Qdrant API Aliases operations.
Aliases allow to give names to collections and use them instead of collection names.
Summary
Functions
Get aliases for a specific collection.
Get list of all existing collections aliases.
Update aliases of collections.
Functions
@spec get_collection_aliases(String.t()) :: Qdrant.Types.result(map())
@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_namerequired - 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" => [...]}}}
@spec get_collections_aliases() :: Qdrant.Types.result(map())
@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" => [...]}}}
@spec update_aliases(Qdrant.Types.request_body()) :: Qdrant.Types.result(map())
@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())
@spec update_aliases( Qdrant.Client.t(), Qdrant.Types.request_body(), Qdrant.Types.request_options() ) :: Qdrant.Types.result(map())
Update aliases of collections.
Parameters
bodyrequired - Alias update operations (create, delete, rename)opts- Options, including:timeoutin 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"}}