OS Manuals

/usr/bin/clickhouse-copier

Altinity Stable Build for ClickHouse - production-ready releases with extended support, rigorous testing, and 100% compatibility with upstream ClickHouse.

From altinity-clickhouse-22.8 22.8.20.12-r3 (enterprise-packages), captured 2026-11-08 by running clickhouse-copier --help (exit 0). permalink

usage: clickhouse-copier --config-file <config-file> --task-path <task-path>
Copies tables from one cluster to another

-C<file>, --config-file=<file>
                                                                                       load
                                                                                       configuration
                                                                                       from
                                                                                       a
                                                                                       given
                                                                                       file
-L<file>, --log-file=<file>
                                                                                       use
                                                                                       given
                                                                                       log
                                                                                       file
-E<file>, --errorlog-file=<file>
                                                                                       use
                                                                                       given
                                                                                       log
                                                                                       file
                                                                                       for
                                                                                       errors
                                                                                       only
-P<file>, --pid-file=<file>
                                                                                       use
                                                                                       given
                                                                                       pidfile
--daemon
                                                                                       Run
                                                                                       application
                                                                                       as
                                                                                       a
                                                                                       daemon.
--umask=mask
                                                                                       Set
                                                                                       the
                                                                                       daemon's
                                                                                       umask
                                                                                       (octal,
                                                                                       e.g.
                                                                                       027).
--pidfile=path
                                                                                       Write
                                                                                       the
                                                                                       process
                                                                                       ID
                                                                                       of
                                                                                       the
                                                                                       application
                                                                                       to
                                                                                       given
                                                                                       file.
--task-path=task-path
                                                                                       path
                                                                                       to
                                                                                       task
                                                                                       in
                                                                                       ZooKeeper
--task-file=task-file
                                                                                       path
                                                                                       to
                                                                                       task
                                                                                       file
                                                                                       for
                                                                                       uploading
                                                                                       in
                                                                                       ZooKeeper
                                                                                       to
                                                                                       task-path
--task-upload-force=task-upload-force
                                                                                       Force
                                                                                       upload
                                                                                       task-file
                                                                                       even
                                                                                       node
                                                                                       already
                                                                                       exists
--safe-mode
                                                                                       disables
                                                                                       ALTER
                                                                                       DROP
                                                                                       PARTITION
                                                                                       in
                                                                                       case
                                                                                       of
                                                                                       errors
--copy-fault-probability=copy-fault-probability
                                                                                       the
                                                                                       copying
                                                                                       fails
                                                                                       with
                                                                                       specified
                                                                                       probability
                                                                                       (used
                                                                                       to
                                                                                       test
                                                                                       partition
                                                                                       state
                                                                                       recovering)
--move-fault-probability=move-fault-probability
                                                                                       the
                                                                                       moving
                                                                                       fails
                                                                                       with
                                                                                       specified
                                                                                       probability
                                                                                       (used
                                                                                       to
                                                                                       test
                                                                                       partition
                                                                                       state
                                                                                       recovering)
--log-level=log-level
                                                                                       sets
                                                                                       log
                                                                                       level
--base-dir=base-dir
                                                                                       base
                                                                                       directory
                                                                                       for
                                                                                       copiers,
                                                                                       consecutive
                                                                                       copier
                                                                                       launches
                                                                                       will
                                                                                       populate
                                                                                       /base-dir/launch_id/*
                                                                                       directories
--experimental-use-sample-offset=experimental-use-sample-offset
                                                                                       Use
                                                                                       SAMPLE
                                                                                       OFFSET
                                                                                       query
                                                                                       instead
                                                                                       of
                                                                                       cityHash64(PRIMARY
                                                                                       KEY)
                                                                                       %
                                                                                       n
                                                                                       ==
                                                                                       k
--status
                                                                                       Get
                                                                                       for
                                                                                       status
                                                                                       for
                                                                                       current
                                                                                       execution
--max-table-tries=max-table-tries
                                                                                       Number
                                                                                       of
                                                                                       tries
                                                                                       for
                                                                                       the
                                                                                       copy
                                                                                       table
                                                                                       task
--max-shard-partition-tries=max-shard-partition-tries
                                                                                       Number
                                                                                       of
                                                                                       tries
                                                                                       for
                                                                                       the
                                                                                       copy
                                                                                       one
                                                                                       partition
                                                                                       task
--max-shard-partition-piece-tries-for-alter=max-shard-partition-piece-tries-for-alter
                                                                                       Number
                                                                                       of
                                                                                       tries
                                                                                       for
                                                                                       final
                                                                                       ALTER
                                                                                       ATTACH
                                                                                       to
                                                                                       destination
                                                                                       table
--retry-delay-ms=retry-delay-ms
                                                                                       Delay
                                                                                       between
                                                                                       task
                                                                                       retries
--help
                                                                                       produce
                                                                                       this
                                                                                       help
                                                                                       message
Options (22)
OptionDescriptionSource
-C, --config-file fileload configuration from a given filehelp
-L, --log-file fileuse given log filehelp
-E, --errorlog-file fileuse given log file for errors onlyhelp
-P, --pid-file fileuse given pidfilehelp
--daemonRun application as a daemon.help
--umask maskSet the daemon's umask (octal, e.g. 027).help
--pidfile pathWrite the process ID of the application to given file.help
--task-path task-pathpath to task in ZooKeeperhelp
--task-file task-filepath to task file for uploading in ZooKeeper to task-pathhelp
--task-upload-force task-upload-forceForce upload task-file even node already existshelp
--safe-modedisables ALTER DROP PARTITION in case of errorshelp
--copy-fault-probability copy-fault-probabilitythe copying fails with specified probability (used to test partition state recovering)help
--move-fault-probability move-fault-probabilitythe moving fails with specified probability (used to test partition state recovering)help
--log-level log-levelsets log levelhelp
--base-dir base-dirbase directory for copiers, consecutive copier launches will populate /base-dir/launch_id/* directorieshelp
--experimental-use-sample-offset experimental-use-sample-offsetUse SAMPLE OFFSET query instead of cityHash64(PRIMARY KEY) % n == khelp
--statusGet for status for current executionhelp
--max-table-tries max-table-triesNumber of tries for the copy table taskhelp
--max-shard-partition-tries max-shard-partition-triesNumber of tries for the copy one partition taskhelp
--max-shard-partition-piece-tries-for-alterNumber of tries for final ALTER ATTACH to destination tablehelp
--retry-delay-ms retry-delay-msDelay between task retrieshelp
--helpproduce this help messagehelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.