Skip to content

docs: add SSTS_MANIFEST primary key range columns to INFORMATION_SCHEMA docs#2498

Open
Copilot wants to merge 3 commits into
mainfrom
copilot/update-docs-show-sst-primary-key-range
Open

docs: add SSTS_MANIFEST primary key range columns to INFORMATION_SCHEMA docs#2498
Copilot wants to merge 3 commits into
mainfrom
copilot/update-docs-show-sst-primary-key-range

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 21, 2026

What's Changed in this PR

GreptimeDB now exposes SST primary key ranges in INFORMATION_SCHEMA.SSTS_MANIFEST; this PR updates docs so the table schema and examples reflect that behavior. The update is applied to both current English and current Chinese docs.

  • SSTS_MANIFEST schema/docs alignment

    • Added primary_key_min and primary_key_max to the DESC SSTS_MANIFEST output.
    • Documented both fields as encoded primary key range bounds.
    • Updated sample query output to include the new columns.
  • INFORMATION_SCHEMA overview alignment

    • Updated the SSTS_MANIFEST row description to mention encoded primary key ranges.

Example snippet:

DESC SSTS_MANIFEST;

| primary_key_min  | Binary | ... | YES | ... |
| primary_key_max  | Binary | ... | YES | ... |

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.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • accounts.google.com
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --mute-audio --crashpad-handler-pid=13904 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/puppeteer_dev_chrome_profile-8oNXjB --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,6034721916232958271,9860561621935276304,262144 --enable-features=PdfOopif --disable-features=AcceptCHFrame,IsolateSandboxedIframes,MediaRouter,OptimizationHints,PaintHolding,ProcessPerSiteUpToMainFrameThreshold,Translate --variations-seed-version git (dns block)
    • Triggering command: /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome --allow-pre-commit-input --disable-REDACTED-networking --disable-REDACTED-timer-throttling --disable-REDACTEDing-occluded-windows --disable-breakpad --disable-client-side-phishing-detection --disable-component-extensions-with-REDACTED-pages --disable-crash-reporter --disable-default-apps --disable-dev-shm-usage --disable-hang-monitor --disable-infobars --disable-ipc-flooding-protection --disable-popup-blocking --disable-prompt-on-repost --disable-renderer-REDACTEDing --disable-search-engine-choice-screen --disable-sync --enable-automation (dns block)
  • clients2.google.com
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --mute-audio --crashpad-handler-pid=13904 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/puppeteer_dev_chrome_profile-8oNXjB --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,6034721916232958271,9860561621935276304,262144 --enable-features=PdfOopif --disable-features=AcceptCHFrame,IsolateSandboxedIframes,MediaRouter,OptimizationHints,PaintHolding,ProcessPerSiteUpToMainFrameThreshold,Translate --variations-seed-version git (dns block)
    • Triggering command: /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome --allow-pre-commit-input --disable-REDACTED-networking --disable-REDACTED-timer-throttling --disable-REDACTEDing-occluded-windows --disable-breakpad --disable-client-side-phishing-detection --disable-component-extensions-with-REDACTED-pages --disable-crash-reporter --disable-default-apps --disable-dev-shm-usage --disable-hang-monitor --disable-infobars --disable-ipc-flooding-protection --disable-popup-blocking --disable-prompt-on-repost --disable-renderer-REDACTEDing --disable-search-engine-choice-screen --disable-sync --enable-automation (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Agent-Logs-Url: https://github.com/GreptimeTeam/docs/sessions/4452d5aa-29e8-4cf3-882a-796b2925abed

Co-authored-by: MichaelScofield <990479+MichaelScofield@users.noreply.github.com>
@cloudflare-workers-and-pages
Copy link
Copy Markdown

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

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 88064df
Status: ✅  Deploy successful!
Preview URL: https://cf94ec4d.greptime-docs.pages.dev
Branch Preview URL: https://copilot-update-docs-show-sst.greptime-docs.pages.dev

View logs

Copilot AI changed the title [WIP] Update docs for show sst primary key range in information_schema docs: add SSTS_MANIFEST primary key range columns to INFORMATION_SCHEMA docs May 21, 2026
Copilot AI requested a review from MichaelScofield May 21, 2026 01:33
@MichaelScofield MichaelScofield requested a review from Copilot May 21, 2026 01:39
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the INFORMATION_SCHEMA.SSTS_MANIFEST documentation to reflect newly exposed SST primary key range bounds in GreptimeDB, in both English and Chinese docs.

Changes:

  • Adds primary_key_min and primary_key_max columns to the documented DESC SSTS_MANIFEST output and field list.
  • Updates sample query output to include the new primary key range columns.
  • Adjusts INFORMATION_SCHEMA overview entries to mention encoded primary key ranges for SSTS_MANIFEST.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
docs/reference/sql/information-schema/ssts-manifest.md Documents primary_key_min/max columns and updates examples for SSTS_MANIFEST.
docs/reference/sql/information-schema/overview.md Updates the SSTS_MANIFEST row description to mention encoded primary key ranges.
i18n/zh/docusaurus-plugin-content-docs/current/reference/sql/information-schema/ssts-manifest.md Chinese counterpart of SSTS_MANIFEST doc updates for the new columns and examples.
i18n/zh/docusaurus-plugin-content-docs/current/reference/sql/information-schema/overview.md Chinese overview row updated to mention encoded primary key ranges.
Comments suppressed due to low confidence (2)

docs/reference/sql/information-schema/ssts-manifest.md:68

  • primary_key_min/max are Binary, but the example output shows a bare hex-looking string (e.g. 01800001f4). Please clarify in the text (near the field descriptions or the example) what representation clients use (raw bytes vs hex) so readers don’t mistake it for a normal string primary key.
- `origin_region_id`: The ID of the region that created the file.
- `node_id`: The ID of the datanode where the file is located.
- `visible`: Whether this file is visible in the current version.
- `primary_key_min`: The minimum encoded primary key in the SST file.
- `primary_key_max`: The maximum encoded primary key in the SST file.

i18n/zh/docusaurus-plugin-content-docs/current/reference/sql/information-schema/ssts-manifest.md:68

  • primary_key_min/max 字段类型是 Binary,但示例里展示的是类似十六进制的字符串(如 01800001f4)。建议在字段说明或示例附近补充说明客户端展示格式(原始字节/十六进制等),避免读者误以为是可直接阅读的主键字符串。
- `origin_region_id`:创建该文件的 Region ID。
- `node_id`:文件所在的数据节点 ID。
- `visible`:该文件在当前版本中是否可见。
- `primary_key_min`:SST 文件中最小的编码主键。
- `primary_key_max`:SST 文件中最大的编码主键。

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/reference/sql/information-schema/ssts-manifest.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@MichaelScofield MichaelScofield marked this pull request as ready for review May 21, 2026 01:46
@fengjiachun
Copy link
Copy Markdown
Contributor

@codex review

@chatgpt-codex-connector
Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Breezy!

ℹ️ 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".

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 feat: show sst primary key range in information_schema

4 participants