Class Adapter<Options, Model, Connection, Field, Value, Query, ExecuteSpec>

constructor

• new Adapter<
      Options extends object = Readonly<Record<string, DataValue>>,
      Model = object,
      Connection = object,
      Field = object,
      Value = DataValue,
      Query extends
          AdapterQuery<
              Model,
              Connection,
              object
              | null,
              Readonly<Record<string, DataValue>>,
              Readonly<Record<string, DataValue>>,
          > = AdapterQuery<
          Model,
          Connection,
          object
          | null,
          Readonly<Record<string, DataValue>>,
          Readonly<Record<string, DataValue>>,
      >,
      ExecuteSpec extends
          AdapterExecuteSpec<
              readonly DataValue[],
              readonly DataValue[],
              AdapterOperationResult,
          > = DefaultAdapterExecuteSpec,
  >(
      ...__namedParameters: {} extends Options
          ? readonly [Options | null | undefined]
          : readonly [Options],
  ): Adapter<Options, Model, Connection, Field, Value, Query, ExecuteSpec>

  Type Parameters

  • Options extends object = Readonly<Record<string, DataValue>>
  • Model = object
  • Connection = object
  • Field = object
  • Value = DataValue
  • Query extends AdapterQuery<
        Model,
        Connection,
        object
        | null,
        Readonly<Record<string, DataValue>>,
        Readonly<Record<string, DataValue>>,
    > = AdapterQuery<
        Model,
        Connection,
        object
        | null,
        Readonly<Record<string, DataValue>>,
        Readonly<Record<string, DataValue>>,
    >
  • ExecuteSpec extends AdapterExecuteSpec<
        readonly DataValue[],
        readonly DataValue[],
        AdapterOperationResult,
    > = DefaultAdapterExecuteSpec

  Parameters

  • ...__namedParameters: {} extends Options ? readonly [Options | null | undefined] : readonly [Options]

  Returns Adapter<Options, Model, Connection, Field, Value, Query, ExecuteSpec>

• new Adapter<
      Options extends object = Readonly<Record<string, DataValue>>,
      Model = object,
      Connection = object,
      Field = object,
      Value = DataValue,
      Query extends
          AdapterQuery<
              Model,
              Connection,
              object
              | null,
              Readonly<Record<string, DataValue>>,
              Readonly<Record<string, DataValue>>,
          > = AdapterQuery<
          Model,
          Connection,
          object
          | null,
          Readonly<Record<string, DataValue>>,
          Readonly<Record<string, DataValue>>,
      >,
      ExecuteSpec extends
          AdapterExecuteSpec<
              readonly DataValue[],
              readonly DataValue[],
              AdapterOperationResult,
          > = DefaultAdapterExecuteSpec,
  >(
      parent: object,
      options: Options | null | undefined,
  ): Adapter<Options, Model, Connection, Field, Value, Query, ExecuteSpec>

  Type Parameters

  • Options extends object = Readonly<Record<string, DataValue>>
  • Model = object
  • Connection = object
  • Field = object
  • Value = DataValue
  • Query extends AdapterQuery<
        Model,
        Connection,
        object
        | null,
        Readonly<Record<string, DataValue>>,
        Readonly<Record<string, DataValue>>,
    > = AdapterQuery<
        Model,
        Connection,
        object
        | null,
        Readonly<Record<string, DataValue>>,
        Readonly<Record<string, DataValue>>,
    >
  • ExecuteSpec extends AdapterExecuteSpec<
        readonly DataValue[],
        readonly DataValue[],
        AdapterOperationResult,
    > = DefaultAdapterExecuteSpec

  Parameters

  • parent: object
  • options: Options | null | undefined

  Returns Adapter<Options, Model, Connection, Field, Value, Query, ExecuteSpec>

options

Readonlyparent

beginTransaction

• beginTransaction(): Promise<Connection>

  Begins a transaction; subclasses may override this optional operation.

  Returns Promise<Connection>

commit

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

  Commits a transaction; subclasses may override this optional operation.

  Parameters

  • connection: Connection

  Returns Promise<void>

count

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

  Counts rows for a normalized Query; subclasses must override this method.

  Parameters

  • query: Query

  Returns Promise<number>

deleteByQuery

• deleteByQuery(query: Query): Promise<AdapterOperationResult>

  Deletes rows for a normalized Query; subclasses must override this method.

  Parameters

  • query: Query

  Returns Promise<AdapterOperationResult>

execute

• execute(...arguments_: ExecuteSpec["arguments"]): Promise<ExecuteSpec["result"]>

  Executes an Adapter-specific raw operation; subclasses may override it.

  Parameters

  • ...arguments_: ExecuteSpec["arguments"]

  Returns Promise<ExecuteSpec["result"]>

find

• find(query: Query, options?: AdapterFindOptions): Promise<AdapterFindResult>

  Finds rows for a normalized Query; subclasses must override this method.

  Parameters

  • query: Query
  • Optionaloptions: AdapterFindOptions

  Returns Promise<AdapterFindResult>

getDBName

• getDBName(): string

  Returns the current database name; the base implementation returns ''.

  Returns string

insert

• insert(
      model: Model,
      connection: Connection | null,
      data: readonly AdapterData<Field, Value>[],
  ): Promise<Readonly<Record<string, DataValue>> | null>

  Inserts one row; subclasses must override this method.

  Parameters

  • model: Model
  • connection: Connection | null
  • data: readonly AdapterData<Field, Value>[]

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

rollback

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

  Rolls back a transaction; subclasses may override this optional operation.

  Parameters

  • connection: Connection

  Returns Promise<void>

update

• update(
      model: Model,
      connection: Connection | null,
      primaryKey: DataRow,
      data: readonly AdapterData<Field, Value>[],
  ): Promise<AdapterOperationResult>

  Updates one located row; subclasses must override this method.

  Parameters

  • model: Model
  • connection: Connection | null
  • primaryKey: DataRow
  • data: readonly AdapterData<Field, Value>[]

  Returns Promise<AdapterOperationResult>

updateByQuery

• updateByQuery(query: Query): Promise<AdapterOperationResult>

  Performs a bulk update; subclasses may override this optional operation.

  Parameters

  • query: Query

  Returns Promise<AdapterOperationResult>