Struct mz_adapter::optimize::OptimizerConfig

pub struct OptimizerConfig {
    pub mode: OptimizeMode,
    pub replan: Option<GlobalId>,
    pub no_fast_path: bool,
    pub features: OptimizerFeatures,
}

Feature flags for the optimizer.

To add a new feature flag, do the following steps:

1. To make the flag available to all stages in our Optimize pipelines and allow engineers to set a system-wide override:

   1. Add the flag to the optimizer_feature_flags!(...) macro call.
   2. Add the flag to the feature_flags!(...) macro call and extend the From<&SystemVars> implementation for OptimizerFeatures.

2. To enable EXPLAIN ... WITH(...) overrides which will allow engineers to inspect plan differences before deploying the optimizer changes:

   1. Add the flag to the ExplainPlanOptionName definition.
   2. Add the flag to the generate_extracted_config!(ExplainPlanOption, ...) macro call.
   3. Extend the TryFrom<ExplainPlanOptionExtracted> implementation for mz_repr::explain::ExplainConfig.

3. To enable CLUSTER ... FEATURES(...) overrides which will allow engineers to experiment with runtime differences before deploying the optimizer changes:

   1. Add the flag to the ClusterFeatureName definition.
   2. Add the flag to the generate_extracted_config!(ClusterFeature, ...) macro call.
   3. Extend the let optimizer_feature_overrides = ... call in plan_create_cluster.

Fields

mode: OptimizeMode

The mode in which the optimizer runs.

replan: Option<GlobalId>

If the GlobalId is set the optimizer works in “replan” mode.

This means that it will not consider catalog items (more specifically indexes) with GlobalId greater or equal than the one provided here.

no_fast_path: bool

Show the slow path plan even if a fast path plan was created. Useful for debugging. Enforced if timing is set.

features: OptimizerFeatures

Optimizer feature flags.

Trait Implementations

impl Clone for OptimizerConfig

fn clone(&self) -> OptimizerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OptimizerConfig

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

Formats the value using the given formatter.

impl From<&OptimizerConfig> for HirToMirConfig

fn from(config: &OptimizerConfig) -> Self

Converts to this type from the input type.

impl From<&SystemVars> for OptimizerConfig

fn from(vars: &SystemVars) -> Self

Converts to this type from the input type.

impl OverrideFrom<ExplainContext> for OptimizerConfig

OptimizerConfig overrides coming from an ExplainContext.

fn override_from(self, ctx: &ExplainContext) -> Self

Override the configuration represented by Self with values from the given layer.

impl OverrideFrom<OptimizerFeatureOverrides> for OptimizerConfig

Override OptimizerConfig::features from OptimizerFeatureOverrides.

fn override_from(self, overrides: &OptimizerFeatureOverrides) -> Self

Override the configuration represented by Self with values from the given layer.