Class QueryOptimizer

Main query optimizer class that combines all optimization features

Constructors

constructor

new QueryOptimizer(
dialect: Dialect,
options?: QueryOptimizationOptions,
): QueryOptimizer
Parameters
- dialect: Dialect
- Optionaloptions: QueryOptimizationOptions
Returns QueryOptimizer
- Defined in query-optimizers/query-optimizer.ts:64

Methods

getHintManager

getHintManager(): QueryHintManager | undefined
Get the query hint manager

Returns QueryHintManager | undefined
- Defined in query-optimizers/query-optimizer.ts:142

getExplainGenerator

getExplainGenerator(): ExplainPlanGenerator | undefined
Get the explain plan generator

Returns ExplainPlanGenerator | undefined
- Defined in query-optimizers/query-optimizer.ts:149

getSlowQueryLogger

getSlowQueryLogger(): SlowQueryLogger | undefined
Get the slow query logger

Returns SlowQueryLogger | undefined
- Defined in query-optimizers/query-optimizer.ts:156

getPreparedStatementCache

getPreparedStatementCache(): PreparedStatementCache | undefined
Get the prepared statement cache

Returns PreparedStatementCache | undefined
- Defined in query-optimizers/query-optimizer.ts:163

getQueryResultCache

getQueryResultCache(): QueryResultCache | undefined
Get the query result cache

Returns QueryResultCache | undefined
- Defined in query-optimizers/query-optimizer.ts:170

getBatchOptimizer

getBatchOptimizer(): BatchQueryOptimizer | undefined
Get the batch optimizer

Returns BatchQueryOptimizer | undefined
- Defined in query-optimizers/query-optimizer.ts:177

applyHints

applyHints(sql: string, hints: QueryHint[]): string
Apply query hints to a SQL statement
Parameters
- sql: string
- hints: QueryHint[]
Returns string
- Defined in query-optimizers/query-optimizer.ts:184

executeQuery

executeQuery(
    sql: string,
    options?: {
        params?: any[];
        useCache?: boolean;
        usePreparedStatement?: boolean;
        hint?: QueryHint[];
        skipSlowLog?: boolean;
    },
): Promise<{ result: any; fromCache: boolean; duration: number }>
Execute an optimized query with caching support
Parameters
- sql: string
- Optionaloptions: {
      params?: any[];
      useCache?: boolean;
      usePreparedStatement?: boolean;
      hint?: QueryHint[];
      skipSlowLog?: boolean;
  }
Returns Promise<{ result: any; fromCache: boolean; duration: number }>
- Defined in query-optimizers/query-optimizer.ts:194

explainQuery

explainQuery(sql: string, options?: ExplainOptions): Promise<ExplainPlan>
Explain a query
Parameters
- sql: string
- Optionaloptions: ExplainOptions
Returns Promise<ExplainPlan>
- Defined in query-optimizers/query-optimizer.ts:281

analyzeQuery

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

batchInsert

batchInsert(
    tableName: string,
    records: Record<string, any>[],
    options?: Partial<BatchOptions>,
): Promise<BatchResult<any>>
Perform batch insert with optimization
Parameters
- tableName: string
- records: Record<string, any>[]
- Optionaloptions: Partial<BatchOptions>
Returns Promise<BatchResult<any>>
- Defined in query-optimizers/query-optimizer.ts:301

batchUpdate

batchUpdate(
    tableName: string,
    records: Record<string, any>[],
    identifierColumn?: string,
    options?: Partial<BatchOptions>,
): Promise<BatchResult<any>>
Perform batch update with optimization
Parameters
- tableName: string
- records: Record<string, any>[]
- OptionalidentifierColumn: string
- Optionaloptions: Partial<BatchOptions>
Returns Promise<BatchResult<any>>
- Defined in query-optimizers/query-optimizer.ts:315

batchDelete

batchDelete(
    tableName: string,
    identifiers: any[],
    identifierColumn?: string,
    options?: Partial<BatchOptions>,
): Promise<BatchResult<any>>
Perform batch delete with optimization
Parameters
- tableName: string
- identifiers: any[]
- OptionalidentifierColumn: string
- Optionaloptions: Partial<BatchOptions>
Returns Promise<BatchResult<any>>
- Defined in query-optimizers/query-optimizer.ts:330

getStats

getStats(): {
    slowQuery: QueryStatistics
    | undefined;
    preparedStatementCache: CacheStats | undefined;
    queryResultCache:
        | { size: number; maxSize: number; hitCount: number }
        | undefined;
}
Get optimization statistics

Returns {
    slowQuery: QueryStatistics | undefined;
    preparedStatementCache: CacheStats | undefined;
    queryResultCache:
        | { size: number; maxSize: number; hitCount: number }
        | undefined;
}
- Defined in query-optimizers/query-optimizer.ts:350

clearCaches

clearCaches(): void
Clear all caches

Returns void
- Defined in query-optimizers/query-optimizer.ts:361

pruneCaches

pruneCaches(): void
Prune expired cache entries

Returns void
- Defined in query-optimizers/query-optimizer.ts:370

invalidateTableCache

invalidateTableCache(tableName: string): number
Invalidate query result cache for a specific table
Parameters
- tableName: string
Returns number
- Defined in query-optimizers/query-optimizer.ts:377

Class QueryOptimizer

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns QueryOptimizer

Methods

getHintManager

Returns QueryHintManager | undefined

getExplainGenerator

Returns ExplainPlanGenerator | undefined

getSlowQueryLogger

Returns SlowQueryLogger | undefined

getPreparedStatementCache

Returns PreparedStatementCache | undefined

getQueryResultCache

Returns QueryResultCache | undefined

getBatchOptimizer

Returns BatchQueryOptimizer | undefined

applyHints

Parameters

Returns string

executeQuery

Parameters

Returns Promise<{ result: any; fromCache: boolean; duration: number }>

explainQuery

Parameters

Returns Promise<ExplainPlan>

analyzeQuery

Parameters

Returns Promise<{ plan: ExplainPlan; recommendations: QueryRecommendation[] }>

batchInsert

Parameters

Returns Promise<BatchResult<any>>

batchUpdate

Parameters

Returns Promise<BatchResult<any>>

batchDelete

Parameters

Returns Promise<BatchResult<any>>

getStats

Returns { slowQuery: QueryStatistics | undefined; preparedStatementCache: CacheStats | undefined; queryResultCache: | { size: number; maxSize: number; hitCount: number } | undefined;}

clearCaches

Returns void

pruneCaches

Returns void

invalidateTableCache

Parameters

Returns number

Settings

On This Page

Returns {
slowQuery: QueryStatistics | undefined;
preparedStatementCache: CacheStats | undefined;
queryResultCache:
| { size: number; maxSize: number; hitCount: number }
| undefined;
}