Merge branch 'main' into dependabot/pip/types-requests-2.25.11

Author: alallema

.code-samples.meilisearch.yaml

@@ -10,7 +10,7 @@ list_all_indexes_1: |-
 create_an_index_1: |-
   client.create_index('movies', {'primaryKey': 'movie_id'})
 update_an_index_1: |-
-  client.index('movies').update(primaryKey='movie_review_id')
+  client.index('movies').update(primary_key='movie_review_id')
 delete_an_index_1: |-
   client.index('movies').delete()
 get_one_document_1: |-
@@ -120,11 +120,11 @@ update_ranking_rules_1: |-
 reset_ranking_rules_1: |-
   client.index('movies').reset_ranking_rules()
 get_distinct_attribute_1: |-
-  client.index('movies').get_distinct_attribute()
+  client.index('shoes').get_distinct_attribute()
 update_distinct_attribute_1: |-
-  client.index('movies').update_distinct_attribute('movie_id')
+  client.index('shoes').update_distinct_attribute('skuid')
 reset_distinct_attribute_1: |-
-  client.index('movies').reset_distinct_attribute()
+  client.index('shoes').reset_distinct_attribute()
 get_filterable_attributes_1: |-
   client.index('movies').get_filterable_attributes()
 update_filterable_attributes_1: |-

CONTRIBUTING.md

@@ -49,8 +49,8 @@ Each PR should pass the tests, mypy type checking, and the linter to be accepted
 
 ```bash
 # Tests
-docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
-docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
+curl -L https://install.meilisearch.com | sh # download MeiliSearch
+./meilisearch --master-key=masterKey --no-analytics=true # run MeiliSearch
 pipenv run pytest meilisearch
 # MyPy
 pipenv run mypy meilisearch

README.md

@@ -53,14 +53,17 @@ pip3 install meilisearch
 
 There are many easy ways to [download and run a MeiliSearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
 
-For example, if you use Docker:
+For example, using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
 
 ```bash
-docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
-docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
+# Install MeiliSearch
+curl -L https://install.meilisearch.com | sh
+
+# Launch MeiliSearch
+./meilisearch --master-key=masterKey
 ```
 
-NB: you can also download MeiliSearch from **Homebrew** or **APT**.
+NB: you can also download MeiliSearch from **Homebrew** or **APT** or even run it using **Docker**.
 
 ## 🚀 Getting Started
 
@@ -149,6 +152,49 @@ JSON output:
 }
 ```
 
+#### Custom Search With Filters <!-- omit in toc -->
+
+If you want to enable filtering, you must add your attributes to the `filterableAttributes` index setting.
+
+```py
+index.update_filterable_attributes([
+  'id',
+  'genres'
+])
+```
+
+You only need to perform this operation once.
+
+Note that MeiliSearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [update status](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
+
+Then, you can perform the search:
+
+```py
+index.search(
+  'wonder',
+  {
+    filter: ['id > 1 AND genres = Action']
+  }
+)
+```
+
+```json
+{
+  "hits": [
+    {
+      "id": 2,
+      "title": "Wonder Woman",
+      "genres": ["Action","Adventure"]
+    }
+  ],
+  "offset": 0,
+  "limit": 20,
+  "nbHits": 1,
+  "processingTimeMs": 0,
+  "query": "wonder"
+}
+```
+
 ## 🤖 Compatibility with MeiliSearch
 
 This package only guarantees the compatibility with the [version v0.23.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.23.0).

meilisearch/index.py

@@ -74,24 +74,20 @@ def delete_if_exists(self) -> bool:
                 raise error
             return False
 
-    def update(self, **body: Dict[str, Any]) -> 'Index':
+    def update(self, primary_key: str) -> 'Index':
         """Update the index primary-key.
 
         Parameters
         ----------
-        body:
-            Accepts primaryKey as an updatable parameter.
-            Ex: index.update(primaryKey='name')
+        primary_key:
+            The primary key to use for the index.
 
         Raises
         ------
         MeiliSearchApiError
             An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
-        payload = {}
-        primary_key = body.get('primaryKey')
-        if primary_key is not None:
-            payload['primaryKey'] = primary_key
+        payload = {'primaryKey': primary_key}
         response = self.http.put(f'{self.config.paths.index}/{self.uid}', payload)
         self.primary_key = response['primaryKey']
         self.created_at = self._iso_to_date_time(response['createdAt'])

meilisearch/tests/index/test_index.py

@@ -163,7 +163,7 @@ def test_get_primary_key(client):
 def test_update_index(client):
     """Tests updating an index."""
     index = client.index(uid=common.INDEX_UID)
-    response = index.update(primaryKey='objectID')
+    response = index.update(primary_key='objectID')
     assert isinstance(response, Index)
     assert index.primary_key == 'objectID'
     assert index.get_primary_key() == 'objectID'