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
from
bd51288 to
30814b1
Compare
shnikd
force-pushed
the
YDBDOCS-1142-serial
branch
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 %}
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
Co-authored-by: ElenaAfina <144937430+ElenaAfina@users.noreply.github.com>
|
🔄 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 |
Co-authored-by: ElenaAfina <144937430+ElenaAfina@users.noreply.github.com>
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
🔄 New commits pushed — @ElenaAfina please take a look. |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
🔄 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
🟢 |
|
Hey @ElenaAfina, it has been 26 business-hours since the author's last update, could you please review? |
|
Hey @ElenaAfina, it has been 56 business-hours since the author's last update, could you please review? |
|
Hey @ElenaAfina, it has been 86 business-hours since the author's last update, could you please review? |
|
Hey @ElenaAfina, it has been 116 business-hours since the author's last update, could you please review? |
ydb/docs/en/core/reference/ydb-cli/export-import/_includes/tools_dump.md
Outdated
Show resolved
Hide resolved
| @@ -0,0 +1,55 @@ | |||
| # ALTER SEQUENCE | |||
|
|
|||
| Modifies parameters of an existing `Sequence` object associated with a [Serial](../types/serial.md) column. | |||
There was a problem hiding this comment.
Add sequence to glossary.md and make "sequence" a link to its definition. It shouldn't be in backticks.
| @@ -0,0 +1,55 @@ | |||
| # ALTER SEQUENCE | |||
|
|
|||
| Modifies parameters of an existing `Sequence` object associated with a [Serial](../types/serial.md) column. | |||
There was a problem hiding this comment.
Explicitly explain that sequences can't be created on their own and appear as part of the implementation of table columns with the Serial data type.
| | 987654321 | `bob@example.com` | Bob | 2 | | ||
| | 111111111 | `john@example.com` | John | 3 | | ||
|
|
||
| You can also explicitly specify a value for the `Serial` column during insertion, for example, when restoring data. In this case, the insertion will work like with a regular integer column, and the `Sequence` will not be affected: |
There was a problem hiding this comment.
This belongs to a generic description of inserting into columns with Serial type and is not specific to this example.
Also, it sounds like this needs to explicitly say that doing so without adjusting the sequence position is likely to result in a primary key conflict either immediately or at a random moment in the future when the sequence will catch up with the inserted value. Or is it smart enough to transparently step over occupied values?
Co-authored-by: Ivan Blinkov <ivan@blinkov.ru>
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
🔄 New commits pushed — @ElenaAfina please take a look. |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
❌ Documentation buildRevision build failed Build logsErrors (1)❌ Link is unreachable: en/yql/reference/syntax/create-table.md in en/yql/reference/syntax/alter-sequence.md. Warnings (1) |
Changelog entry
Changelog category
Description for reviewers
Docs for:
Issues: