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

docs: Add information about new methods #520

Merged
merged 2 commits into from Feb 12, 2024
Merged

docs: Add information about new methods #520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
529ff00
docs: add information about new methods
Feb 8, 2024
54af968
docs: fix information about storing offset manually
Feb 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 2 additions & 3 deletions website/docs/guides/consumers/add-consumers.md
View file
Open in desktop
Expand Up @@ -106,9 +106,8 @@ services.AddKafka(kafka => kafka
## Store Offsets Manually

By default, offsets are stored after the handler and middleware execution automatically.
This is the equivalent to configure the consumer as `WithAutoStoreOffsets()`.

To control Offset storing, it's possible to configure using `WithManualStoreOffsets()` as the following example:
To control Offset storing, it's possible to configure using `WithManualMessageCompletion()` as the following example:


```csharp
Expand All @@ -121,7 +120,7 @@ services.AddKafka(kafka => kafka
.AddConsumer(consumer => consumer
.Topic("topic-name")
.WithGroupId("sample-group")
.WithManualStoreOffsets()
.WithManualMessageCompletion()
...
)
)
Expand Down
3 changes: 3 additions & 0 deletions website/docs/guides/migration/from-v2-to-v3.md
View file
Open in desktop
Expand Up @@ -244,6 +244,9 @@ For the KafkaFlow engine to adapt to the dynamic change of workers, the way the

To achieve this, a new method in the message context was provided to signal the message completion `.Complete()`. Additionally, a new property called `AutoMessageCompletion` was added to signal if KafkaFlow should signal the message as completed automatically which is the default behavior. This property is useful for scenarios where we don't want to complete the message right away, for example in Batch Consume scenarios.

- Use `WithManualMessageCompletion()` instead of `WithManualStoreOffsets()`.
- Use `context.ConsumerContext.Complete()` instead of `context.ConsumerContext.StoreOffset()`.

### 1.3 Expose Worker Events to Client Applications

> Related Issues: [#427](https://github.com/Farfetch/kafkaflow/issues/427)
Expand Down