mjsax commented on code in PR #14725:
URL: https://github.com/apache/kafka/pull/14725#discussion_r1407384770
##########
docs/streams/upgrade-guide.html:
##########
@@ -198,6 +198,16 @@ <h3><a id="streams_api_changes_360"
href="#streams_api_changes_360">Streams API
</code>
</pre>
</p>
+
+ <p>
+ KStreams-to-KTable joins now have an option for adding a grace period.
+ The grace period is enabled on the <code>Joined</code> object using
with <code>withGracePeriod()</code> method.
+ This change was introduced in <a
href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-923%3A+Add+A+Grace+Period+to+Stream+Table+Join";>KIP-923</a>.
+ To use the grace period option in the Stream-Table join the table must
be versioned, see the
+ <a
href="/{{version}}/documentation/streams/developer-guide/dsl-api.html#versioned-state-stores">Developer
Guide</a>.
+ For more information, including how it can be enabled and further
configured, see the <a
href="/{{version}}/documentation/streams/developer-guide/dsl-api.html#kstream-ktable-join"><b>Kafka
Streams Developer Guide</b></a>.
Review Comment:
```
the table must be versioned, see the
<a
href="/{{version}}/documentation/streams/developer-guide/dsl-api.html#versioned-state-stores">Developer
Guide</a>.
```
Use `versioned` as link and remove the `, see the Developer Guide` part.
(This change also avoid the usage of `Developer Guide` in a similar way in
two consecutive sentences.
##########
docs/streams/developer-guide/dsl-api.html:
##########
@@ -2849,6 +2851,12 @@ <h5><a class="toc-backref" href="#id34">KTable-KTable
Foreign-Key
<li>When the table is <a
class="reference internal" href="#versioned-state-stores"><span class="std
std-ref">versioned</span></a>,
the table record to join with is
determined by performing a timestamped lookup, i.e., the table record which is
joined will be the latest-by-timestamp record with timestamp
less than or equal to the stream
record timestamp. If the stream record timestamp is older than the table's
history retention, then the record is dropped.</li>
+ <li>To use the Grace Period, the table
needs to be <a class="reference internal" href="#versioned-state-stores"><span
class="std std-ref">versioned</span></a>.
+ This will cause the stream to
buffer for that duration before trying to find a matching record with the right
timestamp in the table.
Review Comment:
> for that duration
unclear reference -> `for the specified grace period` (or something like
this?)
##########
docs/streams/developer-guide/dsl-api.html:
##########
@@ -2849,6 +2851,12 @@ <h5><a class="toc-backref" href="#id34">KTable-KTable
Foreign-Key
<li>When the table is <a
class="reference internal" href="#versioned-state-stores"><span class="std
std-ref">versioned</span></a>,
the table record to join with is
determined by performing a timestamped lookup, i.e., the table record which is
joined will be the latest-by-timestamp record with timestamp
less than or equal to the stream
record timestamp. If the stream record timestamp is older than the table's
history retention, then the record is dropped.</li>
+ <li>To use the Grace Period, the table
needs to be <a class="reference internal" href="#versioned-state-stores"><span
class="std std-ref">versioned</span></a>.
Review Comment:
`[g]race [p]eriod`
not need to capitalize?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
