Qdrant.Api.Http.Aliases (Qdrant v0.1.15)

Copy Markdown View Source

Qdrant API Aliases operations.

Aliases allow to give names to collections and use them instead of collection names.

Summary

Functions

get_collection_aliases(collection_name)

@spec get_collection_aliases(String.t()) :: Qdrant.Types.result(map())

get_collection_aliases(client, collection_name, opts \\ [])

@spec get_collection_aliases(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_options()
) ::
  Qdrant.Types.result(map())

Get aliases for a specific collection.

Parameters

  • collection_name required - Name of the collection

Network example (not a doctest)

client = Qdrant.Client.new!()
Qdrant.Api.Http.Aliases.get_collection_aliases(client, "my_collection")
{:ok, %{"result" => %{"aliases" => [...]}}}

get_collections_aliases()

@spec get_collections_aliases() :: Qdrant.Types.result(map())

get_collections_aliases(client, opts \\ [])

@spec get_collections_aliases(Qdrant.Client.t(), Qdrant.Types.request_options()) ::
  Qdrant.Types.result(map())

Get list of all existing collections aliases.

Network example (not a doctest)

client = Qdrant.Client.new!()
Qdrant.Api.Http.Aliases.get_collections_aliases(client)
{:ok, %{"result" => %{"aliases" => [...]}}}

update_aliases(body)

@spec update_aliases(Qdrant.Types.request_body()) :: Qdrant.Types.result(map())

update_aliases(client, body)

@spec update_aliases(Qdrant.Client.t(), Qdrant.Types.request_body()) ::
  Qdrant.Types.result(map())
@spec update_aliases(Qdrant.Types.request_body(), integer() | nil) ::
  Qdrant.Types.result(map())

update_aliases(client, body, opts)

Update aliases of collections.

Parameters

  • body required - Alias update operations (create, delete, rename)
  • opts - Options, including :timeout in seconds for operation commit

Network example (not a doctest)

client = Qdrant.Client.new!()
body = %{actions: [%{create_alias: %{collection_name: "my_collection", alias_name: "my_alias"}}]}
Qdrant.Api.Http.Aliases.update_aliases(client, body)
{:ok, %{"result" => true, "status" => "ok"}}