docs: add build index admin function#2573
Open
discord9 wants to merge 4 commits into
Open
Conversation
Deploying greptime-docs with
|
| 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 |
killme2008
reviewed
Jun 17, 2026
|
|
||
| ADMIN BUILD_INDEX('logs'); | ||
|
|
||
| SELECT message FROM logs WHERE MATCHES(message, 'fox'); |
|
|
||
| ALTER TABLE logs MODIFY COLUMN message SET FULLTEXT INDEX; | ||
|
|
||
| ADMIN BUILD_INDEX('logs'); |
Member
There was a problem hiding this comment.
Does it return the procedure id? If so, the user can query the procedure by procedure_state(pid) to check if it finishes.
Contributor
There was a problem hiding this comment.
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 on lines
1
to
+3
| --- | ||
| keywords: [ADMIN statement, SQL, administration functions, flush table, compact table, migrate region, gc table, gc regions] | ||
| description: Describes the `ADMIN` statement used to run administration functions, including examples for flushing tables, scheduling compactions, migrating regions, querying procedure states, and garbage collecting orphaned files. | ||
| keywords: [ADMIN statement, SQL, administration functions, flush table, compact table, build index, migrate region, gc table, gc regions] | ||
| description: Describes the `ADMIN` statement used to run administration functions, including examples for flushing tables, scheduling compactions, building indexes, migrating regions, querying procedure states, and garbage collecting orphaned files. |
|
|
||
| ## Build Index | ||
|
|
||
| Use `ADMIN BUILD_INDEX` to manually build indexes for existing data files when the table metadata requires indexes that some SST files do not have yet. Typical use cases include adding an index to an existing column, migrating from data written before the index was available, or retrying after a previous index build failure. |
| Use `ADMIN BUILD_INDEX` to manually build indexes for existing data files when the table metadata requires indexes that some SST files do not have yet. Typical use cases include adding an index to an existing column, migrating from data written before the index was available, or retrying after a previous index build failure. | ||
|
|
||
| ```sql | ||
| ADMIN BUILD_INDEX('table_name'); |
Comment on lines
+88
to
+92
| ADMIN FLUSH_TABLE('logs'); | ||
|
|
||
| ALTER TABLE logs MODIFY COLUMN message SET FULLTEXT INDEX; | ||
|
|
||
| ADMIN BUILD_INDEX('logs'); |
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 in this PR
Document
admin build_indexin the current English SQL ADMIN reference:build_index(table_name)to the admin function list;SHOW INDEXandinformation_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
sidebars.tsmatches the current document structure when you changed the document structure.Checks
git diff --checkpnpm build