Skip to main content

Add Collection Field

This operation adds a field to a collection without recreating the collection.

POST
/v2/vectordb/collections/fields/add
Cluster Endpoint

The base URL for this API is in the following format:

https://${CLUSTER_ENDPOINT}

📘Notes
  • You need to fill in ${CLUSTER_ENDPOINT} with that of your Zilliz Cloud cluster.
  • To get the endpoint, use the Describe Cluster V2 API to extract the values from the responses.
export CLUSTER_ENDPOINT=""
Parameters
Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like username:password.

Example Value: Bearer {{TOKEN}}
Request Bodyapplication/json
dbNamestring

The name of the database which the collection belongs to. Setting this to a non-existing database results in an error.

collectionNamestring

The name of the target collection. Setting this to a non-existing collection results in an error.

schemaobject

The schema of the field to add.

fieldNamestring

The name of the field to add.

dataTypestring

The data type of the field to add. Supported types are Int64, Float, Double, VarChar, Array, and Vector.

elementDataTypestring

The data type of the elements in an array field. This is required if the current field is of the array type.

nullableboolean

Whether the field can be null. To be compatible with existing data in the collection, this should be set to true.

defaultValueobject

The default value of the field. This is required if the current field is of the VarChar type.

elementTypeParamsobject

Extra field parameters.

max_lengthinteger

An optional parameter for VarChar values that determines the maximum length of the value in the current field.

max_capacityinteger

An optional parameter for Array field values that determines the maximum number of elements in the current array field.

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/fields/add" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "test_db",
    "collectionName": "test_collection",
    "schema": {
        "fieldName": "new_field",
        "dataType": "DataType.VARCHAR",
        "nullable": true,
        "defaultValue": "default_value",
        "elementTypeParams": {
            "max_length": 255
        }
    }
}'
Responses200 - application/json
codeinteger

Response code.

dataobject

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {}
}