Toshihiko
    正在准备搜索索引...

    模块 toshihiko

    Toshihiko

    用于定义 Model 和执行 Adapter 层操作的数据库入口。

    Model

    以下方法返回的表级 API:Toshihiko.define。

    ModelOptions

    由以下方法创建的 Model 共享的选项:Toshihiko.define。

    Query

    对一次数据库操作的可变、可链式描述。

    QueryFieldOperators

    查询条件中一个字段接受的操作符。

    QueryFindManyOptions

    请求返回多行的选项。

    QueryFindOneOptions

    请求返回一行的选项。

    QueryFindOptions

    Query find 操作共享的选项。

    Yukari

    属于一个 Model 的可变数据行。

    ModelDefinitionOptions

    定义 Model 时接受的选项。

    QueryFieldCondition

    一个字段的直接值或操作符对象。

    QueryOrder

    以下方法接受的排序表达式:Query.order。

    QueryOrderDirection

    以下方法接受的排序方向:Query.order。

    QueryWhere

    针对 Model 数据行的类型化查询条件。

    Field

    一个编译后 schema 条目的运行时表示。

    FieldDefinition

    保留字段名和 Field Type 的 schema 条目。

    SchemaFieldDefinition

    Toshihiko schema 中一个条目接受的通用结构。

    FieldType

    定义存储层、应用层和 JSON 值之间的转换。

    FieldValidator

    写入 Yukari 数据行前执行的 validator。

    SchemaDefinition

    以下方法接受的只读字段定义列表:Toshihiko.define。

    Type

    schema 定义使用的内置 Field Type。

    Cache

    Toshihiko Cache 后端实现的契约。

    Adapter

    Toshihiko 数据库 Adapter 需要实现的契约。

    Adapter

    内置 Adapter 构造函数。

    AdapterConstructor

    Toshihiko 构造函数接受的构造函数结构。

    AdapterData

    跨越 Adapter 边界的一个编译后 Field 与应用层值。

    AdapterExecuteSpec

    声明自定义 Adapter 传递给 Toshihiko 和 Query execute 方法的参数与结果。

    AdapterFindOptions

    从 Query 传给 Adapter find 操作的规范化选项。

    AdapterLike

    Adapter 类型推断所需的最小结构契约。

    AdapterQuery

    Adapter 接收的完整规范化 Query 状态。

    CacheModule

    以下方法使用的旧版模块结构:Toshihiko.createCache。

    CacheOptions

    为兼容 v1 保留的模块式 Cache 配置。

    AdapterBeginTransactionArguments

    Adapter 未声明支持时,禁用事务开始操作。

    AdapterCommitArguments

    Adapter 未声明支持时,禁用 commit。

    AdapterCommitResult

    提取 Adapter 事务提交解析后的结果。

    AdapterConnection

    提取 Adapter 接受的非 null 事务连接。

    AdapterCountQueryType

    提取 Adapter count 操作接受的 Query 结构。

    AdapterDeleteByQueryResult

    提取 Adapter 批量删除解析后的结果。

    AdapterDeleteQueryType

    提取 Adapter 批量删除接受的 Query 结构。

    AdapterExecuteArguments

    提取以下方法接受的参数:Toshihiko.execute()。

    AdapterExecuteResult

    提取 Adapter 原始执行解析后的值。

    adapterExecuteSpec

    仅用于类型、承载 Adapter execute 规格的标记。

    AdapterFindResult

    Adapter find 实现返回的数据行结构。

    AdapterModel

    提取 Adapter 实例接受的 Model 类型。

    AdapterOperationResult

    Adapter 写操作接受的通用结果值。

    AdapterQueryExecuteArguments

    提取以下方法接受的参数:Query.execute()。

    AdapterRollbackArguments

    Adapter 未声明支持时,禁用 rollback。

    AdapterRollbackResult

    提取 Adapter 事务回滚解析后的结果。

    AdapterRow

    Adapter 返回的一行存储层数据。

    AdapterSource

    Toshihiko 接受的 Adapter 名称、实例或构造函数。

    AdapterTransactionConnection

    提取 Adapter 开始事务后返回的连接。

    AdapterUpdateByQueryCallArguments

    Adapter 未声明支持时,禁用 Query 批量更新。

    AdapterUpdateByQueryResult

    提取可选 Adapter 批量更新解析后的结果。

    AdapterUpdateByQueryType

    提取可选 Adapter 批量更新接受的 Query 结构。

    AdapterUpdateConnection

    提取 Adapter 更新接受的事务连接。

    AdapterUpdateField

    提取 Adapter 更新接受的编译后 Field 类型。

    AdapterUpdateModel

    提取 Adapter 更新操作接受的 Model 类型。

    AdapterUpdateValue

    提取 Adapter 更新接受的应用层值。

    BooleanStorageValue

    以下方法接受的存储层值:Type.Boolean.parse()。

    BuildInput

    以下方法接受、且受 schema 限制的输入:Model.build。

    BuiltRowFromSchema

    以下方法返回的数据行结构:build():调用方提供的字段和带默认值的字段会被视为确定存在,其余 schema 字段保持可选。

    BuiltYukari

    由以下方法在本地创建的 Yukari:Model.build,并保留由输入决定的字段。

    CacheDeleteKeysResult

    删除多行缓存后返回的后端特有结果。

    CacheDeleteResult

    删除一行缓存后返回的后端特有结果。

    CacheKey

    Cache 实现接受的单个查询 key。

    CacheSetResult

    写入一行缓存后返回的后端特有结果。

    CacheSource

    现有 Cache 实例或模块式 Cache 配置。

    CompiledSchema

    把每个 schema 条目映射为运行时 Field。

    DataRow

    字段名要到 schema 或驱动提供后才能确定的数据行。

    DataValue

    可以存入 Model 字段或由 Adapter 返回的值。

    DatetimeStorageValue

    以下方法接受的存储层值:Type.Datetime.parse()。

    DefaultAdapterExecuteSpec

    无类型 Adapter 实现使用的后备 execute 规格。

    FieldDefinitionJsonValue

    解析一个 schema 条目的 Field Type 生成的 JSON 值。

    FieldDefinitionNonNullValue

    解析一个 schema 条目的非 null 应用层值。

    FieldDefinitionStorageValue

    解析一个 schema 条目的 Field Type 生成的存储层值。

    FieldName

    从数据行对象提取字符串字段名。

    FieldNamesMap

    把逻辑 schema 字段名映射为编译后 Field。

    FieldTypeStorageValue

    解析 Field Type 的以下方法返回的存储层值:restore() 方法。

    FindByIdInput

    以下方法接受的主键值或对象:Query.findById。

    InferModelPrimaryKey

    从 Model 提取逻辑主键字段名。

    InferModelRow

    从 Model 提取完整应用层数据行类型。

    JsonRowFromSchema

    把 Schema 映射为序列化数据行对象。

    JsonStorageValue

    以下方法接受的存储层值:Type.Json.parse()。

    JsonValue

    可递归序列化的 JSON 值。

    NameToColumnMap

    把逻辑 schema 字段名映射为存储列名。

    NumberStorageValue

    数值 Field Type 接受的存储层值。

    PrimaryKeyNames

    提取带有以下标记的字段逻辑名:primaryKey: true。

    QueriedYukari

    从存储层加载的 Yukari;字段经过投影后为可选。

    QueryJsonRow

    选择字段的 Query 返回的部分序列化数据行。

    RowFromSchema

    把 Schema 映射为应用层数据行对象。

    RowShape

    能够感知 schema 的数据行辅助类型使用的最小对象约束。

    StringStorageValue

    以下方法接受的存储层值:Type.String.parse()。

    ToshihikoOptions

    Adapter 未声明自身约束时使用的默认选项约束。

    ValidatedFieldType

    验证 Field Type 的转换与比较方法是否对同一组应用层值和存储层值保持一致。无效定义会解析为 never。

    ValidatedSchema

    对每个 schema 条目检查 Field Type 与 validator 的一致性。

    YukariFieldData

    发送给 Adapter 写操作的一个编译后 Field 与应用层值。

    Escaper

    SQL 字符串和 LIKE 模式转义辅助函数。