tap-clickhouse is a Singer tap for ClickHouse. Unlike 'airbyte' variant this one does not need docker to run.

Built with the Meltano Tap SDK for Singer Taps.

Install from GitHub:

pipx install git+https://github.com/akurdyukov/tap-clickhouse.git@main

• catalog
• state
• discover
• about
• stream-maps
• schema-flattening
• batch

A full list of supported settings and capabilities for this tap is available by running:

tap-clickhouse --about

This Singer tap will automatically import any environment variables within the working directory's .env if the --config=ENV is provided, such that config values will be considered if a matching environment variable is set either in the terminal context or in the .env file.

Set username and password settings to authorize.

You can easily run tap-clickhouse by itself or in a pipeline using Meltano.

tap-clickhouse --version
tap-clickhouse --help
tap-clickhouse --config CONFIG --discover > ./catalog.json

Follow these instructions to contribute to this project.

pipx install poetry
poetry install

Create tests within the tests subfolder and then run:

poetry run pytest

You can also test the tap-clickhouse CLI interface directly using poetry run:

poetry run tap-clickhouse --help

Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Run ClickHouse server with basic database using

docker-compose -f tests/docker-compose.yml up -d

Next, install Meltano (if you haven't already) and any needed plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-clickhouse
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-clickhouse --version
# OR run a test `elt` pipeline:
meltano elt tap-clickhouse target-jsonl

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.