Skip to content

Commit 157a893

Browse files
bors[bot]guimachiavellimaryamsulemani97
authored
Merge #2110 #2111
2110: v1.0: Remove mentions of `--disable-auto-batching` r=guimachiavelli a=guimachiavelli Closes #2085 Additionally, this PR also changes the wording of the `GET` documents endpoint so it doesn't use the word "batch" to keep our terminology consistent. 2111: v1.0: update to add `*` for date filters in task api r=guimachiavelli a=maryamsulemani97 closes #2109 Co-authored-by: gui machiavelli <hey@guimachiavelli.com> Co-authored-by: maryamsulemani97 <maryam@meilisearch.com>
3 parents 0d9048e + 6a94a54 + ca9e547 commit 157a893

File tree

6 files changed

+27
-43
lines changed

6 files changed

+27
-43
lines changed

‎learn/configuration/instance_options.md‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -204,19 +204,6 @@ If you do not supply a master key in `production` or `development` environments
204204

205205
[Learn more about Meilisearch's use of security keys.](/learn/security/master_api_keys.md)
206206

207-
### Disable auto-batching
208-
209-
::: warning
210-
🚩 This option does not take any values. Assigning a value will throw an error. 🚩
211-
:::
212-
213-
**Environment variable**: `MEILI_DISABLE_AUTO_BATCHING`
214-
**CLI option**: `--disable-auto-batching`
215-
216-
Deactivates auto-batching when provided.
217-
218-
[Learn more about auto-batching.](/learn/core_concepts/documents.md#auto-batching)
219-
220207
### Disable analytics
221208

222209
::: warning

‎learn/core_concepts/documents.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,6 @@ Tasks within the same batch share the same values for `startedAt`, `finishedAt`,
139139

140140
If a task fails due to an invalid document, it will be removed from the batch. The rest of the batch will still process normally. If an [`internal`](/reference/errors/overview.md#errors) error occurs, the whole batch will fail and all tasks within it will share the same `error` object.
141141

142-
You can deactivate auto-batching using the `--disable-auto-batching` command-line flag or the `MEILI_DISABLE_AUTO_BATCHING` environment variable. This is useful in cases where you want to avoid any potential bugs in the feature or reduce visibility latency. When auto-batching is disabled, the whole queue takes longer to process, but each individual task will be processed earlier (until a certain number of processed tasks).
143-
144142
#### Auto-batching and task cancelation
145143

146144
If the task you’re canceling is part of a batch, Meilisearch interrupts the whole process, discards all progress, and cancels that task. Then, it automatically creates a new batch without the canceled task and immediately starts processing it.

‎learn/getting_started/quick_start.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ The previous command added documents from `movies.json` to a new index called `m
191191

192192
Every index must have a [primary key](/learn/core_concepts/primary_key.md#primary-field), an attribute shared across all documents in that index. If you try adding documents to an index and even a single one is missing the primary key, none of the documents will be stored.
193193

194-
By default, Meilisearch combines consecutive document requests into a single batch and processes them together. This process is called [auto-batching](/learn/core_concepts/documents.md#auto-batching), and it significantly speeds up indexing. After adding documents, you should receive a response like this:
194+
Meilisearch combines consecutive document requests into a single batch and processes them together. This process is called [auto-batching](/learn/core_concepts/documents.md#auto-batching), and it significantly speeds up indexing. After adding documents, you should receive a response like this:
195195

196196
```json
197197
{
@@ -203,7 +203,7 @@ By default, Meilisearch combines consecutive document requests into a single bat
203203
}
204204
```
205205

206-
Most database operations in Meilisearch are [asynchronous](/learn/advanced/asynchronous_operations.md). This means that rather than being processed instantly, **API requests are added to a queue and processed one at a time**.
206+
Most database operations in Meilisearch are [asynchronous](/learn/advanced/asynchronous_operations.md). This means that rather than being processed instantly, **API requests are added to a queue and processed at a later time**.
207207

208208
Use the returned `taskUid` to [check the status](/reference/api/tasks.md) of your documents:
209209

‎learn/what_is_meilisearch/telemetry.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,6 @@ This list is liable to change with every new version of Meilisearch. It's not be
202202
| `synonyms.total` | Number of synonyms | 3
203203
| `per_index_uid` | `true` if the `uid` is used to fetch an index stat resource, otherwise `false` | false
204204
| `matching_strategy.most_used_strategy` | Most used word matching strategy | last
205-
| `infos.disable_auto_batching` | `true` if `--disable-auto-batching`/`MEILI_DISABLE_AUTO_BATCHING` is specified, otherwise `false` | true
206205
| `infos.with_configuration_file` | `true` if the instance is launched with a configuration file, otherwise `false` | false
207206
| `swap_operation_number` | Number of swap operations | 2
208207
| `pagination.most_used_navigation` | Most used search results navigation | estimated

‎reference/api/documents.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The `/documents` route allows you to create, manage, and delete documents.
88

99
<RouteHighlighter method="GET" route="/indexes/{index_uid}/documents"/>
1010

11-
Get documents by batch.
11+
Get a set of documents.
1212

1313
Using the query parameters `offset` and `limit`, you can browse through all your documents.
1414

‎reference/api/tasks.md‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -211,21 +211,21 @@ Task results are [paginated](/learn/advanced/asynchronous_operations.md#paginati
211211

212212
### Query parameters
213213

214-
| Query Parameter | Default Value | Description |
215-
| :--------------------- | :----------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
216-
| **`limit`** | `20` | Number of tasks to return |
217-
| **`from`** | `uid` of the last created task | `uid` of the first task returned |
218-
| **`uids`** | `*` (all uids) | [Filter tasks](/learn/advanced/asynchronous_operations.md#filtering-tasks) by their `uid`. Separate multiple task `uids` with a comma (`,`) |
219-
| **`statuses`** | `*` (all statuses) | [Filter tasks](/learn/advanced/asynchronous_operations.md#filtering-tasks) by their `status`. Separate multiple task `statuses` with a comma (`,`) |
220-
| **`types`** | `*` (all types) | [Filter tasks](/learn/advanced/asynchronous_operations.md#filtering-tasks) by their `type`. Separate multiple task `types` with a comma (`,`) |
214+
| Query Parameter | Default Value | Description |
215+
| :--------------------- | :----------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
216+
| **`limit`** | `20` | Number of tasks to return |
217+
| **`from`** | `uid` of the last created task | `uid` of the first task returned |
218+
| **`uids`** | `*` (all uids) | [Filter tasks](/learn/advanced/asynchronous_operations.md#filtering-tasks) by their `uid`. Separate multiple task `uids` with a comma (`,`) |
219+
| **`statuses`** | `*` (all statuses) | [Filter tasks](/learn/advanced/asynchronous_operations.md#filtering-tasks) by their `status`. Separate multiple task `statuses` with a comma (`,`) |
220+
| **`types`** | `*` (all types) | [Filter tasks](/learn/advanced/asynchronous_operations.md#filtering-tasks) by their `type`. Separate multiple task `types` with a comma (`,`) |
221221
| **`indexUids`** | `*` (all indexes) | [Filter tasks](/learn/advanced/asynchronous_operations.md#filtering-tasks) by their `indexUid`. Separate multiple task `indexUids` with a comma (`,`). Case-sensitive |
222-
| **`canceledBy`** | N/A | [Filter tasks](/learn/advanced/asynchronous_operations.md#filter-by-canceledby) by their `canceledBy` field. Separate multiple task `uids` with a comma (`,`) |
223-
| **`beforeEnqueuedAt`** | N/A | [Filter tasks](/learn/advanced/asynchronous_operations.md#filter-by-date) by their `enqueuedAt` field |
224-
| **`beforeStartedAt`** | N/A | [Filter tasks](/learn/advanced/asynchronous_operations.md#filter-by-date) by their `startedAt` field |
225-
| **`beforeFinishedAt`** | N/A | [Filter tasks](/learn/advanced/asynchronous_operations.md#filter-by-date) by their `finishedAt` field |
226-
| **`afterEnqueuedAt`** | N/A | [Filter tasks](/learn/advanced/asynchronous_operations.md#filter-by-date) by their `enqueuedAt` field |
227-
| **`afterStartedAt`** | N/A | [Filter tasks](/learn/advanced/asynchronous_operations.md#filter-by-date) by their `startedAt` field |
228-
| **`afterFinishedAt`** | N/A | [Filter tasks](/learn/advanced/asynchronous_operations.md#filter-by-date) by their `finishedAt` field |
222+
| **`canceledBy`** | N/A | [Filter tasks](/learn/advanced/asynchronous_operations.md#filter-by-canceledby) by their `canceledBy` field. Separate multiple task `uids` with a comma (`,`) |
223+
| **`beforeEnqueuedAt`** | `*` (all tasks) | [Filter tasks](/learn/advanced/asynchronous_operations.md#filter-by-date) by their `enqueuedAt` field |
224+
| **`beforeStartedAt`** | `*` (all tasks) | [Filter tasks](/learn/advanced/asynchronous_operations.md#filter-by-date) by their `startedAt` field |
225+
| **`beforeFinishedAt`** | `*` (all tasks) | [Filter tasks](/learn/advanced/asynchronous_operations.md#filter-by-date) by their `finishedAt` field |
226+
| **`afterEnqueuedAt`** | `*` (all tasks) | [Filter tasks](/learn/advanced/asynchronous_operations.md#filter-by-date) by their `enqueuedAt` field |
227+
| **`afterStartedAt`** | `*` (all tasks) | [Filter tasks](/learn/advanced/asynchronous_operations.md#filter-by-date) by their `startedAt` field |
228+
| **`afterFinishedAt`** | `*` (all tasks) | [Filter tasks](/learn/advanced/asynchronous_operations.md#filter-by-date) by their `finishedAt` field |
229229

230230
### Response
231231

@@ -357,10 +357,10 @@ A valid `uids`, `statuses`, `types`, `indexUids`, or date(`beforeXAt` or `afterX
357357
| **`statuses`** | Cancel tasks based on `status`. Separate multiple `statuses` with a comma (`,`). Use `statuses=*` for all `statuses` |
358358
| **`types`** | Cancel tasks based on `type`. Separate multiple `types` with a comma (`,`). Use `types=*` for all `types` |
359359
| **`indexUids`** | Cancel tasks based on `indexUid`. Separate multiple `uids` with a comma (`,`). Use `indexUids=*` for all `indexUids`. Case-sensitive |
360-
| **`beforeEnqueuedAt`** | Cancel tasks **before** a specified `enqueuedAt` date |
361-
| **`beforeStartedAt`** | Cancel tasks **before** a specified `startedAt` date |
362-
| **`afterEnqueuedAt`** | Cancel tasks **after** a specified `enqueuedAt` date |
363-
| **`afterStartedAt`** | Cancel tasks **after** a specified `startedAt` date |
360+
| **`beforeEnqueuedAt`** | Cancel tasks **before** a specified `enqueuedAt` date. Use `beforeEnqueuedAt=*` to cancel all tasks |
361+
| **`beforeStartedAt`** | Cancel tasks **before** a specified `startedAt` date. Use `beforeStartedAt=*` to cancel all tasks |
362+
| **`afterEnqueuedAt`** | Cancel tasks **after** a specified `enqueuedAt` date. Use `afterEnqueuedAt=*` to cancel all tasks |
363+
| **`afterStartedAt`** | Cancel tasks **after** a specified `startedAt` date. Use `afterStartedAt=*` fto cancel all tasks |
364364

365365
::: note
366366
Date filters are equivalent to `<` or `>` operations. At this time, there is no way to perform a `≤` or `≥` operations with a date filter.
@@ -419,12 +419,12 @@ A valid `uids`, `statuses`, `types`, `indexUids`, `canceledBy`, or date(`beforeX
419419
| **`types`** | Delete tasks based on `type`. Separate multiple `types` with a comma (`,`). Use `types=*` for all `types` |
420420
| **`indexUids`** | Delete tasks based on `indexUid`. Separate multiple `uids` with a comma (`,`). Use `indexUids=*` for all `indexUids`. Case-sensitive |
421421
| **`canceledBy`** | Delete tasks based on the `canceledBy` field |
422-
| **`beforeEnqueuedAt`** | Delete tasks **before** a specified `enqueuedAt` date |
423-
| **`beforeStartedAt`** | Delete tasks **before** a specified `startedAt` date |
424-
| **`beforeFinishedAt`** | Delete tasks **before** a specified `finishedAt` date |
425-
| **`afterEnqueuedAt`** | Delete tasks **after** a specified `enqueuedAt` date |
426-
| **`afterStartedAt`** | Delete tasks **after** a specified `startedAt` date |
427-
| **`afterFinishedAt`** | Delete tasks **after** a specified `finishedAt` date |
422+
| **`beforeEnqueuedAt`** | Delete tasks **before** a specified `enqueuedAt` date. Use `beforeEnqueuedAt=*` to delete all tasks |
423+
| **`beforeStartedAt`** | Delete tasks **before** a specified `startedAt` date. Use `beforeStartedAt=*` to delete all tasks |
424+
| **`beforeFinishedAt`** | Delete tasks **before** a specified `finishedAt` date. Use `beforeFinishedAt=*` to delete all tasks |
425+
| **`afterEnqueuedAt`** | Delete tasks **after** a specified `enqueuedAt` date. Use `afterEnqueuedAt=*` to delete all tasks |
426+
| **`afterStartedAt`** | Delete tasks **after** a specified `startedAt` date. Use `afterStartedAt=*` to delete all tasks |
427+
| **`afterFinishedAt`** | Delete tasks **after** a specified `finishedAt` date. Use `afterFinishedAt=*` to delete all tasks |
428428

429429
::: note
430430
Date filters are equivalent to `<` or `>` operations. At this time, there is no way to perform a `≤` or `≥` operations with a date filter.

0 commit comments

Comments
 (0)