[KAFKA-9290] Update IQ related JavaDocs

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 2.6.0
• Component/s: streams
• Labels: beginner newbie
• Assignee: highluck
• Reporter: Matthias J. Sax
• Created: 11/Dec/19 08:13
• Updated: 08/May/20 06:34
• Resolved: 08/May/20 06:15

Description

In Kafka 2.1.0 we deprecated couple of methods (KAFKA-7277) to pass in timestamps via IQ API via Duration/Instance parameters instead of plain longs.

In Kafka 2.3.0 we introduced TimestampedXxxStores (KAFKA-3522) and allow IQ to return the stored timestamp.

However, we never update our JavaDocs that contain code snippets to illustrate how a local store can be queries. For example `KGroupedStream#count(Materialized)` (https://github.com/apache/kafka/blob/trunk/streams/src/main/java/org/apache/kafka/streams/kstream/KGroupedStream.java#L116-L122):

 

* <pre>{@code * KafkaStreams streams = ... // counting words
* String queryableStoreName = "storeName"; // the store name should be the name of the store as defined by the Materialized instance
* ReadOnlyKeyValueStore<String,Long> localStore = streams.store(queryableStoreName, QueryableStoreTypes.<String, Long>keyValueStore());
* String key = "some-word";
* Long countForWord = localStore.get(key); // key must be local (application state is shared over all running Kafka Streams instances)
* }</pre>

We should update all JavaDocs to use `TimestampedXxxStore` and the new Duration/Instance methods in all those code snippets.

 

Issue Links

• contains: KAFKA-9243 Update the javadocs from KeyValueStore to TimestampKeyValueStore
• is related to: KAFKA-9243 Update the javadocs from KeyValueStore to TimestampKeyValueStore
• links to: GitHub Pull Request #8114