View Source Meilisearch.Search (meilisearch_ex v1.0.0)

Search into your Meilisearch indexes. Search API

Link to this section Summary

Functions

Search into your Meilisearch indexes using a POST request. meili doc

Link to this section Types

@type search_params() :: %{
  q: String.t(),
  offset: integer(),
  limit: integer(),
  hitsPerPage: integer(),
  page: integer(),
  filter: String.t() | [String.t()] | nil,
  facets: [String.t()] | nil,
  attributesToRetrieve: [String.t()],
  attributesToCrop: [String.t()] | nil,
  cropLength: integer(),
  cropMarker: String.t(),
  attributesToHighlight: [String.t()] | nil,
  highlightPreTag: String.t(),
  highlightPostTag: String.t(),
  showMatchesPosition: boolean(),
  sort: [String.t()] | nil,
  matchingStrategy: String.t() | :last | :all
}
@type t(item) :: %Meilisearch.Search{
  __meta__: term(),
  estimatedTotalHits: integer(),
  facetDistribution: map(),
  hits: [item],
  hitsPerPage: integer(),
  limit: integer(),
  offset: integer(),
  page: integer(),
  processingTimeMs: integer(),
  query: String.t(),
  totalHits: integer(),
  totalPages: integer()
}

Link to this section Functions

Link to this function

search(client, index_uid, params)

View Source

Search into your Meilisearch indexes using a POST request. meili doc

examples

Examples

iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Index.get(client, "movies")
{:ok, %{
  uid: "movies",
  primaryKey: "id",
  createdAt: ~U[2021-08-12 10:00:00],
  updatedAt: ~U[2021-08-12 10:00:00]
}}