前往 Vapor 2.0 - 文档目录
模型是数据库中Swift数据的展示。因此，它们对于大多数Fluent的api来说都是至关重要的。
本指南概述了与模型相关的协议需求和方法。
再瞧瞧
请参阅入门指南，了解如何使用模型。
增删改查（CRUD）
模型有几种基本的创建、读取、更新和删除的方法。
保存（Save）
将实体持久化到数据存储中并设置id属性。
let pet = Pet(name: "Spud", age: 2)
try pet.save()
查找（Find）
找到提供的标识符或返回nil的模型。
guard let pet = try Pets.find(42) else {
throw Abort.notFound
}
print(pet.name)
删除（Delete）
如果实体以前被获取或保存，则从数据存储中删除该实体。
try pet.delete()
全部（All）
为该模型返回所有实体。
for pet in try Pets.all() {
print(pet.name)
}
计数（Count）
返回该模型的所有实体的计数。
let count = try Pets.count()
数据块（Chunk）
返回为该模型的所有实体提供一个提供的大小的数组。
这是一种解析大型数据集的所有模型的好方法。
try Pets.chunk(20) { pets in
//
}
查询（Query）
为这个Model创建一个Query实例。
let query = try Pet.makeQuery()
要了解关于复杂查询的更多信息，请参见查询(query)部分。
时间戳（Timestamps）
要向您的模型添加时间戳，只需继承Timestampable。
extension User: Timestampable { }
您可以在任何模型实例上访问更新(updated at)和创建(created at)。
user.updatedAt // Date?
user.createdAt // Date?
当对时间戳数据进行过滤或排序时，您可以使用来自类的时间戳键。
let newUsers = try User
.makeQuery()
.filter(User.createdAtKey, .greaterThan, ...)
.all()
如果有定制的需要，还可以覆盖时间戳键。
extension User: Timestampable {
static var updatedAtKey: String { return "custom_updated_at" }
static var createdAtKey: String { return "custom_created_at" }
}
迁移（Migration）
Timestampable的模型将自动创建并更新在数据库创建(database create)调用期间添加的键。
如果您需要手动将Timestampable添加到现有的模型中，那么您可以在迁移中使用date()方法。
database.modify(User.self) { builder in
builder.date(User.createdAtKey)
builder.date(User.updatedAtKey)
}
软删除（Soft Delete）
“软删除”是一种“删除”模型，从所有获取和更新查询到流畅，但实际上并不是从数据库中删除模型。软删除的模型也可以恢复。
要使您的模型具有可软的可删除性，只需将其继承SoftDeletable。
extension User: SoftDeletable { }
一旦您的模型是软的，所有调用delete()的调用将在标记中设置删除，而不是实际删除模型。
要恢复模型，请调用.restore()。要从数据库中删除一个模型，请调用.forceDelete()。
如果您有定制的需要，也可以覆盖软删除键。
extension User: SoftDeletable {
static var deletedAtKey: String { return "custom_deleted_at" }
}
包含删除（Including Deleted）
当一个模型被软删除时，它不会被任何用流利的查询构建器所做的查询所影响。
要包含软删除的模型，例如，如果您想要恢复它们，请使用query builder中的.withSoftDeleted()方法。
let allUsers = try User.makeQuery().withSoftDeleted().all()
生命周期（Lifecycle）
您可以连接到模型的软删除事件。
extension User: SoftDeletable {
func willSoftDelete() throws { ... }
func didSoftDelete() { ... }
func willForceDelete() throws { ... }
func didForceDelete() { ... }
func willRestore() throws { ... }
func didRestore() { ... }
}
笔记
在一个will钩子上投掷，将阻止动作的发生。
迁移（Migration）
SoftDeletable模型将自动在数据库创建(database create )调用期间添加一个删除键。
如果您需要手动添加一个现有模型的SoftDeletable，您可以在迁移中使用date()方法。
database.modify(User.self) { builder in
builder.date(User.deletedAtKey, optional: true)
}
便利（Convenience）
断言存在（Assert Exists）
模型的标识符属性是可选的，因为模型可能还没有被保存。
如果模型还没有通过调用assertExists()来保存，那么您可以获得标识符或者抛出错误。
let id = try pet.assertExists()
print(id) // not optional
生命周期（Life Cycle）
可以在您的模型上实现以下生命周期方法，以便将其连接到内部操作。
/// Called before the entity will be created.在创建实体之前调用。
/// Throwing will cancel the creation.投掷将会取消创建。
func willCreate() throws
/// Called after the entity has been created.在创建实体之后调用。
func didCreate()
/// Called before the entity will be updated.在实体将被更新之前调用。
/// Throwing will cancel the update.投掷将会取消更新。
func willUpdate() throws
/// Called after the entity has been updated.在实体更新后调用。
func didUpdate()
/// Called before the entity will be deleted.在实体被删除之前调用。
/// Throwing will cancel the deletion.投掷将取消删除。
func willDelete() throws
/// Called after the entity has been deleted.该实体已被删除。
func didDelete()
笔记
抛出一个willFoo()方法将取消操作。
下面是实现didDelete方法的一个示例。
final class Pet: Model {
...
func didDelete() {
print("Deleted \(name)")
}
}
实体（Entity）
实体是模型遵循的基本的流畅协议。在保存、获取或删除模型时，它负责提供数据库或查询可能需要的所有信息。
名字（Name）
这个模型的唯一关系名称。也用于内部存储。例如:Pet=“pet”。
这种价值通常不应该过分夸大。
final class Pet: Model {
static let name = "pet"
}
实体（Entity）
这个模型的复数关系名称。用作集合或表名。
例如:Pet=“pets”。
如果您的模型的表名是非标准的，那么这个值应该被覆盖。
final class Pet: Model {
static let entity = "pets"
}
ID类型（ID Type）
用于本地和外id键的标识符类型。
例如:uuid,integer,等等。
如果数据库中的某个特定模型使用了不同的ID类型，那么该值应该被过度使用。
final class Pet: Model {
static let idType: IdentifierType = .uuid
}
还可以使用配置在数据库级别上覆盖这一层。
Config/fluent.json
{
"idType": "uuid"
}
或用编程。
drop.database?.idType = .uuid
关键的命名约定（Key Naming Convention）
用于外id键、表名等的命名传输。
例如:snake_case与camelCase。
如果数据库中的某个特定模型使用不同的键命名约定，那么该值应该被覆盖。
final class Pet: Model {
static let keyNamingConvention = .snake_case
}
还可以使用配置在数据库级别上覆盖这一层。
Config/fluent.json
{
"keyNamingConvention": "snake_case"
}
或用编程。
drop.database?.keyNamingConvention = .snake_case
ID Key
与该实体的标识键对应的列的名称。
默认的是“database.driver.idKey”，然后是“id”
final class Pet: Model {
static let idKey = "id"
}
外来的ID KEY（Foreign ID Key）
当从其他表或集合引用时，指向该实体的id的列的名称。
例如:“foo_id”。
final class Pet: Model {
static let foreignIdKey = "pet_id"
}