Toshihiko
    検索インデックスを準備しています...

    クラス Toshihiko<AdapterInstance, Options>

    Model の定義と Adapter レベルの操作を行う、データベースの入口です。

    Adapter の名前、コンストラクター、またはインスタンスを指定して構築します。選択した Adapter によって、Model と Query に伝播するオプション、接続、実行結果の型が決まります。

    型パラメーター

    階層

    • EventEmitter2
      • Toshihiko
    インデックス
    constructor
    cache dialect options pool
    database
    define execute createCache
    cache: Cache | null | undefined

    設定されている場合、options.cache から作成した Cache です。

    dialect: string | null

    このインスタンスで使用する Adapter 名またはコンストラクター名です。

    options: Options

    コンストラクターへ渡した Adapter 固有のオプションです。

    pool: AdapterInstance extends { mysql: Pool } ? Pool : undefined

    選択された Adapter が公開している場合の MySQL 接続 Pool です。

    • get database(): string

      選択された Adapter が報告するデータベース名です。

      戻り値 string

    • 1 個のテーブルまたはコレクションに対する型付き Model を定義します。

      フィールド名と値は schema 配列から推論されます。options.methods の関数は返される Model へコピーされ、Model API とほかのカスタムメソッドの両方を含む、contextual type が付いた this を受け取ります。

      型パラメーター

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

      パラメータ

      • collectionName: Name

        Adapter に渡すテーブル名またはコレクション名です。

      • schema: Schema

        実行時の変換と静的なデータ行推論に使用するフィールド定義です。

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

        Cache 設定とカスタム Model メソッドを含む 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();
          },
        },
      });

    • 既存の Cache インスタンス、またはモジュール形式のオプションから Cache を作成します。

      パラメータ

      • source: CacheSource

        Cache インスタンス、または { module, options } 設定です。

      戻り値 Cache | null

      既存または新しく作成した Cache です。source が認識できる Cache 設定ではない場合は null です。

    テーマ設定
    メンバーの可視性

    このページ
    コンストラクター
    プロパティ
    アクセッサー
    メソッド