Skip to content
# Interface: QueryBuildOptions

Defined in: packages/core/src/transformers/DynamicQueryBuilder.ts:107

Options for dynamic query building

Properties ​

filter? ​

optional filter: FilterConditions

Defined in: packages/core/src/transformers/DynamicQueryBuilder.ts:112

Legacy filter input for named-parameter binding only. Dynamic predicate injection is no longer supported and will fail fast.


sort? ​

optional sort: SortConditions

Defined in: packages/core/src/transformers/DynamicQueryBuilder.ts:114

Sort conditions to inject into ORDER BY clause


paging? ​

optional paging: PaginationOptions

Defined in: packages/core/src/transformers/DynamicQueryBuilder.ts:116

Pagination options to inject LIMIT/OFFSET clauses


includeColumns? ​

optional includeColumns: string[]

Defined in: packages/core/src/transformers/DynamicQueryBuilder.ts:121

Columns that should remain in the SELECT clause. When specified, every other column is removed so the output matches this whitelist.


excludeColumns? ​

optional excludeColumns: string[]

Defined in: packages/core/src/transformers/DynamicQueryBuilder.ts:126

Columns that should be removed from the SELECT clause. Filters apply subtractively and only drop columns that exist in the original output.


existsStrict? ​

optional existsStrict: boolean

Defined in: packages/core/src/transformers/DynamicQueryBuilder.ts:131

Throw when column-anchored EXISTS filters fail to resolve. Defaults to false so invalid definitions are skipped silently.


schemaInfo? ​

optional schemaInfo: SchemaInfo

Defined in: packages/core/src/transformers/DynamicQueryBuilder.ts:135

Schema metadata used when removing unused LEFT JOINs; overrides builder defaults.


removeUnusedLeftJoins? ​

optional removeUnusedLeftJoins: boolean

Defined in: packages/core/src/transformers/DynamicQueryBuilder.ts:139

Remove unused LEFT JOINs before further processing when schema info is available.


removeUnusedCtes? ​

optional removeUnusedCtes: boolean

Defined in: packages/core/src/transformers/DynamicQueryBuilder.ts:144

Remove unused Common Table Expressions (CTEs) when they can be safely pruned. Defaults to false to preserve original WITH definitions.


optionalConditionParameters? ​

optional optionalConditionParameters: OptionalConditionPruningParameters

Defined in: packages/core/src/transformers/DynamicQueryBuilder.ts:149

Explicit opt-in values for truthful optional condition branches in source SQL. Only listed parameter names are eligible for pruning, and null/undefined are treated as absent-equivalent.


optionalConditionParameterStates? ​

optional optionalConditionParameterStates: OptionalConditionParameterStates

Defined in: packages/core/src/transformers/DynamicQueryBuilder.ts:154

Legacy state-map form for optional branch pruning. Prefer optionalConditionParameters for new code so SQL-facing null semantics stay intuitive.

Released under the MIT License.