diff options
| author | Dana Powers <dana.powers@rd.io> | 2014-09-14 23:38:24 -0700 |
|---|---|---|
| committer | Dana Powers <dana.powers@rd.io> | 2014-12-15 12:42:55 -0800 |
| commit | 8dc362320851e7e5b751a0196d91dfd25bb4e07f (patch) | |
| tree | 8b29710924c84d5180e193c7bab25757247a9fea | |
| parent | 67aa1a1c041d03a8139aac7081500ddd55665c46 (diff) | |
| download | kafka-python-8dc362320851e7e5b751a0196d91dfd25bb4e07f.tar.gz | |
raise KafkaConfigurationError in commit() if there is no configured 'group_id'; add docstring
| -rw-r--r-- | kafka/consumer/new.py | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/kafka/consumer/new.py b/kafka/consumer/new.py index e1273ea..72c471f 100644 --- a/kafka/consumer/new.py +++ b/kafka/consumer/new.py @@ -233,9 +233,16 @@ class KafkaConsumer(object): self._next_commit = time.time() + (self._config['auto_commit_interval_ms'] / 1000.0) def commit(self): + """ + Store consumed message offsets (marked via task_done()) + to kafka cluster for this consumer_group. + + Note -- this functionality requires server version >=0.8.1.1 + see https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol#AGuideToTheKafkaProtocol-OffsetCommit/FetchAPI + """ if not self._config['group_id']: logger.warning('Cannot commit without a group_id!') - raise RuntimeError('Attempted to commit offsets without a configured consumer group (group_id)') + raise KafkaConfigurationError('Attempted to commit offsets without a configured consumer group (group_id)') # API supports storing metadata with each commit # but for now it is unused |