mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-12-16 03:12:43 +00:00
188 lines
7.7 KiB
Markdown
188 lines
7.7 KiB
Markdown
---
|
|
slug: /en/operations/utilities/clickhouse-copier
|
|
sidebar_position: 59
|
|
sidebar_label: clickhouse-copier
|
|
---
|
|
|
|
# clickhouse-copier
|
|
|
|
Copies data from the tables in one cluster to tables in another (or the same) cluster.
|
|
|
|
:::warning
|
|
To get a consistent copy, the data in the source tables and partitions should not change during the entire process.
|
|
:::
|
|
|
|
You can run multiple `clickhouse-copier` instances on different servers to perform the same job. ClickHouse Keeper, or ZooKeeper, is used for syncing the processes.
|
|
|
|
After starting, `clickhouse-copier`:
|
|
|
|
- Connects to ClickHouse Keeper and receives:
|
|
|
|
- Copying jobs.
|
|
- The state of the copying jobs.
|
|
|
|
- It performs the jobs.
|
|
|
|
Each running process chooses the “closest” shard of the source cluster and copies the data into the destination cluster, resharding the data if necessary.
|
|
|
|
`clickhouse-copier` tracks the changes in ClickHouse Keeper and applies them on the fly.
|
|
|
|
To reduce network traffic, we recommend running `clickhouse-copier` on the same server where the source data is located.
|
|
|
|
## Running Clickhouse-copier {#running-clickhouse-copier}
|
|
|
|
The utility should be run manually:
|
|
|
|
``` bash
|
|
$ clickhouse-copier --daemon --config keeper.xml --task-path /task/path --base-dir /path/to/dir
|
|
```
|
|
|
|
Parameters:
|
|
|
|
- `daemon` — Starts `clickhouse-copier` in daemon mode.
|
|
- `config` — The path to the `keeper.xml` file with the parameters for the connection to ClickHouse Keeper.
|
|
- `task-path` — The path to the ClickHouse Keeper node. This node is used for syncing `clickhouse-copier` processes and storing tasks. Tasks are stored in `$task-path/description`.
|
|
- `task-file` — Optional path to file with task configuration for initial upload to ClickHouse Keeper.
|
|
- `task-upload-force` — Force upload `task-file` even if node already exists.
|
|
- `base-dir` — The path to logs and auxiliary files. When it starts, `clickhouse-copier` creates `clickhouse-copier_YYYYMMHHSS_<PID>` subdirectories in `$base-dir`. If this parameter is omitted, the directories are created in the directory where `clickhouse-copier` was launched.
|
|
|
|
## Format of keeper.xml {#format-of-zookeeper-xml}
|
|
|
|
``` xml
|
|
<clickhouse>
|
|
<logger>
|
|
<level>trace</level>
|
|
<size>100M</size>
|
|
<count>3</count>
|
|
</logger>
|
|
|
|
<zookeeper>
|
|
<node index="1">
|
|
<host>127.0.0.1</host>
|
|
<port>2181</port>
|
|
</node>
|
|
</zookeeper>
|
|
</clickhouse>
|
|
```
|
|
|
|
## Configuration of Copying Tasks {#configuration-of-copying-tasks}
|
|
|
|
``` xml
|
|
<clickhouse>
|
|
<!-- Configuration of clusters as in an ordinary server config -->
|
|
<remote_servers>
|
|
<source_cluster>
|
|
<!--
|
|
source cluster & destination clusters accept exactly the same
|
|
parameters as parameters for the usual Distributed table
|
|
see https://clickhouse.com/docs/en/engines/table-engines/special/distributed/
|
|
-->
|
|
<shard>
|
|
<internal_replication>false</internal_replication>
|
|
<replica>
|
|
<host>127.0.0.1</host>
|
|
<port>9000</port>
|
|
<!--
|
|
<user>default</user>
|
|
<password>default</password>
|
|
<secure>1</secure>
|
|
-->
|
|
</replica>
|
|
</shard>
|
|
...
|
|
</source_cluster>
|
|
|
|
<destination_cluster>
|
|
...
|
|
</destination_cluster>
|
|
</remote_servers>
|
|
|
|
<!-- How many simultaneously active workers are possible. If you run more workers superfluous workers will sleep. -->
|
|
<max_workers>2</max_workers>
|
|
|
|
<!-- Setting used to fetch (pull) data from source cluster tables -->
|
|
<settings_pull>
|
|
<readonly>1</readonly>
|
|
</settings_pull>
|
|
|
|
<!-- Setting used to insert (push) data to destination cluster tables -->
|
|
<settings_push>
|
|
<readonly>0</readonly>
|
|
</settings_push>
|
|
|
|
<!-- Common setting for fetch (pull) and insert (push) operations. Also, copier process context uses it.
|
|
They are overlaid by <settings_pull/> and <settings_push/> respectively. -->
|
|
<settings>
|
|
<connect_timeout>3</connect_timeout>
|
|
<!-- Sync insert is set forcibly, leave it here just in case. -->
|
|
<insert_distributed_sync>1</insert_distributed_sync>
|
|
</settings>
|
|
|
|
<!-- Copying tasks description.
|
|
You could specify several table task in the same task description (in the same ZooKeeper node), they will be performed
|
|
sequentially.
|
|
-->
|
|
<tables>
|
|
<!-- A table task, copies one table. -->
|
|
<table_hits>
|
|
<!-- Source cluster name (from <remote_servers/> section) and tables in it that should be copied -->
|
|
<cluster_pull>source_cluster</cluster_pull>
|
|
<database_pull>test</database_pull>
|
|
<table_pull>hits</table_pull>
|
|
|
|
<!-- Destination cluster name and tables in which the data should be inserted -->
|
|
<cluster_push>destination_cluster</cluster_push>
|
|
<database_push>test</database_push>
|
|
<table_push>hits2</table_push>
|
|
|
|
<!-- Engine of destination tables.
|
|
If destination tables have not be created, workers create them using columns definition from source tables and engine
|
|
definition from here.
|
|
|
|
NOTE: If the first worker starts insert data and detects that destination partition is not empty then the partition will
|
|
be dropped and refilled, take it into account if you already have some data in destination tables. You could directly
|
|
specify partitions that should be copied in <enabled_partitions/>, they should be in quoted format like partition column of
|
|
system.parts table.
|
|
-->
|
|
<engine>
|
|
ENGINE=ReplicatedMergeTree('/clickhouse/tables/{cluster}/{shard}/hits2', '{replica}')
|
|
PARTITION BY toMonday(date)
|
|
ORDER BY (CounterID, EventDate)
|
|
</engine>
|
|
|
|
<!-- Sharding key used to insert data to destination cluster -->
|
|
<sharding_key>jumpConsistentHash(intHash64(UserID), 2)</sharding_key>
|
|
|
|
<!-- Optional expression that filter data while pull them from source servers -->
|
|
<where_condition>CounterID != 0</where_condition>
|
|
|
|
<!-- This section specifies partitions that should be copied, other partition will be ignored.
|
|
Partition names should have the same format as
|
|
partition column of system.parts table (i.e. a quoted text).
|
|
Since partition key of source and destination cluster could be different,
|
|
these partition names specify destination partitions.
|
|
|
|
NOTE: In spite of this section is optional (if it is not specified, all partitions will be copied),
|
|
it is strictly recommended to specify them explicitly.
|
|
If you already have some ready partitions on destination cluster they
|
|
will be removed at the start of the copying since they will be interpeted
|
|
as unfinished data from the previous copying!!!
|
|
-->
|
|
<enabled_partitions>
|
|
<partition>'2018-02-26'</partition>
|
|
<partition>'2018-03-05'</partition>
|
|
...
|
|
</enabled_partitions>
|
|
</table_hits>
|
|
|
|
<!-- Next table to copy. It is not copied until previous table is copying. -->
|
|
<table_visits>
|
|
...
|
|
</table_visits>
|
|
...
|
|
</tables>
|
|
</clickhouse>
|
|
```
|
|
|
|
`clickhouse-copier` tracks the changes in `/task/path/description` and applies them on the fly. For instance, if you change the value of `max_workers`, the number of processes running tasks will also change.
|