From 30fbdf4805353997d27f5ddd2303903926d38787 Mon Sep 17 00:00:00 2001 From: Justin Mclean Date: Thu, 3 Sep 2026 01:54:31 +0000 Subject: [PATCH 1/2] docs(readme): correct partition IDs in the quickstart The quickstart described a topic with 2 partitions as having IDs 1 and 2, sent to --partition-id 1 and polled partition 1. Stream, topic and partition IDs are assigned starting from 0, so a topic created with 2 partitions has partitions 0 and 1. Use partition 0 throughout. Also says "the first message" and "a second message" rather than "message ID 1" and "message ID 2", which read as a claim about server-assigned IDs when they only meant the first and second example. --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 74690f17e1..fb64589a76 100644 --- a/README.md +++ b/README.md @@ -317,7 +317,7 @@ Get `dev` stream details: `cargo run --bin iggy -- -u -p stream get dev` -Create a topic named `sample` (numerical ID will be assigned by server automatically) for stream `dev`, with 2 partitions (IDs 1 and 2), no topic compression (`none`), and disabled message expiry (skipped optional parameter). Other compression values are reserved for future server-side support: +Create a topic named `sample` (numerical ID will be assigned by server automatically) for stream `dev`, with 2 partitions (IDs 0 and 1), no topic compression (`none`), and disabled message expiry (skipped optional parameter). Other compression values are reserved for future server-side support: `cargo run --bin iggy -- -u -p topic create dev sample 2 none` @@ -329,17 +329,17 @@ Get topic details for topic `sample` in stream `dev`: `cargo run --bin iggy -- -u -p topic get dev sample` -Send a message 'hello world' (message ID 1) to the stream `dev` to topic `sample` and partition 1: +Send the first message 'hello world' to the stream `dev` to topic `sample` and partition 0: -`cargo run --bin iggy -- -u -p message send --partition-id 1 dev sample "hello world"` +`cargo run --bin iggy -- -u -p message send --partition-id 0 dev sample "hello world"` -Send another message 'lorem ipsum' (message ID 2) to the same stream, topic and partition: +Send a second message 'lorem ipsum' to the same stream, topic and partition: -`cargo run --bin iggy -- -u -p message send --partition-id 1 dev sample "lorem ipsum"` +`cargo run --bin iggy -- -u -p message send --partition-id 0 dev sample "lorem ipsum"` -Poll messages by a regular consumer with ID 1 from the stream `dev` for topic `sample` and partition with ID 1, starting with offset 0, messages count 2, without auto commit (storing consumer offset on server): +Poll messages by a regular consumer with ID 1 from the stream `dev` for topic `sample` and partition with ID 0, starting with offset 0, messages count 2, without auto commit (storing consumer offset on server): -`cargo run --bin iggy -- -u -p message poll --consumer 1 --offset 0 --message-count 2 --auto-commit dev sample 1` +`cargo run --bin iggy -- -u -p message poll --consumer 1 --offset 0 --message-count 2 --auto-commit dev sample 0` Finally, restart the server to see it is able to load the persisted data. From 8b55034c5bc38e2988601799115e47632d02dc9b Mon Sep 17 00:00:00 2001 From: Justin Mclean Date: Thu, 3 Sep 2026 02:11:54 +0000 Subject: [PATCH 2/2] docs(readme): the quickstart poll does use auto commit The poll example described itself as "without auto commit (storing consumer offset on server)" while the command passes --auto-commit. The parenthetical describes what auto commit does, so the prose was the half that was wrong. --auto-commit is documented in the CLI as "whether to commit offset on the server automatically after polling the messages", which is what the example intends to show. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fb64589a76..1700f19c95 100644 --- a/README.md +++ b/README.md @@ -337,7 +337,7 @@ Send a second message 'lorem ipsum' to the same stream, topic and partition: `cargo run --bin iggy -- -u -p message send --partition-id 0 dev sample "lorem ipsum"` -Poll messages by a regular consumer with ID 1 from the stream `dev` for topic `sample` and partition with ID 0, starting with offset 0, messages count 2, without auto commit (storing consumer offset on server): +Poll messages by a regular consumer with ID 1 from the stream `dev` for topic `sample` and partition with ID 0, starting with offset 0, messages count 2, with auto commit (storing consumer offset on server): `cargo run --bin iggy -- -u -p message poll --consumer 1 --offset 0 --message-count 2 --auto-commit dev sample 0`