Interface: FormatQueryOptions
react-querybuilder.FormatQueryOptions
Options object shape for formatQuery.
Hierarchy
-
FormatQueryOptions
Properties
fallbackExpression
Optional fallbackExpression: string
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".
Defined in
packages/react-querybuilder/src/types/importExport.ts:80
fields
Optional fields: FlexibleOptionList<FullField<string, string, string, Option<string>, Option<string>>>
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.
Defined in
packages/react-querybuilder/src/types/importExport.ts:74
format
Optional format: ExportFormat
The ExportFormat.
Defined in
packages/react-querybuilder/src/types/importExport.ts:31
numberedParams
Optional numberedParams: boolean
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
Defined in
packages/react-querybuilder/src/types/importExport.ts:112
paramPrefix
Optional paramPrefix: string
This string will be placed in front of named parameters (aka bind variables) when using the "parameterized_named" export format.
Default
":"
Defined in
packages/react-querybuilder/src/types/importExport.ts:87
paramsKeepPrefix
Optional paramsKeepPrefix: boolean
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" }
Defined in
packages/react-querybuilder/src/types/importExport.ts:104
parseNumbers
Optional parseNumbers: boolean
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.
Defined in
packages/react-querybuilder/src/types/importExport.ts:119
placeholderFieldName
Optional placeholderFieldName: string
Any rules where the field is equal to this value will be ignored.
Default
'~'
Defined in
packages/react-querybuilder/src/types/importExport.ts:125
placeholderOperatorName
Optional placeholderOperatorName: string
Any rules where the operator is equal to this value will be ignored.
Default
'~'
Defined in
packages/react-querybuilder/src/types/importExport.ts:131
quoteFieldNamesWith
Optional quoteFieldNamesWith: string | [string, string]
In the "sql"/"parameterized"/"parameterized_named" 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. A common value for this option is
the backtick ('`').
Default
'' // the empty string
Example
formatQuery(query, { format: 'sql', quoteFieldNamesWith: '`' })
// "`First name` = 'Steve'"
Example
formatQuery(query, { format: 'sql', quoteFieldNamesWith: ['[', ']'] })
// "[First name] = 'Steve'"
Defined in
packages/react-querybuilder/src/types/importExport.ts:61
ruleProcessor
Optional ruleProcessor: RuleProcessor
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.
Defined in
packages/react-querybuilder/src/types/importExport.ts:43
validator
Optional validator: QueryValidator
Validator function for the entire query. Can be the same function passed
as validator prop to QueryBuilder.
Defined in
packages/react-querybuilder/src/types/importExport.ts:66
valueProcessor
Optional valueProcessor: ValueProcessorLegacy | ValueProcessorByRule
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.