Class AdbcConnection

Represents a single connection to a database.

Implements

AdbcConnection

Indexable

[key: number]: () => Promise<void>

Index

Methods

createStatement setOption setAutoCommit setReadOnly getObjects getTableSchema getTableTypes getInfo query queryStream ingest ingestStream execute commit rollback close

Methods

createStatement

createStatement(): Promise<AdbcStatement>
Create a new statement for executing queries.

Returns Promise<AdbcStatement>
A Promise resolving to a new AdbcStatement.
Implementation of AdbcConnection.createStatement
- Defined in lib/index.ts:129

setOption

setOption(key: string, value: string): void
Set an option on the connection.
Parameters
- key: string
  The option name (e.g., "adbc.connection.autocommit").
- value: string
  The option value.
Returns void
Implementation of AdbcConnection.setOption
- Defined in lib/index.ts:138

setAutoCommit

setAutoCommit(enabled: boolean): void
Toggle autocommit behavior.
Parameters
- enabled: boolean
  Whether autocommit should be enabled.
Returns void
Implementation of AdbcConnection.setAutoCommit
- Defined in lib/index.ts:146

setReadOnly

setReadOnly(enabled: boolean): void
Toggle read-only mode.
Parameters
- enabled: boolean
  Whether the connection should be read-only.
Returns void
Implementation of AdbcConnection.setReadOnly
- Defined in lib/index.ts:150

getObjects

getObjects(options?: GetObjectsOptions): Promise<Table<any>>
Get a hierarchical view of database objects (catalogs, schemas, tables, columns).
Parameters
- Optionaloptions: GetObjectsOptions
  Filtering options for the metadata query.
Returns Promise<Table<any>>
A Promise resolving to an Apache Arrow Table containing the metadata.
Implementation of AdbcConnection.getObjects
- Defined in lib/index.ts:154

getTableSchema

getTableSchema(
options: { catalog?: string; dbSchema?: string; tableName: string },
): Promise<Schema<any>>
Get the Arrow schema for a specific table.
Parameters
- options: { catalog?: string; dbSchema?: string; tableName: string }
  An object containing catalog, dbSchema, and tableName.
  - Optionalcatalog?: string
    The catalog name (or undefined).
  - OptionaldbSchema?: string
    The schema name (or undefined).
  - tableName: string
    The table name.
Returns Promise<Schema<any>>
A Promise resolving to the Arrow Schema of the table.
Implementation of AdbcConnection.getTableSchema
- Defined in lib/index.ts:171

getTableTypes

getTableTypes(): Promise<Table<any>>
Get a list of table types supported by the database.

Returns Promise<Table<any>>
A Promise resolving to an Apache Arrow Table with a single string column of table types.
Implementation of AdbcConnection.getTableTypes
- Defined in lib/index.ts:184

getInfo

getInfo(infoCodes?: InfoCode[]): Promise<Table<any>>
Get metadata about the driver and database.
Parameters
- OptionalinfoCodes: InfoCode[]
  Optional list of info codes to retrieve. Use the InfoCode constants. If omitted, all available info is returned.
Returns Promise<Table<any>>
A Promise resolving to an Apache Arrow Table containing the requested metadata info.
Implementation of AdbcConnection.getInfo
- Defined in lib/index.ts:193

query

query(sql: string, params?: Table<any>): Promise<Table<any>>
Execute a SQL query and return all results as an Arrow Table.

Convenience method that creates a statement, sets the SQL, optionally binds parameters, executes the query, and closes the statement. For large result sets, use queryStream to avoid loading everything into memory.
Parameters
- sql: string
  The SQL query to execute.
- Optionalparams: Table<any>
  Optional Arrow Table to bind as parameters.
Returns Promise<Table<any>>
A Promise resolving to an Apache Arrow Table.
Implementation of AdbcConnection.query
- Defined in lib/index.ts:202

queryStream

queryStream(sql: string, params?: Table<any>): Promise<RecordBatchReader<any>>
Execute a SQL query and return the results as a RecordBatchReader for streaming.

