Re: [PR] KAFKA-15307: Kafka Streams configuration docs outdated [kafka]

[via GitHub]

shashankhs11 commented on code in PR #20408:
URL: https://github.com/apache/kafka/pull/20408#discussion_r2305573672


##########
docs/streams/developer-guide/datatypes.html:
##########
@@ -163,6 +164,72 @@ <h3>JSON<a class="headerlink" href="#json" 
title="Permalink to this headline"></
         <p>As shown in the example, you can use JSONSerdes inner classes <code 
class="docutils literal"><span 
class="pre">Serdes.serdeFrom(&lt;serializerInstance&gt;, 
&lt;deserializerInstance&gt;)</span></code> to construct JSON compatible 
serializers and deserializers.
         </p>
       </div>
+      <div class="section" id="window-serdes">
+        <h3>Window Serdes<a class="headerlink" href="#window-serdes" 
title="Permalink to this headline"></a></h3>
+        <p>Apache Kafka Streams includes serde implementations for windowed 
keys in
+          its <code class="docutils literal"><span 
class="pre">kafka-streams</span></code> Maven artifact:</p>
+        <pre class="line-numbers"><code class="language-xml">&lt;dependency&gt;
+    &lt;groupId&gt;org.apache.kafka&lt;/groupId&gt;
+    &lt;artifactId&gt;kafka-streams&lt;/artifactId&gt;
+    &lt;version&gt;{{fullDotVersion}}&lt;/version&gt;
+&lt;/dependency&gt;</code></pre>
+        <p>This artifact provides the following windowed serde implementations 
under the package <a class="reference external" 
href="https://github.com/apache/kafka/blob/{{dotVersion}}/streams/src/main/java/org/apache/kafka/streams/kstream";>org.apache.kafka.streams.kstream</a>:</p>
+        <table border="1" class="docutils">
+          <colgroup>
+            <col width="17%" />
+            <col width="83%" />
+          </colgroup>
+          <thead valign="bottom">
+          <tr class="row-odd"><th class="head">Data type</th>
+            <th class="head">Serde</th>
+          </tr>
+          </thead>
+          <tbody valign="top">
+          <tr class="row-even"><td>Windowed&lt;T&gt; (Time Windows)</td>
+            <td><code class="docutils literal"><span class="pre">new 
WindowedSerdes.TimeWindowedSerde&lt;&gt;(innerSerde, windowSize)</span></code>, 
<code class="docutils literal"><span 
class="pre">WindowedSerdes.timeWindowedSerdeFrom(Class&lt;T&gt; type, long 
windowSize)</span></code></td>
+          </tr>
+          <tr class="row-odd"><td>Windowed&lt;T&gt; (Session Windows)</td>
+            <td><code class="docutils literal"><span class="pre">new 
WindowedSerdes.SessionWindowedSerde&lt;&gt;(innerSerde)</span></code>, <code 
class="docutils literal"><span 
class="pre">WindowedSerdes.sessionWindowedSerdeFrom(Class&lt;T&gt; 
type)</span></code></td>
+          </tr>
+          <tr class="row-even"><td>TimeWindowedSerializer&lt;T&gt;</td>
+            <td><code class="docutils literal"><span class="pre">new 
TimeWindowedSerializer&lt;&gt;(innerSerializer)</span></code></td>
+          </tr>
+          <tr class="row-odd"><td>TimeWindowedDeserializer&lt;T&gt;</td>
+            <td><code class="docutils literal"><span class="pre">new 
TimeWindowedDeserializer&lt;&gt;(innerDeserializer, 
windowSize)</span></code></td>
+          </tr>
+          <tr class="row-even"><td>SessionWindowedSerializer&lt;T&gt;</td>
+            <td><code class="docutils literal"><span class="pre">new 
SessionWindowedSerializer&lt;&gt;(innerSerializer)</span></code></td>
+          </tr>
+          <tr class="row-odd"><td>SessionWindowedDeserializer&lt;T&gt;</td>
+            <td><code class="docutils literal"><span class="pre">new 
SessionWindowedDeserializer&lt;&gt;(innerDeserializer)</span></code></td>
+          </tr>
+          </tbody>
+        </table>
+        <h4>Migration from Deprecated Configs</h4>

Review Comment:
   addressed in a918948! Here is a quick preview of the changes
   
   <img width="813" height="729" alt="image" 
src="https://github.com/user-attachments/assets/9f44ce73-ef65-4873-acfd-54f85500f0e3";
 />
   



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