Skip to main content

Catalogs

Sync Onehouse tables to external catalogs (Glue, Hive, Unity, OneTable, DataHub, Snowflake, OneLake, BigQuery, Dataproc).

Methods

MethodDescription
create_catalogRegister an external catalog
delete_catalogDelete a catalog
describe_catalogShow full configuration for a catalog
show_catalogsList all catalogs in the project

create_catalog

create_catalog(
name: str,
*,
type: str,
credential_type: str | None = None,
options: Mapping[str, str] | None = None,
unsafe_raw: bool = False,
timeout: float | None = None,
poll_interval: float | None = None,
)
ParameterRequiredType / values
nameyesstr
typeyes"GLUE", "HIVE", "BIGQUERY", "DATAHUB", "ONETABLE", "DATAPROC", "UNITY", "SNOWFLAKE", "ONELAKE"
credential_typeno"CREDENTIAL_TYPE_ONEHOUSE", "CREDENTIAL_TYPE_SECRET_MANAGER"
optionsnoMapping[str, str] — catalog-specific config (e.g. region, account ID)

Example

client.create_catalog(
"my_glue_catalog",
type="GLUE",
credential_type="CREDENTIAL_TYPE_ONEHOUSE",
options={"region": "us-west-2"},
)

delete_catalog

delete_catalog(name: str, *, unsafe_raw=False, timeout=None, poll_interval=None)

Example

client.delete_catalog("my_glue_catalog")

describe_catalog

describe_catalog(name: str, *, unsafe_raw=False, timeout=None, poll_interval=None)

Example

result = client.describe_catalog("my_glue_catalog")

show_catalogs

show_catalogs(*, timeout=None, poll_interval=None)

Example

result = client.show_catalogs()