Class Toshihiko<AdapterInstance, Options>

constructor

• new Toshihiko<
      AdapterInstance extends
          AdapterLike = Adapter<
          object,
          object,
          object,
          DataValue,
          AdapterQuery<
              object,
              object,
              object
              | null,
              Readonly<Record<string, DataValue>>,
              Readonly<Record<string, DataValue>>,
          >,
          DefaultAdapterExecuteSpec,
      >,
      Options extends object = object,
  >(
      adapter: string,
      ...__namedParameters: {} extends Options
          ? readonly [Options | undefined]
          : readonly [Options],
  ): Toshihiko<AdapterInstance, Options>

  Type Parameters

  • AdapterInstance extends AdapterLike = Adapter<
        object,
        object,
        object,
        DataValue,
        AdapterQuery<
            object,
            object,
            object
            | null,
            Readonly<Record<string, DataValue>>,
            Readonly<Record<string, DataValue>>,
        >,
        DefaultAdapterExecuteSpec,
    >
  • Options extends object = object

  Parameters

  • adapter: string
  • ...__namedParameters: {} extends Options ? readonly [Options | undefined] : readonly [Options]

  Returns Toshihiko<AdapterInstance, Options>

• new Toshihiko<
      AdapterInstance extends
          AdapterLike = Adapter<
          object,
          object,
          object,
          DataValue,
          AdapterQuery<
              object,
              object,
              object
              | null,
              Readonly<Record<string, DataValue>>,
              Readonly<Record<string, DataValue>>,
          >,
          DefaultAdapterExecuteSpec,
      >,
      Options extends object = object,
  >(
      adapter: AdapterInstance | AdapterConstructor<Options, AdapterInstance>,
      ...__namedParameters: {} extends Options
          ? readonly [Options | undefined]
          : readonly [Options],
  ): Toshihiko<AdapterInstance, Options>

  Type Parameters

  • AdapterInstance extends AdapterLike = Adapter<
        object,
        object,
        object,
        DataValue,
        AdapterQuery<
            object,
            object,
            object
            | null,
            Readonly<Record<string, DataValue>>,
            Readonly<Record<string, DataValue>>,
        >,
        DefaultAdapterExecuteSpec,
    >
  • Options extends object = object

  Parameters

  • adapter: AdapterInstance | AdapterConstructor<Options, AdapterInstance>
  • ...__namedParameters: {} extends Options ? readonly [Options | undefined] : readonly [Options]

  Returns Toshihiko<AdapterInstance, Options>

• new Toshihiko<
      AdapterInstance extends
          AdapterLike = Adapter<
          object,
          object,
          object,
          DataValue,
          AdapterQuery<
              object,
              object,
              object
              | null,
              Readonly<Record<string, DataValue>>,
              Readonly<Record<string, DataValue>>,
          >,
          DefaultAdapterExecuteSpec,
      >,
      Options extends object = object,
  >(
      adapter: AdapterSource<Options, AdapterInstance>,
      ...__namedParameters: {} extends Options
          ? readonly [Options | undefined]
          : readonly [Options],
  ): Toshihiko<AdapterInstance, Options>

  Type Parameters

  • AdapterInstance extends AdapterLike = Adapter<
        object,
        object,
        object,
        DataValue,
        AdapterQuery<
            object,
            object,
            object
            | null,
            Readonly<Record<string, DataValue>>,
            Readonly<Record<string, DataValue>>,
        >,
        DefaultAdapterExecuteSpec,
    >
  • Options extends object = object

  Parameters

  • adapter: AdapterSource<Options, AdapterInstance>
  • ...__namedParameters: {} extends Options ? readonly [Options | undefined] : readonly [Options]

  Returns Toshihiko<AdapterInstance, Options>

Readonlycache

Readonlydialect

Readonlyoptions

Readonlypool

database

• get database(): string

  The database name reported by the selected Adapter.

  Returns string

define

• define<
      const Name extends string,
      const Schema extends SchemaDefinition,
      const Methods extends object = object,
  >(
      collectionName: Name,
      schema: Schema,
      options?: ModelDefinitionOptions<Name, Schema, AdapterInstance, Methods>,
      ...validation: IsValidDefinition<Name, Schema, AdapterInstance> extends true
          ? readonly []
          : readonly [never],
  ): Model<Name, Schema, AdapterInstance> & Methods

  Defines a typed Model for one table or collection.

  Field names and values are inferred from the schema array. Functions in options.methods are copied onto the returned Model and receive a contextually typed this containing both the Model API and the other custom methods.

  Type Parameters

  • const Name extends string
  • const Schema extends SchemaDefinition
  • const Methods extends object = object

  Parameters

  • collectionName: Name

    Adapter-facing table or collection name.

  • schema: Schema

    Field definitions used for runtime conversion and static row inference.

  • options: ModelDefinitionOptions<Name, Schema, AdapterInstance, Methods> = {}

    Model options, including Cache configuration and custom Model methods.

  • ...validation: IsValidDefinition<Name, Schema, AdapterInstance> extends true
        ? readonly []
        : readonly [never]

  Returns Model<Name, Schema, AdapterInstance> & Methods

  A Model extended with the inferred custom methods.

  Example

  const User = database.define('users', [
    { name: 'id', type: Type.Integer, primaryKey: true },
    { name: 'email', type: Type.String },
  ], {
    methods: {
      findByEmail(email: string) {
        return this.where({ email }).findOne();
      },
    },
  });
  Copy

execute

• execute(
      ...arguments_: AdapterExecuteArguments<AdapterInstance>,
  ): Promise<AdapterExecuteResult<AdapterInstance>>

  Executes a raw Adapter operation without creating a Model or Query.

  The accepted arguments and resolved value come from the selected Adapter's execute specification.

  Parameters

  • ...arguments_: AdapterExecuteArguments<AdapterInstance>

    Adapter-defined execute arguments.

  Returns Promise<AdapterExecuteResult<AdapterInstance>>

  The Adapter-defined execution result.

StaticcreateCache

• createCache(source: CacheSource): Cache | null

  Creates a Cache from an existing Cache instance or module-style options.

  Parameters

  • source: CacheSource

    Cache instance or { module, options } configuration.

  Returns Cache | null

  The existing or newly created Cache, or null when the source is not a recognized Cache configuration.