Qdrant v0.0.8

View Source Qdrant.Api.Http.Cluster (Qdrant v0.0.8)

Service distributed setup.

Link to this section Summary

Types

abort_transfer()
drop_replica()
move_shard()
replicate_shard()
shard_operations()
shard_params()

Functions

cluster_status()

Get information about the current state and composition of the cluster. See more on qdrant

collection_cluster_info(collection_name)

Get cluster information for a collection. See more on qdrant

recover_current_peer()

Tries to recover current peer Raft state. [See more on qdrant](https://qdrant.github.io/qdrant/redoc/index.html#tag/cluster/operation/recover_current_peer

remove_peer(peer_id)

Remove peer from the cluster by its id. See more on qdrant Tries to remove peer from the cluster. Will return an error if peer has shards on it.

update_collection_cluster(collection_name, body)

Update collection cluster setup. See more on qdrant

Link to this section Types

Link to this type

abort_transfer()

View Source 
@type abort_transfer() :: %{abort_transfer: shard_params()}
Link to this type

drop_replica()

View Source 
@type drop_replica() :: %{shard_id: non_neg_integer(), peer_id: non_neg_integer()}
Link to this type

move_shard()

View Source 
@type move_shard() :: %{move_shard: shard_params()}
Link to this type

replicate_shard()

View Source 
@type replicate_shard() :: %{replicate_shard: shard_params()}
Link to this type

shard_operations()

View Source 
@type shard_operations() ::
  move_shard() | replicate_shard() | abort_transfer() | drop_replica()
Link to this type

shard_params()

View Source 
@type shard_params() :: %{
  shard_id: non_neg_integer(),
  to_peer_id: non_neg_integer(),
  from_peer_id: non_neg_integer()
}

Link to this section Functions

Link to this function

cluster_status()

View Source 
@spec cluster_status() :: {:ok, Tesla.Env.t()} | {:error, any()}

Get information about the current state and composition of the cluster. See more on qdrant

example

 Example 

iex> Qdrant.Api.Http.Cluster.cluster_status()
{:ok, %Tesla.Env{status: 200,
  body: %{
      "result" => %{
        "status" => "disabled",
      },
      "status" => "ok",
      "time" => 0
    }
  }
}
Link to this function

collection_cluster_info(collection_name)

View Source 
@spec collection_cluster_info(String.t()) :: {:ok, Tesla.Env.t()} | {:error, any()}

Get cluster information for a collection. See more on qdrant

parameters

 Parameters

  • collection_name required - string collection name
Link to this function

recover_current_peer()

View Source 
@spec recover_current_peer() :: {:ok, Tesla.Env.t()} | {:error, any()}

Tries to recover current peer Raft state. [See more on qdrant](https://qdrant.github.io/qdrant/redoc/index.html#tag/cluster/operation/recover_current_peer

example

 Example 

iex> Qdrant.Api.Http.Cluster.recover_current_peer()
{:ok, %Tesla.Env{status: 200,
  body: %{
      "result" => true,
      "status" => "ok",
      "time" => 0
    }
  }
}
Link to this function

remove_peer(peer_id)

View Source 
@spec remove_peer(String.t()) :: {:ok, Tesla.Env.t()} | {:error, any()}

Remove peer from the cluster by its id. See more on qdrant Tries to remove peer from the cluster. Will return an error if peer has shards on it.

parameters

 Parameters

  • peer_id required - integer peer id

example

 Example 

iex> Qdrant.Api.Http.Cluster.remove_peer(42)
{:ok, %Tesla.Env{status: 200,
  body: %{
      "result" => true,
      "status" => "ok",
      "time" => 0
    }
  }
}
Link to this function

update_collection_cluster(collection_name, body)

View Source 
@spec update_collection_cluster(String.t(), shard_operations()) ::
  {:ok, Tesla.Env.t()} | {:error, any()}

Update collection cluster setup. See more on qdrant

parameters

 Parameters

  • collection_name required - string collection name

query-parameters

 Query Parameters

  • timeout - Wait for operation commit timeout in seconds. If timeout is reached - request will return with service error.