DatabricksSrcConn

class

class DatabricksSrcConn(
    host_url: HostUrlSpec,
    token: CredentialsSpec,
    volume: VolumeSpec,
    warehouse: WarehouseSpec | None = None,
    warehouse_id: WarehouseIdSpec | None = None,
    catalog: IdentifierSpec | None = None,
    schema: IdentifierSpec | None = None,
    entity_whitelist: EntityWhitelistSpec | None = None,
    conn_cfg: CfgSpec | None = None,
)

Bases: Conn

Categories: source

Databricks workspace connection used by DatabricksSrc.

Registered on a collection; the runtime resolves it and hands it to the plugin at run time. host_url and token are bare Secret values; the identifier fields accept a plain string or a Secret.

Parameters

parameter

host_urlHostUrlSpec (Secret)

The workspace URL (a Secret), e.g. https://<workspace>.cloud.databricks.com.

parameter

tokenCredentialsSpec (Secret)

The personal access token (PAT), a Secret.

parameter

volumeVolumeSpec (str | Secret)

A Unity Catalog Volume used to stage parquet, given as a [catalog.][schema.]volume name (backtick-quote a part for special characters).

parameter

warehouseWarehouseSpec | None (str | Secret | None)

Optional SQL warehouse name (1-100 characters, no leading / trailing whitespace). Mutually exclusive with warehouse_id.

parameter

warehouse_idWarehouseIdSpec | None (str | Secret | None)

Optional SQL warehouse id (16-character lowercase hex). Mutually exclusive with warehouse.

parameter

catalogIdentifierSpec | None (str | Secret | None)

Optional default catalog (a Databricks identifier).

parameter

schemaIdentifierSpec | None (str | Secret | None)

Optional default schema (a Databricks identifier); requires catalog.

parameter

entity_whitelistEntityWhitelistSpec | None (list[str] | None)

Optional list of regex patterns narrowing which tables the source considers; None (the default) filters nothing.

parameter

conn_cfgCfgSpec | None (dict | None)

Optional connector-config dict (see CfgSpec).

Methods

method

validate

def validate()

Cross-field validation: warehouse and warehouse_id are mutually exclusive, and schema requires catalog.

Called by the framework; raises DatabricksValidateException.