Skip to main content

dropCollection()

A MilvusClient interface. This method drops a specified collection.

📘This method drops all data within the collection.
R<RpcStatus> dropCollection(DropCollectionParam requestParam);

DropCollectionParam​

Use the DropCollectionParam.Builder to construct a DropCollectionParam object.

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

Methods of DropCollectionParam.Builder:

Method

Description

Parameters

withCollectionName(String collectionName)

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

collectionName: The name of the collection to drop.

withDatabaseName(String databaseName)

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

databaseName: The database name.

build()

Constructs a DropCollectionParam object

N/A

The DropCollectionParam.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 the error message of the exception.

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

Example​

import io.milvus.param.*;

DropCollectionParam dropParam = DropCollectionParam.newBuilder()
.withCollectionName(COLLECTION_NAME)
.build();

R<RpcStatus> response = client.dropCollection(dropParam);
if (response.getStatus() != R.Status.Success.getCode()) {
System.out.println(response.getMessage());
}