summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index d8aa6c2..5bea283 100644
--- a/README.md
+++ b/README.md
@@ -14,26 +14,32 @@ Copyright 2012, David Arthur under Apache License, v2.0. See `LICENSE`
You need to specify the topic and partition
+```python
kafka = KafkaClient("localhost", 9092)
kafka.send_messages_simple("my-topic", 0, "some message")
kafka.close()
+```
## Send several messages to a topic
Same as before, just add more arguments to `send_simple`
+```python
kafka = KafkaClient("localhost", 9092)
kafka.send_messages_simple("my-topic", 0, "some message", "another message", "and another")
kafka.close()
+```
## Recieve some messages from a topic
Supply `get_message_set` with a `FetchRequest`, get back the messages and new `FetchRequest`
+```python
kafka = KafkaClient("localhost", 9092)
req = FetchRequest("my-topic", 0, 0, 1024*1024)
(messages, req1) = kafka.get_message_set(req)
kafka.close()
+```
The returned `FetchRequest` includes the offset of the next message. This makes
paging through the queue very simple.
@@ -42,6 +48,7 @@ paging through the queue very simple.
For this we use the `send_multi_message_set` method along with `ProduceRequest` objects.
+```python
kafka = KafkaClient("localhost", 9092)
req1 = ProduceRequest("my-topic-1", 0, [
create_message_from_string("message one"),
@@ -53,23 +60,28 @@ For this we use the `send_multi_message_set` method along with `ProduceRequest`
])
kafka.sent_multi_message_set([req1, req1])
kafka.close()
-
+```
+
## Iterate through all messages from an offset
The `iter_messages` method will make the underlying calls to `get_message_set`
to provide a generator that returns every message available.
+```python
kafka = KafkaClient("localhost", 9092)
for msg in kafka.iter_messages(FetchRequest("my-topic", 0, 0, 1024*1024)):
print(msg.payload)
kafka.close()
+```
An optional `auto` argument will control auto-paging through results
+```python
kafka = KafkaClient("localhost", 9092)
for msg in kafka.iter_messages(FetchRequest("my-topic", 0, 0, 1024*1024), False):
print(msg.payload)
kafka.close()
+```
-This will only iterate through messages in the first byte range of
+This will only iterate through messages in the byte range of
(0, 1024\*1024)