View Source OpenApiTypesense.Collections (OpenApiTypesense v0.2.0)

Provides API endpoints related to collections

Summary

Functions

create_collection(body, opts \\ [])

Create a new collection

When a collection is created, we give it a name and describe the fields that will be indexed from the documents added to the collection.

create_collection(conn, body, opts)

delete_alias(aliasName, opts \\ [])

@spec delete_alias(
  String.t(),
  keyword()
) ::
  {:ok, OpenApiTypesense.CollectionAlias.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Delete an alias

delete_alias(conn, aliasName, opts)

delete_collection(collectionName, opts \\ [])

@spec delete_collection(
  String.t(),
  keyword()
) ::
  {:ok, OpenApiTypesense.CollectionResponse.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Delete a collection

Permanently drops a collection. This action cannot be undone. For large collections, this might have an impact on read latencies.

delete_collection(conn, collectionName, opts)

get_alias(aliasName, opts \\ [])

@spec get_alias(
  String.t(),
  keyword()
) ::
  {:ok, OpenApiTypesense.CollectionAlias.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Retrieve an alias

Find out which collection an alias points to by fetching it

get_alias(conn, aliasName, opts)

get_aliases(opts \\ [])

@spec get_aliases(keyword()) ::
  {:ok, OpenApiTypesense.CollectionAliasesResponse.t()} | :error

List all aliases

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

get_aliases(conn, opts)

get_collection(collectionName, opts \\ [])

@spec get_collection(
  String.t(),
  keyword()
) ::
  {:ok, OpenApiTypesense.CollectionResponse.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Retrieve a single collection

Retrieve the details of a collection, given its name.

get_collection(conn, collectionName, opts)

get_collections(opts \\ [])

@spec get_collections(keyword()) ::
  {:ok, [OpenApiTypesense.CollectionResponse.t()]} | :error

List all collections

Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first.

get_collections(conn, opts)

@spec get_collections(
  OpenApiTypesense.Connection.t(),
  keyword()
) :: {:ok, [OpenApiTypesense.CollectionResponse.t()]} | :error

update_collection(collectionName, body, opts \\ [])

Update a collection

Update a collection's schema to modify the fields and their types.

update_collection(conn, collectionName, body, opts)

upsert_alias(aliasName, body, opts \\ [])

Create or update a collection alias

Create or update a collection alias. An alias is a virtual collection name that points to a real collection. If you're familiar with symbolic links on Linux, it's very similar to that. Aliases are useful when you want to reindex your data in the background on a new collection and switch your application to it without any changes to your code.

upsert_alias(conn, aliasName, body, opts)