-
Notifications
You must be signed in to change notification settings - Fork 610
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add release notes for YDB CLI 2.19.0 #14164
Conversation
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
⚪ Test history | Ya make output | Test bloat
🟢 |
ydb/docs/en/core/changelog-cli.md
Outdated
* Added [views](./concepts/datamodel/view) support in `ydb export s3` and `ydb import s3`. Views are exported as `CREATE VIEW` YQL statements which are executed on import. | ||
* Added [changefeeds](./concepts/cdc) support in `ydb tools dump` and `ydb tools restore`. As a result, there are changes in the backup file structure: for tables with changefeeds, a subdirectory is created for each changefeed, named after the changefeed. This subdirectory contains two files: `changefeed_description.pb`, which contains the changefeed description, and `topic_description.pb`, which contains information about the underlying topic. | ||
* Added `CREATE TABLE` text suggestion on scheme error during `ydb import file csv`. | ||
* Added `--skip-checksum-validation` option to `ydb import s3` command to skip server-side checksum validation. | ||
* Added statistics output on the current progress of the query in `ydb workload` command. | ||
* Added query text to error message if a query fails in `ydb workload run` comamnd. | ||
* Added a message if global timeout expiried in `ydb workload run` comamnd. | ||
* Added new experimental options for `ydb debug ping` command: `--chain-length`, `--chain-work-duration`, `--no-tail-chain`. | ||
* Added some temporary changes to experimental `ydb admin storage` command for internal usage. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Added [views](./concepts/datamodel/view) support in `ydb export s3` and `ydb import s3`. Views are exported as `CREATE VIEW` YQL statements which are executed on import. | |
* Added [changefeeds](./concepts/cdc) support in `ydb tools dump` and `ydb tools restore`. As a result, there are changes in the backup file structure: for tables with changefeeds, a subdirectory is created for each changefeed, named after the changefeed. This subdirectory contains two files: `changefeed_description.pb`, which contains the changefeed description, and `topic_description.pb`, which contains information about the underlying topic. | |
* Added `CREATE TABLE` text suggestion on scheme error during `ydb import file csv`. | |
* Added `--skip-checksum-validation` option to `ydb import s3` command to skip server-side checksum validation. | |
* Added statistics output on the current progress of the query in `ydb workload` command. | |
* Added query text to error message if a query fails in `ydb workload run` comamnd. | |
* Added a message if global timeout expiried in `ydb workload run` comamnd. | |
* Added new experimental options for `ydb debug ping` command: `--chain-length`, `--chain-work-duration`, `--no-tail-chain`. | |
* Added some temporary changes to experimental `ydb admin storage` command for internal usage. | |
* Added [views](./concepts/datamodel/view.md) support in `ydb export s3` and `ydb import s3`. Views are exported as `CREATE VIEW` YQL statements, which are executed on import. | |
* Added [changefeeds](./concepts/cdc.md) support in `ydb tools dump` and `ydb tools restore`. As a result, there are changes in the backup file structure: for tables with changefeeds, a subdirectory is created for each changefeed, named after the changefeed. This subdirectory contains two files: `changefeed_description.pb`, which contains the changefeed description, and `topic_description.pb`, which contains information about the underlying topic. | |
* Added `CREATE TABLE` text suggestion on schema error during `ydb import file csv`. | |
* Added the `--skip-checksum-validation` option to the `ydb import s3` command to skip server-side checksum validation. | |
* Added statistics output on the current progress of the query in the `ydb workload` command. | |
* Added query text to the error message if a query fails in the `ydb workload run` command. | |
* Added a message if the global timeout expired in the `ydb workload run` command. | |
* Added new experimental options for the `ydb debug ping` command: `--chain-length`, `--chain-work-duration`, `--no-tail-chain`. | |
### Backward incompatible changes | |
* Added some temporary changes to the experimental `ydb admin storage`. |
ydb/docs/en/core/changelog-cli.md
Outdated
* Fixed a bug where arm64 YDB CLI binary was downloading amd64 binary to replace itself during `ydb update`. To update already installed binaries to the latest arm64 version, YDB CLI should be re-installed. | ||
* Fixed return code of `ydb workload run` comamnd. | ||
* Fixed a bug where `ydb workload tpch import generator` and `ydb workload tpcds import generator` commands were failing due to not all tables had been created | ||
* Fixed a bug with backslashes in `ydb workload` benchmark paths on Windows |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Fixed a bug where arm64 YDB CLI binary was downloading amd64 binary to replace itself during `ydb update`. To update already installed binaries to the latest arm64 version, YDB CLI should be re-installed. | |
* Fixed return code of `ydb workload run` comamnd. | |
* Fixed a bug where `ydb workload tpch import generator` and `ydb workload tpcds import generator` commands were failing due to not all tables had been created | |
* Fixed a bug with backslashes in `ydb workload` benchmark paths on Windows | |
* Fixed a bug where the arm64 {{ ydb-short-name }} CLI binary was downloading the amd64 binary to replace itself during `ydb update`. To update already installed binaries to the latest arm64 version, {{ ydb-short-name }} CLI should be reinstalled. | |
* Fixed the return code of the `ydb workload run` command. | |
* Fixed a bug where the `ydb workload tpch import generator` and `ydb workload tpcds import generator` commands were failing because not all tables had been created. | |
* Fixed a bug with backslashes in `ydb workload` benchmark paths on Windows. |
ydb/docs/ru/core/changelog-cli.md
Outdated
* Добавлена поддержка [представлений (VIEW)](./concepts/datamodel/view) при выполнении операций `ydb export s3` и `ydb import s3`. Представления экспортируются как YQL-выражение `CREATE VIEW`, которое выполняется при импорта. | ||
* Добавлена поддержка [потоков изменений (changefeeds)](./concepts/cdc) при выполнении команд `ydb tools dump` и `ydb tools restore`. Как результат, появились изменения в файле бэкапа: Для таблиц с потоками изменений создаётся по одноимённой директории на каждый поток изменений. Каждая такая директория содержит два файла: `changefeed_description.pb` содержит описание потока изменений, `topic_description.pb` содержит информацию о связанном топике. | ||
* Добавлена рекомендация с текстом `CREATE TABLE` при схемной ошибке во время выполнения `ydb import file csv`. | ||
* Добавлена опция `--skip-checksum-validation` для команды `ydb import s3`, позволяющая отключить валидацию checksum на стороне сервера. | ||
* Добавлен вывод статистики для текущего процесса при выполнении команды `ydb workload`. | ||
* Добавлен текст запроса к сообщению, если запрос завершился ошибкой при выполнении команды `ydb workload run`. | ||
* Добавлено сообщение в случае ошибки истечения глобального таймаута при выполнении команды `ydb workload run`. | ||
* Добавлены новые экспериментальные опции `--chain-length`, `--chain-work-duration`, `--no-tail-chain` для команды `ydb debug ping`. | ||
* Добавлены временные изменения в экспериментальной команде `ydb admin storage` для внутреннего использования. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Добавлена поддержка [представлений (VIEW)](./concepts/datamodel/view) при выполнении операций `ydb export s3` и `ydb import s3`. Представления экспортируются как YQL-выражение `CREATE VIEW`, которое выполняется при импорта. | |
* Добавлена поддержка [потоков изменений (changefeeds)](./concepts/cdc) при выполнении команд `ydb tools dump` и `ydb tools restore`. Как результат, появились изменения в файле бэкапа: Для таблиц с потоками изменений создаётся по одноимённой директории на каждый поток изменений. Каждая такая директория содержит два файла: `changefeed_description.pb` содержит описание потока изменений, `topic_description.pb` содержит информацию о связанном топике. | |
* Добавлена рекомендация с текстом `CREATE TABLE` при схемной ошибке во время выполнения `ydb import file csv`. | |
* Добавлена опция `--skip-checksum-validation` для команды `ydb import s3`, позволяющая отключить валидацию checksum на стороне сервера. | |
* Добавлен вывод статистики для текущего процесса при выполнении команды `ydb workload`. | |
* Добавлен текст запроса к сообщению, если запрос завершился ошибкой при выполнении команды `ydb workload run`. | |
* Добавлено сообщение в случае ошибки истечения глобального таймаута при выполнении команды `ydb workload run`. | |
* Добавлены новые экспериментальные опции `--chain-length`, `--chain-work-duration`, `--no-tail-chain` для команды `ydb debug ping`. | |
* Добавлены временные изменения в экспериментальной команде `ydb admin storage` для внутреннего использования. | |
* Добавлена поддержка [представлений (VIEW)](./concepts/datamodel/view.md) при выполнении операций `ydb export s3` и `ydb import s3`. Представления экспортируются как YQL-выражение `CREATE VIEW`, которое выполняется при импорте. | |
* Добавлена поддержка [потоков изменений (changefeeds)](./concepts/cdc.md) при выполнении команд `ydb tools dump` и `ydb tools restore`. В результате появились изменения в файле бэкапа: для таблиц с потоками изменений создаётся одноимённая директория на каждый поток изменений. Каждая такая директория содержит два файла: `changefeed_description.pb` с описанием потока изменений и `topic_description.pb` с информацией о связанном топике. | |
* Добавлена рекомендация с текстом `CREATE TABLE` при схемной ошибке во время выполнения `ydb import file csv`. | |
* Добавлена опция `--skip-checksum-validation` для команды `ydb import s3`, позволяющая отключить валидацию контрольной суммы на стороне сервера. | |
* Добавлен вывод статистики для текущего процесса при выполнении команды `ydb workload`. | |
* Добавлен текст запроса к сообщению, если запрос завершился ошибкой при выполнении команды `ydb workload run`. | |
* Добавлено сообщение в случае ошибки истечения глобального таймаута при выполнении команды `ydb workload run`. | |
* Добавлены новые экспериментальные опции `--chain-length`, `--chain-work-duration`, `--no-tail-chain` для команды `ydb debug ping`. | |
### Изменения с потерей обратной совместимости | |
* Внесены временные изменения в экспериментальной команде `ydb admin storage`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Изменений с потерей обратной совместимости сейчас нет. Но команда ydb admin storage
, которая сейчас уже существует и для которой в этой версии добавлено несколько опций, будет в будущем изменена на ydb config
. Вот только тогда будут изменения с потерей обратной совместимости. А пока это "какие-то внутренние изменения". Там много опций и они специфичные, для внутреннего использования
ydb/docs/en/core/changelog-cli.md
Outdated
* Added query text to error message if a query fails in `ydb workload run` comamnd. | ||
* Added a message if global timeout expiried in `ydb workload run` comamnd. | ||
* Added new experimental options for `ydb debug ping` command: `--chain-length`, `--chain-work-duration`, `--no-tail-chain`. | ||
* Added some temporary changes to experimental `ydb admin storage` command for internal usage. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's explain what exactly changed, otherwise it sounds weird.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a bunch of very specific options that shouldn't be described here. On the other hand, the changes were made and the ydb admin storage
is available and has new options. The point of this message is "Yes, there were some changes. This is a command for internal usage and you shouldn't try using it". We could skip mentioning it but I insisted that this message is better than nothing
ydb/docs/en/core/changelog-cli.md
Outdated
* Added [views](./concepts/datamodel/view) support in `ydb export s3` and `ydb import s3`. Views are exported as `CREATE VIEW` YQL statements which are executed on import. | ||
* Added [changefeeds](./concepts/cdc) support in `ydb tools dump` and `ydb tools restore`. As a result, there are changes in the backup file structure: for tables with changefeeds, a subdirectory is created for each changefeed, named after the changefeed. This subdirectory contains two files: `changefeed_description.pb`, which contains the changefeed description, and `topic_description.pb`, which contains information about the underlying topic. | ||
* Added `CREATE TABLE` text suggestion on scheme error during `ydb import file csv`. | ||
* Added `--skip-checksum-validation` option to `ydb import s3` command to skip server-side checksum validation. | ||
* Added statistics output on the current progress of the query in `ydb workload` command. | ||
* Added query text to error message if a query fails in `ydb workload run` comamnd. | ||
* Added a message if global timeout expiried in `ydb workload run` comamnd. | ||
* Added new experimental options for `ydb debug ping` command: `--chain-length`, `--chain-work-duration`, `--no-tail-chain`. | ||
* Added some temporary changes to experimental `ydb admin storage` command for internal usage. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add links to documentation on each of these.
ydb/docs/ru/core/changelog-cli.md
Outdated
* Исправлена ошибка, из-за которой команда `ydb update` на arm64-версии исполняемого файла YDB CLI скачивала и заменяла себя имполняемым файлом amd64-версии. Чтобы обновить ранее установленный YDB CLI до последней arm64-версии (а не amd64), его нужно переустановить. | ||
* Команда `ydb workload run` теперь возвращает корректный код возврата. | ||
* Исправлена ошибка, при которой команды `ydb workload tpch import generator` and `ydb workload tpcds import generator` завершались ошибкой из-за отсутствия необходимых таблиц в схеме. | ||
* Исправлена ошибка с обратными слешами при указании путей в команде `ydb workload` на Windows |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Исправлена ошибка, из-за которой команда `ydb update` на arm64-версии исполняемого файла YDB CLI скачивала и заменяла себя имполняемым файлом amd64-версии. Чтобы обновить ранее установленный YDB CLI до последней arm64-версии (а не amd64), его нужно переустановить. | |
* Команда `ydb workload run` теперь возвращает корректный код возврата. | |
* Исправлена ошибка, при которой команды `ydb workload tpch import generator` and `ydb workload tpcds import generator` завершались ошибкой из-за отсутствия необходимых таблиц в схеме. | |
* Исправлена ошибка с обратными слешами при указании путей в команде `ydb workload` на Windows | |
* Исправлена ошибка, из-за которой команда `ydb update` в arm64-версии исполняемого файла YDB CLI скачивала и заменяла себя исполняемым файлом amd64-версии. Чтобы обновить ранее установленный YDB CLI до последней arm64-версии (а не amd64), его нужно переустановить. | |
* Команда `ydb workload run` теперь возвращает корректный код возврата. | |
* Исправлена ошибка, из-за которой команды `ydb workload tpch import generator` и `ydb workload tpcds import generator` завершались с ошибкой из-за отсутствия необходимых таблиц в схеме. | |
* Исправлена ошибка с обратными слешами при указании путей в команде `ydb workload` на Windows. |
ydb/docs/en/core/changelog-cli.md
Outdated
* Added statistics output on the current progress of the query in `ydb workload` command. | ||
* Added query text to error message if a query fails in `ydb workload run` comamnd. | ||
* Added a message if global timeout expiried in `ydb workload run` comamnd. | ||
* Added new experimental options for `ydb debug ping` command: `--chain-length`, `--chain-work-duration`, `--no-tail-chain`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
В прошлый раз мы не публиковали ydb debug ping, потому что она требовала релиза сервера 25.1. Надо уточнить у автора, может что-то изменилось.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Мы не можем при публикации изменений в CLI следить за тем, доехали ли эти изменения до каких-либо серверных кластеров. Мое мнение: изменение в CLI сделано в такой-то версии CLI, значит оно должно быть отражено в этой версии. Поддержка определённых фичей сервером должна отражаться в release notes сервера
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Я против того, чтобы писать про изменения, которые у большинства пользователей после апдейта кли на новую версию работать не будут. Пожалуйста, давай пока уберем и подумаем над решением, которое всех устроит.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Проблема:
В момент релиза YDB CLI, если новая команда/опция использует новую фичу на сервере, мы не знаем, в какой версии сервера эта фича будет добавлена. И вообще, будет ли она добавлена в принципе.
Как следствие, в общем случае мы не можем писать, в какой версии сервера будет добавлена поддержка этой фичи.
Более того, эта серверная фича, вероятно, уже есть в транке. И пользователи с local_ydb уже могут ей пользоваться.
Одно из предлагаемых решений: не писать про такие фичи сразу, а добавлять их в CLI release notes только после появления фичи на сервере. Тут много вопросов и рисков. Кластеров много, на каждом - своя версия. Всем не угодишь. Плюс есть высокая вероятность забыть вообще отразить это изменение в release notes.
Лично мне кажется, что появление фичи в определённой версии CLI должно быть сразу отражено в release notes к этой версии. Версия CLI уже выпущена и уже умеет работать с этой фичей. Если для неё требуется поддержка на сервере, предлагаю писать "Это новая функциональность, требуется поддержка на стороне сервера"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Договорились писать в релиз ноуты и help про команду с пометкой, что ждет релиза 25.1.
❌ Documentation buildRevision build failed Build logsErrors (2)❌ Link is unreachable: ./reference/ydb-cli/commands/workload.md in /en/changelog-cli.md ❌ Link is unreachable: ./reference/ydb-cli/commands/workload.md in /ru/changelog-cli.md |
69bd877
to
104d3eb
Compare
❌ Documentation buildRevision build failed Build logsErrors (2)❌ Link is unreachable: ./reference/ydb-cli/commands/workload.md in /en/changelog-cli.md ❌ Link is unreachable: ./reference/ydb-cli/commands/workload.md in /ru/changelog-cli.md |
⚪ |
⚪ |
⚪ Test history | Ya make output | Test bloat
🟢 |
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
✅ Documentation buildRevision built successfully |
⚪ Test history | Ya make output | Test bloat
🟢 |
⚪ Test history | Ya make output | Test bloat
🟢 |
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
⚪ Test history | Ya make output | Test bloat
🟢 |
⚪ Test history | Ya make output | Test bloat
🟢 |
⚪ Test history | Ya make output | Test bloat
🟢 |
⚪ Test history | Ya make output | Test bloat
🟢 |
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
⚪ Test history | Ya make output | Test bloat
🟢 |
⚪ Test history | Ya make output | Test bloat
🟢 |
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
⚪ Test history | Ya make output | Test bloat
🟢 |
Co-authored-by: Ivan Blinkov <ivan@blinkov.ru>
Changelog category