force data bulk upsert
Bulk upsert records to an org from a CSV file. Uses Bulk API 1.0.
An upsert refers to inserting a record into a Salesforce object if the record doesn’t already exist, or updating it if it does exist.
When you execute this command, it starts a job and one or more batches, displays their IDs, and then immediately returns control of the terminal to you by default. If you prefer to wait, set the –wait flag to the number of minutes; if it times out, the command outputs the IDs. Use the job and batch IDs to check the status of the job with the “sf force data bulk status” command. A single job can contain many batches, depending on the length of the CSV file.
See “Prepare CSV Files” in the Bulk API Developer Guide for details on formatting your CSV file. (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_csv_preparing.htm)
By default, the job runs the batches in parallel, which we recommend. You can run jobs serially by specifying the –serial flag. But don’t process data in serial mode unless you know this would otherwise result in lock timeouts and you can’t reorganize your batches to avoid the locks.
| Flag Name (Long) | Flag Name (Short) | Description |
|---|---|---|
‑‑api‑version | N/A | Type: Value Override the api version used for api requests made by this command |
‑‑external‑id | ‑i | Type: Value Required Name of the external ID field, or the Id field. |
‑‑file | ‑f | Type: Value Required CSV file that contains the records to upsert. |
‑‑flags‑dir | N/A | Type: Value Import flag values from a directory. |
‑‑json | N/A | Type: Boolean Format output as json. |
‑‑serial | ‑r | Type: Boolean Run batches in serial mode. |
‑‑sobject | ‑s | Type: Value Required API name of the Salesforce object, either standard or custom, that you want to upsert records to. |
‑‑target‑org | ‑o | Type: Value Required Username or alias of the target org. Not required if the target-org configuration variable is already set. |
‑‑wait | ‑w | Type: Value Number of minutes to wait for the command to complete before displaying the results. |
Bulk upsert records to the Contact object in your default org:
Bulk upsert records to a custom object in an org with alias my-scratch and wait 5 minutes for the command to complete: