v1.0
75%
Benchmarks
Extension
Studio
Studio Package
Drizzle Run
Our goodies!
EdgeDB
Upstash
Turso
🚀 Drizzle is giving you 10% off Turso Scaler and Pro for 1 Year 🚀
Payload
Xata
Neon
Nuxt
Hydra
Deco.cx
Tembo
SQLite Cloud
SingleStore
PrAha
Lokalise
Replit
Mooncake

生成列

要使用此功能，您需要安装 drizzle-orm@0.32.0 或更高版本，以及 drizzle-kit@0.23.0 或更高版本

SQL 中的生成列是一项功能，允许您在表中创建列，其值基于同一表中其他列的表达式自动计算。这有助于确保数据一致性，简化数据库设计，提高查询性能。

生成列有两种类型：

  1. 虚拟（或非持久性）生成列：这些列在查询时动态计算。它们在数据库中不占用存储空间。

  2. 存储（或持久性）生成列：这些列在插入或更新行时计算，并将其值存储在数据库中。这使它们可以被索引，并且可以提高查询性能，因为值不需要在每个查询中重新计算。

生成列对于以下情况特别有用：

生成列的实现和使用在不同的 SQL 数据库中可能有显著差异。PostgreSQL、MySQL 和 SQLite 在生成列方面各自有独特的特性、能力和限制。在这一部分中，我们将详细探讨这些差异，以帮助您了解如何在每个数据库系统中最好地利用生成列。

PostgreSQL
MySQL
SQLite
SingleStore(WIP)

数据库端

类型: STORED 仅

工作原理

  • 在插入或更新时自动计算基于其他列的值。

能力

  • 通过预计算复杂表达式简化数据访问。
  • 通过生成列的索引支持增强查询性能。

限制

  • 不能指定默认值。
  • 表达式不能引用其他生成列或包含子查询。
  • 修改生成列表达式需要更改架构。
  • 不能直接用于主键、外键或唯一约束。

欲了解更多信息，请查看 PostgreSQL 文档。

Drizzle 端

在 Drizzle 中，你可以在任何列类型上指定 .generatedAlwaysAs() 函数，并添加一个支持的 SQL 查询，这将为你生成该列的数据。

特性

此函数可以以三种方式接受生成表达式：

string

export const test = pgTable("test", {
    generatedName: text("gen_name").generatedAlwaysAs(`hello world!`),
});
CREATE TABLE IF NOT EXISTS "test" (
    "gen_name" text GENERATED ALWAYS AS (hello world!) STORED
);

sql 标签 - 如果您希望 Drizzle 为您转义一些值

export const test = pgTable("test", {
    generatedName: text("gen_name").generatedAlwaysAs(sql`hello "world"!`),
});
CREATE TABLE IF NOT EXISTS "test" (
    "gen_name" text GENERATED ALWAYS AS (hello "world"!) STORED,
);

callback - 如果您需要引用表中的列

export const test = pgTable("test", {
    name: text("first_name"),
    generatedName: text("gen_name").generatedAlwaysAs(
      (): SQL => sql`hi, ${test.name}!`
    ),
});
CREATE TABLE IF NOT EXISTS "test" (
    "first_name" text,
    "gen_name" text GENERATED ALWAYS AS (hi, "test"."first_name"!) STORED,
);

示例 生成列与全文搜索

schema.ts
import { SQL, sql } from "drizzle-orm";
import { customType, index, integer, pgTable, text } from "drizzle-orm/pg-core";

const tsVector = customType<{ data: string }>({
  dataType() {
    return "tsvector";
  },
});

export const test = pgTable(
  "test",
  {
    id: integer("id").primaryKey().generatedAlwaysAsIdentity(),
    content: text("content"),
    contentSearch: tsVector("content_search", {
      dimensions: 3,
    }).generatedAlwaysAs(
      (): SQL => sql`to_tsvector('english', ${test.content})`
    ),
  },
  (t) => [
    index("idx_content_search").using("gin", t.contentSearch)
  ]
);
CREATE TABLE IF NOT EXISTS "test" (
	"id" integer PRIMARY KEY GENERATED ALWAYS AS IDENTITY (sequence name "test_id_seq" INCREMENT BY 1 MINVALUE 1 MAXVALUE 2147483647 START WITH 1 CACHE 1),
	"content" text,
	"content_search" "tsvector" GENERATED ALWAYS AS (to_tsvector('english', "test"."content")) STORED
);
--> statement-breakpoint
CREATE INDEX IF NOT EXISTS "idx_content_search" ON "test" USING gin ("content_search");