Skip to content

ClickHouse Configuration

fallback_stores

List of fallback store names to search when features are not found in the current store.

Type: list[str]

[stores.dev.config]
# Optional
# fallback_stores = []
[tool.metaxy.stores.dev.config]
# Optional
# fallback_stores = []
export METAXY_STORES__DEV__CONFIG__FALLBACK_STORES=...

hash_algorithm

Hash algorithm for versioning. If None, uses store's default.

Type: metaxy.versioning.types.HashAlgorithm | None

[stores.dev.config]
# Optional
# hash_algorithm = null
[tool.metaxy.stores.dev.config]
# Optional
# hash_algorithm = null
export METAXY_STORES__DEV__CONFIG__HASH_ALGORITHM=...

versioning_engine

Which versioning engine to use: 'auto' (prefer native), 'native', or 'polars'.

Type: Literal['auto', 'native', 'polars'] | Default: "auto"

[stores.dev.config]
versioning_engine = "auto"
[tool.metaxy.stores.dev.config]
versioning_engine = "auto"
export METAXY_STORES__DEV__CONFIG__VERSIONING_ENGINE=auto

connection_string

Ibis connection string (e.g., 'clickhouse://host:9000/db').

Type: str | None

[stores.dev.config]
# Optional
# connection_string = null
[tool.metaxy.stores.dev.config]
# Optional
# connection_string = null
export METAXY_STORES__DEV__CONFIG__CONNECTION_STRING=...

connection_params

Backend-specific connection parameters.

Type: dict[str, Any | None

[stores.dev.config]
# Optional
# connection_params = {}
[tool.metaxy.stores.dev.config]
# Optional
# connection_params = {}
export METAXY_STORES__DEV__CONFIG__CONNECTION_PARAMS=...

table_prefix

Optional prefix for all table names.

Type: str | None

[stores.dev.config]
# Optional
# table_prefix = null
[tool.metaxy.stores.dev.config]
# Optional
# table_prefix = null
export METAXY_STORES__DEV__CONFIG__TABLE_PREFIX=...

auto_create_tables

If True, create tables on open. For development/testing only.

Type: bool | None

[stores.dev.config]
# Optional
# auto_create_tables = null
[tool.metaxy.stores.dev.config]
# Optional
# auto_create_tables = null
export METAXY_STORES__DEV__CONFIG__AUTO_CREATE_TABLES=...