@salesforce/plugin-data
Version:
Plugin for salesforce data commands
1,084 lines (774 loc) • 61.8 kB
Markdown
[](https://www.npmjs.com/package/@salesforce/plugin-data) [](https://npmjs.org/package/@salesforce/plugin-data) [](https://opensource.org/license/apache-2-0)
# plugin-data
`data` commands for Salesforce CLI.
This plugin is bundled with the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli). For more information
on the CLI, read
the [getting started guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_intro.htm)
.
We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific
version or tag if needed.
## Install
```bash
sf plugins:install data@x.y.z
```
## Issues
Please report any issues at https://github.com/forcedotcom/cli/issues
## Contributing
1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
2. Create a new issue before starting your project so that we can keep track of what you are trying to add/fix. That
way, we can also offer suggestions or let you know if there is already an effort in progress.
3. Fork this repository.
4. [Build the plugin locally](#build)
5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing
using a fork.
6. Edit the code in your fork.
7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request
will be accepted without unit tests.
8. Sign CLA (see [CLA](#cla) below).
9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
### CLA
External contributors will be required to sign a Contributor's License Agreement. You can do so by going
to https://cla.salesforce.com/sign-cla.
### Build
To build the plugin locally, make sure to have yarn installed and run the following commands:
```bash
# Clone the repository
git clone git@github.com:salesforcecli/plugin-data
# Install the dependencies and compile
yarn install
yarn build
```
To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
```bash
# Run using local run file.
./bin/dev force:data
```
There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be
useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
```bash
# Link your plugin to the sf cli
sf plugins:link .
# To verify
sf plugins
```
# Commands
<!-- commands -->
- [`sf data bulk results`](#sf-data-bulk-results)
- [`sf data create file`](#sf-data-create-file)
- [`sf data create record`](#sf-data-create-record)
- [`sf data delete bulk`](#sf-data-delete-bulk)
- [`sf data delete record`](#sf-data-delete-record)
- [`sf data delete resume`](#sf-data-delete-resume)
- [`sf data export bulk`](#sf-data-export-bulk)
- [`sf data export resume`](#sf-data-export-resume)
- [`sf data export tree`](#sf-data-export-tree)
- [`sf data get record`](#sf-data-get-record)
- [`sf data import bulk`](#sf-data-import-bulk)
- [`sf data import resume`](#sf-data-import-resume)
- [`sf data import tree`](#sf-data-import-tree)
- [`sf data query`](#sf-data-query)
- [`sf data resume`](#sf-data-resume)
- [`sf data search`](#sf-data-search)
- [`sf data update bulk`](#sf-data-update-bulk)
- [`sf data update record`](#sf-data-update-record)
- [`sf data update resume`](#sf-data-update-resume)
- [`sf data upsert bulk`](#sf-data-upsert-bulk)
- [`sf data upsert resume`](#sf-data-upsert-resume)
- [`sf force data bulk delete`](#sf-force-data-bulk-delete)
- [`sf force data bulk status`](#sf-force-data-bulk-status)
- [`sf force data bulk upsert`](#sf-force-data-bulk-upsert)
## `sf data bulk results`
Get the results of a bulk ingest job that you previously ran.
```
USAGE
$ sf data bulk results -i <value> -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
FLAGS
-i, --job-id=<value> (required) Job ID of the bulk job.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Get the results of a bulk ingest job that you previously ran.
Use this command to get the complete results after running one of the CLI commands that uses Bulk API 2.0 to ingest
(import, update, upsert, or delete) large datasets to your org, such as "data import bulk". The previously-run bulk
command must have completed; if it's still processing, run the corresponding resume command first, such as "data
import resume." Make note of the job ID of the previous bulk command because you use it to run this command.
You can also use this command to get results from running a bulk ingest job with a different tool, such as Data
Loader, as long as you have the job ID. For information on Data Loader, see
https://developer.salesforce.com/docs/atlas.en-us.dataLoader.meta/dataLoader/data_loader_intro.htm.
This command first displays the status of the previous bulk job, the operation that was executed in the org (such as
insert or hard delete), and the updated Salesforce object. The command then displays how many records were processed
in total, and how many were successful or failed. Finally, the output displays the names of the generated
CSV-formatted files that contain the specific results for each ingested record. Depending on the success or failure of
the bulk command, the results files can include the IDs of inserted records or the specific errors. When possible, if
the ingest job failed or was aborted, you also get a CSV file with the unprocessed results.
EXAMPLES
Get results from a bulk ingest job; use the org with alias "my-scratch":
$ sf data bulk results --job-id 7507i000fake341G --target-org my-scratch
```
_See code: [src/commands/data/bulk/results.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/bulk/results.ts)_
## `sf data create file`
Upload a local file to an org.
```
USAGE
$ sf data create file -o <value> -f <value> [--json] [--flags-dir <value>] [--api-version <value>] [-t <value>] [-i
<value>]
FLAGS
-f, --file=<value> (required) Path of file to upload.
-i, --parent-id=<value> ID of the record to attach the file to.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-t, --title=<value> New title given to the file (ContentDocument) after it's uploaded.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Upload a local file to an org.
This command always creates a new file in the org; you can't update an existing file. After a successful upload, the
command displays the ID of the new ContentDocument record which represents the uploaded file.
By default, the uploaded file isn't attached to a record; in the Salesforce UI the file shows up in the Files tab. You
can optionally attach the file to an existing record, such as an account, as long as you know its record ID.
You can also give the file a new name after it's been uploaded; by default its name in the org is the same as the
local file name.
EXAMPLES
Upload the local file "resources/astro.png" to your default org:
$ sf data create file --file resources/astro.png
Give the file a different filename after it's uploaded to the org with alias "my-scratch":
$ sf data create file --file resources/astro.png --title AstroOnABoat.png --target-org my-scratch
Attach the file to a record in the org:
$ sf data create file --file path/to/astro.png --parent-id a03fakeLoJWPIA3
```
_See code: [src/commands/data/create/file.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/create/file.ts)_
## `sf data create record`
Create and insert a record into a Salesforce or Tooling API object.
```
USAGE
$ sf data create record -o <value> -s <value> -v <value> [--json] [--flags-dir <value>] [--api-version <value>] [-t]
FLAGS
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that you're inserting a record
into.
-t, --use-tooling-api Use Tooling API so you can insert a record in a Tooling API object.
-v, --values=<value> (required) Values for the flags in the form <fieldName>=<value>, separate multiple pairs
with spaces.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Create and insert a record into a Salesforce or Tooling API object.
You must specify a value for all required fields of the object.
When specifying fields, use the format <fieldName>=<value>. Enclose all field-value pairs in one set of double
quotation marks, delimited by spaces. Enclose values that contain spaces in single quotes.
This command inserts a record into Salesforce objects by default. Use the --use-tooling-api flag to insert into a
Tooling API object.
ALIASES
$ sf force data record create
EXAMPLES
Insert a record into the Account object of your default org; only the required Name field has a value:
$ sf data create record --sobject Account --values "Name=Acme"
Insert an Account record with values for two fields, one value contains a space; the command uses the org with alias
"my-scratch":
$ sf data create record --sobject Account --values "Name='Universal Containers' Website=www.example.com" \
--target-org my-scratch
Insert a record into the Tooling API object TraceFlag:
$ sf data create record --use-tooling-api --sobject TraceFlag --values "DebugLevelId=7dl170000008U36AAE \
StartDate=2022-12-15T00:26:04.000+0000 ExpirationDate=2022-12-15T00:56:04.000+0000 LogType=CLASS_TRACING \
TracedEntityId=01p17000000R6bLAAS"
```
_See code: [src/commands/data/create/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/create/record.ts)_
## `sf data delete bulk`
Bulk delete records from an org using a CSV file. Uses Bulk API 2.0.
```
USAGE
$ sf data delete bulk -o <value> -s <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w <value>]
(--line-ending CRLF|LF -f <value>) [--hard-delete]
FLAGS
-f, --file=<value> (required) CSV file that contains the IDs of the records to update or delete.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
update or delete records from.
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for the command to complete before
displaying the results.
--api-version=<value> Override the api version used for api requests made by this command
--hard-delete Mark the records as immediately eligible for deletion by your org. If you don't specify
this flag, the deleted records go into the Recycle Bin.
--line-ending=<option> Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux
it's `LF`.
<options: CRLF|LF>
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Bulk delete records from an org using a CSV file. Uses Bulk API 2.0.
The CSV file must have only one column ("Id") and then the list of record IDs you want to delete, one ID per line.
When you execute this command, it starts a job, displays the ID, 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 ID to check the status of the job with the "sf data delete resume" command.
EXAMPLES
Bulk delete Account records from your default org using the list of IDs in the "files/delete.csv" file:
$ sf data delete bulk --sobject Account --file files/delete.csv
Bulk delete records from a custom object in an org with alias my-scratch and wait 5 minutes for the command to
complete:
$ sf data delete bulk --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
FLAG DESCRIPTIONS
--hard-delete
Mark the records as immediately eligible for deletion by your org. If you don't specify this flag, the deleted
records go into the Recycle Bin.
You must have the "Bulk API Hard Delete" system permission to use this flag. The permission is disabled by default
and can be enabled only by a system administrator.
```
_See code: [src/commands/data/delete/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/delete/bulk.ts)_
## `sf data delete record`
Deletes a single record from a Salesforce or Tooling API object.
```
USAGE
$ sf data delete record -o <value> -s <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>] [-w
<value>] [-t]
FLAGS
-i, --record-id=<value> ID of the record you’re deleting.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that you're deleting a record
from.
-t, --use-tooling-api Use Tooling API so you can delete a record from a Tooling API object.
-w, --where=<value> List of <fieldName>=<value> pairs that identify the record you want to delete.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Deletes a single record from a Salesforce or Tooling API object.
Specify the record you want to delete with either its ID or with a list of field-value pairs that identify the record.
If your list of fields identifies more than one record, the delete fails; the error displays how many records were
found.
When specifying field-value pairs, use the format <fieldName>=<value>. Enclose all field-value pairs in one set of
double quotation marks, delimited by spaces. Enclose values that contain spaces in single quotes.
This command deletes a record from Salesforce objects by default. Use the --use-tooling-api flag to delete from a
Tooling API object.
ALIASES
$ sf force data record delete
EXAMPLES
Delete a record from Account with the specified (truncated) ID:
$ sf data delete record --sobject Account --record-id 00180XX
Delete a record from Account whose name equals "Acme":
$ sf data delete record --sobject Account --where "Name=Acme"
Delete a record from Account identified with two field values, one that contains a space; the command uses the org
with alias "my-scratch":
$ sf data delete record --sobject Account --where "Name='Universal Containers' Phone='(123) 456-7890'" \
--target-org myscratch
Delete a record from the Tooling API object TraceFlag with the specified (truncated) ID:
$ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
```
_See code: [src/commands/data/delete/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/delete/record.ts)_
## `sf data delete resume`
Resume a bulk delete job that you previously started. Uses Bulk API 2.0.
```
USAGE
$ sf data delete resume [--json] [--flags-dir <value>] [-o <value>] [--use-most-recent | -i <value>] [--wait <value>]
[--api-version <value>]
FLAGS
-i, --job-id=<value> ID of the job you want to resume.
-o, --target-org=<value> Username or alias of the target org. Not required if the "target-org" configuration
variable is already set.
--api-version=<value> Override the api version used for api requests made by this command
--use-most-recent Use the ID of the most recently-run bulk job.
--wait=<value> [default: 5 minutes] Number of minutes to wait for the command to complete before
displaying the results.
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Resume a bulk delete job that you previously started. Uses Bulk API 2.0.
The command uses the job ID returned by the "sf data delete bulk" command or the most recently-run bulk delete job.
EXAMPLES
Resume a bulk delete job from your default org using an ID:
$ sf data delete resume --job-id 750xx000000005sAAA
Resume the most recently run bulk delete job for an org with alias my-scratch:
$ sf data delete resume --use-most-recent --target-org my-scratch
```
_See code: [src/commands/data/delete/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/delete/resume.ts)_
## `sf data export bulk`
Bulk export records from an org into a file using a SOQL query. Uses Bulk API 2.0.
```
USAGE
$ sf data export bulk -o <value> --output-file <value> -r csv|json [--json] [--flags-dir <value>] [--api-version
<value>] [-w <minutes>] [-q <value> | --query-file <value>] [--all-rows] [--column-delimiter
BACKQUOTE|CARET|COMMA|PIPE|SEMICOLON|TAB] [--line-ending LF|CRLF]
FLAGS
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-q, --query=<value> SOQL query to execute.
-r, --result-format=<option> (required) [default: csv] Format to write the results.
<options: csv|json>
-w, --wait=<minutes> Time to wait for the command to finish, in minutes.
--all-rows Include records that have been soft-deleted due to a merge or delete. By default,
deleted records are not returned.
--api-version=<value> Override the api version used for api requests made by this command
--column-delimiter=<option> Column delimiter to be used when writing CSV output. Default is COMMA.
<options: BACKQUOTE|CARET|COMMA|PIPE|SEMICOLON|TAB>
--line-ending=<option> Line ending to be used when writing CSV output. Default value on Windows is is
`CRLF`; on macOS and Linux it's `LR`.
<options: LF|CRLF>
--output-file=<value> (required) File where records are written.
--query-file=<value> File that contains the SOQL query.
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Bulk export records from an org into a file using a SOQL query. Uses Bulk API 2.0.
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).
EXAMPLES
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
```
_See code: [src/commands/data/export/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/export/bulk.ts)_
## `sf data export resume`
Resume a bulk export job that you previously started. Uses Bulk API 2.0.
```
USAGE
$ sf data export resume [--json] [--flags-dir <value>] [-i <value>] [--use-most-recent] [--api-version <value>]
FLAGS
-i, --job-id=<value> Job ID of the bulk export.
--api-version=<value> Override the api version used for api requests made by this command
--use-most-recent Use the job ID of the bulk export job that was most recently run.
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Resume a bulk export job that you previously started. Uses Bulk API 2.0.
When the original "data export bulk" command times out, it displays a job ID. To see the status and get the results of
the bulk export, run this command by either passing it the job ID or using the --use-most-recent flag to specify the
most recent bulk export job.
Using either `--job-id` or `--use-most-recent` will properly resolve to the correct org where the bulk job was started
based on the cached data by "data export bulk".
EXAMPLES
Resume a bulk export job run by specifying a job ID:
$ sf data export resume --job-id 750xx000000005sAAA
Resume the most recently-run bulk export job:
$ sf data export resume --use-most-recent
```
_See code: [src/commands/data/export/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/export/resume.ts)_
## `sf data export tree`
Export data from an org into one or more JSON files.
```
USAGE
$ sf data export tree -o <value> -q <value>... [--json] [--flags-dir <value>] [--api-version <value>] [-p] [-x
<value>] [-d <value>]
FLAGS
-d, --output-dir=<value> Directory in which to generate the JSON files; default is current directory.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-p, --plan Generate multiple sObject tree files and a plan definition file for aggregated import.
-q, --query=<value>... (required) SOQL query, or filepath of a file that contains the query, to retrieve records.
-x, --prefix=<value> Prefix of generated files.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Export data from an org into one or more JSON files.
Specify a SOQL query, either directly at the command line or read from a file, to retrieve the data you want to
export. The exported data is written to JSON files in sObject tree format, which is a collection of nested,
parent-child records with a single root record. Use these JSON files to import data into an org with the "sf data
import tree" command.
If your SOQL query references multiple objects, the command generates a single JSON file by default. You can specify
the --plan flag to generate separate JSON files for each object and a plan definition file that aggregates them. You
then specify just this plan definition file when you import the data into an org.
The SOQL query can return a maximum of 2,000 records. For more information, see the REST API Developer Guide.
(https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm).
ALIASES
$ sf force data tree export
EXAMPLES
Export records retrieved with the specified SOQL query into a single JSON file in the current directory; the command
uses your default org:
$ sf data export tree --query "SELECT Id, Name, (SELECT Name, Address__c FROM Properties__r) FROM Broker__c"
Export data using a SOQL query in the "query.txt" file and generate JSON files for each object and a plan that
aggregates them:
$ sf data export tree --query query.txt --plan
Prepend "export-demo" before each generated file and generate the files in the "export-out" directory; run the
command on the org with alias "my-scratch":
$ sf data export tree --query query.txt --plan --prefix export-demo --output-dir export-out --target-org \
my-scratch
```
_See code: [src/commands/data/export/tree.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/export/tree.ts)_
## `sf data get record`
Retrieve and display a single record of a Salesforce or Tooling API object.
```
USAGE
$ sf data get record -o <value> -s <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>] [-w
<value>] [-t]
FLAGS
-i, --record-id=<value> ID of the record you’re retrieving.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that you're retrieving a record
from.
-t, --use-tooling-api Use Tooling API so you can retrieve a record from a Tooling API object.
-w, --where=<value> List of <fieldName>=<value> pairs that identify the record you want to display.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Retrieve and display a single record of a Salesforce or Tooling API object.
Specify the record you want to retrieve with either its ID or with a list of field-value pairs that identify the
record. If your list of fields identifies more than one record, the command fails; the error displays how many records
were found.
When specifying field-value pairs, use the format <fieldName>=<value>. Enclose all field-value pairs in one set of
double quotation marks, delimited by spaces. Enclose values that contain spaces in single quotes.
The command displays all the record's fields and their values, one field per terminal line. Fields with no values are
displayed as "null".
This command retrieves a record from Salesforce objects by default. Use the --use-tooling-api flag to retrieve from a
Tooling API object.
ALIASES
$ sf force data record get
EXAMPLES
Retrieve and display a record from Account with the specified (truncated) ID:
$ sf data get record --sobject Account --record-id 00180XX
Retrieve a record from Account whose name equals "Acme":
$ sf data get record --sobject Account --where "Name=Acme"
Retrieve a record from Account identified with two field values, one that contains a space; the command uses the org
with alias "my-scratch":
$ sf data get record --sobject Account --where "Name='Universal Containers' Phone='(123) 456-7890'" --target-org \
myscratch
Retrieve a record from the Tooling API object TraceFlag with the specified (truncated) ID:
$ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
```
_See code: [src/commands/data/get/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/get/record.ts)_
## `sf data import bulk`
Bulk import records into a Salesforce object from a CSV file. Uses Bulk API 2.0.
```
USAGE
$ sf data import bulk -s <value> -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w <value>]
(--line-ending CRLF|LF -f <value>) [--column-delimiter BACKQUOTE|CARET|COMMA|PIPE|SEMICOLON|TAB]
FLAGS
-f, --file=<value> (required) CSV file that contains the Salesforce object records you want to import.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, into which
you're importing records.
-w, --wait=<value> Time to wait for the command to finish, in minutes.
--api-version=<value> Override the api version used for api requests made by this command
--column-delimiter=<option> Column delimiter used in the CSV file.
<options: BACKQUOTE|CARET|COMMA|PIPE|SEMICOLON|TAB>
--line-ending=<option> Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and
Linux it's `LF`.
<options: CRLF|LF>
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Bulk import records into a Salesforce object from a CSV file. Uses Bulk API 2.0.
You can use this command to import millions of records into the object from a file in comma-separated values (CSV)
format.
All the records in the CSV file must be for the same Salesforce object. Specify the object with the `--sobject` flag.
Bulk imports can take a while, depending on how many records are in the CSV file. 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 import resume" and pass
the job ID to the --job-id flag.
For information and examples about how to prepare your CSV files, see "Prepare Data to Ingest" in the "Bulk API 2.0
and Bulk API Developer Guide"
(https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_prepare_data.htm).
EXAMPLES
Import Account records from a CSV-formatted file into an org with alias "my-scratch"; if the import doesn't complete
in 10 minutes, the command ends and displays a job ID:
$ sf data import bulk --file accounts.csv --sobject Account --wait 10 --target-org my-scratch
```
_See code: [src/commands/data/import/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/import/bulk.ts)_
## `sf data import resume`
Resume a bulk import job that you previously started. Uses Bulk API 2.0.
```
USAGE
$ sf data import resume [--json] [--flags-dir <value>] [--use-most-recent] [-i <value>] [-w <value>]
FLAGS
-i, --job-id=<value> Job ID of the bulk import.
-w, --wait=<value> [default: 5 minutes] Time to wait for the command to finish, in minutes.
--use-most-recent Use the job ID of the bulk import job that was most recently run.
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Resume a bulk import job that you previously started. Uses Bulk API 2.0.
When the original "sf data import bulk" command times out, it displays a job ID. To see the status and get the results
of the bulk import, run this command by either passing it the job ID or using the --use-most-recent flag to specify
the most recent bulk import job.
EXAMPLES
Resume a bulk import job to your default org using an ID:
$ sf data import resume --job-id 750xx000000005sAAA
Resume the most recently run bulk import job for an org with alias my-scratch:
$ sf data import resume --use-most-recent --target-org my-scratch
```
_See code: [src/commands/data/import/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/import/resume.ts)_
## `sf data import tree`
Import data from one or more JSON files into an org.
```
USAGE
$ sf data import tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>...] [-p <value>]
FLAGS
-f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
that you want to insert.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-p, --plan=<value> Plan definition file to insert multiple data files.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Import data from one or more JSON files into an org.
The JSON files that contain the data are in sObject tree format, which is a collection of nested, parent-child records
with a single root record. Use the "sf data export tree" command to generate these JSON files.
If you used the --plan flag when exporting the data to generate a plan definition file, use the --plan flag to
reference the file when you import. If you're not using a plan, use the --files flag to list the files. If you specify
multiple JSON files that depend on each other in a parent-child relationship, be sure you list them in the correct
order.
ALIASES
$ sf force data tree import
EXAMPLES
Import the records contained in two JSON files into the org with alias "my-scratch":
$ sf data import tree --files Contact.json,Account.json --target-org my-scratch
Import records using a plan definition file into your default org:
$ sf data import tree --plan Account-Contact-plan.json
FLAG DESCRIPTIONS
-p, --plan=<value> Plan definition file to insert multiple data files.
Unlike when you use the `--files` flag, the files listed in the plan definition file **can** contain more then 200
records. When the CLI executes the import, it automatically batches the records to comply with the 200 record limit
set by the API.
The order in which you list the files in the plan definition file matters. Specifically, records with lookups to
records in another file should be listed AFTER that file. For example, let's say you're loading Account and Contact
records, and the contacts have references to those accounts. Be sure you list the Accounts file before the Contacts
file.
The plan definition file has the following schema:
- items(object) - SObject Type: Definition of records to be insert per SObject Type
- sobject(string) - Name of SObject: Child file references must have SObject roots of this type
- files(array) - Files: An array of files paths to load
```
_See code: [src/commands/data/import/tree.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/import/tree.ts)_
## `sf data query`
Execute a SOQL query.
```
USAGE
$ sf data query -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-q <value>] [-f <value>]
[-t] [--all-rows] [-r human|csv|json] [--output-file <value>]
FLAGS
-f, --file=<value> File that contains the SOQL query.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-q, --query=<value> SOQL query to execute.
-r, --result-format=<option> [default: human] Format to display the results; the --json flag overrides this flag.
<options: human|csv|json>
-t, --use-tooling-api Use Tooling API so you can run queries on Tooling API objects.
--all-rows Include deleted records. By default, deleted records are not returned.
--api-version=<value> Override the api version used for api requests made by this command
--output-file=<value> File where records are written; only CSV and JSON output formats are supported.
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Execute a SOQL query.
Specify the SOQL query at the command line with the --query flag or read the query from a file with the --file flag.
If your query returns more than 10,000 records, prefer to use the `sf data export bulk` command instead. It runs the
query using Bulk API 2.0, which has higher limits than the default API used by the command.
ALIASES
$ sf force data soql query
EXAMPLES
Specify a SOQL query at the command line; the command uses your default org:
$ sf data query --query "SELECT Id, Name, Account.Name FROM Contact"
Read the SOQL query from a file called "query.txt" and write the CSV-formatted output to a file; the command uses
the org with alias "my-scratch":
$ sf data query --file query.txt --output-file output.csv --result-format csv --target-org my-scratch
Use Tooling API to run a query on the ApexTrigger Tooling API object:
$ sf data query --query "SELECT Name FROM ApexTrigger" --use-tooling-api
```
_See code: [src/commands/data/query.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/query.ts)_
## `sf data resume`
View the status of a bulk data load job or batch.
```
USAGE
$ sf data resume -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>] [-b <value>]
FLAGS
-b, --batch-id=<value> ID of the batch whose status you want to view; you must also specify the job ID.
-i, --job-id=<value> (required) ID of the job whose status you want to view.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
View the status of a bulk data load job or batch.
Run this command using the job ID or batch ID returned from the "sf data delete bulk" or "sf data upsert bulk"
commands.
EXAMPLES
View the status of a bulk load job:
$ sf data resume --job-id 750xx000000005sAAA
View the status of a bulk load job and a specific batches:
$ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
```
_See code: [src/commands/data/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/resume.ts)_
## `sf data search`
Execute a SOSL text-based search query.
```
USAGE
$ sf data search -o <value> [--flags-dir <value>] [--api-version <value>] [-q <value>] [-f <value>] [-r
human|csv|json | --json]
FLAGS
-f, --file=<value> File that contains the SOSL query.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-q, --query=<value> SOSL query to execute.
-r, --result-format=<option> [default: human] Format to display the results, or to write to disk if you specify
"csv".
<options: human|csv|json>
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Execute a SOSL text-based search query.
Specify the SOSL query at the command line with the --query flag or read the query from a file with the --file flag.
By default, the results are written to the terminal in human-readable format. If you specify `--result-format csv`,
the output is written to one or more CSV (comma-separated values) files. The file names correspond to the Salesforce
objects in the results, such as Account.csv. Both `--result-format human` and `--result-format json` display only to
the terminal.
EXAMPLES
Specify a SOSL query at the command line; the command uses your default org:
$ sf data search --query "FIND {Anna Jones} IN Name Fields RETURNING Contact (Name, Phone)"
Read the SOSL query from a file called "query.txt"; the command uses the org with alias "my-scratch":
$ sf data search --file query.txt --target-org my-scratch
Similar to the previous example, but write the results to one or more CSV files, depending on the Salesforce objects
in the results:
$ sf data search --file query.txt --target-org my-scratch --result-format csv
```
_See code: [src/commands/data/search.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/search.ts)_
## `sf data update bulk`
Bulk update records to an org from a CSV file. Uses Bulk API 2.0.
```
USAGE
$ sf data update bulk -s <value> -o <value> [--json] [--flags-dir <value>] [-w <value>] [--api-version <value>]
(--line-ending CRLF|LF -f <value>) [--column-delimiter BACKQUOTE|CARET|COMMA|PIPE|SEMICOLON|TAB]
FLAGS
-f, --file=<value> (required) CSV file that contains the Salesforce object records you want to update.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, which you
are updating.
-w, --wait=<value> Time to wait for the command to finish, in minutes.
--api-version=<value> Override the api version used for api requests made by this command
--column-delimiter=<option> Column delimiter used in the CSV file.
<options: BACKQUOTE|CARET|COMMA|PIPE|SEMICOLON|TAB>
--line-ending=<option> Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and
Linux it's `LF`.
<options: CRLF|LF>
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Bulk update records to an org from a CSV file. Uses Bulk API 2.0.
You can use this command to update millions of Salesforce object records based on a file in comma-separated values
(CSV) format.
All the records in the CSV file must be for the same Salesforce object. Specify the object with the `--sobject` flag.
The first column of every line in the CSV file must be an ID of the record you want to update. The CSV file can
contain only existing records; if a record in the file doesn't currently exist in the Salesforce object, the command
fails. Consider using "sf data upsert bulk" if you also want to insert new records.
Bulk updates can take a while, depending on how many records are in the CSV file. 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 update resume" and pass
the job ID to the --job-id flag.
For information and examples about how to prepare your CSV files, see "Prepare Data to Ingest" in the "Bulk API 2.0
and Bulk API Developer Guide"
(https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_prepare_data.htm).
EXAMPLES
Update Account records from a CSV-formatted file into an org with alias "my-scratch"; if the update doesn't complete
in 10 minutes, the command ends and displays a job ID:
$ sf data update bulk --file accounts.csv --sobject Account --wait 10 --target-org my-scratch
```
_See code: [src/commands/data/update/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/update/bulk.ts)_
## `sf data update record`
Updates a single record of a Salesforce or Tooling API object.
```
USAGE
$ sf data update record -o <value> -s <value> -v <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i
<value>] [-w <value>] [-t]
FLAGS
-i, --record-id=<value> ID of the record you’re updating.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that contains the record you're
updating.
-t, --use-tooling-api Use Tooling API so you can update a record in a Tooling API object.
-v, --values=<value> (required) Fields that you're updating, in the format of <fieldName>=<value> pairs.
-w, --where=<value> List of <fieldName>=<value> pairs that identify the record you want to update.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Updates a single record of a Salesforce or Tooling API object.
Specify the record you want to update with either its ID or with a list of field-value pairs that identify the record.
If your list of fields identifies more than one record, the update fails; the error displays how many records were
found.
When using field-value pairs for both identifying the record and specifiyng the new field values, use the format
<fieldName>=<value>. Enclose all field-value pairs in one set of double quotation marks, delimited by spaces. Enclose
values that contain spaces in single quotes.
This command updates a record in Salesforce objects by default. Use the --use-tooling-api flag to update a Tooling API
object.
ALIASES
$ sf force data record update
EXAMPLES
Update the Name field of an Account record with the specified (truncated) ID:
$ sf data update record --sobject Account --record-id 001D0 --values "Name=NewAcme"
Update the Name field of an Account record whose current name is 'Old Acme':
$ sf data update record --sobject Account --where "Name='Old Acme'" --values "Name='New Acme'"
Update the Name and Website fields of an Account record with the specified (truncated) ID:
$ sf data update record --sobject Account --record-id 001D0 --values "Name='Acme III' Website=www.example.com"
Update the ExpirationDate field of a record of the Tooling API object TraceFlag using the specified (truncated) ID:
$ sf data update record -t --sobject TraceFlag --record-id 7tf170000009cUBAAY --values \
"ExpirationDate=2017-12-01T00:58:04.000+0000"
```
_See code: [src/commands/data/update/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.60/src/commands/data/update/record.ts)_
## `sf data update resume`
Resume a bulk update job that you previously started. Uses Bulk API 2.0.
```
USAGE
$ sf data update resume [--json] [--flags-dir <value>] [--use-most-recent] [-i <value>] [-w <value>]
FLAGS
-i, --job-id=<value> Job ID of the bulk update.
-w, --wait=<value> [default: 5 minutes] Time to wait for the command to finish, in minutes.
--use-most-recent Use the job ID of the bulk update job that was most recently run.
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Resume a bulk update job that you previously started. Uses Bulk API 2.0.
When the original "sf data update bulk" command times out, it displays a job ID. To see the status and get the results
of the bulk update, run this command by either passing it the job ID or using the --use-most-recent flag to specify
the most recent bulk update job.
Using either `--job-id` or `--use-most-recent` will properly resolve to the correct org where the bulk job was started
based on the cached data by "data update bulk".
EXAMPLES
Resume a bulk update job using a job ID:
$ sf data update resume --job-id 750xx000000005sAAA
Resume the most recently run