@salesforce/plugin-data 2.1.18 → 2.1.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.txt +1 -1
- package/oclif.manifest.json +1 -1
- package/package.json +8 -8
package/LICENSE.txt
CHANGED
package/oclif.manifest.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"2.1.18","commands":{"force:data:bulk:delete":{"id":"force:data:bulk:delete","description":"bulk delete records from a csv file\nThe file must be a CSV file with only one column: \"Id\".\nOne job can contain many batches, depending on the length of the CSV file.\nReturns a job ID and a batch ID. Use these IDs to check job status with data:bulk:status.\n\n","strict":true,"usage":"<%= command.id %> -f <filepath> -s <string> [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"examples":["$ sfdx force:data:bulk:delete -s Account -f ./path/to/file.csv","$ sfdx force:data:bulk:delete -s MyObject__c -f ./path/to/file.csv"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"csvfile":{"name":"csvfile","type":"option","char":"f","description":"the path to the CSV file containing the ids of the records to delete","required":true,"multiple":false},"sobjecttype":{"name":"sobjecttype","type":"option","char":"s","description":"the sObject type of the records you’re deleting","required":true,"multiple":false},"wait":{"name":"wait","type":"option","char":"w","description":"the number of minutes to wait for the command to complete before displaying the results","multiple":false}},"args":[],"requiresUsername":true,"flagsConfig":{"csvfile":{"kind":"filepath","char":"f","description":"the path to the CSV file containing the ids of the records to delete","required":true,"input":[],"multiple":false,"type":"option"},"sobjecttype":{"kind":"string","char":"s","description":"the sObject type of the records you’re deleting","required":true,"input":[],"multiple":false,"type":"option"},"wait":{"kind":"minutes","char":"w","description":"the number of minutes to wait for the command to complete before displaying the results","min":0,"input":[],"multiple":false,"type":"option"}}},"force:data:bulk:status":{"id":"force:data:bulk:status","description":"view the status of a bulk data load job or batch\nRun this command using the job ID or batch ID returned from the force:data:bulk:delete or force:data:bulk:upsert commands.","strict":true,"usage":"<%= command.id %> -i <string> [-b <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"examples":["$ sfdx force:data:bulk:status -i 750xx000000005sAAA","$ sfdx force:data:bulk:status -i 750xx000000005sAAA -b 751xx000000005nAAA"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"batchid":{"name":"batchid","type":"option","char":"b","description":"the ID of the batch whose status you want to view","multiple":false},"jobid":{"name":"jobid","type":"option","char":"i","description":"the ID of the job you want to view or of the job whose batch you want to view","required":true,"multiple":false}},"args":[],"requiresUsername":true,"flagsConfig":{"batchid":{"kind":"string","char":"b","description":"the ID of the batch whose status you want to view","input":[],"multiple":false,"type":"option"},"jobid":{"kind":"string","char":"i","description":"the ID of the job you want to view or of the job whose batch you want to view","required":true,"input":[],"multiple":false,"type":"option"}}},"force:data:bulk:upsert":{"id":"force:data:bulk:upsert","description":"bulk upsert records from a CSV file\nInserts or updates records from a CSV file.\n\nOne job can contain many batches, depending on the length of the CSV file.\nReturns a job ID and a batch ID. Use these IDs to check job status with data:bulk:status.\n\nFor information about formatting your CSV file, see \"Prepare CSV Files\" in the Bulk API Developer Guide. \n\nBy default, the job runs the batches in parallel. Specify --serial to run them serially.","strict":true,"usage":"<%= command.id %> -i <string> -f <filepath> -s <string> [-w <minutes>] [-r] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"examples":["$ sfdx force:data:bulk:upsert -s MyObject__c -f ./path/to/file.csv -i MyField__c","$ sfdx force:data:bulk:upsert -s MyObject__c -f ./path/to/file.csv -i Id -w 2"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"externalid":{"name":"externalid","type":"option","char":"i","description":"the column name of the external ID","required":true,"multiple":false},"csvfile":{"name":"csvfile","type":"option","char":"f","description":"the path to the CSV file that defines the records to upsert","required":true,"multiple":false},"sobjecttype":{"name":"sobjecttype","type":"option","char":"s","description":"the sObject type of the records you want to upsert","required":true,"multiple":false},"wait":{"name":"wait","type":"option","char":"w","description":"the number of minutes to wait for the command to complete before displaying the results","multiple":false},"serial":{"name":"serial","type":"boolean","char":"r","description":"run batches in serial mode","allowNo":false}},"args":[],"requiresUsername":true,"flagsConfig":{"externalid":{"kind":"string","char":"i","description":"the column name of the external ID","required":true,"input":[],"multiple":false,"type":"option"},"csvfile":{"kind":"filepath","char":"f","description":"the path to the CSV file that defines the records to upsert","required":true,"input":[],"multiple":false,"type":"option"},"sobjecttype":{"kind":"string","char":"s","description":"the sObject type of the records you want to upsert","required":true,"input":[],"multiple":false,"type":"option"},"wait":{"kind":"minutes","char":"w","description":"the number of minutes to wait for the command to complete before displaying the results","min":0,"input":[],"multiple":false,"type":"option"},"serial":{"kind":"boolean","char":"r","description":"run batches in serial mode","default":false,"allowNo":false,"type":"boolean"}}},"force:data:record:create":{"id":"force:data:record:create","description":"creates and inserts a record\nThe format of a field-value pair is <fieldName>=<value>.\nEnclose all field-value pairs in one set of double quotation marks, delimited by spaces.\nEnclose values that contain spaces in single quotes.\n\nTo get data on API performance metrics, specify both --perflog and --json.","strict":true,"usage":"<%= command.id %> -s <string> -v <string> [-t] [--perflog --json] [-u <string>] [--apiversion <string>] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"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"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"sobjecttype":{"name":"sobjecttype","type":"option","char":"s","description":"the type of the record you’re creating","required":true,"multiple":false},"values":{"name":"values","type":"option","char":"v","description":"the <fieldName>=<value> pairs you’re creating","required":true,"multiple":false},"usetoolingapi":{"name":"usetoolingapi","type":"boolean","char":"t","description":"create the record with tooling api","allowNo":false},"perflog":{"name":"perflog","type":"boolean","description":"get API performance data","allowNo":false,"dependsOn":["json"]}},"args":[],"requiresUsername":true,"flagsConfig":{"sobjecttype":{"kind":"string","char":"s","required":true,"description":"the type of the record you’re creating","input":[],"multiple":false,"type":"option"},"values":{"kind":"string","char":"v","required":true,"description":"the <fieldName>=<value> pairs you’re creating","input":[],"multiple":false,"type":"option"},"usetoolingapi":{"kind":"boolean","char":"t","description":"create the record with tooling api","allowNo":false,"type":"boolean"},"perflog":{"kind":"boolean","description":"get API performance data","dependsOn":["json"],"allowNo":false,"type":"boolean"}}},"force:data:record:delete":{"id":"force:data:record:delete","description":"deletes a single record\nSpecify an sObject type and either an ID or a list of <fieldName>=<value> pairs.\nThe format of a field-value pair is <fieldName>=<value>.\nEnclose all field-value pairs in one set of double quotation marks, delimited by spaces.\nEnclose values that contain spaces in single quotes.\n\nTo get data on API performance metrics, specify both --perflog and --json.","strict":true,"usage":"<%= command.id %> -s <string> [-i <id> | -w <string>] [-t] [--perflog --json] [-u <string>] [--apiversion <string>] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"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"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"sobjecttype":{"name":"sobjecttype","type":"option","char":"s","description":"the type of the record you’re deleting","required":true,"multiple":false},"sobjectid":{"name":"sobjectid","type":"option","char":"i","description":"the ID of the record you’re deleting","multiple":false,"exclusive":["where"]},"where":{"name":"where","type":"option","char":"w","description":"a list of <fieldName>=<value> pairs to search for","multiple":false,"exclusive":["sobjectid"]},"usetoolingapi":{"name":"usetoolingapi","type":"boolean","char":"t","description":"delete the record with Tooling API","allowNo":false},"perflog":{"name":"perflog","type":"boolean","description":"get API performance data","allowNo":false,"dependsOn":["json"]}},"args":[],"requiresUsername":true,"flagsConfig":{"sobjecttype":{"kind":"string","char":"s","required":true,"description":"the type of the record you’re deleting","input":[],"multiple":false,"type":"option"},"sobjectid":{"kind":"id","char":"i","description":"the ID of the record you’re deleting","exclusive":["where"],"input":[],"multiple":false,"type":"option"},"where":{"kind":"string","char":"w","description":"a list of <fieldName>=<value> pairs to search for","exclusive":["sobjectid"],"input":[],"multiple":false,"type":"option"},"usetoolingapi":{"kind":"boolean","char":"t","description":"delete the record with Tooling API","allowNo":false,"type":"boolean"},"perflog":{"kind":"boolean","description":"get API performance data","dependsOn":["json"],"allowNo":false,"type":"boolean"}}},"force:data:record:get":{"id":"force:data:record:get","description":"displays a single record\nSpecify an sObject type and either an ID or a list of <fieldName>=<value> pairs.\nThe format of a field-value pair is <fieldName>=<value>.\nEnclose all field-value pairs in one set of double quotation marks, delimited by spaces.\nEnclose values that contain spaces in single quotes.\n\nTo get data on API performance metrics, specify both --perflog and --json.","strict":true,"usage":"<%= command.id %> -s <string> [-i <id> | -w <string>] [-t] [--perflog --json] [-u <string>] [--apiversion <string>] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"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"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"sobjecttype":{"name":"sobjecttype","type":"option","char":"s","description":"the type of the record you’re retrieving","required":true,"multiple":false},"sobjectid":{"name":"sobjectid","type":"option","char":"i","description":"the ID of the record you’re retrieving","multiple":false,"exclusive":["where"]},"where":{"name":"where","type":"option","char":"w","description":"a list of <fieldName>=<value> pairs to search for","multiple":false,"exclusive":["sobjectid"]},"usetoolingapi":{"name":"usetoolingapi","type":"boolean","char":"t","description":"retrieve the record with Tooling API","allowNo":false},"perflog":{"name":"perflog","type":"boolean","description":"get API performance data","allowNo":false,"dependsOn":["json"]}},"args":[],"requiresUsername":true,"flagsConfig":{"sobjecttype":{"kind":"string","char":"s","required":true,"description":"the type of the record you’re retrieving","input":[],"multiple":false,"type":"option"},"sobjectid":{"kind":"id","char":"i","description":"the ID of the record you’re retrieving","exclusive":["where"],"input":[],"multiple":false,"type":"option"},"where":{"kind":"string","char":"w","description":"a list of <fieldName>=<value> pairs to search for","exclusive":["sobjectid"],"input":[],"multiple":false,"type":"option"},"usetoolingapi":{"kind":"boolean","char":"t","description":"retrieve the record with Tooling API","allowNo":false,"type":"boolean"},"perflog":{"kind":"boolean","description":"get API performance data","dependsOn":["json"],"allowNo":false,"type":"boolean"}}},"force:data:record:update":{"id":"force:data:record:update","description":"updates a single record\nThe format of a field-value pair is <fieldName>=<value>.\nEnclose all field-value pairs in one set of double quotation marks, delimited by spaces.\nEnclose values that contain spaces in single quotes.\n\nTo get data on API performance metrics, specify both --perflog and --json.","strict":true,"usage":"<%= command.id %> -s <string> -v <string> [-i <id> | -w <string>] [-t] [--perflog --json] [-u <string>] [--apiversion <string>] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"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"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"sobjecttype":{"name":"sobjecttype","type":"option","char":"s","description":"the sObject type of the record you’re updating","required":true,"multiple":false},"sobjectid":{"name":"sobjectid","type":"option","char":"i","description":"the ID of the record you’re updating","multiple":false,"exclusive":["where"]},"where":{"name":"where","type":"option","char":"w","description":"a list of <fieldName>=<value> pairs to search for","multiple":false,"exclusive":["sobjectid"]},"values":{"name":"values","type":"option","char":"v","description":"the <fieldName>=<value> pairs you’re updating","required":true,"multiple":false},"usetoolingapi":{"name":"usetoolingapi","type":"boolean","char":"t","description":"update the record with Tooling API","allowNo":false},"perflog":{"name":"perflog","type":"boolean","description":"get API performance data","allowNo":false,"dependsOn":["json"]}},"args":[],"requiresUsername":true,"flagsConfig":{"sobjecttype":{"kind":"string","char":"s","required":true,"description":"the sObject type of the record you’re updating","input":[],"multiple":false,"type":"option"},"sobjectid":{"kind":"id","char":"i","description":"the ID of the record you’re updating","exclusive":["where"],"input":[],"multiple":false,"type":"option"},"where":{"kind":"string","char":"w","description":"a list of <fieldName>=<value> pairs to search for","exclusive":["sobjectid"],"input":[],"multiple":false,"type":"option"},"values":{"kind":"string","char":"v","required":true,"description":"the <fieldName>=<value> pairs you’re updating","input":[],"multiple":false,"type":"option"},"usetoolingapi":{"kind":"boolean","char":"t","description":"update the record with Tooling API","allowNo":false,"type":"boolean"},"perflog":{"kind":"boolean","description":"get API performance data","dependsOn":["json"],"allowNo":false,"type":"boolean"}}},"force:data:soql:query":{"id":"force:data:soql:query","description":"execute a SOQL query\nWhen you execute this command in a project, it executes the query against the data in your default scratch org.\n\nTo get data on API performance metrics, specify both --perflog and --json.\n\n","strict":true,"usage":"<%= command.id %> [-q <string> | -f <filepath>] [-w <minutes> [-b | -t]] [-r human|csv|json] [--perflog --json] [-u <string>] [--apiversion <string>] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"examples":["$ sfdx force:data:soql:query -q \"SELECT Id, Name, Account.Name FROM Contact\"","$ sfdx force:data:soql:query -q \"SELECT Id, Name FROM Account WHERE ShippingState IN ('CA', 'NY')\"","$ sfdx force:data:soql:query -q \"SELECT Id, Name FROM Account WHERE ShippingState IN ('CA', 'NY')\" --perflog --json","$ sfdx force:data:soql:query -q \"SELECT Name FROM ApexTrigger\" -t","$ sfdx force:data:soql:query --soqlqueryfile query.txt","$ sfdx force:data:soql:query --soqlqueryfile query.txt -t"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"query":{"name":"query","type":"option","char":"q","description":"SOQL query to execute","multiple":false,"exclusive":["soqlqueryfile"]},"soqlqueryfile":{"name":"soqlqueryfile","type":"option","char":"f","description":"A SOQL query stored in a file","multiple":false,"exclusive":["query"]},"usetoolingapi":{"name":"usetoolingapi","type":"boolean","char":"t","description":"execute query with Tooling API","allowNo":false},"bulk":{"name":"bulk","type":"boolean","char":"b","description":"use the bulk 2.0 API to query data","allowNo":false,"exclusive":["usetoolingapi"]},"wait":{"name":"wait","type":"option","char":"w","description":"wait time for command to finish in minutes","multiple":false,"dependsOn":["bulk"]},"resultformat":{"name":"resultformat","type":"option","char":"r","description":"result format emitted to stdout; --json flag overrides this parameter","helpValue":"(human|csv|json)","multiple":false,"options":["human","csv","json"],"default":"human"},"perflog":{"name":"perflog","type":"boolean","description":"get API performance data","allowNo":false,"dependsOn":["json"]}},"args":[],"requiresUsername":true,"flagsConfig":{"query":{"kind":"string","char":"q","description":"SOQL query to execute","exclusive":["soqlqueryfile"],"exactlyOne":["query","soqlqueryfile"],"input":[],"multiple":false,"type":"option"},"soqlqueryfile":{"kind":"filepath","char":"f","description":"A SOQL query stored in a file","exclusive":["query"],"exactlyOne":["query","soqlqueryfile"],"input":[],"multiple":false,"type":"option"},"usetoolingapi":{"kind":"boolean","char":"t","description":"execute query with Tooling API","allowNo":false,"type":"boolean"},"bulk":{"kind":"boolean","char":"b","default":false,"description":"use the bulk 2.0 API to query data","exclusive":["usetoolingapi"],"allowNo":false,"type":"boolean"},"wait":{"kind":"minutes","char":"w","description":"wait time for command to finish in minutes","dependsOn":["bulk"],"input":[],"multiple":false,"type":"option"},"resultformat":{"kind":"enum","helpValue":"(human|csv|json)","char":"r","description":"result format emitted to stdout; --json flag overrides this parameter","options":["human","csv","json"],"default":"human","input":[],"multiple":false,"type":"option"},"perflog":{"kind":"boolean","description":"get API performance data","dependsOn":["json"],"allowNo":false,"type":"boolean"}}},"force:data:tree:export":{"id":"force:data:tree:export","description":"export data from an org\nExports data from an org into sObject tree format for use with the force:data:tree:import command.\nThe query for export 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","strict":true,"usage":"<%= command.id %> -q <string> [-p] [-x <string>] [-d <directory>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"examples":["$ sfdx force:data:tree:export -q \"SELECT Id, Name, (SELECT Name, Address__c FROM Properties__r) FROM Broker__c\"","$ sfdx force:data:tree:export -q <path to file containing soql query> -x export-demo -d /tmp/sfdx-out -p"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"query":{"name":"query","type":"option","char":"q","description":"soql query, or filepath of file containing a soql query, to retrieve records","required":true,"multiple":false},"plan":{"name":"plan","type":"boolean","char":"p","description":"generate mulitple sobject tree files and a plan definition file for aggregated import","allowNo":false},"prefix":{"name":"prefix","type":"option","char":"x","description":"prefix of generated files","multiple":false},"outputdir":{"name":"outputdir","type":"option","char":"d","description":"directory to store files'","multiple":false}},"args":[],"requiresUsername":true,"flagsConfig":{"query":{"kind":"string","char":"q","description":"soql query, or filepath of file containing a soql query, to retrieve records","required":true,"input":[],"multiple":false,"type":"option"},"plan":{"kind":"boolean","char":"p","description":"generate mulitple sobject tree files and a plan definition file for aggregated import","allowNo":false,"type":"boolean"},"prefix":{"kind":"string","char":"x","description":"prefix of generated files","input":[],"multiple":false,"type":"option"},"outputdir":{"kind":"directory","char":"d","description":"directory to store files'","input":[],"multiple":false,"type":"option"}}},"force:data:tree:import":{"id":"force:data:tree:import","description":"import data into an org\nIMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.\n\nImports data into an org using the SObject Tree Save API. This data can include master-detail relationships.\nTo generate JSON files for use with force:data:tree:import, run \"sfdx force:data:tree:export\".\nThe SObject Tree API supports requests that contain up to 200 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","strict":true,"usage":"<%= command.id %> [-f <array> | -p <filepath>] [--confighelp] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"examples":["$ sfdx force:data:tree:import -f Contact.json,Account.json -u me@my.org","$ sfdx force:data:tree:import -p Account-Contact-plan.json -u me@my.org"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"sobjecttreefiles":{"name":"sobjecttreefiles","type":"option","char":"f","description":"comma-delimited, ordered paths of json files containing collection of record trees to insert","multiple":false,"exclusive":["plan"]},"plan":{"name":"plan","type":"option","char":"p","description":"path to plan to insert multiple data files that have master-detail relationships","multiple":false},"contenttype":{"name":"contenttype","type":"option","char":"c","description":"if data file extension is not .json, provide content type (applies to all files)","hidden":true,"multiple":false},"confighelp":{"name":"confighelp","type":"boolean","description":"display schema information for the --plan configuration file to stdout; if you use this option, all other options except --json are ignored","allowNo":false}},"args":[],"requiresUsername":true,"flagsConfig":{"sobjecttreefiles":{"kind":"array","char":"f","description":"comma-delimited, ordered paths of json files containing collection of record trees to insert","exclusive":["plan"],"input":[],"multiple":false,"type":"option"},"plan":{"kind":"filepath","char":"p","description":"path to plan to insert multiple data files that have master-detail relationships","input":[],"multiple":false,"type":"option"},"contenttype":{"kind":"string","char":"c","description":"if data file extension is not .json, provide content type (applies to all files)","hidden":true,"input":[],"multiple":false,"type":"option"},"confighelp":{"kind":"boolean","description":"display schema information for the --plan configuration file to stdout; if you use this option, all other options except --json are ignored","allowNo":false,"type":"boolean"}},"result":{"tableColumnData":{"refId":{"header":"Reference ID"},"type":{"header":"Type"},"id":{"header":"ID"}}}},"force:data:soql:bulk:report":{"id":"force:data:soql:bulk:report","description":"view the status of a bulk query\nRun this command using the job ID returned from the force:data:soql:query --bulk command.","strict":true,"usage":"<%= command.id %> -i <string> [-r human|csv|json] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"examples":["$ sfdx force:data:soql:bulk:report -i 7500x000005BdFzXXX"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"bulkqueryid":{"name":"bulkqueryid","type":"option","char":"i","description":"the job ID of the bulk query","required":true,"multiple":false},"resultformat":{"name":"resultformat","type":"option","char":"r","description":"result format emitted to stdout; --json flag overrides this parameter","helpValue":"(human|csv|json)","multiple":false,"options":["human","csv","json"],"default":"human"}},"args":[],"requiresUsername":true,"flagsConfig":{"bulkqueryid":{"kind":"string","char":"i","required":true,"description":"the job ID of the bulk query","input":[],"multiple":false,"type":"option"},"resultformat":{"kind":"enum","helpValue":"(human|csv|json)","char":"r","description":"result format emitted to stdout; --json flag overrides this parameter","options":["human","csv","json"],"default":"human","input":[],"multiple":false,"type":"option"}}}}}
|
|
1
|
+
{"version":"2.1.20","commands":{"force:data:bulk:delete":{"id":"force:data:bulk:delete","description":"bulk delete records from a csv file\nThe file must be a CSV file with only one column: \"Id\".\nOne job can contain many batches, depending on the length of the CSV file.\nReturns a job ID and a batch ID. Use these IDs to check job status with data:bulk:status.\n\n","strict":true,"usage":"<%= command.id %> -f <filepath> -s <string> [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"examples":["$ sfdx force:data:bulk:delete -s Account -f ./path/to/file.csv","$ sfdx force:data:bulk:delete -s MyObject__c -f ./path/to/file.csv"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"csvfile":{"name":"csvfile","type":"option","char":"f","description":"the path to the CSV file containing the ids of the records to delete","required":true,"multiple":false},"sobjecttype":{"name":"sobjecttype","type":"option","char":"s","description":"the sObject type of the records you’re deleting","required":true,"multiple":false},"wait":{"name":"wait","type":"option","char":"w","description":"the number of minutes to wait for the command to complete before displaying the results","multiple":false}},"args":[],"requiresUsername":true,"flagsConfig":{"csvfile":{"kind":"filepath","char":"f","description":"the path to the CSV file containing the ids of the records to delete","required":true,"input":[],"multiple":false,"type":"option"},"sobjecttype":{"kind":"string","char":"s","description":"the sObject type of the records you’re deleting","required":true,"input":[],"multiple":false,"type":"option"},"wait":{"kind":"minutes","char":"w","description":"the number of minutes to wait for the command to complete before displaying the results","min":0,"input":[],"multiple":false,"type":"option"}}},"force:data:bulk:status":{"id":"force:data:bulk:status","description":"view the status of a bulk data load job or batch\nRun this command using the job ID or batch ID returned from the force:data:bulk:delete or force:data:bulk:upsert commands.","strict":true,"usage":"<%= command.id %> -i <string> [-b <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"examples":["$ sfdx force:data:bulk:status -i 750xx000000005sAAA","$ sfdx force:data:bulk:status -i 750xx000000005sAAA -b 751xx000000005nAAA"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"batchid":{"name":"batchid","type":"option","char":"b","description":"the ID of the batch whose status you want to view","multiple":false},"jobid":{"name":"jobid","type":"option","char":"i","description":"the ID of the job you want to view or of the job whose batch you want to view","required":true,"multiple":false}},"args":[],"requiresUsername":true,"flagsConfig":{"batchid":{"kind":"string","char":"b","description":"the ID of the batch whose status you want to view","input":[],"multiple":false,"type":"option"},"jobid":{"kind":"string","char":"i","description":"the ID of the job you want to view or of the job whose batch you want to view","required":true,"input":[],"multiple":false,"type":"option"}}},"force:data:bulk:upsert":{"id":"force:data:bulk:upsert","description":"bulk upsert records from a CSV file\nInserts or updates records from a CSV file.\n\nOne job can contain many batches, depending on the length of the CSV file.\nReturns a job ID and a batch ID. Use these IDs to check job status with data:bulk:status.\n\nFor information about formatting your CSV file, see \"Prepare CSV Files\" in the Bulk API Developer Guide. \n\nBy default, the job runs the batches in parallel. Specify --serial to run them serially.","strict":true,"usage":"<%= command.id %> -i <string> -f <filepath> -s <string> [-w <minutes>] [-r] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"examples":["$ sfdx force:data:bulk:upsert -s MyObject__c -f ./path/to/file.csv -i MyField__c","$ sfdx force:data:bulk:upsert -s MyObject__c -f ./path/to/file.csv -i Id -w 2"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"externalid":{"name":"externalid","type":"option","char":"i","description":"the column name of the external ID","required":true,"multiple":false},"csvfile":{"name":"csvfile","type":"option","char":"f","description":"the path to the CSV file that defines the records to upsert","required":true,"multiple":false},"sobjecttype":{"name":"sobjecttype","type":"option","char":"s","description":"the sObject type of the records you want to upsert","required":true,"multiple":false},"wait":{"name":"wait","type":"option","char":"w","description":"the number of minutes to wait for the command to complete before displaying the results","multiple":false},"serial":{"name":"serial","type":"boolean","char":"r","description":"run batches in serial mode","allowNo":false}},"args":[],"requiresUsername":true,"flagsConfig":{"externalid":{"kind":"string","char":"i","description":"the column name of the external ID","required":true,"input":[],"multiple":false,"type":"option"},"csvfile":{"kind":"filepath","char":"f","description":"the path to the CSV file that defines the records to upsert","required":true,"input":[],"multiple":false,"type":"option"},"sobjecttype":{"kind":"string","char":"s","description":"the sObject type of the records you want to upsert","required":true,"input":[],"multiple":false,"type":"option"},"wait":{"kind":"minutes","char":"w","description":"the number of minutes to wait for the command to complete before displaying the results","min":0,"input":[],"multiple":false,"type":"option"},"serial":{"kind":"boolean","char":"r","description":"run batches in serial mode","default":false,"allowNo":false,"type":"boolean"}}},"force:data:record:create":{"id":"force:data:record:create","description":"creates and inserts a record\nThe format of a field-value pair is <fieldName>=<value>.\nEnclose all field-value pairs in one set of double quotation marks, delimited by spaces.\nEnclose values that contain spaces in single quotes.\n\nTo get data on API performance metrics, specify both --perflog and --json.","strict":true,"usage":"<%= command.id %> -s <string> -v <string> [-t] [--perflog --json] [-u <string>] [--apiversion <string>] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"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"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"sobjecttype":{"name":"sobjecttype","type":"option","char":"s","description":"the type of the record you’re creating","required":true,"multiple":false},"values":{"name":"values","type":"option","char":"v","description":"the <fieldName>=<value> pairs you’re creating","required":true,"multiple":false},"usetoolingapi":{"name":"usetoolingapi","type":"boolean","char":"t","description":"create the record with tooling api","allowNo":false},"perflog":{"name":"perflog","type":"boolean","description":"get API performance data","allowNo":false,"dependsOn":["json"]}},"args":[],"requiresUsername":true,"flagsConfig":{"sobjecttype":{"kind":"string","char":"s","required":true,"description":"the type of the record you’re creating","input":[],"multiple":false,"type":"option"},"values":{"kind":"string","char":"v","required":true,"description":"the <fieldName>=<value> pairs you’re creating","input":[],"multiple":false,"type":"option"},"usetoolingapi":{"kind":"boolean","char":"t","description":"create the record with tooling api","allowNo":false,"type":"boolean"},"perflog":{"kind":"boolean","description":"get API performance data","dependsOn":["json"],"allowNo":false,"type":"boolean"}}},"force:data:record:delete":{"id":"force:data:record:delete","description":"deletes a single record\nSpecify an sObject type and either an ID or a list of <fieldName>=<value> pairs.\nThe format of a field-value pair is <fieldName>=<value>.\nEnclose all field-value pairs in one set of double quotation marks, delimited by spaces.\nEnclose values that contain spaces in single quotes.\n\nTo get data on API performance metrics, specify both --perflog and --json.","strict":true,"usage":"<%= command.id %> -s <string> [-i <id> | -w <string>] [-t] [--perflog --json] [-u <string>] [--apiversion <string>] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"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"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"sobjecttype":{"name":"sobjecttype","type":"option","char":"s","description":"the type of the record you’re deleting","required":true,"multiple":false},"sobjectid":{"name":"sobjectid","type":"option","char":"i","description":"the ID of the record you’re deleting","multiple":false,"exclusive":["where"]},"where":{"name":"where","type":"option","char":"w","description":"a list of <fieldName>=<value> pairs to search for","multiple":false,"exclusive":["sobjectid"]},"usetoolingapi":{"name":"usetoolingapi","type":"boolean","char":"t","description":"delete the record with Tooling API","allowNo":false},"perflog":{"name":"perflog","type":"boolean","description":"get API performance data","allowNo":false,"dependsOn":["json"]}},"args":[],"requiresUsername":true,"flagsConfig":{"sobjecttype":{"kind":"string","char":"s","required":true,"description":"the type of the record you’re deleting","input":[],"multiple":false,"type":"option"},"sobjectid":{"kind":"id","char":"i","description":"the ID of the record you’re deleting","exclusive":["where"],"input":[],"multiple":false,"type":"option"},"where":{"kind":"string","char":"w","description":"a list of <fieldName>=<value> pairs to search for","exclusive":["sobjectid"],"input":[],"multiple":false,"type":"option"},"usetoolingapi":{"kind":"boolean","char":"t","description":"delete the record with Tooling API","allowNo":false,"type":"boolean"},"perflog":{"kind":"boolean","description":"get API performance data","dependsOn":["json"],"allowNo":false,"type":"boolean"}}},"force:data:record:get":{"id":"force:data:record:get","description":"displays a single record\nSpecify an sObject type and either an ID or a list of <fieldName>=<value> pairs.\nThe format of a field-value pair is <fieldName>=<value>.\nEnclose all field-value pairs in one set of double quotation marks, delimited by spaces.\nEnclose values that contain spaces in single quotes.\n\nTo get data on API performance metrics, specify both --perflog and --json.","strict":true,"usage":"<%= command.id %> -s <string> [-i <id> | -w <string>] [-t] [--perflog --json] [-u <string>] [--apiversion <string>] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"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"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"sobjecttype":{"name":"sobjecttype","type":"option","char":"s","description":"the type of the record you’re retrieving","required":true,"multiple":false},"sobjectid":{"name":"sobjectid","type":"option","char":"i","description":"the ID of the record you’re retrieving","multiple":false,"exclusive":["where"]},"where":{"name":"where","type":"option","char":"w","description":"a list of <fieldName>=<value> pairs to search for","multiple":false,"exclusive":["sobjectid"]},"usetoolingapi":{"name":"usetoolingapi","type":"boolean","char":"t","description":"retrieve the record with Tooling API","allowNo":false},"perflog":{"name":"perflog","type":"boolean","description":"get API performance data","allowNo":false,"dependsOn":["json"]}},"args":[],"requiresUsername":true,"flagsConfig":{"sobjecttype":{"kind":"string","char":"s","required":true,"description":"the type of the record you’re retrieving","input":[],"multiple":false,"type":"option"},"sobjectid":{"kind":"id","char":"i","description":"the ID of the record you’re retrieving","exclusive":["where"],"input":[],"multiple":false,"type":"option"},"where":{"kind":"string","char":"w","description":"a list of <fieldName>=<value> pairs to search for","exclusive":["sobjectid"],"input":[],"multiple":false,"type":"option"},"usetoolingapi":{"kind":"boolean","char":"t","description":"retrieve the record with Tooling API","allowNo":false,"type":"boolean"},"perflog":{"kind":"boolean","description":"get API performance data","dependsOn":["json"],"allowNo":false,"type":"boolean"}}},"force:data:record:update":{"id":"force:data:record:update","description":"updates a single record\nThe format of a field-value pair is <fieldName>=<value>.\nEnclose all field-value pairs in one set of double quotation marks, delimited by spaces.\nEnclose values that contain spaces in single quotes.\n\nTo get data on API performance metrics, specify both --perflog and --json.","strict":true,"usage":"<%= command.id %> -s <string> -v <string> [-i <id> | -w <string>] [-t] [--perflog --json] [-u <string>] [--apiversion <string>] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"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"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"sobjecttype":{"name":"sobjecttype","type":"option","char":"s","description":"the sObject type of the record you’re updating","required":true,"multiple":false},"sobjectid":{"name":"sobjectid","type":"option","char":"i","description":"the ID of the record you’re updating","multiple":false,"exclusive":["where"]},"where":{"name":"where","type":"option","char":"w","description":"a list of <fieldName>=<value> pairs to search for","multiple":false,"exclusive":["sobjectid"]},"values":{"name":"values","type":"option","char":"v","description":"the <fieldName>=<value> pairs you’re updating","required":true,"multiple":false},"usetoolingapi":{"name":"usetoolingapi","type":"boolean","char":"t","description":"update the record with Tooling API","allowNo":false},"perflog":{"name":"perflog","type":"boolean","description":"get API performance data","allowNo":false,"dependsOn":["json"]}},"args":[],"requiresUsername":true,"flagsConfig":{"sobjecttype":{"kind":"string","char":"s","required":true,"description":"the sObject type of the record you’re updating","input":[],"multiple":false,"type":"option"},"sobjectid":{"kind":"id","char":"i","description":"the ID of the record you’re updating","exclusive":["where"],"input":[],"multiple":false,"type":"option"},"where":{"kind":"string","char":"w","description":"a list of <fieldName>=<value> pairs to search for","exclusive":["sobjectid"],"input":[],"multiple":false,"type":"option"},"values":{"kind":"string","char":"v","required":true,"description":"the <fieldName>=<value> pairs you’re updating","input":[],"multiple":false,"type":"option"},"usetoolingapi":{"kind":"boolean","char":"t","description":"update the record with Tooling API","allowNo":false,"type":"boolean"},"perflog":{"kind":"boolean","description":"get API performance data","dependsOn":["json"],"allowNo":false,"type":"boolean"}}},"force:data:soql:query":{"id":"force:data:soql:query","description":"execute a SOQL query\nWhen you execute this command in a project, it executes the query against the data in your default scratch org.\n\nTo get data on API performance metrics, specify both --perflog and --json.\n\n","strict":true,"usage":"<%= command.id %> [-q <string> | -f <filepath>] [-w <minutes> [-b | -t]] [-r human|csv|json] [--perflog --json] [-u <string>] [--apiversion <string>] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"examples":["$ sfdx force:data:soql:query -q \"SELECT Id, Name, Account.Name FROM Contact\"","$ sfdx force:data:soql:query -q \"SELECT Id, Name FROM Account WHERE ShippingState IN ('CA', 'NY')\"","$ sfdx force:data:soql:query -q \"SELECT Id, Name FROM Account WHERE ShippingState IN ('CA', 'NY')\" --perflog --json","$ sfdx force:data:soql:query -q \"SELECT Name FROM ApexTrigger\" -t","$ sfdx force:data:soql:query --soqlqueryfile query.txt","$ sfdx force:data:soql:query --soqlqueryfile query.txt -t"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"query":{"name":"query","type":"option","char":"q","description":"SOQL query to execute","multiple":false,"exclusive":["soqlqueryfile"]},"soqlqueryfile":{"name":"soqlqueryfile","type":"option","char":"f","description":"A SOQL query stored in a file","multiple":false,"exclusive":["query"]},"usetoolingapi":{"name":"usetoolingapi","type":"boolean","char":"t","description":"execute query with Tooling API","allowNo":false},"bulk":{"name":"bulk","type":"boolean","char":"b","description":"use the bulk 2.0 API to query data","allowNo":false,"exclusive":["usetoolingapi"]},"wait":{"name":"wait","type":"option","char":"w","description":"wait time for command to finish in minutes","multiple":false,"dependsOn":["bulk"]},"resultformat":{"name":"resultformat","type":"option","char":"r","description":"result format emitted to stdout; --json flag overrides this parameter","helpValue":"(human|csv|json)","multiple":false,"options":["human","csv","json"],"default":"human"},"perflog":{"name":"perflog","type":"boolean","description":"get API performance data","allowNo":false,"dependsOn":["json"]}},"args":[],"requiresUsername":true,"flagsConfig":{"query":{"kind":"string","char":"q","description":"SOQL query to execute","exclusive":["soqlqueryfile"],"exactlyOne":["query","soqlqueryfile"],"input":[],"multiple":false,"type":"option"},"soqlqueryfile":{"kind":"filepath","char":"f","description":"A SOQL query stored in a file","exclusive":["query"],"exactlyOne":["query","soqlqueryfile"],"input":[],"multiple":false,"type":"option"},"usetoolingapi":{"kind":"boolean","char":"t","description":"execute query with Tooling API","allowNo":false,"type":"boolean"},"bulk":{"kind":"boolean","char":"b","default":false,"description":"use the bulk 2.0 API to query data","exclusive":["usetoolingapi"],"allowNo":false,"type":"boolean"},"wait":{"kind":"minutes","char":"w","description":"wait time for command to finish in minutes","dependsOn":["bulk"],"input":[],"multiple":false,"type":"option"},"resultformat":{"kind":"enum","helpValue":"(human|csv|json)","char":"r","description":"result format emitted to stdout; --json flag overrides this parameter","options":["human","csv","json"],"default":"human","input":[],"multiple":false,"type":"option"},"perflog":{"kind":"boolean","description":"get API performance data","dependsOn":["json"],"allowNo":false,"type":"boolean"}}},"force:data:tree:export":{"id":"force:data:tree:export","description":"export data from an org\nExports data from an org into sObject tree format for use with the force:data:tree:import command.\nThe query for export 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","strict":true,"usage":"<%= command.id %> -q <string> [-p] [-x <string>] [-d <directory>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"examples":["$ sfdx force:data:tree:export -q \"SELECT Id, Name, (SELECT Name, Address__c FROM Properties__r) FROM Broker__c\"","$ sfdx force:data:tree:export -q <path to file containing soql query> -x export-demo -d /tmp/sfdx-out -p"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"query":{"name":"query","type":"option","char":"q","description":"soql query, or filepath of file containing a soql query, to retrieve records","required":true,"multiple":false},"plan":{"name":"plan","type":"boolean","char":"p","description":"generate mulitple sobject tree files and a plan definition file for aggregated import","allowNo":false},"prefix":{"name":"prefix","type":"option","char":"x","description":"prefix of generated files","multiple":false},"outputdir":{"name":"outputdir","type":"option","char":"d","description":"directory to store files'","multiple":false}},"args":[],"requiresUsername":true,"flagsConfig":{"query":{"kind":"string","char":"q","description":"soql query, or filepath of file containing a soql query, to retrieve records","required":true,"input":[],"multiple":false,"type":"option"},"plan":{"kind":"boolean","char":"p","description":"generate mulitple sobject tree files and a plan definition file for aggregated import","allowNo":false,"type":"boolean"},"prefix":{"kind":"string","char":"x","description":"prefix of generated files","input":[],"multiple":false,"type":"option"},"outputdir":{"kind":"directory","char":"d","description":"directory to store files'","input":[],"multiple":false,"type":"option"}}},"force:data:tree:import":{"id":"force:data:tree:import","description":"import data into an org\nIMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.\n\nImports data into an org using the SObject Tree Save API. This data can include master-detail relationships.\nTo generate JSON files for use with force:data:tree:import, run \"sfdx force:data:tree:export\".\nThe SObject Tree API supports requests that contain up to 200 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","strict":true,"usage":"<%= command.id %> [-f <array> | -p <filepath>] [--confighelp] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"examples":["$ sfdx force:data:tree:import -f Contact.json,Account.json -u me@my.org","$ sfdx force:data:tree:import -p Account-Contact-plan.json -u me@my.org"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"sobjecttreefiles":{"name":"sobjecttreefiles","type":"option","char":"f","description":"comma-delimited, ordered paths of json files containing collection of record trees to insert","multiple":false,"exclusive":["plan"]},"plan":{"name":"plan","type":"option","char":"p","description":"path to plan to insert multiple data files that have master-detail relationships","multiple":false},"contenttype":{"name":"contenttype","type":"option","char":"c","description":"if data file extension is not .json, provide content type (applies to all files)","hidden":true,"multiple":false},"confighelp":{"name":"confighelp","type":"boolean","description":"display schema information for the --plan configuration file to stdout; if you use this option, all other options except --json are ignored","allowNo":false}},"args":[],"requiresUsername":true,"flagsConfig":{"sobjecttreefiles":{"kind":"array","char":"f","description":"comma-delimited, ordered paths of json files containing collection of record trees to insert","exclusive":["plan"],"input":[],"multiple":false,"type":"option"},"plan":{"kind":"filepath","char":"p","description":"path to plan to insert multiple data files that have master-detail relationships","input":[],"multiple":false,"type":"option"},"contenttype":{"kind":"string","char":"c","description":"if data file extension is not .json, provide content type (applies to all files)","hidden":true,"input":[],"multiple":false,"type":"option"},"confighelp":{"kind":"boolean","description":"display schema information for the --plan configuration file to stdout; if you use this option, all other options except --json are ignored","allowNo":false,"type":"boolean"}},"result":{"tableColumnData":{"refId":{"header":"Reference ID"},"type":{"header":"Type"},"id":{"header":"ID"}}}},"force:data:soql:bulk:report":{"id":"force:data:soql:bulk:report","description":"view the status of a bulk query\nRun this command using the job ID returned from the force:data:soql:query --bulk command.","strict":true,"usage":"<%= command.id %> -i <string> [-r human|csv|json] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":[],"examples":["$ sfdx force:data:soql:bulk:report -i 7500x000005BdFzXXX"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"bulkqueryid":{"name":"bulkqueryid","type":"option","char":"i","description":"the job ID of the bulk query","required":true,"multiple":false},"resultformat":{"name":"resultformat","type":"option","char":"r","description":"result format emitted to stdout; --json flag overrides this parameter","helpValue":"(human|csv|json)","multiple":false,"options":["human","csv","json"],"default":"human"}},"args":[],"requiresUsername":true,"flagsConfig":{"bulkqueryid":{"kind":"string","char":"i","required":true,"description":"the job ID of the bulk query","input":[],"multiple":false,"type":"option"},"resultformat":{"kind":"enum","helpValue":"(human|csv|json)","char":"r","description":"result format emitted to stdout; --json flag overrides this parameter","options":["human","csv","json"],"default":"human","input":[],"multiple":false,"type":"option"}}}}}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-data",
|
|
3
|
-
"version": "2.1.
|
|
3
|
+
"version": "2.1.20",
|
|
4
4
|
"description": "Plugin for salesforce data commands",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"main": "lib/index.js",
|
|
@@ -90,9 +90,9 @@
|
|
|
90
90
|
},
|
|
91
91
|
"dependencies": {
|
|
92
92
|
"@oclif/core": "^1.20.0",
|
|
93
|
-
"@salesforce/command": "^5.2.
|
|
93
|
+
"@salesforce/command": "^5.2.37",
|
|
94
94
|
"@salesforce/core": "^3.32.12",
|
|
95
|
-
"@salesforce/ts-types": "^1.7.
|
|
95
|
+
"@salesforce/ts-types": "^1.7.2",
|
|
96
96
|
"@types/fs-extra": "^9.0.13",
|
|
97
97
|
"chalk": "^4.1.0",
|
|
98
98
|
"csv-parse": "^4.16.3",
|
|
@@ -102,11 +102,11 @@
|
|
|
102
102
|
"tslib": "^2"
|
|
103
103
|
},
|
|
104
104
|
"devDependencies": {
|
|
105
|
-
"@oclif/plugin-command-snapshot": "^3.2.
|
|
105
|
+
"@oclif/plugin-command-snapshot": "^3.2.16",
|
|
106
106
|
"@salesforce/cli-plugins-testkit": "^1.4.24",
|
|
107
107
|
"@salesforce/dev-config": "^3.0.1",
|
|
108
108
|
"@salesforce/dev-scripts": "2.0.4",
|
|
109
|
-
"@salesforce/plugin-command-reference": "^1.5.
|
|
109
|
+
"@salesforce/plugin-command-reference": "^1.5.10",
|
|
110
110
|
"@salesforce/prettier-config": "^0.0.2",
|
|
111
111
|
"@salesforce/ts-sinon": "^1.4.2",
|
|
112
112
|
"@swc/core": "^1.3.24",
|
|
@@ -132,7 +132,7 @@
|
|
|
132
132
|
"husky": "^7.0.4",
|
|
133
133
|
"mocha": "^9.1.3",
|
|
134
134
|
"nyc": "^15.1.0",
|
|
135
|
-
"oclif": "^3.4.
|
|
135
|
+
"oclif": "^3.4.3",
|
|
136
136
|
"prettier": "^2.8.0",
|
|
137
137
|
"pretty-quick": "^3.1.0",
|
|
138
138
|
"shelljs": "^0.8.3",
|
|
@@ -142,7 +142,7 @@
|
|
|
142
142
|
"typescript": "^4.9.3"
|
|
143
143
|
},
|
|
144
144
|
"sfdx": {
|
|
145
|
-
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/2.1.
|
|
146
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/2.1.
|
|
145
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/2.1.20.crt",
|
|
146
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/2.1.20.sig"
|
|
147
147
|
}
|
|
148
148
|
}
|