Docs: update description of serial #19443
Conversation
|
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
github-actions
bot
added
documentation
shnikd
force-pushed
the
YDBDOCS-1142-serial
branch
from
4a3ee88 to
8f4234b
Compare
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
❌ Documentation buildRevision build failed Build logsErrors (3)❌ Cannot read properties of undefined (reading 'openCondition') ❌ Link is unreachable: en/reference/ydb-cli/workload-query.md in en/changelog-cli.md. ❌ Link is unreachable: ru/reference/ydb-cli/workload-query.md in ru/changelog-cli.md. Warnings (8) |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
❌ Documentation buildRevision build failed Build logsErrors (2)❌ Link is unreachable: en/reference/ydb-cli/workload-query.md in en/changelog-cli.md. ❌ Link is unreachable: ru/reference/ydb-cli/workload-query.md in ru/changelog-cli.md. |
shnikd
force-pushed
the
YDBDOCS-1142-serial
branch
2 times, most recently
from
30814b1 to
326f594
Compare
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
There was a problem hiding this comment.
Pull Request Overview
This PR enriches the documentation around the new Serial types by expanding descriptions, adding syntax references, and updating navigation entries.
- Expanded
Serialtype docs withSequencebehavior, parameters, and overflow notes - Introduced
ALTER SEQUENCEsyntax reference and linked it in ToC/index files - Enhanced examples to recommend hash-based partitioning and updated CLI guidance for exporting serial columns
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| ydb/docs/ru/core/yql/reference/types/serial.md | Expanded Russian Serial docs with Sequence details and examples |
| ydb/docs/ru/core/yql/reference/syntax/toc_i.yaml | Added ALTER SEQUENCE to Russian syntax ToC |
| ydb/docs/ru/core/yql/reference/syntax/index.md | Exposed ALTER SEQUENCE in Russian syntax index |
| ydb/docs/ru/core/yql/reference/syntax/create_table/index.md | Updated Russian CREATE TABLE type allowance text |
| ydb/docs/ru/core/yql/reference/syntax/alter-sequence.md | New Russian ALTER SEQUENCE syntax reference |
| ydb/docs/en/core/yql/reference/types/toc_i.yaml | Added Serial entry to English types ToC |
| ydb/docs/en/core/yql/reference/types/serial.md | New English Serial type documentation |
| ydb/docs/en/core/yql/reference/types/index.md | Linked Serial in English types index |
| ydb/docs/en/core/yql/reference/syntax/toc_i.yaml | Added ALTER SEQUENCE to English syntax ToC |
| ydb/docs/en/core/yql/reference/syntax/index.md | Exposed ALTER SEQUENCE in English syntax index |
| ydb/docs/en/core/yql/reference/syntax/create_table/index.md | Updated English CREATE TABLE type allowance text |
| ydb/docs/en/core/yql/reference/syntax/alter-sequence.md | New English ALTER SEQUENCE syntax reference |
| ydb/docs/en/core/reference/ydb-cli/export-import/_includes/tools_dump.md | Clarified --avoid-copy impact on serial exports |
Comments suppressed due to low confidence (2)
ydb/docs/en/core/reference/ydb-cli/export-import/_includes/tools_dump.md:54
- [nitpick] Link text
[serial]should match the title casing used elsewhere (Serial). Consider updating link text to[Serial]for consistency.
`--avoid-copy`: Do not create a snapshot before dumping. The default consistency snapshot might be inapplicable in some cases (for example, for tables with external blobs).{% if feature_serial %} For correct export of tables with [serial](../../../../yql/reference/types/serial.md) types, this parameter should not be set. Otherwise, the current value of the sequence generator will not be copied, and new values will start from the initial value, which may lead to primary key conflicts.{% endif %}
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
| RESTART 1000; | ||
| ``` | ||
|
|
||
| An alternative way to achieve the same result is to first change the start value, and then `RESTART` the `Sequence`. After this, subsequent calls to `RESTART` without an explicit value will set the current value to 1000: |
There was a problem hiding this comment.
| An alternative way to achieve the same result is to first change the start value, and then `RESTART` the `Sequence`. After this, subsequent calls to `RESTART` without an explicit value will set the current value to 1000: | |
| An alternative way to achieve the same result is to first change the start value, and then `RESTART` the `Sequence`. After this, subsequent call to `RESTART` without an explicit value will set the current value to 1000: |
There was a problem hiding this comment.
Тут именно все последующие вызовы
| RESTART 1000; | ||
| ``` | ||
|
|
||
| An alternative way to achieve the same result is to first change the start value, and then `RESTART` the `Sequence`. After this, subsequent calls to `RESTART` without an explicit value will set the current value to 1000: |
There was a problem hiding this comment.
нужно пояснение, в каких случаях может быть полезен двухшаговый вариант установки нового стартового значения
There was a problem hiding this comment.
Ну тут в целом и описано, что теперь все последующие вызовы RESTART будут сбрасывать к новому стартовому значению, такой же функционал сейчас в PostgreSql.
| По умолчанию генерируемые значения начинаются с единицы, увеличиваются на один при каждом новом значении и ограничены в соответствии с выбранным типом. | ||
|
|
||
| > **Примечание:** | ||
| > Колонки типа `Serial` поддерживаются как для колонок, входящих в состав первичного ключа, так и для неключевых колонок. |
There was a problem hiding this comment.
надо выбрать - колонки или столбцы в соответствии как сделано в основной доке русской (не уверена) и поправить так всюду по тексту
There was a problem hiding this comment.
В доке сейчас используются и столбцы и колонки
| > **Примечание:** | ||
| > Колонки типа `Serial` поддерживаются как для колонок, входящих в состав первичного ключа, так и для неключевых колонок. | ||
| > | ||
| > Однако такие колонки нельзя [изменить](../syntax/alter_table/family#mod-column-groups) или [удалить](../syntax/alter_table/columns.md) из таблицы — |
There was a problem hiding this comment.
| > Однако такие колонки нельзя [изменить](../syntax/alter_table/family#mod-column-groups) или [удалить](../syntax/alter_table/columns.md) из таблицы — | |
| > Однако такие колонки нельзя [изменить](../syntax/alter_table/family#mod-column-groups) или [удалить](../syntax/alter_table/columns.md) из таблицы, |
There was a problem hiding this comment.
Здесь тоже следствие и кажется правильнее использовать тире
|
🔄 New commits pushed — @ElenaAfina please take a look. |
1 similar comment
|
🔄 New commits pushed — @ElenaAfina please take a look. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: ElenaAfina <144937430+ElenaAfina@users.noreply.github.com>
Co-authored-by: ElenaAfina <144937430+ElenaAfina@users.noreply.github.com>
Co-authored-by: ElenaAfina <144937430+ElenaAfina@users.noreply.github.com>
|
🔄 New commits pushed — @ElenaAfina please take a look. |
Co-authored-by: ElenaAfina <144937430+ElenaAfina@users.noreply.github.com>
Co-authored-by: ElenaAfina <144937430+ElenaAfina@users.noreply.github.com>
Co-authored-by: ElenaAfina <144937430+ElenaAfina@users.noreply.github.com>
Co-authored-by: ElenaAfina <144937430+ElenaAfina@users.noreply.github.com>
Co-authored-by: ElenaAfina <144937430+ElenaAfina@users.noreply.github.com>
Co-authored-by: ElenaAfina <144937430+ElenaAfina@users.noreply.github.com>
Co-authored-by: Ivan Blinkov <ivan@blinkov.ru>
shnikd
force-pushed
the
YDBDOCS-1142-serial
branch
from
1faffc2 to
df88c9f
Compare
|
🔄 New commits pushed — @ElenaAfina please take a look. |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully Build logsWarnings (2) |
|
🔄 New commits pushed — @ElenaAfina please take a look. |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
Changelog entry
Changelog category
Description for reviewers
Docs for:
Issues: