Skip to content

InfluxDBBatchConfig

Source code in docs_src/capo_iot/types/influx_db_batch_config.py
class InfluxDBBatchConfig(TypedDict, closed=True):
    max_batch_size: NotRequired[
        "capo_iot.types.influx_db_max_batch_size.InfluxDBMaxBatchSize"
    ]
    """<p>The maximum number of data points to collect in a batch.</p> <p>If you don't specify a value, this limit doesn't apply. IoT then closes each batch when another configured limit is reached.</p>"""
    max_batch_open_ms: NotRequired[
        "capo_iot.types.influx_db_max_batch_open_ms.InfluxDBMaxBatchOpenMs"
    ]
    """<p>The maximum length of time, in milliseconds, to keep a batch open before writing it to InfluxDB.</p> <p>If you don't specify a value, this limit doesn't apply. IoT then closes each batch when another configured limit is reached.</p>"""
    max_batch_size_bytes: NotRequired[
        "capo_iot.types.influx_db_max_batch_size_bytes.InfluxDBMaxBatchSizeBytes"
    ]
    """<p>The maximum size of a batch, in bytes, before IoT writes it to InfluxDB.</p> <p>If you don't specify a value, this limit doesn't apply. IoT then closes each batch when another configured limit is reached.</p>"""
    batch_across_topics: (
        "capo_iot.types.influx_db_batch_across_topics.InfluxDBBatchAcrossTopics"
    )
    """<p>Specifies whether to collect data points from different topics into the same batch.</p> <p>If omitted or <code>false</code>, IoT batches data points for each topic separately.</p>"""

batch_across_topics instance-attribute

batch_across_topics: InfluxDBBatchAcrossTopics

Specifies whether to collect data points from different topics into the same batch.

If omitted or false, IoT batches data points for each topic separately.

max_batch_open_ms instance-attribute

max_batch_open_ms: NotRequired[InfluxDBMaxBatchOpenMs]

The maximum length of time, in milliseconds, to keep a batch open before writing it to InfluxDB.

If you don't specify a value, this limit doesn't apply. IoT then closes each batch when another configured limit is reached.

max_batch_size instance-attribute

max_batch_size: NotRequired[InfluxDBMaxBatchSize]

The maximum number of data points to collect in a batch.

If you don't specify a value, this limit doesn't apply. IoT then closes each batch when another configured limit is reached.

max_batch_size_bytes instance-attribute

max_batch_size_bytes: NotRequired[InfluxDBMaxBatchSizeBytes]

The maximum size of a batch, in bytes, before IoT writes it to InfluxDB.

If you don't specify a value, this limit doesn't apply. IoT then closes each batch when another configured limit is reached.