viirya commented on code in PR #3207: URL: https://github.com/apache/arrow-rs/pull/3207#discussion_r1043836262
########## arrow-flight/src/sql/client.rs: ########## @@ -0,0 +1,532 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +use std::collections::HashMap; +use std::sync::Arc; +use std::time::Duration; + +use crate::flight_service_client::FlightServiceClient; +use crate::sql::server::{CLOSE_PREPARED_STATEMENT, CREATE_PREPARED_STATEMENT}; +use crate::sql::{ + ActionClosePreparedStatementRequest, ActionCreatePreparedStatementRequest, + ActionCreatePreparedStatementResult, CommandGetCatalogs, CommandGetCrossReference, + CommandGetDbSchemas, CommandGetExportedKeys, CommandGetImportedKeys, + CommandGetPrimaryKeys, CommandGetSqlInfo, CommandGetTableTypes, CommandGetTables, + CommandPreparedStatementQuery, CommandStatementQuery, CommandStatementUpdate, + DoPutUpdateResult, ProstAnyExt, ProstMessageExt, SqlInfo, +}; +use crate::{ + Action, FlightData, FlightDescriptor, FlightInfo, HandshakeRequest, + HandshakeResponse, IpcMessage, Ticket, +}; +use arrow_array::RecordBatch; +use arrow_buffer::Buffer; +use arrow_ipc::convert::fb_to_schema; +use arrow_ipc::reader::read_record_batch; +use arrow_ipc::{root_as_message, MessageHeader}; +use arrow_schema::{ArrowError, Schema, SchemaRef}; +use futures::{stream, TryStreamExt}; +use prost::Message; +use tokio::sync::{Mutex, MutexGuard}; +use tonic::transport::{Channel, Endpoint}; +use tonic::Streaming; + +/// A FlightSQLServiceClient is an endpoint for retrieving or storing Arrow data +/// by FlightSQL protocol. +#[derive(Debug, Clone)] +pub struct FlightSqlServiceClient { + token: Option<String>, + flight_client: Arc<Mutex<FlightServiceClient<Channel>>>, +} + +/// A FlightSql protocol client that can run queries against FlightSql servers +/// This client is in the "experimental" stage. It is not guaranteed to follow the spec in all instances. +/// Github issues are welcomed. +impl FlightSqlServiceClient { + /// Creates a new FlightSql Client that connects via TCP to a server + pub async fn new_with_ep(host: &str, port: u16) -> Result<Self, ArrowError> { + let addr = format!("http://{}:{}";, host, port); + let endpoint = Endpoint::new(addr) + .map_err(|_| ArrowError::IoError("Cannot create endpoint".to_string()))? + .connect_timeout(Duration::from_secs(20)) + .timeout(Duration::from_secs(20)) + .tcp_nodelay(true) // Disable Nagle's Algorithm since we don't want packets to wait + .tcp_keepalive(Option::Some(Duration::from_secs(3600))) + .http2_keep_alive_interval(Duration::from_secs(300)) + .keep_alive_timeout(Duration::from_secs(20)) + .keep_alive_while_idle(true); + let channel = endpoint + .connect() + .await + .map_err(|_| ArrowError::IoError("Cannot connect to endpoint".to_string()))?; + Ok(Self::new(channel)) + } + + /// Creates a new FlightSql client that connects to a server over an arbitrary tonic `Channel` + pub fn new(channel: Channel) -> Self { + let flight_client = FlightServiceClient::new(channel); + FlightSqlServiceClient { + token: None, + flight_client: Arc::new(Mutex::new(flight_client)), + } + } + + fn mut_client( + &mut self, + ) -> Result<MutexGuard<FlightServiceClient<Channel>>, ArrowError> { + self.flight_client + .try_lock() + .map_err(|_| ArrowError::IoError("Unable to lock client".to_string())) + } + + async fn get_flight_info_for_command<M: ProstMessageExt>( + &mut self, + cmd: M, + ) -> Result<FlightInfo, ArrowError> { + let descriptor = FlightDescriptor::new_cmd(cmd.as_any().encode_to_vec()); + let fi = self + .mut_client()? + .get_flight_info(descriptor) + .await + .map_err(status_to_arrow_error)? + .into_inner(); + Ok(fi) + } + + /// Execute a query on the server. + pub async fn execute(&mut self, query: String) -> Result<FlightInfo, ArrowError> { + let cmd = CommandStatementQuery { query }; + self.get_flight_info_for_command(cmd).await + } + + /// Perform a `handshake` with the server, passing credentials and establishing a session + pub async fn handshake( + &mut self, + username: &str, + password: &str, + ) -> Result<Vec<u8>, ArrowError> { + let cmd = HandshakeRequest { + protocol_version: 0, + payload: vec![], + }; + let mut req = tonic::Request::new(stream::iter(vec![cmd])); + let val = base64::encode(format!("{}:{}", username, password)); + let val = format!("Basic {}", val) + .parse() + .map_err(|_| ArrowError::ParseError("Cannot parse header".to_string()))?; + req.metadata_mut().insert("authorization", val); + let resp = self + .mut_client()? + .handshake(req) + .await + .map_err(|e| ArrowError::IoError(format!("Can't handshake {}", e)))?; + if let Some(auth) = resp.metadata().get("authorization") { + let auth = auth.to_str().map_err(|_| { + ArrowError::ParseError("Can't read auth header".to_string()) + })?; + let bearer = "Bearer "; + if !auth.starts_with(bearer) { + Err(ArrowError::ParseError("Invalid auth header!".to_string()))?; + } + let auth = auth[bearer.len()..].to_string(); + self.token = Some(auth); + } + let responses: Vec<HandshakeResponse> = + resp.into_inner().try_collect().await.map_err(|_| { + ArrowError::ParseError("Can't collect responses".to_string()) + })?; + let resp = match responses.as_slice() { + [resp] => resp, + [] => Err(ArrowError::ParseError("No handshake response".to_string()))?, + _ => Err(ArrowError::ParseError( + "Multiple handshake responses".to_string(), + ))?, + }; + Ok(resp.payload.clone()) + } + + /// Execute a update query on the server. + pub async fn execute_update(&mut self, query: String) -> Result<i64, ArrowError> { + let cmd = CommandStatementUpdate { query }; + let descriptor = FlightDescriptor::new_cmd(cmd.as_any().encode_to_vec()); + let mut result = self + .mut_client()? + .do_put(stream::iter(vec![FlightData { + flight_descriptor: Some(descriptor), + ..Default::default() + }])) + .await + .map_err(status_to_arrow_error)? + .into_inner(); + let result = result + .message() + .await + .map_err(status_to_arrow_error)? + .unwrap(); + let any: prost_types::Any = prost::Message::decode(&*result.app_metadata) + .map_err(decode_error_to_arrow_error)?; + let result: DoPutUpdateResult = any.unpack()?.unwrap(); + Ok(result.record_count) + } + + /// Request a list of catalogs. + pub async fn get_catalogs(&mut self) -> Result<FlightInfo, ArrowError> { + self.get_flight_info_for_command(CommandGetCatalogs {}) + .await + } + + /// Request a list of database schemas. + pub async fn get_db_schemas( + &mut self, + request: CommandGetDbSchemas, + ) -> Result<FlightInfo, ArrowError> { + self.get_flight_info_for_command(request).await + } Review Comment: ditto. -- 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: github-unsubscr...@arrow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
