getCompactionPlans()

This operation returns the compaction plans for a specific compaction job, including the merge plans showing which segments will be combined.

public GetCompactionPlansResp getCompactionPlans(GetCompactionPlansReq request)

Request Syntax

getCompactionPlans(GetCompactionPlansReq.builder()
    .compactionID(Long compactionID)
    .build()
);

BUILDER METHODS:

• compactionID(Long compactionID) -

  [REQUIRED]

  The ID of the compaction job returned by compact().

RETURN TYPE:

GetCompactionPlansResp

RETURNS:

A GetCompactionPlansResp object that contains the compaction state and merge plans.

• getCompactionId() (Long) -

  The ID of the compaction.

• getState() (CompactionState) -

  The state of the compaction.

• getPlans() (List) -

  The merge plans of the compaction. Each CompactionPlan has the following getters:

  • getTarget() (Long) -

    The ID of the target segment.

  • getSources() (List) -

    The IDs of the source segments.

EXCEPTIONS:

• MilvusClientException

  This exception will be raised when any error occurs during this operation.

Example

import io.milvus.v2.service.utility.request.GetCompactionPlansReq;
import io.milvus.v2.service.utility.response.GetCompactionPlansResp;

GetCompactionPlansResp plans = client.getCompactionPlans(
    GetCompactionPlansReq.builder()
        .compactionID(jobId)
        .build()
);
System.out.println(plans);