Skip to content

docs: add build index admin function#2573

Open
discord9 wants to merge 4 commits into
mainfrom
docs/admin-build-index
Open

docs: add build index admin function#2573
discord9 wants to merge 4 commits into
mainfrom
docs/admin-build-index

Conversation

@discord9

@discord9 discord9 commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

What's Changed in this PR

Document admin build_index in the current English SQL ADMIN reference:

  • add build_index(table_name) to the admin function list;
  • add an example for building missing indexes after adding or changing index definitions;
  • describe behavior, idempotency, affected-row return value, verification via SHOW INDEX and information_schema.ssts_index_meta, and resource notes.

Scope note: this PR intentionally updates only the current English docs. Localized docs and other versioned copies are deferred until after review approval.

Checklist

  • Please confirm that all corresponding versions of the documents have been revised. (Deferred intentionally: this PR is current English docs only.)
  • 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.

Checks

  • git diff --check
  • pnpm build

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jun 17, 2026

Copy link
Copy Markdown

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 02a7540
Status: ✅  Deploy successful!
Preview URL: https://603559e6.greptime-docs.pages.dev
Branch Preview URL: https://docs-admin-build-index.greptime-docs.pages.dev

View logs

Comment thread docs/reference/sql/admin.md Outdated
Comment thread docs/reference/sql/admin.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the SQL ADMIN reference documentation to include the BUILD_INDEX/build_index admin function, explaining when and how to use it to (re)build missing physical indexes for existing SST files.

Changes:

  • Add build_index(table_name) to the documented admin function list and keywords/frontmatter metadata.
  • Add a brief example invocation in the existing “Admin Functions” example block.
  • Add a new “Build Index” section with usage syntax, an end-to-end example, verification queries, and resource/idempotency notes.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/reference/sql/admin.md
Comment thread docs/reference/sql/admin.md
Comment thread docs/reference/sql/admin.md Outdated
Comment thread docs/reference/sql/admin.md Outdated
Comment thread docs/reference/sql/admin.md Outdated
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.

3 participants