Interface Model<Name, Schema, AdapterInstance>

The table-level API returned by Toshihiko.define.

A Model compiles the supplied schema, creates Query builders, constructs Yukari rows, and exposes schema-aware metadata. Query entry methods always create a fresh Query instance.

interface Model<
    Name extends string,
    Schema extends SchemaDefinition,
    AdapterInstance extends AdapterLike = Adapter,
> {
    ai: Field<Schema[number]> | null;
    autoIncrementField: Field<Schema[number]> | null;
    cache: Cache | null;
    columnToName: Readonly<Record<string, FieldName<RowFromSchema<Schema>>>>;
    fieldColumnsMap: Readonly<Record<string, Field<Schema[number]>>>;
    fieldNamesMap: FieldNamesMap<Schema>;
    name: Name;
    nameToColumn: NameToColumnMap<Schema>;
    options: ModelOptions;
    originalSchema: Schema;
    parent: Toshihiko<AdapterInstance>;
    primaryKeys: readonly Field<Schema[number]>[];
    schema: CompiledSchema<Schema>;
    get toshihiko(): Toshihiko<AdapterInstance>;
    beginTransaction(
        ...support: AdapterBeginTransactionArguments<AdapterInstance>,
    ): Promise<AdapterTransactionConnection<AdapterInstance>>;
    build<const Input extends Partial<RowFromSchema<Schema>>>(
        fields: NoUnknownBuildFields<Schema, Input>,
    ): BuiltYukari<Name, Schema, Input, AdapterInstance>;
    commit(
        ...connection: AdapterCommitArguments<AdapterInstance>,
    ): Promise<AdapterCommitResult<AdapterInstance>>;
    conn(
        connection: AdapterConnection<AdapterInstance> | null,
    ): Query<Name, Schema, AdapterInstance>;
    convertColumnToName(
        column: string,
    ): FieldName<RowFromSchema<Schema>> | undefined;
    convertColumnToName(
        columns: readonly string[],
    ): readonly (FieldName<RowFromSchema<Schema>> | undefined)[];
    convertColumnToName(object: DataRow): DataRow;
    count(): Promise<number>;
    delete(): Promise<AdapterDeleteByQueryResult<AdapterInstance>>;
    execute(
        ...arguments_: AdapterQueryExecuteArguments<AdapterInstance>,
    ): Promise<AdapterExecuteResult<AdapterInstance>>;
    field(
        fields: string | readonly FieldName<RowFromSchema<Schema>>[],
    ): Query<Name, Schema, AdapterInstance>;
    fields(
        fields: string | readonly FieldName<RowFromSchema<Schema>>[],
    ): Query<Name, Schema, AdapterInstance>;
    find(): Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>;
    find(
        options: QueryFindManyOptions,
    ): Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>;
    find(
        options: QueryFindOneOptions,
    ): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>;
    find(
        toJSON: false,
        options?: QueryFindManyOptions,
    ): Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>;
    find(
        toJSON: false,
        options: QueryFindOneOptions,
    ): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>;
    find(
        toJSON: true,
        options?: QueryFindManyOptions,
    ): Promise<readonly Partial<JsonRowFromSchema<Schema>>[]>;
    find(
        toJSON: true,
        options: QueryFindOneOptions,
    ): Promise<Partial<JsonRowFromSchema<Schema>> | null>;
    find(
        options: QueryFindManyOptions,
        toJSON: true,
    ): Promise<readonly Partial<JsonRowFromSchema<Schema>>[]>;
    find(
        options: QueryFindOneOptions,
        toJSON: false,
    ): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>;
    find(
        options: QueryFindOneOptions,
        toJSON: true,
    ): Promise<Partial<JsonRowFromSchema<Schema>> | null>;
    findById(
        id: FindByIdInput<Schema>,
    ): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>;
    findById(
        id: FindByIdInput<Schema>,
        toJSON: false,
    ): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>;
    findById(
        id: FindByIdInput<Schema>,
        toJSON: true,
    ): Promise<Partial<JsonRowFromSchema<Schema>> | null>;
    findOne(): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>;
    findOne(
        toJSON: false,
    ): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>;
    findOne(toJSON: true): Promise<Partial<JsonRowFromSchema<Schema>> | null>;
    getPrimaryKeysColumn(): string | readonly string[];
    getPrimaryKeysName(): string | readonly string[];
    index(indexName: string): Query<Name, Schema, AdapterInstance>;
    limit(
        limit: string | number | readonly (string | number)[],
    ): Query<Name, Schema, AdapterInstance>;
    limit(
        offset: string | number,
        count: string | number,
    ): Query<Name, Schema, AdapterInstance>;
    order(
        order: QueryOrder<RowFromSchema<Schema>>,
    ): Query<Name, Schema, AdapterInstance>;
    orderBy(
        order: QueryOrder<RowFromSchema<Schema>>,
    ): Query<Name, Schema, AdapterInstance>;
    rollback(
        ...connection: AdapterRollbackArguments<AdapterInstance>,
    ): Promise<AdapterRollbackResult<AdapterInstance>>;
    update(
        data: Partial<RowFromSchema<Schema>>,
        ...support: AdapterUpdateByQueryCallArguments<AdapterInstance>,
    ): Promise<AdapterUpdateByQueryResult<AdapterInstance>>;
    where(
        condition: QueryWhere<RowFromSchema<Schema>>,
    ): Query<Name, Schema, AdapterInstance>;
}

