linkrs-query 0.1.0

Query engine, parser, and executor for Linkrs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! Query Optimization Module
//!
//! Provide query optimization capabilities, including the management of statistical information, cost calculation, and optimization strategies.
//!
//! ## Module Structure
//!
//! The optimizer is organized into two main optimization phases:
//!
//! ### Heuristic Optimization (`heuristic/`)
//! Rule-based optimizations that always produce better or equivalent plans:
//! - Predicate Pushdown
//! - Projection Pushdown
//! - Elimination Rules
//! - Merge Operations
//! - Limit Pushdown
//!
//! ### Cost-Based Optimization (`cost_based/`)
//! Statistics-driven optimizations that use cost models:
//! - Join Order Optimization
//! - Index Selection
//! - Traversal Start/Direction Selection
//! - Aggregate Strategy Selection
//! - Materialization Decision
//!
//! ### Supporting Modules
//! - `engine` – The globally unique optimizer engine instance with unified optimization interface
//! - `stats` – Statistical information management
//! - `cost` – Cost calculation and estimation
//! - `analysis` – Plan analysis utilities
//! - `decision` – Optimization decision types
//!
//! ## Usage Examples
//!
//! ```rust
//! use linkrs_query::optimizer::OptimizerEngine;
//!
//! // Create the optimizer engine (global instance)
//! let optimizer = OptimizerEngine::default();
//!
//! // Optimize an execution plan through all enabled phases:
//! // let optimized_plan = optimizer.optimize(plan, None)?;
//! ```

// Core modules
pub mod analysis;
pub mod builder;
pub mod context;
pub mod cost;
pub mod decision;
pub mod engine;
pub mod error;
pub mod factorization;
pub mod partitioning;
pub mod stats;

// Optimization phases
pub mod cost_based; // Cost-based optimization strategies
pub mod heuristic; // Heuristic rewrite rules

// Re-export the main types
pub use builder::OptimizerEngineBuilder;
pub use engine::OptimizerEngine;
pub use error::{CostError, CostResult, OptimizeError, OptimizeResult};
pub use partitioning::{PartitioningConfig, PartitioningDecision, PartitioningPlanner};

pub use stats::{
    CardinalityFeedbackManager, DecisionFeedbackStore, DecorrelationAdvice, EdgeTypeStatistics,
    FeedbackDrivenSelectivity, OperatorFeedback, PropertyStatistics, QueryExecutionFeedback,
    QueryFeedbackHistory, SelectivityFeedbackManager, StatisticsManager, TagStatistics,
};

pub use cost::{CostAssigner, CostCalculator, CostModelConfig, SelectivityEstimator};

// Reexport the analysis module type.
pub use analysis::{
    AggregatedExpressionAnalysis, AnalysisOptions, BatchPlanAnalysis, BatchPlanAnalyzer,
    ExpressionAnalysis, ReferenceCountAnalysis,
};

pub use context::OptimizationContext;

// Re-export cost_based types (formerly strategy)
pub use cost_based::{
    AggregateContext, AggregateSelectionReason, AggregateStrategy, AggregateStrategyDecision,
    AggregateStrategySelector, CandidateStart, DegreeInfo, DirectionContext,
    DirectionSelectionReason, IndexSelection, IndexSelector, JoinCondition, JoinOrderOptimizer,
    JoinOrderResult, KeepReason, OptimizationMethod, PredicateOperator, PropertyPredicate,
    SortContext, SortEliminationDecision, SortEliminationOptimizer, SortKeepReason,
    SubqueryUnnestingOptimizer, TableInfo, TopNConversionReason, TraversalDirection,
    TraversalDirectionDecision, TraversalDirectionOptimizer, TraversalSelectionReason,
    TraversalStartSelector, UnnestDecision, UnnestReason,
};

// Re-export the CTE cache types from the cache module.
pub use crate::cache::{
    CteCacheConfig, CteCacheDecision, CteCacheDecisionMaker, CteCacheEntry, CteCacheManager,
    CteCacheStats,
};

// Re-export heuristic types
pub use heuristic::{
    BaseRewriteRule, EliminationRule, HeuristicRule, HeuristicRuleAdapter, IntoOptRule,
    MatchedResult, MergeRule, NodeRewriter, PushDownRule, RewriteContext, RewriteError,
    RewriteRule, RuleWrapper, TransformResult,
};

pub use decision::{
    AccessPath, EntityIndexChoice, EntityType, IndexChoice, IndexSelectionDecision, JoinAlgorithm,
    JoinOrderDecision, OptimizationDecision, RewriteRuleId, TraversalStartDecision,
};