formatQuery()

Call Signature

formatQuery(ruleGroup: RuleGroupTypeAny): string

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:236

Generates a formatted (indented two spaces) JSON string from a query object.

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny

Returns

string

Call Signature

formatQuery<TResult>(ruleGroup: RuleGroupTypeAny, options: FormatQueryOptions & { ruleGroupProcessor: RuleGroupProcessor<TResult>; }): TResult

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:242

Generates a result based on the provided rule group processor.

Type Parameters

Type Parameter	Default type
TResult	unknown

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny
options	FormatQueryOptions & { ruleGroupProcessor: RuleGroupProcessor<TResult>; }

Returns

TResult

Call Signature

formatQuery(ruleGroup: RuleGroupTypeAny, options: "parameterized" | FormatQueryOptions & { format: "parameterized"; }): ParameterizedSQL

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:251

Generates a index!ParameterizedSQL ParameterizedSQL object from a query object.

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny
options	"parameterized" | FormatQueryOptions & { format: "parameterized"; }

Returns

ParameterizedSQL

Call Signature

formatQuery(ruleGroup: RuleGroupTypeAny, options: "parameterized_named" | FormatQueryOptions & { format: "parameterized_named"; }): ParameterizedNamedSQL

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:260

Generates a index!ParameterizedNamedSQL ParameterizedNamedSQL object from a query object.

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny
options	"parameterized_named" | FormatQueryOptions & { format: "parameterized_named"; }

Returns

ParameterizedNamedSQL

Call Signature

formatQuery(ruleGroup: RuleGroupTypeAny, options: "jsonlogic" | FormatQueryOptions & { format: "jsonlogic"; }): RQBJsonLogic

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:269

Generates a index!RQBJsonLogic JsonLogic object from a query object.

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny
options	"jsonlogic" | FormatQueryOptions & { format: "jsonlogic"; }

Returns

RQBJsonLogic

Call Signature

formatQuery(ruleGroup: RuleGroupTypeAny, options: "elasticsearch" | FormatQueryOptions & { format: "elasticsearch"; }): Record<string, any>

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:282

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 & { format: "elasticsearch"; }

Returns

Record<string, any>

Call Signature

formatQuery(ruleGroup: RuleGroupTypeAny, options: "mongodb_query" | FormatQueryOptions & { format: "mongodb_query"; }): Record<string, any>

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:295

Generates a MongoDB query object from an RQB query object.

This is equivalent to the "mongodb" format, but returns a JSON object instead of a string.

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny
options	"mongodb_query" | FormatQueryOptions & { format: "mongodb_query"; }

Returns

Record<string, any>

Call Signature

formatQuery(ruleGroup: RuleGroupTypeAny, options: "mongodb" | FormatQueryOptions & { format: "mongodb"; }): string

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:310

Generates a JSON.stringify'd MongoDB query object from an RQB query object.

This is equivalent to the "mongodb_query" format, but returns a string instead of a JSON object.

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny
options	"mongodb" | FormatQueryOptions & { format: "mongodb"; }

Returns

string

Deprecated

Use the "mongodb_query" format for greater flexibility.

Call Signature

formatQuery(ruleGroup: RuleGroupTypeAny, options: "prisma" | FormatQueryOptions & { format: "prisma"; }): Record<string, any>

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:319

Generates a Prisma ORM query object from an RQB query object.

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny
options	"prisma" | FormatQueryOptions & { format: "prisma"; }

Returns

Record<string, any>

Call Signature

