Skip to main content

GetCompactionState()

This operation gets the status of a compaction job.

c++
Status GetCompactionState(const GetCompactionStateRequest& request, GetCompactionStateResponse& response)

Request Syntax

c++
auto request = GetCompactionStateRequest()
.WithCompactionID(id);

REQUEST METHODS:

  • WithCompactionID(int64_t id)

    Sets the compaction job ID returned by Compact().

RETURNS:

Status with GetCompactionStateResponse

Check status.IsOk() to confirm success.

EXCEPTIONS:

  • StatusCode

    Check status.Code() and status.Message() for error details.

Example

c++
#include "milvus/MilvusClientV2.h"
auto client = milvus::MilvusClientV2::Create();

milvus::ConnectParam connect_param{"YOUR_CLUSTER_ENDPOINT", "YOUR_CLUSTER_TOKEN"};
auto status = client->Connect(connect_param);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}

int64_t compaction_id = 12345; // obtained from Compact()

milvus::GetCompactionStateResponse response;
status = client->GetCompactionState(
milvus::GetCompactionStateRequest()
.WithCompactionID(compaction_id),
response);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
std::cout << "State: " << static_cast<int>(response.State()) << std::endl;
Minimum SDK versionv2.6.x
Ctrl I