Skip to content

[MINOR] Improve docs for Global Store operations #6803

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

Merged
bbejeck merged 2 commits into from
May 30, 2019
Merged

[MINOR] Improve docs for Global Store operations #6803

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4b4a45
Updated docs
ableegoldman May 24, 2019
3bd47a1
Github suggestion
ableegoldman May 24, 2019
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
4 changes: 3 additions & 1 deletion streams/src/main/java/org/apache/kafka/streams/StreamsBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,9 @@ public synchronized StreamsBuilder addGlobalStore(final StoreBuilder storeBuilde
* of the input topic.
* <p>
* The provided {@link ProcessorSupplier} will be used to create an {@link ProcessorNode} that will receive all
* records forwarded from the {@link SourceNode}.
* records forwarded from the {@link SourceNode}. NOTE: you should not use this to insert transformed records into

@mjsax mjsax May 24, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nit: remove use this to

Or use the {@code Processor} to

@ableegoldman ableegoldman May 24, 2019

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Ack

* the global state store. This store uses the source topic as changelog and during restore will insert records directly
* from the source.
* This {@link ProcessorNode} should be used to keep the {@link StateStore} up-to-date.
* The default {@link TimestampExtractor} as specified in the {@link StreamsConfig config} is used.
* <p>
Expand Down