pinSnapshotData()

This operation pins snapshot data to prevent it from being garbage collected. Use this to ensure a snapshot remains available for restoration.

JavaScript

await milvusClient.pinSnapshotData(data: PinSnapshotDataReq)

Request Syntax

JavaScript

await milvusClient.pinSnapshotData({
    collection_name: string,
    snapshot_name: string,
    ttl_seconds?: number | string,
    db_name?: string,
    timeout?: number,
    client_request_id?: string,
})

PARAMETERS:

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

• snapshot_name (string) - [REQUIRED] The name of the snapshot to pin.

• ttl_seconds (number | string) - Optional pin TTL in seconds. If not specified, the snapshot will be pinned indefinitely.

• 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<PinSnapshotDataResponse>

EXCEPTIONS:

• MilvusError

  This exception will be raised when any error occurs during this operation.

Example

JavaScript

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

const client = new MilvusClient({
    address: 'localhost:19530',
    token: 'root:Milvus',
});

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