getOrcaCheckpointConfig
Syntax
getOrcaCheckpointConfig(name)
Arguments
name is a string representing the name of the stream graph. You can provide either the fully qualified name (FQN), such as "catalog_name.orca_graph.graph_name", or just the graph name, like "factors". If only the name is given, the system will automatically complete it using the current catalog.
Details
Retrieve the Checkpoint configuration of the specified streaming graph.
Return value: a dictionary containing the following fields:
| key | Description |
|---|---|
| enable | Whether Checkpoint is enabled |
| checkpointMod | Consistency level of the streaming graph, excluding
sink nodes:
|
| interval | Time interval to trigger Checkpoint, in milliseconds |
| timeout | Timeout for Checkpoint. If Checkpoint is not completed within the specified time, it will be considered failed, in milliseconds |
| alignedTimeout | Timeout for Barrier alignment. If alignment is not completed within the specified time, the Checkpoint will be considered failed, in milliseconds |
| minIntervalBetweenCkpt | Minimum time interval between the completion of the last Checkpoint and the initiation of the next Checkpoint |
| consecutiveFailures | Maximum number of consecutive Checkpoint failures. If exceeded, the status of the entire streaming graph will be switched to ERROR. |
| maxConcurrentCheckpoints | Maximum number of concurrent Checkpoints allowed. Please note that allowing concurrent Checkpoints may impact running streaming jobs. |
| maxRetainedCheckpoints | The system will periodically clean up historical Checkpoint data. |
Examples
// where name is the name of the streaming graph
getOrcaCheckpointConfig("streamGraph1")
// where name is the fully qualified name
getOrcaCheckpointConfig("catalog1.orca_graph.streamGraph1")