spiceai/docs

spiceai/

docs

Help Login

evgenii/docs-spicepod-v2

Edit on GitHub

Fork

/docs/website/versioned_docs/version-2.0.x/components/catalogs/adbc.md

spiceai/docs | Spice Cloud Platform

evgenii/docs-spicepod-v2

Edit on GitHub

Fork

/docs/website/versioned_docs/version-2.0.x/components/catalogs/adbc.md

spiceai/docs/README.md

title: 'ADBC Catalog Connector' sidebar_label: 'ADBC' description: 'Connect to databases via ADBC for automatic schema and table discovery.' sidebar_position: 11 pagination_prev: null pagination_next: null tags:

catalogs
adbc
data-connectors

Connect to any database via ADBC (Arrow Database Connectivity) as a catalog provider for federated SQL query. The ADBC Catalog Connector uses the ADBC metadata API to automatically discover schemas and tables from the connected database.

Prerequisites

An ADBC-compatible driver must be installed on the system where Spice runs. See the ADBC Data Connector for driver installation instructions.

Configuration

`from`

The from field is used to specify the catalog provider. For ADBC, specify adbc.

`name`

The name field specifies the name of the catalog in Spice. Tables from the ADBC-connected database will be available under this catalog name in Spice. The schema hierarchy of the external database is preserved in Spice.

`include`

Use the include field to specify which tables to include from the catalog. The include field supports glob patterns to match multiple tables. For example, *.my_table_name would include all tables with the name my_table_name from any schema. Multiple include patterns are OR'ed together and can be specified to include multiple tables.

`params`

The following parameters are supported:

Parameter Name	Description
`adbc_driver`	Required. The ADBC driver name (e.g., `bigquery`, `trino`, `snowflake`, `redshift`, `duckdb`, `postgres`).
`adbc_driver_path`	Optional. Absolute path to the ADBC driver shared library. If not specified, the driver is loaded by name.
`adbc_uri`	Required. Database URI/connection string for the ADBC driver.
`adbc_username`	Optional. Username for database authentication.
`adbc_password`	Optional. Password for database authentication.
`adbc_driver_options`	Optional. Semicolon-delimited driver-specific database options (e.g., `key1=value1;key2=value2`).
`connection_pool_size`	Optional. Maximum number of connections in the connection pool. Default: .

Examples

BigQuery

Snowflake