Alter Collection Properties (V2)
This operation alters the properties of a collection.
The base URL for this API is in the following format:
https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530
- Use the cluster endpoint if you are using serving clusters.
Free & Serverless
https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.comDedicated
https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530
- 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="https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530"
The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like username:password. If you are using a project endpoint, only a valid API key with sufficient permissions applies.
The name of the database which the collection belongs to. Setting this to a non-existing database results in an error. If not specified, the default database applies.
The name of the target collection. Setting this to a non-existing collection results in an error.
The collection properties to alter. Keys must be actual Milvus property names.
The time-to-live (TTL) period of the collection in seconds.
Whether to enable automatic compaction for the collection.
The description of the collection.
Whether the collection is currently truncating. When true, compaction is forbidden.
Whether to allow inserting non-BM25 function outputs.
The maximum insert rate limit in MB/s.
The minimum insert rate limit in MB/s.
The maximum delete rate limit in MB/s.
The minimum delete rate limit in MB/s.
The maximum bulk load rate limit in MB/s.
The minimum bulk load rate limit in MB/s.
The maximum query rate limit in QPS.
The minimum query rate limit in QPS.
The maximum search rate limit in VPS.
The minimum search rate limit in VPS.
The maximum disk quota for the collection in MB.
The number of replicas for the collection.
A comma-separated list of resource group names associated with the collection.
Whether to enable memory mapping for the collection.
Whether to enable partition key isolation for the collection.
The name of the field to use for TTL-based expiration.
Whether to preload scalar field data into memory on load.
Whether to preload scalar index data into memory on load.
Whether to preload vector field data into memory on load.
Whether to preload vector index data into memory on load.
export TOKEN="db_admin:xxxxxxxxxxxxx"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/alter_properties" \
--header "Authorization: Bearer ${TOKEN}". \
--header "Request-Timeout: 10" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "test_collection",
"properties": {
"mmap.enabled": true
}
}'
Response code.
Returns an error message.
Response code.
Error message.
{
"code": 0,
"data": {}
}