kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mj...@apache.org
Subject [kafka] branch 2.1 updated: KAFKA-4932: Update docs for KIP-206 (#5769)
Date Wed, 10 Oct 2018 19:10:13 GMT
This is an automated email from the ASF dual-hosted git repository.

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


The following commit(s) were added to refs/heads/2.1 by this push:
     new f063e30  KAFKA-4932: Update docs for KIP-206 (#5769)
f063e30 is described below

commit f063e301e7f720d29686602483961b7fec8b8341
Author: Matthias J. Sax <mjsax@apache.org>
AuthorDate: Wed Oct 10 12:09:09 2018 -0700

    KAFKA-4932: Update docs for KIP-206 (#5769)
    
    Reviewers: Bill Bejeck <bill@confluent.io>, Ewen Cheslack-Postava <ewen@confluent.io>,
Guozhang Wang <guozhang@confluent.io>
---
 docs/streams/developer-guide/datatypes.html | 8 +++++++-
 docs/streams/upgrade-guide.html             | 4 ++++
 2 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/docs/streams/developer-guide/datatypes.html b/docs/streams/developer-guide/datatypes.html
index a24dc4c..6c7869c 100644
--- a/docs/streams/developer-guide/datatypes.html
+++ b/docs/streams/developer-guide/datatypes.html
@@ -142,6 +142,9 @@
           <tr class="row-odd"><td>String</td>
             <td><code class="docutils literal"><span class="pre">Serdes.String()</span></code></td>
           </tr>
+          <tr class="row-even"><td>UUID</td>
+            <td><code class="docutils literal"><span class="pre">Serdes.UUID()</span></code></td>
+          </tr>
           </tbody>
         </table>
         <div class="admonition tip">
@@ -174,7 +177,10 @@
             <a class="reference external" href="https://github.com/apache/kafka/blob/1.0/clients/src/main/java/org/apache/kafka/common/serialization/Serde.java">org.apache.kafka.common.serialization.Serde</a>,
             which you either do manually (see existing SerDes in the previous section) or
by leveraging helper functions in
             <a class="reference external" href="https://github.com/apache/kafka/blob/1.0/clients/src/main/java/org/apache/kafka/common/serialization/Serdes.java">Serdes</a>
-            such as <code class="docutils literal"><span class="pre">Serdes.serdeFrom(Serializer&lt;T&gt;,</span>
<span class="pre">Deserializer&lt;T&gt;)</span></code>.</li>
+            such as <code class="docutils literal"><span class="pre">Serdes.serdeFrom(Serializer&lt;T&gt;,
Deserializer&lt;T&gt;)</span></code>.
+            Note that you will need to implement your own class (that has no generic types)
if you want to use your custom serde in the configuration provided to <code class="docutils
literal"><span class="pre">KafkaStreams</span></code>.
+            If your serde class has generic types or you use <code class="docutils literal"><span
class="pre">Serdes.serdeFrom(Serializer&lt;T&gt;, Deserializer&lt;T&gt;)</span></code>,
you can pass your serde only
+            via methods calls (for example <code class="docutils literal"><span
class="pre">builder.stream("topicName", Consumed.with(...))</span></code>).</li>
         </ol>
       </div>
     </div>
diff --git a/docs/streams/upgrade-guide.html b/docs/streams/upgrade-guide.html
index 0309a53..4bece4a 100644
--- a/docs/streams/upgrade-guide.html
+++ b/docs/streams/upgrade-guide.html
@@ -108,6 +108,10 @@
         they can override this config to a larger value.
     </p>
 
+    <p>
+        We added a new serde for UUIDs (<code>Serdes.UUIDSerde</code>) that you
can use via <code>Serdes.UUID()</code> (cf. <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-206%3A+Add+support+for+UUID+serialization+and+deserialization">KIP-206</a>).
+    </p>
+
     <h3><a id="streams_api_changes_200" href="#streams_api_changes_200">Streams
API changes in 2.0.0</a></h3>
     <p>
         We have removed the <code>skippedDueToDeserializationError-rate</code>
and <code>skippedDueToDeserializationError-total</code> metrics.


Mime
View raw message