[SPARK-51429][Connect] Add "Acknowledgement" message to ExecutePlanResponse #50193
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?
Adds an
Acknowledgement
message inExecutePlanResponse
which is essentially an empty response containing metadata from the server. The message is sent by the server back to the client as the first message (one-time) on anyExecutePlan
orReattachExecute
requests.Why are the changes needed?
An acknowledgement allows a client to disconnect right after registering the request without waiting for its full processing.
It is especially useful when the server supports reattachment or otherwise, can be used for early termination if the client detects a delay in registration by the server.
Does this PR introduce any user-facing change?
Yes.
The first message in the response stream of
ExecutePlan
/ReattachExecute
will be anExecutePlanResponse
containing theAcknowledgement
message.Note: This is a no-op for users not interacting with
ExecutePlanResponse
directly (e.g. Usingdf.collect()
) or those who are already filtering messages for those containing a specific field.How was this patch tested?
New + existing unit tests.
Was this patch authored or co-authored using generative AI tooling?
No.