getReplicateInfo()

This operation gets replication checkpoint information for a target physical channel. Use it before dumping messages or diagnosing cross-cluster replication progress.

public GetReplicateInfoResp getReplicateInfo(GetReplicateInfoReq request)

Request Syntax

getReplicateInfo(GetReplicateInfoReq.builder()
    .sourceClusterId(String sourceClusterId)
    .targetPchannel(String targetPchannel)
    .build());

BUILDER METHODS:

• sourceClusterId(String sourceClusterId)

  The source cluster ID to inspect.

• targetPchannel(String targetPchannel)

  The target physical channel whose replicate checkpoint should be returned.

RETURN TYPE:

GetReplicateInfoResp

RETURNS:

A GetReplicateInfoResp object that contains the replication checkpoint information of the target physical channel.

• getCheckpoint() (ReplicateCheckpoint) -

  The replicate checkpoint of the target physical channel.

• getSalvageCheckpoint() (ReplicateCheckpoint) -

  The salvage checkpoint of the target physical channel.

Each ReplicateCheckpoint object has the following getters:

• getClusterId() (String) -

  The ID of the source cluster.

• getPchannel() (String) -

  The physical channel the checkpoint belongs to.

• getMessageID() (MessageID) -

  The WAL message ID. It has the following getters:

  • getId() (String) -

    The ID of the message.

  • getWalName() (String) -

    The name of the WAL. Supports RocksMQ, Pulsar, Kafka, and WoodPecker.

• getTimeTick() (Long) -

  The timetick of the checkpoint.

EXCEPTIONS:

• MilvusClientException

  This exception will be raised when validation fails or the server returns an error for this operation.

Example

import io.milvus.v2.client.ConnectConfig;
import io.milvus.v2.client.MilvusClientV2;
import io.milvus.v2.service.cdc.request.GetReplicateInfoReq;
import io.milvus.v2.service.cdc.response.GetReplicateInfoResp;

// 1. Set up a client
ConnectConfig connectConfig = ConnectConfig.builder()
        .uri("http://localhost:19530")
        .token("root:Milvus")
        .build();
        
MilvusClientV2 client = new MilvusClientV2(connectConfig);


// 2. Get replication info for a cluster and channel
GetReplicateInfoResp resp = client.getReplicateInfo(GetReplicateInfoReq.builder()
        .sourceClusterId("cluster-a")
        .targetPchannel("by-dev-rootcoord-dml_0_123v0")
        .build());
System.out.println(resp.getCheckpoint());

Related operations

• getReplicateConfiguration()

• dumpMessages()

• updateReplicateConfiguration()