connector_status
Creates, updates, deletes, gets or lists a connector_status resource.
Overview
| Name | connector_status |
| Type | Resource |
| Id | confluent.connect.connector_status |
Fields
The following fields are returned by SELECT queries:
- read_connectv1_connector_status
Connector.
| Name | Datatype | Description |
|---|---|---|
name | string | The name of the connector. |
connector | object | The map containing connector status. |
tasks | array | The map containing the task status. |
type | string | Type of connector, sink or source. (sink, source) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
read_connectv1_connector_status | select | connector_name, environment_id, kafka_cluster_id | Get current status of the connector. This includes whether it is running, failed, or paused. Also includes which worker it is assigned to, error information if it has failed, and the state of all its tasks. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
connector_name | string | The unique name of the connector. |
environment_id | string | The unique identifier of the environment this resource belongs to. |
kafka_cluster_id | string | The unique identifier for the Kafka cluster. |
SELECT examples
- read_connectv1_connector_status
Get current status of the connector. This includes whether it is running, failed, or paused. Also includes which worker it is assigned to, error information if it has failed, and the state of all its tasks.
SELECT
name,
connector,
tasks,
type
FROM confluent.connect.connector_status
WHERE connector_name = '{{ connector_name }}' -- required
AND environment_id = '{{ environment_id }}' -- required
AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required
;