Class QueryParameterProcessor

Index

Constructors

Methods

processQueryTemplate ProcessQueryTemplate validateParameters ValidateParameters

Constructors

constructor

new QueryParameterProcessor(): QueryParameterProcessor
Returns QueryParameterProcessor

Methods

`Static`processQueryTemplate

processQueryTemplate(
    query: QueryTemplateInput,
    parameters: Record<string, unknown> | undefined,
    sqlOverride?: string,
    forceTemplateProcessing?: boolean,
): QueryProcessingResult
Parameters
- query: QueryTemplateInput
- parameters: Record<string, unknown> | undefined
- OptionalsqlOverride: string
- OptionalforceTemplateProcessing: boolean
Returns QueryProcessingResult
Deprecated
Use ProcessQueryTemplate.
- Defined in queryParameterProcessor.ts:499

`Static`ProcessQueryTemplate

ProcessQueryTemplate(
    query: QueryTemplateInput,
    parameters: Record<string, unknown> | undefined,
    sqlOverride?: string,
    forceTemplateProcessing?: boolean,
): QueryProcessingResult
Processes a query template with the provided parameters. Accepts either a full QueryInfo (saved queries) or a minimal QueryTemplateInput (transient specs) — only SQL, UsesTemplate, and Parameters are used.
Parameters
- query: QueryTemplateInput
  The query info or template input containing SQL and parameter definitions
- parameters: Record<string, unknown> | undefined
  User-provided parameter values
- OptionalsqlOverride: string
  Optional SQL to use instead of query.SQL (e.g., platform-resolved SQL)
- OptionalforceTemplateProcessing: boolean
  When true, processes Nunjucks templates even if the query's own UsesTemplate is false. Used for transitive template resolution when a composed dependency uses templates but the outer query does not.
Returns QueryProcessingResult
- Defined in queryParameterProcessor.ts:424

`Static`validateParameters

validateParameters(
    parameters: Record<string, unknown> | undefined,
    parameterDefinitions: MJQueryParameterEntity[],
    skipUnknownParameterCheck?: boolean,
): ParameterValidationResult
Parameters
- parameters: Record<string, unknown> | undefined
- parameterDefinitions: MJQueryParameterEntity[]
- OptionalskipUnknownParameterCheck: boolean
Returns ParameterValidationResult
Deprecated
Use ValidateParameters.
- Defined in queryParameterProcessor.ts:405

`Static`ValidateParameters

ValidateParameters(
    parameters: Record<string, unknown> | undefined,
    parameterDefinitions: MJQueryParameterEntity[],
    skipUnknownParameterCheck?: boolean,
): ParameterValidationResult
Validates parameters against their definitions. Boolean values are bound the way the current platform's dialect expects (BooleanParameterValue): 1/0 on SQL Server, true/false on PostgreSQL.
Parameters
- parameters: Record<string, unknown> | undefined
- parameterDefinitions: MJQueryParameterEntity[]
- OptionalskipUnknownParameterCheck: boolean
Returns ParameterValidationResult
- Defined in queryParameterProcessor.ts:282