Turso
New database
Meet Drizzle
Get started
New database
Existing database
PostgreSQL Neon Vercel Postgres Supabase Xata PGLite MySQL PlanetScale TiDB SQLite Turso Cloudflare D1 Bun SQLite Expo SQLite OP SQLite
使用 Drizzle 和 Turso 开始
This guide assumes familiarity with:
dotenv - 管理环境变量的包 - 在这里阅读
tsx - 运行 TypeScript 文件的包 - 在这里阅读
turso - 用于生产的 SQLite - 在这里阅读
libsql - 优化了低查询延迟的 SQLite 分支,适合全球应用 - 在这里阅读
基本文件结构
这是项目的基本文件结构。在 src/db
目录中,我们在 schema.ts
中有表定义。在 drizzle
文件夹中,有 SQL 迁移文件和快照。
📦 <project root>
├ 📂 drizzle
├ 📂 src
│ ├ 📂 db
│ │ └ 📜 schema.ts
│ └ 📜 index.ts
├ 📜 .env
├ 📜 drizzle.config.ts
├ 📜 package.json
└ 📜 tsconfig.json
步骤 1 - 安装所需的包
npm i drizzle-orm @libsql/client dotenv
npm i -D drizzle-kit tsx
yarn add drizzle-orm @libsql/client dotenv
yarn add -D drizzle-kit tsx
pnpm add drizzle-orm @libsql/client dotenv
pnpm add -D drizzle-kit tsx
bun add drizzle-orm @libsql/client dotenv
bun add -D drizzle-kit tsx
步骤 2 - 设置连接变量
在项目根目录创建一个 .env
文件,并添加你的 Turso 数据库 URL 和授权令牌:
TURSO_DATABASE_URL=
TURSO_AUTH_TOKEN=
重要
如果你不知道 TURSO_DATABASE_URL
和 TURSO_AUTH_TOKEN
的值,可以参考 LibSQL 驱动 SDK 教程。
查看 这里 ,然后带着生成的所有值返回并添加到 .env
文件中
步骤 3 - 将 Drizzle ORM 连接到数据库
Drizzle 原生支持所有 @libsql/client 驱动程序变体:
@libsql/client
defaults to node
import, automatically changes to web
if target
or platofrm
is set for bundler, e.g. esbuild --platform=browser
@libsql/client/node
node
compatible module, supports :memory:
, file
, wss
, http
and turso
conneciton protocols@libsql/client/web
module for fullstack web frameworks like next
, nuxt
, astro
, etc. @libsql/client/http
module for http
and https
connection protocols @libsql/client/ws
module for ws
and wss
conneciton protocols @libsql/client/sqlite3
module for :memory:
and file
conneciton protocols @libsql/client-wasm
Separate experimental package for WASM
default
node
web
http
web sockets
wasm
import { drizzle } from 'drizzle-orm/libsql' ;
const db = drizzle ({ connection : {
url : process . env . DATABASE_URL ,
authToken : process . env . DATABASE_AUTH_TOKEN
}});
import { drizzle } from 'drizzle-orm/libsql/node' ;
const db = drizzle ({ connection : {
url : process . env . DATABASE_URL ,
authToken : process . env . DATABASE_AUTH_TOKEN
}});
import { drizzle } from 'drizzle-orm/libsql/web' ;
const db = drizzle ({ connection : {
url : process . env . DATABASE_URL ,
authToken : process . env . DATABASE_AUTH_TOKEN
}});
import { drizzle } from 'drizzle-orm/libsql/http' ;
const db = drizzle ({ connection : {
url : process . env . DATABASE_URL ,
authToken : process . env . DATABASE_AUTH_TOKEN
}});
import { drizzle } from 'drizzle-orm/libsql/ws' ;
const db = drizzle ({ connection : {
url : process . env . DATABASE_URL ,
authToken : process . env . DATABASE_AUTH_TOKEN
}});
import { drizzle } from 'drizzle-orm/libsql/wasm' ;
const db = drizzle ({ connection : {
url : process . env . DATABASE_URL ,
authToken : process . env . DATABASE_AUTH_TOKEN
}});
在 src
目录创建一个 index.ts
文件并初始化连接:
import 'dotenv/config' ;
import { drizzle } from 'drizzle-orm/libsql' ;
// 你可以指定 libsql 连接选项中的任何属性
const db = drizzle ({
connection : {
url : process . env . TURSO_DATABASE_URL ! ,
authToken : process . env . TURSO_AUTH_TOKEN !
}
});
如果您需要提供您现有的驱动程序:
import 'dotenv/config' ;
import { drizzle } from 'drizzle-orm/libsql' ;
import { createClient } from '@libsql/client' ;
const client = createClient ({
url : process . env . TURSO_DATABASE_URL ! ,
authToken : process . env . TURSO_AUTH_TOKEN !
});
const db = drizzle ({ client });
步骤 4 - 创建一个表
Create a schema.ts
file in the src/db
directory and declare your table:
import { int , sqliteTable , text } from "drizzle-orm/sqlite-core" ;
export const usersTable = sqliteTable ( "users_table" , {
id : int () .primaryKey ({ autoIncrement : true }) ,
name : text () .notNull () ,
age : int () .notNull () ,
email : text () .notNull () .unique () ,
});
步骤 5 - 设置 Drizzle 配置文件
Drizzle 配置 - 由 Drizzle Kit 使用的配置文件,包含有关你的数据库连接、迁移文件夹和模式文件的所有信息。
在项目根目录创建一个 drizzle.config.ts
文件,并添加以下内容:
import 'dotenv/config' ;
import { defineConfig } from 'drizzle-kit' ;
export default defineConfig ({
out : './drizzle' ,
schema : './src/db/schema.ts' ,
dialect : 'turso' ,
dbCredentials : {
url : process . env . TURSO_DATABASE_URL ,
authToken : process . env . TURSO_AUTH_TOKEN ,
} ,
});
步骤 6 - 将更改应用到数据库
You can directly apply changes to your database using the drizzle-kit push
command. This is a convenient method for quickly testing new schema designs or modifications in a local development environment, allowing for rapid iterations without the need to manage migration files:
npx drizzle-kit push
Read more about the push command in documentation .
Tips
Alternatively, you can generate migrations using the drizzle-kit generate
command and then apply them using the drizzle-kit migrate
command:
Generate migrations:
npx drizzle-kit generate
Apply migrations:
npx drizzle-kit migrate
Read more about migration process in documentation .
步骤 7 - 种子和查询数据库
Let’s update the src/index.ts
file with queries to create, read, update, and delete users
import 'dotenv/config' ;
import { eq } from 'drizzle-orm' ;
import { drizzle } from 'drizzle-orm/libsql' ;
import { usersTable } from './db/schema' ;
async function main () {
const db = drizzle ({
connection : {
url : process . env . TURSO_DATABASE_URL ! ,
authToken : process . env . TURSO_AUTH_TOKEN !
}
});
const user : typeof usersTable .$inferInsert = {
name : 'John' ,
age : 30 ,
email : 'john@example.com' ,
};
await db .insert (usersTable) .values (user);
console .log ( 'New user created!' )
const users = await db .select () .from (usersTable);
console .log ( 'Getting all users from the database: ' , users)
/*
const users: {
id: number;
name: string;
age: number;
email: string;
}[]
*/
await db
.update (usersTable)
.set ({
age : 31 ,
})
.where ( eq ( usersTable .email , user .email));
console .log ( 'User info updated!' )
await db .delete (usersTable) .where ( eq ( usersTable .email , user .email));
console .log ( 'User deleted!' )
}
main ();
步骤 8 - 运行 index.ts 文件
To run any TypeScript files, you have several options, but let’s stick with one: using tsx
You’ve already installed tsx
, so we can run our queries now
Run index.ts
script
npx tsx src/index.ts
yarn tsx src/index.ts
pnpm tsx src/index.ts
bun tsx src/index.ts
tips
We suggest using bun
to run TypeScript files. With bun
, such scripts can be executed without issues or additional
settings, regardless of whether your project is configured with CommonJS (CJS), ECMAScript Modules (ESM), or any other module format.
To run a script with bun
, use the following command:
bun src/index.ts
If you don’t have bun installed, check the Bun installation docs