docs: add greptime cli meta put key and put table command documentation#2456
Open
Copilot wants to merge 3 commits into
Open
docs: add greptime cli meta put key and put table command documentation#2456Copilot wants to merge 3 commits into
greptime cli meta put key and put table command documentation#2456Copilot wants to merge 3 commits into
Conversation
Agent-Logs-Url: https://github.com/GreptimeTeam/docs/sessions/90cf259f-88f7-4df0-8153-989af8136b77 Co-authored-by: WenyXu <32535939+WenyXu@users.noreply.github.com>
Deploying greptime-docs with
|
| Latest commit: |
6730218
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://234523f2.greptime-docs.pages.dev |
| Branch Preview URL: | https://copilot-update-docs-metadata.greptime-docs.pages.dev |
Copilot
AI
changed the title
[WIP] Update docs for metadata put key and table commands
docs: add May 7, 2026
greptime cli meta put key and put table command documentation
WenyXu
reviewed
May 7, 2026
Agent-Logs-Url: https://github.com/GreptimeTeam/docs/sessions/8df79b85-6f3c-4e6f-ace8-0ed1ee635e55 Co-authored-by: WenyXu <32535939+WenyXu@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for the newly introduced greptime cli meta put subcommands (key/value writes and table metadata writes) across both current and v1.0 docs, in English and Chinese.
Changes:
- Documented
greptime cli meta put key(stdin value + optional validation bypass). - Documented
greptime cli meta put table infoandgreptime cli meta put table route(stdin JSON payloads). - Added examples for
put table info/put table routeand updated frontmatter descriptions to include insertion/write operations.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| docs/reference/command-lines/utilities/metadata-interaction.md | Adds meta put command reference sections + examples for current (EN) docs. |
| versioned_docs/version-1.0/reference/command-lines/utilities/metadata-interaction.md | Mirrors the same meta put documentation for v1.0 (EN) docs. |
| i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines/utilities/metadata-interaction.md | Adds the corresponding meta put sections + examples for current (ZH) docs. |
| i18n/zh/docusaurus-plugin-content-docs/version-1.0/reference/command-lines/utilities/metadata-interaction.md | Mirrors the same meta put documentation for v1.0 (ZH) docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
WenyXu
force-pushed
the
copilot/update-docs-metadata-commands
branch
from
801213a to
6730218
Compare
Contributor
|
@codex review |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6730218cad
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
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 the new
greptime cli meta putsubcommands added in GreptimeTeam/greptimedb#7989. Updates nightly and v1.0 docs in both English and Chinese.What's Changed in this PR
New sections added to
metadata-interaction.mdPut key-value pair —
greptime cli meta put key [KEY] --value-stdin [--no-validate]--value-stdin(required): reads raw value bytes from stdin--no-validate: bypasses key/value schema validation before writePut table metadata — two subcommands sharing the
--table-id/--table-nameselector:greptime cli meta put table info --value-stdin— updatesTableInfoValue(JSON from stdin)greptime cli meta put table route --value-stdin— updatesTableRouteValue(JSON from stdin)Examples for
put table infoandput table routeare included. Theput keyusage example was removed as it was not a suitable illustration.Checklist
sidebars.tsmatches the current document structure when you changed the document structure.