tap-clickhouse
tap-clickhouse is a Singer tap for ClickHouse.
Built with the Meltano Tap SDK for Singer Taps.
Installation
Install from GitHub:
pipx install git+https://github.com/akurdyukov/tap-clickhouse.git@main
Configuration
Capabilities
catalogstatediscoveraboutstream-mapsschema-flatteningbatch
Accepted Config Options
| Setting | Required | Default | Description |
|---|---|---|---|
| driver | False | http | Driver type |
| username | False | default | Database user |
| password | True | None | Username password |
| host | False | localhost | Database host |
| port | False | 8123 | Database connection port |
| database | False | default | Database name |
| secure | False | 0 | Should the connection be secure |
| verify | False | 1 | Should secure connection need to verify SSL/TLS |
| stream_maps | False | None | Config object for stream maps capability. For more information check out Stream Maps. |
| stream_map_config | False | None | User-defined config values to be used within map expressions. |
| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |
| flattening_max_depth | False | None | The max depth to flatten schemas. |
| batch_config | False | None |
A full list of supported settings and capabilities for this tap is available by running:
tap-clickhouse --about
Configure using environment variables
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.
Source Authentication and Authorization
Set username and password settings to authorize.
Usage
You can easily run tap-clickhouse by itself or in a pipeline using Meltano.
Executing the Tap Directly
tap-clickhouse --version
tap-clickhouse --help
tap-clickhouse --config CONFIG --discover > ./catalog.json
Developer Resources
Follow these instructions to contribute to this project.
Initialize your Development Environment
pipx install poetry
poetry install
Create and Run Tests
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
Testing with Meltano
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
SDK Dev Guide
See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.
1 maintainer
Metadata
1 maintainer
Release files for akurdyukov-tap-clickhouse 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| akurdyukov_tap_clickhouse-0.0.1.tar.gz | 8.6 kB | Without provenance | Details for akurdyukov_tap_clickhouse-0.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| akurdyukov_tap_clickhouse-0.0.1-py3-none-any.whl | Python 3 | none | any | Details for akurdyukov_tap_clickhouse-0.0.1-py3-none-any.whl |
Total release size: 18.3 kB
Release files / akurdyukov_tap_clickhouse-0.0.1.tar.gz
| Download URL | akurdyukov_tap_clickhouse-0.0.1.tar.gz |
|---|---|
| Size | 8.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c795f264371683050cdcf9c020753956216c79e116e61779413394e4aead6b59
|
|
BLAKE2b-256 checksum How to use checksums |
1fa5b589991912e98596988c93f4722e99d4225a6e7a176c44cb7fc06d6c227f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.6.1 CPython/3.11.5 Darwin/22.5.0
|
Release files / akurdyukov_tap_clickhouse-0.0.1-py3-none-any.whl
| Download URL | akurdyukov_tap_clickhouse-0.0.1-py3-none-any.whl |
|---|---|
| Size | 9.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
51d140a63263d721f899d88d877bd5f352f9de0403c2de5ca6fbd3c7b9b2b693
|
|
BLAKE2b-256 checksum How to use checksums |
d18532516de1cd2dc7ce3e8ec7c53ce42ed3fc2354cbbf5b8e75b8a535848454
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.6.1 CPython/3.11.5 Darwin/22.5.0
|
Security for akurdyukov-tap-clickhouse 0.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
