Shortcuts

qdrant_client.http.api.collections_api module

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

Bases: _CollectionsApi

async collection_cluster_info(collection_name: str) InlineResponse2008[source]

Get cluster information for a collection

async collection_exists(collection_name: str) InlineResponse2007[source]

Returns “true” if the given collection name exists, and “false” otherwise

async create_collection(collection_name: str, timeout: Optional[int] = None, create_collection: Optional[CreateCollection] = None) InlineResponse200[source]

Create new collection with given parameters

async create_field_index(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, create_field_index: Optional[CreateFieldIndex] = None) InlineResponse2006[source]

Create index for field in collection

async create_shard_key(collection_name: str, timeout: Optional[int] = None, create_sharding_key: Optional[CreateShardingKey] = None) InlineResponse200[source]
async create_shard_snapshot(collection_name: str, shard_id: int, wait: Optional[bool] = None) InlineResponse20011[source]

Create new snapshot of a shard for a collection

async create_snapshot(collection_name: str, wait: Optional[bool] = None) InlineResponse20011[source]

Create new snapshot for a collection

async delete_collection(collection_name: str, timeout: Optional[int] = None) InlineResponse200[source]

Drop collection and all associated data

async delete_field_index(collection_name: str, field_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None) InlineResponse2006[source]

Delete field index for collection

async delete_shard_key(collection_name: str, timeout: Optional[int] = None, drop_sharding_key: Optional[DropShardingKey] = None) InlineResponse200[source]
async delete_shard_snapshot(collection_name: str, shard_id: int, snapshot_name: str, wait: Optional[bool] = None) InlineResponse200[source]

Delete snapshot of a shard for a collection

async delete_snapshot(collection_name: str, snapshot_name: str, wait: Optional[bool] = None) InlineResponse200[source]

Delete snapshot for a collection

async get_collection(collection_name: str) InlineResponse2005[source]

Get detailed information about specified existing collection

async get_collection_aliases(collection_name: str) InlineResponse2009[source]

Get list of all aliases for a collection

async get_collections() InlineResponse2004[source]

Get list name of all existing collections

async get_collections_aliases() InlineResponse2009[source]

Get list of all existing collections aliases

async get_shard_snapshot(collection_name: str, shard_id: int, snapshot_name: str) None[source]

Download specified snapshot of a shard from a collection as a file

async get_snapshot(collection_name: str, snapshot_name: str) None[source]

Download specified snapshot from a collection as a file

async list_shard_snapshots(collection_name: str, shard_id: int) InlineResponse20010[source]

Get list of snapshots for a shard of a collection

async list_snapshots(collection_name: str) InlineResponse20010[source]

Get list of snapshots for a collection

async recover_from_snapshot(collection_name: str, wait: Optional[bool] = None, snapshot_recover: Optional[SnapshotRecover] = None) InlineResponse200[source]

Recover local collection data from a snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created.

async recover_from_uploaded_snapshot(collection_name: str, wait: Optional[bool] = None, priority: Optional[SnapshotPriority] = None, checksum: Optional[str] = None, snapshot: Optional[IO[Any]] = None) InlineResponse200[source]

Recover local collection data from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created.

async recover_shard_from_snapshot(collection_name: str, shard_id: int, wait: Optional[bool] = None, shard_snapshot_recover: Optional[ShardSnapshotRecover] = None) InlineResponse200[source]

Recover shard of a local collection data from a snapshot. This will overwrite any data, stored in this shard, for the collection.

async recover_shard_from_uploaded_snapshot(collection_name: str, shard_id: int, wait: Optional[bool] = None, priority: Optional[SnapshotPriority] = None, checksum: Optional[str] = None, snapshot: Optional[IO[Any]] = None) InlineResponse200[source]

Recover shard of a local collection from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection shard.

async update_aliases(timeout: Optional[int] = None, change_aliases_operation: Optional[ChangeAliasesOperation] = None) InlineResponse200[source]
async update_collection(collection_name: str, timeout: Optional[int] = None, update_collection: Optional[UpdateCollection] = None) InlineResponse200[source]

Update parameters of the existing collection

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 SyncCollectionsApi(api_client: Union[ApiClient, AsyncApiClient])[source]

