[jira] [Assigned] (KAFKA-9290) Update IQ related JavaDocs

["highluck (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/KAFKA-9290?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

highluck reassigned KAFKA-9290:
-------------------------------

    Assignee: highluck

> Update IQ related JavaDocs
> --------------------------
>
>                 Key: KAFKA-9290
>                 URL: https://issues.apache.org/jira/browse/KAFKA-9290
>             Project: Kafka
>          Issue Type: Improvement
>          Components: streams
>            Reporter: Matthias J. Sax
>            Assignee: highluck
>            Priority: Minor
>              Labels: beginner, newbie
>
> 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]):
>  
> {code:java}
> * <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>
> {code}
> We should update all JavaDocs to use `TimestampedXxxStore` and the new Duration/Instance methods in all those code snippets.
>  



--
This message was sent by Atlassian Jira
(v8.3.4#803005)