docs: add gc_table and gc_regions admin functions#2407
Open
Conversation
Agent-Logs-Url: https://github.com/GreptimeTeam/docs/sessions/3d77637a-4248-4847-8468-afaa64dbe606 Co-authored-by: fengjiachun <3860496+fengjiachun@users.noreply.github.com>
Deploying greptime-docs with
|
| Latest commit: |
72eb934
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://cde0b5df.greptime-docs.pages.dev |
| Branch Preview URL: | https://copilot-update-docs-admin-gc.greptime-docs.pages.dev |
Copilot
AI
changed the title
[WIP] Update documentation for admin gc table and regions
docs: add gc_table and gc_regions admin functions
Apr 9, 2026
discord9
approved these changes
Apr 20, 2026
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.
Documents two new admin functions introduced in greptimedb#7619 for manually triggering garbage collection of orphaned SST files in object storage.
Changes
docs/reference/sql/admin.md— Addedgc_tableandgc_regionsto the function list and examples; updated front matter keywords/descriptioni18n/zh/.../reference/sql/admin.md— Chinese translation of the same additionsNew functions
Both functions return the number of processed regions. The optional
full_file_listingboolean (defaultfalse) forces a thorough scan of all files in object storage.Checklist
sidebars.tsmatches the current document structure when you changed the document structure.