Skip to main content

parseSQL

Converts a SQL SELECT statement or WHERE clause into a DefaultRuleGroupType or DefaultRuleGroupTypeIC.

Functions

FunctionDescription
evalSQLLiteralValue-
getFieldName-
isSQLBitExpression-
isSQLExpressionOperandAn operand that is neither a bare identifier nor a (signed) literal nor a placeholder.
isSQLFunctionCall-
isSQLIdentifier-
isSQLLiteralOrSignedNumberValue-
isSQLLiteralValue-
isSQLPlaceHolder-
isSQLSignedNumber-
normalizeOperator-
parseSQLConverts a SQL SELECT statement into a query suitable for the index!QueryBuilder QueryBuilder component's query or defaultQuery props (DefaultRuleGroupType).

Interfaces

InterfaceDescription
ParsedSQL-
ParseSQLExpressionContextContext passed to a ParseSQLOptions.getExpression handler alongside the operand node. Carries the same number-parsing option as the rest of parseSQL plus a predicate for validating that field leaves inside an expression exist in the configured fields.
ParseSQLOptionsOptions object for parseSQL.
SQLAndExpression-
SQLBetweenPredicate-
SQLBitExpression-
SQLBooleanExtra-
SQLBooleanValue-
SQLCaseWhen-
SQLComparisonBooleanPrimary-
SQLComparisonSubQueryBooleanPrimary-
SQLContainsExpr-
SQLEndsWithExpr-
SQLExpressionList-
SQLFunctionCall-
SQLIdentifier-
SQLIdentifierExpr-
SQLInExpressionListPredicate-
SQLInSubQueryPredicate-
SQLIsExpression-
SQLIsNullBooleanPrimary-
SQLLikePredicate-
SQLNotExpression-
SQLNumberValue-
SQLOrExpression-
SQLPlaceHolder-
SQLPrefix-
SQLRegexpPredicate-
SQLSignedNumberValue-
SQLSimpleExprParentheses-
SQLSoundsLikePredicate-
SQLStartsWithExpr-
SQLStringValue-
SQLSubQuery-
SQLWhereObject-
SQLWhereObjectAny-
SQLXorExpression-

Type Aliases

Type AliasDescription
AndOperator-
ComparisonOperator-
MixedAndXorOrList-
NotOpt-
OrOperator-
SQLBooleanPrimary-
SQLExpression-
SQLExpressionOperandA SQL operand subtree that a ParseSQLOptions.getExpression handler may receive: a bare identifier, a (signed) literal, a placeholder, an arithmetic SQLBitExpression, a SQLFunctionCall, or a parenthesized wrapper (unwrapped by the handler).
SQLLiteralValue-
SQLPredicate-
SQLSimpleExpression-
XorOperator-

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.