ecto_typesense v0.9.0

View Source Typesense.Collections (ecto_typesense v0.9.0)

Methods for interaction with Typesense collections.

Link to this section Summary

Types

schema()

Functions

create(schema)

Create a Collection.

delete(id)

Delete a collection.

list()

List all collections.

retrieve(collection)

Retrieve a collection.

Link to this section Types

Link to this type

schema()

View Source 
@type schema() :: %{
  :name => String.t(),
  :fields => [
    %{
      :name => String.t(),
      :type => String.t(),
      optional(:facet) => boolean(),
      optional(:optional) => boolean()
    }
  ],
  optional(:default_sorting_field) => integer()
}

Link to this section Functions

Link to this function

create(schema)

View Source 
@spec create(schema()) :: {:ok, map()} | {:error, map()}

Create a Collection.

examples

 Examples 

schema = %{
  name: "companies",
  fields: [
    %{name: "company_name", type: "string"},
    %{name: "num_employees", type: "int32"},
    %{name: "country", type: "string", facet: true},
  ],
  default_sorting_field: "num_employees"
}
Typesense.Collections.create(schema)
Link to this function

delete(id)

View Source 
@spec delete(binary()) :: {:ok, any()} | {:error, any()}

Delete a collection.

examples

 Examples 

iex> Typesense.Collections.delete(collection_id)
{:ok, _collection}
Link to this function

list()

View Source 
@spec list() :: {:ok, list()} | {:error, any()}

List all collections.

examples

 Examples 

iex> Typesense.Collections.list()
{:ok, collections}
Link to this function

retrieve(collection)

View Source 
@spec retrieve(binary()) :: {:ok, map()} | {:error, any()}

Retrieve a collection.

examples

 Examples 

iex> Typesense.Collections.retrieve("companies")
{:ok, company}