Interface DatabaseAdapter

packages/data-table/src/lib/adapter.ts:297–333

 * Runtime contract implemented by concrete database adapters.
 */
export interface DatabaseAdapter {
  /** Database dialect name exposed by the adapter. */
  dialect: string
  /** Feature flags describing the adapter's supported behaviors. */
  capabilities: AdapterCapabilities
  /** Compiles a data-manipulation operation into executable SQL statements. */
  compileSql(operation: DataManipulationOperation): SqlStatement[]
  /** Executes a data-manipulation request. */
  execute(request: DataManipulationRequest): Promise<DataManipulationResult>
  /**
   * Executes a raw SQL script that may contain multiple statements.
   *
   * Drivers must be configured to accept multi-statement scripts where required
   * (for example, mysql2 needs `multipleStatements: true`).
   */
  executeScript(sql: string, transaction?: TransactionToken): Promise<void>
  /** Checks whether a table exists. */
  hasTable(table: TableRef, transaction?: TransactionToken): Promise<boolean>
  /** Checks whether a column exists on a table. */
  hasColumn(table: TableRef, column: string, transaction?: TransactionToken): Promise<boolean>
  /** Starts a new database transaction. */
  beginTransaction(options?: TransactionOptions): Promise<TransactionToken>
  /** Commits an open transaction. */
  commitTransaction(token: TransactionToken): Promise<void>
  /** Rolls back an open transaction. */
  rollbackTransaction(token: TransactionToken): Promise<void>
  /** Creates a savepoint inside an open transaction. */
  createSavepoint(token: TransactionToken, name: string): Promise<void>
  /** Rolls back to a previously created savepoint. */
  rollbackToSavepoint(token: TransactionToken, name: string): Promise<void>
  /** Releases a previously created savepoint. */
  releaseSavepoint(token: TransactionToken, name: string): Promise<void>
  /** Acquires the adapter's migration lock when supported. */
  acquireMigrationLock?(): Promise<void>
  /** Releases the adapter's migration lock when supported. */
  releaseMigrationLock?(): Promise<void>
}