Skip to content

Commit 0ddc69d

Browse files
authored
KAFKA-19721: Update streams documentation with KIP-1147 changes (#20606)
Update KIP-1147 changes (renaming --property to --formatter-property) in the ops and streams documentation. Reviewers: Andrew Schofield <[email protected]>
1 parent 7426629 commit 0ddc69d

File tree

3 files changed

+24
-24
lines changed

3 files changed

+24
-24
lines changed

docs/ops.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4315,7 +4315,7 @@ <h4 class="anchor-heading"><a id="tiered_storage_config_ex" class="anchor-link">
43154315

43164316
<p>Lastly, we can try to consume some data from the beginning and print offset number, to make sure it will successfully fetch offset 0 from the remote storage.</p>
43174317

4318-
<pre><code class="language-bash">$ bin/kafka-console-consumer.sh --topic tieredTopic --from-beginning --max-messages 1 --bootstrap-server localhost:9092 --property print.offset=true</code></pre>
4318+
<pre><code class="language-bash">$ bin/kafka-console-consumer.sh --topic tieredTopic --from-beginning --max-messages 1 --bootstrap-server localhost:9092 --formatter-property print.offset=true</code></pre>
43194319

43204320
<p>In KRaft mode, you can disable tiered storage at the topic level, to make the remote logs as read-only logs, or completely delete all remote logs.</p>
43214321

docs/streams/developer-guide/datatypes.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -217,15 +217,15 @@ <h4>Usage in Code</h4>
217217
<h4>Usage in Command Line</h4>
218218
<p>When using command-line tools (like <code>bin/kafka-console-consumer.sh</code>), you can configure windowed deserializers by passing the inner class and window size via configuration properties. The property names use a prefix pattern:</p>
219219
<pre class="line-numbers"><code class="language-bash"># Time windowed deserializer configuration
220-
--property print.key=true \
221-
--property key.deserializer=org.apache.kafka.streams.kstream.TimeWindowedDeserializer \
222-
--property key.deserializer.windowed.inner.deserializer.class=org.apache.kafka.common.serialization.StringDeserializer \
223-
--property key.deserializer.window.size.ms=500
220+
--formatter-property print.key=true \
221+
--formatter-property key.deserializer=org.apache.kafka.streams.kstream.TimeWindowedDeserializer \
222+
--formatter-property key.deserializer.windowed.inner.deserializer.class=org.apache.kafka.common.serialization.StringDeserializer \
223+
--formatter-property key.deserializer.window.size.ms=500
224224

225225
# Session windowed deserializer configuration
226-
--property print.key=true \
227-
--property key.deserializer=org.apache.kafka.streams.kstream.SessionWindowedDeserializer \
228-
--property key.deserializer.windowed.inner.deserializer.class=org.apache.kafka.common.serialization.StringDeserializer</code></pre>
226+
--formatter-property print.key=true \
227+
--formatter-property key.deserializer=org.apache.kafka.streams.kstream.SessionWindowedDeserializer \
228+
--formatter-property key.deserializer.windowed.inner.deserializer.class=org.apache.kafka.common.serialization.StringDeserializer</code></pre>
229229

230230
<h4>Deprecated Configs</h4>
231231
<p>The following <code>StreamsConfig</code> parameters are deprecated in favor of passing parameters directly to serializer/deserializer constructors:</p>

docs/streams/quickstart.html

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -175,10 +175,10 @@ <h4><a id="quickstart_streams_start" href="#quickstart_streams_start">Step 4: St
175175
<pre><code class="language-bash">$ bin/kafka-console-consumer.sh --bootstrap-server localhost:9092 \
176176
--topic streams-wordcount-output \
177177
--from-beginning \
178-
--property print.key=true \
179-
--property print.value=true \
180-
--property key.deserializer=org.apache.kafka.common.serialization.StringDeserializer \
181-
--property value.deserializer=org.apache.kafka.common.serialization.LongDeserializer</code></pre>
178+
--formatter-property print.key=true \
179+
--formatter-property print.value=true \
180+
--formatter-property key.deserializer=org.apache.kafka.common.serialization.StringDeserializer \
181+
--formatter-property value.deserializer=org.apache.kafka.common.serialization.LongDeserializer</code></pre>
182182

183183

184184
<h4><a id="quickstart_streams_process" href="#quickstart_streams_process">Step 5: Process some data</a></h4>
@@ -197,10 +197,10 @@ <h4><a id="quickstart_streams_process" href="#quickstart_streams_process">Step 5
197197
<pre><code class="language-bash">$ bin/kafka-console-consumer.sh --bootstrap-server localhost:9092 \
198198
--topic streams-wordcount-output \
199199
--from-beginning \
200-
--property print.key=true \
201-
--property print.value=true \
202-
--property key.deserializer=org.apache.kafka.common.serialization.StringDeserializer \
203-
--property value.deserializer=org.apache.kafka.common.serialization.LongDeserializer
200+
--formatter-property print.key=true \
201+
--formatter-property print.value=true \
202+
--formatter-property key.deserializer=org.apache.kafka.common.serialization.StringDeserializer \
203+
--formatter-property value.deserializer=org.apache.kafka.common.serialization.LongDeserializer
204204

205205
all 1
206206
streams 1
@@ -225,10 +225,10 @@ <h4><a id="quickstart_streams_process" href="#quickstart_streams_process">Step 5
225225
<pre><code class="language-bash">$ bin/kafka-console-consumer.sh --bootstrap-server localhost:9092 \
226226
--topic streams-wordcount-output \
227227
--from-beginning \
228-
--property print.key=true \
229-
--property print.value=true \
230-
--property key.deserializer=org.apache.kafka.common.serialization.StringDeserializer \
231-
--property value.deserializer=org.apache.kafka.common.serialization.LongDeserializer
228+
--formatter-property print.key=true \
229+
--formatter-property print.value=true \
230+
--formatter-property key.deserializer=org.apache.kafka.common.serialization.StringDeserializer \
231+
--formatter-property value.deserializer=org.apache.kafka.common.serialization.LongDeserializer
232232

233233
all 1
234234
streams 1
@@ -255,10 +255,10 @@ <h4><a id="quickstart_streams_process" href="#quickstart_streams_process">Step 5
255255
<pre><code class="language-bash">$ bin/kafka-console-consumer.sh --bootstrap-server localhost:9092 \
256256
--topic streams-wordcount-output \
257257
--from-beginning \
258-
--property print.key=true \
259-
--property print.value=true \
260-
--property key.deserializer=org.apache.kafka.common.serialization.StringDeserializer \
261-
--property value.deserializer=org.apache.kafka.common.serialization.LongDeserializer
258+
--formatter-property print.key=true \
259+
--formatter-property print.value=true \
260+
--formatter-property key.deserializer=org.apache.kafka.common.serialization.StringDeserializer \
261+
--formatter-property value.deserializer=org.apache.kafka.common.serialization.LongDeserializer
262262

263263
all 1
264264
streams 1

0 commit comments

Comments
 (0)