https://github.com/robottokauf3/meilisearch-elixir

Elixir client for MeiliSearch
https://github.com/robottokauf3/meilisearch-elixir

Last synced: 3 months ago
JSON representation

Elixir client for MeiliSearch

• Host: GitHub
• URL: https://github.com/robottokauf3/meilisearch-elixir
• Owner: robottokauf3
• License: mit
• Created: 2020-03-28T00:47:16.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-02-23T11:20:11.000Z (9 months ago)
• Last Synced: 2024-07-06T10:43:12.575Z (4 months ago)
• Language: Elixir
• Size: 80.1 KB
• Stars: 50
• Watchers: 4
• Forks: 26
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-meilisearch - Elixir - A lightweight Elixir client (Integrations / Community Integrations)

README

        
# MeiliSearch Elixir

![Tests](https://github.com/robottokauf3/meilisearch-elixir/workflows/Tests/badge.svg)

A lightweight [Meilisearch](https://docs.meilisearch.com/) client for Elixir.

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed

by adding `meilisearch` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:meilisearch, "~> 1.0.0"}

  ]

end

```

## Usage

```elixir

# Create Index

Meilisearch.Indexes.create("index_name")

# Create Index and set primary key

Meilisearch.Indexes.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.Documents.add_or_replace("index_name", documents)

# Search

Meilisearch.Search.search("water")

```

### Available Modules

This API should enable you to call all API calls that are defined in the [API reference](https://docs.meilisearch.com/reference/api/overview.html).

## 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

```elixir

config :meilisearch,

  endpoint: "http://127.0.0.1:7700",

  api_key: "test_api_key"

```

### Environment Variables

```shell

MEILISEARCH_ENDPOINT=http://localhost:7700 mix test

MEILISEARCH_API_KEY=test_api_key_very_secure mix test

```

## Compatibility

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

  - v1.0.0

  - v1.0.1

In general: The minor versions of this client should be compatible to the same minor version of Meilisearch.

## Development

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

```

$ docker run -it --rm -p 7700:7700 -e MEILI_MASTER_KEY=test_api_key_very_secure getmeili/meilisearch:latest /bin/sh -c /bin/meilisearch

```

Or using the provided devcontainer configuration.

And then just run your tests, as you usual would: 

```

$ mix test

```

## License

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