qdrant_client.http.api.cluster_api module

class AsyncClusterApi(api_client: Union[ApiClient, AsyncApiClient])[source]

Bases: _ClusterApi

async cluster_status() → InlineResponse2003[source]

Get information about the current state and composition of the cluster

async collection_cluster_info(collection_name: str) → InlineResponse2008[source]

Get cluster information for a collection

async create_shard_key(collection_name: str, timeout: Optional[int] = None, create_sharding_key: Optional[CreateShardingKey] = None) → InlineResponse200[source]

async delete_shard_key(collection_name: str, timeout: Optional[int] = None, drop_sharding_key: Optional[DropShardingKey] = None) → InlineResponse200[source]

async recover_current_peer() → InlineResponse200[source]

async remove_peer(peer_id: int, force: Optional[bool] = None) → InlineResponse200[source]

Tries to remove peer from the cluster. Will return an error if peer has shards on it.

async update_collection_cluster(collection_name: str, timeout: Optional[int] = None, cluster_operations: Optional[Union[MoveShardOperation, ReplicateShardOperation, AbortTransferOperation, DropReplicaOperation, CreateShardingKeyOperation, DropShardingKeyOperation, RestartTransferOperation]] = None) → InlineResponse200[source]

class SyncClusterApi(api_client: Union[ApiClient, AsyncApiClient])[source]

Bases: _ClusterApi

cluster_status() → InlineResponse2003[source]

Get information about the current state and composition of the cluster

collection_cluster_info(collection_name: str) → InlineResponse2008[source]

Get cluster information for a collection

create_shard_key(collection_name: str, timeout: Optional[int] = None, create_sharding_key: Optional[CreateShardingKey] = None) → InlineResponse200[source]

delete_shard_key(collection_name: str, timeout: Optional[int] = None, drop_sharding_key: Optional[DropShardingKey] = None) → InlineResponse200[source]

recover_current_peer() → InlineResponse200[source]

remove_peer(peer_id: int, force: Optional[bool] = None) → InlineResponse200[source]

Tries to remove peer from the cluster. Will return an error if peer has shards on it.

update_collection_cluster(collection_name: str, timeout: Optional[int] = None, cluster_operations: Optional[Union[MoveShardOperation, ReplicateShardOperation, AbortTransferOperation, DropReplicaOperation, CreateShardingKeyOperation, DropShardingKeyOperation, RestartTransferOperation]] = None) → InlineResponse200[source]

jsonable_encoder(obj: Any, include: Optional[Union[Set[Union[int, str]], Dict[Union[int, str], Any]]] = None, exclude=None, by_alias: bool = True, skip_defaults: Optional[bool] = None, exclude_unset: bool = True, exclude_none: bool = True)[source]

to_json(model: BaseModel, *args: Any, **kwargs: Any) → str[source]