Struct OptimizerContext 

pub struct OptimizerContext {

    session_ctx: Arc<SessionImpl>,
    sql: Arc<str>,
    normalized_sql: String,
    explain_options: ExplainOptions,
    optimizer_trace: RefCell<Vec<String>>,
    logical_explain: RefCell<Option<String>>,
    with_options: WithOptions,
    session_timezone: RefCell<SessionTimezone>,
    total_rule_applied: RefCell<usize>,
    overwrite_options: OverwriteOptions,
    rcte_cache: RefCell<HashMap<usize, LogicalPlanRef>>,
    last_plan_node_id: Cell<i32>,
    last_correlated_id: Cell<u32>,
    last_expr_display_id: Cell<usize>,
    last_watermark_group_id: Cell<u32>,
    _phantom: PhantomData<Rc<()>>,
}

Fields

session_ctx: Arc<SessionImpl>

sql: Arc<str>

The original SQL string, used for debugging.

normalized_sql: String

Normalized SQL string. See HandlerArgs::normalize_sql.

explain_options: ExplainOptions

Explain options

optimizer_trace: RefCell<Vec<String>>

Store the trace of optimizer

logical_explain: RefCell<Option<String>>

Store the optimized logical plan of optimizer

with_options: WithOptions

Store options or properties from the with clause

session_timezone: RefCell<SessionTimezone>

Store the Session Timezone and whether it was used.

total_rule_applied: RefCell<usize>

Total number of optimization rules have been applied.

overwrite_options: OverwriteOptions

Store the configs can be overwritten in with clause if not specified, use the value from session variable.

rcte_cache: RefCell<HashMap<usize, LogicalPlanRef>>

Store the mapping between share_id and the corresponding PlanRef, used by rcte’s planning. (e.g., in LogicalCteRef)

last_plan_node_id: Cell<i32>

Last assigned plan node ID.

last_correlated_id: Cell<u32>

Last assigned correlated ID.

last_expr_display_id: Cell<usize>

Last assigned expr display ID.

last_watermark_group_id: Cell<u32>

Last assigned watermark group ID.

_phantom: PhantomData<Rc<()>>

Implementations

impl OptimizerContext

pub fn from_handler_args(handler_args: HandlerArgs) -> Self

Create a new OptimizerContext from the given HandlerArgs, with empty ExplainOptions.

pub fn new(handler_args: HandlerArgs, explain_options: ExplainOptions) -> Self

Create a new OptimizerContext from the given HandlerArgs and ExplainOptions.

pub fn next_plan_node_id(&self) -> PlanNodeId

pub fn next_correlated_id(&self) -> CorrelatedId

pub fn next_expr_display_id(&self) -> usize

pub fn next_watermark_group_id(&self) -> WatermarkGroupId

pub(super) fn backup_elem_ids(&self) -> LastAssignedIds

pub(super) fn reset_elem_ids(&self)

This should only be called in crate::optimizer::plan_node::reorganize_elements_id.

pub(super) fn restore_elem_ids(&self, backup: LastAssignedIds)

pub fn add_rule_applied(&self, num: usize)

pub fn total_rule_applied(&self) -> usize

pub fn is_explain_verbose(&self) -> bool

pub fn is_explain_trace(&self) -> bool

fn is_explain_logical(&self) -> bool

pub fn trace(&self, str: impl Into<String>)

pub fn warn_to_user(&self, str: impl Into<String>)

fn explain_plan_impl(&self, plan: &impl Explain) -> String

pub fn may_store_explain_logical(&self, plan: &LogicalPlanRef)

pub fn take_logical(&self) -> Option<String>

pub fn take_trace(&self) -> Vec<String>

pub fn with_options(&self) -> &WithOptions

pub fn overwrite_options(&self) -> &OverwriteOptions

pub fn session_ctx(&self) -> &Arc<SessionImpl>

pub fn sql(&self) -> &str

Return the original SQL.

pub fn normalized_sql(&self) -> &str

Return the normalized SQL.

pub fn session_timezone(&self) -> RefMut<'_, SessionTimezone>

pub fn get_session_timezone(&self) -> String

pub fn get_rcte_cache_plan(&self, id: &usize) -> Option<PlanRef>

pub fn insert_rcte_cache_plan(&self, id: usize, plan: PlanRef)

Trait Implementations

impl Debug for OptimizerContext

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

Formats the value using the given formatter.