Bulk export records from an org into a file using a SOQL query. Uses Bulk API 2.0.
Description for data export bulk
You can use this command to export millions of records from an org, either to migrate data or to back it up.
Use a SOQL query to specify the fields of a standard or custom object that you want to export. Specify the SOQL query either at the command line with the --query flag or read it from a file with the --query-file flag; you can't specify both flags. The --output-file flag is required, which means you can only write the records to a file, in either CSV or JSON format.
Bulk exports can take a while, depending on how many records are returned by the SOQL query. If the command times out, the command displays the job ID. To see the status and get the results of the job, run "sf data export resume" and pass the job ID to the --job-id flag.
IMPORTANT: This command uses Bulk API 2.0, which limits the type of SOQL queries you can run. For example, you can't use aggregate functions such as count(). For the complete list of limitations, see the "SOQL Considerations" section in the "Bulk API 2.0 and Bulk API Developer Guide" (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm).
Flags
| Flag Name (Long) | Flag Name (Short) | Description |
|---|---|---|
| <code>‑‑all‑rows</code> | N/A | Type: Boolean<br><br>Include records that have been soft-deleted due to a merge or delete. By default, deleted records are not returned. |
| <code>‑‑api‑version</code> | N/A | Type: Value<br><br>Override the api version used for api requests made by this command |
| <code>‑‑column‑delimiter</code> | N/A | Type: Value<br>Valid Values: BACKQUOTE, CARET, COMMA, PIPE, SEMICOLON, TAB<br><br>Column delimiter to be used when writing CSV output. Default is COMMA. |
| <code>‑‑flags‑dir</code> | N/A | Type: Value<br><br>Import flag values from a directory. |
| <code>‑‑json</code> | N/A | Type: Boolean<br><br>Format output as json. |
| <code>‑‑line‑ending</code> | N/A | Type: Value<br>Valid Values: LF, CRLF<br><br>Line ending to be used when writing CSV output. Default value on Windows is is CRLF; on macOS and Linux it's LR. |
| <code>‑‑output‑file</code> | N/A | Type: Value<br>Required<br><br>File where records are written. |
| <code>‑‑query</code> | <code>‑q</code> | Type: Value<br><br>SOQL query to execute. |
| <code>‑‑query‑file</code> | N/A | Type: Value<br><br>File that contains the SOQL query. |
| <code>‑‑result‑format</code> | <code>‑r</code> | Type: Value<br>Required<br>Valid Values: csv, json<br>Default value: csv<br><br>Format to write the results. |
| <code>‑‑target‑org</code> | <code>‑o</code> | Type: Value<br>Required<br><br>Username or alias of the target org. Not required if the target-org configuration variable is already set. |
| <code>‑‑wait</code> | <code>‑w</code> | Type: Value<br><br>Time to wait for the command to finish, in minutes. |
Examples for data export bulk
Export the Id, Name, and Account.Name fields of the Contact object into a CSV-formatted file; if the export doesn't complete in 10 minutes, the command ends and displays a job ID. Use the org with alias "my-scratch":
sf data export bulk --query "SELECT Id, Name, Account.Name FROM Contact" --output-file export-accounts.csv --wait 10 --target-org my-scratch
Similar to previous example, but use the default org, export the records into a JSON-formatted file, and include records that have been soft deleted:
sf data export bulk --query "SELECT Id, Name, Account.Name FROM Contact" --output-file export-accounts.json --result-format json --wait 10 --all-rows