如何通过Drizzle ORM的pgTable定义生成CREATE TABLE SQL？

直接利用Drizzle内置的表元数据就能搞定，不用再依赖麻烦的diff工具，下面是具体实现：

1. 单表初始化实现 #

先导入所需模块并定义表结构：

import { pgTable, serial, varchar, sql } from 'drizzle-orm/postgres-core';
import { drizzle } from 'drizzle-orm/pglite';
import { PGLite } from '@electric-sql/pglite';

// 示例表结构
const users = pgTable('users', {
  id: serial('id').primaryKey(),
  name: varchar('name', { length: 255 }).notNull(),
  email: varchar('email', { length: 255 }).unique().notNull(),
});

封装一个极简工具函数，传入pgTable实例即可生成目标SQL：

function getCreateTableIfNotExistsSql(table: ReturnType<typeof pgTable>) {
  // 从表元数据获取原始CREATE TABLE语句，拼接IF NOT EXISTS
  const rawCreateSql = table.toSQL().createTable;
  return `${rawCreateSql} IF NOT EXISTS`;
}

生成并执行建表语句，之后就能正常操作数据库：

// 初始化pglite内存数据库
const pglite = new PGLite();
const db = drizzle(pglite);

// 生成建表SQL并执行
const createUsersSql = getCreateTableIfNotExistsSql(users);
await db.execute(sql.raw(createUsersSql));

// 测试增删改查
await db.insert(users).values({ name: 'Alice', email: 'alice@test.com' });
const usersList = await db.select().from(users);
console.log(usersList);

2. 多表批量初始化 #

如果有多个表需要初始化，直接循环处理即可：

// 定义所有需要初始化的表
const allTables = [users, posts, comments];

// 批量生成并执行建表语句
for (const table of allTables) {
  const createSql = getCreateTableIfNotExistsSql(table);
  await db.execute(sql.raw(createSql));
}

为什么不用diffTestSchemas？ #

diffTestSchemas是用于对比两个Schema差异、生成迁移SQL的工具，测试场景下仅需初始化表，直接从表元数据生成建表语句更轻量，省去了不必要的对比步骤。

内容的提问来源于stack exchange，提问作者codeBelt