Struct arrow_flight::sql::client::FlightSqlServiceClient
source · pub struct FlightSqlServiceClient { /* private fields */ }
Expand description
A FlightSQLServiceClient is an endpoint for retrieving or storing Arrow data by FlightSQL protocol.
Implementations§
source§impl FlightSqlServiceClient
impl FlightSqlServiceClient
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.
sourcepub async fn new_with_endpoint(
client_ident: Identity,
server_ca: Certificate,
domain: &str,
host: &str,
port: u16
) -> Result<Self, ArrowError>
pub async fn new_with_endpoint(
client_ident: Identity,
server_ca: Certificate,
domain: &str,
host: &str,
port: u16
) -> Result<Self, ArrowError>
Creates a new HTTPs FlightSql Client that connects via TCP to a server
sourcepub fn new(channel: Channel) -> Self
pub fn new(channel: Channel) -> Self
Creates a new FlightSql client that connects to a server over an arbitrary tonic Channel
sourcepub fn inner(&self) -> &FlightServiceClient<Channel>
pub fn inner(&self) -> &FlightServiceClient<Channel>
Return a reference to the underlying FlightServiceClient
sourcepub fn inner_mut(&mut self) -> &mut FlightServiceClient<Channel>
pub fn inner_mut(&mut self) -> &mut FlightServiceClient<Channel>
Return a mutable reference to the underlying FlightServiceClient
sourcepub fn into_inner(self) -> FlightServiceClient<Channel>
pub fn into_inner(self) -> FlightServiceClient<Channel>
Consume this client and return the underlying FlightServiceClient
sourcepub async fn execute(&mut self, query: String) -> Result<FlightInfo, ArrowError>
pub async fn execute(&mut self, query: String) -> Result<FlightInfo, ArrowError>
Execute a query on the server.
sourcepub async fn handshake(
&mut self,
username: &str,
password: &str
) -> Result<Bytes, ArrowError>
pub async fn handshake(
&mut self,
username: &str,
password: &str
) -> Result<Bytes, ArrowError>
Perform a handshake
with the server, passing credentials and establishing a session
Returns arbitrary auth/handshake info binary blob
sourcepub async fn execute_update(&mut self, query: String) -> Result<i64, ArrowError>
pub async fn execute_update(&mut self, query: String) -> Result<i64, ArrowError>
Execute a update query on the server, and return the number of records affected
sourcepub async fn get_catalogs(&mut self) -> Result<FlightInfo, ArrowError>
pub async fn get_catalogs(&mut self) -> Result<FlightInfo, ArrowError>
Request a list of catalogs as tabular FlightInfo results
sourcepub async fn get_db_schemas(
&mut self,
request: CommandGetDbSchemas
) -> Result<FlightInfo, ArrowError>
pub async fn get_db_schemas(
&mut self,
request: CommandGetDbSchemas
) -> Result<FlightInfo, ArrowError>
Request a list of database schemas as tabular FlightInfo results
sourcepub async fn do_get(
&mut self,
ticket: Ticket
) -> Result<Streaming<FlightData>, ArrowError>
pub async fn do_get(
&mut self,
ticket: Ticket
) -> Result<Streaming<FlightData>, ArrowError>
Given a flight ticket, request to be sent the stream. Returns record batch stream reader
sourcepub async fn get_tables(
&mut self,
request: CommandGetTables
) -> Result<FlightInfo, ArrowError>
pub async fn get_tables(
&mut self,
request: CommandGetTables
) -> Result<FlightInfo, ArrowError>
Request a list of tables.
sourcepub async fn get_primary_keys(
&mut self,
request: CommandGetPrimaryKeys
) -> Result<FlightInfo, ArrowError>
pub async fn get_primary_keys(
&mut self,
request: CommandGetPrimaryKeys
) -> Result<FlightInfo, ArrowError>
Request the primary keys for a table.
sourcepub async fn get_exported_keys(
&mut self,
request: CommandGetExportedKeys
) -> Result<FlightInfo, ArrowError>
pub async fn get_exported_keys(
&mut self,
request: CommandGetExportedKeys
) -> Result<FlightInfo, ArrowError>
Retrieves a description about the foreign key columns that reference the primary key columns of the given table.
sourcepub async fn get_imported_keys(
&mut self,
request: CommandGetImportedKeys
) -> Result<FlightInfo, ArrowError>
pub async fn get_imported_keys(
&mut self,
request: CommandGetImportedKeys
) -> Result<FlightInfo, ArrowError>
Retrieves the foreign key columns for the given table.
sourcepub async fn get_cross_reference(
&mut self,
request: CommandGetCrossReference
) -> Result<FlightInfo, ArrowError>
pub async fn get_cross_reference(
&mut self,
request: CommandGetCrossReference
) -> Result<FlightInfo, ArrowError>
Retrieves a description of the foreign key columns in the given foreign key table that reference the primary key or the columns representing a unique constraint of the parent table (could be the same or a different table).
sourcepub async fn get_table_types(&mut self) -> Result<FlightInfo, ArrowError>
pub async fn get_table_types(&mut self) -> Result<FlightInfo, ArrowError>
Request a list of table types.
sourcepub async fn get_sql_info(
&mut self,
sql_infos: Vec<SqlInfo>
) -> Result<FlightInfo, ArrowError>
pub async fn get_sql_info(
&mut self,
sql_infos: Vec<SqlInfo>
) -> Result<FlightInfo, ArrowError>
Request a list of SQL information.
sourcepub async fn prepare(
&mut self,
query: String
) -> Result<PreparedStatement<Channel>, ArrowError>
pub async fn prepare(
&mut self,
query: String
) -> Result<PreparedStatement<Channel>, ArrowError>
Create a prepared statement object.
sourcepub async fn close(&mut self) -> Result<(), ArrowError>
pub async fn close(&mut self) -> Result<(), ArrowError>
Explicitly shut down and clean up the client.
Trait Implementations§
source§impl Clone for FlightSqlServiceClient
impl Clone for FlightSqlServiceClient
source§fn clone(&self) -> FlightSqlServiceClient
fn clone(&self) -> FlightSqlServiceClient
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl !RefUnwindSafe for FlightSqlServiceClient
impl Send for FlightSqlServiceClient
impl Sync for FlightSqlServiceClient
impl Unpin for FlightSqlServiceClient
impl !UnwindSafe for FlightSqlServiceClient
Blanket Implementations§
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request