Skip to content

[9.0] Remove references to transport version from index version docs (#135205) #135222

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 22, 2025
Merged

[9.0] Remove references to transport version from index version docs (#135205) #135222

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/internal/Versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,19 +165,19 @@ also has that change, and knows about the patch backport ids and what they mean.
## Index version

Index version is a single incrementing version number for the index data format,
metadata, and associated mappings. It is declared the same way as the
transport version - with the pattern `M_NNN_S_PP`, for the major version, version id,
subsidiary version id, and patch number respectively.
metadata, and associated mappings. It is declared with the pattern `M_NNN_S_PP`,
for the major version, version id, subsidiary version id, and patch number
respectively.

Index version is stored in index metadata when an index is created,
and it is used to determine the storage format and what functionality that index supports.
The index version does not change once an index is created.

In the same way as transport versions, when a change is needed to the index
data format or metadata, or new mapping types are added, create a new version constant
below the last one, incrementing the `NNN` version component.
When a change is needed to the index data format or metadata, or new mapping
types are added, create a new version constant below the last one, incrementing
the `NNN` version component.

Unlike transport version, version constants cannot be collapsed together,
Index version constants cannot be collapsed together,
as an index keeps its creation version id once it is created.
Fortunately, new index versions are only created once a month or so,
so we don’t have a large list of index versions that need managing.
Expand Down