add docs for clickhouse-disks

docs/en/operations/utilities/clickhouse-disks.md

@@ -0,0 +1,38 @@
+---
+slug: /en/operations/utilities/clickhouse-disks
+sidebar_position: 59
+sidebar_label: clickhouse-disks
+---
+
+# clickhouse-disks
+
+A utility providing filesystem-like operations for ClickHouse disks.
+
+Program-wide options:
+
+* `--config-file, -C` -- path to ClickHouse config, defaults to `/etc/clickhouse-server/config.xml`.
+* `--save-logs` -- Log progress of invoked commands to `/var/log/clickhouse-server/clickhouse-disks.log`.
+* `--log-level` -- What [type](../server-configuration-parameters/settings#server_configuration_parameters-logger) of events to log, defaults to `none`.
+* `--disk` -- what disk to use for `mkdir, move, read, write, remove` commands. Defaults to `default`.
+
+## Commands
+
+* `copy [--diskFrom d1] [--diskTo d2] <FROM_PATH> <TO_PATH>`.
+  Recursively copy data from `FROM_PATH` at disk `d1` (defaults to `disk` value if not provided)
+  to `TO_PATH` at disk `d2` (defaults to `disk` value if not provided).
+* `move <FROM_PATH> <TO_PATH>`.
+  Move file or directory from `FROM_PATH` to `TO_PATH`.
+* `remove <PATH>`.
+  Remove `PATH` recursively.
+* `link <FROM_PATH> <TO_PATH>`.
+  Create a hardlink from `FROM_PATH` to `TO_PATH`.
+* `list [--recursive] <PATH>...`
+  List files at `PATH`s. Non-recursive by default.
+* `list-disks`.
+  List disks names.
+* `mkdir [--recursive] <PATH>`.
+  Create a directory. Non-recursive by default.
+* `read: <FROM_PATH> [<TO_PATH>]`
+  Read a file from `FROM_PATH` to `TO_PATH` (`stdout` if not supplied).
+* `write [FROM_PATH] <TO_PATH>`.
+  Write a file from `FROM_PATH` (`stdin` if not supplied) to `TO_PATH`.

docs/en/operations/utilities/index.md

@@ -13,4 +13,6 @@ pagination_next: 'en/operations/utilities/clickhouse-copier'
 - [clickhouse-format](../../operations/utilities/clickhouse-format.md) — Enables formatting input queries.
 - [ClickHouse obfuscator](../../operations/utilities/clickhouse-obfuscator.md) — Obfuscates data.
 - [ClickHouse compressor](../../operations/utilities/clickhouse-compressor.md) — Compresses and decompresses data.
+- [clickhouse-disks](../../operations/utilities/clickhouse-disks.md) -- Provides filesystem-like operations
+ on files among different ClickHouse disks.
 - [clickhouse-odbc-bridge](../../operations/utilities/odbc-bridge.md) — A proxy server for ODBC driver.

programs/disks/CommandCopy.cpp

@@ -17,13 +17,11 @@ public:
     {
         command_name = "copy";
         command_option_description.emplace(createOptionsDescription("Allowed options", getTerminalWidth()));
-        description = "Recursively copy data containing at `from_path` to `to_path`\nPath should be in format './' or './path' or 'path'";
+        description = "Recursively copy data from `FROM_PATH` to `TO_PATH`";
         usage = "copy [OPTION]... <FROM_PATH> <TO_PATH>";
         command_option_description->add_options()
-            ("diskFrom", po::value<String>(), "set name for disk from which we do operations")
-            ("diskTo", po::value<String>(), "set name for disk to which we do operations")
-            ;
-
+            ("diskFrom", po::value<String>(), "disk from which we copy")
+            ("diskTo", po::value<String>(), "disk to which we copy");
     }
 
     void processOptions(

programs/disks/CommandLink.cpp

@@ -15,7 +15,7 @@ public:
     CommandLink()
     {
         command_name = "link";
-        description = "Create hardlink from `from_path` to `to_path`\nPath should be in format './' or './path' or 'path'";
+        description = "Create hardlink from `from_path` to `to_path`";
         usage = "link [OPTION]... <FROM_PATH> <TO_PATH>";
     }
 

programs/disks/CommandList.cpp

@@ -17,11 +17,10 @@ public:
     {
         command_name = "list";
         command_option_description.emplace(createOptionsDescription("Allowed options", getTerminalWidth()));
-        description = "List files (the default disk is used by default)\nPath should be in format './' or './path' or 'path'";
+        description = "List files at path[s]";
         usage = "list [OPTION]... <PATH>...";
         command_option_description->add_options()
-            ("recursive", "recursively list all directories")
-            ;
+            ("recursive", "recursively list all directories");
     }
 
     void processOptions(

programs/disks/CommandMkDir.cpp

@@ -18,11 +18,10 @@ public:
     {
         command_name = "mkdir";
         command_option_description.emplace(createOptionsDescription("Allowed options", getTerminalWidth()));
-        description = "Create directory or directories recursively";
+        description = "Create a directory";
         usage = "mkdir [OPTION]... <PATH>";
         command_option_description->add_options()
-            ("recursive", "recursively create directories")
-            ;
+            ("recursive", "recursively create directories");
     }
 
     void processOptions(

programs/disks/CommandMove.cpp

@@ -15,7 +15,7 @@ public:
     CommandMove()
     {
         command_name = "move";
-        description = "Move file or directory from `from_path` to `to_path`\nPath should be in format './' or './path' or 'path'";
+        description = "Move file or directory from `from_path` to `to_path`";
         usage = "move [OPTION]... <FROM_PATH> <TO_PATH>";
     }
 

programs/disks/CommandRead.cpp

@@ -20,11 +20,10 @@ public:
     {
         command_name = "read";
         command_option_description.emplace(createOptionsDescription("Allowed options", getTerminalWidth()));
-        description = "read File `from_path` to `to_path` or to stdout\nPath should be in format './' or './path' or 'path'";
-        usage = "read [OPTION]... <FROM_PATH> <TO_PATH>\nor\nread [OPTION]... <FROM_PATH>";
+        description = "Read a file from `FROM_PATH` to `TO_PATH`";
+        usage = "read [OPTION]... <FROM_PATH> [<TO_PATH>]";
         command_option_description->add_options()
-            ("output", po::value<String>(), "set path to file to which we are read")
-            ;
+            ("output", po::value<String>(), "file to which we are reading, defaults to `stdout`");
     }
 
     void processOptions(

programs/disks/CommandWrite.cpp

@@ -21,11 +21,10 @@ public:
     {
         command_name = "write";
         command_option_description.emplace(createOptionsDescription("Allowed options", getTerminalWidth()));
-        description = "Write File `from_path` or stdin to `to_path`";
-        usage = "write [OPTION]... <FROM_PATH> <TO_PATH>\nor\nstdin | write [OPTION]... <TO_PATH>\nPath should be in format './' or './path' or 'path'";
+        description = "Write a file from `FROM_PATH` to `TO_PATH`";
+        usage = "write [OPTION]... [<FROM_PATH>] <TO_PATH>";
         command_option_description->add_options()
-            ("input", po::value<String>(), "set path to file to which we are write")
-            ;
+            ("input", po::value<String>(), "file from which we are reading, defaults to `stdin`");
     }
 
     void processOptions(