如果你还没有 PostgreSQL 数据库并想创建一个进行测试,你可以查看我们的指南,了解如何在 Docker 中设置 PostgreSQL。
Docker 中的 PostgreSQL 设置指南可以在 这里 找到。去设置它,生成一个数据库 URL(在指南中有说明),然后回来进行下一步。
Drizzle 对 node-postgres
和 postgres.js
驱动程序的 PostgreSQL 连接提供原生支持。
我们将在这个入门示例中使用 node-postgres
。但如果你想找到更多连接 PostgreSQL 的方式,可以查看我们的 PostgreSQL 连接 页面。
这是项目的基本文件结构。在 src/db
目录中,我们在 schema.ts
中有表定义。在 drizzle
文件夹中,有 SQL 迁移文件和快照。
📦 <project root>
├ 📂 drizzle
├ 📂 src
│ ├ 📂 db
│ │ └ 📜 schema.ts
│ └ 📜 index.ts
├ 📜 .env
├ 📜 drizzle.config.ts
├ 📜 package.json
└ 📜 tsconfig.json
npm i drizzle-orm pg dotenv
npm i -D drizzle-kit tsx @types/pg
Create a .env
file in the root of your project and add your database connection variable:
DATABASE_URL=
如果你还没有 PostgreSQL 数据库并想创建一个进行测试,你可以查看我们的指南,了解如何在 Docker 中设置 PostgreSQL。
Docker 中的 PostgreSQL 设置指南可以在 这里 找到。去设置它,生成一个数据库 URL(在指南中有说明),然后回来进行下一步。
Create a index.ts
file in the src/db
directory and initialize the connection:
import 'dotenv/config';
import { drizzle } from 'drizzle-orm/node-postgres';
const db = drizzle(process.env.DATABASE_URL!);
Create a schema.ts
file in the src/db
directory and declare your table:
import { integer, pgTable, varchar } from "drizzle-orm/pg-core";
export const usersTable = pgTable("users", {
id: integer().primaryKey().generatedAlwaysAsIdentity(),
name: varchar({ length: 255 }).notNull(),
age: integer().notNull(),
email: varchar({ length: 255 }).notNull().unique(),
});
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: 'postgresql',
dbCredentials: {
url: process.env.DATABASE_URL!,
},
});
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.
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.
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/node-postgres';
import { eq } from 'drizzle-orm';
import { usersTable } from './db/schema';
const db = drizzle(process.env.DATABASE_URL!);
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();
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
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