神奇的 `sql` 运算符 🪄

使用 ORM 库时，有时你可能会发现使用提供的 ORM 语法编写特定查询很困难。在这种情况下，你可以使用原始查询，这需要将查询构建为原始字符串。但是，原始查询通常缺乏类型安全性和查询参数化的优势。

为了解决这个问题，许多库引入了 sql 模板的概念。此模板允许你编写更多类型安全和参数化的查询，从而增强代码的整体安全性和灵活性。Drizzle 是一个强大的 ORM 库，也支持 SQL 模板。

使用 Drizzle 的 sql 模板，你可以更进一步地编写查询。如果你在使用库的查询构建器编写整个查询时遇到困难，可以选择性地在 Drizzle 查询的特定部分中使用 sql 模板。这种灵活性使你可以在部分 SELECT 语句、WHERE 子句、ORDER BY 子句、HAVING 子句、GROUP BY 子句，甚至关系查询构建器中使用 SQL 模板。

通过利用 Drizzle 中 SQL 模板的功能，你可以保留类型安全和查询参数化的优势，同时实现所需的查询结构和复杂性。这使你能够在应用中创建更健壮、更易于维护的代码。

sql“ 模板

在其他 ORM 中，你可能也会遇到的最常见用法之一是能够将 sql 查询原样用于原始查询。

import { sql } from 'drizzle-orm' 

const id = 69;
await db.execute(sql`select * from ${usersTable} where ${usersTable.id} = ${id}`)

它将生成当前查询

select * from "users" where "users"."id" = $1; --> [69]

任何提供给 sql 参数的表和列都会自动映射到其对应的 SQL 语法，并使用转义的表名，并将转义的表名附加到列名。

此外，任何动态参数（例如 ${id}）都将映射到 $1 占位符，相应的值将被移动到一个值数组中，该数组将单独传递给数据库。

这种方法可以有效地防止任何潜在的 SQL 注入漏洞。

`sql<T>`

请注意，sql<T> 不执行任何运行时映射。你使用 sql<T> 定义的类型纯粹是 Drizzle 的辅助函数。重要的是要理解，由于 SQL 查询具有高度的灵活性和可定制性，因此没有可行的方法可以动态确定确切的类型。

你可以在 Drizzle 中定义自定义类型，用于字段需要除 unknown 以外的特定类型的地方。

此功能在部分选择查询中特别有用，可确保所选字段的类型一致：

// without sql<T> type defined
const response: { id: unknown }[] = await db.select({
    lowerName: sql`lower(${usersTable.id})`
}).from(usersTable);

// with sql<T> type defined
const response: { id: string }[] = await db.select({
    lowerName: sql<string>`lower(${usersTable.id})`
}).from(usersTable);

sql``.mapWith()

如果你需要对从数据库驱动程序传递到 Drizzle 的值进行运行时映射，可以使用 .mapWith()。

此函数接受不同的值，这些值将在运行时映射响应。

只要 mapWith 内部的接口与 Column 实现的接口相同，你就可以复制特定的列映射策略。

const usersTable = pgTable('users', {
    id: serial('id').primaryKey(),
    name: text('name').notNull(),
});

//  at runtime this values will be mapped same as `text` column is mapped in drizzle
sql`...`.mapWith(usersTable.name);

你还可以为 DriverValueDecoder 接口传递你自己的实现：

sql``.mapWith({
	mapFromDriverValue: (value: any) => {
		const mappedValue = value;
		// mapping you want to apply
		return mappedValue;
	},
});
    
// or
sql``.mapWith(Number);

sql``.as<T>()

在不同情况下，有时很难确定如何命名要使用的自定义字段。你可能会遇到需要为将要选择的字段明确指定别名的情况。这在处理复杂查询时尤其有用。

为了解决这些情况，我们引入了一个实用的 .as('alias_name') 助手，它允许你显式定义别名。通过利用此功能，你可以为字段提供清晰且有意义的名称，从而使你的查询更直观、更易读。

sql`lower(usersTable.name)`.as('lower_name')

... "usersTable"."name" as lower_name ...

`sql.raw()`

在某些情况下，你可能不需要从输入创建参数化值，也不需要将表/列映射到转义表/列。你也可以直接生成查询。对于这种情况，我们提供了 sql.raw() 函数。

sql.raw() 函数允许你在查询中包含原始 SQL 语句，而无需任何额外处理或转义。当你拥有预先构建的 SQL 语句，或者需要将复杂或动态的 SQL 代码直接合并到查询中时，此功能非常有用。

sql.raw(`select * from users where id = ${12}`);
// vs
sql`select * from users where id = ${12}`;

select * from users where id = 12;
--> vs
select * from users where id = $1; --> [12]

