Export / import s3 for topics configuration docs #30232

stanislav-shchetinin · 2025-12-05T16:03:19Z

Changelog entry

...

Changelog category

Documentation (changelog entry is not required)

Description for reviewers

...

github-actions · 2025-12-05T16:03:58Z

⚪ 2025-12-05 16:03:58 UTC Pre-commit check linux-x86_64-relwithdebinfo for de368b0 has started.
⚪ 2025-12-05 16:04:56 UTC Artifacts will be uploaded here
⚪ 2025-12-05 16:06:57 UTC ya make is running...
🟢 2025-12-05 16:07:02 UTC Tests successful.

Ya make output | Test bloat

TESTS	PASSED	ERRORS	FAILED	SKIPPED	MUTED^?
0	0	0	0	0	0

🟢 2025-12-05 16:07:08 UTC Build successful.

github-actions · 2025-12-05T16:04:17Z

🟢 2025-12-05 16:04:16 UTC The validation of the Pull Request description is successful.

ydbot · 2025-12-05T16:04:18Z

Run Extra Tests

Run additional tests for this PR. You can customize:

Test Size: small, medium, large (default: all)
Test Targets: any directory path (default: ydb/)
Sanitizers: ASAN, MSAN, TSAN
Coredumps: enable for debugging (default: off)
Additional args: custom ya make arguments

Copilot

Pull request overview

This PR adds documentation for exporting and importing topics (schema only, without messages) to/from S3-compatible storage in both English and Russian documentation.

Key changes:

Added topics to the list of exportable object types in S3 export documentation
Added a new "Topics" section describing the file structure for exported topics
Updated list formatting for consistency (semicolons)

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File	Description
ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/file-structure.md	Adds "Topics" section explaining that each topic has a directory with `create_topic.pb` file containing topic parameters in text protobuf format
ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/export-s3.md	Adds topic to the list of exportable objects, fixes list punctuation consistency
ydb/docs/en/core/reference/ydb-cli/export-import/_includes/s3_export.md	Adds topic to the list of exportable objects (English version)
ydb/docs/en/core/reference/ydb-cli/export-import/_includes/file_structure.md	Adds "Topics" section describing the topic export file structure (English version)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-05T16:06:28Z