Type Parameters

Name extends string
Schema extends SchemaDefinition
AdapterInstance extends AdapterLike = Adapter

Hierarchy

EventEmitter2
- Model

Properties

ai

ai: Field<Schema[number]> | null

Compatibility alias for autoIncrementField.

`Readonly`autoIncrementField

autoIncrementField: Field<Schema[number]> | null

Compiled field marked with autoIncrement: true, when present.

`Readonly`cache

cache: Cache | null

Cache selected by Model options or inherited from the parent Toshihiko.

`Readonly`columnToName

columnToName: Readonly<Record<string, FieldName<RowFromSchema<Schema>>>>

Storage column name to logical field name.

`Readonly`fieldColumnsMap

fieldColumnsMap: Readonly<Record<string, Field<Schema[number]>>>

Storage column name to compiled Field.

`Readonly`fieldNamesMap

fieldNamesMap: FieldNamesMap<Schema>

Logical field name to compiled Field.

`Readonly`name

name: Name

Table or collection name passed to Toshihiko.define.

`Readonly`nameToColumn

nameToColumn: NameToColumnMap<Schema>

Logical field name to storage column name.

`Readonly`options

options: ModelOptions

Model options passed to Toshihiko.define.

`Readonly`originalSchema

originalSchema: Schema

Exact schema array passed to Toshihiko.define.

`Readonly`parent

parent: Toshihiko<AdapterInstance>

Toshihiko instance which owns this Model.

`Readonly`primaryKeys

primaryKeys: readonly Field<Schema[number]>[]

Compiled fields marked with primaryKey: true.

`Readonly`schema

schema: CompiledSchema<Schema>

Runtime Field objects compiled from originalSchema.

Accessors

toshihiko

get toshihiko(): Toshihiko<AdapterInstance>
Compatibility getter for parent.

Returns Toshihiko<AdapterInstance>
- Defined in contracts/model.ts:345

Methods

beginTransaction

beginTransaction(
...support: AdapterBeginTransactionArguments<AdapterInstance>,
): Promise<AdapterTransactionConnection<AdapterInstance>>
Begins a transaction through the selected Adapter.

This method is callable only when the Adapter declares transaction support.
Parameters
- ...support: AdapterBeginTransactionArguments<AdapterInstance>
Returns Promise<AdapterTransactionConnection<AdapterInstance>>
The Adapter-specific transaction connection.
- Defined in contracts/model.ts:363

build

build<const Input extends Partial<RowFromSchema<Schema>>>(
fields: NoUnknownBuildFields<Schema, Input>,
): BuiltYukari<Name, Schema, Input, AdapterInstance>
Creates a new Yukari row without writing it.

Input keys are restricted to schema fields. Supplied fields and fields with defaults are known to exist on the returned type; other fields remain optional until assigned or loaded.
Type Parameters
- const Input extends Partial<RowFromSchema<Schema>>
Parameters
- fields: NoUnknownBuildFields<Schema, Input>
  Initial application values keyed by logical field name.
Returns BuiltYukari<Name, Schema, Input, AdapterInstance>
A newly built Yukari ready for Yukari.insert or Yukari.save.
Example
```
const user = User.build({ email: 'yukari@example.com' });
await user.save();
```
- Defined in contracts/model.ts:439

commit

commit(
...connection: AdapterCommitArguments<AdapterInstance>,
): Promise<AdapterCommitResult<AdapterInstance>>
Commits an Adapter transaction connection.
Parameters
- ...connection: AdapterCommitArguments<AdapterInstance>
  Connection returned by beginTransaction.
Returns Promise<AdapterCommitResult<AdapterInstance>>
The Adapter-defined commit result.
- Defined in contracts/model.ts:384

