Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v1.8 #2801

Merged
merged 9 commits into from
May 6, 2024
Merged

v1.8 #2801

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
24 changes: 23 additions & 1 deletion .code-samples.meilisearch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,8 @@ update_settings_1: |-
},
"faceting": {
"maxValuesPerFacet": 200
}
},
"searchCutoffMs": 150
}'
reset_settings_1: |-
curl \
Expand Down Expand Up @@ -1187,3 +1188,24 @@ index_settings_tutorial_api_put_setting_1: |-
index_settings_tutorial_api_task_1: |-
curl \
-X GET 'http://localhost:7700/tasks/TASK_UID'
get_search_cutoff_1: |-
curl \
-X GET 'http://localhost:7700/indexes/movies/settings/search-cutoff-ms'
update_search_cutoff_1: |-
curl \
-X PUT 'http://localhost:7700/indexes/movies/settings/search-cutoff-ms' \
-H 'Content-Type: application/json' \
--data-binary '150'
reset_search_cutoff_1: |-
curl \
-X DELETE 'http://localhost:7700/indexes/movies/settings/search-cutoff-ms'
negative_search_1: |-
curl \
-X POST 'http://localhost:7700/indexes/movies/search' \
-H 'Content-Type: application/json' \
--data-binary '{ "q": "-escape" }'
negative_search_2: |-
curl \
-X POST 'http://localhost:7700/indexes/movies/search' \
-H 'Content-Type: application/json' \
--data-binary '{ "q": "-\"escape room\"" }'
77 changes: 76 additions & 1 deletion assets/misc/meilisearch-collection-postman.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"info": {
"_postman_id": "4fce48ba-4382-42b4-b740-702192d63ea4",
"name": "Meilisearch v1.7",
"name": "Meilisearch v1.8",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "25294324"
},
Expand Down Expand Up @@ -2184,6 +2184,81 @@
}
},
"response": []
},
{
"name": "Get search cutoff",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{url}}/indexes/{{indexUID}}/settings/search-cutoff-ms",
"host": [
"{{url}}"
],
"path": [
"indexes",
"{{indexUID}}",
"settings",
"search-cutoff-ms"
]
}
},
"response": []
},
{
"name": "Update search cutoff",
"protocolProfileBehavior": {
"disabledSystemHeaders": {
"content-type": true
}
},
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "150"
},
"url": {
"raw": "{{url}}/indexes/{{indexUID}}/settings/search-cutoff-ms",
"host": [
"{{url}}"
],
"path": [
"indexes",
"{{indexUID}}",
"settings",
"search-cutoff-ms"
]
}
},
"response": []
},
{
"name": "Reset search cutoff",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{url}}/indexes/{{indexUID}}/settings/search-cutoff-ms",
"host": [
"{{url}}"
],
"path": [
"indexes",
"{{indexUID}}",
"settings",
"search-cutoff-ms"
]
}
},
"response": []
}
]
},
Expand Down
5 changes: 5 additions & 0 deletions config/sidebar-learn.json
Original file line number Diff line number Diff line change
Expand Up @@ -537,6 +537,11 @@
"source": "learn/experimental/replication_parameters.mdx",
"label": "Replication parameters",
"slug": "replication_parameters"
},
{
"source": "learn/experimental/search_queue_size.mdx",
"label": "Search queue size",
"slug": "search_queue_size"
}
]
},
Expand Down
16 changes: 8 additions & 8 deletions learn/cookbooks/docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Docker is a tool that bundles applications into containers. Docker containers en
Docker containers are distributed in images. To use Meilisearch, use the `docker pull` command to download a Meilisearch image:

```sh
docker pull getmeili/meilisearch:v1.7
docker pull getmeili/meilisearch:v1.8
```

