Skip to main content

listSnapshots()

Addedv3.0.xModifiedv3.0.x

This operation lists all snapshots for a collection.

await milvusClient.listSnapshots(data: ListSnapshotsReq)

Request Syntax​

await milvusClient.listSnapshots({
    collection_name: string,
    db_name?: string,
    timeout?: number,
    client_request_id?: string,
})

PARAMETERS:

  • collection_name (string) - [REQUIRED] The name of the collection.

  • db_name (string) - The name of the database. Optional.

  • timeout (number) - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or an error occurs. Default is undefined.

  • client_request_id (string) - A trace ID for request tracking. Optional.

RETURNS Promise<ListSnapshotsResponse>

This method returns a promise that resolves to a ListSnapshotsResponse object.

{
    snapshots: string[],
    status:  ResStatus
}

PARAMETERS:

  • snapshots (string[]) - A list of snapshot names that currently exist for the requested collection.

  • ResStatus A ResStatus object.

    • code (number) -

      A code that indicates the operation result. It remains 0 if this operation succeeds.

    • error_code (string | number) -

      An error code that indicates an occurred error. It remains Success if this operation succeeds.

    • reason (string) -

      The reason that indicates the reason for the reported error. It remains an empty string if this operation succeeds.

Example​

import { MilvusClient } from '@zilliz/milvus2-sdk-node';

const client = new MilvusClient({
    address: 'YOUR_CLUSTER_ENDPOINT',
    token: 'YOUR_CLUSTER_TOKEN',
});

const res = await client.listSnapshots({
    collection_name: 'my_collection',
});