Add ydb changelog

updated

util/generic/string.h

@@ -1,5 +1,6 @@
 #pragma once
 
+#include <algorithm>
 #include <cstddef>
 #include <cstring>
 #include <stlfwd>

util/thread/lfqueue.h

@@ -22,7 +22,7 @@ struct TDefaultLFCounter {
 // @brief lockfree queue
 // @tparam T - the queue element, should be movable
 // @tparam TCounter, a observer class to count number of items in queue
-//                   be carifull, IncCount and DecCount can be called on a moved object and
+//                   be careful, IncCount and DecCount can be called on a moved object and
 //                   it is TCounter class responsibility to check validity of passed object
 template <class T, class TCounter>
 class TLockFreeQueue: public TNonCopyable {

ydb/docs/ru/core/changelog.md

@@ -0,0 +1,8 @@
+# История изменений
+
+## 25.06.2022 {#25-06-2022}
+
+{{ ydb-short-name }} CLI 1.9.1:
+
+* Добавлена возможность сжатия данных при экспорте в S3-совместимое хранилище (см. параметр `--compression` команды [ydb export s3](reference/ydb-cli/export_import/s3_export.md)).
+* Добавлена возможность управления автоматической проверкой доступности новой версии {{ ydb-short-name }} CLI (см. параметры `--disable-checks` и `--enable-checks` команды [ydb version](reference/ydb-cli/version.md)).

ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/s3_export.md

@@ -26,11 +26,12 @@
 
 ### Дополнительные параметры {#aux}
 
-`--description STRING`: Текстовое описание операции, сохраняемое в истории операций
-`--retries NUM`: Количество повторных попыток выгрузки, которые будет предпринимать сервер. По умолчанию 10.
-`--format STRING`: Формат вывода результата
-- `pretty`: Человекочитаемый формат (по умолчанию)
-- `proto-json-base64`: Protobuf в формате json, бинарные строки закодированы в base64
+Параметр | Описание
+--- | ---
+`--description STRING` | Текстовое описание операции, сохраняемое в истории операций.
+`--retries NUM` | Количество повторных попыток выгрузки, которые будет предпринимать сервер.</br>Значение по умолчанию: `10`.
+`--compression STRING` | Сжимать выгружаемые данные.</br>При уровне сжатия по умолчанию для алгоритма [Zstandard](https://ru.wikipedia.org/wiki/Zstandard) данные могут быть сжаты в 5-10 раз. Сжатие данных использует ресурс CPU и может повлиять на скорость выполнения других операций с БД.</br>Допустимые значения:</br><ul><li>`zstd` — сжатие алгоритмом Zstandard c уровнем сжатия по умолчанию (`3`);</li><li>`zstd-N` — сжатие алгоритмом Zstandard, `N` — уровень сжатия (`1` — `22`).</li></ul>
+`--format STRING` | Формат вывода результата.</br>Допустимые значения:</br><ul><li>`pretty` — человекопонятный формат (по умолчанию);</li><li>`proto-json-base64` — [Protocol Buffers](https://ru.wikipedia.org/wiki/Protocol_Buffers) в формате [JSON](https://ru.wikipedia.org/wiki/JSON), бинарные строки закодированы в [Base64](https://ru.wikipedia.org/wiki/Base64).</li></ul>
 
 ## Выполнение выгрузки {#exec}
 

ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml

@@ -49,6 +49,8 @@ items:
       href: commands/discovery-list.md
     - name: Проверка аутентификации
       href: commands/discovery-whoami.md
+    - name: Вывод версии YDB CLI
+      href: version.md
   - name: Нагрузочное тестирование
     items:
     - name: Обзор

ydb/docs/ru/core/reference/ydb-cli/version.md

@@ -0,0 +1,59 @@
+# Вывод версии {{ ydb-short-name }} CLI
+
+С помощью подкоманды `version` вы можете узнать версию установленного {{ ydb-short-name }} CLI, а также управлять автоматической проверкой доступности новой версии.
+
+Автоматическая проверка доступности новой версии происходит при выполнении любой команды {{ ydb-short-name }} CLI кроме `ydb version --enable-checks` и `ydb version --disable-checks`, но не чаще одного раза в сутки. Результат и время последней проверки сохраняются в конфигурационном файле {{ ydb-short-name }} CLI.
+
+Общий вид команды:
+
+```bash
+{{ ydb-cli }} [global options...] version [options...]
+```
+
+* `global options` — [глобальные параметры](commands/global-options.md).
+* `options` — [параметры подкоманды](#options).
+
+Посмотрите описание команды:
+
+```bash
+{{ ydb-cli }} version --help
+```
+
+## Параметры подкоманды {#options}
+
+Параметр | Описание
+---|---
+`--semantic` | Вывести только номер версии.
+`--check` | Проверить доступность новой версии.
+`--disable-checks` | Отключить проверку доступности новой версии.
+`--enable-checks` | Включить проверку доступности новой версии.
+
+## Примеры {#examples}
+
+### Отключить проверку доступности новой версии {#disable-checks}
+
+При выполнении команд {{ ydb-short-name }} CLI происходит автоматическая проверка доступности новой версии. Если хост, на котором выполняется команда, не имеет доступа в интернет, это приводит к нежелательной задержке и выводу предупреждения при выполнении команды. Чтобы отключить автоматическую проверку обновления, выполните команду:
+
+```bash
+{{ ydb-cli }} version --disable-checks
+```
+
+Результат:
+
+```text
+Latest version checks disabled
+```
+
+### Вывести только номер версии {#semantic}
+
+Для более удобной обработки в скриптах вы можете ограничить вывод номером версии {{ ydb-short-name }} CLI:
+
+```bash
+{{ ydb-cli }} version --semantic
+```
+
+Результат:
+
+```text
+1.9.1
+```

ydb/docs/ru/core/toc_i.yaml

@@ -27,3 +27,6 @@ items:
 - include: { mode: link, path: downloads/toc_p.yaml }
 - name: Публичные материалы
   href: public-talks.md
+- name: История изменений
+  href: changelog.md
+