CreateSnapshot()

申请开通

此操作会创建 Collection 的时间点快照。您可以使用快照备份 Collection 数据和元数据，用于灾难恢复或迁移。

go

func (c *Client) CreateSnapshot(ctx context.Context, opt CreateSnapshotOption, callOptions ...grpc.CallOption) error

请求语法

创建 CreateSnapshot() 的请求。

go

option := client.NewCreateSnapshotOption(snapshotName, collectionName).
    WithDescription(description string).
    WithDbName(dbName string)

err := client.CreateSnapshot(option)

参数：

• name （string） -

  [必需]

  要创建的快照的名称。此名称在 Collection 内必须唯一。

• collectionName （string） -

  [必需]

  要创建快照的 Collection 的名称。

构建器方法：

• WithDescription(description string)

  此方法为快照设置可选的人类可读描述。

• WithDbName(dbName string)

  此方法设置 Database 名称。如果未设置，则使用默认 Database。

返回类型：

error

返回：

成功时返回 nil。如果 Collection 不存在、快照名称已被占用，或操作因任何其他原因失败，则返回错误。

错误处理：

• error

  操作失败。检查 err != nil 以了解失败详情。

示例

演示 CreateSnapshot() 的用法。

go

import (
	"log"
	"context"
	"fmt"

	"github.com/milvus-io/milvus/client/v3/milvusclient"
)

ctx, cancel := context.WithCancel(context.Background())
defer cancel()

milvusAddr := "YOUR_CLUSTER_ENDPOINT"

cli, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
	Address: milvusAddr,
})
if err != nil {
	log.Fatal(err)
}

defer cli.Close(ctx)

option := milvusclient.NewCreateSnapshotOption("backup_20260418", "my_collection").
	WithDescription("Daily backup before schema change")

err = cli.CreateSnapshot(ctx, option)
if err != nil {
	// handle error
}

fmt.Println("Snapshot created successfully")