tap-clickhouse - Meltano Hub

ClickHouse

tap-clickhouse (akurdyukov variant)🥈

Fast Open-Source OLAP DBMS

The tap-clickhouse extractor pulls data from ClickHouse that can then be sent to a destination using a loader.

Alternate Implementations

Airbyte
🥈
akurdyukov (default)🥈

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Installation and configuration

Add the tap-clickhouse extractor to your project using
```
meltano add
```
:

meltano add extractor tap-clickhouse

Configure the tap-clickhouse settings using

meltano config

:

meltano config tap-clickhouse set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-clickhouse test

Next steps

Follow the remaining steps of the Getting Started guide:

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-clickhouse may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

about
batch
catalog
discover
schema-flattening
state
stream-maps

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-clickhouse settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

database
driver
host
password
port
secure
username
verify

Expand To Show SDK Settings

batch_config.encoding.compression
batch_config.encoding.format
batch_config.storage.prefix
batch_config.storage.root
faker_config.locale
faker_config.seed
flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-clickhouse list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Database (database)

Environment variable: TAP_CLICKHOUSE_DATABASE
Default Value: default

Database name

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set database [value]

Driver (driver)

Environment variable: TAP_CLICKHOUSE_DRIVER
Default Value: http

Driver type

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set driver [value]

Host (host)

Environment variable: TAP_CLICKHOUSE_HOST
Default Value: localhost

Database host

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set host [value]

Password (password)

Environment variable: TAP_CLICKHOUSE_PASSWORD

Username password

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set password [value]

Port (port)

Environment variable: TAP_CLICKHOUSE_PORT
Default Value: 8123

Database connection port

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set port [value]

Secure (secure)

Environment variable: TAP_CLICKHOUSE_SECURE
Default Value: false

Should the connection be secure

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set secure [value]

Username (username)

Environment variable: TAP_CLICKHOUSE_USERNAME
Default Value: default

Database user

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set username [value]

Verify (verify)

Environment variable: TAP_CLICKHOUSE_VERIFY
Default Value: true

Should secure connection need to verify SSL/TLS

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set verify [value]

Expand To Show SDK Settings

Batch Compression Format (batch_config.encoding.compression)

Environment variable: TAP_CLICKHOUSE_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set batch_config encoding.compression [value]

Batch Encoding Format (batch_config.encoding.format)

Environment variable: TAP_CLICKHOUSE_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set batch_config encoding.format [value]

Batch Storage Prefix (batch_config.storage.prefix)

Environment variable: TAP_CLICKHOUSE_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set batch_config storage.prefix [value]

Batch Storage Root (batch_config.storage.root)

Environment variable: TAP_CLICKHOUSE_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set batch_config storage.root [value]

Faker Locale (faker_config.locale)

Environment variable: TAP_CLICKHOUSE_FAKER_CONFIG_LOCALE

One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set faker_config locale [value]

Faker Seed (faker_config.seed)

Environment variable: TAP_CLICKHOUSE_FAKER_CONFIG_SEED

Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set faker_config seed [value]

Enable Schema Flattening (flattening_enabled)

Environment variable: TAP_CLICKHOUSE_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set flattening_enabled [value]

Max Flattening Depth (flattening_max_depth)

Environment variable: TAP_CLICKHOUSE_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set flattening_max_depth [value]

User Stream Map Configuration (stream_map_config)

Environment variable: TAP_CLICKHOUSE_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_CLICKHOUSE_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.

Configure this setting directly using the following Meltano command:

meltano config tap-clickhouse set stream_maps [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-clickhouse extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the

#plugins-general

channel.

Install

meltano add extractor tap-clickhouse

Maintenance Status

Repo

https://github.com/akurdyukov/tap-clickhouse

Maintainer

Meltano Stats

Keywords