Turso
本指南讨论了使用 Prisma ORM 和 Turso 背后的概念，解释了 Turso 和其他数据库提供商之间的共性和差异，并引导您完成配置应用程序以与 Turso 集成的过程。
Prisma ORM 对 Turso 的支持目前处于Early Access阶段。 我们欢迎您在此GitHub 讨论中提供反馈。
什么是 Turso？
Turso 是一个边缘托管的分布式数据库，它基于 libSQL，它是 SQLite 的开源和开放贡献的分支，使您能够将数据更靠近您的应用程序并最大限度地减少查询延迟。 Turso 也可以托管在远程服务器上。
Prisma ORM 版本 5.4.2 及更高版本在 Early Access 中提供对 Turso 的支持。
与其他数据库提供商的共性
libSQL 与 SQLite 100% 兼容。 libSQL 扩展了 SQLite 并添加了以下特性和功能
- 复制支持
- 自动备份支持
- 能够将 Turso 嵌入为其他程序（如 Linux 内核）的一部分
- 支持用户定义的函数
- 异步 I/O 支持
要了解有关 libSQL 与 SQLite 之间差异的更多信息，请参阅 libSQL 宣言。
将 Prisma ORM 与 Turso 结合使用的许多方面与将 Prisma ORM 与任何其他关系数据库结合使用一样。 您仍然可以
- 使用 Prisma Schema Language 对数据库进行建模
- 在您的 schema 中使用 Prisma ORM 现有的
sqlite数据库连接器 - 在您的应用程序中使用 Prisma Client 与 Turso 的数据库服务器通信
需要考虑的差异
Turso 和 SQLite 之间存在许多差异需要考虑。 在决定使用 Turso 和 Prisma ORM 时，您应该注意以下几点
- 远程和嵌入式 SQLite 数据库。 libSQL 使用 HTTP 连接到远程 SQLite 数据库。 libSQL 还支持远程数据库副本和嵌入式副本。 嵌入式副本使您能够将主数据库复制到应用程序内部。
- 进行 schema 更改。 由于 libSQL 使用 HTTP 连接到远程数据库，因此它与 Prisma Migrate 不兼容。 但是，您可以使用
prisma migrate diff创建 schema 迁移，然后使用 Turso 的 CLI 将更改应用到您的数据库。
如何连接和查询 Turso 数据库
以下部分介绍了如何创建 Turso 数据库、检索数据库凭据并连接到数据库。
如何配置数据库并检索数据库凭据
确保您已安装 Turso CLI 以管理您的数据库。
如果您没有现有数据库，您可以通过运行以下命令来配置数据库
turso db create turso-prisma-db
上述命令将在离您位置最近的区域创建一个数据库。
运行以下命令以检索数据库的连接字符串
turso db show turso-prisma-db
接下来，创建一个身份验证令牌，该令牌将允许您连接到数据库
turso db tokens create turso-prisma-db
使用身份验证令牌和连接字符串更新您的 .env 文件
TURSO_AUTH_TOKEN="eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9..."
TURSO_DATABASE_URL="libsql://turso-prisma-db-user.turso.io"
如何连接到 Turso 数据库
首先，启用 driverAdapters 预览功能标志
generator client {
provider = "prisma-client-js"
previewFeatures = ["driverAdapters"]
}
datasource db {
provider = "sqlite"
url = "file:./dev.db"
}
生成 Prisma Client
npx prisma generate
安装 libSQL 数据库客户端和用于 libSQL 包的 Prisma ORM 驱动适配器
npm install @libsql/client @prisma/adapter-libsql
更新您的 Prisma Client 实例
import { PrismaClient } from '@prisma/client'
import { PrismaLibSQL } from '@prisma/adapter-libsql'
import { createClient } from '@libsql/client'
const libsql = createClient({
url: `${process.env.TURSO_DATABASE_URL}`,
authToken: `${process.env.TURSO_AUTH_TOKEN}`,
})
const adapter = new PrismaLibSQL(libsql)
const prisma = new PrismaClient({ adapter })
您可以像往常一样在您的项目中使用具有完整类型安全的 Prisma Client。
如何管理 schema 更改
使用 Turso 时，当前不支持 Prisma Migrate 和内省工作流程。 这是因为 Turso 使用 HTTP 连接到您的数据库，而 Prisma Migrate 不支持 HTTP 连接。
要更新您的数据库 schema
-
针对本地 SQLite 数据库使用
prisma migrate dev生成迁移文件npx prisma migrate dev --name init -
使用 Turso 的 CLI 应用迁移
turso db shell turso-prisma-db < ./prisma/migrations/20230922132717_init/migration.sql信息将
20230922132717_init替换为您的迁移名称。
对于后续迁移，重复上述步骤以将更改应用于您的数据库。 此工作流程不支持跟踪应用于远程数据库的迁移历史记录。
嵌入式 Turso 数据库副本
Turso 支持 嵌入式副本。 Turso 的嵌入式副本使您能够在应用程序内部拥有主远程数据库的副本。 嵌入式副本的行为类似于本地 SQLite 数据库。 数据库查询速度更快，因为您的数据库位于您的应用程序内部。
嵌入式数据库副本如何工作
当您的应用程序最初建立与数据库的连接时，主数据库将满足查询
Turso 将 (1) 在您的应用程序内部创建一个嵌入式副本，并 (2) 将数据从您的主数据库复制到该副本，以便在本地可用
嵌入式副本将满足后续的读取查询。 libSQL 客户端提供了一个 sync() 方法，您可以调用该方法以确保嵌入式副本的数据保持最新。
借助嵌入式副本，此设置保证了应用程序的响应速度，因为数据将在本地轻松可用且访问速度更快。
就像您可能熟悉的读取副本设置一样，写入操作会转发到主远程数据库并在传播到所有嵌入式副本之前执行。
- 写入操作传播已转发到数据库。
- 数据库使用来自 1 的更新响应服务器。
- 写入操作已传播到数据库副本。
您的应用程序的数据需求将决定您应该多久同步远程数据库和嵌入式数据库副本之间的数据。 例如，您可以使用中间件函数（例如 Express 和 Fastify）或 cron 作业来同步数据。
如何在远程数据库和嵌入式副本之间同步数据
要开始将嵌入式副本与 Prisma ORM 结合使用，请在您的应用程序中添加 libSQL 中的 sync() 方法。 下面的示例展示了如何使用 Express 中间件同步数据。
import express from 'express'
const app = express()
// ... the rest of your application code
app.use(async (req, res, next) => {
await libsql.sync()
next()
})
app.listen(3000, () => console.log(`Server ready at https://127.0.0.1:3000`))
它也可以作为 Prisma Client 扩展来实现。 下面的示例展示了在执行创建、更新或删除操作后自动同步。
const prisma = new PrismaClient().$extends({
query: {
$allModels: {
async $allOperations({ operation, model, args, query }) {
const result = await query(args)
// Synchronize the embedded replica after any write operation
if (['create', 'update', 'delete'].includes(operation)) {
await libsql.sync()
}
return result
}
}
}
})