TruncateCollection()

Truncate a collection, removing all data while keeping the collection structure.

Status TruncateCollection(const TruncateCollectionRequest& request)

Request Syntax

auto request = TruncateCollectionRequest()
    .WithDatabaseName(db_name)
    .WithCollectionName(collection_name);

REQUEST METHODS:

• WithDatabaseName(const std::string& db_name)

  Set target db name, use default database if it is empty.

• SetDatabaseName(const std::string& db_name)

  Set target db name, use default database if it is empty.

• WithCollectionName(const std::string& collection_name)

  Set name of the collection.

• SetCollectionName(const std::string& collection_name)

  Set the collection name.

RETURNS:

Status

Returns a status indicating whether the operation succeeded.

ERROR HANDLING:

• Status

  Failures are reported through the returned Status. The SDK converts internal exceptions into a non-OK Status; public API calls do not throw. Inspect status.IsOk() and status.Message() for failure details.

Example

Demonstrates TruncateCollection() with the C++ SDK.

auto client = milvus::MilvusClientV2::Create();
milvus::ConnectParam connect_param{"http://localhost:19530", "root:Milvus"};
util::CheckStatus(client->Connect(connect_param));

auto request = milvus::TruncateCollectionRequest();
util::CheckStatus(client->TruncateCollection(request));