jedarden adab169bed docs(miroir-ctl): add subcommand runbooks and help text (P11.4, miroir-uyx.4)

- Created docs/ctl/*.md runbooks for all 16 miroir-ctl subcommands
- Each runbook includes: purpose, preconditions, examples, gotchas, see also
- Added runbook location to --help output
- All runbooks under 50 lines for easy reading

Closes: miroir-uyx.4

2026-05-24 11:47:36 -04:00

1.3 KiB

Raw Blame History

`miroir-ctl dump`

Purpose

Export and import index data for backup, migration, or bulk loading.

Preconditions

For export: index must exist and be healthy
For import: target index must exist with matching schema

Examples

# Export an index to a compressed dump file
miroir-ctl dump export --index myindex --output myindex.dump

# Export with chunking (for large indexes)
miroir-ctl dump export --index myindex --output myindex.dump --chunk-size 10000

# Import a dump file
miroir-ctl dump import --input myindex.dump --index myindex

# Import with throttling (limit write rate)
miroir-ctl dump import --input myindex.dump --index myindex --throttle 5000

# Verify dump integrity without importing
miroir-ctl dump verify --input myindex.dump

Gotchas

Export creates a compressed archive — includes documents, settings, and tasks
Import is idempotent — running twice won't duplicate documents (PK-based upsert)
Large dumps are chunked automatically — use --chunk-size to control memory usage
Import bypasses the write path's sharding layer — writes directly to target shards
Use miroir-ctl task status to track async import jobs

1.3 KiB Raw Blame History

miroir-ctl dump

Purpose

Preconditions

Examples

Gotchas

See also

1.3 KiB

Raw Blame History

`miroir-ctl dump`