[SPARK-48850][DOCS][SS][SQL] Add documentation for new options added to State Data Source #47274
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
eason-yuchen-liu
changed the title
HeartSaVioR
reviewed
Jul 11, 2024
| <td>readChangeFeed</td> | ||
| <td>boolean</td> | ||
| <td>false</td> | ||
| <td>If set to true, will read the change of state over microbatches. The output table schema will also change. Two columns 'batch_id'(long) and 'change_type'(string) will be appended to the front. Option 'changeStartBatchId' must be specified with this option. Option 'batchId', 'joinSide', 'snapshotStartBatchId', 'snapshotPartitionId' is conflict with this option. An example usage of this option can be found below.</td> |
There was a problem hiding this comment.
The output table schema will also change. Two columns 'batch_id'(long) and 'change_type'(string) will be appended to the front.
We could simply defer to the next section, to make the explanation to be concise.
is conflict with this option
cannot be used with this option (probably more clearer)
An example usage of this option can be found below.
probably better to explicitly mention the section name? link would be even better.
|
|
|
CI failure is not relevant. |
HeartSaVioR
approved these changes
Jul 11, 2024
|
https://github.com/eason-yuchen-liu/spark/runs/27338180115 Looks like it only failed with protobuf breaking change. Not sure why, probably it tried to find the proto file from changeset? I'll ignore it anyway. |
|
Thanks! Merging to master. |
jingz-db
pushed a commit
to jingz-db/spark
that referenced
this pull request
Jul 22, 2024
…to State Data Source ### What changes were proposed in this pull request? In apache#46944 and apache#47188, we introduced some new options to the State Data Source. This PR aims to explain these new features in the documentation. ### Why are the changes needed? It is necessary to reflect the latest change in the documentation website. ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? The API Doc website can be rendered correctly. ### Was this patch authored or co-authored using generative AI tooling? No. Closes apache#47274 from eason-yuchen-liu/snapshot-doc. Authored-by: Yuchen Liu <yuchen.liu@databricks.com> Signed-off-by: Jungtaek Lim <kabhwan.opensource@gmail.com>
attilapiros
pushed a commit
to attilapiros/spark
that referenced
this pull request
Oct 4, 2024
…to State Data Source ### What changes were proposed in this pull request? In apache#46944 and apache#47188, we introduced some new options to the State Data Source. This PR aims to explain these new features in the documentation. ### Why are the changes needed? It is necessary to reflect the latest change in the documentation website. ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? The API Doc website can be rendered correctly. ### Was this patch authored or co-authored using generative AI tooling? No. Closes apache#47274 from eason-yuchen-liu/snapshot-doc. Authored-by: Yuchen Liu <yuchen.liu@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 #46944 and #47188, we introduced some new options to the State Data Source. This PR aims to explain these new features in the documentation.
Why are the changes needed?
It is necessary to reflect the latest change in the documentation website.
Does this PR introduce any user-facing change?
No.
How was this patch tested?
The API Doc website can be rendered correctly.
Was this patch authored or co-authored using generative AI tooling?
No.