docs: document how data is organized in SST files#2531
Merged
Conversation
Explain the physical SST layout in the storage engine docs: - storage-engine.md: add Data Layout in SST Files (sort order, internal columns, row groups, file metadata) and Scan Pruning sections with diagrams; touch up the WAL/SST/Compactor bullets. - data-persistence-indexing.md: note skipping and full-text indexes are also stored in Puffin files. - data-model.md and design-table.md: cross-link to the storage engine doc for how data is laid out in SST files. Signed-off-by: evenyag <realevenyag@gmail.com>
evenyag
commented
Jun 5, 2026
Contributor
Author
There was a problem hiding this comment.
Will sync the versioned docs and zh docs later.
Deploying greptime-docs with
|
| Latest commit: |
8d49806
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://24954488.greptime-docs.pages.dev |
| Branch Preview URL: | https://docs-sst-data-layout.greptime-docs.pages.dev |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 83ff57a1f4
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
React/MDX requires the style prop to be an object, not a string. A string value made SSR fail and broke the Docusaurus build. Signed-off-by: evenyag <realevenyag@gmail.com>
Contributor
Author
|
@codex update zh docs and version 1.0 docs. |
|
Summary
Testing
|
evenyag
added a commit
that referenced
this pull request
Jun 10, 2026
Main's PR #2531 added authoritative "Data Layout in SST Files" and "Scan Pruning" sections to the storage engine docs. Trim the overlapping explanation in the table design guide and link out to those sections instead. Also fix the storage engine cross-link to the renamed "SST format" section. Signed-off-by: evenyag <realevenyag@gmail.com>
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
2 participants
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.
What's Changed in this PR
Explain the physical SST layout in the storage engine docs:
columns, row groups, file metadata) and Scan Pruning sections with
diagrams; touch up the WAL/SST/Compactor bullets.
also stored in Puffin files.
for how data is laid out in SST files.
Checklist
sidebars.tsmatches the current document structure when you changed the document structure.