docs: add manual compaction time range - #2666
Open
v0y4g3r wants to merge 2 commits into
Open
Conversation
Signed-off-by: Lei, HUANG <ratuthomm@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the GreptimeDB documentation to describe the newly supported start_time/end_time options for manual compaction, including range semantics and strategy-specific behavior, and mirrors the content in both English and Chinese nightly docs.
Changes:
- Document
start_time/end_timefor limiting manual compaction to a half-open time range ([start_time, end_time)), including time zone handling. - Clarify regular (TWCS-triggered) vs SWCS (forced) behavior when a time range is specified, including SWCS dependency-window expansion.
- Add corresponding examples to the ADMIN SQL reference in both English and Chinese docs.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/user-guide/deployments-administration/manage-data/compaction.md | Adds an English section explaining time-ranged manual compaction behavior for regular and SWCS. |
| docs/reference/sql/admin.md | Adds English ADMIN SQL examples showing time-ranged regular and SWCS compaction invocations. |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/manage-data/compaction.md | Adds the Chinese equivalent section describing time range rules/behavior and examples. |
| i18n/zh/docusaurus-plugin-content-docs/current/reference/sql/admin.md | Adds Chinese ADMIN SQL examples for time-ranged regular and SWCS compaction. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Deploying greptime-docs with
|
| Latest commit: |
5d42d6f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f630cbf7.greptime-docs.pages.dev |
| Branch Preview URL: | https://docs-manual-compaction-time.greptime-docs.pages.dev |
Signed-off-by: Lei, HUANG <ratuthomm@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What's changed
start_timeandend_timeoptions for ranged manual compaction.Related
Verification
pnpm exec eslint docs/reference/sql/admin.md docs/user-guide/deployments-administration/manage-data/compaction.md i18n/zh/docusaurus-plugin-content-docs/current/reference/sql/admin.md i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/manage-data/compaction.mdpnpm testpnpm buildgit diff --check