Lucid ORM
Lucid 是一个 SQL 查询构建器，也是一个构建在 Knex 之上的 Active Record ORM，由 AdonisJS 核心团队创建和维护。Lucid 致力于充分利用 SQL 的潜力，并为许多高级 SQL 操作提供简洁的 API。
Lucid 的文档位于 https://lucid.adonisjs.com
为什么选择 Lucid
以下是 Lucid 的一些精选特性。
- 基于 Knex 构建的流畅查询构建器。
- 支持读写副本和多连接管理。
- 符合 Active Record 模式的基于类的模型（处理关系、序列化和钩子）。
- 使用增量变更集修改数据库模式的迁移系统。
- 用于生成测试伪造数据的模型工厂。
- 用于将初始/虚拟数据插入数据库的数据库填充器。
除此之外，以下是在 AdonisJS 应用程序中使用 Lucid 的其他原因。
-
我们为 Lucid 提供了与 Auth 包和验证器的集成。因此，你不必自己编写这些集成。
-
Lucid 预配置在
api和web启动套件中，为你的应用程序提供了先发优势。 -
Lucid 的主要目标之一是充分利用 SQL 的潜力，并支持许多高级 SQL 操作，如 窗口函数、递归 CTE、JSON 操作、行级锁 等等。
-
Lucid 和 Knex 都已经存在多年。因此，与许多其他新 ORM 相比，它们更加成熟且经过实战检验。
话虽如此，AdonisJS 并不强制你使用 Lucid。只需卸载该包并安装你选择的 ORM 即可。
安装
使用以下命令安装并配置 Lucid。
node ace add @adonisjs/lucid
-
在
adonisrc.ts文件中注册以下服务提供者。{providers: [// ...other providers() => import('@adonisjs/lucid/database_provider'),]} -
在
adonisrc.ts文件中注册以下命令。{commands: [// ...other commands() => import('@adonisjs/lucid/commands'),]} -
创建
config/database.ts文件。 -
定义所选方言的环境变量及其验证。
-
安装所需的对等依赖项。
创建你的第一个模型
配置完成后，你可以使用以下命令创建你的第一个模型。
node ace make:model User
此命令会在 app/models 目录下创建一个包含以下内容的新文件。
import { DateTime } from 'luxon'
import { BaseModel, column } from '@adonisjs/lucid/orm'
export default class User extends BaseModel {
@column({ isPrimary: true })
declare id: number
@column.dateTime({ autoCreate: true })
declare createdAt: DateTime
@column.dateTime({ autoCreate: true, autoUpdate: true })
declare updatedAt: DateTime
}
访问 官方文档 了解更多关于模型的信息。
迁移
迁移是一种使用增量变更集来修改数据库模式和数据的方法。你可以使用以下命令创建一个新的迁移。
node ace make:migration users
此命令会在 database/migrations 目录下创建一个包含以下内容的新文件。
import { BaseSchema } from '@adonisjs/lucid/schema'
export default class extends BaseSchema {
protected tableName = 'users'
async up() {
this.schema.createTable(this.tableName, (table) => {
table.increments('id')
table.timestamp('created_at')
table.timestamp('updated_at')
})
}
async down() {
this.schema.dropTable(this.tableName)
}
}
你可以使用以下命令运行所有挂起的迁移。
node ace migration:run
访问 官方文档 了解更多关于迁移的信息。
查询构建器
Lucid 附带了一个基于 Knex 构建的流畅查询构建器。你可以使用查询构建器对数据库执行 CRUD 操作。
import db from '@adonisjs/lucid/services/db'
/**
* 创建查询构建器实例
*/
const query = db.query()
/**
* 创建查询构建器实例并选择表
*/
const queryWithTableSelection = db.from('users')
查询构建器也可以限定于模型实例。
import User from '#models/user'
const user = await User.query().where('username', 'rlanz').first()
访问 官方文档 了解更多关于查询构建器的信息。
CRUD 操作
Lucid 模型具有内置方法来对数据库执行 CRUD 操作。
import User from '#models/user'
/**
* 创建一个新用户
*/
const user = await User.create({
username: 'rlanz',
email: 'romain@adonisjs.com',
})
/**
* 通过主键查找用户
*/
const user = await User.find(1)
/**
* 更新用户
*/
const user = await User.find(1)
user.username = 'romain'
await user.save()
/**
* 删除用户
*/
const user = await User.find(1)
await user.delete()
访问 官方文档 了解更多关于 CRUD 操作的信息。