SOQL Parser JS
Description
:sunny: This library allows parsing Salesforce SOQL queries using JavaScript or Typescript. Works in the browser and node. :sunny:
SOQL Parser JS provides the following capabilities:
- Parse a SOQL query into a usable data structure.
- Turn a parsed data structure back into a well formed SOQL query with various format options.
- Check if a SOQL query is syntactically valid (note: some cases may be structurally valid but not allowed by Salesforce, e.x. invalid field name).
This library is written in Typescript and all type definitions are included with the library for your benefit if you choose to use Typescript or use VSCode's automatic type checking.
:warning: antlr4 is dependency for this library and is a rather large library (~600 KB) and is required for the parser to function. Consider using dynamic imports to achieve lazy loading.
Examples
Want to try it out? Check out the demo.
Look through the unit tests for additional examples.
Usage
Parsing
Parsing a SOQL query can be completed by calling parseQuery(soqlQueryString, options)
. A Query
data structure will be returned;
Typescript / ES6
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
{
"fields": [
{
"type": "Field",
"field": "UserId"
},
{
"type": "FieldFunctionExpression",
"rawValue": "COUNT(Id)",
"fn": "COUNT",
"isAggregateFn": true,
"parameters": ["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"
}
}
Options
export interface SoqlQueryConfig {
continueIfErrors?: boolean;
logging: boolean;
}
Composing
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.
:page_facing_up: Note: Some operators may be converted to upper case (e.x. NOT, AND)
:page_facing_up: 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.
The base query object is shaped like this:
export interface QueryBase {
fields: FieldType[];
sObjectAlias?: string;
where?: WhereClause;
limit?: number;
offset?: number;
groupBy?: GroupByClause;
having?: HavingClause;
orderBy?: OrderByClause | OrderByClause[];
withDataCategory?: WithDataCategoryClause;
for?: ForClause;
update?: UpdateClause;
}
The easiest way to build the fields is to call the utility function getComposedField()
.
Example
This is the query that will be composed programmatically
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
import { composeQuery, getComposedField } from 'soql-parser-js';
const oppLineItemsSubquery = {
fields: [
getComposedField('Quantity'),
getComposedField('ListPrice'),
getComposedField({
field: 'UnitPrice',
relationships: ['PricebookEntry'],
}),
getComposedField({
field: 'Name',
relationships: ['PricebookEntry'],
}),
],
relationshipName: 'OpportunityLineItems',
};
const soqlQuery = {
fields: [
getComposedField('Id'),
getComposedField('Name'),
getComposedField({
fn: 'FORMAT',
parameters: 'Amount',
alias: 'MyFormattedAmount',
}),
getComposedField({ 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);
In the example above, we made use of getComposedField(input: string | ComposeFieldInput)
to compose the fields. The input expects a string or one of the following data structures listed below. An error will be thrown if the data passed in is not one of the following shapes.
This returns a FieldType
object.
export interface ComposeField {
field: string;
objectPrefix?: string;
}
export interface ComposeFieldFunction {
fn: string;
parameters?: string | string[] | FieldFunctionExpression | FieldFunctionExpression[];
alias?: string;
}
export interface ComposeFieldRelationship {
field: string;
relationships: string[];
objectPrefix?: string;
}
export interface ComposeFieldSubquery {
subquery?: Subquery;
}
export interface ComposeFieldTypeof {
field: string;
conditions: FieldTypeOfCondition[];
}
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);
}
Checking if a Query is Valid
This will parse a Query to confirm valid syntax, but will not parse into the Query data structure, which will have a small performance gain.
This method is faster than parsing the full query.
Options:
export interface ConfigBase {
logging: boolean;
}
import { isQueryValid } 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 isValid = isQueryValid(soql);
console.log(isValid);
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, {
fieldMaxLineLen: 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%'
Options
export interface SoqlQueryConfig {
continueIfErrors?: boolean;
logging: boolean;
includeSubqueryAsField: boolean;
}
export interface SoqlComposeConfig {
logging: boolean;
format: boolean;
formatOptions?: FormatOptions;
autoCompose: boolean;
}
export interface FormatOptions {
numIndent?: number;
fieldMaxLineLen?: number;
fieldSubqueryParensOnOwnLine?: boolean;
whereClauseOperatorsIndented?: boolean;
logging?: boolean;
}
Utility Functions
The following utility functions are available:
getComposedField(input: string | ComposeFieldInput)
- Convenience method to construct fields in the correct data format. See example usage in the Compose example.
isSubquery(query: Query | Subquery)
- Returns true if the data passed in is a subquery
getFlattenedFields(query: Query)
- 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 fields. - Refer to
tests/publicUtils.spec.ts
for usage examples.
Data Models
These are all available for import in your typescript projects
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'
| 'BOOLEAN'
| 'NULL'
| 'DATETIME'
| 'DATE'
| 'DATE_LITERAL'
| 'DATE_N_LITERAL';
export type FieldType = Field | FieldFunctionExpression | FieldRelationship | FieldSubquery | FieldTypeOf;
export type OrderByCriterion = 'ASC' | 'DESC';
export type NullsOrder = 'FIRST' | 'LAST';
export type GroupByType = 'CUBE' | 'ROLLUP';
export interface Field {
type: 'Field';
field: string;
objectPrefix?: string;
}
export interface FieldFunctionExpression {
type: 'FieldFunctionExpression';
fn: string;
parameters?: string[] | FieldFunctionExpression[];
alias?: string;
isAggregateFn?: boolean;
rawValue?: string;
}
export interface FieldRelationship {
type: 'FieldRelationship';
field: string;
relationships: string[];
objectPrefix?: string;
rawValue?: string;
}
export interface FieldSubquery {
type: 'FieldSubquery';
subquery: Subquery;
from?: string;
}
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;
where?: WhereClause;
limit?: number;
offset?: number;
groupBy?: GroupByClause;
having?: HavingClause;
orderBy?: OrderByClause | OrderByClause[];
withDataCategory?: WithDataCategoryClause;
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;
right?: WhereClause;
operator?: LogicalOperator;
}
export interface Condition {
openParen?: number;
closeParen?: number;
logicalPrefix?: LogicalPrefix;
field?: string;
fn?: FunctionExp;
operator: Operator;
value?: string | string[];
valueQuery?: Query;
literalType?: LiteralType;
dateLiteralVariable?: number;
}
export interface OrderByClause {
field?: string;
fn?: FunctionExp;
order?: OrderByCriterion;
nulls?: NullsOrder;
}
export interface GroupByClause {
field: string | string[];
type?: GroupByType;
}
export interface HavingClause {
left: HavingCondition;
right?: HavingClause;
operator?: LogicalOperator;
}
export interface HavingCondition {
openParen?: number;
closeParen?: number;
field?: string;
fn?: FunctionExp;
operator: string;
value: string | number;
}
export interface FunctionExp {
text?: string;
name?: string;
alias?: string;
parameter?: string | string[];
isAggregateFn?: boolean;
fn?: FunctionExp;
}
export interface WithDataCategoryClause {
conditions: WithDataCategoryCondition[];
}
export interface WithDataCategoryCondition {
groupName: string;
selector: GroupSelector;
parameters: string[];
}
Compose Class
You only need to interact with the compose class if you want to compose part of a SOQL query
logging: boolean;
format: boolean;
query: string;
formatter: Formatter;
constructor(private soql: Query, config?: Partial<SoqlComposeConfig>)
start(): void
parseQuery(query: Query | Subquery): string
parseFields(fields: FieldType[]): string[]
parseTypeOfField(typeOfField: FieldTypeOf): string
parseFn(fn: FunctionExp): string
parseWhereClause(where: WhereClause): string
parseGroupByClause(groupBy: GroupByClause): string
parseHavingClause(having: HavingClause): string
parseOrderBy(orderBy: OrderByClause | OrderByClause[]): string
parseWithDataCategory(withDataCategory: WithDataCategoryClause): string
Utils
export interface ComposeField {
field: string;
objectPrefix?: string;
}
export interface ComposeFieldFunction {
fn: string;
parameters?: string | string[] | FieldFunctionExpression | FieldFunctionExpression[];
alias?: string;
}
export interface ComposeFieldRelationship {
field: string;
relationships: string[];
objectPrefix?: string;
}
export interface ComposeFieldSubquery {
subquery?: Subquery;
}
export interface ComposeFieldTypeof {
field: string;
conditions: FieldTypeOfCondition[];
}
export type ComposeFieldInput =
| ComposeField
| ComposeFieldFunction
| ComposeFieldRelationship
| ComposeFieldSubquery
| ComposeFieldTypeof;
CLI Usage
The CLI can be used to parse a query or compose a previously parsed query back to SOQL.
Examples:
$ npm install -g soql-parser-js
$ soql --help
$ soql --query "SELECT Id FROM Account"
$ soql -query "SELECT Id FROM Account"
$ soql -query "SELECT Id FROM Account" -output some-output-file.json
$ soql -query "SELECT Id FROM Account" -json
$ soql -query some-input-file.txt
$ soql -compose some-input-file.json
$ soql -compose some-input-file.json
$ soql -compose some-input-file.json -output some-output-file.json
Arguments:
--query, -q A SOQL query surrounded in quotes or a file path to a text file containing a SOQL query.
--compose, -c An escaped and quoted parsed SOQL JSON string or a file path to a text file containing a parsed query JSON object.
--output, -o Filepath.
--json, -j Provide all output messages as JSON.
--debug, -d Print additional debug log messages.
--help, -h Show this help message.
Contributing
All contributions are welcome on the project. Please read the contribution guidelines.
Special Thanks