Struct ForeignSession 

pub struct ForeignSession { /* private fields */ }

This wrapper struct exists on the receiver side of the FFI interface, so it has no guarantees about being able to access the data in private_data. Any functions defined on this struct must use only the stable function pointers in FFI_SessionRef to interact with the foreign session.

Query planner delegation

If the session owner installed the current foreign query planner, Session::create_physical_plan dispatches back to that planner and Session::query_planner returns that planner. The planner must retain and invoke the session owner’s previous planner instead of using either method to delegate back to the session. Otherwise, repeated delegation exhausts the stack. See crate::query_planner for details.

Trait Implementations

impl Debug for ForeignSession

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

Formats the value using the given formatter.

impl Send for ForeignSession

impl Session for ForeignSession

fn session_id(&self) -> &str

Return the session ID

fn config(&self) -> &SessionConfig

Return the SessionConfig

fn config_options(&self) -> &ConfigOptions

return the ConfigOptions

fn catalog_list(&self) -> Arc<dyn CatalogProviderList>

Return the catalogs registered with this session.

fn query_planner(&self) -> Arc<dyn QueryPlanner + Send + Sync>

Return the query planner for this session.

fn optimize(&self, plan: &LogicalPlan) -> Result<LogicalPlan>

Optimize a logical plan.

fn create_physical_plan<'life0, 'life1, 'async_trait>( &'life0 self, logical_plan: &'life1 LogicalPlan, ) -> Pin<Box<dyn Future<Output = Result<Arc<dyn ExecutionPlan>>> + Send + 'async_trait>>

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

Creates a physical ExecutionPlan plan from a LogicalPlan.

fn create_physical_expr( &self, expr: Expr, df_schema: &DFSchema, ) -> Result<Arc<dyn PhysicalExpr>>

Create a PhysicalExpr from an Expr after applying type coercion, and function rewrites.

fn physical_optimizers(&self) -> &[Arc<dyn PhysicalOptimizerRule + Send + Sync>]

Return the physical optimizer rules for this session.

fn scalar_functions(&self) -> &HashMap<String, Arc<ScalarUDF>>

Return reference to scalar_functions

fn higher_order_functions(&self) -> &HashMap<String, Arc<HigherOrderUDF>>

Return reference to higher_order_functions

fn aggregate_functions(&self) -> &HashMap<String, Arc<AggregateUDF>>

Return reference to aggregate_functions

fn window_functions(&self) -> &HashMap<String, Arc<WindowUDF>>

Return reference to window functions

fn extension_type_registry(&self) -> &ExtensionTypeRegistryRef

Return a reference to the extension type registry

fn runtime_env(&self) -> &Arc<RuntimeEnv>

Return the runtime env

fn execution_props(&self) -> &ExecutionProps

Return the execution properties

fn as_any(&self) -> &dyn Any

fn table_options(&self) -> &TableOptions

Return the table options

fn default_table_options(&self) -> TableOptions

return the TableOptions options with its extensions

fn table_options_mut(&mut self) -> &mut TableOptions

Returns a mutable reference to TableOptions

fn task_ctx(&self) -> Arc<TaskContext>

Get a new TaskContext to run in this session

fn statistics_registry(&self) -> Option<&StatisticsRegistry>

Return the optional statistics registry used during physical optimization.

impl Sync for ForeignSession