Skip to content

Commit b7d0125

Browse files
clarify exporting data into existing indexes
1 parent 62064e2 commit b7d0125

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

reference/api/export.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Use the `/export` route to transfer data from your origin instance to a remote t
1515

1616
Migrate data from the origin instance to a target instance.
1717

18+
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.
19+
1820
### Body
1921

2022
| Name | Type | Default value | Description |
@@ -32,7 +34,7 @@ This field is required.
3234

3335
#### `apiKey`
3436

35-
A security key with full admin permissions to a secured Meilisearch instance.
37+
A security key with `index.create`, `settings.update`, and `documents.add` permissions to a secured Meilisearch instance.
3638

3739
#### `payloadSize`
3840

@@ -42,10 +44,12 @@ The maximum size of each single data payload in a human-readable format such as
4244

4345
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.
4446

47+
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.
48+
4549
Each index object accepts the following fields:
4650

4751
- `filter`: a [filter expression](/learn/filtering_and_sorting/filter_expression_reference) defining the subset of documents to export. Optional, defaults to `null`
48-
- `overrideSettings`: if `false`, uses the index settings as configured in the origin instance. if `true`, uses the target instance settings. Optional, defaults to `false`.
52+
- `overrideSettings`: if `true`, configures indexes in the target instance with the origin instance settings. Optional, defaults to `false`
4953

5054
### Example
5155

0 commit comments

Comments
 (0)