OS Manuals

/usr/bin/clickhouse-disks

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

From altinity-clickhouse-24.8 24.8.14.10550-r0 (enterprise-packages), captured 2026-11-08 by running clickhouse-disks --help (exit 0). permalink

 ClickHouse disk management tool
  -h [ --help ]            Print common help message
  -C [ --config-file ] arg Set config file
  --disk arg               Set disk name
  --save-logs              Save logs to a file
  --log-level arg          Logging level
  -q [ --query ] arg       Query for a non-interactive mode
  --test-mode              Interactive interface in test regyme

Available commands:
help     Print help message about available commands
  --command arg         A command to help with (optional, positional), if not
                        specified, help lists all the commands

switch-disk(switch_disk)     Switch disk (makes sense only in interactive mode)
  --disk arg            the disk to switch to (mandatory, positional)
  --path arg            the path to switch on the disk

read(r,cat)     Read a file from `path-from` to `path-to`
  --path-from arg       file from which we are reading (mandatory, positional)
  --path-to arg         file to which we are writing, defaults to `stdout`

current_disk_with_path(cur,current,current_disk,current_path)     Prints current disk and path (which coincide with the prompt)

list-disks(ls_disks,ls-disks,list_disks)     Lists all available disks

link(ln)     Create hardlink from `from_path` to `to_path`
  --path-from arg       the path from which a hard link will be created
                        (mandatory, positional)
  --path-to arg         the path where a hard link will be created (mandatory,
                        positional)

touch(create)     Create a file by path
  --path arg            the path of listing (mandatory, positional)

mkdir     Creates a directory
  --parents             recursively create directories
  --path arg            the path on which directory should be created
                        (mandatory, positional)

remove(delete,rm)     Remove file or directory. Throws exception if file doesn't exists
  --path arg            path that is going to be deleted (mandatory,
                        positional)
  -r [ --recursive ]    recursively removes the directory (required to remove a
                        directory)

move(mv)     Move file or directory from `from_path` to `to_path`
  --path-from arg       path from which we copy (mandatory, positional)
  --path-to arg         path to which we copy (mandatory, positional)

write(w)     Write a file from `path-from` to `path-to`
  --path-from arg       file from which we are reading, defaults to `stdin`
                        (input from `stdin` is finished by Ctrl+D)
  --path-to arg         file to which we are writing (mandatory, positional)

cd(change_dir,change-dir)     Change directory (makes sense only in interactive mode)
  --path arg            the path to which we want to change (mandatory,
                        positional)
  --disk arg            A disk where the path is changed (without disk
                        switching)

list(ls)     List files at path[s]
  --recursive           recursively list the directory
  --all                 show hidden files
  --path arg            the path of listing (mandatory, positional)

copy(cp)     Recursively copy data from `path-from` to `path-to`
  --disk-from arg       disk from which we copy is executed (default value is a
                        current disk)
  --disk-to arg         disk to which copy is executed (default value is a
                        current disk)
  --path-from arg       path from which copy is executed (mandatory,
                        positional)
  --path-to arg         path to which copy is executed (mandatory, positional)
  -r [ --recursive ]    recursively copy the directory (required to remove a
                        directory)
Options (16)
OptionDescriptionSource
-hPrint common help messagehelp
--disk argSet disk namehelp
--save-logsSave logs to a filehelp
--log-level argLogging levelhelp
-qQuery for a non-interactive modehelp
--test-modeInteractive interface in test regymehelp
--command argA command to help with (optional, positional), if not specified, help lists all the commandshelp
--path argthe path to switch on the diskhelp
--path-from argfile from which we are reading (mandatory, positional)help
--path-to argfile to which we are writing, defaults to `stdout`help
--parentsrecursively create directorieshelp
-rrecursively removes the directory (required to remove a directory)help
--recursiverecursively list the directoryhelp
--allshow hidden fileshelp
--disk-from argdisk from which we copy is executed (default value is a current disk)help
--disk-to argdisk to which copy is executed (default value is a current disk)help

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