(arrow-rs) branch master updated: Minor/Doc Expand FlightSqlServiceClient::handshake doc (#5321)

[tu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tustvold pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git


The following commit(s) were added to refs/heads/master by this push:
     new cf8084940d Minor/Doc Expand FlightSqlServiceClient::handshake doc (#5321)
cf8084940d is described below

commit cf8084940d7b41d3f3d066a993981b20bb006e0c
Author: Devin D'Angelo <de...@gmail.com>
AuthorDate: Mon Jan 22 06:31:05 2024 -0500

    Minor/Doc Expand FlightSqlServiceClient::handshake doc (#5321)
    
    * FlightSQL handshake doc
    
    * Update client.rs
    
    Co-authored-by: Raphael Taylor-Davies <17...@users.noreply.github.com>
    
    ---------
    
    Co-authored-by: Raphael Taylor-Davies <17...@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 133df5b044..6448e69e7f 100644
--- a/arrow-flight/src/sql/client.rs
+++ b/arrow-flight/src/sql/client.rs
@@ -131,8 +131,11 @@ impl FlightSqlServiceClient<Channel> {
         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<Bytes, ArrowError> {
         let cmd = HandshakeRequest {
             protocol_version: 0,