formatQuery(ruleGroup: RuleGroupTypeAny, options: "drizzle" | FormatQueryOptions & { format: "drizzle"; }): (columns: Record<string, Column<ColumnBaseConfig<ColumnDataType, string>, object, object>> | Table<TableConfig<Column<any, object, object>>>, drizzleOperators: { and: (...conditions: (SQLWrapper | undefined)[]) => SQL<unknown> | undefined; between: {<T>(column: Aliased, min: SQLWrapper | T, max: SQLWrapper | T): SQL; <TColumn>(column: TColumn, min: SQLWrapper | TColumn["_"]["data"], max: SQLWrapper | TColumn["_"]["data"]): SQL; <T>(column: Exclude<T, Column<ColumnBaseConfig<ColumnDataType, string>, object, object> | Aliased<unknown>>, min: unknown, max: unknown): SQL; }; eq: BinaryOperator; exists: (subquery: SQLWrapper) => SQL; gt: BinaryOperator; gte: BinaryOperator; ilike: (column: SQL<unknown> | Column<ColumnBaseConfig<ColumnDataType, string>, object, object> | Aliased<unknown>, value: string | SQLWrapper) => SQL; inArray: {<T>(column: Aliased<T>, values: SQLWrapper | (Placeholder<string, any> | T)[]): SQL; <TColumn>(column: TColumn, values: SQLWrapper | readonly (Placeholder<string, any> | TColumn["_"]["data"])[]): SQL; <T>(column: Exclude<T, Column<ColumnBaseConfig<ColumnDataType, string>, object, object> | Aliased<unknown>>, values: readonly unknown[] | SQLWrapper): SQL; }; isNotNull: (value: SQLWrapper) => SQL; isNull: (value: SQLWrapper) => SQL; like: (column: SQL<unknown> | Column<ColumnBaseConfig<ColumnDataType, string>, object, object> | Aliased<unknown>, value: string | SQLWrapper) => SQL; lt: BinaryOperator; lte: BinaryOperator; ne: BinaryOperator; not: (condition: SQLWrapper) => SQL; notBetween: {<T>(column: Aliased, min: SQLWrapper | T, max: SQLWrapper | T): SQL; <TColumn>(column: TColumn, min: SQLWrapper | TColumn["_"]["data"], max: SQLWrapper | TColumn["_"]["data"]): SQL; <T>(column: Exclude<T, Column<ColumnBaseConfig<ColumnDataType, string>, object, object> | Aliased<unknown>>, min: unknown, max: unknown): SQL; }; notExists: (subquery: SQLWrapper) => SQL; notIlike: (column: SQL<unknown> | Column<ColumnBaseConfig<ColumnDataType, string>, object, object> | Aliased<unknown>, value: string | SQLWrapper) => SQL; notInArray: {<T>(column: Aliased<T>, values: SQLWrapper | (T | Placeholder<string, any>)[]): SQL; <TColumn>(column: TColumn, values: SQLWrapper | (Placeholder<string, any> | TColumn["_"]["data"])[]): SQL; <T>(column: Exclude<T, Column<ColumnBaseConfig<ColumnDataType, string>, object, object> | Aliased<unknown>>, values: unknown[] | SQLWrapper): SQL; }; notLike: (column: SQL<unknown> | Column<ColumnBaseConfig<ColumnDataType, string>, object, object> | Aliased<unknown>, value: string | SQLWrapper) => SQL; or: (...conditions: (SQLWrapper | undefined)[]) => SQL<unknown> | undefined; sql: typeof sql; }) => SQL<unknown> | undefined

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:330

Generates a Drizzle ORM query function from an RQB query object. The function can be assigned to the where property in the Drizzle relational queries API.

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny
options	"drizzle" | FormatQueryOptions & { format: "drizzle"; }

Returns

(columns: Record<string, Column<ColumnBaseConfig<ColumnDataType, string>, object, object>> | Table<TableConfig<Column<any, object, object>>>, drizzleOperators: { and: (...conditions: (SQLWrapper | undefined)[]) => SQL<unknown> | undefined; between: {<T>(column: Aliased, min: SQLWrapper | T, max: SQLWrapper | T): SQL; <TColumn>(column: TColumn, min: SQLWrapper | TColumn["_"]["data"], max: SQLWrapper | TColumn["_"]["data"]): SQL; <T>(column: Exclude<T, Column<ColumnBaseConfig<ColumnDataType, string>, object, object> | Aliased<unknown>>, min: unknown, max: unknown): SQL; }; eq: BinaryOperator; exists: (subquery: SQLWrapper) => SQL; gt: BinaryOperator; gte: BinaryOperator; ilike: (column: SQL<unknown> | Column<ColumnBaseConfig<ColumnDataType, string>, object, object> | Aliased<unknown>, value: string | SQLWrapper) => SQL; inArray: {<T>(column: Aliased<T>, values: SQLWrapper | (Placeholder<string, any> | T)[]): SQL; <TColumn>(column: TColumn, values: SQLWrapper | readonly (Placeholder<string, any> | TColumn["_"]["data"])[]): SQL; <T>(column: Exclude<T, Column<ColumnBaseConfig<ColumnDataType, string>, object, object> | Aliased<unknown>>, values: readonly unknown[] | SQLWrapper): SQL; }; isNotNull: (value: SQLWrapper) => SQL; isNull: (value: SQLWrapper) => SQL; like: (column: SQL<unknown> | Column<ColumnBaseConfig<ColumnDataType, string>, object, object> | Aliased<unknown>, value: string | SQLWrapper) => SQL; lt: BinaryOperator; lte: BinaryOperator; ne: BinaryOperator; not: (condition: SQLWrapper) => SQL; notBetween: {<T>(column: Aliased, min: SQLWrapper | T, max: SQLWrapper | T): SQL; <TColumn>(column: TColumn, min: SQLWrapper | TColumn["_"]["data"], max: SQLWrapper | TColumn["_"]["data"]): SQL; <T>(column: Exclude<T, Column<ColumnBaseConfig<ColumnDataType, string>, object, object> | Aliased<unknown>>, min: unknown, max: unknown): SQL; }; notExists: (subquery: SQLWrapper) => SQL; notIlike: (column: SQL<unknown> | Column<ColumnBaseConfig<ColumnDataType, string>, object, object> | Aliased<unknown>, value: string | SQLWrapper) => SQL; notInArray: {<T>(column: Aliased<T>, values: SQLWrapper | (T | Placeholder<string, any>)[]): SQL; <TColumn>(column: TColumn, values: SQLWrapper | (Placeholder<string, any> | TColumn["_"]["data"])[]): SQL; <T>(column: Exclude<T, Column<ColumnBaseConfig<ColumnDataType, string>, object, object> | Aliased<unknown>>, values: unknown[] | SQLWrapper): SQL; }; notLike: (column: SQL<unknown> | Column<ColumnBaseConfig<ColumnDataType, string>, object, object> | Aliased<unknown>, value: string | SQLWrapper) => SQL; or: (...conditions: (SQLWrapper | undefined)[]) => SQL<unknown> | undefined; sql: typeof sql; }) => SQL<unknown> | undefined

