Struct mz_sql::plan::StatementContext

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

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.

ambiguous_columns: RefCell<bool>

Whether the statement contains an expression that can make the exact column list ambiguous. For example NATURAL JOIN or SELECT *. 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 current_schemas(&self) -> &[(ResolvedDatabaseSpecifier, SchemaSpecifier)]

Returns the schemas in order of search_path that exist in the catalog.

pub fn current_schema( &self, ) -> Option<&(ResolvedDatabaseSpecifier, SchemaSpecifier)>

Returns the first schema from the search_path that exist in the catalog, or None if there are none.

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

pub fn allocate_full_name( &self, name: PartialItemName, ) -> Result<FullItemName, PlanError>

pub fn allocate_qualified_name( &self, name: PartialItemName, ) -> Result<QualifiedItemName, PlanError>

pub fn allocate_temporary_full_name( &self, name: PartialItemName, ) -> FullItemName

pub fn allocate_temporary_qualified_name( &self, name: PartialItemName, ) -> Result<QualifiedItemName, PlanError>

pub fn allocate_resolved_item_name( &self, id: CatalogItemId, name: UnresolvedItemName, ) -> Result<ResolvedItemName, PlanError>

pub fn active_database(&self) -> Option<&DatabaseId>

pub fn resolve_optional_schema( &self, schema_name: &Option<ResolvedSchemaName>, ) -> Result<SchemaSpecifier, PlanError>

pub fn resolve_active_schema(&self) -> Result<&SchemaSpecifier, PlanError>

pub fn get_cluster(&self, id: &ClusterId) -> &dyn CatalogCluster<'_>

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

pub fn get_database(&self, id: &DatabaseId) -> &dyn CatalogDatabase

pub fn resolve_schema_in_database( &self, database_spec: &ResolvedDatabaseSpecifier, schema: &Ident, ) -> Result<&dyn CatalogSchema, PlanError>

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

pub fn get_schema( &self, database_spec: &ResolvedDatabaseSpecifier, schema_spec: &SchemaSpecifier, ) -> &dyn CatalogSchema

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

pub fn get_item(&self, id: &CatalogItemId) -> &dyn CatalogItem

pub fn get_item_by_resolved_name( &self, name: &ResolvedItemName, ) -> Result<Box<dyn CatalogCollectionItem>, PlanError>

pub fn get_column_by_resolved_name( &self, name: &ColumnName<Aug>, ) -> Result<(Box<dyn CatalogCollectionItem>, usize), PlanError>

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

pub fn resolve_cluster( &self, name: Option<&Ident>, ) -> Result<&dyn CatalogCluster<'_>, PlanError>

pub fn resolve_type(&self, ty: Type) -> Result<ResolvedDataType, PlanError>

pub fn get_object_type(&self, id: &ObjectId) -> ObjectType

pub fn get_system_object_type(&self, id: &SystemObjectId) -> SystemObjectType

pub fn require_feature_flag(&self, flag: &FeatureFlag) -> Result<(), PlanError>

Returns an error if the named FeatureFlag is not set to on.

pub fn require_feature_flag_w_dynamic_desc( &self, flag: &FeatureFlag, desc: String, detail: String, ) -> Result<(), PlanError>

Equivalent to Self::require_feature_flag but with the ability for the caller to control the error message.

pub fn is_feature_flag_enabled(&self, flag: &FeatureFlag) -> bool

Returns true if the named FeatureFlag is set to on, returns false otherwise.

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

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

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

pub(crate) fn build_tunnel_definition( &self, ssh_tunnel: Option<Object>, aws_privatelink: Option<ConnectionDefaultAwsPrivatelink<Aug>>, ) -> Result<Tunnel<ReferencedConnection>, PlanError>

pub fn relation_desc_into_table_defs( &self, desc: &RelationDesc, ) -> Result<(Vec<ColumnDef<Aug>>, Vec<TableConstraint<Aug>>), PlanError>

pub fn get_owner_id(&self, id: &ObjectId) -> Option<RoleId>

pub fn humanize_resolved_name( &self, name: &ResolvedItemName, ) -> Result<PartialItemName, PlanError>

pub fn dangerous_resolve_name(&self, name: Vec<&str>) -> ResolvedItemName

WARNING! This style of name resolution assumes the referred-to objects exists (i.e. panics if objects do not exist) so should never be used to handle user input.

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.