类 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>

  类型参数

  • 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>

• 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>

  类型参数

  • 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>

• 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>

  类型参数

  • 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>

只读cache

只读dialect

只读options

只读pool

database

• get database(): string

  所选 Adapter 报告的数据库名。

  返回 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

  为一张表或一个集合定义带类型的 Model。

  字段名和值从 schema 数组推断。以下位置中的函数： options.methods 会被复制到返回的 Model 上，并获得具有上下文类型的 this，其中同时包含 Model API 和其他自定义方法。

  类型参数

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

  参数

  • collectionName: Name

    提供给 Adapter 的表名或集合名。

  • schema: Schema

    用于运行时转换和静态数据行推断的字段定义。

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

    Model 选项，包括 Cache 配置和自定义 Model 方法。

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

  返回 Model<Name, Schema, AdapterInstance> & Methods

  带有推断后自定义方法的 Model。

  示例

  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();
      },
    },
  });
  复制

execute

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

  不创建 Model 或 Query，直接执行 Adapter 原始操作。

  接受的参数和 Promise 结果由所选 Adapter 的 execute 规格决定。

  参数

  • ...arguments_: AdapterExecuteArguments<AdapterInstance>

    由 Adapter 定义的 execute 参数。

  返回 Promise<AdapterExecuteResult<AdapterInstance>>

  由 Adapter 定义的执行结果。

静态createCache

• createCache(source: CacheSource): Cache | null

  从现有 Cache 实例或模块式选项创建 Cache。

  参数

  • source: CacheSource

    Cache 实例或 { module, options } 配置。

  返回 Cache | null

  现有或新建的 Cache，或 null，表示 source 不是可识别的 Cache 配置。