kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From guozh...@apache.org
Subject [kafka] branch 1.1 updated: KAFKA-6560: Add docs for KIP-261 (#4685)
Date Mon, 12 Mar 2018 20:12:09 GMT
This is an automated email from the ASF dual-hosted git repository.

guozhang pushed a commit to branch 1.1
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/1.1 by this push:
     new 8e676b7  KAFKA-6560: Add docs for KIP-261 (#4685)
8e676b7 is described below

commit 8e676b7700c2afca2afe68b9c66f1600e3721441
Author: Guozhang Wang <wangguoz@gmail.com>
AuthorDate: Mon Mar 12 13:11:29 2018 -0700

    KAFKA-6560: Add docs for KIP-261 (#4685)
    
    Reviewers: Matthias J. Sax <mjsax@apache.org>, Bill Bejeck <bill@confluent.io>
---
 docs/streams/upgrade-guide.html | 27 ++++++++++++++++++++++-----
 1 file changed, 22 insertions(+), 5 deletions(-)

diff --git a/docs/streams/upgrade-guide.html b/docs/streams/upgrade-guide.html
index 1d5a342..f5c16c0 100644
--- a/docs/streams/upgrade-guide.html
+++ b/docs/streams/upgrade-guide.html
@@ -34,9 +34,17 @@
     </div>
 
     <p>
-        If you are using Java 7 and want to upgrade from 1.0.x to 1.1.0 you don't need to
make any code changes as the public API is fully backward compatible.
-        If you are using Java 8 method references in your Kafka Streams code you might need
to update your code to resolve method ambiguties.
-	Hot-swaping the jar-file only might not work for this case.
+        If you want to upgrade from 1.1.x to 1.2.0 and you have customized window store implementations
on the <code>ReadOnlyWindowStore</code> interface
+        you'd need to update your code to incorporate the newly added public APIs; otherwise
you don't need to make any code changes.
+        See <a href="#streams_api_changes_120">below</a> for a complete list
of 1.2.0 API and semantic changes that allow you to advance your application and/or simplify
your code base.
+    </p>
+
+    <p>
+        If you want to upgrade from 1.0.x to 1.1.0 and you have customized window store implementations
on the <code>ReadOnlyWindowStore</code> interface
+        you'd need to update your code to incorporate the newly added public APIs.
+        Otherwise, if you are using Java 7 you don't need to make any code changes as the
public API is fully backward compatible;
+        but if you are using Java 8 method references in your Kafka Streams code you might
need to update your code to resolve method ambiguities.
+        Hot-swaping the jar-file only might not work for this case.
         See <a href="#streams_api_changes_110">below</a> for a complete list
of 1.1.0 API and semantic changes that allow you to advance your application and/or simplify
your code base.
     </p>
 
@@ -64,12 +72,21 @@
         See <a href="#streams_api_changes_0101">below</a> a complete list of
0.10.1 API changes that allow you to advance your application and/or simplify your code base,
including the usage of new features.
     </p>
 
+    <!-- TODO: verify release verion and update `id` and `href` attributes (also at other
places that link to this headline) -->
+    <h3><a id="streams_api_changes_120" href="#streams_api_changes_120">Streams
API changes in 1.2.0</a></h3>
+    <p>
+        We have added support for methods in <code>ReadOnlyWindowStore</code>
which allows for querying a single window's key-value pair.
+        For users who have customized window store implementations on the above interface,
they'd need to update their code to implement the newly added method as well.
+        For more details, see <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-261%3A+Add+Single+Value+Fetch+in+Window+Stores">KIP-261</a>.
+    </p>
+    
     <h3><a id="streams_api_changes_110" href="#streams_api_changes_110">Streams
API changes in 1.1.0</a></h3>
     <p>
-	We have added support for methods in <code>ReadOnlyWindowStore</code> which
allows for querying <code>WindowStore</code>s without the neccesity of providing
keys.
+        We have added support for methods in <code>ReadOnlyWindowStore</code>
which allows for querying <code>WindowStore</code>s without the necessity of providing
keys.
+        For users who have customized window store implementations on the above interface,
they'd need to update their code to implement the newly added method as well.
+        For more details, see <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-205%3A+Add+all%28%29+and+range%28%29+API+to+ReadOnlyWindowStore">KIP-205</a>.
     </p>
 
-
     <p>
 	There is a new artifact <code>kafka-streams-test-utils</code> providing a <code>TopologyTestDriver</code>,
<code>ConsumerRecordFactory</code>, and <code>OutputVerifier</code>
class.
 	You can include the new artifact as a regular dependency to your unit tests and use the
test driver to test your business logic of your Kafka Streams application.

-- 
To stop receiving notification emails like this one, please contact
guozhang@apache.org.

Mime
View raw message