The target-clickhouse loader sends data into Clickhouse after it was pulled from a source using an extractor
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the target-clickhouse loader to your
project using
:meltano add
-
Configure the target-clickhouse
settings using
:meltano config
meltano add loader target-clickhouse
meltano config target-clickhouse set --interactive
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
target-clickhouse
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this loader. 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 loader.
This plugin has the following capabilities:
- about
- schema-flattening
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
target-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:
add_record_metadata
default_target_schema
flattening_enabled
flattening_max_depth
sqlalchemy_url
stream_map_config
stream_maps
table_name
You can also list these settings using
with the meltano config
list
subcommand:
meltano config target-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.
Add Record Metadata (add_record_metadata)
-
Environment variable:
TARGET_CLICKHOUSE_ADD_RECORD_METADATA
Add metadata to records.
Configure this setting directly using the following Meltano command:
meltano config target-clickhouse set add_record_metadata [value]
Default Target Schema (default_target_schema)
-
Environment variable:
TARGET_CLICKHOUSE_DEFAULT_TARGET_SCHEMA
The default target database schema name to use for all streams.
Configure this setting directly using the following Meltano command:
meltano config target-clickhouse set default_target_schema [value]
Flattening Enabled (flattening_enabled)
-
Environment variable:
TARGET_CLICKHOUSE_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config target-clickhouse set flattening_enabled [value]
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TARGET_CLICKHOUSE_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config target-clickhouse set flattening_max_depth [value]
Sqlalchemy URL (sqlalchemy_url)
-
Environment variable:
TARGET_CLICKHOUSE_SQLALCHEMY_URL
The SQLAlchemy connection string for the ClickHouse database
Configure this setting directly using the following Meltano command:
meltano config target-clickhouse set sqlalchemy_url [value]
Stream Map Config (stream_map_config)
-
Environment variable:
TARGET_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 target-clickhouse set stream_map_config [value]
Stream Maps (stream_maps)
-
Environment variable:
TARGET_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 target-clickhouse set stream_maps [value]
Table Name (table_name)
-
Environment variable:
TARGET_CLICKHOUSE_TABLE_NAME
The name of the table to write to. Defaults to stream name.
Configure this setting directly using the following Meltano command:
meltano config target-clickhouse set table_name [value]
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general
channel.