Class ExplainPlanGenerator

Explain plan generator for different database dialects

Index

Constructors

Methods

setDefaultOptions explain analyzeQuery

Constructors

constructor

new ExplainPlanGenerator(
dialect: Dialect,
defaultOptions?: ExplainOptions,
): ExplainPlanGenerator
Parameters
- dialect: Dialect
- OptionaldefaultOptions: ExplainOptions
Returns ExplainPlanGenerator
- Defined in query-optimizers/explain-plans.ts:89

Methods

setDefaultOptions

setDefaultOptions(options: ExplainOptions): void
Set default options for EXPLAIN queries
Parameters
- options: ExplainOptions
Returns void
- Defined in query-optimizers/explain-plans.ts:102

explain

explain(sql: string, options?: ExplainOptions): Promise<ExplainPlan>
Generate an explain plan for a SQL query
Parameters
- sql: string
- Optionaloptions: ExplainOptions
Returns Promise<ExplainPlan>
- Defined in query-optimizers/explain-plans.ts:109

analyzeQuery

analyzeQuery(
sql: string,
options?: ExplainOptions,
): Promise<{ plan: ExplainPlan; recommendations: QueryRecommendation[] }>
Analyze a query and provide optimization recommendations
Parameters
- sql: string
- Optionaloptions: ExplainOptions
Returns Promise<{ plan: ExplainPlan; recommendations: QueryRecommendation[] }>
- Defined in query-optimizers/explain-plans.ts:378