nileshkumar3 commented on code in PR #21840:
URL: https://github.com/apache/kafka/pull/21840#discussion_r3223470449
##########
docs/streams/developer-guide/processor-api.md:
##########
@@ -173,11 +173,16 @@ Yes (enabled by default)
* Stores its data on local disk.
* Storage capacity: managed local state can be larger than the memory (heap
space) of an application instance, but must fit into the available local disk
space.
* RocksDB settings can be fine-tuned, see [RocksDB
configuration](config-streams.html#streams-developer-guide-rocksdb-config).
- * Available [store
variants](/{version}/javadoc/org/apache/kafka/streams/state/Stores.html#persistentKeyValueStore\(java.lang.String\)):
timestamped key-value store, versioned key-value store, time window key-value
store, session window key-value store.
+ * Available [store
variants](/{version}/javadoc/org/apache/kafka/streams/state/Stores.html): plain
key-value store (values only — no embedded record timestamp in state),
timestamped key-value store, versioned key-value store, windowed store, session
store. Header-aware variants are also described below.
+ * Use
[persistentKeyValueStore](/{version}/javadoc/org/apache/kafka/streams/state/Stores.html#persistentKeyValueStore\(java.lang.String\))
when you need a persistent plain key-value store as above.
* Use
[persistentTimestampedKeyValueStore](/{version}/javadoc/org/apache/kafka/streams/state/Stores.html#persistentTimestampedKeyValueStore\(java.lang.String\))
when you need a persistent key-(value/timestamp) store that supports
put/get/delete and range queries.
* Use
[persistentVersionedKeyValueStore](/{version}/javadoc/org/apache/kafka/streams/state/Stores.html#persistentVersionedKeyValueStore\(java.lang.String,java.time.Duration\))
when you need a persistent, versioned key-(value/timestamp) store that
supports put/get/delete and timestamped get operations.
- * Use
[persistentWindowStore](/{version}/javadoc/org/apache/kafka/streams/state/Stores.html#persistentWindowStore\(java.lang.String,java.time.Duration,java.time.Duration,boolean\))
or
[persistentTimestampedWindowStore](/{version}/javadoc/org/apache/kafka/streams/state/Stores.html#persistentTimestampedWindowStore\(java.lang.String,java.time.Duration,java.time.Duration,boolean\))
when you need a persistent timeWindowedKey-value or
timeWindowedKey-(value/timestamp) store, respectively.
- * Use
[persistentSessionStore](/{version}/javadoc/org/apache/kafka/streams/state/Stores.html#persistentSessionStore\(java.lang.String,java.time.Duration\))
when you need a persistent sessionWindowedKey-value store.
+ * Use
[persistentWindowStore](/{version}/javadoc/org/apache/kafka/streams/state/Stores.html#persistentWindowStore\(java.lang.String,java.time.Duration,java.time.Duration,boolean\))
or
[persistentTimestampedWindowStore](/{version}/javadoc/org/apache/kafka/streams/state/Stores.html#persistentTimestampedWindowStore\(java.lang.String,java.time.Duration,java.time.Duration,boolean\))
when you need a persistent plain windowed store or a persistent timestamped
windowed store, respectively.
+ * Use
[persistentSessionStore](/{version}/javadoc/org/apache/kafka/streams/state/Stores.html#persistentSessionStore\(java.lang.String,java.time.Duration\))
when you need a persistent session store.
+ * **Headers:** To persist [record
headers](https://kafka.apache.org/documentation/#recordheaders) in state, use a
`WithHeaders` store supplier with its matching `StoreBuilder` factory (see
[Headers in State Stores](#headers-in-state-stores) below). There are no
`WithHeaders` suppliers for plain persistent key-value or plain persistent
windowed stores — only persistent timestamped key-value, persistent timestamped
windowed, and session `WithHeaders` suppliers exist.
Review Comment:
changed to 2 short sentences.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
