2.23 Actions with connector
The connector states include:
| State | Description |
|---|---|
PAUSED | The connector has been paused; it does not process data but retains its current state and configuration |
STOPPED | The connector has been stopped |
RUNNING | The connector is running and processing data |
FAILED | The connector encountered an error and cannot continue processing data |
The following actions can be performed on a connector according to the state transition matrix below:
| From state & Action | Stop | Resume | Pause | Restart | Reset offset | Delete |
|---|---|---|---|---|---|---|
RUNNING | ✅ | - | ✅ | ✅ | - | - |
PAUSED | ✅ | ✅ | - | - | - | - |
FAILED | ✅ | - | - | ✅ | - | - |
STOPPED | - | ✅ | - | - | ✅ | ✅ |
Use cases:
| Action | Description |
|---|---|
| Restart | Restart the connector |
| Pause | Pause the connector and its tasks, stopping message processing until the connector is resumed. This action is asynchronous, and the tasks will not transition to the PAUSED state at the same time.• Effects: – The connector and its tasks will stop processing data. – The connector remains in the system and can be resumed (continued) at any time. – The connector's offsets (data read positions) are preserved and not lost. • When to use: – When you want to pause data processing without deleting or completely stopping the connector. – When system maintenance or temporary troubleshooting is needed. |
| Resume | Resume a paused connector. This action is asynchronous, and the tasks will not transition to the running state at the same time |
| Stop | Stop the connector without deleting it. All tasks for the connector will be completely shut down. • Effects: – The connector and its tasks will stop running. – The connector is removed from the list of running connectors. – The connector's configuration is deleted, and the connector must be recreated from scratch if you want to use it again. • When to use: – When you no longer need that connector. – When you want to fully remove the connector to free up resources or replace it with a new one. |
| Reset offset | Reset the offset value for the connector, so the connector reads data again from the beginning |