ValueProcessorOptions

Defined in: packages/react-querybuilder/src/types/importExport.ts:205

Options object for ValueProcessorByRule functions.

Extends

• FormatQueryOptions

Properties

concatOperator?

optional concatOperator: string & {} | "||" | "+" | "CONCAT"

Defined in: packages/react-querybuilder/src/types/importExport.ts:193

Operator to use when concatenating wildcard characters and field names in "sql" format. The ANSI standard is ||, while SQL Server uses +. MySQL does not implement a concatenation operator by default, and therefore requires use of the CONCAT function.

If concatOperator is set to "CONCAT" (case-insensitive), the CONCAT function will be used. Note that Oracle SQL does not support more than two values in the CONCAT function, so this option should not be used in that context. The default setting ("||") is already compatible with Oracle SQL.

Default

'||'

Inherited from

FormatQueryOptions.concatOperator

---

context?

optional context: Record<string, any>

Defined in: packages/react-querybuilder/src/types/importExport.ts:199

Inherited from

FormatQueryOptions.context

---

escapeQuotes?

optional escapeQuotes: boolean

Defined in: packages/react-querybuilder/src/types/importExport.ts:207

---

fallbackExpression?

optional fallbackExpression: string

Defined in: packages/react-querybuilder/src/types/importExport.ts:129

This string will be inserted in place of invalid groups for non-JSON formats. Defaults to '(1 = 1)' for "sql"/"parameterized"/"parameterized_named" and '$and:[{$expr:true}]' for "mongodb".

Inherited from

FormatQueryOptions.fallbackExpression

---

fieldData?

optional fieldData: FullField<Option, Option>

Defined in: packages/react-querybuilder/src/types/importExport.ts:212

The full field object, if fields was provided in the formatQuery options parameter.

---

fieldIdentifierSeparator?

optional fieldIdentifierSeparator: string

Defined in: packages/react-querybuilder/src/types/importExport.ts:95

When used in conjunction with the quoteFieldNamesWith option, field names will be split by this string, each part being individually processed as per the rules of the quoteFieldNamesWith configuration. The parts will then be re-joined by the same string.

A common value for this option is '.'.

A value of '' (the empty string) will disable splitting/rejoining.

Default

''

Example

formatQuery(query, {
  format: 'sql',
  quoteFieldNamesWith: ['[', ']'],
  fieldIdentifierSeparator: '.',
})
// "[dbo].[Musicians].[First name] = 'Steve'"

Inherited from

FormatQueryOptions.fieldIdentifierSeparator

---

fieldParamNames?

optional fieldParamNames: Record<string, string[]>

Defined in: packages/react-querybuilder/src/types/importExport.ts:219

Included for the "parameterized_named" format only. Keys of this object represent field names and values represent the current list of parameter names for that field based on the query rules processed up to that point. Use this list to ensure that parameter names generated by the custom rule processor are unique.

---

fields?

optional fields: FlexibleOptionList<FullField<Option, Option>>

Defined in: packages/react-querybuilder/src/types/importExport.ts:113

This can be the same FullField array passed to QueryBuilder, but really all you need to provide is the name and validator for each field.

The full field object from this array, where the field's identifying property matches the rule's field, will be passed to the rule processor.

Inherited from

FormatQueryOptions.fields

---

format?

optional format: ExportFormat

Defined in: packages/react-querybuilder/src/types/importExport.ts:43

The ExportFormat.

Inherited from

FormatQueryOptions.format

---

getNextNamedParam()?

optional getNextNamedParam: (field: string) => string

Defined in: packages/react-querybuilder/src/types/importExport.ts:224

Included for the "parameterized_named" format only. Call this function with a field name to get a unique parameter name, as yet unused during query processing.

Parameters

Parameter	Type
field	string

Returns

string

---

numberedParams?

optional numberedParams: boolean

Defined in: packages/react-querybuilder/src/types/importExport.ts:161

Renders parameter placeholders as a series of sequential numbers instead of '?' like the default. This option will respect the paramPrefix option like the 'parameterized_named' format.

Default

false

Inherited from

FormatQueryOptions.numberedParams

---

paramPrefix?

optional paramPrefix: string

Defined in: packages/react-querybuilder/src/types/importExport.ts:136

This string will be placed in front of named parameters (aka bind variables) when using the "parameterized_named" export format.

Default

":"

Inherited from

FormatQueryOptions.paramPrefix

---

paramsKeepPrefix?

optional paramsKeepPrefix: boolean

Defined in: packages/react-querybuilder/src/types/importExport.ts:153

