Skip to content

docs: add RaftEngine store backend support for metadata snapshot operations#2410

Merged
WenyXu merged 3 commits intomainfrom
copilot/update-docs-support-raftengine
Apr 15, 2026
Merged

docs: add RaftEngine store backend support for metadata snapshot operations#2410
WenyXu merged 3 commits intomainfrom
copilot/update-docs-support-raftengine

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 9, 2026

Adds documentation for the new raft-engine-store backend option in CLI metadata snapshot save/restore operations, introduced in GreptimeTeam/greptimedb#7467.

What's Changed in this PR

  • Reference docs (docs/reference/command-lines/utilities/metadata.md + zh): Updated --backend option to include raft-engine-store; updated --store-addrs to document the raftengine:///path/to/metadata URL scheme
  • User guide (back-up-&-restore-meta-data.md + zh): Added RaftEngine export/import examples with a note that the standalone instance must be stopped before export (RaftEngine holds a directory lock)
# Export from RaftEngine (stop standalone first)
greptime cli meta snapshot save \
    --store-addrs "raftengine:///path/to/metadata" \
    --backend raft-engine-store

# Restore to RaftEngine
greptime cli meta snapshot restore \
    --store-addrs "raftengine:///path/to/metadata" \
    --backend raft-engine-store

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.

…ot operations

Agent-Logs-Url: https://github.com/GreptimeTeam/docs/sessions/f925075a-49b5-46db-83ce-8e8cfda95bca

Co-authored-by: fengjiachun <3860496+fengjiachun@users.noreply.github.com>
@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: ff8e8c4
Status: ✅  Deploy successful!
Preview URL: https://f3e3a9dd.greptime-docs.pages.dev
Branch Preview URL: https://copilot-update-docs-support.greptime-docs.pages.dev

View logs

Copilot AI changed the title [WIP] Update docs for RaftEngine store backend in metadata snapshot operations docs: add RaftEngine store backend support for metadata snapshot operations Apr 9, 2026
Copilot AI requested a review from fengjiachun April 9, 2026 21:18
@WenyXu WenyXu marked this pull request as ready for review April 13, 2026 07:11
@WenyXu WenyXu requested a review from killme2008 as a code owner April 13, 2026 07:11
@WenyXu
Copy link
Copy Markdown
Member

WenyXu commented Apr 13, 2026

@copilot please update nightly and v1.0.0 docs

Copy link
Copy Markdown
Member

@killme2008 killme2008 left a comment

Choose a reason for hiding this comment

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

LGTM

@fengjiachun
Copy link
Copy Markdown
Contributor

@codex review

@chatgpt-codex-connector
Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Already looking forward to the next diff.

ℹ️ 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".

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

@WenyXu WenyXu merged commit fbcf10a into main Apr 15, 2026
5 checks passed
@WenyXu WenyXu deleted the copilot/update-docs-support-raftengine branch April 15, 2026 06:15
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(cli): support RaftEngine store backend for metadata snapshot operations

4 participants