内置数据结构

Koishi 的数据库 API 实际上分为两部分：

• @koishijs/core 中定义的内置数据结构
• minato 中提供的 ORM 接口

这一页中将仅展示第一部分的内容。

内置表

User

• id: string 内部编号
• name: string 用户昵称
• flag: number 状态标签
• authority: number 用户权限

Channel

• id: string 频道标识符
• flag: number 状态标签
• assignee: string 代理者

全局接口

User.Flag, Channel.Flag

所有用户 / 频道状态标签构成的枚举类型。参见 状态标签。

内置实例方法

下列实例方法直接由 @koishijs/core 提供实现。

database.getUser(platform, id, modifier?)

• platform: string 平台名
• id: string | string[] 用户标识符
• modifier: QueryModifier<User.Field> 请求修饰符
• 返回值: Promise<User | User[]> 用户数据

向数据库请求用户数据。如果传入的 id 是一个列表，则返回值也应当是一个列表。

database.setUser(platform, id, data)

• platform: string 平台名
• id: string 用户标识符
• data: User 要修改 / 添加的数据
• 返回值: Promise<void>

向数据库修改或添加用户数据。

database.getChannel(platform, id, fields?)

• platform: string 平台名
• id: string | string[] 频道标识符
• fields: QueryModifier<User.Field> 请求修饰符
• 返回值: Promise<Channel | Channel[]> 频道数据

向数据库请求频道数据。如果传入的 id 是一个列表，则返回值也应当是一个列表。

database.getAssignedChannels(fields?, platform?, assignees?) deprecated

• fields: ChannelField[] 请求的字段，默认为全部字段
• platform: string 平台名，默认为全平台
• assignees: string[] 代理者列表，默认为当前运行的全部机器人
• 返回值: Promise<Channel[]> 频道数据列表

向数据库请求被特定机器人管理的所有频道数据。这里的两个参数可以写任意一个，都可以识别。

database.setChannel(platform, id, data)

• platform: string 平台名
• id: number 频道标识符
• data: Channel 要修改 / 添加的数据
• 返回值: Promise<void>

向数据库修改或添加频道数据。