Module prelude 

To simplify compatibility, crates for clickhouse_arrow, datafusion, and datafusion::arrow are re-exported.

Re-exports

pub use super::analyzer::function_pushdown::ClickHouseFunctionPushdown;

pub use super::sql::SqlTable;

pub use super::table_factory::ClickHouseTableFactory;

pub use super::table_factory::ClickHouseTableProviderFactory;

pub use super::udfs::eval::clickhouse_eval_udf;

pub use super::udfs::register_clickhouse_functions;

pub use datafusion::arrow;

pub use clickhouse_arrow;

pub use datafusion;

pub use super::providers::*;

Modules

plan_node

A UserDefinedLogicalNodeCore implementation for wrapping largest sub-trees of a DataFusion logical plan for execution on ClickHouse directly.

planner

An ExtensionPlanner implementation for executing ClickHouseFunctionNodes

Structs

ClickHouseBuilder

Entrypoint builder for ClickHouse and DataFusion integration.

ClickHouseCatalogBuilder

ClickHouseCatalogBuilder can be used to create tables, register existing tables, and finally refresh the ClickHouse catalog in DataFusion.

ClickHouseConnection

A wrapper around ArrowPoolConnection that provides additional functionality relevant for DataFusion.

ClickHouseConnectionPool

A wrapper around a clickhouse_arrow::ConnectionPool<ArrowFormat>

ClickHouseContextProvider

Custom ContextProvider

ClickHouseDataSink

datafusion::datasource::sink::DataSink for ClickHouse

ClickHouseQueryPlanner

A custom QueryPlanner leveraging ClickHouseExtensionPlanner

ClickHouseSessionContext

Wrapper for SessionContext which allows running arbitrary ClickHouse functions.

ClickHouseTableCreator

Builder phase for creating ClickHouse tables.

Constants

DEFAULT_CLICKHOUSE_CATALOG

The default DataFusion catalog name if no other name is provided.

Functions

configure_analyzer_rules

Given a SessionState, configure the analyzer rules for the ClickHouse session context.

default_arrow_options

Simple function to provide default ArrowOptions fit for common use

prepare_session_context

Convenience method (opinionated) for preparing a session context both with federation if the feature is enabled as well as UDF pushdown support through the custom Analyzer. It is called in ClickHouseSessionContext::new and ClickHouseSessionContext::from when creating a new ClickHouseSessionContext.

Type Aliases

ArrowPoolConnection

Type alias for a pooled connection to a ClickHouse database.