milvus-logo
LFAI
< Docs
  • RESTful

Rename Collection

This operation renames an existing collection and optionally moves the collection to a new database.

POST
/v2/vectordb/collections/rename
Cluster Endpoint

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

http://localhost:19530

export CLUSTER_ENDPOINT="http://localhost:19530"
Parameters
Request-Timeoutintegerheader

The timeout duration for this operation in seconds. Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.

Example Value: 0
Authorizationstringheaderrequired

The authentication token

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

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

dbNamestring

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

newDbNamestring

The name of the database to which the collection belongs after this operation. The value defaults to default. Setting this to a database rather than the one the collection belongs to before this operation moves this collection to the specified database. Setting this to a non-existing database results in an error.

newCollectionNamestringrequired

The name of the target collection after this operation. Setting this to the value of oldcollectionname results in an error.

export TOKEN="root:Milvus"


curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/rename" \
--header "Request-Timeout: 0" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "test_collection",
    "newCollectionName": "quick_setup"
}'
Responses200 - application/json

A success response

codeinteger

Response code.

Example Value: 0
dataobject

Response payload which is an empty object.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

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