Skip to content

DuckDB 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=...

database

Database path (:memory:, file path, or md:database).

Type: str | pathlib.Path

[stores.dev.config]
# Optional
# database = null
[tool.metaxy.stores.dev.config]
# Optional
# database = null
export METAXY_STORES__DEV__CONFIG__DATABASE=...

config

DuckDB configuration settings (e.g., {'threads': '4'}).

Type: dict[str, str | None

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

extensions

DuckDB extensions to install and load on open.

Type: collections.abc.Sequence[str | metaxy.metadata_store.duckdb.ExtensionSpec | collections.abc.Mapping[str, Any | None

[stores.dev.config]
# Optional
# extensions = null
[tool.metaxy.stores.dev.config]
# Optional
# extensions = null
export METAXY_STORES__DEV__CONFIG__EXTENSIONS=...

ducklake

DuckLake attachment configuration.

metadata_backend

Type: metaxy.metadata_store._ducklake_support.SupportsDuckLakeParts | dict[str, Any

[stores.dev.config.ducklake]
# Optional
# metadata_backend = {}
[tool.metaxy.stores.dev.config.ducklake]
# Optional
# metadata_backend = {}
export METAXY_STORES__DEV__CONFIG__DUCKLAKE__METADATA_BACKEND=...

storage_backend

Type: metaxy.metadata_store._ducklake_support.SupportsDuckLakeParts | dict[str, Any

[stores.dev.config.ducklake]
# Optional
# storage_backend = {}
[tool.metaxy.stores.dev.config.ducklake]
# Optional
# storage_backend = {}
export METAXY_STORES__DEV__CONFIG__DUCKLAKE__STORAGE_BACKEND=...

alias

Type: str | Default: "ducklake"

[stores.dev.config.ducklake]
alias = "ducklake"
[tool.metaxy.stores.dev.config.ducklake]
alias = "ducklake"
export METAXY_STORES__DEV__CONFIG__DUCKLAKE__ALIAS=ducklake

plugins

Type: tuple[str, ...]

[stores.dev.config.ducklake]
# Optional
# plugins = null
[tool.metaxy.stores.dev.config.ducklake]
# Optional
# plugins = null
export METAXY_STORES__DEV__CONFIG__DUCKLAKE__PLUGINS=...

attach_options

Type: dict[str, Any]

[stores.dev.config.ducklake]
# Optional
# attach_options = {}
[tool.metaxy.stores.dev.config.ducklake]
# Optional
# attach_options = {}
export METAXY_STORES__DEV__CONFIG__DUCKLAKE__ATTACH_OPTIONS=...