ydb/docs/en/core/reference/ydb-cli/export-import/_includes/s3_export.md

 - [Row-oriented table](../../../../concepts/datamodel/table.md#row-oriented-tables)
 - [Secondary index](../../../../concepts/glossary.md#secondary-index)
 - [Vector index](../../../../concepts/glossary.md#vector-index)
+- [Topic](../../../../concepts/datamodel/topic.md) ()


The parentheses appear to be incomplete. Based on the Russian version of this file, this should read "(only the schema, without messages)" to match the description "только схема, без сообщений".

Suggested change

- [Topic](../../../../concepts/datamodel/topic.md) ()

- [Topic](../../../../concepts/datamodel/topic.md) (only the schema, without messages)

Copilot · 2025-12-05T16:06:29Z

ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/export-s3.md

- [векторный индекс](../../../../concepts/glossary.md#vector-index).
+- [вторичный индекс](../../../../concepts/glossary.md#secondary-index);
+- [векторный индекс](../../../../concepts/glossary.md#vector-index);
+- [топик](../../../../concepts/datamodel/topic.md) (only the schema, without messages).


Inconsistent use of language. The line contains Russian text "только схема, без сообщений" within English documentation. This should be translated to English: "(only the schema, without messages)".

Suggested change

- [топик](../../../../concepts/datamodel/topic.md) (only the schema, without messages).

- [топик](../../../../concepts/datamodel/topic.md) (только схема, без сообщений).

Поддерживаю.

Copilot · 2025-12-05T16:06:30Z

ydb/docs/en/core/reference/ydb-cli/export-import/_includes/file_structure.md


+## Topics {#topics}
+
+For each topic in the database, there's a same-name directory in the file structure's directory hierarchy that includes the create_topic.pb file. This file provides information about the topic parameters, partitioning settings, and consumers in the [text protobuf](https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.text_format) format.


The filename create_topic.pb should be formatted with backticks for consistency with other file references in the documentation (e.g., changefeed_description.pb and topic_description.pb on lines 73-74).

Suggested change

For each topic in the database, there's a same-name directory in the file structure's directory hierarchy that includes the create_topic.pb file. This file provides information about the topic parameters, partitioning settings, and consumers in the [text protobuf](https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.text_format) format.

For each topic in the database, there's a same-name directory in the file structure's directory hierarchy that includes the `create_topic.pb` file. This file provides information about the topic parameters, partitioning settings, and consumers in the [text protobuf](https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.text_format) format.

github-actions · 2025-12-05T16:07:01Z

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (4)

⚠️ Incorrect syntax for notes, file ru/devops/observability/alerting.md

⚠️ Skip error: SkippedEvalError: Cannot apply an unsupported filter: ansible_config_file | dirname

⚠️ Variable ansible_config_file | dirname not found in ru/devops/deployment-options/ansible/initial-deployment.md

⚠️ ru/reference/ydb-cli/topic-consumer-add.md: 35: MD001 / heading-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4]

github-actions · 2025-12-05T16:07:10Z

⚪ 2025-12-05 16:07:10 UTC Pre-commit check linux-x86_64-release-asan for de368b0 has started.
⚪ 2025-12-05 16:07:26 UTC Artifacts will be uploaded here
⚪ 2025-12-05 16:09:29 UTC ya make is running...
🟢 2025-12-05 16:09:34 UTC Tests successful.

Ya make output | Test bloat

TESTS	PASSED	ERRORS	FAILED	SKIPPED	MUTED^?
0	0	0	0	0	0

🟢 2025-12-05 16:09:39 UTC Build successful.

CyberROFL · 2025-12-05T16:57:12Z

ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/export-s3.md

- [векторный индекс](../../../../concepts/glossary.md#vector-index).
+- [вторичный индекс](../../../../concepts/glossary.md#secondary-index);
+- [векторный индекс](../../../../concepts/glossary.md#vector-index);
+- [топик](../../../../concepts/datamodel/topic.md) (only the schema, without messages).


Поддерживаю.

CyberROFL · 2025-12-05T16:57:29Z

ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/export-s3.md

- [векторный индекс](../../../../concepts/glossary.md#vector-index).
+- [вторичный индекс](../../../../concepts/glossary.md#secondary-index);
+- [векторный индекс](../../../../concepts/glossary.md#vector-index);
+- [топик](../../../../concepts/datamodel/topic.md) (only the schema, without messages).


Suggested change

- [топик](../../../../concepts/datamodel/topic.md) (only the schema, without messages).

- [топик](../../../../concepts/datamodel/topic.md) (только схема).

stanislav-shchetinin added 2 commits December 5, 2025 14:58

topics in export

806cc08

cli

8085aef

Copilot AI review requested due to automatic review settings December 5, 2025 16:03

stanislav-shchetinin requested a review from a team as a code owner December 5, 2025 16:03

stanislav-shchetinin self-assigned this Dec 5, 2025

github-actions bot added the documentation Improvements or additions to documentation label Dec 5, 2025

stanislav-shchetinin mentioned this pull request Dec 5, 2025

Support export / import s3 for topics #18195

Closed

Copilot started reviewing on behalf of stanislav-shchetinin December 5, 2025 16:04 View session

Copilot finished reviewing on behalf of stanislav-shchetinin December 5, 2025 16:05

Copilot AI reviewed Dec 5, 2025

View reviewed changes

CyberROFL reviewed Dec 5, 2025

View reviewed changes

	- [Topic](../../../../concepts/datamodel/topic.md) ()
	- [Topic](../../../../concepts/datamodel/topic.md) (only the schema, without messages)

	- [топик](../../../../concepts/datamodel/topic.md) (only the schema, without messages).
	- [топик](../../../../concepts/datamodel/topic.md) (только схема, без сообщений).


		## Topics {#topics}

		For each topic in the database, there's a same-name directory in the file structure's directory hierarchy that includes the create_topic.pb file. This file provides information about the topic parameters, partitioning settings, and consumers in the [text protobuf](https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.text_format) format.

Export / import s3 for topics configuration docs #30232

Are you sure you want to change the base?

Export / import s3 for topics configuration docs #30232

Uh oh!

Conversation

stanislav-shchetinin commented Dec 5, 2025

Changelog entry

Changelog category

Description for reviewers

Uh oh!

github-actions bot commented Dec 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 5, 2025

Uh oh!

ydbot commented Dec 5, 2025

Run Extra Tests

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

CyberROFL Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 5, 2025

✅ Documentation build

Build logs

Warnings (4)

Uh oh!

github-actions bot commented Dec 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CyberROFL Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

CyberROFL Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Dec 5, 2025 •

edited

Loading

github-actions bot commented Dec 5, 2025 •

edited

Loading