Class BigtableAdapter

constructor

• new BigtableAdapter(
      options: BigtableAdapterOptions,
      loader?: BigtableClientLoader,
  ): BigtableAdapter

  Creates the adapter and validates its configuration.

  The validation is the point: a blank instance id is otherwise a bare gRPC failure on the first request rather than a named configuration error at construction — the guard family M52c's and M52d's reviews added for D1 and Durable Objects.

  Parameters

  • options: BigtableAdapterOptions

    The 'bigtable' arm options

  • Optionalloader: BigtableClientLoader

    An explicit client loader, overriding the inject-or-lazy choice options would otherwise make. Supply one to wrap a differently-pinned SDK module around createLazyBigtableLoader's adaptation; the loader's owned flag decides whether BigtableAdapter.disconnect closes the client it produced.

  Returns BigtableAdapter

  Throws

  When neither client nor projectId is supplied, when instance is absent or blank, or when maxPageFetches is not a positive integer

ReadonlytransactionIsolationLevels

beginTransaction

• beginTransaction(options?: TransactionOptions): Promise<IAdapterTransaction>

  Begin a transaction, returning a handle that can open transaction-scoped data sources as well as commit and roll back.

  Parameters

  • Optionaloptions: TransactionOptions

    Optional transaction settings; omitted preserves the backend default

  Returns Promise<IAdapterTransaction>

  The transaction handle

connect

• connect(): Promise<void>

  Opens the underlying connection (pool).

  Returns Promise<void>

createDataSource

• createDataSource(entity: string): IDataSource

  Open a non-transactional data source for the named entity.

  Parameters

  • entity: string

    Entity name (for example 'User')

  Returns IDataSource

  A data source bound to that entity

disconnect

• disconnect(): Promise<void>

  Closes the underlying connection (pool).

  Returns Promise<void>

isReady

• isReady(): boolean

  Reports whether the adapter is connected and usable.

  Returns boolean

  true when ready

rawQuery

• rawQuery<T>(_sql: string, _params?: unknown[]): Promise<T[]>

  Execute a raw query in the backend's own dialect.

  Type Parameters

  • T

    Expected row shape

  Parameters

  • _sql: string

    The query text

  • Optional_params: unknown[]

    Positional parameters

  Returns Promise<T[]>

  The result rows