Struct sql::plan::StatementContext

pub struct StatementContext<'a> {
    pcx: Option<&'a PlanContext>,
    pub catalog: &'a dyn SessionCatalog,
    pub param_types: RefCell<BTreeMap<usize, ScalarType>>,
}

Immutable state that applies to the planning of an entire Statement.

Fields

pcx: Option<&'a PlanContext>

The optional PlanContext, which will be present for statements that execute within the OneShot QueryLifetime and None otherwise (views). This is an awkward field and should probably be relocated to a place that fits our execution model more closely.

catalog: &'a dyn SessionCatalog

param_types: RefCell<BTreeMap<usize, ScalarType>>

The types of the parameters in the query. This is filled in as planning occurs.

Implementations

impl<'a> StatementContext<'a>

pub fn new(
    pcx: Option<&'a PlanContext>,
    catalog: &'a dyn SessionCatalog
) -> StatementContext<'a>

pub fn pcx(&self) -> Result<&PlanContext, Error>

pub fn allocate_name(&self, name: PartialName) -> FullName

pub fn allocate_temporary_name(&self, name: PartialName) -> FullName

pub fn resolve_default_database(
    &self
) -> Result<&dyn CatalogDatabase, PlanError>

pub fn resolve_default_schema(&self) -> Result<&dyn CatalogSchema, PlanError>

pub fn resolve_database(
    &self,
    name: UnresolvedObjectName
) -> Result<&dyn CatalogDatabase, PlanError>

pub fn resolve_database_ident(
    &self,
    name: Ident
) -> Result<&dyn CatalogDatabase, PlanError>

pub fn resolve_schema(
    &self,
    name: UnresolvedObjectName
) -> Result<&dyn CatalogSchema, PlanError>

pub fn resolve_item(
    &self,
    name: UnresolvedObjectName
) -> Result<&dyn CatalogItem, PlanError>

pub fn resolve_function(
    &self,
    name: UnresolvedObjectName
) -> Result<&dyn CatalogItem, PlanError>

pub fn get_item_by_id(&self, id: &GlobalId) -> &dyn CatalogItem

pub fn experimental_mode(&self) -> bool

pub fn require_experimental_mode(&self, feature_name: &str) -> Result<(), Error>

pub fn finalize_param_types(self) -> Result<Vec<ScalarType>, Error>

pub fn humanize_scalar_type(&self, typ: &ScalarType) -> String

pub fn humanize_column_type(&self, typ: &ColumnType) -> String

Trait Implementations

impl<'a> Clone for StatementContext<'a>

fn clone(&self) -> StatementContext<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for StatementContext<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'_ StatementContext<'a>> for OptimizerConfig

Convert a reference to a StatementContext to an OptimizerConfig.

This picks up feature flag values such as qgm_optimizations from the PlanContext if this is present in the StatementContext, otherwise uses sensible defaults.

fn from(scx: &StatementContext<'_>) -> Self

Performs the conversion.