Elasticlunr v0.6.6

Elasticlunr.Index (Elasticlunr v0.6.6) View Source

Link to this section Summary

Types

document_field()
search_query()
search_result()
t()

Functions

add_documents(index, documents, opts \\ [])
add_field(index, field, opts \\ [])
all(index)
analyze(index, field, content, options)
get_field(index, field)
get_fields(index)
new(opts \\ [])
remove_documents(index, document_ids)
save_document(index, save)
search(index, query, opts \\ nil)
terms(index, query)
update_documents(index, documents)
update_field(index, name, field)

Link to this section Types

Link to this type

document_field()

View Source

Specs

document_field() :: atom() | binary()
Link to this type

search_query()

View Source

Specs

search_query() :: binary() | map()
Link to this type

search_result()

View Source

Specs

search_result() :: any()
Link to this type

t()

View Source

Specs

t() :: %Elasticlunr.Index{
  documents_size: integer(),
  fields: map(),
  name: atom() | binary(),
  on_conflict: atom(),
  pipeline: Elasticlunr.Pipeline.t(),
  ref: Elasticlunr.Field.document_ref(),
  store_documents: boolean(),
  store_positions: boolean()
}

Link to this section Functions

Link to this function

add_documents(index, documents, opts \\ [])

View Source
Link to this function

add_field(index, field, opts \\ [])

View Source

Specs

add_field(t(), document_field(), keyword()) :: t()
Link to this function

all(index)

View Source

Specs

all(t()) :: [Elasticlunr.Field.document_ref()]
Link to this function

analyze(index, field, content, options)

View Source

Specs

analyze(t(), document_field(), any(), keyword()) ::
  Elasticlunr.Token.t() | [Elasticlunr.Token.t()]
Link to this function

get_field(index, field)

View Source

Specs

get_field(t(), document_field()) :: Elasticlunr.Field.t()
Link to this function

get_fields(index)

View Source

Specs

get_fields(t()) :: [Elasticlunr.Field.document_ref() | document_field()]
Link to this function

new(opts \\ [])

View Source

Specs

new(keyword()) :: t()
Link to this function

remove_documents(index, document_ids)

View Source

Specs

remove_documents(t(), [Elasticlunr.Field.document_ref()]) :: t()
Link to this function

save_document(index, save)

View Source

Specs

save_document(t(), boolean()) :: t()
Link to this function

search(index, query, opts \\ nil)

View Source

Specs

search(t(), search_query(), map() | nil) :: [search_result()]
Link to this function

terms(index, query)

View Source

Specs

terms(
  t(),
  keyword()
) :: any()
Link to this function

update_documents(index, documents)

View Source

Specs

update_documents(t(), [map()]) :: t()
Link to this function

update_field(index, name, field)

View Source

Specs

update_field(t(), document_field(), Elasticlunr.Field.t()) :: t()