Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 13, 2025

What's Changed in this PR

Documents the metric engine's sparse primary key encoding feature enabled by default in GreptimeDB PR #7195.

Configuration Documentation (configuration.md)

  • Updated region engine section to include metric engine alongside mito
  • Added metric engine configuration section with sparse_primary_key_encoding option (default: true)
  • Documented performance benefits: encodes only non-null primary key columns to reduce CPU overhead

Metric Engine Documentation (metric-engine.md)

  • Updated operational capabilities to reflect DELETE support on logical tables
  • Clarified physical tables remain read-only for safety

Applied to both nightly and v1.0 documentation versions in English and Chinese (中文).

Chinese Documentation (中文文档)

  • Updated configuration documentation with metric engine section and sparse_primary_key_encoding option
  • Updated metric engine documentation to reflect DELETE support on logical tables
  • Applied to both current (nightly) and version-1.0

Checklist

Original prompt

This section details on the original issue you should resolve

<issue_title>Update docs for feat(metric)!: enable sparse primary key encoding by default</issue_title>
<issue_description>A document change request is generated from GreptimeTeam/greptimedb#7195</issue_description>

<agent_instructions>Update nightly and v1.0, following existing markdown write styling</agent_instructions>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…tion

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

cloudflare-workers-and-pages bot commented Nov 13, 2025

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8bee8ca
Status: ✅  Deploy successful!
Preview URL: https://e3848b22.greptime-docs.pages.dev
Branch Preview URL: https://copilot-update-docs-sparse-k.greptime-docs.pages.dev

View logs

Copilot AI changed the title [WIP] Update docs to enable sparse primary key encoding by default docs: add metric engine sparse primary key encoding configuration Nov 13, 2025
Copilot AI requested a review from WenyXu November 13, 2025 07:06
Copilot finished work on behalf of WenyXu November 13, 2025 07:06
@WenyXu
Copy link
Member

WenyXu commented Nov 13, 2025

@copilot update Chinese version

Co-authored-by: WenyXu <32535939+WenyXu@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Nov 13, 2025

@copilot update Chinese version

Updated Chinese documentation in commit 8bee8ca. Changes include:

  • Configuration documentation with metric engine section and sparse_primary_key_encoding option
  • Metric engine documentation reflecting DELETE support on logical tables
  • Applied to both current (nightly) and version-1.0

@WenyXu WenyXu marked this pull request as ready for review November 13, 2025 07:37
Copilot finished work on behalf of WenyXu November 13, 2025 07:38
Copy link
Contributor

@fengjiachun fengjiachun left a comment

Choose a reason for hiding this comment

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

LGTM

@killme2008 killme2008 merged commit db16087 into main Nov 15, 2025
11 checks passed
@killme2008 killme2008 deleted the copilot/update-docs-sparse-key-encoding branch November 15, 2025 23:43
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(metric)!: enable sparse primary key encoding by default

5 participants