v1.16: /export route (#3315)

* add `/export` route

* Update code samples [skip ci]

* Apply suggestions from code review

Co-authored-by: Clément Renault <[email protected]>

* Update code samples [skip ci]

* clarify exporting data into existing indexes

* Update reference/api/export.mdx

Co-authored-by: Clément Renault <[email protected]>

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Clément Renault <[email protected]>

Author: 3 people

.code-samples.meilisearch.yaml

@@ -1467,6 +1467,18 @@ related_results_similar_1: |-
       "id": 192,
       "embedder": "EMBEDDER_NAME"
     }'
+export_post_1: |-
+  curl \
+    -X POST 'MEILISEARCH_URL/export' \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+      "url": "TARGET_INSTANCE_URL",
+      "indexes": {
+        "*": {
+          "overrideSettings": true
+        }
+      }
+    }'
 
 ### Code samples for experimental features
 experimental_get_metrics_1: |-

docs.json

@@ -349,7 +349,8 @@
                   "reference/api/dump",
                   "reference/api/experimental_features",
                   "reference/api/metrics",
-                  "reference/api/logs"
+                  "reference/api/logs",
+                  "reference/api/export"
                 ]
               },
               {

reference/api/export.mdx

@@ -0,0 +1,68 @@
+---
+title: Export
+description: "Migrate between instances with the `/export` route"
+---
+
+import { RouteHighlighter } from '/snippets/route_highlighter.mdx'
+
+import CodeSamplesExperimentalDeleteLogsStream1 from '/snippets/samples/code_samples_experimental_delete_logs_stream_1.mdx';
+
+Use the `/export` route to transfer data from your origin instance to a remote target instance. This is particularly useful when migrating from your local development environment to a Meilisearch Cloud instance.
+
+## Migrate database between instances
+
+<RouteHighlighter method="POST" path="/export" />
+
+Migrate data from the origin instance to a target instance.
+
+Migration is an additive operation. If the exported indexes already exist in the target instance, Meilisearch keeps the existing documents intact and adds the new data to the index. If the same document is present in both the target and origin, Meilisearch replaces the target documents with the new data.
+
+### Body
+
+| Name                | Type   | Default value | Description                                                                                               |
+| ------------------- | ------ | ------------- | --------------------------------------------------------------------------------------------------------- |
+| **`url`** *         | String | `null`        | The target instance's URL address. Required                                                               |
+| **`apiKey`** *      | String | `null`        | An API key with full admin access to the target instance                                                  |
+| **`payloadSize`** * | String | "50 MiB"      | A string specifying the payload size in a human-readable format                                           |
+| **`indexes`** *     | Object | `null`        | A set of patterns matching the indexes you want to export. Defaults to all indexes in the origin instance |
+
+#### `url`
+
+A string pointing to a remote Meilisearch instance, including its port if necessary.
+
+This field is required.
+
+#### `apiKey`
+
+A security key with `index.create`, `settings.update`, and `documents.add` permissions to a secured Meilisearch instance.
+
+#### `payloadSize`
+
+The maximum size of each single data payload in a human-readable format such as `"100MiB"`. Larger payloads are generally more efficient, but require significantly more powerful machines.
+
+#### `indexes`
+
+A set of objects whose keys correspond to patterns matching the indexes you want to export. By default, Meilisearch exports all documents across all indexes.
+
+Meilisearch does not override any index settings by default. If the target instance contains an index with the same name as an index you're exporting, Meilisearch uses the settings in the target instance. If the index does not already exist in the target instance, Meilisearch uses the settings in the origin instance.
+
+Each index object accepts the following fields:
+
+- `filter`: a [filter expression](/learn/filtering_and_sorting/filter_expression_reference) defining the subset of documents to export. Optional, defaults to `null`
+- `overrideSettings`: if `true`, configures indexes in the target instance with the origin instance settings. Optional, defaults to `false`
+
+### Example
+
+<CodeSamplesExportPost1 />
+
+#### Response
+
+```json
+{
+  "taskUid": 2,
+  "indexUid": null,
+  "status": "enqueued",
+  "type": "export",
+  "enqueuedAt": "2025-06-26T12:54:10.785864Z"
+}
+```

reference/errors/error_codes.mdx

@@ -192,6 +192,26 @@ This error occurs if:
 
 The provided `_geo` field of one or more documents is invalid. Meilisearch expects `_geo` to be an object with two fields, `lat` and `lng`, each containing geographic coordinates expressed as a string or floating point number. Read more about `_geo` and how to troubleshoot it in [our dedicated guide](/learn/filtering_and_sorting/geosearch).
 
+## `invalid_export_url`
+
+The export target instance URL is invalid or could not be reached.
+
+## `invalid_export_api_key`
+
+The supplied security key does not have the required permissions to access the target instance.
+
+## `invalid_export_payload_size`
+
+The provided payload size is invalid. The payload size must be a string indicating the maximum payload size in a human-readable format.
+
+## `invalid_export_indexes_patterns`
+
+The provided index pattern is invalid. The index pattern must be an alphanumeric string, optionally including a wildcard.
+
+## `invalid_export_index_filter`
+
+The provided index export filter is not a valid [filter expression](/learn/filtering_and_sorting/filter_expression_reference).
+
 ## `invalid_facet_search_facet_name`
 
 The attribute used for the `facetName` field is either not a string or not defined in the [`filterableAttributes` list](/reference/api/settings#filterable-attributes).

snippets/samples/code_samples_async_guide_filter_by_statuses_2.mdx

@@ -1,5 +1,14 @@
 <CodeGroup>
 
+```rust Rust
+let mut query = TasksQuery::new(&client);
+let tasks = query
+  .with_statuses(["failed", "canceled"])
+  .execute()
+  .await
+  .unwrap();
+```
+
 ```rust Rust
 let mut query = TasksQuery::new(&client);
 let tasks = query

snippets/samples/code_samples_basic_security_tutorial_admin_1.mdx

@@ -1,5 +1,13 @@
 <CodeGroup>
 
+```rust Rust
+let client = Client::new("http://localhost:7700", Some("DEFAULT_ADMIN_API_KEY"));
+let task = client
+  .create_index("medical_records", Some("id"))
+  .await
+  .unwrap();
+```
+
 ```rust Rust
 let client = Client::new("http://localhost:7700", Some("DEFAULT_ADMIN_API_KEY"));
 let task = client

snippets/samples/code_samples_basic_security_tutorial_listing_1.mdx

@@ -1,5 +1,13 @@
 <CodeGroup>
 
+```rust Rust
+let client = Client::new("http://localhost:7700", Some("MASTER_KEY"));
+client
+  .get_keys()
+  .await
+  .unwrap();
+```
+
 ```rust Rust
 let client = Client::new("http://localhost:7700", Some("MASTER_KEY"));
 client

snippets/samples/code_samples_basic_security_tutorial_search_1.mdx

@@ -1,5 +1,16 @@
 <CodeGroup>
 
+```rust Rust
+let client = Client::new("http://localhost:7700", Some("DEFAULT_SEARCH_API_KEY"));
+let index = client.index("medical_records");
+index
+  .search()
+  .with_query("appointments")
+  .execute::<MedicalRecord>()
+  .await
+  .unwrap();
+```
+
 ```rust Rust
 let client = Client::new("http://localhost:7700", Some("DEFAULT_SEARCH_API_KEY"));
 let index = client.index("medical_records");

snippets/samples/code_samples_index_settings_tutorial_api_get_setting_1.mdx

@@ -1,5 +1,12 @@
 <CodeGroup>
 
+```rust Rust
+let searchable_attributes: Vec<String> = index
+  .get_searchable_attributes()
+  .await
+  .unwrap();
+```
+
 ```rust Rust
 let searchable_attributes: Vec<String> = index
   .get_searchable_attributes()

snippets/samples/code_samples_index_settings_tutorial_api_put_setting_1.mdx

@@ -1,5 +1,12 @@
 <CodeGroup>
 
+```rust Rust
+let task = index
+  .set_searchable_attributes(["title", "overview"])
+  .await
+  .unwrap();
+```
+
 ```rust Rust
 let task = index
   .set_searchable_attributes(["title", "overview"])