Struct arrow_flight::sql::metadata::SqlInfoList

pub struct SqlInfoList { /* private fields */ }

A builder for CommandGetSqlInfo response.

CommandGetSqlInfo are metadata requests used by a Flight SQL server to communicate supported capabilities to Flight SQL clients.

Servers construct a SqlInfoList by adding infos via with_sql_info and build the response using encode.

The available configuration options are defined in the Flight SQL protos.

Example

// Create the list of metadata describing the server
let info_list = SqlInfoList::new()
    .with_sql_info(SqlInfo::FlightSqlServerName, "server name")
    // ... add other SqlInfo here ..
    .with_sql_info(
        SqlInfo::FlightSqlServerTransaction,
        SqlSupportedTransaction::Transaction as i32,
    );

// Create the batch to send back to the client
let batch = info_list.encode().unwrap();

Implementations

impl SqlInfoList

pub fn new() -> Self

pub fn with_sql_info( self, name: impl SqlInfoName, value: impl Into<SqlInfoValue> ) -> Self

register the specific sql metadata item

pub fn filter(&self, info: &[u32]) -> Cow<'_, Self>

Filter this info list keeping only the info values specified in infos.

Returns self if infos is empty (no filtering)

pub fn encode(&self) -> Result<RecordBatch>

Encode the contents of this list according to the FlightSQL spec

pub fn schema() -> &'static Schema

Return the Schema for a GetSchema RPC call with crate::sql::CommandGetSqlInfo

Trait Implementations

impl Clone for SqlInfoList

fn clone(&self) -> SqlInfoList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SqlInfoList

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

Formats the value using the given formatter.

impl Default for SqlInfoList

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<SqlInfoList> for SqlInfoList

fn eq(&self, other: &SqlInfoList) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SqlInfoList