diff options
author | alexv-smirnov <alex@ydb.tech> | 2022-08-31 20:59:50 +0300 |
---|---|---|
committer | alexv-smirnov <alex@ydb.tech> | 2022-08-31 20:59:50 +0300 |
commit | 824aa0bc51a75b892a09253e2edbefe396e997fd (patch) | |
tree | d5c88f5fadfb3c7d6bb5b88563fead3339c3fa1c | |
parent | d34df8ec792a0722c031eca4f55830041ff2d122 (diff) | |
download | ydb-824aa0bc51a75b892a09253e2edbefe396e997fd.tar.gz |
ydb docs profile delete deactivate
-rw-r--r-- | ydb/docs/ru/core/reference/ydb-cli/profile/_includes/activate.md | 28 | ||||
-rw-r--r-- | ydb/docs/ru/core/reference/ydb-cli/profile/_includes/delete.md | 45 |
2 files changed, 47 insertions, 26 deletions
diff --git a/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/activate.md b/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/activate.md index ec09007969..3fe12b4281 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/activate.md +++ b/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/activate.md @@ -10,9 +10,9 @@ - Активированный профиль применяется неявно, а значит, может примениться по ошибке, когда допущена описка в имени переменной окружения. - Активированный профиль нельзя применять в скриптах, так как он сохраняется в файле, и его смена в одном окне терминала повлияет на все другие окна, возможно приведя к неожиданной смене БД посередине исполняемого в скрипте цикла. -С момента как вам в первый раз потребуется соединиться с какой-либо новой БД, отличной от начальной, рекомендуется деактивировать профиль и всегда выбирать его явно опцией `--profile`. +С момента как вам в первый раз потребуется соединиться с какой-либо новой БД, отличной от начальной, рекомендуется деактивировать профиль и всегда выбирать его явно опцией `--profile` (`-p`). -## Активация профиля командой {#activate} +## Активация профиля {#activate} Активация профиля выполняется командой @@ -52,7 +52,7 @@ Profile "<profile_name>" was activated. Активация профиля с именем `mydb1`: ```bash -$ {{ ydb-cli }} config profile activate mydb1 +{{ ydb-cli }} config profile activate mydb1 Profile "mydb1" was activated. ``` @@ -64,16 +64,26 @@ Profile "mydb1" was activated. Activate profile "<profile_name>" to use by default? (current active profile is not set) y/n: ``` -Ответьте `y` (Да) чтобы профиль был активирован. +Ответьте `n` (Нет) чтобы не активировать создаваемый профиль, или `y` (Да) чтобы он был активирован. ## Деактивация профиля {#deactivate} -{{ ydb-short-name }} CLI в настоящее время поддерживает деактивацию профиля только в интерактивном режиме при вызове команды активации без указания профиля (выбор пункта `2` в описанной выше [команде активации](#activate)). - -При необходимости вы можете использовать перенаправление ввода операционной системы для автоматического выбора опции `2` в интерактивном вводе: +Деактивация текущего активированного профиля выполняется командой ``` bash -echo 2 | {{ ydb-cli }} config profile activate +{{ ydb-cli }} config profile deactivate +``` + +Если активированный профиль существовал, то выводится сообщение о его успешной деактивации: + +``` text +Profile "profile_name" was deactivated. +``` + +Если активированного профиля не существовало, то выводится сообщение о том что в результате исполнения команды никаких изменений не произведено: + +``` text +There is no profile active. Nothing is done. ``` -Работоспособность данного способа никак не гарантируется. +В любом случае, команда возвращает result code `0`. diff --git a/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/delete.md b/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/delete.md index a57411a262..d4db0a01ae 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/delete.md +++ b/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/delete.md @@ -1,37 +1,48 @@ # Удаление профиля -В настоящее время профиль удаляется только в интерактивном режиме следующей командой: +Удаление профиля производится следующей командой: ``` bash -{{ ydb-cli }} config profile delete <profile_name> +{{ ydb-cli }} config profile delete <profile_name> [-f] ``` -, где `<profile_name>` - имя профиля. +## Параметры {#options} -{{ ydb-short-name }} CLI запросит подтверждение удаления профиля: +`<profile_name>` : Имя профиля. -``` text -Profile "<profile_name>" will be permanently removed. Continue? (y/n): -``` +`--force` (`-f`) : Флаг усиленного режима. Если не указан, то команда будет запрашивать подтверждение удаления в интерактивном режиме, и вернет ошибку в случае если профиль отсутствует. Если указан, то запрос на подтверждение не выдается, и команда завершается успешно даже если профиля с указанным именем не существовало. -Ответьте `y` (Да) чтобы профиль был удален. +## Примеры {#examples} -## Пример {#example} +### Удаление профиля `mydb1` без интерактивного подтверждения -Удаление профиля `mydb1`: +```bash +{{ ydb-cli }} config profile delete mydb1 -f +``` + +Команда исполнится успешно также и в случае, если профиль с именем `mydb1` не существует. + +### Удаление профиля `mydb1` с интерактивным подтверждением ```bash -$ {{ ydb-cli }} config profile delete mydb1 +{{ ydb-cli }} config profile delete mydb1 +``` + +Если профиль не существует, выполнение команды завершится с ошибкой: +``` text +No existing profile "mydb1". Run "ydb config profile list" without arguments to see existing profiles +``` + +Если профиль существует, то выдается интерактивный запрос на подтверждение: +``` text Profile "mydb1" will be permanently removed. Continue? (y/n): y Profile "mydb1" was removed. ``` -## Удаление профиля без интерактивного ввода {#non-interactive} +### Удаление всех профилей -Хотя данный режим не поддерживается {{ ydb-short-name }} CLI, при необходимости вы можете использовать перенаправление ввода операционной системы для автоматического ответа `y` на вопрос подтверждения удаления: +Хотя специальной команды удаления всех профилей нет в YDB CLI, в Linux-совместимых операционных системах вы можете воспользоваться следующим рецептом для удаления всех существующих профилей: ``` bash -echo y | {{ ydb-cli }} config profile delete my_profile -``` - -Работоспособность данного способа никак не гарантируется.
\ No newline at end of file +{{ ydb-cli }} config profile list | while read l;do {{ ydb-cli }} config profile delete $l;done; +```
\ No newline at end of file |