Meilisearch.Health (meilisearch v0.20.0) View Source

Collection of functions used to retrive Meilisearch health information.

MeiliSearch Documentation - Health

Link to this section Summary

Functions

get()

Get the health of Meilisearch instance

healthy?()

Retrieve the health of the instance as a boolean value

Link to this section Functions

get()

Specs

get() :: Meilisearch.HTTP.response()

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"}

healthy?()

Specs

healthy?() :: boolean()

Retrieve the health of the instance as a boolean value

Example

iex> Meilisearch.Health.healthy?()
true