You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: learn/advanced/asynchronous_operations.md
+5-8Lines changed: 5 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -10,9 +10,6 @@ For example, updating the `filterableAttributes` index setting will require as m
10
10
11
11
Currently, these are Meilisearch's asynchronous operations:
12
12
13
-
- Updating index settings
14
-
- Adding documents to an index
15
-
- Updating documents in an index
16
13
- Creating an index
17
14
- Updating an index
18
15
- Deleting an index
@@ -24,9 +21,9 @@ Currently, these are Meilisearch's asynchronous operations:
24
21
25
22
## Understanding tasks
26
23
27
-
Most of Meilisearch's asynchronous operations belong to a category called "tasks". After you have requested an asynchronous operation, you can use the [task API](/reference/api/tasks.md) to find the detailed status of your request. To do so, you will need the task's unique identifier.
24
+
At this time, all of Meilisearch's asynchronous operations belong to a category called "tasks". After you have requested an asynchronous operation, you can use the [task API](/reference/api/tasks.md) to find the detailed status of your request. To do so, you will need the task's unique identifier.
28
25
29
-
### Response
26
+
### Task API response
30
27
31
28
The response from the [task API](/reference/api/tasks.md) will always include the following fields in the stated order:
32
29
@@ -137,7 +134,7 @@ Had the task failed, the response would have included an `error` object:
137
134
138
135
## Task workflow
139
136
140
-
1. When you make a task request, Meilisearch puts it in the task queue, sets the task's `status` to `enqueued` and returns a [`task` object](/learn/advanced/asynchronous_operations.md#response)
137
+
1. When you make an [asynchronous request](#which-operations-are-async), Meilisearch puts it in the task queue, sets the task's `status` to `enqueued` and returns a [summarized `task` object](/learn/advanced/asynchronous_operations.md#summarized-task-objects)
141
138
2. When your task reaches the front of the queue, Meilisearch begins working on it and changes the request `status` to `processing`
142
139
3. Once the task has completed processing, Meilisearch marks it as `succeeded`, if it was successful, or `failed`, if there was an error.
143
140
4. Tasks marked as `succeeded` or `failed` are not deleted and will remain visible in [the task list](/reference/api/tasks.md#get-tasks)
@@ -156,8 +153,8 @@ Meilisearch's asynchronous tasks are atomic. This means that all operations conc
156
153
157
154
What happens to an asynchronous operation when Meilisearch is terminated changes depending on the request's `status`:
158
155
159
-
-`enqueued`: the task will remain enqueued and will be processed as usual once is restarted
160
-
-`processing`: there will be no consequences, since no part of the task has been committed to the database. After restarting, will treat the task as `enqueued`
156
+
-`enqueued`: the task will remain enqueued and will be processed as usual once Meilisearch has been restarted
157
+
-`processing`: there will be no consequences, since no part of the task has been committed to the database. After restarting, the task will be treated as `enqueued`
161
158
-`succeeded`: there will be no data loss since the request was successfully completed
162
159
-`failed`: the task failed and nothing has been altered in the database
0 commit comments