diff options
| author | bazeltsev <[email protected]> | 2023-03-21 11:10:33 +0300 |
|---|---|---|
| committer | bazeltsev <[email protected]> | 2023-03-21 11:10:33 +0300 |
| commit | fdb6efd6d67e871c970a7b684d37fd3f1872be35 (patch) | |
| tree | d99e85a6992d3b96e3891e3b59c995310675d858 | |
| parent | ad134e1da3c964b3a65a5b2a1d69fb2bda314aaa (diff) | |
Add ydb cli features to docs
updated
5 files changed, 12 insertions, 10 deletions
diff --git a/ydb/docs/ru/core/reference/ydb-cli/_includes/connect.md b/ydb/docs/ru/core/reference/ydb-cli/_includes/connect.md index bec65700fab..1fc6f2d6e40 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/_includes/connect.md +++ b/ydb/docs/ru/core/reference/ydb-cli/_includes/connect.md @@ -62,8 +62,6 @@ - `--ca-file <filepath>` : Файл корневого PEM-сертификата для TLS-соединения -В настоящее время корневой сертификат не сохраняется в профиле, и может быть определен только опцией командной строки. - ## Проверка аутентификации {#whoami} Сервисная команда {{ ydb-short-name }} CLI [`discovery whoami`](../commands/discovery-whoami.md) позволяет проверить, под какой учетной записью вы фактически аутентифицировались на сервере. diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/global-options.md b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/global-options.md index 84ca039e3ad..2c6fcecf424 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/global-options.md +++ b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/global-options.md @@ -6,5 +6,6 @@ ## Сервисные опции {#service-options} -- `--profile <name>` : Указывает на использование профиля соединения с БД с заданным именем при выполнении какой-либо команды {{ ydb-short-name }} CLI. В профиле может быть сохранено большинство параметров соединения. -- `-v, --verbose` : Вывод детальной информации обо всех выполняемых операциях. Указание данной опции полезно для локализации проблем при соединении с БД. +* `--profile <name>` — указывает на использование профиля соединения с БД с заданным именем при выполнении какой-либо команды {{ ydb-short-name }} CLI. В профиле может быть сохранено большинство параметров соединения. +* `-v, --verbose` — вывод детальной информации обо всех выполняемых операциях. Указание данной опции полезно для локализации проблем при соединении с БД. +* `--profile-file` — использовать профили из указанного файла. По умолчанию используются профили из файла `~/.ydb/config/config.yaml`. diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/scheme-ls.md b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/scheme-ls.md index 23a5415288a..36afc7ad4ae 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/scheme-ls.md +++ b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/scheme-ls.md @@ -3,7 +3,7 @@ Команда `scheme ls` позволяет получить список объектов в базе данных: ```bash -{{ ydb-cli }} [connection options] scheme ls [path] [-lR] +{{ ydb-cli }} [connection options] scheme ls [path] [-lR1] ``` {% include [conn_options_ref.md](conn_options_ref.md) %} @@ -13,8 +13,10 @@ Параметром `path` можно задать [директорию](../dir.md), для которой нужно вывести перечень объектов. Для команды доступны следующие опции: -- `-l` : Полная информация об атрибутах каждого объекта -- `-R` : Рекурсивный обход всех поддиректорий + +* `-l` — полная информация об атрибутах каждого объекта; +* `-R` — рекурсивный обход всех поддиректорий; +* `-1` — выводить по одному объекту схемы на строку (например, для последующей обработки в скрипте). **Примеры** diff --git a/ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/import-file.md b/ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/import-file.md index 1235449d3ae..078e951e4ec 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/import-file.md +++ b/ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/import-file.md @@ -11,7 +11,7 @@ Общий вид команды: ```bash -{{ ydb-cli }} [connection options] import file csv|tsv [options] +{{ ydb-cli }} [connection options] import file csv|json|parquet|tsv [options] ``` {% include [conn_options_ref.md](../../commands/_includes/conn_options_ref.md) %} diff --git a/ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/s3_conn.md b/ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/s3_conn.md index dca708b73c1..2163e5b43c7 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/s3_conn.md +++ b/ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/s3_conn.md @@ -25,8 +25,9 @@ YDB CLI определяет значения этих параметров из ### Параметры командной строки -`--access-key STR`: Идентификатор ключа доступа -`--secret-key STR`: Секретный ключ доступа +* `--access-key` — идентификатор ключа доступа. +* `--secret-key` — секретный ключ доступа. +* `--aws-profile` — имя профиля в файле `~/.aws/credentials`. Порядок поиска профиля: указанный файл, переменная окружения `AWS_PROFILE`. Значение по умолчанию `default`. ### Переменные окружения |
