约定

使用 ID 作为主键

默认情况下，IBest-ORM 会使用 ID 作为表的主键。你可以通过标签 primaryKey 将其它字段设为主键。

@Table
export class User {
    @Field({ type: FieldType.INTEGER, tag: ['primaryKey'] })
    UID?: number
  
    @Field({ type: FieldType.TEXT })
    Name?: string
}

表名

您可以通过 @Table 装饰器参数来更改默认表名，例如：

@Table("user")
export class User {}

如果未指定，则使用类名作为默认的表名。

临时指定表名

您可以使用 Table 方法临时指定表名，例如：

let users = this.db.Table("user").Where("age", 18).Find();

列名

您可以通过 @Field 装饰器的name参数来更改默认列名，例如：

@Table
export class User {
  @Field({ type: FieldType.TEXT })
  UserName?: string
  
  @Field({ type: FieldType.INTEGER, name: "user_id"})
  UserId?: number
}

如果未指定，则使用属性的名称的 蛇形命名 作为默认的列名。

@Table
export class User {
  @Field({ type: FieldType.INTEGER })
  ID?: number           // 列名是 `id`
  
  @Field({ type: FieldType.TEXT })
  Name?: string         // 列名是 `name`

  @Field({ type: FieldType.TEXT })
  CreatedAt: string     // 列名是 `created_at`
}