Call Signature

formatQuery(ruleGroup: RuleGroupTypeAny, options: "sequelize" | FormatQueryOptions & { format: "sequelize"; }): WhereOptions | undefined

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:340

Generates a Sequelize query object from an RQB query object. The object can be assigned to the where property in the Sequelize query functions.

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny
options	"sequelize" | FormatQueryOptions & { format: "sequelize"; }

Returns

WhereOptions | undefined

Call Signature

formatQuery(ruleGroup: RuleGroupTypeAny, options: "jsonata" | FormatQueryOptions & { format: "jsonata"; }): string

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:352

Generates a JSONata query string from an RQB query object.

NOTE: Either parseNumbers: "strict-limited" or parseNumbers: true are recommended for this format.

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny
options	"jsonata" | FormatQueryOptions & { format: "jsonata"; }

Returns

string

Call Signature

formatQuery(ruleGroup: RuleGroupTypeAny, options: "ldap" | FormatQueryOptions & { format: "ldap"; }): string

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:361

Generates an LDAP query string from an RQB query object.

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny
options	"ldap" | FormatQueryOptions & { format: "ldap"; }

Returns

string

Call Signature

formatQuery(ruleGroup: RuleGroupTypeAny, options: "diagnostics" | FormatQueryOptions & { format: "diagnostics"; }): DiagnosticsResult

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:371

Generates a DiagnosticsResult from a query object, containing an annotated query tree, a flat diagnostics array, aggregate stats, and a per-field summary.

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny
options	"diagnostics" | FormatQueryOptions & { format: "diagnostics"; }

Returns

DiagnosticsResult

Call Signature

formatQuery(ruleGroup: RuleGroupTypeAny, options: FormatQueryOptions): string

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:380

Generates a formatted (indented two spaces) JSON string from a query object.

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny
options	FormatQueryOptions

Returns

string

Call Signature

formatQuery(ruleGroup: RuleGroupTypeAny, options: "sequelize" | "json" | "sql" | "json_without_ids" | "mongodb" | "cel" | "spel" | "natural_language" | "ldap" | "drizzle" | "prisma" | "cypher" | "gql" | "sparql" | "gremlin"): string

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:386

Generates a query string in the requested format.

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny
options	"sequelize" | "json" | "sql" | "json_without_ids" | "mongodb" | "cel" | "spel" | "natural_language" | "ldap" | "drizzle" | "prisma" | "cypher" | "gql" | "sparql" | "gremlin"

Returns

string

Call Signature

formatQuery(ruleGroup: RuleGroupTypeAny, options: FormatQueryOptions & { format: "sequelize" | "json" | "sql" | "json_without_ids" | "mongodb" | "cel" | "spel" | "natural_language" | "ldap" | "drizzle" | "prisma" | "cypher" | "gql" | "sparql" | "gremlin"; }): string

Defined in: packages/core/src/utils/formatQuery/formatQuery.ts:395

Generates a query string in the requested format.

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny
options	FormatQueryOptions & { format: "sequelize" | "json" | "sql" | "json_without_ids" | "mongodb" | "cel" | "spel" | "natural_language" | "ldap" | "drizzle" | "prisma" | "cypher" | "gql" | "sparql" | "gremlin"; }

Returns

string

---

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.