View Source EctoTypesense.Documents (ecto_typesense v0.9.0)

Interact with Typesense documents from an Ecto schema.

Link to this section Summary

create(document)

delete(document)

delete(module, id)

export(module)

import(documents)

retrieve(document)

retrieve(module, id)

update(document)

@spec create(Ecto.Schema.t()) :: {:ok, map()} | {:error, any()}

@spec delete(Ecto.Schema.t()) :: {:ok, map()} | {:error, any()}

@spec delete(Ecto.Queryable.t(), term()) :: {:ok, map()} | {:error, any()}

@spec export(Ecto.Queryable.t()) :: {:ok, map()} | {:error, any()}

@spec import([Ecto.Schema.t()]) :: {:ok, map()} | {:error, any()}

@spec import(Ecto.Queryable.t(), [Ecto.Schema.t()]) :: {:ok, map()} | {:error, any()}

@spec retrieve(Ecto.Schema.t()) :: {:ok, map()} | {:error, any()}

@spec retrieve(Ecto.Queryable.t(), term()) :: {:ok, map()} | {:error, any()}

@spec search(Ecto.Queryable.t(), map()) :: {:ok, map()} | {:error, any()}

@spec update(Ecto.Queryable.t()) :: {:ok, map()} | {:error, any()}

@spec update(Ecto.Queryable.t(), term(), Ecto.Schema.t()) ::
  {:ok, map()} | {:error, any()}