---
title: "system.kafka.pollPartition"
description: "Returns a list of records polled from a specified partition."
---

# system.kafka.pollPartition

> Returns a list of records polled from a specified partition.

This function is used in **Python Scripting**.

## Description
## Client Permission Restrictions
This scripting function has no [Client Permission](ignition-modules\vision\vision-project-properties\vision-project-properties.md#vision-permissions-properties) restrictions.

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

### Parameters

| Type | Parameter | Description |
|---|---|---|
| String | `connector` | The name of the Kafka connector. |
| String | `topic` | The name of the Kafka topic. |
| Integer | `partition` | The partition to poll. |
| Long | `offset` | The position of offset to start the poll at. |
| Dictionary | `options` | Custom options specific to the consumer, with key value string pairs. Optional. |
| Integer | `sizeCutoff` |  The total record count allowed before polling will be stopped. |
| Long | `timeoutMs` |  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
```python title="Example #1"
# Get a list of records from the specified partition.
system.kafka.pollPartition("MyKafkaConnector", "MyKafkaTopic", 2, 4, 5, 1000 )
```