listCollections()

Addedv2.3.xModifiedv3.0.x

This operation lists all existing collections.

milvusClient.listCollections();

Request Syntax

listCollections({
    collection_name: string
    type: ShowCollectionsType,
    timeout?: number
})

PARAMETERS:

• collection_name (string) -

  [REQUIRED]

  The name of an existing collection.

• type (ShowCollectionsType)

  The scope of this operation. Possible values are All or Loaded.

• timeout (number) -

  The timeout duration for this operation.

  Setting this to None indicates that this operation timeouts when any response returns or error occurs.

RETURNS Promise<ShowCollectionsResponse>

This method returns a promise that resolves to a ShowCollectionsResponse object.

{
    data: CollectionData[],
    created_timestamps: string[],
    created_utc_timestamps: string[],
    status:  ResStatus
}

PARAMETERS:

• data (CollectionData[]) - A list of collection data objects. Each entry contains the collection name, ID, timestamp, and loaded percentage.

• created_timestamps (string[]) - A list of hybrid timestamps indicating when each collection was created.

• created_utc_timestamps (string[]) - A list of UTC timestamps indicating when each collection was created.

• ResStatus A ResStatus object.

  • code (number) -

    A code that indicates the operation result. It remains 0 if this operation succeeds.

  • error_code (string | number) -

    An error code that indicates an occurred error. It remains Success if this operation succeeds.

  • reason (string) -

    The reason that indicates the reason for the reported error. It remains an empty string if this operation succeeds.

Example

const milvusClient = new MilvusClient({
    address: 'YOUR_CLUSTER_ENDPOINT',
    token: 'YOUR_CLUSTER_TOKEN',
});
const res = await milvusClient.listCollections({ collection_name: 'my_collection' });