[SS][SPARK-47331] Serialization using case classes/primitives/POJO based on SQL encoder for Arbitrary State API v2. #45447
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jingz-db
changed the title
jingz-db
changed the title
anishshri-db
reviewed
Mar 9, 2024
| * @param stateName - name of logical state partition | ||
| * @tparam GK - grouping key type | ||
| * @tparam S - value type |
There was a problem hiding this comment.
Nit: Could we rename type param to V instead ?
anishshri-db
reviewed
Mar 9, 2024
| } | ||
|
|
||
| public POJOTestClass(String name, int id) { | ||
| this.name = name; |
There was a problem hiding this comment.
indent/spacing seems off ?
anishshri-db
reviewed
Mar 9, 2024
sql/core/src/test/java/org/apache/spark/sql/execution/streaming/state/POJOTestClass.java
Outdated
Show resolved
Hide resolved
anishshri-db
reviewed
Mar 9, 2024
| @@ -93,7 +96,7 @@ class ValueStateSuite extends SharedSparkSession | |||
| Encoders.STRING.asInstanceOf[ExpressionEncoder[Any]]) | |||
|
|
|||
| val stateName = "testState" | |||
| val testState: ValueState[Long] = handle.getValueState[Long]("testState") | |||
| val testState: ValueState[Long] = handle.getValueState[Long]("testState", Encoders.scalaLong) | |||
There was a problem hiding this comment.
Can we also add a test for other common types such as Double/String etc ?
anishshri-db
reviewed
Mar 9, 2024
| } | ||
|
|
||
| // Getter methods | ||
| public String getName() { |
There was a problem hiding this comment.
Not sure if this is a GH thing - but this still seems a little off to me ?
There was a problem hiding this comment.
There was a weird style correction happening without me realizing it. Fixed now!
HeartSaVioR
approved these changes
Mar 11, 2024
There was a problem hiding this comment.
+1
Btw, it might be better to have user facing two APIs for scala-friendly vs java-friendly. See flatMapGroupsWithState methods - providing encoder explicitly is only required to java-friendly API and for scala-friendly API people can use implicit. This could be done as another follow-up JIRA ticket.
|
GA failure happened only in Pyspark connect, and these failed suites do not have relationship with this change. |
|
Thanks! Merging to master. |
jpcorreia99
pushed a commit
to jpcorreia99/spark
that referenced
this pull request
Mar 12, 2024
…sed on SQL encoder for Arbitrary State API v2 ### What changes were proposed in this pull request? In the new operator for arbitrary state-v2, we cannot rely on the session/encoder being available since the initialization for the various state instances happens on the executors. Hence, for the state serialization, we propose to let user explicitly pass in encoder for state variable and serialize primitives/case classes/POJO with SQL encoder. Leveraging SQL encoder can speed up the serialization. ### Why are the changes needed? These changes are needed for providing a dedicated serializer for state-v2. The changes are part of the work around adding new stateful streaming operator for arbitrary state mgmt that provides a bunch of new features listed in the SPIP JIRA here - https://issues.apache.org/jira/browse/SPARK-45939 ### Does this PR introduce _any_ user-facing change? Users will need to specify the SQL encoder for their state variable: `def getValueState[T](stateName: String, valEncoder: Encoder[T]): ValueState[T]` `def getListState[T](stateName: String, valEncoder: Encoder[T]): ListState[T]` For primitive type, Encoder is something as: `Encoders.scalaLong`; for case class, `Encoders.product[CaseClass]`; for POJO, `Encoders.bean(classOf[POJOClass])` ### How was this patch tested? Unit tests for primitives, case classes, POJO separately in `ValueStateSuite` ### Was this patch authored or co-authored using generative AI tooling? No Closes apache#45447 from jingz-db/sql-encoder-state-v2. Authored-by: jingz-db <jing.zhan@databricks.com> Signed-off-by: Jungtaek Lim <kabhwan.opensource@gmail.com>
Created Task here: https://issues.apache.org/jira/browse/SPARK-47403 |
sweisdb
pushed a commit
to sweisdb/spark
that referenced
this pull request
Apr 1, 2024
…sed on SQL encoder for Arbitrary State API v2 ### What changes were proposed in this pull request? In the new operator for arbitrary state-v2, we cannot rely on the session/encoder being available since the initialization for the various state instances happens on the executors. Hence, for the state serialization, we propose to let user explicitly pass in encoder for state variable and serialize primitives/case classes/POJO with SQL encoder. Leveraging SQL encoder can speed up the serialization. ### Why are the changes needed? These changes are needed for providing a dedicated serializer for state-v2. The changes are part of the work around adding new stateful streaming operator for arbitrary state mgmt that provides a bunch of new features listed in the SPIP JIRA here - https://issues.apache.org/jira/browse/SPARK-45939 ### Does this PR introduce _any_ user-facing change? Users will need to specify the SQL encoder for their state variable: `def getValueState[T](stateName: String, valEncoder: Encoder[T]): ValueState[T]` `def getListState[T](stateName: String, valEncoder: Encoder[T]): ListState[T]` For primitive type, Encoder is something as: `Encoders.scalaLong`; for case class, `Encoders.product[CaseClass]`; for POJO, `Encoders.bean(classOf[POJOClass])` ### How was this patch tested? Unit tests for primitives, case classes, POJO separately in `ValueStateSuite` ### Was this patch authored or co-authored using generative AI tooling? No Closes apache#45447 from jingz-db/sql-encoder-state-v2. Authored-by: jingz-db <jing.zhan@databricks.com> Signed-off-by: Jungtaek Lim <kabhwan.opensource@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
In the new operator for arbitrary state-v2, we cannot rely on the session/encoder being available since the initialization for the various state instances happens on the executors. Hence, for the state serialization, we propose to let user explicitly pass in encoder for state variable and serialize primitives/case classes/POJO with SQL encoder. Leveraging SQL encoder can speed up the serialization.
Why are the changes needed?
These changes are needed for providing a dedicated serializer for state-v2.
The changes are part of the work around adding new stateful streaming operator for arbitrary state mgmt that provides a bunch of new features listed in the SPIP JIRA here - https://issues.apache.org/jira/browse/SPARK-45939
Does this PR introduce any user-facing change?
Users will need to specify the SQL encoder for their state variable:
def getValueState[T](stateName: String, valEncoder: Encoder[T]): ValueState[T]def getListState[T](stateName: String, valEncoder: Encoder[T]): ListState[T]For primitive type, Encoder is something as:
Encoders.scalaLong; for case class,Encoders.product[CaseClass]; for POJO,Encoders.bean(classOf[POJOClass])How was this patch tested?
Unit tests for primitives, case classes, POJO separately in
ValueStateSuiteWas this patch authored or co-authored using generative AI tooling?
No