Struct SqlTable 

pub struct SqlTable {
    pub table_reference: TableReference,
    /* private fields */
}

A TableProvider for remote ClickHouse sql tables.

Fields

table_reference: TableReference

Implementations

impl SqlTable

pub async fn try_new( name: &str, pool: Arc<ClickHouseConnectionPool>, table_reference: impl Into<TableReference>, ) -> Result<Self>

Create a new SqlTable from a name and a ClickHouseConnectionPool.

Errors

• Returns an error if the table does not exist.

pub fn new_with_schema_unchecked( name: &str, pool: Arc<ClickHouseConnectionPool>, schema: impl Into<SchemaRef>, table_reference: impl Into<TableReference>, ) -> Self

pub fn with_exprs(self, exprs: Vec<Expr>) -> Self

pub fn with_coercion(self, coerce: bool) -> Self

Whether to coerce the RecordBatches returned by SQLExecutor::execute using the provided LogicalPlan’s schema.

pub fn pool(&self) -> &Arc<ClickHouseConnectionPool>

Access the underlying connection pool

Trait Implementations

impl Clone for SqlTable

fn clone(&self) -> SqlTable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SqlTable

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

Formats the value using the given formatter.

impl Display for SqlTable

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

Formats the value using the given formatter.

impl TableProvider for SqlTable

fn as_any(&self) -> &dyn Any

Returns the table provider as Any so that it can be downcast to a specific implementation.

fn schema(&self) -> SchemaRef

Get a reference to the schema for this table

fn table_type(&self) -> TableType

Get the type of this table for metadata/catalog purposes.

fn supports_filters_pushdown( &self, filters: &[&Expr], ) -> Result<Vec<TableProviderFilterPushDown>>

Specify if DataFusion should provide filter expressions to the TableProvider to apply during the scan.

fn scan<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _state: &'life1 dyn Session, projection: Option<&'life2 Vec<usize>>, filters: &'life3 [Expr], limit: Option<usize>, ) -> Pin<Box<dyn Future<Output = Result<Arc<dyn ExecutionPlan>>> + Send + 'async_trait>>

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

Create an ExecutionPlan for scanning the table with optionally specified projection, filter and limit, described below.

fn constraints(&self) -> Option<&Constraints>

Get a reference to the constraints of the table. Returns:

fn get_table_definition(&self) -> Option<&str>

Get the create statement used to create this table, if available.

fn get_logical_plan(&self) -> Option<Cow<'_, LogicalPlan>>

Get the LogicalPlan of this table, if available.

fn get_column_default(&self, _column: &str) -> Option<&Expr>

Get the default value for a column, if available.

fn statistics(&self) -> Option<Statistics>

Get statistics for this table, if available Although not presently used in mainline DataFusion, this allows implementation specific behavior for downstream repositories, in conjunction with specialized optimizer rules to perform operations such as re-ordering of joins.

fn insert_into<'life0, 'life1, 'async_trait>( &'life0 self, _state: &'life1 dyn Session, _input: Arc<dyn ExecutionPlan>, _insert_op: InsertOp, ) -> Pin<Box<dyn Future<Output = Result<Arc<dyn ExecutionPlan>, DataFusionError>> + Send + 'async_trait>>

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

Return an ExecutionPlan to insert data into this table, if supported.