跳到主要内容

alter_collection_field()

此操作会更改指定 Collection 字段的参数。

请求语法

python
alter_collection_field(
collection_name: str,
field_name: str,
field_params: Dict,
db_name="",
timeout: Optional[float] = None,
**kwargs,
)

参数:

  • collection_name (str) -

    目标 Collection 的名称。

  • field_name (str) -

    目标字段的名称。

  • field_params (dict) -

    要更改的字段参数。未提及的属性保持不变。可用参数因字段类型而异。

    • mmap_enabled (bool) -

      是否让 Milvus 将字段数据映射到内存中,而不是将其完全加载到内存中。详情请参阅 MMap-enabled Data Storage。

  • timeout (Optional[float]) -

    此操作的超时时长。

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

📘Notes

您必须在加载 Collection 之前更改字段设置。对已加载的 Collection 更改字段会返回错误。若要更改已加载 Collection 的设置,请先释放该 Collection,再更改字段,然后重新加载。

返回类型:

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
field_params = {"max_length": 1500}

client.alter_collection_field(
collection_name="collection_name",
field_name="my_varchar",
field_params=field_params
)
最低 SDK 版本v2.4.x
Ctrl I