188fd5404c
Enumerates dump variants that streaming mode can/can't handle. - Added docs/dump-import/compatibility-matrix.md with comprehensive compatibility matrix covering Meilisearch versions, dump variants, and workarounds - Added docs/dump-import/README.md as entry point - Updated miroir-ctl dump command to reference matrix with helpful error messages for unimplemented subcommands (import, export, analyze) Addresses Open Problem #5: identifies what "can't reconstruct" means in concrete terms, giving operators clear guidance on when broadcast fallback is needed and what alternatives exist. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
41 lines
1.5 KiB
Markdown
41 lines
1.5 KiB
Markdown
# Dump Import Documentation
|
|
|
|
This directory contains documentation for Miroir's dump import functionality, including compatibility information and operational guidance.
|
|
|
|
## Overview
|
|
|
|
Miroir supports two dump import modes:
|
|
|
|
1. **Streaming Mode (Recommended)**: Routes documents per-shard via the public API. Efficient storage distribution, scales horizontally.
|
|
2. **Broadcast Mode (Legacy)**: Sends all documents to all nodes. Requires post-import rebalance. Used as fallback for incompatible dump variants.
|
|
|
|
## Documents
|
|
|
|
- **[compatibility-matrix.md](./compatibility-matrix.md)**: Comprehensive matrix of dump variants, streaming compatibility, and workarounds
|
|
|
|
## Quick Reference
|
|
|
|
```bash
|
|
# Import a dump (streaming mode by default)
|
|
miroir-ctl dump import --file products.dump --index products
|
|
|
|
# Force broadcast mode
|
|
miroir-ctl dump import --file products.dump --index products --mode broadcast
|
|
|
|
# Analyze a dump for compatibility
|
|
miroir-ctl dump analyze --file products.dump
|
|
```
|
|
|
|
## Related Plan Sections
|
|
|
|
- [Plan §13.9: Streaming routed dump import](../plan/plan.md#139-streaming-routed-dump-import)
|
|
- [Plan §13.5: Two-phase settings broadcast](../plan/plan.md#135-two-phase-settings-broadcast)
|
|
|
|
## Enhancement Tracking
|
|
|
|
| Bead | Description | Status |
|
|
|------|-------------|--------|
|
|
| `miroir-zc2.5` | Dump import compatibility matrix | Complete |
|
|
| `miroir-zc2.6` | Configurable shard metadata field name | Open |
|
|
| `miroir-zc2.7` | Pre-import validation and field conflict detection | Open |
|
|
| `miroir-zc2.8` | EE-to-CE dump conversion tool | Open |
|