View Source Typesense.Documents (ecto_typesense v0.9.0)
Methods for interaction with Typesense Documents.
Link to this section Summary
Functions
Index a document.
Delete a document by id, or several documents through a query.
Export documents from a collection.
Import documents into a collection.
Retrieve a document.
Search for documents.
Update a document.
Link to this section Functions
Index a document.
examples
Examples
iex> document = %{
company_name: "Stark Industries",
num_employees: 5215,
country: "USA"
}
iex> Typesense.Documents.create(collection, document)
{:ok, document}Delete a document by id, or several documents through a query.
examples
Examples
iex> Typesense.Documents.delete(collection, id)
{:ok, _document}Export documents from a collection.
examples
Examples
iex> Typesense.Documents.export(collection)
[%{}, ...]Import documents into a collection.
examples
Examples
iex> documents = [%{
id: "124",
company_name: "Stark Industries",
num_employees: 5215,
country: "USA"
}]
iex> Typesense.Documents.import(collection, documents, :create)
{:ok, documents}Retrieve a document.
examples
Examples
iex> Typesense.Documents.retrieve(collection, id)
{:ok, document}Search for documents.
examples
Examples
iex> search_params = %{
q: "stark",
query_by: "company_name",
filter_by: "num_employees:>100",
sort_by: "num_employees:desc"
}
iex> Typesense.Documents.search(collection, search_params)
iex> {:ok, documents}Update a document.
examples
Examples
iex> Typesense.Documents.update(collection, id, document)
{:ok, document}