Class MySQLAdapter

constructor

• new MySQLAdapter(options?: MySQLAdapterOptions): MySQLAdapter

  Parameters

  • Optionaloptions: MySQLAdapterOptions

  Returns MySQLAdapter

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

  Parameters

  • parent: object
  • options: MySQLAdapterOptions

  Returns MySQLAdapter

Readonlydatabase

Readonlyformat

Readonlymysql

Readonlypackage

Readonlyusername

beginTransaction

• beginTransaction(): Promise<PoolConnection>

  Acquires a Pool connection and begins a transaction on it.

  Returns Promise<PoolConnection>

commit

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

  Commits and releases a transaction connection.

  Parameters

  • connection: PoolConnection

  Returns Promise<void>

count

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

  Compiles and executes COUNT(0) for a normalized Query.

  Parameters

  • query: MySQLQuery

  Returns Promise<number>

deleteByQuery

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

  Invalidates related Cache entries and performs a bulk DELETE.

  Parameters

  • query: MySQLQuery

  Returns Promise<ResultSetHeader>

execute

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

  Executes parameterized SQL through a selected connection or the Pool.

  SQL and values are passed separately unless mysql2 formatting requires query(), such as named placeholders or identifier placeholders.

  Parameters

  • ...arguments_: MySQLExecuteArguments

  Returns Promise<QueryResult>

find

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

  Finds rows directly or through the Model Cache.

  Parameters

  • query: MySQLQuery
  • options: AdapterFindOptions = defaultFindOptions

  Returns 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,
  >

  Reads primary keys, resolves cached rows, fetches misses with at most ten concurrent workers, and preserves the requested field projection.

  Parameters

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

  Returns 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,
  >

  Executes a compiled read without consulting or populating a Cache.

  Parameters

  • model: MySQLModel
  • options: MySQLQueryOptions = {}

  Returns Promise<
      | Readonly<Record<string, DataValue>>
      | readonly Readonly<Record<string, DataValue>>[]
      | null,
  >

getDBName

• getDBName(): string

  Returns the configured database name.

  Returns string

insert

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

  Inserts one row, then reads it back using generated or supplied key values.

  Parameters

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

  Returns Promise<Readonly<Record<string, DataValue>>>

makeArrayWhere

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

  Formats an array of condition objects joined by the requested logic.

  Parameters

  • model: MySQLModel
  • condition: readonly Readonly<Record<string, DataValue>>[]
  • Optionallogic: string

  Returns string

makeDelete

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

  Formats a complete DELETE statement.

  Parameters

  • model: MySQLModel
  • Optionaloptions: MySQLQueryOptions

  Returns string

makeFieldWhere

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

  Formats one logical field condition as SQL.

  Parameters

  • model: MySQLModel
  • key: string
  • condition: DataValue
  • Optionallogic: string

  Returns string

makeFind

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

  Formats a complete SELECT statement.

  Parameters

  • model: MySQLModel
  • Optionaloptions: MySQLQueryOptions

  Returns string

makeIndex

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

  Formats an optional FORCE INDEX clause.

  Parameters

  • model: MySQLModel
  • Optionalindex: string

  Returns string

makeLimit

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

  Formats normalized limits as a MySQL LIMIT fragment body.

  Parameters

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

  Returns string

makeOrder

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

  Formats normalized sort entries as an ORDER BY fragment body.

  Parameters

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

  Returns string

makeSet

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

  Formats logical update values as a SQL SET fragment body.

  Parameters

  • model: MySQLModel
  • update: DataRow

  Returns string

makeSql

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

  Selects the matching SQL formatter for find, count, update, or delete.

  Parameters

  • type: string
  • model: MySQLModel
  • Optionaloptions: MySQLQueryOptions

  Returns string

makeUpdate

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

  Formats a complete UPDATE statement.

  Parameters

  • model: MySQLModel
  • Optionaloptions: MySQLQueryOptions

  Returns string

makeWhere

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

  Formats a complete Toshihiko condition as SQL.

  Parameters

  • model: MySQLModel
  • condition:
        | Readonly<Record<string, DataValue>>
        | readonly Readonly<Record<string, DataValue>>[]
  • Optionallogic: string

  Returns string

queryToOptions

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

  Copies normalized Query state into SQL-builder options.

  single: true also rewrites the limit so at most one row is requested.

  Parameters

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

  Returns MySQLQueryOptions

rollback

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

  Rolls back and releases a transaction connection.

  Parameters

  • connection: PoolConnection

  Returns Promise<void>

update

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

  Updates one row using its original locator and invalidates cached copies.

  Parameters

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

  Returns Promise<ResultSetHeader>

  Throws

  When the locator or update data is empty, or no row was affected.

updateByQuery

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

  Invalidates related Cache entries and performs a bulk UPDATE.

  Parameters

  • query: MySQLQuery

  Returns Promise<ResultSetHeader>