Skip to content

docs: clarify REGION_STATISTICS owned-SST semantics (nightly only)#2510

Merged
WenyXu merged 4 commits into
mainfrom
copilot/update-docs-count-owned-ssts
Jun 8, 2026
Merged

docs: clarify REGION_STATISTICS owned-SST semantics (nightly only)#2510
WenyXu merged 4 commits into
mainfrom
copilot/update-docs-count-owned-ssts

Conversation

Copilot AI commented May 28, 2026

Copy link
Copy Markdown
Contributor

What's Changed in this PR

This updates REGION_STATISTICS nightly 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

    • Updated region_rows, sst_num, sst_size, and index_size field descriptions in:
      • docs/reference/sql/information-schema/region-statistics.md
      • i18n/zh/docusaurus-plugin-content-docs/current/reference/sql/information-schema/region-statistics.md
  • Doc semantics aligned with engine behavior

    • region_rows: owned-SST rows + memtable rows
    • sst_size / sst_num / index_size: owned SST/index files only (listed in table column order)
    • Referenced SSTs from other regions are explicitly documented as excluded
  • Field description ordering

    • Reordered sst_size and sst_num bullets to match the example output table column order (sst_size before sst_num), making the docs easier to scan and cross-reference.
- `sst_size`: The region's total size of SST files owned by this region. SST files referenced from other regions are not counted.
- `sst_num`: The region's total number of SST files owned by this region. SST files referenced from other regions are not counted.
- `index_size`: The region's total size of index files owned by this region. SST index files referenced from other regions are not counted.

Checklist

  • Please confirm that all corresponding versions of the documents have been revised.
  • Please ensure that the content in sidebars.ts matches the current document structure when you changed the document structure.
  • This change requires follow-up update in localized docs.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented May 28, 2026

Copy link
Copy Markdown

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

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

View logs

Copilot AI changed the title [WIP] Update documentation for count owned SSTs in region stats docs: clarify REGION_STATISTICS owned-SST semantics May 28, 2026
Copilot finished work on behalf of WenyXu May 28, 2026 09:50
Copilot AI requested a review from WenyXu May 28, 2026 09:50
@WenyXu WenyXu marked this pull request as ready for review June 5, 2026 06:38
@WenyXu WenyXu requested a review from fengjiachun as a code owner June 5, 2026 06:38
Copilot AI review requested due to automatic review settings June 5, 2026 06:38
@WenyXu WenyXu requested a review from killme2008 as a code owner June 5, 2026 06:38

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_rows as “owned-SST rows + memtable rows,” excluding rows from referenced SSTs.
  • Clarifies sst_num, sst_size, and index_size as counting only owned SST/index files, excluding referenced SSTs.
  • Applies the same wording updates across current and version-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.

Comment thread docs/reference/sql/information-schema/region-statistics.md Outdated
Comment thread versioned_docs/version-1.0/reference/sql/information-schema/region-statistics.md Outdated
@WenyXu

WenyXu commented Jun 5, 2026

Copy link
Copy Markdown
Member

@copilot apply suggestions

Copilot AI commented Jun 5, 2026

Copy link
Copy Markdown
Contributor Author

@copilot apply suggestions

Done — swapped sst_num and sst_size bullets to match the table column order (sst_size before sst_num) in all four files (EN/ZH, current/v1.0). Commit: docs: reorder sst_size/sst_num bullets to match table column order.

Copilot finished work on behalf of WenyXu June 5, 2026 09:24
Comment thread docs/reference/sql/information-schema/region-statistics.md
@WenyXu

WenyXu commented Jun 8, 2026

Copy link
Copy Markdown
Member

@copilot only update nightly docs.

Copilot AI commented Jun 8, 2026

Copy link
Copy Markdown
Contributor Author

@copilot only update nightly docs.

Reverted the changes to versioned_docs/version-1.0/ and i18n/zh/.../version-1.0/ — nightly docs (docs/ and i18n/zh/.../current/) remain updated.

Copilot AI changed the title docs: clarify REGION_STATISTICS owned-SST semantics docs: clarify REGION_STATISTICS owned-SST semantics (nightly only) Jun 8, 2026
Copilot finished work on behalf of WenyXu June 8, 2026 06:16
@WenyXu WenyXu merged commit 05dfc00 into main Jun 8, 2026
6 checks passed
@WenyXu WenyXu deleted the copilot/update-docs-count-owned-ssts branch June 8, 2026 06:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update docs for fix(mito): count owned SSTs in region stats

4 participants