formatQuery()
formatQuery(ruleGroup)
formatQuery(
ruleGroup):string
Generates a formatted (indented two spaces) JSON string from a query object.
Parameters
| Parameter | Type |
|---|---|
ruleGroup | RuleGroupTypeAny |
Returns
string
Defined in
packages/react-querybuilder/src/utils/formatQuery/formatQuery.ts:70
formatQuery(ruleGroup, options)
formatQuery(
ruleGroup,options):ParameterizedSQL
Generates a ParameterizedSQL object from a query object.
Parameters
| Parameter | Type |
|---|---|
ruleGroup | RuleGroupTypeAny |
options | "parameterized" | FormatQueryOptions & object |
Returns
Defined in
packages/react-querybuilder/src/utils/formatQuery/formatQuery.ts:74
formatQuery(ruleGroup, options)
formatQuery(
ruleGroup,options):ParameterizedNamedSQL
Generates a ParameterizedNamedSQL object from a query object.
Parameters
| Parameter | Type |
|---|---|
ruleGroup | RuleGroupTypeAny |
options | "parameterized_named" | FormatQueryOptions & object |
Returns
Defined in
packages/react-querybuilder/src/utils/formatQuery/formatQuery.ts:81
formatQuery(ruleGroup, options)
formatQuery(
ruleGroup,options):RQBJsonLogic
Generates a JsonLogic object from a query object.
Parameters
| Parameter | Type |
|---|---|
ruleGroup | RuleGroupTypeAny |
options | "jsonlogic" | FormatQueryOptions & object |
Returns
Defined in
packages/react-querybuilder/src/utils/formatQuery/formatQuery.ts:88
formatQuery(ruleGroup, options)
formatQuery(
ruleGroup,options):Record<string,any>
Generates an ElasticSearch query object from an RQB query object.
NOTE: Support for the ElasticSearch format is experimental. You may have better results exporting "sql" format then using ElasticSearch SQL.
Parameters
| Parameter | Type |
|---|---|
ruleGroup | RuleGroupTypeAny |
options | "elasticsearch" | FormatQueryOptions & object |
Returns
Record<string, any>
Defined in
packages/react-querybuilder/src/utils/formatQuery/formatQuery.ts:99
formatQuery(ruleGroup, options)
formatQuery(
ruleGroup,options):string
Generates a JSONata query string from an RQB query object.
NOTE: The parseNumbers option is recommended for this format.
Parameters
| Parameter | Type |
|---|---|
ruleGroup | RuleGroupTypeAny |
options | "jsonata" | FormatQueryOptions & object |
Returns
string
Defined in
packages/react-querybuilder/src/utils/formatQuery/formatQuery.ts:109
formatQuery(ruleGroup, options)
formatQuery(
ruleGroup,options):string
Generates a formatted (indented two spaces) JSON string from a query object.
Parameters
| Parameter | Type |
|---|---|
ruleGroup | RuleGroupTypeAny |
options | FormatQueryOptions |
Returns
string
Defined in
packages/react-querybuilder/src/utils/formatQuery/formatQuery.ts:116
formatQuery(ruleGroup, options)
formatQuery(
ruleGroup,options):string
Generates a query string in the requested format.
Parameters
| Parameter | Type |
|---|---|
ruleGroup | RuleGroupTypeAny |
options | "json" | "sql" | "json_without_ids" | "mongodb" | "cel" | "spel" | "natural_language" |
Returns
string
Defined in
packages/react-querybuilder/src/utils/formatQuery/formatQuery.ts:120
formatQuery(ruleGroup, options)
formatQuery(
ruleGroup,options):string
Generates a query string in the requested format.
Parameters
| Parameter | Type |
|---|---|
ruleGroup | RuleGroupTypeAny |
options | FormatQueryOptions & object |
Returns
string
Defined in
packages/react-querybuilder/src/utils/formatQuery/formatQuery.ts:130
API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.