docs: table sharding in user guide

[waynexia]

What's Changed in this PR

Closes https://github.com/GreptimeTeam/docs/issues/1046

Describe the when and how to shard a table

Checklist

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

Summary by CodeRabbit

• Documentation
  • Added new documentation on table sharding in GreptimeDB, explaining its importance in distributed databases, guidelines for sharding tables, and partition rules based on column value ranges.
  • Updated contributor guide to focus on data sharding concepts, removing specific mentions of partitioning types.
  • Introduced a new section titled table-sharding in the summary of topics.

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

[!NOTE]

Reviews paused

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Walkthrough

The update introduces a user guide for table sharding in GreptimeDB, explaining its role in distributed databases, providing guidelines for sharding tables, and detailing partition rules based on column value ranges. It also adds a new section for table-sharding in the summary.yml file.

Changes

Files	Change Summary
docs/nightly/en/contributor-guide/frontend/table-sharding.md	Removed specific mentions of partitioning types and focused on data sharding concepts borrowed from OLTP databases.
docs/nightly/en/summary.yml	Added a new section titled table-sharding.
docs/nightly/en/user-guide/operations/table-sharding.md	Introduced table sharding in GreptimeDB, detailing its significance, sharding guidelines, and partition rules.

Sequence Diagram(s)

N/A

Assessment against linked issues

Objective	Addressed	Explanation
Explanation of GreptimeDB table-sharding functionality (#1046)	✅
Instructions on table partitioning in GreptimeDB with examples (#1046)	✅
Guidelines for managing table shardings (#1046)	✅

Amidst the fields of data bright, Tables shard to spread the light. With columns split and ranges set, GreptimeDB’s path is met. The user’s guide now leads the way, Through partitioned realms, we sway. 🐇📚

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[cloudflare-workers-and-pages[bot]]

Deploying greptime-docs with    Cloudflare Pages

Latest commit:	4cad7ed
Status:	✅  Deploy successful!
Preview URL:	https://21165918.greptime-docs.pages.dev
Branch Preview URL:	https://table-sharding.greptime-docs.pages.dev

View logs

[waynexia]

@coderabbitai pause

[coderabbitai[bot]]

Actions performed

Reviews paused.

[waynexia]

@coderabbitai resolve

[coderabbitai[bot]]

Actions performed

Comments resolved.

[waynexia]

hold this for repartition feature

[nicecui]

may be we can write a new PR for the repartition feature