Struct mz_sql::plan::statement::StatementContext
source · 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>,
}
Expand description
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§
source§impl<'a> StatementContext<'a>
impl<'a> StatementContext<'a>
pub fn new( pcx: Option<&'a PlanContext>, catalog: &'a dyn SessionCatalog, ) -> StatementContext<'a>
sourcepub fn current_schemas(&self) -> &[(ResolvedDatabaseSpecifier, SchemaSpecifier)]
pub fn current_schemas(&self) -> &[(ResolvedDatabaseSpecifier, SchemaSpecifier)]
Returns the schemas in order of search_path that exist in the catalog.
sourcepub fn current_schema(
&self,
) -> Option<&(ResolvedDatabaseSpecifier, SchemaSpecifier)>
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: GlobalId, 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: &GlobalId) -> &dyn CatalogItem
pub fn get_item_by_resolved_name( &self, name: &ResolvedItemName, ) -> Result<&dyn CatalogItem, PlanError>
pub fn get_column_by_resolved_name( &self, name: &ColumnName<Aug>, ) -> Result<(&dyn CatalogItem, 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
sourcepub fn require_feature_flag(&self, flag: &FeatureFlag) -> Result<(), PlanError>
pub fn require_feature_flag(&self, flag: &FeatureFlag) -> Result<(), PlanError>
Returns an error if the named FeatureFlag
is not set to on
.
sourcepub fn require_feature_flag_w_dynamic_desc(
&self,
flag: &FeatureFlag,
desc: String,
detail: String,
) -> Result<(), PlanError>
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.
sourcepub fn is_feature_flag_enabled(&self, flag: &FeatureFlag) -> bool
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>
sourcepub fn dangerous_resolve_name(&self, name: Vec<&str>) -> ResolvedItemName
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§
source§impl<'a> Clone for StatementContext<'a>
impl<'a> Clone for StatementContext<'a>
source§fn clone(&self) -> StatementContext<'a>
fn clone(&self) -> StatementContext<'a>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl<'a> !Freeze for StatementContext<'a>
impl<'a> !RefUnwindSafe for StatementContext<'a>
impl<'a> Send for StatementContext<'a>
impl<'a> !Sync for StatementContext<'a>
impl<'a> Unpin for StatementContext<'a>
impl<'a> !UnwindSafe for StatementContext<'a>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T> FutureExt for T
impl<T> FutureExt for T
source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request
source§impl<T, U> OverrideFrom<Option<&T>> for Uwhere
U: OverrideFrom<T>,
impl<T, U> OverrideFrom<Option<&T>> for Uwhere
U: OverrideFrom<T>,
source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T> ProgressEventTimestamp for T
impl<T> ProgressEventTimestamp for T
source§impl<P, R> ProtoType<R> for Pwhere
R: RustType<P>,
impl<P, R> ProtoType<R> for Pwhere
R: RustType<P>,
source§fn into_rust(self) -> Result<R, TryFromProtoError>
fn into_rust(self) -> Result<R, TryFromProtoError>
RustType::from_proto
.source§fn from_rust(rust: &R) -> P
fn from_rust(rust: &R) -> P
RustType::into_proto
.source§impl<'a, S, T> Semigroup<&'a S> for Twhere
T: Semigroup<S>,
impl<'a, S, T> Semigroup<&'a S> for Twhere
T: Semigroup<S>,
source§fn plus_equals(&mut self, rhs: &&'a S)
fn plus_equals(&mut self, rhs: &&'a S)
std::ops::AddAssign
, for types that do not implement AddAssign
.source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.