Class QueryBuilder

Simple salesforce SOQL builder

Hierarchy

QueryBuilderData
- QueryBuilder

Index

Constructors

Properties

Accessors

fields sobjectType where

Methods

clone execute filter getQuery getSpec isSelected limit offset select selectRelated sortBy sortDirection toString validateFields clone parse

Constructors

constructor

new QueryBuilder(query: SalesforceQueryData): QueryBuilder
Parameters
- query: SalesforceQueryData
Returns QueryBuilder
Overrides QueryBuilderData.constructor
- Defined in packages/salesforce/src/queryBuilder.ts:62
new QueryBuilder(sobjectType: string, fieldList?: string[]): QueryBuilder
Parameters
- sobjectType: string
- OptionalfieldList: string[]
Returns QueryBuilder
Overrides QueryBuilderData.constructor
- Defined in packages/salesforce/src/queryBuilder.ts:63

Properties

`Protected` `Readonly`query

query: SalesforceQueryData

Accessors

fields

get fields(): Iterable<string>
Returns Iterable<string>
Inherited from QueryBuilderData.fields
- Defined in packages/salesforce/src/queryBuilder.ts:32

sobjectType

get sobjectType(): string
Returns string
Inherited from QueryBuilderData.sobjectType
- Defined in packages/salesforce/src/queryBuilder.ts:36

where

get where(): QueryConditionBuilder
Returns QueryConditionBuilder
- Defined in packages/salesforce/src/queryBuilder.ts:99

Methods

clone

clone(): QueryBuilder
Returns QueryBuilder
- Defined in packages/salesforce/src/queryBuilder.ts:87

execute

execute<T = any>(executor?: QueryExecutor): Promise<T[]>
Type Parameters
- T = any
Parameters
- Optionalexecutor: QueryExecutor
Returns Promise<T[]>
Inherited from QueryBuilderData.execute
- Defined in packages/salesforce/src/queryBuilder.ts:40

filter

filter(
filter: QueryFilterCondition,
options?: { ignoreUndefined: boolean },
): this
Parameters
- filter: QueryFilterCondition
- Optionaloptions: { ignoreUndefined: boolean }
Returns this
- Defined in packages/salesforce/src/queryBuilder.ts:103

getQuery

getQuery(options?: QueryFormatterOptions): string
Format the query as SOQL string. Namespace placeholders are only replaced when a namespace service is passed; without one placeholders are left untouched so the executing layer can normalize them with its own initialized namespace service.
Parameters
- Optionaloptions: QueryFormatterOptions
Returns string
Inherited from QueryBuilderData.getQuery
- Defined in packages/salesforce/src/queryBuilder.ts:24

getSpec

getSpec(): SalesforceQueryData
Returns SalesforceQueryData
Inherited from QueryBuilderData.getSpec
- Defined in packages/salesforce/src/queryBuilder.ts:15

isSelected

isSelected(field: string): boolean
Parameters
- field: string
Returns boolean
- Defined in packages/salesforce/src/queryBuilder.ts:113

limit

limit(limit: number, offset?: number): QueryBuilder
Parameters
- limit: number
- Optionaloffset: number
Returns QueryBuilder
- Defined in packages/salesforce/src/queryBuilder.ts:131

offset

offset(offset: number): QueryBuilder
Parameters
- offset: number
Returns QueryBuilder
- Defined in packages/salesforce/src/queryBuilder.ts:139

select

select(...fields: FieldReference[]): QueryBuilder
Parameters
- ...fields: FieldReference[]
Returns QueryBuilder
- Defined in packages/salesforce/src/queryBuilder.ts:108

selectRelated

selectRelated(relationName: string, fields: FieldReference[]): QueryBuilder
Parameters
- relationName: string
- fields: FieldReference[]
Returns QueryBuilder
- Defined in packages/salesforce/src/queryBuilder.ts:117

sortBy

sortBy(
sortFields: FieldReference | FieldReference[],
direction?: "asc" | "desc",
): QueryBuilder
Parameters
- sortFields: FieldReference | FieldReference[]
- Optionaldirection: "asc" | "desc"
Returns QueryBuilder
- Defined in packages/salesforce/src/queryBuilder.ts:121

sortDirection

sortDirection(direction: "asc" | "desc"): QueryBuilder
Parameters
- direction: "asc" | "desc"
Returns QueryBuilder
- Defined in packages/salesforce/src/queryBuilder.ts:126

toString

toString(): string
Returns string
Inherited from QueryBuilderData.toString
- Defined in packages/salesforce/src/queryBuilder.ts:28

validateFields

validateFields(schema: SalesforceSchemaService): Promise<string[]>
Validate queried fields and remove any unknown field from the query using the schema access provided
Parameters
- schema: SalesforceSchemaService
  Schema access
Returns Promise<string[]>
- Defined in packages/salesforce/src/queryBuilder.ts:72

`Static`clone

clone(query: QueryBuilder): QueryBuilder
Parameters
- query: QueryBuilder
Returns QueryBuilder
- Defined in packages/salesforce/src/queryBuilder.ts:91

`Static`parse

parse(query: string): QueryBuilder
Parameters
- query: string
Returns QueryBuilder
- Defined in packages/salesforce/src/queryBuilder.ts:95