Struct FlightSqlDriver

pub struct FlightSqlDriver { /* private fields */ }

Available on crate feature flight only.

Default Flight SQL driver. Requires a QUERY to be passed as a table option. If USERNAME (and optionally PASSWORD) are passed, will perform the Handshake using basic authentication. Any additional headers for the GetFlightInfo call can be passed as table options using the HEADER_PREFIX prefix. If a token is returned by the server with the handshake response, it will be stored as a gRPC authorization header within the returned FlightMetadata, to be sent with the subsequent DoGet requests.

Implementations

impl FlightSqlDriver

pub fn new() -> Self

pub fn with_properties_template( self, properties_template: FlightProperties, ) -> Self

Custom flight properties to be returned from the metadata call instead of the default ones. The headers (if any) will only be used for the Handshake/GetFlightInfo calls by default. This behaviour can be changed by calling Self::with_persistent_headers below. Headers provided as options for the metadata call will overwrite the template ones.

pub fn with_persistent_headers(self, persistent_headers: bool) -> Self

Propagate the static headers configured for Handshake/GetFlightInfo to the subsequent DoGet calls.

Trait Implementations

impl Clone for FlightSqlDriver

fn clone(&self) -> FlightSqlDriver

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlightSqlDriver

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

Formats the value using the given formatter.

impl Default for FlightSqlDriver

fn default() -> FlightSqlDriver

Returns the “default value” for a type.

impl FlightDriver for FlightSqlDriver

fn metadata<'life0, 'life1, 'async_trait>( &'life0 self, channel: Channel, options: &'life1 HashMap<String, String>, ) -> Pin<Box<dyn Future<Output = Result<FlightMetadata>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns a FlightMetadata from the specified channel, according to the provided table options. The driver must provide at least a FlightInfo in order to construct a flight metadata.