Use this instead of query when working with large result sets that should not be fully loaded into memory. The reader remains valid after the statement is closed because the underlying iterator holds its own reference to the native resources.
Parameters
- sql: string
  The SQL query to execute.
- Optionalparams: Table<any>
  Optional Arrow Table to bind as parameters.
Returns Promise<RecordBatchReader<any>>
A Promise resolving to an Apache Arrow RecordBatchReader.
Implementation of AdbcConnection.queryStream
- Defined in lib/index.ts:206

ingest

ingest(tableName: string, data: Table, options?: IngestOptions): Promise<number>
Ingest Arrow data into a database table.

Convenience method that sets the ingestion options, binds the data, and calls executeUpdate. Depending on the driver, this can avoid per-row overhead compared to a prepare-bind-insert loop.
Parameters
- tableName: string
  The target table name.
- data: Table
  Arrow Table to ingest.
- Optionaloptions: IngestOptions
  Ingestion options (mode, catalog, dbSchema, temporary).
Returns Promise<number>
A Promise resolving to the number of rows ingested, or -1 if unknown.
Implementation of AdbcConnection.ingest
- Defined in lib/index.ts:237

ingestStream

ingestStream(
    tableName: string,
    reader: RecordBatchReader,
    options?: IngestOptions,
): Promise<number>
Ingest Arrow data from a stream into a database table.

Unlike ingest, this method streams data batch-by-batch, avoiding full materialization in memory. Use this for large datasets that should not be buffered entirely.
Parameters
- tableName: string
  The target table name.
- reader: RecordBatchReader
  Arrow RecordBatchReader to stream.
- Optionaloptions: IngestOptions
  Ingestion options (mode, catalog, dbSchema, temporary).
Returns Promise<number>
A Promise resolving to the number of rows ingested, or -1 if unknown.
Implementation of AdbcConnection.ingestStream
- Defined in lib/index.ts:248

execute

execute(sql: string, params?: Table<any>): Promise<number>
Execute a SQL statement (INSERT, UPDATE, DELETE, DDL) and return the row count.

Convenience method that creates a statement, sets the SQL, optionally binds parameters, executes the update, and closes the statement.
Parameters
- sql: string
  The SQL statement to execute.
- Optionalparams: Table<any>
  Optional Arrow Table to bind as parameters.
Returns Promise<number>
A Promise resolving to the number of rows affected, or -1 if unknown.
Implementation of AdbcConnection.execute
- Defined in lib/index.ts:280

commit

commit(): Promise<void>
Commit any pending transactions. Only valid if autocommit is disabled.

Returns Promise<void>
Implementation of AdbcConnection.commit
- Defined in lib/index.ts:293

rollback

rollback(): Promise<void>
Rollback any pending transactions. Only valid if autocommit is disabled.

Returns Promise<void>
Implementation of AdbcConnection.rollback
- Defined in lib/index.ts:301

close

close(): Promise<void>
Close the connection and release resources.

Returns Promise<void>
Implementation of AdbcConnection.close
- Defined in lib/index.ts:309

Class AdbcConnection

Implements

Indexable

Index

Methods

Methods

createStatement

Returns Promise<AdbcStatement>

setOption

Parameters

Returns void

setAutoCommit

Parameters

Returns void

setReadOnly

Parameters

Returns void

getObjects

Parameters

Returns Promise<Table<any>>

getTableSchema

Parameters

Optionalcatalog?: string

OptionaldbSchema?: string

tableName: string

Returns Promise<Schema<any>>

getTableTypes

Returns Promise<Table<any>>

getInfo

Parameters

Returns Promise<Table<any>>

query

Parameters

Returns Promise<Table<any>>

queryStream

Parameters

Returns Promise<RecordBatchReader<any>>

ingest

Parameters

Returns Promise<number>

ingestStream

Parameters

Returns Promise<number>

execute

Parameters

Returns Promise<number>

commit

Returns Promise<void>

rollback

Returns Promise<void>

close

Returns Promise<void>

Settings

On This Page

`Optional`catalog?: string

`Optional`dbSchema?: string