Skip to main content

releasePartitions()

MilvusClient interface. This method releases partitions' data from memory.

R<RpcStatus> releasePartitions(ReleasePartitionsParam requestParam);

ReleasePartitionsParam

Use the ReleasePartitionsParam.Builder to construct a ReleasePartitionsParam object.

import io.milvus.param.ReleasePartitionsParam;
ReleasePartitionsParam.Builder builder = ReleasePartitionsParam.newBuilder();

Methods of ReleasePartitionsParam.Builder:

Method

Description

Parameters

withCollectionName(String collectionName)

Set the collection name. Collection name cannot be empty or null.

collectionName: The target collection name.

withDatabaseName(String databaseName)

Sets the database name. database name can be null for default database.

databaseName: The database name.

withPartitionNames(List<String> partitionNames)

Set the partition names list. Partition names list cannot be null or empty.

partitionNames: The name list of partitions to be released.

addPartitionName(String partitionName)

Add a partition by name. Partition name cannot be empty or null.

partitionName: A target partition name.

build()

Construct a ReleasePartitionsParam object.

N/A

The ReleasePartitionsParam.Builder.build() can throw the following exceptions:

  • ParamException: error if the parameter is invalid.

Returns

This method catches all the exceptions and returns an R<RpcStatus> object.

  • If the API fails on the server side, it returns the error code and message from the server.

  • If the API fails by RPC exception, it returns R.Status.Unknown and error message of the exception.

  • If the API succeeds, it returns R.Status.Success.

Example

import io.milvus.param.*;

ReleasePartitionsParam param = ReleasePartitionsParam.newBuilder()
.withCollectionName(COLLECTION_NAME)
.addPartitionName(PARTITION_NAME)
.build();
R<Boolean> response = client.releasePartitions(param);
if (response.getStatus() != R.Status.Success.getCode()) {
System.out.println(response.getMessage());
}