Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix manual commit documentation page is misleading #1071

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix manual commit documentation page is misleading #1071

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/examples/manual_commit.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Manual commit
=============

When processing more sensitive data ``enable_auto_commit=False`` mode of
Consumer can lead to data loss in cases of critical failure. To avoid it we
can commit offsets manually after they were processed. Note, that this is a
tradeoff from *at most once* to *at least once* delivery, to achieve
*exactly once* you will need to save offsets in the destination database and
validate those yourself.
When processing sensitive data, setting ``enable_auto_commit=True`` for the
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This way it's probably misleading too, as it's True by default. Maybe something like this?

Suggested change
When processing sensitive data, setting ``enable_auto_commit=True`` for the
When processing sensitive data, using ``enable_auto_commit=True`` (default) for the

Consumer can lead to data loss in the event of a critical failure. To avoid
this, set ``enable_auto_commit=False`` and commit offsets manually only after
messages have been processed. Note, that this is a tradeoff from *at most once*
to *at least once* delivery, to achieve *exactly once* you will need to save
offsets in the destination database and validate those yourself.

More on message delivery: https://kafka.apache.org/documentation.html#semantics

Expand Down