Clarify the usage of the extraction command

This commit is contained in:
Clément Renault 2024-10-09 10:32:18 +02:00
parent 3f0fe54025
commit 91e5da2356
No known key found for this signature in database
GPG Key ID: F250A4C4E3AE5F5F

View File

@ -64,7 +64,10 @@ enum Command {
skip_enqueued_tasks: bool,
},
/// Exports the documents of an index from the Meilisearch database to stdout.
/// Exports the documents of an index in NDJSON format from a Meilisearch index to stdout.
///
/// This command can be executed on a running Meilisearch database. However, please note that
/// it will maintain a read-only transaction for the duration of the extraction process.
ExportDocuments {
/// The index name to export the documents from.
#[arg(long)]