viirya commented on code in PR #43920: URL: https://github.com/apache/spark/pull/43920#discussion_r1407204045
########## docs/structured-streaming-state-data-source.md: ########## @@ -0,0 +1,248 @@ +--- +layout: global +displayTitle: State data source (Experimental) Guide in Structured Streaming +title: State data source (Experimental) Guide in Structured Streaming +license: | + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--- + +State data source Guide in Structured Streaming (Experimental) + +## Overview + +State data source provides functionality to manipulate the state from the checkpoint. + +As of Spark 4.0, state data source provides the read functionality with a batch query. Additional functionalities including write is on the future roadmap. + +NOTE: this data source is currently marked as experimental - source options and the behavior (output) might be subject to change. + +## Reading state key-values from the checkpoint + +State data source enables reading key-value pairs from the state in the checkpoint, via running a separate batch query. Review Comment: ```suggestion State data source enables reading key-value pairs from the state store in the checkpoint, via running a separate batch query. ``` -- 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]
