Struct SqlTable

pub struct SqlTable<T: 'static, P: 'static> {
    pub table_reference: TableReference,
    /* private fields */
}

Fields

table_reference: TableReference

Implementations

impl<T, P> SqlTable<T, P>

pub fn create_federated_table_provider( self: Arc<Self>, ) -> DataFusionResult<FederatedTableProviderAdaptor>

Available on crate feature federation only.

impl<T, P> SqlTable<T, P>

pub async fn new( name: &str, pool: &Arc<dyn DbConnectionPool<T, P> + Send + Sync>, table_reference: impl Into<TableReference>, ) -> Result<Self>

pub fn new_with_schema( name: &str, pool: &Arc<dyn DbConnectionPool<T, P> + Send + Sync>, schema: impl Into<SchemaRef>, table_reference: impl Into<TableReference>, ) -> Self

pub fn scan_to_sql( &self, projection: Option<&Vec<usize>>, filters: &[Expr], limit: Option<usize>, ) -> DataFusionResult<String>

pub fn with_dialect(self, dialect: Arc<dyn Dialect + Send + Sync>) -> Self

pub fn name(&self) -> &str

pub fn clone_pool(&self) -> Arc<dyn DbConnectionPool<T, P> + Send + Sync>

Trait Implementations

impl<T: Clone + 'static, P: Clone + 'static> Clone for SqlTable<T, P>

fn clone(&self) -> SqlTable<T, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, P> Debug for SqlTable<T, P>

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

Formats the value using the given formatter.

impl<T, P> Display for SqlTable<T, P>

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

Formats the value using the given formatter.

impl<T, P> SQLExecutor for SqlTable<T, P>

Available on crate feature federation only.

fn name(&self) -> &str

Executor name

fn compute_context(&self) -> Option<String>

Executor compute context allows differentiating the remote compute context such as authorization or active database.

fn dialect(&self) -> Arc<dyn Dialect>

The specific SQL dialect (currently supports ‘sqlite’, ‘postgres’, ‘flight’)

fn execute( &self, query: &str, schema: SchemaRef, ) -> DataFusionResult<SendableRecordBatchStream>

Execute a SQL query

fn table_names<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = DataFusionResult<Vec<String>>> + Send + 'async_trait>>

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

Returns the tables provided by the remote

fn get_table_schema<'life0, 'life1, 'async_trait>( &'life0 self, table_name: &'life1 str, ) -> Pin<Box<dyn Future<Output = DataFusionResult<SchemaRef>> + Send + 'async_trait>>

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

Returns the schema of table_name within this SQLExecutor

fn logical_optimizer( &self, ) -> Option<Box<dyn FnMut(LogicalPlan) -> Result<LogicalPlan, DataFusionError>>>

Returns the analyzer rule specific for this engine to modify the logical plan before execution

fn ast_analyzer( &self, ) -> Option<Box<dyn FnMut(Statement) -> Result<Statement, DataFusionError>>>

Returns an AST analyzer specific for this engine to modify the AST before execution

fn statistics<'life0, 'life1, 'async_trait>( &'life0 self, plan: &'life1 LogicalPlan, ) -> Pin<Box<dyn Future<Output = Result<Statistics, DataFusionError>> + Send + 'async_trait>>

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

Returns statistics for this SQLExecutor node. If statistics are not available, it should return Statistics::new_unknown (the default), not an error. See the ExecutionPlan trait.

impl<T, P> TableProvider for SqlTable<T, P>

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], ) -> DataFusionResult<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 = DataFusionResult<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.