From cf8084940d7b41d3f3d066a993981b20bb006e0c Mon Sep 17 00:00:00 2001 From: Devin D'Angelo Date: Mon, 22 Jan 2024 06:31:05 -0500 Subject: [PATCH] Minor/Doc Expand FlightSqlServiceClient::handshake doc (#5321) * FlightSQL handshake doc * Update client.rs Co-authored-by: Raphael Taylor-Davies <1781103+tustvold@users.noreply.github.com> --------- Co-authored-by: Raphael Taylor-Davies <1781103+tustvold@users.noreply.github.com> --- arrow-flight/src/sql/client.rs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/arrow-flight/src/sql/client.rs b/arrow-flight/src/sql/client.rs index 133df5b044c..6448e69e7f3 100644 --- a/arrow-flight/src/sql/client.rs +++ b/arrow-flight/src/sql/client.rs @@ -131,8 +131,11 @@ impl FlightSqlServiceClient { self.get_flight_info_for_command(cmd).await } - /// Perform a `handshake` with the server, passing credentials and establishing a session - /// Returns arbitrary auth/handshake info binary blob + /// Perform a `handshake` with the server, passing credentials and establishing a session. + /// + /// If the server returns an "authorization" header, it is automatically parsed and set as + /// a token for future requests. Any other data returned by the server in the handshake + /// response is returned as a binary blob. pub async fn handshake(&mut self, username: &str, password: &str) -> Result { let cmd = HandshakeRequest { protocol_version: 0,