Bonfire.Search.Adapter behaviour (Bonfire v1.0.0-social-rc.1.19)

Behaviour defining the interface for search adapters in Bonfire. Adapters must implement all these callbacks to provide search functionality.

Summary

facets()

index()

object()

search_opts()

search_result()

@type index() :: atom() | binary()

@type object() :: map() | struct()

@type search_opts() :: map() | keyword()

@type search_result() :: map() | nil

(optional)

@callback create_index(binary(), boolean()) :: {:ok, map()} | {:error, term()}

(optional)

@callback delete(binary(), binary()) :: {:ok, map()} | {:error, term()}

(optional)

@callback index_exists(binary()) :: boolean()

(optional)

@callback put_documents(object(), binary()) :: {:ok, map()} | {:error, term()}

@callback search(binary(), search_opts()) :: search_result()

@callback search(binary(), index()) :: search_result()

@callback search(binary(), search_opts(), boolean(), facets()) :: search_result()

@callback search_by_type(binary(), facets()) :: list()

(optional)

@callback set_facets(binary(), list() | binary()) :: {:ok, map()} | {:error, term()}

(optional)

@callback set_searchable_fields(binary(), list()) :: {:ok, map()} | {:error, term()}