クラス MySQLAdapter

constructor

• new MySQLAdapter(options?: MySQLAdapterOptions): MySQLAdapter

  パラメータ

  • オプションoptions: MySQLAdapterOptions

  戻り値 MySQLAdapter

• new MySQLAdapter(parent: object, options: MySQLAdapterOptions): MySQLAdapter

  パラメータ

  • parent: object
  • options: MySQLAdapterOptions

  戻り値 MySQLAdapter

読み取り専用database

読み取り専用format

読み取り専用mysql

読み取り専用package

読み取り専用username

beginTransaction

• beginTransaction(): Promise<PoolConnection>

  Pool 接続を取得し、その接続上でトランザクションを開始します。

  戻り値 Promise<PoolConnection>

commit

• commit(connection: PoolConnection): Promise<void>

  トランザクション接続をコミットして解放します。

  パラメータ

  • connection: PoolConnection

  戻り値 Promise<void>

count

• count(query: MySQLQuery): Promise<number>

  正規化済みの Query に対して COUNT(0) をコンパイルして実行します。

  パラメータ

  • query: MySQLQuery

  戻り値 Promise<number>

deleteByQuery

• deleteByQuery(query: MySQLQuery): Promise<ResultSetHeader>

  関連する Cache エントリーを無効化し、一括 DELETE を実行します。

  パラメータ

  • query: MySQLQuery

  戻り値 Promise<ResultSetHeader>

execute

• execute(...arguments_: MySQLExecuteArguments): Promise<QueryResult>

  選択された接続または Pool を介して、パラメーター化された SQL を実行します。

  名前付きプレースホルダーや識別子プレースホルダーなど、mysql2 のフォーマットに query() が必要な場合を除き、SQL と値は別々に渡されます。

  パラメータ

  • ...arguments_: MySQLExecuteArguments

  戻り値 Promise<QueryResult>

find

• find(
      query: MySQLQuery,
      options?: AdapterFindOptions,
  ): Promise<
      | Readonly<Record<string, DataValue>>
      | readonly Readonly<Record<string, DataValue>>[]
      | null,
  >

  データ行を直接、または Model の Cache を介して検索します。

  パラメータ

  • query: MySQLQuery
  • options: AdapterFindOptions = defaultFindOptions

  戻り値 Promise<
      | Readonly<Record<string, DataValue>>
      | readonly Readonly<Record<string, DataValue>>[]
      | null,
  >

findWithCache

• findWithCache(
      cache: Cache,
      model: MySQLModel,
      options?: MySQLQueryOptions,
  ): Promise<
      | Readonly<Record<string, DataValue>>
      | readonly Readonly<Record<string, DataValue>>[]
      | null,
  >

  主キーを読み取り、キャッシュ済みのデータ行を解決し、キャッシュミスを同時に最大 10 個のワーカーで取得します。要求された選択フィールドは維持されます。

  パラメータ

  • cache: Cache
  • model: MySQLModel
  • options: MySQLQueryOptions = {}

  戻り値 Promise<
      | Readonly<Record<string, DataValue>>
      | readonly Readonly<Record<string, DataValue>>[]
      | null,
  >

findWithNoCache

• findWithNoCache(
      model: MySQLModel,
      options?: MySQLQueryOptions,
  ): Promise<
      | Readonly<Record<string, DataValue>>
      | readonly Readonly<Record<string, DataValue>>[]
      | null,
  >

  Cache を参照せず、Cache にも保存せずに、コンパイル済みの読み取りを実行します。

  パラメータ

  • model: MySQLModel
  • options: MySQLQueryOptions = {}

  戻り値 Promise<
      | Readonly<Record<string, DataValue>>
      | readonly Readonly<Record<string, DataValue>>[]
      | null,
  >

getDBName

• getDBName(): string

  設定済みのデータベース名を返します。

  戻り値 string

insert

• insert(
      model: MySQLModel,
      connection: PoolConnection | null,
      data: readonly AdapterData<MySQLField, DataValue>[],
  ): Promise<Readonly<Record<string, DataValue>>>

  1 行を挿入し、生成または指定されたキー値を使用して読み戻します。

  パラメータ

  • model: MySQLModel
  • connection: PoolConnection | null
  • data: readonly AdapterData<MySQLField, DataValue>[]

  戻り値 Promise<Readonly<Record<string, DataValue>>>

makeArrayWhere

• makeArrayWhere(
      model: MySQLModel,
      condition: readonly Readonly<Record<string, DataValue>>[],
      logic?: string,
  ): string

  指定された論理演算で結合した条件オブジェクトの配列をフォーマットします。

  パラメータ

  • model: MySQLModel
  • condition: readonly Readonly<Record<string, DataValue>>[]
  • オプションlogic: string

  戻り値 string

