summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDana Powers <dana.powers@gmail.com>2016-08-20 17:41:45 -0700
committerDana Powers <dana.powers@gmail.com>2016-08-20 17:41:45 -0700
commit754ff8954e2ab149cfa2b79cd21c85b84602e7c8 (patch)
tree3e7bd5ac41a1051816d292b209c5efddcba424a2
parente50d4dde3c2634fc33168a869314e91769573dd4 (diff)
downloadkafka-python-754ff8954e2ab149cfa2b79cd21c85b84602e7c8.tar.gz
Improve KafkaProducer docstring re retries config
-rw-r--r--kafka/producer/kafka.py8
1 files changed, 5 insertions, 3 deletions
diff --git a/kafka/producer/kafka.py b/kafka/producer/kafka.py
index 84039f6..3927a72 100644
--- a/kafka/producer/kafka.py
+++ b/kafka/producer/kafka.py
@@ -121,10 +121,12 @@ class KafkaProducer(object):
retries (int): Setting a value greater than zero will cause the client
to resend any record whose send fails with a potentially transient
error. Note that this retry is no different than if the client
- resent the record upon receiving the error. Allowing retries will
- potentially change the ordering of records because if two records
+ resent the record upon receiving the error. Allowing retries
+ 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
- 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.
batch_size (int): Requests sent to brokers will contain multiple
batches, one for each partition with data available to be sent.