conn

conn(
connection: AdapterConnection<AdapterInstance> | null,
): Query<Name, Schema, AdapterInstance>
Creates a fresh Query and applies Query.conn.
Parameters
- connection: AdapterConnection<AdapterInstance> | null
Returns Query<Name, Schema, AdapterInstance>
- Defined in contracts/model.ts:526

convertColumnToName

convertColumnToName(
column: string,
): FieldName<RowFromSchema<Schema>> | undefined
Converts storage column names to logical schema field names.

Unknown columns return undefined for string or array input and are omitted from object input.
Parameters
- column: string
  One storage column name. Overloads also accept an array of column names or a row keyed by column name.
Returns FieldName<RowFromSchema<Schema>> | undefined
The corresponding logical name or converted structure.
- Defined in contracts/model.ts:713
convertColumnToName(
columns: readonly string[],
): readonly (FieldName<RowFromSchema<Schema>> | undefined)[]
Converts storage column names to logical schema field names.

Unknown columns return undefined for string or array input and are omitted from object input.
Parameters
- columns: readonly string[]
Returns readonly (FieldName<RowFromSchema<Schema>> | undefined)[]
The corresponding logical name or converted structure.
- Defined in contracts/model.ts:714
convertColumnToName(object: DataRow): DataRow
Converts storage column names to logical schema field names.

Unknown columns return undefined for string or array input and are omitted from object input.
Parameters
- object: DataRow
Returns DataRow
The corresponding logical name or converted structure.
- Defined in contracts/model.ts:715

count

count(): Promise<number>
Counts all rows through a fresh Query.

Returns Promise<number>
- Defined in contracts/model.ts:535

delete

delete(): Promise<AdapterDeleteByQueryResult<AdapterInstance>>
Deletes rows through a fresh Query with no condition.

Use where first unless deleting the entire table is intentional.

Returns Promise<AdapterDeleteByQueryResult<AdapterInstance>>
- Defined in contracts/model.ts:568

execute

execute(
...arguments_: AdapterQueryExecuteArguments<AdapterInstance>,
): Promise<AdapterExecuteResult<AdapterInstance>>
Executes an Adapter-specific raw operation through a fresh Query.
Parameters
- ...arguments_: AdapterQueryExecuteArguments<AdapterInstance>
Returns Promise<AdapterExecuteResult<AdapterInstance>>
- Defined in contracts/model.ts:577

field

field(
fields: string | readonly FieldName<RowFromSchema<Schema>>[],
): Query<Name, Schema, AdapterInstance>
Creates a fresh Query and applies the Query.field alias.
Parameters
- fields: string | readonly FieldName<RowFromSchema<Schema>>[]
Returns Query<Name, Schema, AdapterInstance>
- Defined in contracts/model.ts:460

fields

fields(
fields: string | readonly FieldName<RowFromSchema<Schema>>[],
): Query<Name, Schema, AdapterInstance>
Creates a fresh Query and applies Query.fields.
Parameters
- fields: string | readonly FieldName<RowFromSchema<Schema>>[]
Returns Query<Name, Schema, AdapterInstance>
- Defined in contracts/model.ts:471

find

find(): Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>
Finds rows through a fresh Query.

The overloads and serialization behavior match Query.find.

Returns Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>
- Defined in contracts/model.ts:594
find(
options: QueryFindManyOptions,
): Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>
Finds rows through a fresh Query.

The overloads and serialization behavior match Query.find.
Parameters
- options: QueryFindManyOptions
Returns Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>
- Defined in contracts/model.ts:595
find(
options: QueryFindOneOptions,
): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>
Finds rows through a fresh Query.

The overloads and serialization behavior match Query.find.
Parameters
- options: QueryFindOneOptions
Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>
- Defined in contracts/model.ts:598
find(
toJSON: false,
options?: QueryFindManyOptions,
): Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>
Finds rows through a fresh Query.

The overloads and serialization behavior match Query.find.
Parameters
- toJSON: false
- Optionaloptions: QueryFindManyOptions
Returns Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>
- Defined in contracts/model.ts:601
find(
toJSON: false,
options: QueryFindOneOptions,
): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>
Finds rows through a fresh Query.

The overloads and serialization behavior match Query.find.
Parameters
- toJSON: false
- options: QueryFindOneOptions
Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>
- Defined in contracts/model.ts:605
find(
toJSON: true,
options?: QueryFindManyOptions,
): Promise<readonly Partial<JsonRowFromSchema<Schema>>[]>
Finds rows through a fresh Query.

