alamb commented on code in PR #36946:
URL: https://github.com/apache/arrow/pull/36946#discussion_r1286947374
##########
format/Flight.proto:
##########
@@ -343,6 +368,43 @@ message FlightInfo {
bool ordered = 6;
}
+/*
+ * The information to process a long-running query.
+ */
+message RetryInfo {
Review Comment:
Minor Editorial point is that calling this "RetryInfo" is somewhat
misleading in my mind because it implies to me that the query is being retried,
when in reality it is that current execution status that is being retried.
Maybe something like "PartialFlightInfo" or something might make it clearer
##########
format/Flight.proto:
##########
@@ -343,6 +368,43 @@ message FlightInfo {
bool ordered = 6;
}
+/*
+ * The information to process a long-running query.
+ */
+message RetryInfo {
+ /*
+ * The currently available results so far.
+ *
+ * It's a complete FlightInfo each time not just the delta between
+ * the previous and current FlightInfo.
+ *
+ * A server should only append to the endpoints in the info. So the
+ * client can run DoGet(Ticket) with the Ticket in the info even
+ * when the query isn't finished yet. FlightInfo.ordered is also
+ * valid.
Review Comment:
```suggestion
* The currently available results.
*
* If `flight_descriptor` is not specified, the query is complete and
* `info` specifies all results. Otherwise, `info` contains partial query
results.
*
* Note that each `RetryInfo` response contains a complete FlightInfo
* (not just the delta between the previous and current FlightInfo).
*
* Subsequent `RetryInfo` responses may only append new endpoints to info.
*
* Clients can begin fetching results via DoGet(Ticket) with the ticket in
the info before
* the query is completed. FlightInfo.ordered is also valid.
```
##########
format/Flight.proto:
##########
@@ -65,6 +65,32 @@ service FlightService {
*/
rpc GetFlightInfo(FlightDescriptor) returns (FlightInfo) {}
+ /*
+ * For a given FlightDescriptor, start a query and get information
+ * to poll the updated statuses. This is a useful interface if the
Review Comment:
```suggestion
* to poll its execution status. This is a useful interface if the
```
##########
format/Flight.proto:
##########
@@ -343,6 +368,43 @@ message FlightInfo {
bool ordered = 6;
}
+/*
+ * The information to process a long-running query.
+ */
+message RetryInfo {
+ /*
+ * The currently available results so far.
+ *
+ * It's a complete FlightInfo each time not just the delta between
+ * the previous and current FlightInfo.
+ *
+ * A server should only append to the endpoints in the info. So the
+ * client can run DoGet(Ticket) with the Ticket in the info even
+ * when the query isn't finished yet. FlightInfo.ordered is also
+ * valid.
+ */
+ FlightInfo info = 1;
+
+ /*
+ * The descriptor the client should use on the next try.
+ * If unset, the query is complete.
+ */
+ FlightDescriptor flight_descriptor = 2;
+
+ /*
+ * Query progress. Must be in [0.0, 1.0] but need not be
Review Comment:
```suggestion
* Query progress. If known, must be in [0.0, 1.0] but need not be
```
##########
format/Flight.proto:
##########
@@ -65,6 +65,32 @@ service FlightService {
*/
rpc GetFlightInfo(FlightDescriptor) returns (FlightInfo) {}
+ /*
+ * For a given FlightDescriptor, start a query and get information
+ * to poll the updated statuses. This is a useful interface if the
+ * query may be a long-running query. The first PollFlightInfo call
+ * should return as quickly as possible. (GetFlightInfo doesn't
+ * return until the query is complete.)
+ *
+ * A client can consume the current results so far before
+ * the query is completed. See RetryInfo.info for details.
Review Comment:
```suggestion
* A client can consume any available results before
* the query is completed. See RetryInfo.info for details.
```
--
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]
