Struct arrow_flight::sql::client::FlightSqlServiceClient

pub struct FlightSqlServiceClient { /* private fields */ }

A FlightSQLServiceClient is an endpoint for retrieving or storing Arrow data by FlightSQL protocol.

Implementations

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.

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

pub fn new(channel: Channel) -> Self

Creates a new FlightSql client that connects to a server over an arbitrary tonic Channel

pub async fn execute(&mut self, query: String) -> Result<FlightInfo, ArrowError>

Execute a query on the server.

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

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

pub async fn get_catalogs(&mut self) -> Result<FlightInfo, ArrowError>

Request a list of catalogs as tabular FlightInfo results

pub async fn get_db_schemas(
    &mut self,
    request: CommandGetDbSchemas
) -> Result<FlightInfo, ArrowError>

Request a list of database schemas as tabular FlightInfo results

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

pub async fn get_tables(
    &mut self,
    request: CommandGetTables
) -> Result<FlightInfo, ArrowError>

Request a list of tables.

pub async fn get_primary_keys(
    &mut self,
    request: CommandGetPrimaryKeys
) -> Result<FlightInfo, ArrowError>

Request the primary keys for a table.

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.

pub async fn get_imported_keys(
    &mut self,
    request: CommandGetImportedKeys
) -> Result<FlightInfo, ArrowError>

Retrieves the foreign key columns for the given table.

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).

pub async fn get_table_types(&mut self) -> Result<FlightInfo, ArrowError>

Request a list of table types.

pub async fn get_sql_info(
    &mut self,
    sql_infos: Vec<SqlInfo>
) -> Result<FlightInfo, ArrowError>

Request a list of SQL information.

pub async fn prepare(
    &mut self,
    query: String
) -> Result<PreparedStatement<Channel>, ArrowError>

Create a prepared statement object.

pub async fn close(&mut self) -> Result<(), ArrowError>

Explicitly shut down and clean up the client.

Trait Implementations

impl Clone for FlightSqlServiceClient

fn clone(&self) -> FlightSqlServiceClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FlightSqlServiceClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.