Skip to content

Commit

Permalink
Minor/Doc Expand FlightSqlServiceClient::handshake doc (apache#5321)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
devinjdangelo and tustvold authored Jan 22, 2024
1 parent e47e2f1 commit cf80849
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions arrow-flight/src/sql/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit cf80849

Please sign in to comment.