add_collection_field()

此操作会向现有 Collection 添加一个新的标量字段，而无需重新创建该 Collection。由于内部 Schema 同步，字段几乎会立即可用，延迟极低。

Notes

如果该 Collection 启用了动态字段，并且您添加的静态字段与现有动态字段键同名，则静态字段将遮蔽该动态字段键。原始动态值仍可通过 $meta['field_name'] 语法访问。

Notes

这不适用于外部 Collection。

请求语法

python

add_collection_field(
    collection_name: str,
    timeout: Optional[float] = None,
    **kwargs
)

参数：

• collection_name (string) –

  [必需]

  目标 Collection 的名称。

• field_name (string) –

  [必需]

  新字段的名称。

• data_type (DataType) –

  [必需]

  新字段的数据类型。支持的类型请参见 DataType。

• desc (string, optional) –

  字段的简要描述。

• timeout (float) –

  RPC 请求的超时时间（以秒为单位）。如果为 None，则调用将无限期等待。

• kwargs (dict, optional) –

  附加参数包括：

  • nullable (bool):

    对于动态添加的字段，必须将其设置为 True，以适配那些没有新字段值的现有 Entity。

  • default_value (DataType-specific):

    如果在插入数据时未提供该字段的值，则使用此默认值。

  • max_length (int):

    对于 DataType.VARCHAR 字段为必需。设置字符串允许的最大字节长度（1 到 65,535）。

  • element_type (DataType):

    对于 DataType.ARRAY 字段为必需。指定数组内元素的数据类型。

  • max_capacity (int):

    对于 DataType.ARRAY 字段为必需。定义数组中的最大元素数量。

返回类型：

None

异常：

• MilvusException

  当此操作过程中发生任何错误时，将引发此异常。

示例

示例 1： 添加一个基本的可空字段

python

client.add_collection_field(
    collection_name="product_catalog",
    field_name="created_timestamp",
    data_type=DataType.INT64,
    nullable=True  # Required for added fields
)

示例 2： 添加一个带默认值的字段

python

client.add_collection_field(
    collection_name="product_catalog",
    field_name="priority_level",
    data_type=DataType.VARCHAR,
    max_length=20,
    nullable=True,          # Required for added fields
    default_value="standard"  # Default value for existing entities
)