Gel 认证扩展 - Drizzle ORM 中文文档

Drizzle | Gel 认证扩展

This guide assumes familiarity with:

开始使用 Gel
使用 drizzle-kit pull

第一步 - 定义 Gel 认证 schema

在 dbschema/default.esdl 文件中添加带有认证扩展的 Gel schema

using extension auth;

module default {
  global current_user := (
    assert_single((
      select User { id, username, email }
      filter .identity = global ext::auth::ClientTokenIdentity
    ))
  );

  type User {
    required identity: ext::auth::Identity;
    required username: str;
    required email: str;
  }
}

第二步 - 将 Gel schema 推送到数据库

生成 Gel 迁移文件：

gel migration create

将 Gel 迁移应用到数据库

gel migration apply

第三步 - 设置 Drizzle 配置文件

Drizzle 配置 - 是一个被 Drizzle Kit 使用的配置文件，包含关于数据库连接、迁移文件夹和 schema 文件的所有信息。

在项目根目录创建一个 drizzle.config.ts 文件，并添加以下内容：

import { defineConfig } from 'drizzle-kit';

export default defineConfig({
  dialect: 'gel',
  // 为 drizzle-kit 启用 auth schema
  schemaFilter: ['ext::auth', 'public']
});

第四步 - 将 Gel 类型拉取到 Drizzle schema

拉取你的数据库 schema：

npm

yarn

pnpm

bun

npx drizzle-kit pull

yarn drizzle-kit pull

pnpm drizzle-kit pull

bun drizzle-kit pull

以下是生成的 schema.ts 文件示例：

IMPORTANT

你不仅会获得来自 ext::auth 的 Identity 表，Drizzle 会拉取所有你可以使用的 auth 表。下面的示例仅展示其中一个。

import { gelTable, uniqueIndex, uuid, text, gelSchema, timestamptz, foreignKey } from "drizzle-orm/gel-core"
import { sql } from "drizzle-orm"

export const extauth = gelSchema('ext::auth');

export const identityInExtauth = extauth.table('Identity', {
	id: uuid().default(sql`uuid_generate_v4()`).primaryKey().notNull(),
	createdAt: timestamptz('created_at').default(sql`(clock_timestamp())`).notNull(),
	issuer: text().notNull(),
	modifiedAt: timestamptz('modified_at').notNull(),
	subject: text().notNull(),
}, (table) => [
	uniqueIndex('6bc2dd19-bce4-5810-bb1b-7007afe97a11;schemaconstr').using(
		'btree',
		table.id.asc().nullsLast().op('uuid_ops'),
	),
]);

export const user = gelTable('User', {
	id: uuid().default(sql`uuid_generate_v4()`).primaryKey().notNull(),
	email: text().notNull(),
	identityId: uuid('identity_id').notNull(),
	username: text().notNull(),
}, (table) => [
	uniqueIndex('d504514c-26a7-11f0-b836-81aa188c0abe;schemaconstr').using(
		'btree',
		table.id.asc().nullsLast().op('uuid_ops'),
	),
	foreignKey({
		columns: [table.identityId],
		foreignColumns: [identityInExtauth.id],
		name: 'User_fk_identity',
	}),
]);

🎉 现在你可以在查询中使用 auth 表了！