Repository navigation
Add TsFile v4 file format documentation - #1039
Merged
Merged
Conversation
ColinLeeo
added
bot:triaged
ColinLeeo
marked this pull request as draft
October 28, 2026 03:17
Contributor
Author
|
Warning New commits since the last reviewThe previous review verdict has been withdrawn and this PR has been marked as Draft. Next steps: fix the remaining items, run the full test suite locally, then click Ready for review (or comment |
ColinLeeo
added
bot:needs-check
Break the metadata index root into its table-name prefix and device index root, and explain the lookup path down to Chunk Metadata.
The parsed layout rows already carry the grammar, so the raw notation is redundant.
Stacked rows read like a sequence. Mark alternative children and separate them with an 'or' divider, and make Chunk Layout spell out its two forms.
ColinLeeo
force-pushed
the
doc/tsfile-file-format-v2
branch
from
October 28, 2026 03:56
9b90e2e to
5c83c69
Compare
No section documents the file header on its own, so the link promised content that does not exist. The children still point at the version page.
ColinLeeo
marked this pull request as ready for review
October 28, 2026 04:04
ColinLeeo
added
bot:need-ci
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
UserGuide/latest/FileFormat.TsFileStructureTreecomponent plus sidebar entries in both locales. The tree descends through Page Header/Page Data, Timeseries Statistics/Chunk Metadata, and the table/device index roots, showing offset, size, and one row per field with its own note.ordivider between the options, so they are not mistaken for a sequence; fields inside one structure stay as ordered rows.PLAINlayout; the bit layouts of other value codecs are out of scope.Test plan
pnpm docs:build— 162 pages, no dead links.java/(Statistics, index nodes, encodings, compression IDs, Bloom hashing, Page AEAD layout).