Maintains the parameter prefix in the params object keys when using the "parameterized_named" export format. Recommended when using SQLite.

Default

false

Example

console.log(formatQuery(query, {
  format: "parameterized_named",
  paramPrefix: "$",
  paramsKeepPrefix: true
}).params)
// { $firstName: "Stev" }
// Default (`paramsKeepPrefix` is `false`):
// { firstName: "Stev" }

Inherited from

FormatQueryOptions.paramsKeepPrefix

---

parseNumbers?

optional parseNumbers: boolean

Defined in: packages/react-querybuilder/src/types/importExport.ts:168

Renders values as either number-types or unquoted strings, as appropriate and when possible. Each string-type value is evaluated against numericRegex to determine if it can be represented as a plain numeric value. If so, parseFloat is used to convert it to a number.

Inherited from

FormatQueryOptions.parseNumbers

---

placeholderFieldName?

optional placeholderFieldName: string

Defined in: packages/react-querybuilder/src/types/importExport.ts:174

Any rules where the field is equal to this value will be ignored.

Default

'~'

Inherited from

FormatQueryOptions.placeholderFieldName

---

placeholderOperatorName?

optional placeholderOperatorName: string

Defined in: packages/react-querybuilder/src/types/importExport.ts:180

Any rules where the operator is equal to this value will be ignored.

Default

'~'

Inherited from

FormatQueryOptions.placeholderOperatorName

---

preset?

optional preset: SQLPreset

Defined in: packages/react-querybuilder/src/types/importExport.ts:197

Option presets to maximize compatibility with various SQL dialects.

Inherited from

FormatQueryOptions.preset

---

quoteFieldNamesWith?

optional quoteFieldNamesWith: string | [string, string]

Defined in: packages/react-querybuilder/src/types/importExport.ts:74

In the "sql", "parameterized", "parameterized_named", and "jsonata" export formats, field names will be bracketed by this string. If an array of strings is passed, field names will be preceded by the first element and succeeded by the second element.

Tip: Use fieldIdentifierSeparator to bracket identifiers individually within field names.

Default

'' // the empty string

Examples

formatQuery(query, { format: 'sql', quoteFieldNamesWith: '"' })
// `"First name" = 'Steve'`

formatQuery(query, { format: 'sql', quoteFieldNamesWith: ['[', ']'] })
// "[First name] = 'Steve'"

Inherited from

FormatQueryOptions.quoteFieldNamesWith

---

quoteValuesWith?

optional quoteValuesWith: string

Defined in: packages/react-querybuilder/src/types/importExport.ts:100

Character to use for quoting string values in the SQL format.

Default

'

Inherited from

FormatQueryOptions.quoteValuesWith

---

ruleProcessor?

optional ruleProcessor: RuleProcessor

Defined in: packages/react-querybuilder/src/types/importExport.ts:55

This function will be used to process each rule for query language formats. If not defined, the appropriate defaultRuleProcessor* for the format will be used.

Inherited from

FormatQueryOptions.ruleProcessor

---

validator?

optional validator: QueryValidator

Defined in: packages/react-querybuilder/src/types/importExport.ts:105

Validator function for the entire query. Can be the same function passed as validator prop to QueryBuilder.

Inherited from

FormatQueryOptions.validator

---

valueProcessor?

optional valueProcessor: ValueProcessorByRule

Defined in: packages/react-querybuilder/src/types/importExport.ts:206

This function will be used to process the value from each rule for query language formats. If not defined, the appropriate defaultValueProcessor* for the format will be used.

Overrides

FormatQueryOptions.valueProcessor

---

wrapValueWith?

optional wrapValueWith: [string, string]

Defined in: packages/react-querybuilder/src/types/importExport.ts:230

Additional prefix and suffix characters to wrap the value in. Useful for augmenting the default value processor results with special syntax (e.g., for dates or function calls).

Methods

getOperators()?

optional getOperators(field: string, misc: { fieldData: FullField<Option, Option>; }): null | FlexibleOptionList<FullOperator>

Defined in: packages/react-querybuilder/src/types/importExport.ts:120

This can be the same getOperators function passed to QueryBuilder.

The full operator object from this array, where the operator's identifying property matches the rule's operator, will be passed to the rule processor.

Parameters

Parameter	Type
field	string
misc	{ fieldData: FullField<Option, Option>; }
misc.fieldData	FullField<Option, Option>

Returns

null | FlexibleOptionList<FullOperator>

Inherited from

FormatQueryOptions.getOperators

---

caution

API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.