Class QueryFormatter

Index

Constructors

Properties

Methods

format formatCondition formatFieldList updateNamespace format

Constructors

constructor

new QueryFormatter(options?: QueryFormatterOptions): QueryFormatter
Parameters
- Optionaloptions: QueryFormatterOptions
Returns QueryFormatter
- Defined in packages/salesforce/src/queryParser.ts:80

Properties

`Private` `Optional` `Readonly`options

options?: QueryFormatterOptions

Methods

`Private`format

format(query: SalesforceQueryData): string
Parameters
- query: SalesforceQueryData
Returns string
- Defined in packages/salesforce/src/queryParser.ts:97

`Private`formatCondition

formatCondition(
condition: string | QueryBinary | QueryUnary,
previousCondition?: QueryBinary | QueryUnary,
): string
Parameters
- condition: string | QueryBinary | QueryUnary
- OptionalpreviousCondition: QueryBinary | QueryUnary
Returns string
- Defined in packages/salesforce/src/queryParser.ts:139

`Private`formatFieldList

formatFieldList(fields: string[]): string
Parameters
- fields: string[]
Returns string
- Defined in packages/salesforce/src/queryParser.ts:155

`Private`updateNamespace

updateNamespace(value: string): string
Parameters
- value: string
Returns string
- Defined in packages/salesforce/src/queryParser.ts:164

`Static`format

format(query: SalesforceQueryData, options?: QueryFormatterOptions): string
Format structured query data into a SOQL query that can be executed against Salesforce.

Namespace placeholders (%vlocity_namespace%) are only replaced when a namespace service is passed; without one placeholders are left untouched so the executing layer (e.g. QueryService or SalesforceDataService) can normalize them with its own initialized namespace service.
Parameters
- query: SalesforceQueryData
  Query data to format
- Optionaloptions: QueryFormatterOptions
  Optional query formatter options used to replace namespace placeholders
Returns string
Formatted SOQL query
- Defined in packages/salesforce/src/queryParser.ts:93