跳到主要内容

alter_collection_properties()

此操作用于修改指定 Collection 的属性。

Notes

这不适用于外部 Collection。

请求语法​

python
alter_collection_properties(
self,
collection_name: str,
properties: dict,
timeout: Optional[float] = None,
**kwargs
)

参数:

  • collection_name (str) -

    目标 Collection 的名称。

  • properties (dict) -

    以字典形式指定属性及其新值。可用的字典键如下:

    • collection.ttl.seconds (int) -

      Collection 的生存时间(TTL),单位为秒。

    • ttl_field (str)

      用作 Entity 级 TTL 过期逻辑时间戳的 TIMESTAMPTZ 字段名称。

    • mmap.enabled (bool) -

      是否为 Collection 中所有字段的原始数据和索引启用 mmap。详情请参见 使用 mmap。

    • partitionkey.isolation (bool) -

      是否启用 Partition 键隔离。详情请参见 使用 Partition 键。

    • dynamicfield.enabled (bool) -

      是否启用动态字段。详情请参见 动态字段。

  • timeout (Optional[float]) -

    此操作的超时时长。

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

返回类型:

NoneType

返回值:

None

异常:

  • MilvusException

    当此操作期间发生任何错误时,将引发此异常,尤其是在指定别名不存在时。

示例​

python
from pymilvus import MilvusClient

# 1. Create a milvus client
client = MilvusClient(
uri="https://inxx-xxxxxxxxxxxx.api.gcp-us-west1.zillizcloud.com:19530",
token="user:password"
)

# upsert properties
properties = {"collection.ttl.seconds": 500, "mmap.enabled": true}

client.alter_collection_properties(
collection_name="collection_name",
properties = properties
)
最低 SDK 版本v3.0.x