Bun SQLite
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 和 Bun:SQLite 入门
This guide assumes familiarity with:
bun - JavaScript 一体化工具包 - 点击阅读
bun:sqlite - 高性能 SQLite3 驱动的原生实现 - 点击阅读
基本文件结构
这是项目的基本文件结构。在 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
npm i -D drizzle-kit @types/bun
yarn add drizzle-orm
yarn add -D drizzle-kit @types/bun
pnpm add drizzle-orm
pnpm add -D drizzle-kit @types/bun
bun add drizzle-orm
bun add -D drizzle-kit @types/bun
步骤 2 - 设置连接变量
Create a .env
file in the root of your project and add your database connection variable:
重要
例如,如果您想在项目根目录中创建一个 SQLite 数据库文件以进行测试,可以使用以下示例:
DB_FILE_NAME=mydb.sqlite
步骤 3 - 将 Drizzle ORM 连接到数据库
Create a index.ts
file in the src
directory and initialize the connection:
import 'dotenv/config' ;
import { drizzle } from 'drizzle-orm/bun-sqlite' ;
const db = drizzle ( process . env . DB_FILE_NAME ! );
import 'dotenv/config' ;
import { drizzle } from 'drizzle-orm/bun-sqlite' ;
// You can specify any property from the libsql connection options
const db = drizzle ({ connection : { source : process . env . DB_FILE_NAME ! }});
If you need to provide your existing driver:
import 'dotenv/config' ;
import { drizzle } from 'drizzle-orm/bun-sqlite' ;
import { Database } from 'bun:sqlite' ;
const sqlite = new Database ( process . env . DB_FILE_NAME ! );
const db = drizzle ({ client : sqlite });
步骤 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 config - a configuration file that is used by Drizzle Kit and contains all the information about your database connection, migration folder and schema files.
Create a drizzle.config.ts
file in the root of your project and add the following content:
import 'dotenv/config' ;
import { defineConfig } from 'drizzle-kit' ;
export default defineConfig ({
out : './drizzle' ,
schema : './src/db/schema.ts' ,
dialect : 'sqlite' ,
dbCredentials : {
url : process . env .DB_FILE_NAME ! ,
} ,
});
步骤 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 { drizzle } from 'drizzle-orm/bun:sqlite' ;
import { eq } from 'drizzle-orm' ;
import { usersTable } from './db/schema' ;
const db = drizzle ( process . env .DB_FILE_NAME ! );
async function main () {
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 文件
要使用 bun
运行脚本,请使用以下命令:
bun src/index.ts