From 91e5da2356563a3f14c24cadd38c44fa67466cc3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Renault?= Date: Wed, 9 Oct 2024 10:32:18 +0200 Subject: [PATCH] Clarify the usage of the extraction command --- meilitool/src/main.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/meilitool/src/main.rs b/meilitool/src/main.rs index faf18bd6e..c94ff19da 100644 --- a/meilitool/src/main.rs +++ b/meilitool/src/main.rs @@ -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)]