meilisearch v0.2.0-beta Meilisearch.Health View Source

Collection of functions used to retrive Meilisearch health information.

MeiliSearch Documentation - Health

Link to this section Summary

Functions

Get the health of Meilisearch instance

Retrieve the health of the instance as a boolean value

Update the health of Meilisearch instance

Link to this section Functions

Specs

Get the health of Meilisearch instance

Example

# Healthy
iex> Meilisearch.Health.get()
{:ok, nil}

# Unhealthy
iex> Meilisearch.Health.get()
{:error, 503, "Server is in maintenance, please try again later"}

Specs

healthy?() :: boolean()

Retrieve the health of the instance as a boolean value

Example

iex> Meilisearch.Health.healthy?()
true

Specs

Update the health of Meilisearch instance

Example

iex> Meilisearch.Health.update(false)
{:ok, nil}