Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/remove-all-task-batch-list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@meilisearch/cli": minor
---

**Breaking:** Remove `--all` from `meili task list` and `meili batch list`: an instance can hold millions of tasks. Page with `--limit` and `--from` instead: pass the `next` of each response as the `--from` of the next call, and stop when `next` is `null`. ([#87](https://github.com/meilisearch/cli/pull/87))
2 changes: 1 addition & 1 deletion docs/contract/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Commands reuse these groups. A command that matches a group uses the whole group
|---|---|
| `--limit <n>` | Passed to the API. |
| `--offset <n>` or `--from <uid>` | Passed to the API. The name is the API parameter name for that route. |
| `--all` | Fetch every page, and print them as one list. `document list` has no `--all`: an index can hold millions of documents. On `document delete`, select the route that deletes every document. |
| `--all` | Fetch every page, and print them as one list. `document list`, `task list` and `batch list` have no `--all`: an index can hold millions of documents, and an instance millions of tasks and batches. On `document delete`, select the route that deletes every document. |

**Body input** (commands that send a JSON body):

Expand Down
2 changes: 1 addition & 1 deletion docs/contract/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ Destructive commands are the commands of the verb `delete`, as `commands.md` der
## Pagination

- `--limit` and `--offset` (or `--from` for tasks and batches) are passed to the API unchanged.
- `--all` follows the API pagination until the end. The CLI returns the envelope of the last page, with `results` replaced by the full list and without the fields that describe one page: `limit` and `offset`, or `limit` and `from` on the routes that page with a cursor.
- `--all` follows the API pagination until the end. The CLI returns the envelope of the last page, with `results` replaced by the full list and without the fields that describe one page: `limit` and `offset`. Tasks and batches have no `--all`: an instance can hold millions of them.
- The list commands of the Management API do not offer these flags yet. The Management API numbers its pages instead of counting an offset, and the flags wait until the two APIs page the same way. Each command prints the first page as the API sends it, envelope included.

## Help
Expand Down
Loading
Loading