[SPARK-48850][DOCS][SS][SQL] Add documentation for new options added to State Data Source#47274
[SPARK-48850][DOCS][SS][SQL] Add documentation for new options added to State Data Source#47274eason-yuchen-liu wants to merge 4 commits into
Conversation
HeartSaVioR
left a comment
There was a problem hiding this comment.
Would you mind building the doc and capturing snapshot for the change? It would be much easier to review the change with markdown/code. Thanks!
| <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. |
|
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. |
…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>
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.