Skip to content

[KAFKA-10722] doc: Described the types of the stores used #9607

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
mjsax merged 2 commits into from
Dec 1, 2020
Merged

[KAFKA-10722] doc: Described the types of the stores used #9607

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39eb477
doc: Described the types of the stores used
fml2 Nov 17, 2020
faa5c52
docs: Improved wording
fml2 Nov 18, 2020
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
6 changes: 6 additions & 0 deletions docs/streams/developer-guide/dsl-api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -870,6 +870,12 @@ <h4 class="anchor-heading"><a id="streams_concepts_globalktable" class="anchor-l
<p id="streams-developer-guide-dsl-transformations-stateful-overview">Stateful transformations depend on state for processing inputs and producing outputs and require a <a class="reference internal" href="../architecture.html#streams_architecture_state"><span class="std std-ref">state store</span></a> associated with the stream processor. For example, in aggregating operations, a windowing state store is used to collect the latest aggregation results per
window. In join operations, a windowing state store is used to collect all of the records received so far within the
defined window boundary.</p>
<p><b>Note:</b> Following store types are used regardless of the possibly specified type (via the parameter <code class="docutils literal"><span class="pre">materialized</span></code>):
<ul class="simple">
<li>non-windowed aggregations and plain KTables use <a class="reference external" href="/{{version}}/javadoc/org/apache/kafka/streams/state/TimestampedKeyValueStore.html">TimestampedKeyValueStore</a>s</li>

@mjsax mjsax Nov 17, 2020

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.

Maybe we should say non-windowed KTable -- "plain" does not sound technical.

@fml2 fml2 Nov 18, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

OK, will do.

<li>time-windowed aggregations and kstream-kstream joins use <a class="reference external" href="/{{version}}/javadoc/org/apache/kafka/streams/state/TimestampedWindowStore.html">TimestampedWindowStore</a>s</li>

@mjsax mjsax Nov 17, 2020

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.

kstream-kstream -> KStream-KStream

@fml2 fml2 Nov 18, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

OK, will do.

Why did the build fail?

<li>session windowed aggregations use <a class="reference external" href="/{{version}}/javadoc/org/apache/kafka/streams/state/SessionStore.html">SessionStore</a>s (there is no timestamped session store as of now)</li>
</ul>
<p>Note, that state stores are fault-tolerant.
In case of failure, Kafka Streams guarantees to fully restore all state stores prior to resuming the processing.
See <a class="reference internal" href="../architecture.html#streams_architecture_recovery"><span class="std std-ref">Fault Tolerance</span></a> for further information.</p>
Expand Down