Typesense.Collections (typesense v0.2.0)
The Typesense.Collections module is the service implementation for Typesense' Collections API Resource.
Link to this section Summary
Functions
Create a Collection.
Delete a collection.
List all collections.
Retrieve all collections.
Search a collection.
Link to this section Functions
Link to this function
create(schema)
Create a Collection.
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)
Delete a collection.
Examples
iex> Typesense.Collections.delete(collection_id)
{:ok, _collection}
Link to this function
list()
List all collections.
Examples
iex> Typesense.Collections.list()
{:ok, collections}
Link to this function
retrieve(collection)
Retrieve all collections.
Examples
iex> Typesense.Collections.retrieve("companies")
{:ok, company}
Link to this function
search(collection, query_params)
Search a collection.
Examples
iex> Typesense.Collections.search(collection, query_params)
[%{}, ...]