Toshihiko
    Preparing search index...

    Module toshihiko

    Toshihiko

    The database entry point used to define models and execute Adapter-level operations.

    Model

    The table-level API returned by Toshihiko.define.

    ModelOptions

    Options shared by models created with Toshihiko.define.

    Query

    A mutable, chainable description of one database operation.

    QueryFieldOperators

    Operators accepted for one field in a query condition.

    QueryFindManyOptions

    Options which request multiple rows.

    QueryFindOneOptions

    Options which request one row.

    QueryFindOptions

    Options shared by query find operations.

    Yukari

    One mutable row belonging to a Model.

    ModelDefinitionOptions

    Options accepted while defining a model.

    QueryFieldCondition

    A direct value or an operator object for one field.

    QueryOrder

    Sort expressions accepted by Query.order.

    QueryOrderDirection

    Sort direction accepted by Query.order.

    QueryWhere

    A typed query condition for a model row.

    Field

    The runtime representation of one compiled schema entry.

    FieldDefinition

    A schema entry which retains its field name and Field Type.

    SchemaFieldDefinition

    The common shape accepted for one entry in a Toshihiko schema.

    FieldType

    Defines conversion between storage, application, and JSON values.

    FieldValidator

    A validator executed before a Yukari row is written.

    SchemaDefinition

    A readonly list of field definitions accepted by Toshihiko.define.

    Type

    Built-in Field Types used by schema definitions.

    Cache

    Contract implemented by a Toshihiko cache backend.

    Adapter

    Contract implemented by a Toshihiko database adapter.

    Adapter

    Built-in adapter constructors.

    AdapterConstructor

    Constructor shape accepted by the Toshihiko constructor.

    AdapterData

    One compiled Field and application value crossing the Adapter boundary.

    AdapterExecuteSpec

    Declares the arguments and result propagated to Toshihiko and Query execute methods by a custom Adapter.

    AdapterFindOptions

    Normalized options passed from Query to an Adapter find operation.

    AdapterLike

    Minimum structural contract required for Adapter type inference.

    AdapterQuery

    Complete normalized query state received by an Adapter.

    CacheModule

    Legacy module shape used by Toshihiko.createCache.

    CacheOptions

    Module-style Cache configuration retained for v1 compatibility.

    AdapterBeginTransactionArguments

    Disables transaction start when an Adapter does not declare support.

    AdapterCommitArguments

    Disables commit when an Adapter does not declare support.

    AdapterCommitResult

    Extracts the resolved result of Adapter transaction commit.

    AdapterConnection

    Extracts the non-null transaction connection accepted by an Adapter.

    AdapterCountQueryType

    Extracts the Query shape accepted by an Adapter count operation.

    AdapterDeleteByQueryResult

    Extracts the resolved result of Adapter bulk delete.

    AdapterDeleteQueryType

    Extracts the Query shape accepted by Adapter bulk delete.

    AdapterExecuteArguments

    Extracts arguments accepted by Toshihiko.execute().

    AdapterExecuteResult

    Extracts the resolved value of Adapter raw execution.

    adapterExecuteSpec

    Type-only marker used to carry an Adapter's execute specification.

    AdapterFindResult

    Row shape returned by an Adapter find implementation.

    AdapterModel

    Extracts the Model type accepted by an Adapter instance.

    AdapterOperationResult

    Common result values accepted from Adapter write operations.

    AdapterQueryExecuteArguments

    Extracts arguments accepted by Query.execute().

    AdapterRollbackArguments

    Disables rollback when an Adapter does not declare support.

    AdapterRollbackResult

    Extracts the resolved result of Adapter transaction rollback.

    AdapterRow

    One storage row returned by an Adapter.

    AdapterSource

    Adapter name, instance, or constructor accepted by Toshihiko.

    AdapterTransactionConnection

    Extracts the connection returned by Adapter transaction start.

    AdapterUpdateByQueryCallArguments

    Disables Query bulk update when an Adapter does not declare support.

    AdapterUpdateByQueryResult

    Extracts the resolved result of optional Adapter bulk update.

    AdapterUpdateByQueryType

    Extracts the Query shape accepted by optional Adapter bulk update.

    AdapterUpdateConnection

    Extracts the transaction connection accepted by Adapter update.

    AdapterUpdateField

    Extracts the compiled Field type accepted by Adapter update.

    AdapterUpdateModel

    Extracts the Model type accepted by an Adapter update operation.

    AdapterUpdateValue

    Extracts the application value accepted by Adapter update.

    BooleanStorageValue

    Storage values accepted by Type.Boolean.parse().

    BuildInput

    Schema-restricted input accepted by Model.build.

    BuiltRowFromSchema

    Row shape returned by build(): supplied and defaulted fields are known, while the remaining schema fields stay optional.

    BuiltYukari

    Yukari created locally by Model.build, with input-sensitive fields.

    CacheDeleteKeysResult

    Backend-specific result returned when deleting multiple cached rows.

    CacheDeleteResult

    Backend-specific result returned when deleting one cached row.

    CacheKey

    A single lookup key accepted by Cache implementations.

    CacheSetResult

    Backend-specific result returned after writing one cached row.

    CacheSource

    Existing Cache instance or module-style Cache configuration.

    CompiledSchema

    Maps every schema entry to its runtime Field.

    DataRow

    A row whose field names are not known until a schema or driver supplies them.

    DataValue

    A value that can be stored in a model field or returned by an adapter.

    DatetimeStorageValue

    Storage values accepted by Type.Datetime.parse().

    DefaultAdapterExecuteSpec

    Fallback execute specification for untyped Adapter implementations.

    FieldDefinitionJsonValue

    Resolves the JSON value produced by one schema entry's Field Type.

    FieldDefinitionNonNullValue

    Resolves one schema entry's non-null application value.

    FieldDefinitionStorageValue

    Resolves the storage value produced by one schema entry's Field Type.

    FieldName

    Extracts string field names from a row object.

    FieldNamesMap

    Maps logical schema field names to compiled Fields.

    FieldTypeStorageValue

    Resolves the storage value returned by a Field Type's restore() method.

    FindByIdInput

    Primary-key value or object accepted by Query.findById.

    InferModelPrimaryKey

    Extracts logical primary-key field names from a Model.

    InferModelRow

    Extracts the complete application row type from a Model.

    JsonRowFromSchema

    Maps a Schema to its serialized row object.

    JsonStorageValue

    Storage values accepted by Type.Json.parse().

    JsonValue

    A recursively serializable JSON value.

    NameToColumnMap

    Maps logical schema field names to storage column names.

    NumberStorageValue

    Storage values accepted by numeric Field Types.

    PrimaryKeyNames

    Extracts the logical names of fields marked with primaryKey: true.

    QueriedYukari

    Yukari loaded from storage, with fields optional after projection.

    QueryJsonRow

    Serialized partial row returned by a field-selecting Query.

    RowFromSchema

    Maps a Schema to its application row object.

    RowShape

    Minimum object constraint used by schema-aware row helpers.

    StringStorageValue

    Storage values accepted by Type.String.parse().

    ToshihikoOptions

    Default option constraint used when an Adapter does not declare its own.

    ValidatedFieldType

    Verifies that a Field Type's conversion and comparison methods agree on the same application and storage values. Invalid definitions resolve to never.

    ValidatedSchema

    Applies Field Type and validator consistency checks to every schema entry.

    YukariFieldData

    One compiled Field and application value sent to an Adapter write.

    Escaper

    SQL string and LIKE pattern escaping helpers.