Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

Commit

Permalink
Add a Triggering Documents Re-Indexing technical section
Browse files Browse the repository at this point in the history
  • Loading branch information
gmourier committed Mar 7, 2022
1 parent b0a09a0 commit 1592a0c
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions text/0123-settings-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ N/A

Each setting is exposed as a sub-resource of the `indexes/:index_uid/settings` endpoints. e.g. The ranking rules setting of a Meilisearch index is exposed at `indexes/:index_uid/settings/ranking-rules`.

Some setting changes cause a complete re-indexing of the documents. See [4.1. Triggering Documents Re-indexing](#41-triggering-documents-re-indexing).

### 3.2. API Endpoints Definition

Manipulate all settings of a Meilisearch index.
Expand Down Expand Up @@ -65,7 +67,7 @@ Modify the settings of a Meilisearch index.
| `searchableAttributes` | Array of String / `null` | false |
| `filterableAttributes` | Array of String / `null` | false |
| `sortableAttributes` | Array of String / `null` | false |
| `rankingRules` | Array of String | false |
| `rankingRules` | Array of String / `null` | false |
| `stopWords` | Array of String / `null` | false |
| `synonyms` | Object / `null` | false |
| `distinctAttribute` | String / `null` | false |
Expand Down Expand Up @@ -130,7 +132,18 @@ The auth layer can return the following errors if Meilisearch is secured (a mast
- 🔴 Accessing this route with a key that does not have permissions (i.e. other than the master-key) returns an [invalid_api_key](0061-error-format-and-definitions.md#invalid_api_key) error.

## 4. Technical Details
N/A

### 4.1. Triggering Documents Re-indexing

Meilisearch favors search speed and compromises on indexing speed by computing internal data structures to get search results as fast as possible.

Changing any of the following index settings will cause documents to be re-indexed:

- `searchableAttributes`
- `filterableAttributes`
- `sortableAttributes`
- `distinctAttribute`
- `stopWords`

## 5. Future Possibilities
- Replace `POST` HTTP verb with `PATCH`

0 comments on commit 1592a0c

Please sign in to comment.