def update_health(self, health):
"""Update health of meilisearch
Update health of meilisearch to true or false.
Parameters
----------
health: bool
Boolean reprensenting the healthyness of meilisearch. True for healthy.
"""
return HttpRequests.put(self.config, self.health_path, { 'health': health })
def update_schema(self, schema):
"""Update schema of index
Parameters
----------
schema: dict, optional
dict containing the schema of the index.
https://docs.meilisearch.com/main_concepts/indexes.html#schema-definition
Returns
----------
update: `dict`
Schema definition
"""
return HttpRequests.put(
self.config, '{}/{}/{}'.format(self.index_path, self.uid,
self.schema_path), schema).json()
def update(self, **body):
"""Update an index from meilisearch
Parameters
----------
body: **kwargs
Accepts primaryKey as an updatable parameter.
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
payload = {}
primary_key = body.get('primaryKey', None)
if primary_key is not None:
payload['primaryKey'] = primary_key
return HttpRequests.put(self.config, '{}/{}'.format(self.index_path, self.uid), payload)
def update_documents(self, documents):
"""Update documents in the index
Parameters
----------
documents: list
List of dics containing each a document, or json string
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return HttpRequests.put(self.config, '{}/{}/{}'.format(
self.index_path,
self.uid,
self.document_path,
),
documents
).json()
def update_key(self, key, body):
"""Update a key.
Update a key with custom permissions, scope, description and expire date.
More info here https://docs.meilisearch.com/advanced_guides/keys.html.
Parameters
----------
key: str
Key value
body: dict
Dictionnary with all information to update.
https://docs.meilisearch.com/references/keys.html#update-key
Returns
----------
key: dict
Information about the updated key
"""
return HttpRequests.put(self.config,
'{}/{}'.format(self.key_path,
key), body).json()
def update_documents(self, documents, primary_key=None):
"""Update documents in the index
Parameters
----------
documents: list
List of dics containing each a document, or json string
primary_key: string
The primary-key used in MeiliSearch index. Ignored if already set up.
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
if primary_key is None:
url = '{}/{}/{}'.format(self.index_path, self.uid,
self.document_path)
else:
url = '{}/{}/{}?{}'.format(
self.index_path, self.uid, self.document_path,
urllib.parse.urlencode({'primaryKey': primary_key}))
return HttpRequests.put(self.config, url, documents)
class Client():
"""
A client for the MeiliSearch API
A client instance is needed for every MeiliSearch API method to know the location of
MeiliSearch and its permissions.
"""
config = None
http = None
def __init__(self, url, apiKey=None):
"""
Parameters
----------
url : str
The url to the MeiliSearch API (ex: http://localhost:7700)
apiKey : str
The optional API key for MeiliSearch
"""
self.config = Config(url, apiKey)
self.http = HttpRequests(self.config)
def create_index(self, uid, options=None):
"""Create an index.
If the argument `uid` isn't passed in, it will be generated
by MeiliSearch.
Parameters
----------
uid: str
UID of the index
options: dict, optional
Options passed during index creation (ex: primaryKey)
Returns
-------
index : Index
an instance of Index containing the information of the newly created index
Raises
------
HTTPError
In case of any other error found here https://docs.meilisearch.com/references/#errors-status-code
"""
index = Index(self.config, uid)
index.create(self.config, uid, options)
return index
def get_indexes(self):
"""Get all indexes.
Raises
------
HTTPError
In case of any error found here https://docs.meilisearch.com/references/#errors-status-code
Returns
-------
list
List of indexes in dictionnary format. (e.g [{ 'uid': 'movies' 'primaryKey': 'objectID' }])
"""
return Index.get_indexes(self.config)
def get_index(self, uid):
"""Get an index.
Raises
------
HTTPError
In case of any error found here https://docs.meilisearch.com/references/#errors-status-code
Returns
-------
index : Index
an instance of Index containing the information of the index found
"""
return Index.get_index(self.config, uid=uid)
def get_or_create_index(self, uid, options=None):
"""Get an index, or create it if it doesn't exist.
Parameters
----------
uid: str
UID of the index
options: dict, optional
Options passed during index creation (ex: primaryKey)
Returns
-------
index : Index
an instance of Index containing the information of the retrieved or newly created index
Raises
------
HTTPError
In case of any other error found here https://docs.meilisearch.com/references/#errors-status-code
"""
index = self.get_index(uid)
try:
index.create(self.config, uid, options)
except MeiliSearchApiError as err:
if err.error_code != 'index_already_exists':
raise err
return index
def get_all_stats(self):
"""Get all stats of MeiliSearch
Get information about database size and all indexes
https://docs.meilisearch.com/references/stats.html
Returns
----------
stats: `dict`
Dictionnary containing stats about your MeiliSearch instance
"""
return self.http.get(self.config.paths.stat)
def health(self):
"""Get health of MeiliSearch
`204` HTTP status response when MeiliSearch is healthy.
Raises
----------
HTTPError
If MeiliSearch is not healthy
"""
return self.http.get(self.config.paths.health)
def update_health(self, health):
"""Update health of meilisearch
Update health of MeiliSearch to true or false.
Parameters
----------
health: bool
Boolean representing the health status of MeiliSearch. True for healthy.
"""
return self.http.put(self.config.paths.health, {'health': health})
def get_keys(self):
"""Get all keys created
Get list of all the keys that were created and all their related information.
Returns
----------
keys: list
List of keys and their information.
https://docs.meilisearch.com/references/keys.html#get-keys
"""
return self.http.get(self.config.paths.keys)
def get_version(self):
"""Get version MeiliSearch
Returns
----------
version: dict
Information about the version of MeiliSearch.
"""
return self.http.get(self.config.paths.version)
def version(self):
"""Alias for get_version
Returns
----------
version: dict
Information about the version of MeiliSearch.
"""
return self.get_version()
def create_dump(self):
"""Triggers the creation of a MeiliSearch dump
Returns
----------
Dump: dict
Information about the dump.
https://docs.meilisearch.com/references/dump.html#create-a-dump
"""
return self.http.post(self.config.paths.dumps)
def get_dump_status(self, uid):
"""Retrieves the status of a MeiliSearch dump creation
Parameters
----------
uid: str
UID of the dump
Returns
----------
Dump status: dict
Information about the dump status.
https://docs.meilisearch.com/references/dump.html#get-dump-status
"""
return self.http.get(self.config.paths.dumps + '/' + str(uid) +
'/status')
class Index():
"""
Indexes routes wrapper
Index class gives access to all indexes routes and child routes (herited).
https://docs.meilisearch.com/references/indexes.html
"""
config = None
http = None
uid = ""
def __init__(self, config, uid):
"""
Parameters
----------
config : Config
Config object containing permission and location of meilisearch
uid: str
Uid of the index on which to perform the index actions.
index_path: str
Index url path
"""
self.config = config
self.uid = uid
self.http = HttpRequests(config)
def delete(self):
"""Delete an index from meilisearch
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.delete('{}/{}'.format(self.config.paths.index, self.uid))
def update(self, **body):
"""Update an index from meilisearch
Parameters
----------
body: **kwargs
Accepts primaryKey as an updatable parameter.
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
payload = {}
primary_key = body.get('primaryKey', None)
if primary_key is not None:
payload['primaryKey'] = primary_key
return self.http.put('{}/{}'.format(self.config.paths.index, self.uid), payload)
def info(self):
"""Get info of index
Returns
----------
index: `dict`
Dictionnary containing index information.
"""
return self.http.get('{}/{}'.format(self.config.paths.index, self.uid))
def get_primary_key(self):
"""Get the primary key
Returns
----------
primary_key: str
String containing primary key.
"""
return self.info()['primaryKey']
@staticmethod
def create(config, uid, options=None):
"""Create an index.
Parameters
----------
uid: str
UID of the index
options: dict, optional
Options passed during index creation (ex: primaryKey)
Returns
-------
index : Index
an instance of Index containing the information of the newly created index
Raises
------
HTTPError
In case of any error found here https://docs.meilisearch.com/references/#errors-status-code
"""
if options is None:
options = {}
payload = {**options, 'uid': uid}
return HttpRequests(config).post(config.paths.index, payload)
@staticmethod
def get_indexes(config):
"""Get all indexes from meilisearch.
Returns
-------
indexes : list
List of indexes (dict)
Raises
------
HTTPError
In case of any error found here https://docs.meilisearch.com/references/#errors-status-code
"""
return HttpRequests(config).get(config.paths.index)
@staticmethod
def get_index(config, uid):
"""Get Index instance from given index
If the argument `uid` aren't passed in, it will raise an exception.
Returns
-------
index : Index
Instance of Index with the given index.
Raises
------
Exception
If index UID is missing.
"""
if uid is not None:
return Index(config, uid=uid)
raise Exception('Uid is needed to find index')
def get_all_update_status(self):
"""Get all update status from MeiliSearch
Returns
----------
update: `list`
List of all enqueued and processed actions of the index.
"""
return self.http.get(
'{}/{}/{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.update
)
)
def get_update_status(self, update_id):
"""Get one update from MeiliSearch
Parameters
----------
update_id: int
identifier of the update to retrieve
Returns
----------
update: `list`
List containing the details of the update status.
"""
return self.http.get(
'{}/{}/{}/{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.update,
update_id
)
)
def wait_for_pending_update(self, update_id, timeout_in_ms=5000, interval_in_ms=50):
"""Wait until MeiliSearch processes an update, and get its status
Parameters
----------
update_id: int
identifier of the update to retrieve
timeout_in_ms (optional): int
time the method should wait before rising a TimeoutError
interval_in_ms (optional): int
time interval the method should wait (sleep) between requests
Returns
----------
update: `dict`
Dictionary containing the details of the processed update status.
"""
start_time = datetime.now()
elapsed_time = 0
while elapsed_time < timeout_in_ms:
get_update = self.get_update_status(update_id)
if get_update['status'] != 'enqueued':
return get_update
sleep(interval_in_ms / 1000)
time_delta = datetime.now() - start_time
elapsed_time = time_delta.seconds * 1000 + time_delta.microseconds / 1000
raise TimeoutError
def get_stats(self):
"""Get stats of an index
Get information about the number of documents, field frequencies, ...
https://docs.meilisearch.com/references/stats.html
Returns
----------
stats: `dict`
Dictionnary containing stats about the given index.
"""
return self.http.get(
'{}/{}/{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.stat,
)
)
def search(self, query, opt_params=None):
"""Search in meilisearch
Parameters
----------
query: str
String containing the searched word(s)
opt_params: dict
Dictionnary containing optional query parameters
https://docs.meilisearch.com/references/search.html#search-in-an-index
Returns
----------
results: `dict`
Dictionnary with hits, offset, limit, processingTime and initial query
"""
# Query parameters parsing
if opt_params is None:
opt_params = {}
for key in opt_params:
if key in ('facetsDistribution', 'facetFilters'):
opt_params[key] = json.dumps(opt_params[key])
elif isinstance(opt_params[key], list):
opt_params[key] = ','.join(opt_params[key])
params = {
'q': query,
**opt_params
}
return self.http.get(
'{}/{}/{}?{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.search,
urllib.parse.urlencode(params))
)
def get_document(self, document_id):
"""Get one document with given document identifier
Parameters
----------
document_id: str
Unique identifier of the document.
Returns
----------
document: `dict`
Dictionnary containing the documents information
"""
return self.http.get(
'{}/{}/{}/{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.document,
document_id
)
)
def get_documents(self, parameters=None):
"""Get a set of documents from the index
Parameters
----------
parameters (optional): dict
parameters accepted by the get documents route: https://docs.meilisearch.com/references/documents.html#get-all-documents
Returns
----------
document: `dict`
Dictionnary containing the documents information
"""
if parameters is None:
parameters = {}
return self.http.get(
'{}/{}/{}?{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.document,
urllib.parse.urlencode(parameters))
)
def add_documents(self, documents, primary_key=None):
"""Add documents to the index
Parameters
----------
documents: list
List of dics containing each a document, or json string
primary_key: string
The primary-key used in MeiliSearch index. Ignored if already set up.
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
if primary_key is None:
url = '{}/{}/{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.document
)
else:
url = '{}/{}/{}?{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.document,
urllib.parse.urlencode({'primaryKey': primary_key})
)
return self.http.post(url, documents)
def update_documents(self, documents, primary_key=None):
"""Update documents in the index
Parameters
----------
documents: list
List of dics containing each a document, or json string
primary_key: string
The primary-key used in MeiliSearch index. Ignored if already set up.
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
if primary_key is None:
url = '{}/{}/{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.document
)
else:
url = '{}/{}/{}?{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.document,
urllib.parse.urlencode({'primaryKey': primary_key})
)
return self.http.put(url, documents)
def delete_document(self, document_id):
"""Add documents to the index
Parameters
----------
document_id: str
Unique identifier of the document.
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.delete(
'{}/{}/{}/{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.document,
document_id
)
)
def delete_documents(self, ids):
"""Delete multiple documents of the index
Parameters
----------
list: list
List of unique identifiers of documents.
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.post(
'{}/{}/{}/delete-batch'.format(
self.config.paths.index,
self.uid,
self.config.paths.document
),
ids
)
def delete_all_documents(self):
"""Delete all documents of the index
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.delete(
'{}/{}/{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.document
)
)
# GENERAL SETTINGS ROUTES
def get_settings(self):
"""Get settings of an index
https://docs.meilisearch.com/references/settings.html
Returns
----------
settings: `dict`
Dictionnary containing the settings of the index
"""
return self.http.get(
'{}/{}/{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.setting
)
)
def update_settings(self, body):
"""Update settings of an index
https://docs.meilisearch.com/references/settings.html#update-settings
Parameters
----------
body: `dict`
Dictionnary containing the settings of the index
More information:
https://docs.meilisearch.com/references/settings.html#update-settings
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.post(
'{}/{}/{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.setting
),
body
)
def reset_settings(self):
"""Reset settings of an index to default values
https://docs.meilisearch.com/references/settings.html#reset-settings
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.delete(
'{}/{}/{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.setting
),
)
# RANKING RULES SUB-ROUTES
def get_ranking_rules(self):
"""
Get ranking rules of an index
Returns
----------
settings: `list`
List containing the ranking rules of the index
"""
return self.http.get(
self.__settings_url_for(self.config.paths.ranking_rules)
)
def update_ranking_rules(self, body):
"""
Update ranking rules of an index
Parameters
----------
body: `list`
List containing the ranking rules
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.post(
self.__settings_url_for(self.config.paths.ranking_rules),
body
)
def reset_ranking_rules(self):
"""Reset ranking rules of an index to default values
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.delete(
self.__settings_url_for(self.config.paths.ranking_rules),
)
# DISTINCT ATTRIBUTE SUB-ROUTES
def get_distinct_attribute(self):
"""
Get distinct attribute of an index
Returns
----------
settings: `str`
String containing the distinct attribute of the index
"""
return self.http.get(
self.__settings_url_for(self.config.paths.distinct_attribute)
)
def update_distinct_attribute(self, body):
"""
Update distinct attribute of an index
Parameters
----------
body: `str`
String containing the distinct attribute
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.post(
self.__settings_url_for(self.config.paths.distinct_attribute),
body
)
def reset_distinct_attribute(self):
"""Reset distinct attribute of an index to default values
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.delete(
self.__settings_url_for(self.config.paths.distinct_attribute),
)
# SEARCHABLE ATTRIBUTES SUB-ROUTES
def get_searchable_attributes(self):
"""
Get searchable attributes of an index
Returns
----------
settings: `list`
List containing the searchable attributes of the index
"""
return self.http.get(
self.__settings_url_for(self.config.paths.searchable_attributes)
)
def update_searchable_attributes(self, body):
"""
Update searchable attributes of an index
Parameters
----------
body: `list`
List containing the searchable attributes
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.post(
self.__settings_url_for(self.config.paths.searchable_attributes),
body
)
def reset_searchable_attributes(self):
"""Reset searchable attributes of an index to default values
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.delete(
self.__settings_url_for(self.config.paths.searchable_attributes),
)
# DISPLAYED ATTRIBUTES SUB-ROUTES
def get_displayed_attributes(self):
"""
Get displayed attributes of an index
Returns
----------
settings: `list`
List containing the displayed attributes of the index
"""
return self.http.get(
self.__settings_url_for(self.config.paths.displayed_attributes)
)
def update_displayed_attributes(self, body):
"""
Update displayed attributes of an index
Parameters
----------
body: `list`
List containing the displayed attributes
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.post(
self.__settings_url_for(self.config.paths.displayed_attributes),
body
)
def reset_displayed_attributes(self):
"""Reset displayed attributes of an index to default values
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.delete(
self.__settings_url_for(self.config.paths.displayed_attributes),
)
# STOP WORDS SUB-ROUTES
def get_stop_words(self):
"""
Get stop words of an index
Returns
----------
settings: `list`
List containing the stop words of the index
"""
return self.http.get(
self.__settings_url_for(self.config.paths.stop_words)
)
def update_stop_words(self, body):
"""
Update stop words of an index
Parameters
----------
body: `list`
List containing the stop words
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.post(
self.__settings_url_for(self.config.paths.stop_words),
body
)
def reset_stop_words(self):
"""Reset stop words of an index to default values
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.delete(
self.__settings_url_for(self.config.paths.stop_words),
)
# SYNONYMS SUB-ROUTES
def get_synonyms(self):
"""
Get synonyms of an index
Returns
----------
settings: `dict`
Dictionnary containing the synonyms of the index
"""
return self.http.get(
self.__settings_url_for(self.config.paths.synonyms)
)
def update_synonyms(self, body):
"""
Update synonyms of an index
Parameters
----------
body: `dict`
Dictionnary containing the synonyms
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.post(
self.__settings_url_for(self.config.paths.synonyms),
body
)
def reset_synonyms(self):
"""Reset synonyms of an index to default values
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.delete(
self.__settings_url_for(self.config.paths.synonyms),
)
# ACCEPT-NEW-FIELDS SUB-ROUTES
def get_accept_new_fields(self):
"""
Get accept-new-fields value of an index
Returns
----------
settings: `bool`
Boolean containing the accept-new-fields value of the index
"""
return self.http.get(
self.__settings_url_for(self.config.paths.accept_new_fields)
)
def update_accept_new_fields(self, body):
"""
Update accept-new-fields value of an index
Parameters
----------
body: `bool`
Boolean containing the accept-new-fields value
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.post(
self.__settings_url_for(self.config.paths.accept_new_fields),
body
)
# ATTRIBUTES FOR FACETING SUB-ROUTES
def get_attributes_for_faceting(self):
"""
Get attributes for faceting of an index
Returns
----------
settings: `list`
List containing the attributes for faceting of the index
"""
return self.http.get(
self.__settings_url_for(self.config.paths.attributes_for_faceting)
)
def update_attributes_for_faceting(self, body):
"""
Update attributes for faceting of an index
Parameters
----------
body: `list`
List containing the attributes for faceting
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.post(
self.__settings_url_for(self.config.paths.attributes_for_faceting),
body
)
def reset_attributes_for_faceting(self):
"""Reset attributes for faceting of an index to default values
Returns
----------
update: `dict`
Dictionnary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
"""
return self.http.delete(
self.__settings_url_for(self.config.paths.attributes_for_faceting),
)
def __settings_url_for(self, sub_route):
return '{}/{}/{}/{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.setting,
sub_route
)
class Index():
"""
Indexes routes wrapper.
Index class gives access to all indexes routes and child routes (inherited).
https://docs.meilisearch.com/references/indexes.html
"""
config = None
http = None
uid = None
primary_key = None
def __init__(self, config, uid, primary_key=None):
"""
Parameters
----------
config : dict
Config object containing permission and location of MeiliSearch.
uid: str
UID of the index on which to perform the index actions.
primary_key (optional): str
Primary-key of the index.
"""
self.config = config
self.http = HttpRequests(config)
self.uid = uid
self.primary_key = primary_key
def delete(self):
"""Delete 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
"""
return self.http.delete('{}/{}'.format(self.config.paths.index,
self.uid))
def update(self, **body):
"""Update the index primary-key.
Parameters
----------
body: **kwargs
Accepts primaryKey as an updatable parameter.
Ex: index.update(primaryKey='name')
Returns
-------
index: dict
Dictionary containing index information.
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', None)
if primary_key is not None:
payload['primaryKey'] = primary_key
response = self.http.put(
'{}/{}'.format(self.config.paths.index, self.uid), payload)
self.primary_key = response['primaryKey']
return self
def fetch_info(self):
"""Fetch the info of the index.
Returns
-------
index: dict
Dictionary containing the index information.
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
"""
index_dict = self.http.get('{}/{}'.format(self.config.paths.index,
self.uid))
self.primary_key = index_dict['primaryKey']
return self
def get_primary_key(self):
"""Get the primary key.
Returns
-------
primary_key: str | None
String containing the primary key.
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
"""
return self.fetch_info().primary_key
@classmethod
def create(cls, config, uid, options=None):
"""Create the index.
Parameters
----------
uid: str
UID of the index.
options: dict, optional
Options passed during index creation (ex: { 'primaryKey': 'name' }).
Returns
-------
index : Index
An instance of Index containing the information of the newly created 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
"""
if options is None:
options = {}
payload = {**options, 'uid': uid}
index_dict = HttpRequests(config).post(config.paths.index, payload)
return cls(config, index_dict['uid'], index_dict['primaryKey'])
def get_all_update_status(self):
"""Get all update status
Returns
-------
update: list
List of all enqueued and processed actions of 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
"""
return self.http.get('{}/{}/{}'.format(self.config.paths.index,
self.uid,
self.config.paths.update))
def get_update_status(self, update_id):
"""Get one update status
Parameters
----------
update_id: int
identifier of the update to retrieve
Returns
-------
update: list
List containing the details of the update status.
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
"""
return self.http.get('{}/{}/{}/{}'.format(self.config.paths.index,
self.uid,
self.config.paths.update,
update_id))
def wait_for_pending_update(self,
update_id,
timeout_in_ms=5000,
interval_in_ms=50):
"""Wait until MeiliSearch processes an update, and get its status.
Parameters
----------
update_id: int
identifier of the update to retrieve
timeout_in_ms (optional): int
time the method should wait before raising a MeiliSearchTimeoutError
interval_in_ms (optional): int
time interval the method should wait (sleep) between requests
Returns
-------
update: dict
Dictionary containing the details of the processed update status.
Raises
------
MeiliSearchTimeoutError
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
"""
start_time = datetime.now()
elapsed_time = 0
while elapsed_time < timeout_in_ms:
get_update = self.get_update_status(update_id)
if get_update['status'] != 'enqueued':
return get_update
sleep(interval_in_ms / 1000)
time_delta = datetime.now() - start_time
elapsed_time = time_delta.seconds * 1000 + time_delta.microseconds / 1000
raise MeiliSearchTimeoutError(
f'timeout of ${timeout_in_ms}ms has exceeded on process ${update_id} when waiting for pending update to resolve.'
)
def get_stats(self):
"""Get stats of the index.
Get information about the number of documents, field frequencies, ...
https://docs.meilisearch.com/references/stats.html
Returns
-------
stats: dict
Dictionary containing stats about the given 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
"""
return self.http.get('{}/{}/{}'.format(
self.config.paths.index,
self.uid,
self.config.paths.stat,
))
def search(self, query, opt_params=None):
"""Search in the index.
Parameters
----------
query: str
String containing the searched word(s)
opt_params (optional): dict
Dictionary containing optional query parameters
https://docs.meilisearch.com/references/search.html#search-in-an-index
Returns
-------
results: dict
Dictionary with hits, offset, limit, processingTime and initial query
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
"""
if opt_params is None:
opt_params = {}
body = {'q': query, **opt_params}
return self.http.post('{}/{}/{}'.format(self.config.paths.index,
self.uid,
self.config.paths.search),
body=body)
def get_document(self, document_id):
"""Get one document with given document identifier.
Parameters
----------
document_id: str
Unique identifier of the document.
Returns
-------
document: dict
Dictionary containing the documents information.
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
"""
return self.http.get('{}/{}/{}/{}'.format(self.config.paths.index,
self.uid,
self.config.paths.document,
document_id))
def get_documents(self, parameters=None):
"""Get a set of documents from the index.
Parameters
----------
parameters (optional): dict
parameters accepted by the get documents route: https://docs.meilisearch.com/references/documents.html#get-all-documents
Returns
-------
document: dict
Dictionary containing the documents information.
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
"""
if parameters is None:
parameters = {}
return self.http.get('{}/{}/{}?{}'.format(
self.config.paths.index, self.uid, self.config.paths.document,
urllib.parse.urlencode(parameters)))
def add_documents(self, documents, primary_key=None):
"""Add documents to the index.
Parameters
----------
documents: list
List of documents. Each document should be a dictionary.
primary_key (optional): string
The primary-key used in index. Ignored if already set up.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
if primary_key is None:
url = '{}/{}/{}'.format(self.config.paths.index, self.uid,
self.config.paths.document)
else:
url = '{}/{}/{}?{}'.format(
self.config.paths.index, self.uid, self.config.paths.document,
urllib.parse.urlencode({'primaryKey': primary_key}))
return self.http.post(url, documents)
def update_documents(self, documents, primary_key=None):
"""Update documents in the index.
Parameters
----------
documents: list
List of documents. Each document should be a dictionary.
primary_key (optional): string
The primary-key used in index. Ignored if already set up
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
if primary_key is None:
url = '{}/{}/{}'.format(self.config.paths.index, self.uid,
self.config.paths.document)
else:
url = '{}/{}/{}?{}'.format(
self.config.paths.index, self.uid, self.config.paths.document,
urllib.parse.urlencode({'primaryKey': primary_key}))
return self.http.put(url, documents)
def delete_document(self, document_id):
"""Delete one document from the index.
Parameters
----------
document_id: str
Unique identifier of the document.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.delete('{}/{}/{}/{}'.format(
self.config.paths.index, self.uid, self.config.paths.document,
document_id))
def delete_documents(self, ids):
"""Delete multiple documents from the index.
Parameters
----------
list: list
List of unique identifiers of documents.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.post(
'{}/{}/{}/delete-batch'.format(self.config.paths.index, self.uid,
self.config.paths.document), ids)
def delete_all_documents(self):
"""Delete all documents from the index.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.delete('{}/{}/{}'.format(self.config.paths.index,
self.uid,
self.config.paths.document))
# GENERAL SETTINGS ROUTES
def get_settings(self):
"""Get settings of the index.
https://docs.meilisearch.com/references/settings.html
Returns
-------
settings: dict
Dictionary containing the settings of 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
"""
return self.http.get('{}/{}/{}'.format(self.config.paths.index,
self.uid,
self.config.paths.setting))
def update_settings(self, body):
"""Update settings of the index.
https://docs.meilisearch.com/references/settings.html#update-settings
Parameters
----------
body: dict
Dictionary containing the settings of the index.
More information:
https://docs.meilisearch.com/references/settings.html#update-settings
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.post(
'{}/{}/{}'.format(self.config.paths.index, self.uid,
self.config.paths.setting), body)
def reset_settings(self):
"""Reset settings of the index to default values.
https://docs.meilisearch.com/references/settings.html#reset-settings
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.delete(
'{}/{}/{}'.format(self.config.paths.index, self.uid,
self.config.paths.setting), )
# RANKING RULES SUB-ROUTES
def get_ranking_rules(self):
"""
Get ranking rules of the index.
Returns
-------
settings: list
List containing the ranking rules of 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
"""
return self.http.get(
self.__settings_url_for(self.config.paths.ranking_rules))
def update_ranking_rules(self, body):
"""
Update ranking rules of the index.
Parameters
----------
body: list
List containing the ranking rules.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.post(
self.__settings_url_for(self.config.paths.ranking_rules), body)
def reset_ranking_rules(self):
"""Reset ranking rules of the index to default values.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.delete(
self.__settings_url_for(self.config.paths.ranking_rules), )
# DISTINCT ATTRIBUTE SUB-ROUTES
def get_distinct_attribute(self):
"""
Get distinct attribute of the index.
Returns
-------
settings: str
String containing the distinct attribute of 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
"""
return self.http.get(
self.__settings_url_for(self.config.paths.distinct_attribute))
def update_distinct_attribute(self, body):
"""
Update distinct attribute of the index.
Parameters
----------
body: str
String containing the distinct attribute.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.post(
self.__settings_url_for(self.config.paths.distinct_attribute),
body)
def reset_distinct_attribute(self):
"""Reset distinct attribute of the index to default values.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.delete(
self.__settings_url_for(self.config.paths.distinct_attribute), )
# SEARCHABLE ATTRIBUTES SUB-ROUTES
def get_searchable_attributes(self):
"""
Get searchable attributes of the index.
Returns
-------
settings: list
List containing the searchable attributes of 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
"""
return self.http.get(
self.__settings_url_for(self.config.paths.searchable_attributes))
def update_searchable_attributes(self, body):
"""
Update searchable attributes of the index.
Parameters
----------
body: list
List containing the searchable attributes.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.post(
self.__settings_url_for(self.config.paths.searchable_attributes),
body)
def reset_searchable_attributes(self):
"""Reset searchable attributes of the index to default values.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.delete(
self.__settings_url_for(self.config.paths.searchable_attributes), )
# DISPLAYED ATTRIBUTES SUB-ROUTES
def get_displayed_attributes(self):
"""
Get displayed attributes of the index.
Returns
-------
settings: list
List containing the displayed attributes of 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
"""
return self.http.get(
self.__settings_url_for(self.config.paths.displayed_attributes))
def update_displayed_attributes(self, body):
"""
Update displayed attributes of the index.
Parameters
----------
body: list
List containing the displayed attributes.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.post(
self.__settings_url_for(self.config.paths.displayed_attributes),
body)
def reset_displayed_attributes(self):
"""Reset displayed attributes of the index to default values.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.delete(
self.__settings_url_for(self.config.paths.displayed_attributes), )
# STOP WORDS SUB-ROUTES
def get_stop_words(self):
"""
Get stop words of the index.
Returns
-------
settings: list
List containing the stop words of 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
"""
return self.http.get(
self.__settings_url_for(self.config.paths.stop_words))
def update_stop_words(self, body):
"""
Update stop words of the index.
Parameters
----------
body: list
List containing the stop words.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.post(
self.__settings_url_for(self.config.paths.stop_words), body)
def reset_stop_words(self):
"""Reset stop words of the index to default values.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.delete(
self.__settings_url_for(self.config.paths.stop_words), )
# SYNONYMS SUB-ROUTES
def get_synonyms(self):
"""
Get synonyms of the index.
Returns
-------
settings: dict
Dictionary containing the synonyms of 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
"""
return self.http.get(
self.__settings_url_for(self.config.paths.synonyms))
def update_synonyms(self, body):
"""
Update synonyms of the index.
Parameters
----------
body: dict
Dictionary containing the synonyms.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.post(
self.__settings_url_for(self.config.paths.synonyms), body)
def reset_synonyms(self):
"""Reset synonyms of the index to default values.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.delete(
self.__settings_url_for(self.config.paths.synonyms), )
# ATTRIBUTES FOR FACETING SUB-ROUTES
def get_attributes_for_faceting(self):
"""
Get attributes for faceting of the index.
Returns
-------
settings: list
List containing the attributes for faceting of 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
"""
return self.http.get(
self.__settings_url_for(self.config.paths.attributes_for_faceting))
def update_attributes_for_faceting(self, body):
"""
Update attributes for faceting of the index.
Parameters
----------
body: list
List containing the attributes for faceting.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.post(
self.__settings_url_for(self.config.paths.attributes_for_faceting),
body)
def reset_attributes_for_faceting(self):
"""Reset attributes for faceting of the index to default values.
Returns
-------
update: dict
Dictionary containing an update id to track the action:
https://docs.meilisearch.com/references/updates.html#get-an-update-status
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
"""
return self.http.delete(
self.__settings_url_for(
self.config.paths.attributes_for_faceting), )
def __settings_url_for(self, sub_route):
return '{}/{}/{}/{}'.format(self.config.paths.index, self.uid,
self.config.paths.setting, sub_route)
