Class BulkV2<S>

constructor

• new BulkV2<S>(connection): BulkV2<S>

• Type Parameters

  • S extends Schema

  Parameters

  • connection: Connection<S>

  Returns BulkV2<S>

pollInterval

pollTimeout

createJob

• createJob(options): IngestJobV2<S>

• Create an instance of an ingest job object.

  Parameters

  • options: NewIngestJobOptions

  Returns IngestJobV2<S>

  An ingest job instance

  Params

  options object

  Example

  // Upsert records to the Account object.
  
  const job = connection.bulk2.createJob({
    operation: 'insert'
    object: 'Account',
  });
  
  // create the job in the org
  await job.open()
  
  // upload data
  await job.uploadData(csvFile)
  
  // finished uploading data, mark it as ready for processing
  await job.close()
  Copy

job

• job(type, options): QueryJobV2<S>

• Get an ingest or query job instance specified by a given job ID

  Parameters

  • type: "query"
  • options: Pick<ExistingQueryJobV2Options, "id">

    Options object with a job ID

  Returns QueryJobV2<S>

  IngestJobV2 An ingest job
• job(type, options): IngestJobV2<S>

• Parameters

  • type: "ingest"
  • options: Pick<ExistingIngestJobOptions, "id">

  Returns IngestJobV2<S>

loadAndWaitForResults

• loadAndWaitForResults(options): Promise<IngestJobV2Results<S>>

• Create, upload, and start bulkload job

  Parameters

  • options: Required<Pick<JobInfoV2, "object" | "operation">> & Partial<Pick<JobInfoV2, "assignmentRuleId" | "lineEnding" | "columnDelimiter" | "contentType" | "externalIdFieldName">> & Partial<BulkV2PollingOptions> & {
        input: string | Readable | Record[];
    }

  Returns Promise<IngestJobV2Results<S>>

query

• query(soql, options?): Promise<Parsable<Record>>

• Execute bulk query and get a record stream.

  Default timeout: 10000ms

  Parameters

  • soql: string

    SOQL query
  • Optional options: Partial<BulkV2PollingOptions> & {
        columnDelimiter?: "BACKQUOTE" | "CARET" | "COMMA" | "PIPE" | "SEMICOLON" | "TAB";
        lineEnding?: "LF" | "CRLF";
        scanAll?: boolean;
    }

  Returns Promise<Parsable<Record>>

  • Record stream, convertible to a CSV data stream