Bases: _CollectionsApi

collection_cluster_info(collection_name: str) InlineResponse2008[source]

Get cluster information for a collection

collection_exists(collection_name: str) InlineResponse2007[source]

Returns “true” if the given collection name exists, and “false” otherwise

create_collection(collection_name: str, timeout: Optional[int] = None, create_collection: Optional[CreateCollection] = None) InlineResponse200[source]

Create new collection with given parameters

create_field_index(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, create_field_index: Optional[CreateFieldIndex] = None) InlineResponse2006[source]

Create index for field in collection

create_shard_key(collection_name: str, timeout: Optional[int] = None, create_sharding_key: Optional[CreateShardingKey] = None) InlineResponse200[source]
create_shard_snapshot(collection_name: str, shard_id: int, wait: Optional[bool] = None) InlineResponse20011[source]

Create new snapshot of a shard for a collection

create_snapshot(collection_name: str, wait: Optional[bool] = None) InlineResponse20011[source]

Create new snapshot for a collection

delete_collection(collection_name: str, timeout: Optional[int] = None) InlineResponse200[source]

Drop collection and all associated data

delete_field_index(collection_name: str, field_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None) InlineResponse2006[source]

Delete field index for collection

delete_shard_key(collection_name: str, timeout: Optional[int] = None, drop_sharding_key: Optional[DropShardingKey] = None) InlineResponse200[source]
delete_shard_snapshot(collection_name: str, shard_id: int, snapshot_name: str, wait: Optional[bool] = None) InlineResponse200[source]

Delete snapshot of a shard for a collection

delete_snapshot(collection_name: str, snapshot_name: str, wait: Optional[bool] = None) InlineResponse200[source]

Delete snapshot for a collection

get_collection(collection_name: str) InlineResponse2005[source]

Get detailed information about specified existing collection

get_collection_aliases(collection_name: str) InlineResponse2009[source]

Get list of all aliases for a collection

get_collections() InlineResponse2004[source]

Get list name of all existing collections

get_collections_aliases() InlineResponse2009[source]

Get list of all existing collections aliases

get_shard_snapshot(collection_name: str, shard_id: int, snapshot_name: str) None[source]

Download specified snapshot of a shard from a collection as a file

get_snapshot(collection_name: str, snapshot_name: str) None[source]

Download specified snapshot from a collection as a file

list_shard_snapshots(collection_name: str, shard_id: int) InlineResponse20010[source]

Get list of snapshots for a shard of a collection

list_snapshots(collection_name: str) InlineResponse20010[source]

Get list of snapshots for a collection

recover_from_snapshot(collection_name: str, wait: Optional[bool] = None, snapshot_recover: Optional[SnapshotRecover] = None) InlineResponse200[source]

Recover local collection data from a snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created.

recover_from_uploaded_snapshot(collection_name: str, wait: Optional[bool] = None, priority: Optional[SnapshotPriority] = None, checksum: Optional[str] = None, snapshot: Optional[IO[Any]] = None) InlineResponse200[source]

Recover local collection data from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created.

recover_shard_from_snapshot(collection_name: str, shard_id: int, wait: Optional[bool] = None, shard_snapshot_recover: Optional[ShardSnapshotRecover] = None) InlineResponse200[source]

Recover shard of a local collection data from a snapshot. This will overwrite any data, stored in this shard, for the collection.

recover_shard_from_uploaded_snapshot(collection_name: str, shard_id: int, wait: Optional[bool] = None, priority: Optional[SnapshotPriority] = None, checksum: Optional[str] = None, snapshot: Optional[IO[Any]] = None) InlineResponse200[source]

Recover shard of a local collection from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection shard.

update_aliases(timeout: Optional[int] = None, change_aliases_operation: Optional[ChangeAliasesOperation] = None) InlineResponse200[source]
update_collection(collection_name: str, timeout: Optional[int] = None, update_collection: Optional[UpdateCollection] = None) InlineResponse200[source]

Update parameters of the existing collection

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]

Qdrant

Learn more about Qdrant vector search project and ecosystem

Discover Qdrant

Similarity Learning

Explore practical problem solving with Similarity Learning

Learn Similarity Learning

Community

Find people dealing with similar problems and get answers to your questions

Join Community