Description
This library allows parsing and composing SOQL queries from Salesforce using JavaScript or Typescript.
Available Features:
- Parse SOQL queries into a common
Query
data structure. - Compose a
Query
data structure back into a SOQL query. - Validate a query to check if the syntax is valid. (Note: even if a query is returned as valid, it might still be invalid based on your Salesforce configuration)
This library uses Chevrotain to parse queries. Prior to version 2.0.0, antlr4 was used. The move to Chevrotain provided a significant performance increase and decrease in bundle size. :tada:
Migrating from version 1 to version 2? Check out the changelog for a full list of changes.
Want to try it out? Check out the demo.
Quick Start
import { parseQuery, composeQuery, isQueryValid } from 'soql-parser-js';
const query = parseQuery(`SELECT Id FROM Account WHERE Id = 'FOO'`);
console.log('query', query);
const soql = composeQuery(query);
console.log('soql', soql);
isQueryValid('SELECT Id, Foo FROM Baz');
isQueryValid('SELECT Id Foo FROM Baz');
Available Features
Function | Description | Arguments |
---|
parseQuery | Parse a SOQL query string into a Query data structure. | soql: Query config?: ParseQueryConfig |
isQueryValid | Returns true if the query was able to be parsed. | soql: Query config?: ParseQueryConfig |
composeQuery | Turn a Query object back into a SOQL statement. | soql: Query config?: SoqlComposeConfig |
formatQuery | Format a SOQL query string. | soql: Query config?: FormatOptions |
Utility Functions
Function | Description | Arguments |
---|
getField | Convenience method to construct fields in the correct format when using composeQuery() . Look in the data models section below for the structure of ComposeFieldInput . | input: `string |
isSubquery | Returns true if the data passed in is a subquery. | query: `Query |
isFieldSubquery | Returns true if the data passed in is a FieldSubquery. | value: any |
getFlattenedFields | Flatten a Salesforce record based on the parsed SOQL Query. | soql: `Query |
ParseQueryConfig
Property | Type | Description | required | default |
---|
allowApexBindVariables | boolean | Determines if apex variables are allowed in parsed query. Example: WHERE Id IN :accountIds . | FALSE | FALSE |
logErrors | boolean | If true, then additional detail will be logged to the console if there is a lexing or parsing error. | FALSE | FALSE |
SoqlComposeConfig
Property | Type | Description | required | default |
---|
format | boolean | Apply formatting the the composed query. This will result in a multi-line soql statement. | FALSE | TRUE |
formatOptions | FormatOptions | Options to apply to the formatter. | FALSE | |
autoCompose | boolean | If you need to compose just part of a query, you can create your own instance of the Compose class and set this to false, then call any methods that you need to just for what you would like to turn into a SOQL query. | FALSE | TRUE |
logging | boolean | Print out logging statements to the console about the format operation. | FALSE | FALSE |
FormatOptions
Property | Type | Description | required | default |
---|
numIndent | number | The number of tab characters to indent. | FALSE | 1 |
fieldMaxLineLength | number | The number of characters that the fields should take up before making a new line. Set this to 1 to have every field on its own line. | FALSE | 60 |
fieldSubqueryParensOnOwnLine | boolean | If true, the opening and closing parentheses will be on their own line for subqueries. | FALSE | TRUE |
whereClauseOperatorsIndented | boolean | If true, indents the where clause operators. | FALSE | FALSE |
logging | boolean | Print out logging statements to the console about the format operation. | FALSE | FALSE |
Examples
Parsing Queries
Parsing a SOQL query can be completed by calling parseQuery(soqlQueryString)
. A Query
data structure will be returned.
import { parseQuery } from 'soql-parser-js';
const soql = `
SELECT UserId, COUNT(Id)
FROM LoginHistory
WHERE LoginTime > 2010-09-20T22:16:30.000Z
AND LoginTime < 2010-09-21T22:16:30.000Z
GROUP BY UserId
`;
const soqlQuery = parseQuery(soql);
console.log(JSON.stringify(soqlQuery, null, 2));
Results (click to show)
{
"fields": [
{
"type": "Field",
"field": "UserId"
},
{
"type": "FieldFunctionExpression",
"functionName": "COUNT",
"parameters": ["Id"],
"isAggregateFn": true,
"rawValue": "COUNT(Id)"
}
],
"sObject": "LoginHistory",
"where": {
"left": {
"field": "LoginTime",
"operator": ">",
"value": "2010-09-20T22:16:30.000Z",
"literalType": "DATETIME"
},
"operator": "AND",
"right": {
"left": {
"field": "LoginTime",
"operator": "<",
"value": "2010-09-21T22:16:30.000Z",
"literalType": "DATETIME"
}
}
},
"groupBy": {
"field": "UserId"
}
}
Validating Queries
import { isQueryValid } from 'soql-parser-js';
const invalidSoql = `SELECT UserId, COUNT(Id) Account`;
const validSoql = `SELECT UserId, COUNT(Id) Account`;
console.log(isQueryValid(soql));
console.log(isQueryValid(soql));
Composing Queries
Build a Query
data structure to have it converted back into a SOQL query.
Composing a query will turn a Query object back to a SOQL query string. The exact same data structure returned from parseQuery()
can be used,
but depending on your use-case, you may need to build your own data structure to compose a query.
These examples show building your own Query object with the minimum required fields.
Some utility methods have been provided to make it easier to build the field data structures.
Note: Some operators may be converted to uppercase (e.x. NOT, AND)
Note: There are a number of fields populated on the Query object when parseQuery()
is called that are not required to compose a query. Look at the examples below and the comments in the data model for more information.
import { composeQuery, getField, Query } from 'soql-parser-js';
const oppLineItemsSubquery = {
fields: [
getField('Quantity'),
getField('ListPrice'),
getField({
field: 'UnitPrice',
relationships: ['PricebookEntry'],
}),
getField({
field: 'Name',
relationships: ['PricebookEntry'],
}),
],
relationshipName: 'OpportunityLineItems',
};
const soqlQuery: Query = {
fields: [
getField('Id'),
getField('Name'),
getField({
functionName: 'FORMAT',
parameters: 'Amount',
alias: 'MyFormattedAmount',
}),
getField({ subquery: oppLineItemsSubquery }),
],
sObject: 'Opportunity',
where: {
left: {
field: 'CreatedDate',
operator: '>',
value: 'LAST_N_YEARS:1',
},
operator: 'AND',
right: {
left: {
field: 'StageName',
operator: '=',
value: 'Closed Won',
literalType: 'STRING',
},
},
},
limit: 150,
};
const composedQuery = composeQuery(soqlQuery, { format: true });
console.log(composedQuery);
Results
SELECT Id, Name, FORMAT(Amount) MyFormattedAmount,
(
SELECT Quantity, ListPrice, PricebookEntry.UnitPrice,
PricebookEntry.Name
FROM OpportunityLineItems
)
FROM Opportunity
WHERE CreatedDate > LAST_N_YEARS:1
AND StageName = 'Closed Won'
LIMIT 150
Composing a partial query
If you need to compose just a part of a query instead of the entire query, you can create an instance of the Compose class directly.
For example, if you just need the "WHERE" clause from a query as a string, you can do the following:
import { Compose, getComposedField, parseQuery } from 'soql-parser-js';
const soql = `SELECT Id FROM Account WHERE Name = 'Foo'`;
const parsedQuery = parseQuery(soql);
const composer = new Compose(parsedQuery, { autoCompose: false });
const whereClause = composer.parseWhereClause(parsedQuery.where);
console.log(whereClause);
}
Format Query
This function is provided as a convenience and just calls parse and compose.
Check out the demo to see the outcome of the various format options.
import { formatQuery } from 'soql-parser-js';
const query = `SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue, BillingAddress, BillingCity, BillingCountry, BillingGeocodeAccuracy, ShippingStreet, Sic, SicDesc, Site, SystemModstamp, TickerSymbol, Type, Website, (SELECT Id, Name, AccountId, Amount, CampaignId, CloseDate, CreatedById, Type FROM Opportunities), (SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue, BillingAddress, Website FROM ChildAccounts) FROM Account WHERE Name LIKE 'a%' OR Name LIKE 'b%' OR Name LIKE 'c%'`;
const formattedQuery1 = formatQuery(query);
const formattedQuery2 = formatQuery(query, {
fieldMaxLineLength: 20,
fieldSubqueryParensOnOwnLine: false,
whereClauseOperatorsIndented: true,
});
const formattedQuery3 = formatQuery(query, { fieldSubqueryParensOnOwnLine: true, whereClauseOperatorsIndented: true });
SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue,
BillingAddress, BillingCity, BillingCountry, BillingGeocodeAccuracy,
ShippingStreet, Sic, SicDesc, Site, SystemModstamp, TickerSymbol, Type,
Website,
(
SELECT Id, Name, AccountId, Amount, CampaignId, CloseDate,
CreatedById, Type
FROM Opportunities
),
(
SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue,
BillingAddress, Website
FROM ChildAccounts
)
FROM Account
WHERE Name LIKE 'a%'
OR Name LIKE 'b%'
OR Name LIKE 'c%'
SELECT Id, Name,
AccountNumber, AccountSource,
AnnualRevenue, BillingAddress,
BillingCity, BillingCountry,
BillingGeocodeAccuracy, ShippingStreet,
Sic, SicDesc, Site,
SystemModstamp, TickerSymbol, Type,
Website,
(SELECT Id, Name,
AccountId, Amount, CampaignId,
CloseDate, CreatedById, Type
FROM Opportunities),
(SELECT Id, Name,
AccountNumber, AccountSource,
AnnualRevenue, BillingAddress,
Website
FROM ChildAccounts)
FROM Account
WHERE Name LIKE 'a%'
OR Name LIKE 'b%'
OR Name LIKE 'c%'
SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue,
BillingAddress, BillingCity, BillingCountry, BillingGeocodeAccuracy,
ShippingStreet, Sic, SicDesc, Site, SystemModstamp, TickerSymbol, Type,
Website,
(
SELECT Id, Name, AccountId, Amount, CampaignId, CloseDate,
CreatedById, Type
FROM Opportunities
),
(
SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue,
BillingAddress, Website
FROM ChildAccounts
)
FROM Account
WHERE Name LIKE 'a%'
OR Name LIKE 'b%'
OR Name LIKE 'c%'
Utility Functions
The following utility functions are available:
getField(input: string | ComposeFieldInput)
- Convenience method to construct fields in the correct format. See data model below for the various input types as well as example usage in the Compose examples above.
- returns one of the following data structures:
SoqlModels.FieldFunctionExpression | SoqlModels.Field | SoqlModels.FieldRelationship | SoqlModels.FieldSubquery | SoqlModels.FieldTypeOf
.
isSubquery(query: Query | Subquery)
- Returns
true
if the data passed in is a subquery
getFlattenedFields(query: Query | Subquery | FieldSubquery)
- Flatten a Salesforce record based on the parsed SOQL Query. this is useful if you have relationships in your query and want to show the results in a table, using
.
dot notation for the relationship field headings. - Returns an array of strings.
- Refer to
tests/publicUtils.spec.ts
for usage examples.
Data Models
Query
export type LogicalOperator = 'AND' | 'OR';
export type Operator = '=' | '!=' | '<=' | '>=' | '>' | '<' | 'LIKE' | 'IN' | 'NOT IN' | 'INCLUDES' | 'EXCLUDES';
export type FieldTypeOfConditionType = 'WHEN' | 'ELSE';
export type GroupSelector = 'ABOVE' | 'AT' | 'BELOW' | 'ABOVE_OR_BELOW';
export type LogicalPrefix = 'NOT';
export type ForClause = 'VIEW' | 'UPDATE' | 'REFERENCE';
export type UpdateClause = 'TRACKING' | 'VIEWSTAT';
export type LiteralType =
| 'STRING'
| 'INTEGER'
| 'DECIMAL'
| 'INTEGER_WITH_CURRENCY_PREFIX'
| 'DECIMAL_WITH_CURRENCY_PREFIX'
| 'BOOLEAN'
| 'NULL'
| 'DATETIME'
| 'DATE'
| 'DATE_LITERAL'
| 'DATE_N_LITERAL'
| 'APEX_BIND_VARIABLE';
export type FieldType = Field | FieldFunctionExpression | FieldRelationship | FieldSubquery | FieldTypeOf;
export type OrderByCriterion = 'ASC' | 'DESC';
export type NullsOrder = 'FIRST' | 'LAST';
export type GroupByType = 'CUBE' | 'ROLLUP';
export type DateLiteral =
| 'YESTERDAY'
| 'TODAY'
| 'TOMORROW'
| 'LAST_WEEK'
| 'THIS_WEEK'
| 'NEXT_WEEK'
| 'LAST_MONTH'
| 'THIS_MONTH'
| 'NEXT_MONTH'
| 'LAST_90_DAYS'
| 'NEXT_90_DAYS'
| 'THIS_QUARTER'
| 'LAST_QUARTER'
| 'NEXT_QUARTER'
| 'THIS_YEAR'
| 'LAST_YEAR'
| 'NEXT_YEAR'
| 'THIS_FISCAL_QUARTER'
| 'LAST_FISCAL_QUARTER'
| 'NEXT_FISCAL_QUARTER'
| 'THIS_FISCAL_YEAR'
| 'LAST_FISCAL_YEAR'
| 'NEXT_FISCAL_YEAR';
export type DateNLiteral =
| 'YESTERDAY'
| 'NEXT_N_DAYS'
| 'LAST_N_DAYS'
| 'N_DAYS_AGO'
| 'NEXT_N_WEEKS'
| 'LAST_N_WEEKS'
| 'N_WEEKS_AGO'
| 'NEXT_N_MONTHS'
| 'LAST_N_MONTHS'
| 'N_MONTHS_AGO'
| 'NEXT_N_QUARTERS'
| 'LAST_N_QUARTERS'
| 'N_QUARTERS_AGO'
| 'NEXT_N_YEARS'
| 'LAST_N_YEARS'
| 'N_YEARS_AGO'
| 'NEXT_N_FISCAL_QUARTERS'
| 'LAST_N_FISCAL_QUARTERS'
| 'N_FISCAL_QUARTERS_AGO'
| 'NEXT_N_FISCAL_YEARS'
| 'LAST_N_FISCAL_YEARS'
| 'N_FISCAL_YEARS_AGO';
export interface Field {
type: 'Field';
field: string;
objectPrefix?: string;
rawValue?: string;
alias?: string;
}
export interface FieldFunctionExpression {
type: 'FieldFunctionExpression';
functionName: string;
parameters: (string | FieldFunctionExpression)[];
alias?: string;
isAggregateFn?: boolean;
rawValue?: string;
}
export interface FieldRelationship {
type: 'FieldRelationship';
field: string;
relationships: string[];
objectPrefix?: string;
rawValue?: string;
alias?: string;
}
export interface FieldSubquery {
type: 'FieldSubquery';
subquery: Subquery;
}
export interface FieldTypeOf {
type: 'FieldTypeof';
field: string;
conditions: FieldTypeOfCondition[];
}
export interface FieldTypeOfCondition {
type: FieldTypeOfConditionType;
objectType?: string;
fieldList: string[];
}
export interface QueryBase {
fields: FieldType[];
sObjectAlias?: string;
usingScope?: string;
where?: WhereClause;
limit?: number;
offset?: number;
groupBy?: GroupByClause;
orderBy?: OrderByClause | OrderByClause[];
withDataCategory?: WithDataCategoryClause;
withSecurityEnforced?: boolean;
for?: ForClause;
update?: UpdateClause;
}
export interface Query extends QueryBase {
sObject: string;
}
export interface Subquery extends QueryBase {
relationshipName: string;
sObjectPrefix?: string[];
}
export interface WhereClause {
left: Condition & ValueQuery;
right?: WhereClause;
operator?: LogicalOperator;
}
export interface ValueQuery {
valueQuery?: Query;
}
export interface Condition {
openParen?: number;
closeParen?: number;
logicalPrefix?: LogicalPrefix;
field?: string;
fn?: FunctionExp;
operator: Operator;
value?: string | string[];
literalType?: LiteralType | LiteralType[];
dateLiteralVariable?: number | number[];
}
export interface OrderByClause {
field?: string;
fn?: FunctionExp;
order?: OrderByCriterion;
nulls?: NullsOrder;
}
export interface GroupByClause {
field?: string | string[];
fn?: FunctionExp;
having?: HavingClause;
}
export interface HavingClause {
left: Condition;
right?: HavingClause;
operator?: LogicalOperator;
}
export interface FunctionExp {
rawValue?: string;
functionName?: string;
alias?: string;
parameters?: (string | FunctionExp)[];
isAggregateFn?: boolean;
}
export interface WithDataCategoryClause {
conditions: WithDataCategoryCondition[];
}
export interface WithDataCategoryCondition {
groupName: string;
selector: GroupSelector;
parameters: string[];
}
Compose / Utility
export type ComposeFieldInput = ComposeField | ComposeFieldFunction | ComposeFieldRelationship | ComposeFieldSubquery | ComposeFieldTypeof;
export interface ComposeField {
field: string;
objectPrefix?: string;
}
export interface ComposeFieldFunction {
fn?: string;
functionName: string;
parameters?: string | SoqlModels.FieldFunctionExpression | (string | SoqlModels.FieldFunctionExpression)[];
alias?: string;
}
export interface ComposeFieldRelationship {
field: string;
relationships: string[];
objectPrefix?: string;
}
export interface ComposeFieldSubquery {
subquery?: SoqlModels.Subquery;
}
export interface ComposeFieldTypeof {
field: string;
conditions: SoqlModels.FieldTypeOfCondition[];
}
Contributing
All contributions are welcome on the project. Please read the contribution guidelines.