你还可以在 SQL 函数中使用 sql.raw()，这样你就可以包含任何原始字符串，而无需通过主 sql 模板函数对其进行转义。

通过在 sql 函数中使用 sql.raw()，你可以将未转义的原始字符串直接合并到查询中。当你有特定的 SQL 代码或表达式，并且这些代码或表达式不应受到模板函数的自动转义或修改的影响时，这种方法尤其有用。

sql`select * from ${usersTable} where id = ${12}`;
// vs
sql`select * from ${usersTable} where id = ${sql.raw(12)}`;

select * from "users" where id = $1; --> [12]
--> vs
select * from "users" where id = 12;

sql.fromList()

sql 模板生成 SQL 块，这些 SQL 块是 SQL 语句片段的数组，在将 SQL 语句应用到数据库或 Drizzle 中的查询后，这些 SQL 块将被连接成查询和参数。

在某些情况下，你可能需要使用自定义业务逻辑将这些块聚合到一个数组中，然后将它们连接成一个可以传递给数据库或查询的 SQL 语句。对于这种情况，fromList 函数会非常有用。

fromList 函数允许你将多个 SQL 语句组合成一个 SQL 语句。你可以根据你的特定需求使用它来聚合和连接各个 SQL 部分，然后获得可执行的统一 SQL 查询。

const sqlChunks: SQL[] = [];

sqlChunks.push(sql`select * from users`);

// some logic

sqlChunks.push(sql` where `);

// some logic

for (let i = 0; i < 5; i++) {
	sqlChunks.push(sql`id = ${i}`);

	if (i === 4) continue;
	sqlChunks.push(sql` or `);
}

const finalSql: SQL = sql.fromList(sqlChunks)

select * from users where id = $1 or id = $2 or id = $3 or id = $4 or id = $5; --> [0, 1, 2, 3, 4]

sql.join()

事实上，sql.join 函数的用途与 fromList 助手类似。但是，它在处理 SQL 块之间的空格或指定用于连接 SQL 块的自定义分隔符时提供了额外的灵活性。

使用 sql.join，你可以使用指定的分隔符将 SQL 块连接在一起。此分隔符可以是你想要插入到块之间的任何字符串或字符。

当你对格式化或分隔 SQL 块有特定要求时，这尤其有用。通过指定自定义分隔符，你可以在最终的 SQL 查询中实现所需的结构和格式。

const sqlChunks: SQL[] = [];

sqlChunks.push(sql`select * from users`);

// some logic

sqlChunks.push(sql`where`);

// some logic

for (let i = 0; i < 5; i++) {
	sqlChunks.push(sql`id = ${i}`);

if (i === 4) continue;
    sqlChunks.push(sql`or`);
}

const finalSql: SQL = sql.join(sqlChunks, sql.raw(' '));

select * from users where id = $1 or id = $2 or id = $3 or id = $4 or id = $5; --> [0, 1, 2, 3, 4]

sql.append()

如果你已经使用 sql 模板生成了 SQL，则可以通过使用 append 函数直接向生成的 SQL 添加新块来实现与 fromList 相同的行为。

通过使用 append 函数，你可以动态地将其他 SQL 块添加到现有的 SQL 字符串中，从而有效地将它们连接在一起。这使得你可以将用于聚合块的自定义逻辑或业务规则合并到最终的 SQL 查询中。

const finalSql = sql`select * from users`;

// some logic

finalSql.append(sql` where `);

// some logic

for (let i = 0; i < 5; i++) {
	finalSql.append(sql`id = ${i}`);

	if (i === 4) continue;
	finalSql.append(sql` or `);
}

select * from users where id = $1 or id = $2 or id = $3 or id = $4 or id = $5; --> [0, 1, 2, 3, 4]

sql.empty()

通过使用 sql.empty()，你可以从一个空白的 SQL 对象开始，然后根据需要动态地向其中附加 SQL 块。这使得你可以逐步构建 SQL 查询，应用自定义逻辑或条件来确定每个块的内容。

使用 sql.empty() 初始化 SQL 对象后，即可充分利用 SQL 模板的全部功能，例如参数化、组合和转义。这使你能够以灵活且可控的方式构建 SQL 查询，并使其适应你的特定需求。

const finalSql = sql.empty();

// some logic

finalSql.append(sql`select * from users`);

// some logic

finalSql.append(sql` where `);

// some logic

for (let i = 0; i < 5; i++) {
	finalSql.append(sql`id = ${i}`);

	if (i === 4) continue;
	finalSql.append(sql` or `);
}

select * from users where id = $1 or id = $2 or id = $3 or id = $4 or id = $5; --> [0, 1, 2, 3, 4]

将 `sql` 转换为字符串和参数

在前面的所有示例中，你都观察到了 TypeScript 中 SQL 模板语法的用法以及生成的 SQL 输出。