The overloads and serialization behavior match Query.find.
Parameters
- toJSON: true
- Optionaloptions: QueryFindManyOptions
Returns Promise<readonly Partial<JsonRowFromSchema<Schema>>[]>
- Defined in contracts/model.ts:609
find(
toJSON: true,
options: QueryFindOneOptions,
): Promise<Partial<JsonRowFromSchema<Schema>> | null>
Finds rows through a fresh Query.

The overloads and serialization behavior match Query.find.
Parameters
- toJSON: true
- options: QueryFindOneOptions
Returns Promise<Partial<JsonRowFromSchema<Schema>> | null>
- Defined in contracts/model.ts:613
find(
options: QueryFindManyOptions,
toJSON: true,
): Promise<readonly Partial<JsonRowFromSchema<Schema>>[]>
Finds rows through a fresh Query.

The overloads and serialization behavior match Query.find.
Parameters
- options: QueryFindManyOptions
- toJSON: true
Returns Promise<readonly Partial<JsonRowFromSchema<Schema>>[]>
- Defined in contracts/model.ts:617
find(
options: QueryFindOneOptions,
toJSON: false,
): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>
Finds rows through a fresh Query.

The overloads and serialization behavior match Query.find.
Parameters
- options: QueryFindOneOptions
- toJSON: false
Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>
- Defined in contracts/model.ts:621
find(
options: QueryFindOneOptions,
toJSON: true,
): Promise<Partial<JsonRowFromSchema<Schema>> | null>
Finds rows through a fresh Query.

The overloads and serialization behavior match Query.find.
Parameters
- options: QueryFindOneOptions
- toJSON: true
Returns Promise<Partial<JsonRowFromSchema<Schema>> | null>
- Defined in contracts/model.ts:625

findById

findById(
id: FindByIdInput<Schema>,
): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>
Finds one row by primary key through a fresh Query.
Parameters
- id: FindByIdInput<Schema>
  Single primary-key value or composite-key object.
Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>
- Defined in contracts/model.ts:675
findById(
id: FindByIdInput<Schema>,
toJSON: false,
): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>
Finds one row by primary key through a fresh Query.
Parameters
- id: FindByIdInput<Schema>
  Single primary-key value or composite-key object.
- toJSON: false
Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>
- Defined in contracts/model.ts:678
findById(
id: FindByIdInput<Schema>,
toJSON: true,
): Promise<Partial<JsonRowFromSchema<Schema>> | null>
Finds one row by primary key through a fresh Query.
Parameters
- id: FindByIdInput<Schema>
  Single primary-key value or composite-key object.
- toJSON: true
Returns Promise<Partial<JsonRowFromSchema<Schema>> | null>
- Defined in contracts/model.ts:682

findOne

findOne(): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>
Finds at most one row through a fresh Query.

Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>
- Defined in contracts/model.ts:658
findOne(
toJSON: false,
): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>
Finds at most one row through a fresh Query.
Parameters
- toJSON: false
Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>
- Defined in contracts/model.ts:659
findOne(toJSON: true): Promise<Partial<JsonRowFromSchema<Schema>> | null>
Finds at most one row through a fresh Query.
Parameters
- toJSON: true
Returns Promise<Partial<JsonRowFromSchema<Schema>> | null>
- Defined in contracts/model.ts:660

getPrimaryKeysColumn

getPrimaryKeysColumn(): string | readonly string[]
Returns storage column names for primary keys.

Returns string | readonly string[]
One string for a single key, an array for composite keys, or an empty array when the Model has no primary key.
- Defined in contracts/model.ts:754

getPrimaryKeysName

getPrimaryKeysName(): string | readonly string[]
Returns logical primary-key names.

Returns string | readonly string[]
One string for a single key, an array for composite keys, or an empty array when the Model has no primary key.
- Defined in contracts/model.ts:739

index

index(indexName: string): Query<Name, Schema, AdapterInstance>
Creates a fresh Query and applies Query.index.
Parameters
- indexName: string
Returns Query<Name, Schema, AdapterInstance>
- Defined in contracts/model.ts:499

limit

limit(
limit: string | number | readonly (string | number)[],
): Query<Name, Schema, AdapterInstance>
Creates a fresh Query and applies Query.limit.
Parameters
- limit: string | number | readonly (string | number)[]
Returns Query<Name, Schema, AdapterInstance>
- Defined in contracts/model.ts:482
limit(
offset: string | number,
count: string | number,
): Query<Name, Schema, AdapterInstance>
Creates a fresh Query and applies Query.limit.
Parameters
- offset: string | number
- count: string | number
Returns Query<Name, Schema, AdapterInstance>
- Defined in contracts/model.ts:483

