Clickhouse Server

The primary way to use splinkclickhouse is with data in a running Clickhouse server.

Connecting to Splink

To use Clickhouse with Splink you will need to connect to your Clickhouse instance with clickhouse-connect.

You will need to configure a client to your running version, and use this to create a Splink DatabaseAPI:

import clickhouse_connect

from splinkclickhouse import ClickhouseServerAPI

client = clickhouse_connect.get_client(
    host="127.0.0.1",
    port=8443,
    username="splink_user",
    password="password",
    database="database",
)

db_api = ClickhouseServerAPI(client)

From this point onwards your code should generally be the same as that appearing in the Splink docs. The exceptions will be if you want to take advantage of Clickhouse-specific comparisons or need advanced usage.

Dates

If you are working with dates, particularly those before 1900, you may wish to read the guide on working with dates.