Downloads 966this week

GitHub stars 1

Extension descriptor (YAML)

Read and write ClickHouse tables directly from DuckDB.

Compatibility Matrix

This table covers all DuckDB releases that have not reached end-of-life, including LTS releases, and shows the 2 most recent patch releases of each. Older patch releases are not listed, but the extension may be available for them as well.

Installing and Loading

INSTALL clickhouse_scanner FROM community;
LOAD clickhouse_scanner;

Example

INSTALL clickhouse_scanner FROM community;
LOAD clickhouse_scanner;

CREATE SECRET ch (
    TYPE clickhouse,
    HOST 'abc123.eu-west-1.aws.clickhouse.cloud',
    PORT 9440,
    USER 'default',
    PASSWORD 'my-pass',
    DATABASE 'analytics'
);
ATTACH '' AS ch (TYPE clickhouse, SECRET ch);

SELECT event, count(*)
FROM ch.analytics.events
WHERE ts > now() - INTERVAL 1 DAY
GROUP BY ALL;

INSERT INTO ch.analytics.events
SELECT * FROM read_parquet('events/*.parquet');

About clickhouse_scanner

The ClickHouse extension attaches a ClickHouse server, or ClickHouse Cloud, as a DuckDB database. Tables are read and written with ordinary DuckDB SQL over ClickHouse's native protocol, with TLS. Filters, projections and LIMITs are pushed down to ClickHouse.

Features include:

• ATTACH support for ClickHouse databases, including secrets for credentials
• reads from attached schemas and tables, including joins with local data
• writes with INSERT, COPY, CREATE TABLE, UPDATE and DELETE
• clickhouse_query and clickhouse_execute for ClickHouse SQL that DuckDB cannot express
• clickhouse_scan to read one table without attaching a database

Added Functions

Overloaded Functions

This extension does not add any function overloads.

Added Types

This extension does not add any types.

Added Settings