makeDelete

• makeDelete(model: MySQLModel, options?: MySQLQueryOptions): string

  完全な DELETE 文をフォーマットします。

  パラメータ

  • model: MySQLModel
  • オプションoptions: MySQLQueryOptions

  戻り値 string

makeFieldWhere

• makeFieldWhere(
      model: MySQLModel,
      key: string,
      condition: DataValue,
      logic?: string,
  ): string

  1 個の論理フィールド条件を SQL としてフォーマットします。

  パラメータ

  • model: MySQLModel
  • key: string
  • condition: DataValue
  • オプションlogic: string

  戻り値 string

makeFind

• makeFind(model: MySQLModel, options?: MySQLQueryOptions): string

  完全な SELECT 文をフォーマットします。

  パラメータ

  • model: MySQLModel
  • オプションoptions: MySQLQueryOptions

  戻り値 string

makeIndex

• makeIndex(model: MySQLModel, index?: string): string

  任意の FORCE INDEX 句をフォーマットします。

  パラメータ

  • model: MySQLModel
  • オプションindex: string

  戻り値 string

makeLimit

• makeLimit(model: MySQLModel, limit: readonly (string | number)[]): string

  正規化済みの limit を MySQL の LIMIT フラグメントの本体としてフォーマットします。

  パラメータ

  • model: MySQLModel
  • limit: readonly (string | number)[]

  戻り値 string

makeOrder

• makeOrder(
      model: MySQLModel,
      order: readonly Readonly<Record<string, number>>[],
  ): string

  正規化済みのソート項目を ORDER BY フラグメントの本体としてフォーマットします。

  パラメータ

  • model: MySQLModel
  • order: readonly Readonly<Record<string, number>>[]

  戻り値 string

makeSet

• makeSet(model: MySQLModel, update: DataRow): string

  論理的な更新値を SQL の SET フラグメントの本体としてフォーマットします。

  パラメータ

  • model: MySQLModel
  • update: DataRow

  戻り値 string

makeSql

• makeSql(type: string, model: MySQLModel, options?: MySQLQueryOptions): string

  find、count、update、delete の各操作に対応する SQL フォーマッターを選択します。

  パラメータ

  • type: string
  • model: MySQLModel
  • オプションoptions: MySQLQueryOptions

  戻り値 string

makeUpdate

• makeUpdate(model: MySQLModel, options?: MySQLQueryOptions): string

  完全な UPDATE 文をフォーマットします。

  パラメータ

  • model: MySQLModel
  • オプションoptions: MySQLQueryOptions

  戻り値 string

makeWhere

• makeWhere(
      model: MySQLModel,
      condition:
          | Readonly<Record<string, DataValue>>
          | readonly Readonly<Record<string, DataValue>>[],
      logic?: string,
  ): string

  完全な Toshihiko 条件を SQL としてフォーマットします。

  パラメータ

  • model: MySQLModel
  • condition:
        | Readonly<Record<string, DataValue>>
        | readonly Readonly<Record<string, DataValue>>[]
  • オプションlogic: string

  戻り値 string

queryToOptions

• queryToOptions(
      query: MySQLQuery,
      overrides?: Partial<MySQLQueryOptions>,
  ): MySQLQueryOptions

  正規化済みの Query 状態を SQL builder のオプションへコピーします。

  single: true の場合は limit も書き換え、要求するデータ行を最大 1 行にします。

  パラメータ

  • query: MySQLQuery
  • overrides: Partial<MySQLQueryOptions> = {}

  戻り値 MySQLQueryOptions

rollback

• rollback(connection: PoolConnection): Promise<void>

  トランザクション接続をロールバックして解放します。

  パラメータ

  • connection: PoolConnection

  戻り値 Promise<void>

update

• update(
      model: MySQLModel,
      connection: PoolConnection | null,
      primaryKey: DataRow,
      data: readonly AdapterData<MySQLField, DataValue>[],
  ): Promise<ResultSetHeader>

  元の特定条件を使用して 1 行を更新し、キャッシュ済みのコピーを無効化します。

  パラメータ

  • model: MySQLModel
  • connection: PoolConnection | null
  • primaryKey: DataRow
  • data: readonly AdapterData<MySQLField, DataValue>[]

  戻り値 Promise<ResultSetHeader>

  Throws

  特定条件または更新データが空の場合、あるいは更新された行がない場合です。

updateByQuery

• updateByQuery(query: MySQLQuery): Promise<ResultSetHeader>

  関連する Cache エントリーを無効化し、一括 UPDATE を実行します。

  パラメータ

  • query: MySQLQuery

  戻り値 Promise<ResultSetHeader>