splinkclickhouse

Basic Clickhouse support for use as a backend with the data-linkage and deduplication package Splink.

Supports clickhouse server connected via clickhouse connect.

Also supports in-process chDB version if installed with the chdb extras.

Installation

Install from PyPI using pip:

# just installs the Clickhouse server dependencies
pip install splinkclickhouse
# or to install with support for chdb:
pip install splinkclickhouse[chdb]

or you can install the package directly from github:

# Replace with any version you want, or specify a branch after '@'
pip install git+https://github.com/ADBond/splinkclickhouse.git@v0.4.1

If instead you are using conda, splinkclickhouse is available on conda-forge:

conda install conda-forge::splinkclickhouse

Note that the conda version will only be able to use the Clickhouse server functionality as chdb is not currently available within conda.

Documentation

Head over to the docs site for details on using the package.

Caveats

While the package is in early development there will may be breaking changes in new versions without warning, although these should only occur in new minor versions. Nevertheless if you depend on this package it is recommended to pin a version to avoid any disruption that this may cause.

It is tested against Clickhouse server version 24.8. There have also been occasional tests against 24.11. Other versions are likely to function normally, but if you have a significantly different version, functionality may be affected.

Dev setup

For dev setup see dev.md.

Use

See the docs TODO.

Support

If you have difficulties with the package you can open an issue. You may also suggest changes by opening a PR, although it may be best to discuss in an issue beforehand.

This package is 'unofficial', in that it is not directly supported by the Splink team. Maintenance / improvements will be done on a 'best effort' basis where resources allow.