tigrbl_engine_clickhouse 0.4.2.dev4

ClickHouse engine plugin for analytical database sessions, warehouse workloads, and Tigrbl engine registration.

tigrbl_engine_clickhouse

ClickHouse engine plugin for analytical database sessions, warehouse workloads, and Tigrbl engine registration.

What is tigrbl_engine_clickhouse?

ClickHouse engine plugin for analytical database sessions, warehouse workloads, and Tigrbl engine registration.

Why use tigrbl_engine_clickhouse?

Use it when a Tigrbl application needs this backend without installing every engine package.

When should I install tigrbl_engine_clickhouse?

Install it when the storage, analytics, cache, or integration workload named by this package is the intended runtime backend.

Who is tigrbl_engine_clickhouse for?

Application developers, data platform engineers, and operators choosing concrete persistence or data-plane behavior.

Where does tigrbl_engine_clickhouse fit?

tigrbl_engine_clickhouse lives at pkgs/engines/tigrbl_engine_clickhouse and serves ClickHouse analytical workloads.

How does tigrbl_engine_clickhouse work?

It exposes a tigrbl.engine entry point and a package register() hook so Tigrbl can discover or load the backend at runtime.

Certification Status

• Package status: governed package in the tigrbl/tigrbl workspace.
• Governance source: SSOT registry.
• Release evidence: publish workflow validates package builds, tests, GitHub release assets, and PyPI publication for managed packages.
• Local certification guard: pkgs/core/tigrbl_tests/tests/unit/test_package_badges_and_notices.py verifies every package README keeps the Discord badge, Apache 2.0 badge, explicit Python-version badge, LICENSE, and NOTICE.
• Scope note: this README documents the package boundary. Runtime feature support remains governed by .ssot/ entities and the conformance docs linked below.

Install

uv add tigrbl_engine_clickhouse

pip install tigrbl_engine_clickhouse

Surface Coverage

Surface	Value
PyPI package	tigrbl_engine_clickhouse
Repository path	pkgs/engines/tigrbl_engine_clickhouse
Python import root	tigrbl_engine_clickhouse
Console scripts	none declared
Entry points	tigrbl.engine
Optional extras	none declared
Legal files	LICENSE, NOTICE
Supported Python	`3.10

What It Owns

tigrbl_engine_clickhouse owns the engine plugin boundary. It should be installed when you need this package's focused responsibility without assuming every other Tigrbl workspace package is present.

Implementation orientation:

• tigrbl_engine_clickhouse: engine, session

Public API and Import Surface

• Import roots: tigrbl_engine_clickhouse.
• Public symbols: ClickHouseEngine, ClickHouseSession, clickhouse_engine, register.
• Workspace dependencies: tigrbl.
• External runtime dependencies: clickhouse-connect>=0.6.0.

Usage Examples

Verify the installed package

python -m pip show tigrbl_engine_clickhouse
python - <<'PY'
from importlib.metadata import version
print(version("tigrbl_engine_clickhouse"))
PY

Register the engine plugin explicitly

from tigrbl_engine_clickhouse import register

register()

Discover the engine through package metadata

from importlib.metadata import entry_points

for entry_point in entry_points(group="tigrbl.engine"):
    if entry_point.module.startswith("tigrbl_engine_clickhouse"):
        plugin_register = entry_point.load()
        plugin_register()

Install alongside the facade

uv add tigrbl tigrbl_engine_clickhouse
pip install tigrbl tigrbl_engine_clickhouse

How To Choose This Package

Choose tigrbl_engine_clickhouse when the quick-answer table matches your use case. Choose tigrbl instead when you want the full public facade. Choose a lower-level package such as tigrbl-core, tigrbl-base, or tigrbl-runtime when you are building framework extensions or testing a specific internal boundary.

Related Packages

• tigrbl
• tigrbl-core
• tigrbl-runtime
• tigrbl_engine_sqlite
• tigrbl_engine_postgres
• tigrbl_engine_duckdb
• tigrbl_engine_pandas

Documentation Links

• Workspace docs
• Package catalog
• Package layout
• Current target
• Current state
• SSOT registry
• Release workflow

Support

• Community: Discord.
• Issues: GitHub Issues.
• Repository: pkgs/engines/tigrbl_engine_clickhouse.

Package-local Boundary

This README is the package-local distribution entry point for tigrbl_engine_clickhouse. It answers install, usage, API, ownership, and certification-orientation questions for this package. Broader architectural decisions, release status, and cross-package proof chains remain in the repository-level docs and SSOT registry.

License

Licensed under the Apache License, Version 2.0. See LICENSE, NOTICE, and the official Apache 2.0 license text.