Struct TransformCtx

pub struct TransformCtx<'a> {
    pub global_id: Option<GlobalId>,
    pub indexes: &'a dyn IndexOracle,
    pub stats: &'a dyn StatisticsOracle,
    pub features: &'a OptimizerFeatures,
    pub typecheck_ctx: &'a SharedContext,
    pub df_meta: &'a mut DataflowMetainfo,
    pub metrics: Option<&'a OptimizerMetrics>,
    pub last_hash: BTreeMap<GlobalId, u64>,
}

Arguments that get threaded through all transforms, plus a DataflowMetainfo that can be manipulated by the transforms.

Fields

global_id: Option<GlobalId>

The global ID for this query (if it exists).

indexes: &'a dyn IndexOracle

The indexes accessible.

stats: &'a dyn StatisticsOracle

Statistical estimates.

features: &'a OptimizerFeatures

Features passed to the enclosing Optimizer.

typecheck_ctx: &'a SharedContext

Typechecking context.

df_meta: &'a mut DataflowMetainfo

Transforms can use this field to communicate information outside the result plans.

metrics: Option<&'a OptimizerMetrics>

Metrics for the optimizer.

last_hash: BTreeMap<GlobalId, u64>

The last hash of the query, if known.

Implementations

impl<'a> TransformCtx<'a>

pub fn local( features: &'a OptimizerFeatures, typecheck_ctx: &'a SharedContext, df_meta: &'a mut DataflowMetainfo, metrics: Option<&'a OptimizerMetrics>, global_id: Option<GlobalId>, ) -> Self

Generates a TransformCtx instance for the local MIR optimization stage.

Used to call Optimizer::optimize on a Optimizer::logical_optimizer in order to transform a stand-alone MirRelationExpr.

pub fn global( indexes: &'a dyn IndexOracle, stats: &'a dyn StatisticsOracle, features: &'a OptimizerFeatures, typecheck_ctx: &'a SharedContext, df_meta: &'a mut DataflowMetainfo, metrics: Option<&'a OptimizerMetrics>, ) -> Self

Generates a TransformCtx instance for the global MIR optimization stage.

Used to call optimize_dataflow.

pub(crate) fn typecheck(&self) -> SharedContext

pub fn set_global_id(&mut self, global_id: GlobalId)

Lets self know the id of the object that is being optimized.

pub(crate) fn reset_global_id(&mut self)

pub(crate) fn update_last_hash(&mut self, plan: &MirRelationExpr) -> u64

Updates last_hash with the hash of the given MIR plan for the id self.global_id. Returns the hash.

Trait Implementations

impl<'a> Debug for TransformCtx<'a>

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

Formats the value using the given formatter.