Connection | @salesforce/core

Handles connections and requests to Salesforce Orgs.

extends

jsforce.Connection

example

// Uses latest API version const connection = await Connection.create(await AuthInfo.create(myAdminUsername)); connection.query('SELECT Name from Account');

// Use different API version connection.setApiVersion("42.0"); connection.query('SELECT Name from Account');

Hierarchy

Connection
- Connection

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Connection(options: ConnectionOptions, authInfo: AuthInfo, logger?: Logger): Connection

Overrides Connection.__constructor
- Defined in connection.ts:121
Parameters
- options: ConnectionOptions
- authInfo: AuthInfo
- Optional logger: Logger
Returns Connection

Properties

accessToken

accessToken: string

analytics

analytics: Analytics

bulk

bulk: Bulk

chatter

chatter: Chatter

instanceUrl

instanceUrl: string

metadata

metadata: Metadata

oauth2

oauth2: OAuth2

streaming

streaming: Streaming

tooling

tooling: Tooling

version

version: string

Static defaultMaxListeners

defaultMaxListeners: number

Methods

_baseUrl

_baseUrl(): string

Inherited from BaseConnection._baseUrl
- Defined in @types/jsforce/connection.d.ts:94
Returns string

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in @types/node/index.d.ts:1082
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

authorize

authorize(code: string, callback?: undefined | function): Promise<UserInfo>

Inherited from Connection.authorize
- Defined in @types/jsforce/connection.d.ts:136
Parameters
- code: string
- Optional callback: undefined | function
Returns Promise<UserInfo>

autoFetchQuery

autoFetchQuery<T>(soql: string, options?: ExecuteOptions): Promise<QueryResult<T>>

- Defined in connection.ts:284
Executes a query and auto-fetches (i.e., "queryMore") all results. This is especially useful with large query result sizes, such as over 2000 records. The default maximum fetch size is 10,000 records. Modify this via the options argument.

Type parameters
- T
Parameters
- soql: string
  
  The SOQL string.
- Default value options: ExecuteOptions = {}
  
  The query options. NOTE: the autoFetch option will always be true.
Returns Promise<QueryResult<T>>

baseUrl

baseUrl(): string

- Defined in connection.ts:185
Returns string

The Force API base url for the instance.

create

create<T>(type: string, records: Record<T> | Array<Record<T>>, options?: Object, callback?: undefined | function): Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

Inherited from BaseConnection.create
- Defined in @types/jsforce/connection.d.ts:98
Type parameters
- T
Parameters
- type: string
- records: Record<T> | Array<Record<T>>
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

del

del<T>(type: string, ids: string | string[], options?: Object, callback?: undefined | function): Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

Inherited from BaseConnection.del
- Defined in @types/jsforce/connection.d.ts:108
Type parameters
- T
Parameters
- type: string
- ids: string | string[]
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

delete

delete<T>(type: string, ids: string | string[], options?: Object, callback?: undefined | function): Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

Inherited from BaseConnection.delete
- Defined in @types/jsforce/connection.d.ts:110
Type parameters
- T
Parameters
- type: string
- ids: string | string[]
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

describe

describe<T>(type: string, callback?: undefined | function): Promise<DescribeSObjectResult>

Inherited from BaseConnection.describe
- Defined in @types/jsforce/connection.d.ts:114
Type parameters
- T
Parameters
- type: string
- Optional callback: undefined | function
Returns Promise<DescribeSObjectResult>

describeGlobal

describeGlobal<T>(callback?: undefined | function): Promise<DescribeGlobalResult>

Inherited from BaseConnection.describeGlobal
- Defined in @types/jsforce/connection.d.ts:115
Type parameters
- T
Parameters
- Optional callback: undefined | function
Returns Promise<DescribeGlobalResult>

destroy

destroy<T>(type: string, ids: string | string[], options?: Object, callback?: undefined | function): Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

Inherited from BaseConnection.destroy
- Defined in @types/jsforce/connection.d.ts:112
Type parameters
- T
Parameters
- type: string
- ids: string | string[]
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in @types/node/index.d.ts:1094
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in @types/node/index.d.ts:1095
Returns Array<string | symbol>

getApiVersion

getApiVersion(): string

- Defined in connection.ts:221
Get the API version used for all connection requests.

Returns string

getAuthInfoFields

getAuthInfoFields(): AuthFields

- Defined in connection.ts:244
Getter for the AuthInfo

