docs: clarify REGION_STATISTICS owned-SST semantics (nightly only)#2510
Conversation
Deploying greptime-docs with
|
| Latest commit: |
0d73509
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://525081d5.greptime-docs.pages.dev |
| Branch Preview URL: | https://copilot-update-docs-count-ow.greptime-docs.pages.dev |
There was a problem hiding this comment.
Pull request overview
This PR clarifies the semantics of INFORMATION_SCHEMA.REGION_STATISTICS fields to match the updated GreptimeDB behavior: statistics now count only SST/index files owned by the region, excluding cross-region referenced SSTs. The clarification is applied consistently across English/Chinese docs and both current and version-1.0 doc sets.
Changes:
- Clarifies
region_rowsas “owned-SST rows + memtable rows,” excluding rows from referenced SSTs. - Clarifies
sst_num,sst_size, andindex_sizeas counting only owned SST/index files, excluding referenced SSTs. - Applies the same wording updates across
currentandversion-1.0, in both English and Chinese.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/reference/sql/information-schema/region-statistics.md | Updates field descriptions to document owned-SST-only semantics for region statistics. |
| versioned_docs/version-1.0/reference/sql/information-schema/region-statistics.md | Mirrors the same owned-SST-only clarifications for the v1.0 doc set. |
| i18n/zh/docusaurus-plugin-content-docs/current/reference/sql/information-schema/region-statistics.md | Chinese localization update for current, aligning wording with owned-SST-only semantics. |
| i18n/zh/docusaurus-plugin-content-docs/version-1.0/reference/sql/information-schema/region-statistics.md | Chinese localization update for v1.0, aligning wording with owned-SST-only semantics. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@copilot apply suggestions |
Done — swapped |
|
@copilot only update nightly docs. |
Reverted the changes to |
What's Changed in this PR
This updates
REGION_STATISTICSnightly docs to match greptimedb PR #8191 behavior: region stats now count only SST data/index files owned by the region, excluding cross-region referenced SSTs.The clarification is applied to both English and Chinese nightly docs only. Version-1.0 docs are not updated as this feature is not available in v1.0.
Scope
region_rows,sst_num,sst_size, andindex_sizefield descriptions in:docs/reference/sql/information-schema/region-statistics.mdi18n/zh/docusaurus-plugin-content-docs/current/reference/sql/information-schema/region-statistics.mdDoc semantics aligned with engine behavior
region_rows: owned-SST rows + memtable rowssst_size/sst_num/index_size: owned SST/index files only (listed in table column order)Field description ordering
sst_sizeandsst_numbullets to match the example output table column order (sst_sizebeforesst_num), making the docs easier to scan and cross-reference.Checklist
sidebars.tsmatches the current document structure when you changed the document structure.