Module meilisearch_sdk::dumps

source ·
Expand description

Module containing the dumps trait. The dumps module allows the creation of database dumps.

  • Dumps are .dump files that can be used to launch Meilisearch.

  • Dumps are compatible between Meilisearch versions.

  • Creating a dump is also referred to as exporting it, whereas launching Meilisearch with a dump is referred to as importing it.

  • During a dump export, all indexes of the current instance are exported—together with their documents and settings—and saved as a single .dump file.

  • During a dump import, all indexes contained in the indicated .dump file are imported along with their associated documents and settings. Any existing index with the same uid as an index in the dump file will be overwritten.

  • Dump imports are performed at launch using an option.

§Example


// Create a dump
let task_info = client.create_dump().await.unwrap();
assert!(matches!(
    task_info,
    TaskInfo {
        update_type: TaskType::DumpCreation { .. },
        ..
    }
));

Functions§