跳到主要内容

pin_snapshot_data()

内测版

此操作会在一段时间内固定快照数据,以便您在导出或备份文件时,垃圾回收不会将其删除。

请求语法​

python
pin_snapshot_data(
self,
snapshot_name: str,
collection_name: str,
db_name: str = "",
ttl_seconds: int = 0,
timeout: Optional[float] = None,
**kwargs,
) -> int

参数:

  • snapshot_name (str) -

    要固定的快照名称。

  • collection_name (str) -

    拥有该快照的 Collection。

  • db_name (str) -

    Database 名称。留空则使用当前活动的 Database。

  • ttl_seconds (int) -

    固定的存活时间(秒)。0 将使用服务器默认 TTL。

  • timeout (Optional[float]) -

    此操作的超时时间,单位为秒。

  • kwargs (dict) -

    传递给底层 RPC 的附加请求选项。

返回类型:

int

用于通过 unpin_snapshot_data() 释放此固定的 pin_id。

异常:

  • MilvusException

    当无法固定快照或请求失败时引发。

示例​

python
from pymilvus import MilvusClient

client = MilvusClient(uri="YOUR_CLUSTER_ENDPOINT", token="YOUR_CLUSTER_TOKEN")

pin_id = client.pin_snapshot_data(
snapshot_name="backup_20260509",
collection_name="products",
ttl_seconds=3600,
)

# Copy snapshot data to external storage here.

client.unpin_snapshot_data(pin_id=pin_id)
最低 SDK 版本v3.0.x