Shortcuts

qdrant_client.http.api.snapshots_api module

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

Bases: _SnapshotsApi

async create_full_snapshot(wait: Optional[bool] = None) InlineResponse20011[source]

Create new snapshot of the whole storage

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_full_snapshot(snapshot_name: str, wait: Optional[bool] = None) InlineResponse200[source]

Delete snapshot of the whole storage

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_full_snapshot(snapshot_name: str) None[source]

Download specified snapshot of the whole storage as a file

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_full_snapshots() InlineResponse20010[source]

Get list of snapshots of the whole storage

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.

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

Bases: _SnapshotsApi

create_full_snapshot(wait: Optional[bool] = None) InlineResponse20011[source]

Create new snapshot of the whole storage

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_full_snapshot(snapshot_name: str, wait: Optional[bool] = None) InlineResponse200[source]

Delete snapshot of the whole storage

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_full_snapshot(snapshot_name: str) None[source]

Download specified snapshot of the whole storage as a file

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_full_snapshots() InlineResponse20010[source]

Get list of snapshots of the whole storage

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.

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