pinSnapshotData()

この操作は、スナップショットデータがガベージコレクションされないように固定します。これを使用して、スナップショットが復元可能な状態を維持できるようにします。

typescript
await milvusClient.pinSnapshotData(data: PinSnapshotDataReq)

リクエスト構文

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

パラメータ:

collection_name (string) -
[REQUIRED]
The name of the collection the snapshot belongs to.
snapshot_name (string) -
[必須]
固定するスナップショットの名前です。
ttl_seconds (number | string) -
オプションの固定 TTL（秒）です。指定しない場合、スナップショットは無期限に固定されます。
db_name (string) -
データベース名です。省略可能です。
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) -
リクエスト追跡用のトレース ID です。省略可能です。

戻り値 Promise<PinSnapshotDataResponse>

このメソッドは、PinSnapshotDataResponse オブジェクトに解決される promise を返します。

typescript
{
    pin_id: string,
    status:  ResStatus
}

パラメータ:

pin_id (string) -
固定リースの識別子です。TTL が期限切れになる前に固定を解除するには、この値を unpinSnapshotData() に渡します。
ResStatus
ResStatus オブジェクトです。
- code (number) -
  
  操作結果を示すコードです。この操作が成功した場合は 0 のままです。
- error_code (string | number) -
  
  発生したエラーを示すエラーコードです。この操作が成功した場合は Success のままです。
- reason (string) -
  
  報告されたエラーの理由を示します。この操作が成功した場合は空文字列のままです。

例

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

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

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

リクエスト構文​

例​

リクエスト構文

例