Skip to main content

releaseCollection()

This operation releases the data of a specific collection from memory.

public void releaseCollection(ReleaseCollectionReq request)

Request Syntax​

releaseCollection(ReleaseCollectionReq.builder()
    .collectionName(String collectionName)
    .async(Boolean async)
    .timeout(Long timeout)
    .build()
)

BUILDER METHODS:

  • collectionName(String collectionName)

    The name of a collection.

  • async(Boolean async)

    Whether this operation is asynchronous.

    The value defaults to Boolean.True, indicating immediate return while the process may still run in the background.

  • timeout(Long timeout)

    The timeout duration of the process. The process terminates after the specified duration expires.

    The value defaults to 60000L, indicating the timeout duration is one minute.

RETURNS:

void

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.ReleaseCollectionReq;

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

// 2. Release collection "test"
ReleaseCollectionReq releaseCollectionReq = ReleaseCollectionReq.builder()
        .collectionName("test")
        .build();
client.releaseCollection(releaseCollectionReq);