order

order(
order: QueryOrder<RowFromSchema<Schema>>,
): Query<Name, Schema, AdapterInstance>
Creates a fresh Query and applies Query.order.
Parameters
- order: QueryOrder<RowFromSchema<Schema>>
Returns Query<Name, Schema, AdapterInstance>
- Defined in contracts/model.ts:508

orderBy

orderBy(
order: QueryOrder<RowFromSchema<Schema>>,
): Query<Name, Schema, AdapterInstance>
Creates a fresh Query and applies the Query.orderBy alias.
Parameters
- order: QueryOrder<RowFromSchema<Schema>>
Returns Query<Name, Schema, AdapterInstance>
- Defined in contracts/model.ts:517

rollback

rollback(
...connection: AdapterRollbackArguments<AdapterInstance>,
): Promise<AdapterRollbackResult<AdapterInstance>>
Rolls back an Adapter transaction connection.
Parameters
- ...connection: AdapterRollbackArguments<AdapterInstance>
  Connection returned by beginTransaction.
Returns Promise<AdapterRollbackResult<AdapterInstance>>
The Adapter-defined rollback result.
- Defined in contracts/model.ts:404

update

update(
data: Partial<RowFromSchema<Schema>>,
...support: AdapterUpdateByQueryCallArguments<AdapterInstance>,
): Promise<AdapterUpdateByQueryResult<AdapterInstance>>
Updates rows through a fresh Query with no condition.

Use where first unless updating the entire table is intentional.
Parameters
- data: Partial<RowFromSchema<Schema>>
- ...support: AdapterUpdateByQueryCallArguments<AdapterInstance>
Returns Promise<AdapterUpdateByQueryResult<AdapterInstance>>
- Defined in contracts/model.ts:550

where

where(
condition: QueryWhere<RowFromSchema<Schema>>,
): Query<Name, Schema, AdapterInstance>
Creates a fresh Query and applies Query.where.
Parameters
- condition: QueryWhere<RowFromSchema<Schema>>
Returns Query<Name, Schema, AdapterInstance>
- Defined in contracts/model.ts:451

Interface Model<Name, Schema, AdapterInstance>

Type Parameters

Hierarchy

Index

Properties

Accessors

Methods

Properties

ai

ReadonlyautoIncrementField

Readonlycache

ReadonlycolumnToName

ReadonlyfieldColumnsMap

ReadonlyfieldNamesMap

Readonlyname

ReadonlynameToColumn

Readonlyoptions

ReadonlyoriginalSchema

Readonlyparent

ReadonlyprimaryKeys

Readonlyschema

Accessors

toshihiko

Returns Toshihiko<AdapterInstance>

Methods

beginTransaction

Parameters

Returns Promise<AdapterTransactionConnection<AdapterInstance>>

build

Type Parameters

Parameters

Returns BuiltYukari<Name, Schema, Input, AdapterInstance>

Example

commit

Parameters

Returns Promise<AdapterCommitResult<AdapterInstance>>

conn

Parameters

Returns Query<Name, Schema, AdapterInstance>

convertColumnToName

Parameters

Returns FieldName<RowFromSchema<Schema>> | undefined

Parameters

Returns readonly (FieldName<RowFromSchema<Schema>> | undefined)[]

Parameters

Returns DataRow

count

Returns Promise<number>

delete

Returns Promise<AdapterDeleteByQueryResult<AdapterInstance>>

execute

Parameters

Returns Promise<AdapterExecuteResult<AdapterInstance>>

field

Parameters

Returns Query<Name, Schema, AdapterInstance>

fields

Parameters

Returns Query<Name, Schema, AdapterInstance>

find

Returns Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>

Parameters

Returns Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>

Parameters

Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

Parameters

Returns Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>

Parameters

Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

Parameters

Returns Promise<readonly Partial<JsonRowFromSchema<Schema>>[]>

Parameters

Returns Promise<Partial<JsonRowFromSchema<Schema>> | null>

Parameters

Returns Promise<readonly Partial<JsonRowFromSchema<Schema>>[]>

Parameters

Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

Parameters

Returns Promise<Partial<JsonRowFromSchema<Schema>> | null>

findById

`Readonly`autoIncrementField

`Readonly`cache

`Readonly`columnToName

`Readonly`fieldColumnsMap

`Readonly`fieldNamesMap

`Readonly`name

`Readonly`nameToColumn

`Readonly`options

`Readonly`originalSchema

`Readonly`parent

`Readonly`primaryKeys

`Readonly`schema