Update Flight proto: PollFlightInfo & expiration time #5413
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
github-actions
bot
added
arrow
Jefffrey
commented
Feb 20, 2024
Comment on lines
+630
to
+678
| pub async fn cancel_flight_info( | ||
| &mut self, | ||
| request: CancelFlightInfoRequest, | ||
| ) -> Result<CancelFlightInfoResult> { | ||
| let action = Action::new("CancelFlightInfo", request.encode_to_vec()); | ||
| let response = self.do_action(action).await?.try_next().await?; | ||
| let response = response.ok_or(FlightError::protocol( | ||
| "Received no response for cancel_flight_info call", | ||
| ))?; | ||
| CancelFlightInfoResult::decode(response) | ||
| .map_err(|e| FlightError::DecodeError(e.to_string())) | ||
| } | ||
|
|
||
| /// Make a `RenewFlightEndpoint` call to the server and return | ||
| /// the renewed [`FlightEndpoint`]. | ||
| /// | ||
| /// # Example: | ||
| /// ```no_run | ||
| /// # async fn run() { | ||
| /// # use arrow_flight::{FlightClient, FlightDescriptor, RenewFlightEndpointRequest}; | ||
| /// # let channel: tonic::transport::Channel = unimplemented!(); | ||
| /// let mut client = FlightClient::new(channel); | ||
| /// | ||
| /// // Send a 'CMD' request to the server | ||
| /// let request = FlightDescriptor::new_cmd(b"MOAR DATA".to_vec()); | ||
| /// let flight_endpoint = client | ||
| /// .get_flight_info(request) | ||
| /// .await | ||
| /// .expect("error handshaking") | ||
| /// .endpoint[0]; | ||
| /// | ||
| /// // Renew the endpoint | ||
| /// let request = RenewFlightEndpointRequest::new(flight_endpoint); | ||
| /// let flight_endpoint = client | ||
| /// .renew_flight_endpoint(request) | ||
| /// .await | ||
| /// .expect("error renewing"); | ||
| /// # } | ||
| /// ``` | ||
| pub async fn renew_flight_endpoint( | ||
| &mut self, | ||
| request: RenewFlightEndpointRequest, | ||
| ) -> Result<FlightEndpoint> { | ||
| let action = Action::new("RenewFlightEndpoint", request.encode_to_vec()); | ||
| let response = self.do_action(action).await?.try_next().await?; | ||
| let response = response.ok_or(FlightError::protocol( | ||
| "Received no response for renew_flight_endpoint call", | ||
| ))?; | ||
| FlightEndpoint::decode(response).map_err(|e| FlightError::DecodeError(e.to_string())) |
There was a problem hiding this comment.
Wasn't sure if to add these to the SQL client & server as well? Maybe in a followup PR to keep size down?
There was a problem hiding this comment.
yes, I think the SQL interface should support this feature as well. Let's keep that out of this PR though.
Comment on lines
-475
to
-477
| /// .with_descriptor( | ||
| /// FlightDescriptor::new_cmd("a command") | ||
| /// ) |
There was a problem hiding this comment.
Since was also calling with_descriptor(...) again below
| @@ -391,6 +391,7 @@ impl FlightSqlServiceClient<Channel> { | |||
|
|
|||
| /// Explicitly shut down and clean up the client. | |||
| pub async fn close(&mut self) -> Result<(), ArrowError> { | |||
| // TODO: consume self instead of &mut self to explicitly prevent reuse? | |||
There was a problem hiding this comment.
Thoughts on this? Since close() doesn't exactly close anything at the moment, so maybe better to force closure via taking self
There was a problem hiding this comment.
I agree that close should be consuming 👍
Let's do that in a follow-up PR though.
|
This looks plausible to me, but I'm not very familiar with this code anymore |
crepererum
approved these changes
Feb 22, 2024
| @@ -391,6 +391,7 @@ impl FlightSqlServiceClient<Channel> { | |||
|
|
|||
| /// Explicitly shut down and clean up the client. | |||
| pub async fn close(&mut self) -> Result<(), ArrowError> { | |||
| // TODO: consume self instead of &mut self to explicitly prevent reuse? | |||
There was a problem hiding this comment.
I agree that close should be consuming 👍
Let's do that in a follow-up PR though.
Comment on lines
+630
to
+678
| pub async fn cancel_flight_info( | ||
| &mut self, | ||
| request: CancelFlightInfoRequest, | ||
| ) -> Result<CancelFlightInfoResult> { | ||
| let action = Action::new("CancelFlightInfo", request.encode_to_vec()); | ||
| let response = self.do_action(action).await?.try_next().await?; | ||
| let response = response.ok_or(FlightError::protocol( | ||
| "Received no response for cancel_flight_info call", | ||
| ))?; | ||
| CancelFlightInfoResult::decode(response) | ||
| .map_err(|e| FlightError::DecodeError(e.to_string())) | ||
| } | ||
|
|
||
| /// Make a `RenewFlightEndpoint` call to the server and return | ||
| /// the renewed [`FlightEndpoint`]. | ||
| /// | ||
| /// # Example: | ||
| /// ```no_run | ||
| /// # async fn run() { | ||
| /// # use arrow_flight::{FlightClient, FlightDescriptor, RenewFlightEndpointRequest}; | ||
| /// # let channel: tonic::transport::Channel = unimplemented!(); | ||
| /// let mut client = FlightClient::new(channel); | ||
| /// | ||
| /// // Send a 'CMD' request to the server | ||
| /// let request = FlightDescriptor::new_cmd(b"MOAR DATA".to_vec()); | ||
| /// let flight_endpoint = client | ||
| /// .get_flight_info(request) | ||
| /// .await | ||
| /// .expect("error handshaking") | ||
| /// .endpoint[0]; | ||
| /// | ||
| /// // Renew the endpoint | ||
| /// let request = RenewFlightEndpointRequest::new(flight_endpoint); | ||
| /// let flight_endpoint = client | ||
| /// .renew_flight_endpoint(request) | ||
| /// .await | ||
| /// .expect("error renewing"); | ||
| /// # } | ||
| /// ``` | ||
| pub async fn renew_flight_endpoint( | ||
| &mut self, | ||
| request: RenewFlightEndpointRequest, | ||
| ) -> Result<FlightEndpoint> { | ||
| let action = Action::new("RenewFlightEndpoint", request.encode_to_vec()); | ||
| let response = self.do_action(action).await?.try_next().await?; | ||
| let response = response.ok_or(FlightError::protocol( | ||
| "Received no response for renew_flight_endpoint call", | ||
| ))?; | ||
| FlightEndpoint::decode(response).map_err(|e| FlightError::DecodeError(e.to_string())) |
There was a problem hiding this comment.
yes, I think the SQL interface should support this feature as well. Let's keep that out of this PR though.
This was referenced Feb 22, 2024
|
Thank you @Jefffrey and @crepererum |
Closed
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.
Which issue does this PR close?
Closes #5367
Rationale for this change
Update
Flight.prototo as of: https://github.com/apache/arrow/blob/0993b369c4b91d81a17166d1427e7c26cd9beee4/format/Flight.protoUpdate
FlightSql.prototo as of: https://github.com/apache/arrow/blob/0993b369c4b91d81a17166d1427e7c26cd9beee4/format/FlightSql.protoTaking inspiration from these arrow commits:
What changes are included in this PR?
prost-typesto get theTimestampstruct (also bumpprostversion to latest)FlightEndpoint:expiration_timeandapp_metadataFlightInfo:app_metadataPollInfoCancelFlightInfoRequestCancelFlightInfoResultRenewFlightEndpointRequestpoll_flight_infomethod for Flight serverpoll_flight_infocancel_flight_inforenew_flight_endpointAre there any user-facing changes?
Yes