From aba56c6eb8a6bb8b0d316b44ee1cef108841a6ae Mon Sep 17 00:00:00 2001
From: David Li
Date: Tue, 5 Jul 2022 15:41:37 -0400
Subject: [PATCH] Clarify cancel semantics
---
format/FlightSql.proto | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/format/FlightSql.proto b/format/FlightSql.proto
index 96fca02230780..d6431bee4c366 100644
--- a/format/FlightSql.proto
+++ b/format/FlightSql.proto
@@ -1684,10 +1684,12 @@ message DoPutUpdateResult {
/*
* Explicitly cancel a running query.
*
- * For distributed queries (ones that use GetFlightInfo->DoGet), this lets a
- * single client explicitly cancel work across all clients, given server
- * support. The transaction/statement is not rolled back. This only indicates
- * the client no longer wishes to read the remainder of the query results.
+ * This lets a single client explicitly cancel work, no matter how many clients
+ * are involved/whether the query is distributed or not, given server
+ * support. The transaction/statement is not rolled back; it is the
+ * application's job to commit or rollback as appropriate. This only indicates
+ * the client no longer wishes to read the remainder of the query
+ * results or continue submitting data.
*/
message ActionCancelQuery {
// The result of the GetFlightInfo RPC that initated the query.