@salesforce/plugin-data
Plugin for salesforce data commands
Last updated a month ago by
salesforce-releases .
BSD-3-Clause ·
Repository ·
Bugs ·
Original npm ·
Tarball ·
package.json
$ cnpm install @salesforce/plugin-data
SYNC missed versions from
official npm registry.
plugin-data
data commands for Salesforce CLI.
This plugin is bundled with the Salesforce CLI. For more information on the CLI, read the getting started guide.
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
sfdx plugins:install data@x.y.z
Issues
Please report any issues at https://github.com/forcedotcom/cli/issues
Contributing
- Please read our Code of Conduct
- 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.
- Fork this repository.
- Build the plugin locally
- Create a topic branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
- Edit the code in your fork.
- 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.
- Sign CLA (see CLA below).
- 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:
# 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/run or ./bin/run.cmd file.
# Run using local run file.
./bin/run 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.
# Link your plugin to the sfdx cli
sfdx plugins:link .
# To verify
sfdx plugins
Commands
sfdx force:data:record:create -s <string> -v <string> [-t] [--perflog] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:data:record:delete -s <string> [-i <id>] [-w <string>] [-t] [--perflog] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:data:record:get -s <string> [-i <id>] [-w <string>] [-t] [--perflog] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:data:record:update -s <string> -v <string> [-i <id>] [-w <string>] [-t] [--perflog] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx force:data:record:create -s <string> -v <string> [-t] [--perflog] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
creates and inserts a record
USAGE
$ sfdx force:data:record:create -s <string> -v <string> [-t] [--perflog] [-u <string>] [--apiversion <string>]
[--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-s, --sobjecttype=sobjecttype (required) the type of the record
you’re creating
-t, --usetoolingapi create the record with tooling api
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-v, --values=values (required) the <fieldName>=<value>
pairs you’re creating
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--perflog get API performance data
DESCRIPTION
The format of a field-value pair is <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.
To get data on API performance metrics, specify both --perflog and --json.
EXAMPLES
sfdx force:data:record:create -s Account -v "Name=Acme"
sfdx force:data:record:create -s Account -v "Name='Universal Containers'"
sfdx force:data:record:create -s Account -v "Name='Universal Containers' Website=www.example.com"
sfdx force:data:record:create -t -s TraceFlag -v "DebugLevelId=7dl170000008U36AAE
StartDate=2017-12-01T00:26:04.000+0000 ExpirationDate=2017-12-01T00:56:04.000+0000 LogType=CLASS_TRACING
TracedEntityId=01p17000000R6bLAAS"
sfdx force:data:record:create -s Account -v "Name=Acme" --perflog --json
See code: src/commands/force/data/record/create.ts
sfdx force:data:record:delete -s <string> [-i <id>] [-w <string>] [-t] [--perflog] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
deletes a single record
USAGE
$ sfdx force:data:record:delete -s <string> [-i <id>] [-w <string>] [-t] [--perflog] [-u <string>] [--apiversion
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-i, --sobjectid=sobjectid the ID of the record you’re deleting
-s, --sobjecttype=sobjecttype (required) the type of the record
you’re deleting
-t, --usetoolingapi delete the record with Tooling API
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-w, --where=where a list of <fieldName>=<value> pairs
to search for
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--perflog get API performance data
DESCRIPTION
Specify an sObject type and either an ID or a list of <fieldName>=<value> pairs.
The format of a field-value pair is <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.
To get data on API performance metrics, specify both --perflog and --json.
EXAMPLES
sfdx force:data:record:delete -s Account -i 001D000000Kv3dl
sfdx force:data:record:delete -s Account -w "Name=Acme"
sfdx force:data:record:delete -s Account -w "Name='Universal Containers'"
sfdx force:data:record:delete -s Account -w "Name='Universal Containers' Phone='(123) 456-7890'"
sfdx force:data:record:delete -t -s TraceFlag -i 7tf170000009cU6AAI --perflog --json
See code: src/commands/force/data/record/delete.ts
sfdx force:data:record:get -s <string> [-i <id>] [-w <string>] [-t] [--perflog] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
displays a single record
USAGE
$ sfdx force:data:record:get -s <string> [-i <id>] [-w <string>] [-t] [--perflog] [-u <string>] [--apiversion
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-i, --sobjectid=sobjectid the ID of the record you’re
retrieving
-s, --sobjecttype=sobjecttype (required) the type of the record
you’re retrieving
-t, --usetoolingapi retrieve the record with Tooling API
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-w, --where=where a list of <fieldName>=<value> pairs
to search for
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--perflog get API performance data
DESCRIPTION
Specify an sObject type and either an ID or a list of <fieldName>=<value> pairs.
The format of a field-value pair is <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.
To get data on API performance metrics, specify both --perflog and --json.
EXAMPLES
sfdx force:data:record:get -s Account -i 001D000000Kv3dl
sfdx force:data:record:get -s Account -w "Name=Acme"
sfdx force:data:record:get -s Account -w "Name='Universal Containers'"
sfdx force:data:record:get -s Account -w "Name='Universal Containers' Phone='(123) 456-7890'"
sfdx force:data:record:get -t -s TraceFlag -i 7tf170000009cUBAAY --perflog --json
See code: src/commands/force/data/record/get.ts
sfdx force:data:record:update -s <string> -v <string> [-i <id>] [-w <string>] [-t] [--perflog] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
updates a single record
USAGE
$ sfdx force:data:record:update -s <string> -v <string> [-i <id>] [-w <string>] [-t] [--perflog] [-u <string>]
[--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-i, --sobjectid=sobjectid the ID of the record you’re updating
-s, --sobjecttype=sobjecttype (required) the sObject type of the
record you’re updating
-t, --usetoolingapi update the record with Tooling API
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-v, --values=values (required) the <fieldName>=<value>
pairs you’re updating
-w, --where=where a list of <fieldName>=<value> pairs
to search for
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--perflog get API performance data
DESCRIPTION
The format of a field-value pair is <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.
To get data on API performance metrics, specify both --perflog and --json.
EXAMPLES
sfdx force:data:record:update -s Account -i 001D000000Kv3dl -v "Name=NewAcme"
sfdx force:data:record:update -s Account -w "Name='Old Acme'" -v "Name='New Acme'"
sfdx force:data:record:update -s Account -i 001D000000Kv3dl -v "Name='Acme III' Website=www.example.com"
sfdx force:data:record:update -t -s TraceFlag -i 7tf170000009cUBAAY -v "ExpirationDate=2017-12-01T00:58:04.000+0000"
sfdx force:data:record:update -s Account -i 001D000000Kv3dl -v "Name=NewAcme" --perflog --json
See code: src/commands/force/data/record/update.ts
Current Tags
11 Versions
Maintainers (41)
amateurhuman 
amphro 
apapko 
brandonm 
byao 
cdias 
conal 
cwallsf 
davidturissini 
dehru 
dhagberg-sf 
diervo 
ekashida 
futuremint_sf 
gr8gatsby 
harshkothari410 
interactivellama 
jgraff 
jgrantham 
jleen-sfdc 
joshsimmons 
jqian 
kevinv11n 
khawkins 
kriscfoster 
krisgraysfdc 
maratto 
mpsenn 
pallavi.singh 
pmdartus 
rasphilco 
ravi.jayaramappa 
rsalvador 
salesforce-bot 
sfdc_iamigo 
smugakamil 
tausifm 
tbliss 
tconn 
vazexqi 
vineet-sinha
Downloads
Today
0
This Week
0
This Month
0
Last Day
0
Last Week
0
Last Month
45
Dependencies (6)
- @oclif/config ^1
- @salesforce/command ^3.0.3
- @salesforce/core ^2.13.0
- @salesforce/data ^0.1.1
- @salesforce/ts-types ^1.4.3
- tslib ^1
Dev Dependencies (25)
- @salesforce/dev-config ^2.0.0
- @salesforce/dev-scripts ^0.6.2
- @salesforce/prettier-config ^0.0.1
- @salesforce/ts-sinon ^1.2.3
- @typescript-eslint/eslint-plugin ^2.30.0
- @typescript-eslint/parser ^2.30.0
- chai ^4.2.0
- eslint ^6.8.0
- eslint-config-prettier ^6.11.0
- eslint-config-salesforce ^0.1.0
- eslint-config-salesforce-license ^0.1.0
- eslint-config-salesforce-typescript ^0.1.0
- eslint-plugin-header ^3.0.0
- eslint-plugin-import ^2.20.2
- eslint-plugin-jsdoc ^27.0.3
- eslint-plugin-prettier ^3.1.3
- husky ^4.2.5
- mocha ^7.2.0
- nyc ^15.1.0
- prettier ^2.0.5
- pretty-quick ^2.0.1
- shx ^0.3.3
- sinon ^9.0.2
- ts-node ^8.10.2
- typescript ^3.9.3
Dependents (0)
None