如果你需要获取从 SQL 模板生成的查询字符串和相应的参数，则必须指定要为其生成查询的数据库方言。不同的数据库在参数化和转义方面有不同的语法，因此选择合适的方言至关重要。

选择方言后，你可以利用相应实现的功能将 SQL 模板转换为所需的查询字符串和参数格式。这确保了与你正在使用的特定数据库系统的兼容性。

PostgreSQL

MySQL

SQLite

import { PgDialect } from 'drizzle-orm/pg-core';

const pgDialect = new PgDialect();
pgDialect.sqlToQuery(sql`select * from ${usersTable} where ${usersTable.id} = ${12}`);

select * from "users" where "users"."id" = $1; --> [ 12 ]

import { MySqlDialect } from 'drizzle-orm/mysql-core';

const mysqlDialect = new MySqlDialect();
mysqlDialect.sqlToQuery(sql`select * from ${usersTable} where ${usersTable.id} = ${12}`);

select * from `users` where `users`.`id` = ?; --> [ 12 ]

import { SQLiteSyncDialect } from 'drizzle-orm/sqlite-core';

const sqliteDialect = new SQLiteSyncDialect();
sqliteDialect.sqlToQuery(sql`select * from ${usersTable} where ${usersTable.id} = ${12}`);

select * from "users" where "users"."id" = ?; --> [ 12 ]

`sql` select

你也可以在部分选择查询中使用 SQL 功能。部分选择查询允许你从表中检索特定字段或列，而不是获取整行。

有关部分选择查询的更多详细信息，你可以参考核心 API 文档提供的核心 API 文档。

从表中选择不同的自定义字段

这里你可以看到 sql<T>、sql``.mapWith() 和 sql``.as<T>() 的用法。

import { sql } from 'drizzle-orm'
import { usersTable } from 'schema'

await db.select({
    id: usersTable.id,
    lowerName: sql<string>`lower(${usersTable.name})`,
    aliasedName: sql<string>`lower(${usersTable.name})`.as('aliased_column'),
    count: sql<number>`count(*)`.mapWith(Number) 
}).from(usersTable)

select `id`, lower(`name`), lower(`name`) as `aliased_column`, count(*) from `users`;

where 中的 `sql`

事实上，Drizzle 提供了一组可在 SQL 模板中使用的可用表达式。但是，数据库通常有更广泛的可用表达式，包括通过扩展或其他方式提供的表达式。

为了确保灵活性并允许你使用 Drizzle 原生不支持的任何表达式，你可以自由地直接使用 SQL 函数编写 SQL 模板。这使得你可以充分利用 SQL 的全部功能，并合并特定于目标数据库的任何表达式或功能。

通过使用 SQL 模板，你不再局限于 Drizzle 中预定义的表达式。你可以表达复杂的查询，并结合底层数据库系统提供的任何支持的表达式。

使用 SQL 按 id 进行过滤

import { sql } from 'drizzle-orm'
import { usersTable } from 'schema'

const id = 77

await db.select()
        .from(usersTable)
        .where(sql`${usersTable.id} = ${id}`)

select * from "users" where "users"."id" = $1; --> [ 77 ]

高级全文搜索 where 语句

import { sql } from 'drizzle-orm'
import { usersTable } from 'schema'

const searchParam = "Ale"

await db.select()
        .from(usersTable)
        .where(sql`to_tsvector('simple', ${usersTable.name}) @@ to_tsquery('simple', ${searchParam})`)

select * from "users" where to_tsvector('simple', "users"."name") @@ to_tsquery('simple', '$1'); --> [ "Ale" ]

orderBy 中的 `sql`

当你需要 Drizzle 中不提供的排序功能，但又不想使用原始 SQL 时，可以在 ORDER BY 子句中使用 sql 模板。

import { sql } from 'drizzle-orm'
import { usersTable } from 'schema'

await db.select().from(usersTable).orderBy(sql`${usersTable.id} desc nulls first`)

select * from "users" order by "users"."id" desc nulls first;

having 和 groupBy 中的 `sql`

当你需要 Drizzle 中不提供的排序功能，但又不想使用原始 SQL 时，可以在 HAVING 和 GROUP BY 子句中使用 sql 模板。

import { sql } from 'drizzle-orm'
import { usersTable } from 'schema'

await db.select({ 
    projectId: usersTable.projectId,
    count: sql<number>`count(${usersTable.id})`.mapWith(Number)
}).from(usersTable)
    .groupBy(sql`${usersTable.projectId}`)
    .having(sql`count(${usersTable.id}) > 300`)

select "project_id", count("users"."id") from users group by "users"."project_id" having count("users"."id") > 300;

神奇的 sql 运算符 🪄

sql“ 模板

sql<T>