神奇的 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` = ?; --> [69]

传递给 sql 参数的任何表和列，都会自动映射为其对应的 SQL
语法：表名会被转义，转义后的表名也会追加到列名上。

此外，任何动态参数，例如 ${id}，都会映射为 ? 占位符，
而对应的值会被移动到一个单独传递给数据库的值数组中。

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

sql<T>

你可以在 Drizzle 中定义一个自定义类型，用于字段需要除 unknown 之外的特定类型的场景。

此功能在部分 select 查询中尤其有用，可确保所选字段的类型保持一致：

// 未定义 sql<T> 类型
const response: { lowerName: unknown }[] = await db.select({
    lowerName: sql`lower(${usersTable.id})`
}).from(usersTable);

// 定义了 sql<T> 类型
const response: { lowerName: string }[] = await db.select({
    lowerName: sql<string>`lower(${usersTable.id})`
}).from(usersTable);

sql``.mapWith()

对于需要对从数据库驱动传递到 drizzle 的值进行运行时映射的情况，你可以使用 .mapWith()

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

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

import { mysqlTable, int, text } from 'drizzle-orm/mysql-core';

const usersTable = mysqlTable('users', {
    id: int().primaryKey().autoincrement(),
    name: text().notNull(),
});

// 在运行时，这些值将被映射得与 drizzle 中 `text` 列的映射方式相同
sql`...`.mapWith(usersTable.name);

你也可以为 DriverValueDecoder 接口传入你自己的实现：

sql``.mapWith({
	mapFromDriverValue: (value: any) => {
		const mappedValue = value;
		// 你想应用的映射
		return mappedValue;
	},
});
    
// 或者
sql``.mapWith(Number);

sql``.as<T>()

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

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

sql`lower(${usersTable.name})`.as('lower_name')

... `users`.`name` as lower_name ...

sql.raw()

有些情况下，你可能不需要从输入中创建参数化值，也不需要将表/列映射为转义后的形式。
相反，你可能只想按原样生成查询。对于这种情况，我们提供了 sql.raw() 函数。

sql.raw() 函数允许你在查询中包含原始 SQL 语句，而无需进行任何额外处理或转义。
当你已经预先构造好了 SQL 语句，或者需要直接在查询中包含复杂或动态的 SQL 代码时，这会非常有用。

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

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

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

通过在 sql 函数中使用 sql.raw()，你可以将未转义的原始字符串直接纳入查询中。
这在你有某些特定的 SQL 代码或表达式需要保持不被模板函数自动转义或修改时，尤其有用。

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

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

sql.fromList()

sql 模板会生成 sql 片段，这些片段是由 SQL 各部分组成的数组，在将 SQL 应用到 Drizzle 的数据库或查询之后，它们会被拼接到查询和参数中。

在某些场景下，你可能需要使用自定义业务逻辑将这些片段聚合到一个数组中，然后再将它们拼接成一个可以传递给数据库或查询的单个 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 = ? or id = ? or id = ? or id = ? or id = ?; --> [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`);

// 一些逻辑

sqlChunks.push(sql`where`);

// 一些逻辑

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 = ? or id = ? or id = ? or id = ? or id = ?; --> [0, 1, 2, 3, 4]

sql.append()

如果你已经使用 sql 模板生成了 SQL，你可以通过使用 append 函数直接向生成的 SQL 中添加一个新的片段，从而实现与 fromList 相同的行为。

通过使用 append 函数，你可以动态地向现有的 SQL 字符串中添加额外的 SQL 片段， 从而将它们有效地连接在一起。这使你能够结合自定义逻辑或业务 规则，将这些片段聚合成最终的 SQL 查询。

const finalSql = sql`select * from users`;

// 一些逻辑

finalSql.append(sql` where `);

// 一些逻辑

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 = ? or id = ? or id = ? or id = ? or id = ?; --> [0, 1, 2, 3, 4]

sql.empty()

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

一旦你使用 sql.empty() 初始化了 SQL 对象，就可以利用 sql 模板的全部功能，例如参数化、组合和转义。
这使你能够以灵活且可控的方式构建 SQL 查询，并根据你的具体需求进行调整。

const finalSql = sql.empty();

// 一些逻辑

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

// 一些逻辑

finalSql.append(sql` where `);

// 一些逻辑

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 = ? or id = ? or id = ? or id = ? or id = ?; --> [0, 1, 2, 3, 4]

将 sql 转换为字符串和参数

在前面的所有示例中，你已经看到了在 TypeScript 中使用 SQL 模板语法以及生成的 SQL 输出。

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

一旦你选择了方言，就可以使用对应实现提供的功能，将 SQL 模板转换为所需的查询字符串和参数格式。这样可以确保与你所使用的特定数据库系统兼容。

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 ]

sql 选择

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

有关部分选择查询的更多详细信息，你可以参考 Core API 文档中的 Core API docs。

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

在这里你可以看到 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` = ?; --> [ 77 ]

高级全文搜索 where 语句

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

const searchPattern = "%Ale%"

await db.select()
        .from(usersTable)
        .where(sql`lower(${usersTable.name}) like lower(${searchPattern})`)

select * from `users` where lower(`users`.`name`) like lower(?); --> [ "%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;

sql 在 having 和 groupBy 中

当你需要某些在 Drizzle 中不可用的排序特定功能，但又不想直接使用原始 SQL 时，sql 模板确实可以用于 HAVING 和 GROUP BY 子句。

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;