Skip to main content

connector_offsets

Creates, updates, deletes, gets or lists a connector_offsets resource.

Overview​

Nameconnector_offsets
TypeResource
Idconfluent.connect.connector_offsets

Fields​

The following fields are returned by SELECT queries:

Connector Offsets.

NameDatatypeDescription
idstringThe ID of the connector.
namestringThe name of the connector.
metadataobjectMetadata of the connector offset.
offsetsarrayArray of offsets which are categorised into partitions.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_connectv1_connector_offsetsselectconnector_name, environment_id, kafka_cluster_idGet the current offsets for the connector. The offsets provide information on the point in the source system,
from which the connector is pulling in data. The offsets of a connector are continuously observed periodically and are queryable via this API.

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.

NameDatatypeDescription
connector_namestringThe unique name of the connector.
environment_idstringThe unique identifier of the environment this resource belongs to.
kafka_cluster_idstringThe unique identifier for the Kafka cluster.

SELECT examples​

Get the current offsets for the connector. The offsets provide information on the point in the source system,
from which the connector is pulling in data. The offsets of a connector are continuously observed periodically and are queryable via this API.

SELECT
id,
name,
metadata,
offsets
FROM confluent.connect.connector_offsets
WHERE connector_name = '{{ connector_name }}' -- required
AND environment_id = '{{ environment_id }}' -- required
AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required
;