rename_collection()

此操作会重命名现有 Collection。

Notes

此方法适用于 Dedicated serving 集群和按需计算。

• 对于 serving 集群中的 Collection，请使用集群 Endpoint 创建 MilvusClient。

  • Free & Serverless

    https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.com

  • Dedicated

    https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

• 对于按需计算中的 Collection，请使用项目 Endpoint 创建 MilvusClient。

  https://{project-id}.{region}.api.zillizcloud.com

请求语法

python

rename_collection(
    old_name: str,
    new_name: str,
    target_db: Optional[str] = "",
    timeout: Optional[float] = None,
    **kwargs,
) -> None

参数：

• old_name (str) -

  [必需]

  现有 Collection 的名称。

  如果将其设置为不存在的 Collection，将导致 MilvusException。

• new_name (str) -

  [必需]

  此操作后目标 Collection 的名称。

  如果将其设置为 old_name 的值，将导致 MilvusException。

• target_db (Optional[str]) -

  要将 Collection 移动到的目标 Database 名称。该值默认为空字符串，这意味着 Collection 保持在当前 Database 中。

• timeout (float | None) -

  此操作的超时时长。将其设置为 None 表示当收到任意响应或发生任何错误时，此操作即超时。

返回类型：

NoneType

返回值：

None

异常：

• MilvusException

  当此操作期间发生任何错误时，将引发此异常。

示例

python

from pymilvus import MilvusClient

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

# Create a collection
client.create_collection(
    collection_name="test_collection",
    dimension=5
)

# Rename the collection
client.rename_collection(
    old_name="test_collection",
    new_name="test_collection_renamed"
)

# Move collection to another database
client.rename_collection(
    old_name="test_collection_renamed",
    new_name="test_collection",
    target_db="my_database"
)