Struct arrow_flight::sql::metadata::XdbcTypeInfoDataBuilder

pub struct XdbcTypeInfoDataBuilder { /* private fields */ }

Implementations

impl XdbcTypeInfoDataBuilder

A builder for XdbcTypeInfoData which is used to create CommandGetXdbcTypeInfo responses.

Example

use arrow_flight::sql::{Nullable, Searchable, XdbcDataType};
use arrow_flight::sql::metadata::{XdbcTypeInfo, XdbcTypeInfoDataBuilder};
// Create the list of metadata describing the server. Since this would not change at
// runtime, using once_cell::Lazy or similar patterns to constuct the list is a common approach.
let mut builder = XdbcTypeInfoDataBuilder::new();
builder.append(XdbcTypeInfo {
    type_name: "INTEGER".into(),
    data_type: XdbcDataType::XdbcInteger,
    column_size: Some(32),
    literal_prefix: None,
    literal_suffix: None,
    create_params: None,
    nullable: Nullable::NullabilityNullable,
    case_sensitive: false,
    searchable: Searchable::Full,
    unsigned_attribute: Some(false),
    fixed_prec_scale: false,
    auto_increment: Some(false),
    local_type_name: Some("INTEGER".into()),
    minimum_scale: None,
    maximum_scale: None,
    sql_data_type: XdbcDataType::XdbcInteger,
    datetime_subcode: None,
    num_prec_radix: Some(2),
    interval_precision: None,
});
let info_list = builder.build().unwrap();

// to access the underlying record batch
let batch = info_list.record_batch(None);

pub fn new() -> Self

Create a new instance of XdbcTypeInfoDataBuilder.

pub fn append(&mut self, info: XdbcTypeInfo)

Append a new row

pub fn build(self) -> Result<XdbcTypeInfoData>

Create helper structure for handling xdbc metadata requests.

pub fn schema(&self) -> SchemaRef

Return the Schema for a GetSchema RPC call with CommandGetXdbcTypeInfo

Trait Implementations

impl Default for XdbcTypeInfoDataBuilder

fn default() -> Self

Returns the “default value” for a type.