Add documentation for new features in interactive client

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

@@ -4,35 +4,53 @@ sidebar_position: 59
 sidebar_label: clickhouse-disks
 ---
 
-# clickhouse-disks
+# Clickhouse-disks
 
-A utility providing filesystem-like operations for ClickHouse disks.
+A utility providing filesystem-like operations for ClickHouse disks. It can work in both interactive and not interactive modes.
 
-Program-wide options:
+## 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`.
+* `--query, -q` -- single query that can be executed without launching interactive mode
+
+## Default Disks
+After the launch two disks are initialized. The first one is a disk `local` that is supposed to imitate local file system from which clickhouse-disks utility was launched. The second one is a disk `default` that is mounted to the local filesystem in the directory that can be found in config as a parameter `clickhouse/path` (default value is `/var/lib/clickhouse`).
+
+## Clickhouse-disks state
+For each disk that was added the utility stores current directory (as in a usual filesystem). User can change current directory and switch between disks.
+
+State is reflected in a prompt "`disk_name`:`path_name`" 
 
 ## Commands
 
-* `copy [--disk-from d1] [--disk-to 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`.
+In these documentation file all mandatory positional arguments are referred as `<parameter>`, named arguments are referred as `[--parameter value]`. All positional parameters could be mentioned as a named parameter with a corresponding name.
+
+* `cd (change-dir, change_dir) [--disk disk] <path>`
+  Change directory to path `path` on disk `disk` (default value is a current disk). No disk switching happens.
+* `copy (cp) [--disk-from disk_1] [--disk-to disk_2] <path-from> <path-to>`.
+  Recursively copy data from `path-from` at disk `disk_1` (default value is a current disk (parameter `disk` in a non-interactive mode))
+  to `path-to` at disk `disk_2` (default value is a current disk (parameter `disk` in a non-interactive mode)).
+* `current_disk_with_path (current, current_disk, current_path)`
+  Print current state in format: 
+    `Disk: "current_disk" Path: "current path on current disk"`
+* `move (mv) <path-from> <path-to>`.
+  Move file or directory from `path-from` to `path-to` within current disk.
+* `remove (rm, delete) <path>`.
+  Remove `path` recursively on a current disk.
+* `link (ln) <path-from> <path-to>`.
+  Create a hardlink from `path-from` to `path-to` on a current disk.
+* `list (ls) [--recursive] <path>`
+  List files at `path`s on a current disk. Non-recursive by default.
+* `list-disks (list_disks, ls-disks, ls_disks)`.
   List disks names.
-* `mkdir [--recursive] <PATH>`.
+* `mkdir [--recursive] <path>` on a current disk.
   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`.
+* `read (r) <path-from> [--path-to path]`
+  Read a file from `path-from` to `path` (`stdout` if not supplied).
+* `switch-disk [--path path] <disk>`
+  Switch to disk `disk` on path `path` (if `path` is not specified default value is a previous path on disk `disk`). 
+* `write (w) [--path-from path] <path-to>`.
+  Write a file from `path` (`stdin` if not supplied) to `path-to`.

programs/disks/CommandCopy.cpp

@@ -12,11 +12,12 @@ public:
     explicit CommandCopy() : ICommand()
     {
         command_name = "copy";
-        description = "Recursively copy data from `FROM_PATH` to `TO_PATH`";
-        options_description.add_options()("disk-from", po::value<String>(), "disk from which we copy")(
-            "disk-to", po::value<String>(), "disk to which we copy")(
-            "path-from", po::value<String>(), "path from which we copy (mandatory, positional)")(
-            "path-to", po::value<String>(), "path to which we copy (mandatory, positional)");
+        description = "Recursively copy data from `path-from` to `path-to`";
+        options_description.add_options()(
+            "disk-from", po::value<String>(), "disk from which we copy is executed (default value is a current disk)")(
+            "disk-to", po::value<String>(), "disk to which copy is executed (default value is a current disk)")(
+            "path-from", po::value<String>(), "path from which copy is executed (mandatory, positional)")(
+            "path-to", po::value<String>(), "path to which copy is executed (mandatory, positional)");
         positional_options_description.add("path-from", 1);
         positional_options_description.add("path-to", 1);
     }

programs/disks/CommandMove.cpp

@@ -12,14 +12,14 @@ public:
         command_name = "move";
         description = "Move file or directory from `from_path` to `to_path`";
         options_description.add_options()("path-from", po::value<String>(), "path from which we copy (mandatory, positional)")(
-            "path-to", po::value<String>(), "path to which we copy (mandatory, positional)");
+            "path-to", po::value<String>(), "path to which we copy (mandatory, positional)")s;
         positional_options_description.add("path-from", 1);
         positional_options_description.add("path-to", 1);
     }
 
     void executeImpl(const CommandLineOptions & options, DisksClient & client) override
     {
-        auto disk = client.getCurrentDiskWithPath();
+        auto disk = getDiskWithPath(client, options, "disk");
 
         String path_from = disk.getRelativeFromRoot(getValueFromCommandLineOptionsThrow<String>(options, "path-from"));
         String path_to = disk.getRelativeFromRoot(getValueFromCommandLineOptionsThrow<String>(options, "path-to"));

programs/disks/CommandRemove.cpp

@@ -17,7 +17,7 @@ public:
 
     void executeImpl(const CommandLineOptions & options, DisksClient & client) override
     {
-        auto disk = client.getCurrentDiskWithPath();
+        auto disk = getDiskWithPath(client, options, "disk");
         const String & path = disk.getRelativeFromRoot(getValueFromCommandLineOptionsThrow<String>(options, "path"));
         disk.getDisk()->removeRecursive(path);
     }

programs/disks/DisksApp.cpp

@@ -280,7 +280,7 @@ void DisksApp::addOptions()
     options_description.add_options()("help,h", "Print common help message")("config-file,C", po::value<String>(), "Set config file")(
         "disk", po::value<String>(), "Set disk name")("save-logs", "Save logs to a file")(
         "log-level", po::value<String>(), "Logging level")("query,q", po::value<String>(), "Query for a non-interactive mode")(
-        "test-mode", "Interface in test regyme");
+        "test-mode", "Interactive interface in test regyme");
 
     command_descriptions.emplace("list-disks", makeCommandListDisks());
     command_descriptions.emplace("copy", makeCommandCopy());