Become a Gold Sponsor
DrizzleORM v0.29.1 发布
Nov 29, 2023

修复

新特性/助手

所有方言中所有查询构建器的详细 JSDoc

现在,您可以在开发和使用 JSDoc 时,在 IDE 中访问更多信息、提示、文档链接等。以前,我们仅为过滤表达式提供了这些,但现在您可以在 Drizzle 查询构建器的所有部分中看到它们。

SQL 中的聚合函数的新助手

请记住,聚合函数通常与 SELECT 语句的 GROUP BY 子句一起使用。 因此,如果您在一个查询中使用聚合函数和其他列进行选择,请务必使用 .groupBy 子句。

以下是使用 sql 模板的函数及其等效项的列表:

count

await db.select({ value: count() }).from(users);
await db.select({ value: count(users.id) }).from(users);

// 等效于书写
await db.select({ 
  value: sql`count('*')`.mapWith(Number) 
}).from(users);
await db.select({ 
  value: sql`count(${users.id})`.mapWith(Number) 
}).from(users);

countDistinct

await db.select({ value: countDistinct(users.id) }).from(users);

// 等效于书写
await db.select({ 
  value: sql`count(${users.id})`.mapWith(Number) 
}).from(users);

avg

await db.select({ value: avg(users.id) }).from(users);

// 等效于书写
await db.select({ 
  value: sql`avg(${users.id})`.mapWith(String) 
}).from(users);

avgDistinct

await db.select({ value: avgDistinct(users.id) }).from(users);

// 等效于书写
await db.select({ 
  value: sql`avg(distinct ${users.id})`.mapWith(String) 
}).from(users);

sum

await db.select({ value: sum(users.id) }).from(users);

// 等效于书写
await db.select({ 
  value: sql`sum(${users.id})`.mapWith(String) 
}).from(users);

sumDistinct

await db.select({ value: sumDistinct(users.id) }).from(users);

// 等效于书写
await db.select({ 
  value: sql`sum(distinct ${users.id})`.mapWith(String) 
}).from(users);

max

await db.select({ value: max(users.id) }).from(users);

// 等效于书写
await db.select({ 
  value: sql`max(${expression})`.mapWith(users.id) 
}).from(users);

min

await db.select({ value: min(users.id) }).from(users);

// 等效于书写
await db.select({ 
  value: sql`min(${users.id})`.mapWith(users.id) 
}).from(users);

要获取更多信息,请查看文档:聚合助手

新包

Drizzle ESLint 插件

对于那些无法针对特定场景进行类型检查的情况,或者虽然可以但错误信息难以理解的情况,我们决定创建一个 ESLint 包,带有推荐的规则。该包旨在帮助开发人员在开发过程中处理关键场景。有关更多信息,您可以查看 docs

安装

npm
yarn
pnpm
bun
npm i eslint eslint-plugin-drizzle

您可以为 IDE 安装这些包以支持 TypeScript

npm
yarn
pnpm
bun
npm i @typescript-eslint/eslint-plugin @typescript-eslint/parser

使用

创建一个 .eslintrc.yml 文件,将 drizzle 添加到 plugins 中,并指定您要使用的规则。您可以在下面找到所有现有规则的列表:

root: true
parser: '@typescript-eslint/parser'
parserOptions:
  project: './tsconfig.json'
plugins:
  - drizzle
rules:
  'drizzle/enforce-delete-with-where': "error"
  'drizzle/enforce-update-with-where': "error"

所有配置

此插件导出了一个包含所有规则的完整配置(不包括已弃用的规则)。

root: true
extends:
  - "plugin:drizzle/all"
parser: '@typescript-eslint/parser'
parserOptions:
  project: './tsconfig.json'
plugins:
  - drizzle

目前,all 等效于 recommended

root: true
extends:
  - "plugin:drizzle/recommended"
parser: '@typescript-eslint/parser'
parserOptions:
  project: './tsconfig.json'
plugins:
  - drizzle

规则

enforce-delete-with-where: 强制在 .delete() 语句中与 the.where() 子句一起使用 delete。大多数情况下,您不需要删除表中的所有行,而需要某种类型的 WHERE 语句。

错误信息:

没有 `.where(...)` 您将删除表中的所有行。如果您不想这样做,请使用 `db.delete(...).where(...)`。否则,您可以在此处忽略此规则。

您可以选择在插件选项中定义一个 drizzleObjectName,该选项接受 stringstring[]。这在您有对象或类的删除方法不是来自 Drizzle 的情况下是有用的。这种 delete 方法将触发 ESLint 规则。为此,您可以定义在代码库中使用的 Drizzle 对象的名称(例如 db),这样规则仅在 delete 方法来自该对象时触发:

示例,配置 1:

"rules": {
  "drizzle/enforce-delete-with-where": ["error"]
}
class MyClass {
  public delete() {
    return {}
  }
}

const myClassObj = new MyClass();

// ---> 将触发 ESLint 规则
myClassObj.delete()

const db = drizzle(...)
// ---> 将触发 ESLint 规则
db.delete()

示例,配置 2:

"rules": {
  "drizzle/enforce-delete-with-where": ["error", { "drizzleObjectName": ["db"] }],
}
class MyClass {
  public delete() {
    return {}
  }
}

const myClassObj = new MyClass();

// ---> 不会触发 ESLint 规则
myClassObj.delete()

const db = drizzle(...)
// ---> 将触发 ESLint 规则
db.delete()

enforce-update-with-where: 强制在 .update() 语句中与 the.where() 子句一起使用 update。大多数情况下,您不需要更新表中的所有行,而需要某种类型的 WHERE 语句。

错误信息:

没有 `.where(...)` 您将更新表中的所有行。如果您不想这样做,请使用 `db.update(...).set(...).where(...)`。否则,您可以在此处忽略此规则。

您可以选择在插件选项中定义一个 drizzleObjectName,该选项接受 stringstring[]。这在您有对象或类的更新方法不是来自 Drizzle 的情况下是有用的。这种 update 方法将触发 ESLint 规则。为此,您可以定义在代码库中使用的 Drizzle 对象的名称(例如 db),这样规则仅在 update 方法来自该对象时触发:

示例,配置 1:

"rules": {
  "drizzle/enforce-update-with-where": ["error"]
}
class MyClass {
  public update() {
    return {}
  }
}

const myClassObj = new MyClass();

// ---> 将触发 ESLint 规则
myClassObj.update()

const db = drizzle(...)
// ---> 将触发 ESLint 规则
db.update()

示例,配置 2:

"rules": {
  "drizzle/enforce-update-with-where": ["error", { "drizzleObjectName": ["db"] }],
}
class MyClass {
  public update() {
    return {}
  }
}

const myClassObj = new MyClass();

// ---> 不会触发 ESLint 规则
myClassObj.update()

const db = drizzle(...)
// ---> 将触发 ESLint 规则
db.update()