You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by GitBox <gi...@apache.org> on 2020/06/23 23:25:33 UTC

[GitHub] [kafka] mjsax commented on a change in pull request #8920: DOCS-4446: document timestamped state stores

mjsax commented on a change in pull request #8920:
URL: https://github.com/apache/kafka/pull/8920#discussion_r444554053



##########
File path: docs/streams/developer-guide/processor-api.html
##########
@@ -49,6 +49,7 @@
                         <li><a class="reference internal" href="#defining-and-creating-a-state-store" id="id4">Defining and creating a State Store</a></li>
                         <li><a class="reference internal" href="#fault-tolerant-state-stores" id="id5">Fault-tolerant State Stores</a></li>
                         <li><a class="reference internal" href="#enable-or-disable-fault-tolerance-of-state-stores-store-changelogs" id="id6">Enable or Disable Fault Tolerance of State Stores (Store Changelogs)</a></li>
+                        <li><a class="reference internal" href="#timestamped-state-stores" id="id11">Timestamped State Stores</a></li>

Review comment:
       Should we also extend `Defining and creating a State Store` ? -- It seems the section you added below, focuses on their usage?
   
   

##########
File path: docs/streams/developer-guide/processor-api.html
##########
@@ -343,6 +344,38 @@ <h2>
 </pre></div>
                 </div>
             </div>
+            <div class="section" id="timestamped-state-stores">
+                <span id="streams-developer-guide-state-store-timestamps"></span><h3><a class="toc-backref" href="#id11">Timestamped State Stores</a><a class="headerlink" href="#timestamped-state-stores" title="Permalink to this headline"></a></h3>
+                <p>
+                    Starting in Kafka Streams 2.3, you can store record timestamps in KTables.

Review comment:
       > Starting in Kafka Streams 2.3
   
   Do we need this?
   
   > can store
   
   `KTables` always store timestamps by default. Should we rephrase?

##########
File path: docs/streams/developer-guide/processor-api.html
##########
@@ -343,6 +344,38 @@ <h2>
 </pre></div>
                 </div>
             </div>
+            <div class="section" id="timestamped-state-stores">
+                <span id="streams-developer-guide-state-store-timestamps"></span><h3><a class="toc-backref" href="#id11">Timestamped State Stores</a><a class="headerlink" href="#timestamped-state-stores" title="Permalink to this headline"></a></h3>
+                <p>
+                    Starting in Kafka Streams 2.3, you can store record timestamps in KTables.
+                    A timestamped state store improves stream processing semantics and enables
+                    handling out-of-order data in source KTables, detecting out-of-order joins and aggregations,
+                    and getting the timestamp of the latest update in an Interactive Query.
+                </p>
+                <p>You can query timestamped state stores both with and without a timestamp.</p>
+                <p>
+                    Use <a class="reference external" href="/{{version}}/javadoc/org/apache/kafka/streams/state/TimestampedKeyValueStore.html">TimestampedKeyValueStore</a>
+                    when you need a key-(value/timestamp) store that supports put/get/delete and range queries. 
+                </p>
+                <p>
+                    Use <a class="reference external" href="/{{version}}/javadoc/org/apache/kafka/streams/state/TimestampedWindowStore.html">TimestampedWindowStore</a>
+                    when you need to store windowedKey-(value/timestamp) pairs.</p>
+                <p>
+                    The <a class="reference external" href="/{{version}}/javadoc/org/apache/kafka/streams/state/Stores.html">Stores</a>
+                    class provides corresponding factory methods for timestamped stores.</p>
+                <p>

Review comment:
       Seems this part belong to section `Defining and creating a State Store` ?

##########
File path: docs/streams/developer-guide/processor-api.html
##########
@@ -343,6 +344,38 @@ <h2>
 </pre></div>
                 </div>
             </div>
+            <div class="section" id="timestamped-state-stores">
+                <span id="streams-developer-guide-state-store-timestamps"></span><h3><a class="toc-backref" href="#id11">Timestamped State Stores</a><a class="headerlink" href="#timestamped-state-stores" title="Permalink to this headline"></a></h3>
+                <p>
+                    Starting in Kafka Streams 2.3, you can store record timestamps in KTables.
+                    A timestamped state store improves stream processing semantics and enables
+                    handling out-of-order data in source KTables, detecting out-of-order joins and aggregations,
+                    and getting the timestamp of the latest update in an Interactive Query.
+                </p>
+                <p>You can query timestamped state stores both with and without a timestamp.</p>
+                <p>
+                    Use <a class="reference external" href="/{{version}}/javadoc/org/apache/kafka/streams/state/TimestampedKeyValueStore.html">TimestampedKeyValueStore</a>
+                    when you need a key-(value/timestamp) store that supports put/get/delete and range queries. 
+                </p>
+                <p>
+                    Use <a class="reference external" href="/{{version}}/javadoc/org/apache/kafka/streams/state/TimestampedWindowStore.html">TimestampedWindowStore</a>
+                    when you need to store windowedKey-(value/timestamp) pairs.</p>
+                <p>
+                    The <a class="reference external" href="/{{version}}/javadoc/org/apache/kafka/streams/state/Stores.html">Stores</a>
+                    class provides corresponding factory methods for timestamped stores.</p>
+                <p>
+                    <b>Upgrade note:</b> All users upgrade with a single rolling bounce per instance.
+                    <ul class="first simple">
+                        <li>For Platform API users, nothing changes in existing applications, and you

Review comment:
       `Platform API` ? Do you mean `Processor API` ?




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org