@spec create_collection(
  schema ::
    map()
    | %ExTypesense.Collection{
        created_at: term(),
        default_sorting_field: term(),
        fields: term(),
        name: term(),
        num_documents: term(),
        symbols_to_index: term(),
        token_separators: term()
      }
) :: response()

Create collection from map or from an ecto schema module.

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"
  }
iex> ExTypesense.create_collection(schema)
{:ok,
  %ExTypesense.Collection{
    "created_at" => 1234567890,
    "default_sorting_field" => "num_employees",
    "fields" => [...],
    "name" => "companies",
    "num_documents" => 0,
    "symbols_to_index" => [],
    "token_separators" => []
  }
}

iex> ExTypesense.Parser.struct_to_map(AppModule, "title") |> ExTypesense.create_collection()
{:ok,
  %ExTypesense.Collection{
    "created_at" => 1234567890,
    "default_sorting_field" => "num_employees",
    "fields" => [...],
    "name" => "companies",
    "num_documents" => 0,
    "symbols_to_index" => [],
    "token_separators" => []
  }
}

@spec delete_collection(String.t()) :: response()

Deletes a collection using collection name.

@spec delete_collection_alias(String.t()) :: response()

Deletes a collection alias. The collection itself is not affected by this action.

@spec get_collection(String.t()) :: response()

Get a specific collection using collection name.

@spec get_collection_alias(String.t()) :: response()

Get a specific collection alias.

@spec list_collection_aliases() :: response()

List all aliases and the corresponding collections that they map to.

@spec list_collections() :: response()

Lists all collections.

@spec update_collection(
  String.t(),
  collection ::
    map()
    | %ExTypesense.Collection{
        created_at: term(),
        default_sorting_field: term(),
        fields: term(),
        name: term(),
        num_documents: term(),
        symbols_to_index: term(),
        token_separators: term()
      }
) :: response()

Make changes in a collection's fields: adding, removing or updating an existing field(s). Key name is drop to indicate which field is removed (example described below). Only fields can only be updated at the moment.

Note: Typesense supports updating all fields except the id field (since it's a special field within Typesense).

examples

Examples

 new_schema =
  %{
   fields: [
     %{name: "num_employees", drop: true},
     %{name: "company_category", type: "string"},
   ],
  }

iex> ExTypesense.update_collection("companies", new_schema)
{:ok,
  %ExTypesense.Collection{
    "created_at" => nil,
    "name" => nil,
    "default_sorting_field" => nil,
    "fields" => [...],
    "num_documents" => 0,
    "symbols_to_index" => [],
    "token_separators" => []
  }
}

@spec upsert_collection_alias(String.t(), String.t()) :: response()

Upserts a collection alias.