getSlaveReplicationStatus

Syntax

getSlaveReplicationStatus([limit=-1])

Details

This function displays the cluster replication task status in the slave cluster. It can only be executed by an administrator on the controller of a slave cluster. If slaveReplicationDBScope is configured, the function only returns replication status for the specified databases. Finished tasks are listed first, followed by unfinished tasks.

The function returns:

• All tasks if limit is not specified
• Up to limit tasks (including both completed and pending) if specified
• Maximum of 10,000 most recent completed tasks
• Pending tasks starting from the earliest timestamp until reaching the specified limit

Parameters

limit (optional) is an integer that specifies the maximum tasks that can be returned in the result. The default value is -1, meaning no limit is placed.

Returns

Return value: A table where finished tasks are listed first, then followed by unfinished tasks. The function returns:

• All tasks if limit is not specified
• Up to limit tasks (including both completed and pending) if specified
• Maximum of 10,000 most recent completed tasks
• Pending tasks starting from the earliest timestamp until reaching the specified limit

Return columns:

• taskId: ID of asynchronous replication task.
• masterTid: transaction ID in the master cluster.
• groupId: ID of the group to which the asynchronous replication task belongs.
• queueId: ID of the execution queue to which the replication task belongs.
• operationType: operation type of the replication task.
• createTime: the time (of NANOTIMESTAMP type) when the slave cluster receives the task from the master cluster.
• dbName: the database name where the task is executed.
• tableName: the table name where the task is executed.
• srcIP: IP of the data node where data of write tasks is stored.
• srcPort: port of the data node where data of write tasks is stored.
• finishTime: the time (of NANOTIMESTAMP type) when the task is finished.
• executionNode: the data node where the task is executed.
• state: the task state, including WAITING, EXECUTING, FINISH, and FAILED.
• details: If state = FAILED, returns the failure cause; If state = FINISH, provides additional description on the task.

Examples

getSlaveReplicationStatus();