Skip to content

Latest commit

 

History

History
85 lines (61 loc) · 3.51 KB

README.md

File metadata and controls

85 lines (61 loc) · 3.51 KB
Raw

Clickhouse Data Connector

Follow these steps to get started with Clickhouse as a Data Connector.

Preparation

  • Install the Spice.ai CLI

  • Install Clickhouse

  • Start a Clickhouse instance (clickhouse server)

    clickhouse server

  • Create a database and table, for example:

    clickhouse client
    CREATE TABLE my_first_table
(
    user_id UInt32,
    message String,
    timestamp DateTime,
    metric Float32
)
ENGINE = MergeTree
PRIMARY KEY (user_id, timestamp);

INSERT INTO my_first_table (user_id, message, timestamp, metric) VALUES
  (101, 'Hello, ClickHouse!',                                 now(),       -1.0    ),
  (102, 'Insert a lot of rows per batch',                     yesterday(), 1.41421 ),
  (102, 'Sort your data based on your commonly-used queries', today(),     2.718   ),
  (101, 'Granules are the smallest chunks of data read',      now() + 5,   3.14159 );

Quickstart

Step 1. Edit the spicepod.yaml file in this directory and replace the params in the clickhouse_quickstart dataset with the connection parameters for your Clickhouse instance, where [local_table_name] is your desired name for the federated table and [remote_table_path] is the name of the table in your Clickhouse instance.

Follow the quickstart guide to get started with the Spice.ai runtime.

See the datasets reference for more dataset configuration options.

Set the environment variable CLICKHOUSE_PASS to the Clickhouse instance password. Environment variables can be specified on the command line when running the Spice runtime or in a .env file in the same directory as spicepod.yaml. The password is not required if the Clickhouse instance does not have a password set.

i.e. to set the password in a .env file:

echo "CLICKHOUSE_PASS=<password>" > .env

A .env file is created in the project directory with the following content:

CLICKHOUSE_PASS=<password>

Step 2. Run the Spice runtime with spice run from this directory.

Step 3. Run spice sql in a new terminal to start an interactive SQL query session against the Spice runtime.

For more information on using spice sql, see the CLI reference.

Step 4. Execute the query select * from [local_table_name]; to see the Clickhouse table accelerated locally.

$ spice sql
Welcome to the Spice.ai SQL REPL! Type 'help' for help.

show tables; -- list available tables
sql> select * from my_first_table;
+---------+----------------------------------------------------+---------------------+---------+
| user_id | message                                            | timestamp           | metric  |
+---------+----------------------------------------------------+---------------------+---------+
| 101     | Hello, ClickHouse!                                 | 2024-09-02T05:53:24 | -1.0    |
| 101     | Granules are the smallest chunks of data read      | 2024-09-02T05:53:29 | 3.14159 |
| 102     | Insert a lot of rows per batch                     | 2024-08-31T15:00:00 | 1.41421 |
| 102     | Sort your data based on your commonly-used queries | 2024-09-01T15:00:00 | 2.718   |
+---------+----------------------------------------------------+---------------------+---------+

Time: 0.004758125 seconds. 4 rows.