Catalog System

Overview

The catalog system manages metadata for database tables, columns, and business rules.

class openchatbi.catalog.catalog_loader.DataCatalogLoader(engine: Engine, include_tables: list[str] | None = None)[source]

Bases: object

The loader to load data catalog from data warehouse metadata and save to catalog store.

__init__(engine: Engine, include_tables: list[str] | None = None)[source]

Initialize catalog loader.

Parameters:

engine (Engine) – SQLAlchemy engine instance
include_tables (Optional[List[str]]) – List of table names to include, None for all

get_tables_and_columns() → dict[str, list[dict[str, Any]]][source]

Extract table and column metadata including comments using SQLAlchemy inspector.

get_table_indexes(table_name: str) → list[dict[str, Any]][source]

Get index information for a specific table.

get_foreign_keys(table_name: str) → list[dict[str, Any]][source]

Get foreign key information for a specific table.

save_to_catalog_store(catalog_store: CatalogStore, database_name: str | None = None, update: bool = False) → bool[source]

Extract warehouse metadata and save to catalog store.

Parameters:

catalog_store (CatalogStore) – Target catalog store to load data to
database_name (Optional[str]) – Database name in catalog, defaults to ‘default’
update (bool) – Update existing catalog store to sync with data warehouse

Returns:

True if load was successful, False otherwise

Return type:

bool

openchatbi.catalog.catalog_loader.load_catalog_from_data_warehouse(catalog_store: CatalogStore) → bool[source]

Load catalog data from data warehouse using SQLAlchemy based on data warehouse config (URI)

Main entry point for catalog loading.