meilisearch v0.20.0

MeiliSearch Elixir

Tests

A lightweight Meilisearch client for Elixir.

Installation

If available in Hex, the package can be installed by adding meilisearch to your list of dependencies in mix.exs:

def deps do
  [
    {:meilisearch, "~> 0.20.0"}
  ]
end

Usage 

# Create Index
Meilisearch.Index.create("index_name")

# Create Index and set primary key
Meilisearch.Index.create("index_name", primary_key: "key_name")

# Insert documents
documents = [
  %{
    "id" => 1,
    "tagline" => "In space no one can hear you scream",
    "title" => "Alien"
  },
  %{
    "id" => 2,
    "tagline" => "You'll never go in the water again",
    "title" => "Jaws"
  },
  %{
    "id" => 3,
    "tagline" => "Be Afraid. Be very afraid.",
    "title" => "The Fly"
  }
]
Meilisearch.Document.add_or_replace("index_name", documents)

# Search
Meilisearch.Search.search("water")

Available Modules

  • [X] Index
  • [X] Health
  • [X] Stats
  • [X] Version
  • [X] Documents
  • [X] Search
  • [X] Updates
  • [X] Keys
  • [X] Settings
  • [X] System Information

Config

Client settings can be configured in your application config or with environment variables.

Note: environment variables will override values in the application config.

Application Config 

config :meilisearch,
  endpoint: "http://127.0.0.1:7700",
  api_key: "test_api_key"

Environment Variables 

MEILISEARCH_ENDPOINT=http://localhost:7700 mix test
MEILISEARCH_API_KEY=test_api_key mix test

Compatibility

The 0.20.X versions of this client have been tested against the following versions of Meilisearch:

  • v0.20.0
  • v0.19.0
  • v0.18.1
  • v0.17.0

Development

You will need Meilisearch running locally for development and testing. You can do this via Docker:

$ docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=test_api_key

License

meilisearch-elixir is released under the MIT license. Please refer to LICENSE for details.