openstack/deb-python-kafka
Code Issues Proposed changes

Improve KafkaProducer docstring re retries config

Browse Source
This commit is contained in:
Dana Powers
2016-08-20 17:41:45 -07:00
parent e50d4dde3c
commit 754ff8954e
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
kafka/producer/kafka.py
View File

@@ -121,10 +121,12 @@ class KafkaProducer(object):
retries (int): Setting a value greater than zero will cause the client retries (int): Setting a value greater than zero will cause the client
to resend any record whose send fails with a potentially transient to resend any record whose send fails with a potentially transient
error. Note that this retry is no different than if the client error. Note that this retry is no different than if the client
resent the record upon receiving the error. Allowing retries will resent the record upon receiving the error. Allowing retries
potentially change the ordering of records because if two records without setting max_in_flight_connections_per_connection to 1 will
potentially change the ordering of records because if two batches
are sent to a single partition, and the first fails and is retried are sent to a single partition, and the first fails and is retried
but the second succeeds, then the second record may appear first. but the second succeeds, then the records in the second batch may
appear first.
Default: 0. Default: 0.
batch_size (int): Requests sent to brokers will contain multiple batch_size (int): Requests sent to brokers will contain multiple
batches, one for each partition with data available to be sent. batches, one for each partition with data available to be sent.