Skip to main content
Version: 8.3

system.kafka.pollPartition

This function is used in Python Scripting.

Description​

Returns a list of records polled from a specified partition.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

system.kafka.pollPartition(connector, topic, partition, offset, [options], sizeCutoff, timeoutMs)

Parameters​

TypeParameterDescription
StringconnectorThe name of the Kafka connector.
StringtopicThe name of the Kafka topic.
IntegerpartitionThe partition to poll.
LongoffsetThe position of offset to start the poll at.
DictionaryoptionsCustom options specific to the consumer, with key value string pairs. Optional.
IntegersizeCutoff
New in 8.3.3
The total record count allowed before polling will be stopped.
LongtimeoutMs
New in 8.3.3
The amount of time in milliseconds before polling will be stopped.

Returns​

List - A list of records polled from a specified partition.

Scope​

Gateway

Code Examples​

Example #1
# Get a list of records from the specified partition.
system.kafka.pollPartition("MyKafkaConnector", "MyKafkaTopic", 2, 4, 5, 1000 )