Returns AuthFields

A cloned authInfo.

getConnectionOptions

getConnectionOptions(): AuthFields

- Defined in connection.ts:248
Returns AuthFields

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in @types/node/index.d.ts:1091
Returns number

getUsername

getUsername(): Optional<string>

- Defined in connection.ts:256
Getter for the username of the Salesforce Org

Returns Optional<string>

initialize

initialize(options?: ConnectionOptions): void

Inherited from Connection.initialize
- Defined in @types/jsforce/connection.d.ts:134
Parameters
- Optional options: ConnectionOptions
Returns void

insert

insert<T>(type: string, records: Record<T> | Array<Record<T>>, options?: Object, callback?: undefined | function): Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

Inherited from BaseConnection.insert
- Defined in @types/jsforce/connection.d.ts:100
Type parameters
- T
Parameters
- type: string
- records: Record<T> | Array<Record<T>>
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

isUsingAccessToken

isUsingAccessToken(): boolean

- Defined in connection.ts:264
Returns true if this connection is using access token auth.

Returns boolean

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in @types/node/index.d.ts:1096
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in @types/node/index.d.ts:1092
Parameters
- event: string | symbol
Returns Function[]

login

Inherited from Connection.login
- Defined in @types/jsforce/connection.d.ts:137
Parameters
- user: string
- password: string
- Optional callback: undefined | function
Returns Promise<UserInfo>

loginByOAuth2

loginByOAuth2(user: string, password: string, callback?: undefined | function): Promise<UserInfo>

Inherited from Connection.loginByOAuth2
- Defined in @types/jsforce/connection.d.ts:138
Parameters
- user: string
- password: string
- Optional callback: undefined | function
Returns Promise<UserInfo>

loginBySoap

loginBySoap(user: string, password: string, callback?: undefined | function): Promise<UserInfo>

Inherited from Connection.loginBySoap
- Defined in @types/jsforce/connection.d.ts:139
Parameters
- user: string
- password: string
- Optional callback: undefined | function
Returns Promise<UserInfo>

logout

logout(callback?: undefined | function): Promise<void>

Inherited from Connection.logout
- Defined in @types/jsforce/connection.d.ts:140
Parameters
- Optional callback: undefined | function
Returns Promise<void>

logoutByOAuth2

logoutByOAuth2(callback?: undefined | function): Promise<void>

Inherited from Connection.logoutByOAuth2
- Defined in @types/jsforce/connection.d.ts:141
Parameters
- Optional callback: undefined | function
Returns Promise<void>

logoutBySoap

logoutBySoap(callback?: undefined | function): Promise<void>

Inherited from Connection.logoutBySoap
- Defined in @types/jsforce/connection.d.ts:142
Parameters
- Optional callback: undefined | function
Returns Promise<void>

normalizeUrl

normalizeUrl(url: string): string

- Defined in connection.ts:272
Normalize a Salesforce url to include a instance information.

Parameters
- url: string
  
  partial url.
Returns string

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in @types/node/index.d.ts:1088
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in @types/node/index.d.ts:1083
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in @types/node/index.d.ts:1084
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in @types/node/index.d.ts:1085
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in @types/node/index.d.ts:1086
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

query

query<T>(soql: string, options?: ExecuteOptions, callback?: undefined | function): Query<QueryResult<T>>

Inherited from BaseConnection.query
- Defined in @types/jsforce/connection.d.ts:96
Type parameters
- T
Parameters
- soql: string
- Optional options: ExecuteOptions
- Optional callback: undefined | function
Returns Query<QueryResult<T>>

queryAll

queryAll<T>(soql: string, options?: undefined | object, callback?: undefined | function): Query<QueryResult<T>>

Inherited from Connection.queryAll
- Defined in @types/jsforce/connection.d.ts:135
Type parameters
- T
Parameters
- soql: string
- Optional options: undefined | object
- Optional callback: undefined | function
Returns Query<QueryResult<T>>

queryMore

queryMore<T>(locator: string, options?: ExecuteOptions, callback?: undefined | function): Promise<QueryResult<T>>

Inherited from BaseConnection.queryMore
- Defined in @types/jsforce/connection.d.ts:97
Type parameters
- T
Parameters
- locator: string
- Optional options: ExecuteOptions
- Optional callback: undefined | function
Returns Promise<QueryResult<T>>

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in @types/node/index.d.ts:1093
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in @types/node/index.d.ts:1089
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in @types/node/index.d.ts:1087
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