Meilisearch deploys a new Docker image with every release of the engine. Each image is tagged with the corresponding Meilisearch version, indicated in the above example by the text following the `:` symbol. You can see [the full list of available Meilisearch Docker images](https://hub.docker.com/r/getmeili/meilisearch/tags#!) on Docker Hub.
Expand All @@ -31,7 +31,7 @@ After completing the previous step, use `docker run` to launch the Meilisearch i
docker run -it --rm \
-p 7700:7700 \
-v $(pwd)/meili_data:/meili_data \
getmeili/meilisearch:v1.7
getmeili/meilisearch:v1.8
```

### Configure Meilisearch
Expand All @@ -47,7 +47,7 @@ docker run -it --rm \
-p 7700:7700 \
-e MEILI_MASTER_KEY='MASTER_KEY'\
-v $(pwd)/meili_data:/meili_data \
getmeili/meilisearch:v1.7
getmeili/meilisearch:v1.8
```

#### Passing instance options with CLI arguments
Expand All @@ -58,7 +58,7 @@ If you want to pass command-line arguments to Meilisearch with Docker, you must
docker run -it --rm \
-p 7700:7700 \
-v $(pwd)/meili_data:/meili_data \
getmeili/meilisearch:v1.7 \
getmeili/meilisearch:v1.8 \
meilisearch --master-key="MASTER_KEY"
```

Expand All @@ -76,7 +76,7 @@ To keep your data intact between reboots, specify a dedicated volume by running
docker run -it --rm \
-p 7700:7700 \
-v $(pwd)/meili_data:/meili_data \
getmeili/meilisearch:v1.7
getmeili/meilisearch:v1.8
```

The example above uses `$(pwd)/meili_data`, which is a directory in the host machine. Depending on your OS, mounting volumes from the host to the container might result in performance loss and is only recommended when developing your application.
Expand All @@ -91,7 +91,7 @@ To import a dump, use Meilisearch's `--import-dump` command-line option and spec
docker run -it --rm \
-p 7700:7700 \
-v $(pwd)/meili_data:/meili_data \
getmeili/meilisearch:v1.7 \
getmeili/meilisearch:v1.8 \
meilisearch --import-dump /meili_data/dumps/20200813-042312213.dump
```

Expand All @@ -111,7 +111,7 @@ To generate a Meilisearch snapshot with Docker, launch Meilisearch with `--sched
docker run -it --rm \
-p 7700:7700 \
-v $(pwd)/meili_data:/meili_data \
getmeili/meilisearch:v1.7 \
getmeili/meilisearch:v1.8 \
meilisearch --schedule-snapshot --snapshot-dir /meili_data/snapshots
```

Expand All @@ -123,7 +123,7 @@ To import a snapshot, launch Meilisearch with the `--import-snapshot` option:
docker run -it --rm \
-p 7700:7700 \
-v $(pwd)/meili_data:/meili_data \
getmeili/meilisearch:v1.7 \
getmeili/meilisearch:v1.8 \
meilisearch --import-snapshot /meili_data/snapshots/data.ms.snapshot
```

Expand Down
1 change: 1 addition & 0 deletions learn/experimental/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,5 @@ Activating or deactivating experimental features this way does not require you t
| [Puffin reports](/learn/experimental/puffin_reports) | Export profiler data to diagnose performance issues | During runtime with the API route |
| [Reduce indexing memory usage](/learn/experimental/reduce-indexing-memory-usage) | Optimizes indexing performance | At launch with a CLI flag or environment variable |
| [Replication parameters](/learn/experimental/replication_parameters) | Alters task processing for clustering compatibility | At launch with a CLI flag or environment variable |
| [Search queue size](/learn/experimental/search_queue_size) | Configure maximum number of concurrent search requests | At launch with a CLI flag or environment variable |
| [Vector search](/learn/experimental/vector_search) | Allows Meilisearch to function as a vector embedding store | During runtime with the API route |
18 changes: 18 additions & 0 deletions learn/experimental/search_queue_size.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Search queue size — Meilisearch documentation
description: --experimental-search-queue-size is an experimental feature. Use it to configure Meilisearch's maximum number of concurrent search requests.
---

# Search queue size

Meilisearch queues up to 1000 search requests at any given moment. This limit exists to prevent Meilisearch from consuming an unbounded amount of RAM. Use `--experimental-search-queue-size` to configure this limit.

[Visit the GitHub discussion to learn how to use this feature](https://github.com/meilisearch/product/discussions/729).

Are you using this feature? Meilisearch wants to hear from you! Tell us about your experience in the [GitHub discussion](https://github.com/meilisearch/product/discussions/729). All feedback is useful and helps make Meilisearch better and easier to use.

<Capsule intent="warning">
This is an experimental feature. Experimental features are unstable: their API might significantly change and become incompatible between releases. Meilisearch does not recommend using experimental features in a production environment.

Meilisearch makes experimental features available expecting they will become stable in a future release. However, it is not possible to guarantee when and if this will happen.
</Capsule>
Loading