Add Collection Field
This operation adds a field to a collection without recreating the collection.
The base URL for this API is in the following format:
https://${CLUSTER_ENDPOINT}
- 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=""
The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like username:password.
The name of the database which the collection belongs to. Setting this to a non-existing database results in an error.
The name of the target collection. Setting this to a non-existing collection results in an error.
The schema of the field to add.
The name of the field to add.
The data type of the field to add. Supported types are Int64, Float, Double, VarChar, Array, and Vector.
The data type of the elements in an array field. This is required if the current field is of the array type.
Whether the field can be null. To be compatible with existing data in the collection, this should be set to true.
The default value of the field. This is required if the current field is of the VarChar type.
Extra field parameters.
An optional parameter for VarChar values that determines the maximum length of the value in the current field.
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
}
}
}'
Response code.
Returns an error message.
Response code.
Error message.
{
"code": 0,
"data": {}
}