Skip to content

Commit c13f1e4

Browse files
authored
Clarify file splitting on export (#1738)
1 parent d33ff2a commit c13f1e4

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

app/views/pages/developer-guide/data-import-export/export.liquid

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ platformOS CLI provides the `pos-cli data export --zip` command. Options:
1313

1414
- --path (short: -p): A file path to a JSON file which will be created by the CLI and where the exported data is stored.
1515
- --export-internal-ids: By default, export will use the autogenerated `external_id` for the `id` field. When this option is set, it will use the normal `id` from the object.
16+
- Note that records files will be split into multiple files if they exceed 10,000 records. For example, if you have 20,000 users, you will get 2 files: `users.0.csv` and `users.1.csv`.
1617

1718
Under the hood, the CLI uses the export API that's described in the next section. However, using the CLI provides some major benefits:
1819

@@ -52,6 +53,7 @@ mutation create_data_export(
5253
```
5354

5455
Please note that you can specify the filters, that will be taken into consideration and only data matching the filters will be included in the CSV files.
56+
Also note that records files will be split into multiple files if they exceed 10,000 records. For example, if you have 20,000 users, you will get 2 files: `users.0.csv` and `users.1.csv`.
5557

5658
### Encrypting data using GPG
5759

0 commit comments

Comments
 (0)