HeartSaVioR commented on a change in pull request #33038:
URL: https://github.com/apache/spark/pull/33038#discussion_r667566548
##########
File path:
sql/core/src/main/scala/org/apache/spark/sql/execution/streaming/state/StateStore.scala
##########
@@ -251,16 +250,15 @@ trait StateStoreProvider {
* @param stateStoreId Id of the versioned StateStores that this provider
will generate
* @param keySchema Schema of keys to be stored
* @param valueSchema Schema of value to be stored
- * @param keyIndexOrdinal Optional column (represent as the ordinal of the
field in keySchema) by
- * which the StateStore implementation could index
the data.
+ * @param numColsPrefixKey The number of leftmost columns to be used as
prefix key.
Review comment:
Thanks for the input! I agree we'd need to add more details.
One thing we may want to consider is that caller defines the prefix key, and
it's natural (or we can document the behavior to `prefixScan` method doc) that
it won't work if there's no prefix key.
I feel we can just emphasize the behavior when the number is less than 1.
I'll update the doc, and let's see whether it's good for you as well or not.
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
