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
{{ message }}
This repository was archived by the owner on Mar 21, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: text/0034-telemetry-policies.md
+1-5Lines changed: 1 addition & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,8 +86,6 @@ The collected data is sent to [Segment](https://segment.com/). Segment is a plat
86
86
|`infos.ignore_missing_snapshot`|`true` if `--ignore_missing_snapshot` is specified to true, otherwise `false`| true | Every Hour |
87
87
|`infos.ignore_snapshot_if_db_exists`|`true` if `--ignore_snapshot_if_db_exists` is specified to true, otherwise `false`| true | Every Hour |
88
88
|`infos.http_addr`|`true` if `--http-addr`/`MEILI_HTTP_ADDR` is specified, otherwise `false`| true| Every Hour |
89
-
|`infos.max_index_size`| Value of `--max-index-size`/`MEILI_INDEX_SIZE` in bytes | 336042103 | Every Hour |
90
-
|`infos.max_task_db_size`| Value of `--max-task-db-size`/`MEILI_MAX_TASK_DB_SIZE` in bytes | 336042103 | Every Hour |
91
89
|`infos.http_payload_size_limit`| Value of `--http-payload-size-limit`/`MEILI_HTTP_PAYLOAD_SIZE_LIMIT` in bytes | 336042103 | Every Hour |
92
90
|`infos.disable_auto_batching`|`true` if `--disable-auto-batching`/`MEILI_DISABLE_AUTO_BATCHING` is specified to true, otherwise `false`|`true`| Every Hour |
93
91
|`infos.log_level`| Value of `--log-level`/`MEILI_LOG_LEVEL`| debug | Every Hour |
@@ -173,7 +171,7 @@ The collected data is sent to [Segment](https://segment.com/). Segment is a plat
173
171
|`filtered_by_before_finished_at`|`true` if tasks are filtered by the `beforeFinishedAt` query parameter, otherwise `false`| false |`Tasks Seen`, `Tasks Canceled`, `Tasks Deleted`|
174
172
|`filtered_by_after_finished_at`|`true` if tasks are filtered by the `afterFinishedAt` query parameter, otherwise `false`| false |`Tasks Seen`, `Tasks Canceled`, `Tasks Deleted`|
175
173
|`per_index_uid`|`true` if an uid is used to fetch an index stat resource, otherwise `false`| false |`Stats Seen`|
176
-
|`swap_operation_number`| The number of swap operation given in `POST /swap-indexes` API call | 2 |`Indexes Swapped`|
174
+
|`swap_operation_number`| The number of swap operation given in `POST /swap-indexes` API call | 2 |`Indexes Swapped`|
177
175
|`matching_strategy.most_used_strategy`| Most used word matching strategy among all search requests in this batch |`last`|`Documents Searched POST`, `Documents Searched GET`|
178
176
|`per_document_id`|`true` if `DELETE /indexes/:indexUid/documents/:documentUid` endpoint was used in this batch, otherwise `false`| false |`Documents Deleted`|
179
177
|`clear_all`|`true` if `DELETE /indexes/:indexUid/documents` endpoint was used in this batch, otherwise `false`| false |`Documents Deleted`|
@@ -214,8 +212,6 @@ This property allows us to gather essential information to better understand on
214
212
| infos.ignore_missing_snapshot |`true` if `--ignore-missing-snapshot` is specified to true, otherwise `false`|`true`|
215
213
| infos.ignore_snapshot_if_db_exists |`true` if `--ignore-snapshot-if-db-exists` is specified to true, otherwise `false`|`true`|
216
214
| infos.http_addr |`true` if `--http-addr`/`MEILI_HTTP_ADDR` is specified, otherwise `false`|`true`|
217
-
| infos.max_index_size | Value of `--max-index-size`/`MEILI_INDEX_SIZE` in bytes |`336042103`|
218
-
| infos.max_task_db_size | Value of `--max-task-db-size`/`MEILI_MAX_TASK_DB_SIZE` in bytes |`336042103`|
219
215
| infos.http_payload_size_limit | Value of `--http-payload-size-limit`/`MEILI_HTTP_PAYLOAD_SIZE_LIMIT` in bytes |`336042103`|
220
216
| infos.disable_auto_batching |`true` if `--disable-auto-batching`/`MEILI_DISABLE_AUTO_BATCHING` is specified to true, otherwise `false`|`true`|
221
217
| infos.log_level | Value of `--log-level`/`MEILI_LOG_LEVEL`|`debug`|
Copy file name to clipboardExpand all lines: text/0060-tasks-api.md
+27-31Lines changed: 27 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -534,50 +534,46 @@ HTTP Code: `404 Not Found`
534
534
535
535
- The `:taskUid` is inferred when the message is generated.
536
536
537
-
#### 8. `MEILI_MAX_TASK_DB_SIZE` env var and `--max-task-db-size` CLI option
538
-
539
-
See [0119-instance-options](0119-instance-options.md##3312-max-taskdb-size)
540
-
541
-
#### 9. Asynchronous Write Operations on Index resource
537
+
#### 8. Asynchronous Write Operations on Index resource
542
538
543
539
- 💡 Automatic index creation using the `/indexes/:indexToCreate/documents` route generates a `documentAdditionOrUpdate` task that also handles index creation.
544
540
545
-
#### 10. Paginate `task` resource lists
541
+
#### 9. Paginate `task` resource lists
546
542
547
543
The API endpoint `GET /tasks` is browsable using a keyset-based pagination.
548
544
549
-
##### 10.1. Why a Seek/Keyset based pagination?
545
+
##### 9.1. Why a Seek/Keyset based pagination?
550
546
551
547
Keyset-based pagination is more appropriate when the data can grow or shrink quickly in terms of magnitude.
552
548
553
-
###### 10.1.1. Pros
549
+
###### 9.1.1. Pros
554
550
555
551
The performance is better than the not-so-good but old pagination with `offset`/`limit`.
556
552
557
553
Seek/Keyset pagination keeps the results consistent between each page as the data evolves. It avoids the [Page Drift effect](https://use-the-index-luke.com/sql/partial-results/fetch-next-page), especially when the data is sorted from the most recent to the oldest.
558
554
559
555
Moreover, the performance is superior to traditional pagination since the computational complexity remains constant to reach the identifier marking the beginning of the new slice to be returned from a hash table.
560
556
561
-
###### 10.1.2. Cons
557
+
###### 9.1.2. Cons
562
558
563
559
The main drawback of this type of pagination is that it does not navigate within a finite number of pages. It is also limited to a precise sorting criterion on unique identifiers ordered sequentially.
| next | integer - nullable | Represents the value to send in `from` to fetch the next slice of the results. The first item for the next slice starts at this exact number. When the returned value is null, it means that all the data have been browsed in the given order. |
572
568
573
-
##### 10.3. GET query parameters
569
+
##### 9.3. GET query parameters
574
570
575
571
| field | type | required | description |
576
572
|-------|------|----------|--------------|
577
573
| limit | integer | No | Default `20`. Limit on the number of tasks to be returned. |
578
574
| from | integer | No | Limit results to tasks with uids equal to and lower than this uid. |
579
575
580
-
##### 10.4. Usage examples
576
+
##### 9.4. Usage examples
581
577
582
578
This part demonstrates keyset paging in action on `/tasks`. The items `uid` remains sorted sequentially and can be used to navigate a list of `tasks` objects.
583
579
@@ -666,26 +662,26 @@ This part demonstrates keyset paging in action on `/tasks`. The items `uid` rema
666
662
667
663
- 💡 `next` response parameter is null because there are no more `tasks` to fetch. It means that the response represents the last slice of results for the given resource list.
668
664
669
-
##### 10.5. Behaviors for `limit` and `from` query parameters
665
+
##### 9.5. Behaviors for `limit` and `from` query parameters
670
666
671
-
###### 10.5.1. `limit`
667
+
###### 9.5.1. `limit`
672
668
673
669
- If `limit` is not set, the default value is chosen.
674
670
675
-
###### 10.5.2. `from`
671
+
###### 9.5.2. `from`
676
672
677
673
- If `from` is set with an out of bounds task `uid`, the response returns the tasks that are the nearest to the specified uid, the `next` field is set to the next page. It will be equivalent to call the `/tasks` route without any parameter.
678
674
679
-
###### 10.5.3. Errors
675
+
###### 9.5.3. Errors
680
676
681
677
- 🔴 Sending a value with a different type than `Integer` for `limit` returns a [bad_request](0061-error-format-and-definitions.md#bad_request) error.
682
678
- 🔴 Sending a value with a different type than `Integer` for `from` returns a [bad_request](0061-error-format-and-definitions.md#bad_request) error.
683
679
684
-
#### 11. Filtering task resources
680
+
#### 10. Filtering task resources
685
681
686
682
The tasks API endpoints are filterable by `uids`, `indexUids`, `types`, `statuses`, `canceledBy`, `beforeEnqueuedAt`, `afterEnqueuedAt`, `beforeStartedAt`, `afterStartedAt`, `beforeFinishedAt`, `afterFinishedAt` query parameters.
@@ -701,9 +697,9 @@ The tasks API endpoints are filterable by `uids`, `indexUids`, `types`, `status
701
697
| beforeFinishedAt | string | No | Filter tasks based on their finishedAt time. Retrieve tasks finished before the given filter value. |
702
698
| afterFinishedAt | string | No | Filter tasks based on their finishedAt time. Retrieve tasks finished after the given filter value. |
703
699
704
-
##### 11.2. Query Parameters Behaviors
700
+
##### 10.2. Query Parameters Behaviors
705
701
706
-
###### 11.2.1. `uids`
702
+
###### 10.2.1. `uids`
707
703
708
704
Filter tasks by their related unique identifier. By default, when `uids` query parameter is not set, all the tasks are concerned. It is possible to specify several uid by separating them with the `,` character.
709
705
@@ -715,7 +711,7 @@ The tasks API endpoints are filterable by `uids`, `indexUids`, `types`, `status
715
711
716
712
- 🔴 Sending values with a different type than `Integer` being separated by `,` for the `uid` parameter returns an [`invalid_task_uids_filter`](0061-error-format-and-definitions.md#invalid_task_uids_filter) error.
717
713
718
-
###### 11.2.2. `indexUids`
714
+
###### 10.2.2. `indexUids`
719
715
720
716
Filter tasks by their related index. By default, when `indexUids` query parameter is not set, the tasks of all the indexes are concerned. It is possible to specify several indexUids by separating them with the `,` character.
721
717
@@ -725,7 +721,7 @@ Filter tasks by their related index. By default, when `indexUids` query paramete
725
721
726
722
`indexUids` is **case-sensitive**.
727
723
728
-
###### 11.2.3. `statuses`
724
+
###### 10.2.3. `statuses`
729
725
730
726
Filter tasks by their status. By default, when `statuses` query parameter is not set, all task statuses are concerned. It's possible to specify several statuses by separating them with the `,` character.
731
727
@@ -737,7 +733,7 @@ Filter tasks by their status. By default, when `statuses` query parameter is not
737
733
738
734
- 🔴 If the `statuses` parameter value is not consistent with one of the task statuses, an [`invalid_task_statuses_filter`](0061-error-format-and-definitions.md#invalid_task_statuses_filter) error is returned.
739
735
740
-
###### 11.2.4. `types`
736
+
###### 10.2.4. `types`
741
737
742
738
Filter tasks by their related type. By default, when `types` query parameter is not set, all task types are concerned. It's possible to specify several types by separating them with the `,` character.
743
739
@@ -749,7 +745,7 @@ Filter tasks by their related type. By default, when `types` query parameter is
749
745
750
746
- 🔴 If the `types` parameter value is not consistent with one of the task types, an [`invalid_task_types_filter`](0061-error-format-and-definitions.md#invalid_task_types_filter) error is returned.
751
747
752
-
###### 11.2.5. `canceledBy`
748
+
###### 10.2.5. `canceledBy`
753
749
754
750
Filter tasks by the `taskCancelation` uid that canceled them. It's possible to specify several task uids by separating them with the `,` character.
755
751
@@ -761,15 +757,15 @@ Filter tasks by the `taskCancelation` uid that canceled them. It's possible to s
761
757
762
758
- 🔴Sending a value with a different type than `Integer` for the `canceledBy` parameter returns an [`invalid_task_canceled_by_filter`](0061-error-format-and-definitions.md#invalid_task_canceled_by_filter) error.
763
759
764
-
###### 11.2.6. Date Parameters
760
+
###### 10.2.6. Date Parameters
765
761
766
762
Date filters accepts the RFC 3339 format. The following syntaxes are valid:
767
763
768
764
-`YYYY-MM-DD`
769
765
-`YYYY-MM-DDTHH:MM:SSZ`
770
766
-`YYYY-MM-DDTHH:MM:SS+01:00`
771
767
772
-
###### 11.2.6.1. `beforeEnqueuedAt` and `afterEnqueuedAt`
768
+
###### 10.2.6.1. `beforeEnqueuedAt` and `afterEnqueuedAt`
773
769
774
770
Filter tasks based on their enqueuedAt time. Retrieve tasks enqueued before/after the given filter value.
775
771
@@ -780,7 +776,7 @@ Filter tasks based on their enqueuedAt time. Retrieve tasks enqueued before/afte
780
776
- 🔴 The date filters are exclusive. It means the given value will not be included.
781
777
- 🔴 Sending an invalid value for the date parameter returns an [`invalid_task_date_filter`](0061-error-format-and-definitions.md#invalid_task_date_filter) error.
782
778
783
-
###### 11.2.6.2. `beforeStartedAt` and `afterStartedAt`
779
+
###### 10.2.6.2. `beforeStartedAt` and `afterStartedAt`
784
780
785
781
Filter tasks based on their startedAt time. Retrieve tasks started before/after the given filter value.
786
782
@@ -791,7 +787,7 @@ Filter tasks based on their startedAt time. Retrieve tasks started before/after
791
787
- 🔴 The date filters are exclusive. It means the given value will not be included.
792
788
- 🔴 Sending an invalid value for the date parameter returns an [`invalid_task_date_filter`](0061-error-format-and-definitions.md#invalid_task_date_filter) error.
793
789
794
-
###### 11.2.6.3. `beforeFinishedAt` and `afterFinishedAt`
790
+
###### 10.2.6.3. `beforeFinishedAt` and `afterFinishedAt`
795
791
796
792
Filter tasks based on their finishedAt time. Retrieve tasks finished before/after the given filter value.
797
793
@@ -803,15 +799,15 @@ Filter tasks based on their finishedAt time. Retrieve tasks finished before/afte
803
799
- 🔴 Sending an invalid value for the date parameter returns an [`invalid_task_date_filter`](0061-error-format-and-definitions.md#invalid_task_date_filter) error.
804
800
805
801
806
-
###### 11.2.7. Select multiple values for the same filter
802
+
###### 10.2.7. Select multiple values for the same filter
807
803
808
804
It is possible to specify multiple values for a filter using the `,` character.
809
805
810
806
For example, to select the `enqueued` and `processing` tasks of the `movies` and `movie_reviews` indexes, it is possible to express it like this: `/tasks?indexUids=movies,movie_reviews&statuses=enqueued,processing`
811
807
812
808
---
813
809
814
-
##### 11.3. Usages examples
810
+
##### 10.3. Usages examples
815
811
816
812
This part demonstrates filtering on `/tasks`.
817
813
@@ -986,7 +982,7 @@ This part demonstrates filtering on `/tasks`.
986
982
987
983
---
988
984
989
-
##### 11.4. Empty `results`
985
+
##### 10.4. Empty `results`
990
986
991
987
If no results match the filters. A response is returned with an empty `results` array.
0 commit comments