request

request(request: RequestInfo | string, options?: JsonMap): Promise<JsonCollection>

Overrides BaseConnection.request
- Defined in connection.ts:145
Send REST API request with given HTTP request info, with connected session information and SFDX headers.

override

Parameters
- request: RequestInfo | string
  
  HTTP request object or URL to GET request.
- Optional options: JsonMap
  
  HTTP API request options.
Returns Promise<JsonCollection>

requestRaw

requestRaw(request: RequestInfo): Promise<JsonMap>

- Defined in connection.ts:167
Send REST API request with given HTTP request info, with connected session information and SFDX headers. This method returns a raw http response which includes a response body and statusCode.

override

Parameters
- request: RequestInfo
  
  HTTP request object or URL to GET request.
Returns Promise<JsonMap>

The request Promise.

retrieve

retrieve<T>(type: string, ids: string | string[], options?: Object, callback?: undefined | function): Promise<object & T | (object & T)[]>

Inherited from BaseConnection.retrieve
- Defined in @types/jsforce/connection.d.ts:102
Type parameters
- T
Parameters
- type: string
- ids: string | string[]
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<object & T | (object & T)[]>

retrieveMaxApiVersion

retrieveMaxApiVersion(): Promise<string>

- Defined in connection.ts:194
Retrieves the highest api version that is supported by the target server instance.

Returns Promise<string>

The max API version number. i.e 46.0

setApiVersion

setApiVersion(version: string): void

- Defined in connection.ts:230
Set the API version for all connection requests.

throws

{SfdxError} {name: 'IncorrectAPIVersion'}: Incorrect API version.

Parameters
- version: string
  
  The API version.
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in @types/node/index.d.ts:1090
Parameters
- n: number
Returns this

sobject

sobject<T>(resource: string): SObject<T>

Inherited from BaseConnection.sobject
- Defined in @types/jsforce/connection.d.ts:116
Type parameters
- T
Parameters
- resource: string
Returns SObject<T>

update

update<T>(type: string, records: Record<T> | Array<Record<T>>, options?: Object, callback?: undefined | function): Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

Inherited from BaseConnection.update
- Defined in @types/jsforce/connection.d.ts:104
Type parameters
- T
Parameters
- type: string
- records: Record<T> | Array<Record<T>>
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

upsert

upsert<T>(type: string, records: Record<T> | Array<Record<T>>, extIdField: string, options?: Object, callback?: undefined | function): Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

Inherited from BaseConnection.upsert
- Defined in @types/jsforce/connection.d.ts:106
Type parameters
- T
Parameters
- type: string
- records: Record<T> | Array<Record<T>>
- extIdField: string
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

useLatestApiVersion

useLatestApiVersion(): Promise<void>

- Defined in connection.ts:208
Use the latest API version available on this.instanceUrl.

Returns Promise<void>

Static create

create(authInfo: AuthInfo, configAggregator?: ConfigAggregator): Promise<Connection>

- Defined in connection.ts:84
Create and return a connection to an org using authentication info. The returned connection uses the latest API version available on the server unless the apiVersion config value is set.

Parameters
- authInfo: AuthInfo
  
  The authentication info from the persistence store.
- Optional configAggregator: ConfigAggregator
Returns Promise<Connection>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in @types/node/index.d.ts:1079
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: ConnectionOptions

authInfo: AuthInfo

Optional logger: Logger

Returns Connection

Properties

accessToken

analytics

bulk

chatter

instanceUrl

metadata

oauth2

streaming

tooling

version

Static defaultMaxListeners

Methods

_baseUrl

Returns string

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

authorize

Parameters

code: string

Optional callback: undefined | function

Returns Promise<UserInfo>

autoFetchQuery

Type parameters

T

Parameters

soql: string

Default value options: ExecuteOptions = {}

Returns Promise<QueryResult<T>>

baseUrl

Returns string

create

Type parameters

T

Parameters

type: string

records: Record<T> | Array<Record<T>>

Optional options: Object

Optional callback: undefined | function

Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

del

Type parameters

T

Parameters

type: string

ids: string | string[]

Optional options: Object

Optional callback: undefined | function

Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

delete

Type parameters

T

Parameters

type: string

ids: string | string[]

Optional options: Object

Optional callback: undefined | function

Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

describe

Type parameters

T

Parameters