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

  编译并执行 COUNT(0)，用于规范化后的 Query。

  参数

  • query: MySQLQuery

  返回 Promise<number>

deleteByQuery

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

  使相关 Cache 条目失效，并执行批量 DELETE。

  参数

  • query: MySQLQuery

  返回 Promise<ResultSetHeader>

execute

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

  通过所选连接或 Pool 执行参数化 SQL。

  SQL 与值会分开传递，除非 mysql2 格式化需要 query()，例如命名占位符或标识符占位符。

  参数

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

  读取主键、解析缓存数据行、以最多十个并发 worker 获取未命中数据，并保留请求的字段投影。

  参数

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

  参数

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

  插入一行数据，然后用生成或提供的 key 值重新读取。

  参数

  • 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

  把一个逻辑字段条件格式化为 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

  为以下操作选择对应的 SQL 格式化器：find、count、update，或 delete。

  参数

  • 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，确保最多请求一行。

  参数

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

  使用原始定位条件更新一行数据，并使缓存副本失效。

  参数

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

  返回 Promise<ResultSetHeader>

  抛出

  定位条件或更新数据为空，或没有数据行受影响时。

updateByQuery

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

  使相关 Cache 条目失效，并执行批量 UPDATE。

  参数

  • query: MySQLQuery

  返回 Promise<ResultSetHeader>