Class QueryBuilder

Simple salesforce SOQL builder

Hierarchy

QueryBuilderData
- QueryBuilder

Index

Constructors

Properties

Accessors

fields sobjectType where

Methods

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

Constructors

constructor

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

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:24

sobjectType

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

where

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

Methods

clone

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

execute

execute<T>(executor?): Promise<T[]>
Type Parameters
- T = any
Parameters
- Optional executor: SalesforceConnectionProvider | {
  query(q) => Promise<T[]>;
  }
Returns Promise<T[]>
Inherited from QueryBuilderData.execute
- Defined in packages/salesforce/src/queryBuilder.ts:32

executeTooling

executeTooling<T>(executor?): Promise<T[]>
Type Parameters
- T = any
Parameters
- Optional executor: SalesforceConnectionProvider | {
  queryTooling(q) => Promise<T[]>;
  }
Returns Promise<T[]>
Inherited from QueryBuilderData.executeTooling
- Defined in packages/salesforce/src/queryBuilder.ts:45

filter

filter(filter, options?): QueryBuilder
Parameters
- filter: QueryFilterCondition
- Optional options: {
  ignoreUndefined: boolean;
  }
  - ignoreUndefined: boolean
Returns QueryBuilder
- Defined in packages/salesforce/src/queryBuilder.ts:113

getQuery

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

getSpec

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

isSelected

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

limit

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

offset

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

select

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

selectRelated

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

sortBy

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

sortDirection

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

toString

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

validateFields

validateFields(schema): 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:82

`Static` clone

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

`Static` parse

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