Class RecordBatch

Inserts and updates a set records and transparently selects either the collections or bulk API.

Index

Constructors

constructor

new RecordBatch(
    schemaService: SalesforceSchemaService,
    options?: Partial<
        { bulkApiThreshold: number; chunkSize: number; useBulkApi: boolean },
    >,
    logger?: Logger,
): RecordBatch
Parameters
- schemaService: SalesforceSchemaService
- Optionaloptions: Partial<{ bulkApiThreshold: number; chunkSize: number; useBulkApi: boolean }>
- logger: Logger = ...
Returns RecordBatch
- Defined in packages/salesforce/src/recordBatch.ts:69

Properties

`Private` `Readonly`bulkPollInterval

bulkPollInterval: 5000

`Private` `Readonly`bulkPollTimeout

bulkPollTimeout: number = ...

`Private`failedCount

failedCount: number = 0

`Private` `Readonly`insert

insert: Map<string, { data: any; ref: string }[]> = ...

`Private`isExecuting

isExecuting: boolean = false

`Private` `Readonly`logger

logger: Logger = ...

`Private` `Readonly`options

options: { bulkApiThreshold: number; chunkSize: number; useBulkApi: boolean } = ...

Type Declaration

bulkApiThreshold: number
chunkSize: number
Max chunk size when using the collections API only; if using bulk API once
useBulkApi: boolean
Allow the use of the bulk API when the record count is larger then the bulk API threshold (chunkSize)

`Private`processedCount

processedCount: number = 0

`Private`progressReporter

progressReporter: undefined | null | BatchProgressCallback

`Private`recordCount

recordCount: number = 0

`Private` `Readonly`schemaService

schemaService: SalesforceSchemaService

`Private` `Readonly`update

update: Map<string, { data: any; ref: string }[]> = ...

Accessors

size

get size(): number
Returns the number of records in this batch

Returns number
- Defined in packages/salesforce/src/recordBatch.ts:65

Methods

add

add(type: string, data: any, ref?: string): this
Parameters
- type: string
- data: any
- Optionalref: string
Returns this
- Defined in packages/salesforce/src/recordBatch.ts:278

addInsert

addInsert(type: string, data: any, ref?: string): this
Parameters
- type: string
- data: any
- Optionalref: string
Returns this
- Defined in packages/salesforce/src/recordBatch.ts:300

addUpdate

addUpdate(type: string, data: any, id: string, ref?: string): this
Parameters
- type: string
- data: any
- id: string
- Optionalref: string
Returns this
- Defined in packages/salesforce/src/recordBatch.ts:285

execute

execute(
    connection: SalesforceConnection | SalesforceConnectionProvider,
    onProgress?: BatchProgressCallback,
    cancelToken?: CancellationToken,
): AsyncGenerator<BatchResultRecord>
Parameters
- connection: SalesforceConnection | SalesforceConnectionProvider
- OptionalonProgress: BatchProgressCallback
- OptionalcancelToken: CancellationToken
Returns AsyncGenerator<BatchResultRecord>
- Defined in packages/salesforce/src/recordBatch.ts:82

`Private`executeWithBulkApi

executeWithBulkApi(
    connection: SalesforceConnection,
    chunk: RecordBatchChunk,
    cancelToken?: CancellationToken,
): Promise<RecordResult[]>
Parameters
- connection: SalesforceConnection
- chunk: RecordBatchChunk
- OptionalcancelToken: CancellationToken
Returns Promise<RecordResult[]>
- Defined in packages/salesforce/src/recordBatch.ts:215

`Private`executeWithCollectionApi

executeWithCollectionApi(
connection: SalesforceConnection,
chunk: RecordBatchChunk,
): Promise<RecordResult[]>
Parameters
- connection: SalesforceConnection
- chunk: RecordBatchChunk
Returns Promise<RecordResult[]>
- Defined in packages/salesforce/src/recordBatch.ts:199

`Private`getRecords

getRecords(
operation: "all" | RecordOperationType,
count?: number,
): Promise<undefined | RecordBatchChunk>
Parameters
- operation: "all" | RecordOperationType
- Optionalcount: number
Returns Promise<undefined | RecordBatchChunk>
- Defined in packages/salesforce/src/recordBatch.ts:160

`Private`reportProgress

reportProgress(): void
Returns void
- Defined in packages/salesforce/src/recordBatch.ts:268

`Private`validateRecordData

validateRecordData(
    sobjectType: string,
    values: object,
    mode: "insert" | "update",
): Promise<{}>
Validate if the specified record data can be inserted; if not drop any fields that cannot be inserted or updated depending on the mode property specified.
Parameters
- sobjectType: string
  SObject type
- values: object
  Values of the record
- mode: "insert" | "update"
  Check for update or insert
Returns Promise<{}>
- Defined in packages/salesforce/src/recordBatch.ts:314

`Private`yieldRecords

yieldRecords(
operation: "all" | RecordOperationType,
count: number,
): AsyncGenerator<RecordBatchChunk>
Parameters
- operation: "all" | RecordOperationType
- count: number
Returns AsyncGenerator<RecordBatchChunk>
- Defined in packages/salesforce/src/recordBatch.ts:191

Class RecordBatch

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RecordBatch

Properties

Private ReadonlybulkPollInterval

Private ReadonlybulkPollTimeout

PrivatefailedCount

Private Readonlyinsert

PrivateisExecuting

Private Readonlylogger

Private Readonlyoptions

Type Declaration

bulkApiThreshold: number

chunkSize: number

useBulkApi: boolean

PrivateprocessedCount

PrivateprogressReporter

PrivaterecordCount

Private ReadonlyschemaService

Private Readonlyupdate

Accessors

size

Returns number

Methods

add

Parameters

Returns this

addInsert

Parameters

Returns this

addUpdate

Parameters

Returns this

execute

Parameters

Returns AsyncGenerator<BatchResultRecord>

PrivateexecuteWithBulkApi

Parameters

Returns Promise<RecordResult[]>

PrivateexecuteWithCollectionApi

Parameters

Returns Promise<RecordResult[]>

PrivategetRecords

Parameters

Returns Promise<undefined | RecordBatchChunk>

PrivatereportProgress

Returns void

PrivatevalidateRecordData

Parameters

Returns Promise<{}>

PrivateyieldRecords

Parameters

Returns AsyncGenerator<RecordBatchChunk>

Settings

On This Page

`Private` `Readonly`bulkPollInterval

`Private` `Readonly`bulkPollTimeout

`Private`failedCount

`Private` `Readonly`insert

`Private`isExecuting

`Private` `Readonly`logger

`Private` `Readonly`options

`Private`processedCount

`Private`progressReporter

`Private`recordCount

`Private` `Readonly`schemaService

`Private` `Readonly`update

`Private`executeWithBulkApi

`Private`executeWithCollectionApi

`Private`getRecords

`Private`reportProgress

`Private`validateRecordData

`Private`yieldRecords