Class QueryHintManager

Query hint manager for applying hints to SQL queries

Index

Constructors

Methods

setEnabled isEnabled applyHints forceIndex useIndex ignoreIndex maxExecutionTime sqlBigResult sqlSmallResult sqlNoCache

Constructors

constructor

new QueryHintManager(
dialect: Dialect,
options?: { enabled?: boolean },
): QueryHintManager
Parameters
- dialect: Dialect
- Optionaloptions: { enabled?: boolean }
Returns QueryHintManager
- Defined in query-optimizers/query-hints.ts:116

Methods

setEnabled

setEnabled(enabled: boolean): void
Enable or disable query hints
Parameters
- enabled: boolean
Returns void
- Defined in query-optimizers/query-hints.ts:124

isEnabled

isEnabled(): boolean
Check if hints are enabled

Returns boolean
- Defined in query-optimizers/query-hints.ts:131

applyHints

applyHints(sql: string, hints: QueryHint[]): string
Apply query hints to a SQL query
Parameters
- sql: string
  The base SQL query
- hints: QueryHint[]
  Array of query hints to apply
Returns string
SQL with hints applied
- Defined in query-optimizers/query-hints.ts:141

forceIndex

forceIndex(indexName: string, tableName?: string): QueryHint
Create a hint for forcing index usage
Parameters
- indexName: string
- OptionaltableName: string
Returns QueryHint
- Defined in query-optimizers/query-hints.ts:423

useIndex

useIndex(indexName: string | string[], tableName?: string): QueryHint
Create a hint for suggesting index usage
Parameters
- indexName: string | string[]
- OptionaltableName: string
Returns QueryHint
- Defined in query-optimizers/query-hints.ts:430

ignoreIndex

ignoreIndex(indexName: string | string[], tableName?: string): QueryHint
Create a hint for ignoring certain indexes
Parameters
- indexName: string | string[]
- OptionaltableName: string
Returns QueryHint
- Defined in query-optimizers/query-hints.ts:437

maxExecutionTime

maxExecutionTime(seconds: number): QueryHint
Create a hint for maximum execution time
Parameters
- seconds: number
Returns QueryHint
- Defined in query-optimizers/query-hints.ts:444

sqlBigResult

sqlBigResult(): QueryHint
Create a hint for SQL_BIG_RESULT

Returns QueryHint
- Defined in query-optimizers/query-hints.ts:451

sqlSmallResult

sqlSmallResult(): QueryHint
Create a hint for SQL_SMALL_RESULT

Returns QueryHint
- Defined in query-optimizers/query-hints.ts:458

sqlNoCache

sqlNoCache(): QueryHint
Create a hint for SQL_NO_CACHE

Returns QueryHint
- Defined in query-optimizers/query-hints.ts:465