POST api/v1/mirrors/status This endpoint is used to get the status of a mirror. Status of the mirror could be:
STATUS_SETUP: The mirror is in setup flow, where it creates target tables and metadata tables.STATUS_SNAPSHOT: The mirror is currently performing initial load.STATUS_RUNNING: The mirror has completed initial load and is in the phase of CDC.STATUS_PAUSED: The mirror is in CDC phase and is paused .STATUS_PAUSING: The mirror is in CDC phase and is in the process of pausing.STATUS_TERMINATED: The mirror has been deleted/terminated.STATUS_UNKNOWN: The mirror is not found in the catalog, or its status cannot be obtained due to some issue.
Request Body The request consists of the mirror name specified as flowJobName
and includeFlowInfo as a boolean, which when set, will include in its response
additional, non-status related information about the mirror
such as mirror configuration and initial load information of tables.
The name of the mirror to get the status of.
When set to true, will include in its response
additional, non-status related information about the mirror
such as mirror configuration and initial load information of tables.
Response Fields The current state of the mirror.
Indicates if the request was successful.
Additional flow information when includeFlowInfo is set to true:
Information about the mirror configuration and initial load of tables.
Array of table mapping objects. Each object contains the following fields.
The source table identifier. Will be of the form schema.table.
destinationTableIdentifier
The destination table identifier.
Pull batch size: the maximum number of rows to pull in a single batch, if idleTimeoutSeconds has not been reached.
The time in seconds after which the mirror will flush pulled rows to the target data store,
if pull batch size has not already been reached.
User provided publication name for the mirror, if any.
User provided replication slot name for the mirror, if any.
Indicates if initial snapshot was enabled for this mirror.
snapshotNumRowsPerPartition
The number of rows to sync per partition during initial snapshot.
snapshotMaxParallelWorkers
The maximum number of parallel workers to use during initial snapshot.
snapshotNumTablesInParallel
The number of tables to sync in parallel during initial snapshot.
Indicates if this mirror is a resync
Indicates if this mirror was configured to only run initial load and not CDC.
Indicates if soft delete is enabled.
The name of the column used for soft delete.
The name of the column used for tracking sync time.
Lua script configured for the mirror.
The data type system of the mirror.
The destination peer name.
Information about the initial load of tables.
Array of clone objects - each indicating initial load information of a table.
Each object contains the following fields.
The name of the destination table.
The time when the clone started.
The number of partitions completed.
The total number of partitions.
The number of rows synced.
The average time taken to sync each partition, in milliseconds.
The name of the clone job.
Indicates if fetching is completed.
Indicates if consolidation (loading of stage files to target tables) is completed.
The source peer type. Example: "POSTGRES"
The destination peer type. Example: "BIGQUERY"
Request
with includeFlowInfo set
curl --request POST \ --url http://localhost:3000/api/v1/mirrors/status \ --header 'Authorization: Basic OnBlZXJkYg==' \ --header 'Content-Type: application/json' \ --data '{ `flowJobName`:`testing_bq_2`, `includeFlowInfo`:false }'
Response
with includeFlowInfo set
Error example
{ "flowJobName" : "testing_bq_2" , "errorMessage" : "" , "currentFlowState" : "STATUS_RUNNING" , "ok" : true }
