describeCollection()

This operation lists detailed information about a specific collection.

public DescribeCollectionResp describeCollection(DescribeCollectionReq request)

Request Syntax

describeCollection(DescribeCollectionReq.builder()
    .collectionName(String collectionName)
    .build()
)

BUILDER METHODS:

• collectionName(String collectionName)

  The name of an existing collection.

  Setting this to a non-existing collection results in MilvusException.

RETURN TYPE:

DescribeCollectionResp

RETURNS:

A DescribeCollectionResp object that contains detailed information about the specified collection.

PARAMETERS:

• collection_name (String)

  The name of the current collection.

• description (String)

  The description of the current collection.

• numOfPartitions (long)

  The number of partitions in the current collection.

• fieldNames (List<String>)

  A list of fields in the current collection.

• vectorFieldName (List<String>)

  The name of the vector field.

• primaryFieldName (String)

  The name of the primary field.

• enableDynamicField (Boolean)

  Whether to use the reserved JSON field $meta to save non-schema-defined fields and their values as key-value pairs.

• autoID (Boolean)

  Whether Zilliz Cloud automatically generates the primary key for the collection.

• collectionSchema (CreateCollectionReq.CollectionSchema)

  The scheme of the collection.

• createTime (long)

  The time when the collection was created.

EXCEPTIONS:

• MilvusClientExceptions

  This exception will be raised when any error occurs during this operation.

Example

import io.milvus.v2.client.ConnectConfig;
import io.milvus.v2.client.MilvusClientV2;
import io.milvus.v2.service.collection.request.DescribeCollectionReq;
import io.milvus.v2.service.collection.response.DescribeCollectionResp;

// 1. Set up a client
ConnectConfig connectConfig = ConnectConfig.builder()
        .uri("YOUR_CLUSTER_ENDPOINT")
        .token("YOUR_CLUSTER_TOKEN")
        .build();
        
MilvusClientV2 client = new MilvusClientV2(connectConfig);

// 2. Get the collection detail
DescribeCollectionReq describeCollectionReq = DescribeCollectionReq.builder()
        .collectionName("test")
        .build();
DescribeCollectionResp describeCollectionResp = client.describeCollection(describeCollectionReq);