Skip to content

docs: add gc_table and gc_regions admin functions#2407

Open
Copilot wants to merge 2 commits intomainfrom
copilot/update-docs-admin-gc-table-regions
Open

docs: add gc_table and gc_regions admin functions#2407
Copilot wants to merge 2 commits intomainfrom
copilot/update-docs-admin-gc-table-regions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 9, 2026

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 — Added gc_table and gc_regions to the function list and examples; updated front matter keywords/description
  • i18n/zh/.../reference/sql/admin.md — Chinese translation of the same additions

New functions

-- GC orphaned SST files for a dropped table
admin gc_table("test");
admin gc_table("test", true);  -- full file listing mode

-- GC orphaned SST files for specific regions
admin gc_regions(1, 2, 3);
admin gc_regions(1, 2, 3, true);  -- full file listing mode

Both functions return the number of processed regions. The optional full_file_listing boolean (default false) forces a thorough scan of all files in object storage.

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.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Apr 9, 2026

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

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

View logs

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
Copilot AI requested a review from fengjiachun April 9, 2026 21:13
@fengjiachun fengjiachun requested a review from discord9 April 19, 2026 15:30
@fengjiachun fengjiachun marked this pull request as ready for review April 20, 2026 20:24
@fengjiachun fengjiachun requested a review from killme2008 as a code owner April 20, 2026 20:24
Copy link
Copy Markdown
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

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: admin gc table/regions

3 participants