# Interface: QueryBuildOptions

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

Options for dynamic query building

Properties

filter?

optional filter: FilterConditions

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

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:115

Sort conditions to inject into ORDER BY clause

---

paging?

optional paging: PaginationOptions

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

Pagination options to inject LIMIT/OFFSET clauses

---

includeColumns?

optional includeColumns: string[]

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

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:127

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

---

serialize?

optional serialize: boolean | JsonMapping

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

JSON serialization mapping to transform results into hierarchical JSON

• JsonMapping object: explicit mapping configuration
• true: auto-load mapping from corresponding .json file
• false/undefined: no serialization

---

jsonb?

optional jsonb: boolean

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

JSONB usage setting. Must be true (default) for PostgreSQL GROUP BY compatibility. Setting to false will throw an error as JSON type cannot be used in GROUP BY clauses.

Default

true

---

existsStrict?

optional existsStrict: boolean

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

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:148

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

---

removeUnusedLeftJoins?

optional removeUnusedLeftJoins: boolean

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

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

---

removeUnusedCtes?

optional removeUnusedCtes: boolean

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

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:162

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:167

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