@salesforce/plugin-data 2.1.22 → 2.1.24

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.
@@ -1 +1,1233 @@
1
- {"version":"2.1.22","commands":{"data:query":{"id":"data:query","summary":"Execute a SOQL query.","description":"Specify the SOQL query at the command line with the --query flag or read the query from a file with the --file flag.\n\nIf your query returns more than 10,000 records, specify the --bulk flag. The command then runs the query using Bulk API 2.0, which has higher limits than the default API used by the command.\n\nWhen using --bulk, the command waits 3 minutes by default for the query to complete. Use the --wait parameter to specify a different number of minutes to wait, or set --wait to 0 to immediately return control to the terminal. If you set --wait to 0, or you use the --async flag, or the command simply times out, the command displays an ID. Pass this ID to the the \"data query resume\" command using the --bulk-query-id flag to get the results; pass the ID to the \"data resume\" command to get the job status.","strict":true,"pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":["force:data:soql:query"],"examples":["Specify a SOQL query at the command line; the command uses your default org:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id, Name, Account.Name FROM Contact\"","Read the SOQL query from a file called \"query.txt\"; the command uses the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --file query.txt --target-org my-scratch","Use Tooling API to run a query on the ApexTrigger Tooling API object:\n<%= config.bin %> <%= command.id %> --query \"SELECT Name FROM ApexTrigger\" --use-tooling-api","Use Bulk API 2.0 to run a query that returns many rows, and return control to the terminal immediately:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id FROM Contact\" --bulk --wait 0"],"deprecateAliases":true,"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false,"deprecateAliases":true},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"deprecateAliases":true,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."},"deprecateAliases":true},"query":{"name":"query","type":"option","char":"q","summary":"SOQL query to execute.","multiple":false,"deprecateAliases":true},"file":{"name":"file","type":"option","char":"f","summary":"File that contains the SOQL query.","multiple":false,"deprecateAliases":true,"aliases":["soqlqueryfile"]},"use-tooling-api":{"name":"use-tooling-api","type":"boolean","char":"t","summary":"Use Tooling API so you can run queries on Tooling API objects.","allowNo":false,"deprecateAliases":true,"aliases":["usetoolingapi"]},"bulk":{"name":"bulk","type":"boolean","char":"b","summary":"Use Bulk API 2.0 to run the query.","allowNo":false,"exclusive":["use-tooling-api"],"deprecateAliases":true},"wait":{"name":"wait","type":"option","char":"w","summary":"Time to wait for the command to finish, in minutes.","multiple":false,"dependsOn":["bulk"],"exclusive":["async"],"deprecateAliases":true},"async":{"name":"async","type":"boolean","summary":"Use Bulk API 2.0, but don't wait for the job to complete.","allowNo":false,"dependsOn":["bulk"],"exclusive":["wait"],"deprecateAliases":true},"result-format":{"name":"result-format","type":"option","char":"r","summary":"Format to display the results; the --json flag overrides this flag.","helpValue":"(human|json|csv)","multiple":false,"options":["human","json","csv"],"default":"human","deprecateAliases":true,"aliases":["resultformat"]},"perflog":{"name":"perflog","type":"boolean","summary":"Get API performance data.","description":"Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.","hidden":true,"allowNo":false,"deprecated":{"version":"57"},"deprecateAliases":true}},"args":[],"hasDynamicHelp":true},"data:resume":{"id":"data:resume","summary":"View the status of a bulk data load job or batch.","description":"Run this command using the job ID or batch ID returned from the \"<%= config.bin %> data delete bulk\" or \"<%= config.bin %> data upsert bulk\" commands.","strict":true,"pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":["force:data:bulk:status"],"examples":["View the status of a bulk load job:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA","View the status of a bulk load job and a specific batches:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA"],"deprecateAliases":true,"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false,"deprecateAliases":true},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"deprecateAliases":true,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."},"deprecateAliases":true},"batch-id":{"name":"batch-id","type":"option","char":"b","summary":"ID of the batch whose status you want to view; you must also specify the job ID.","multiple":false,"deprecateAliases":true,"aliases":["batchid"]},"job-id":{"name":"job-id","type":"option","char":"i","summary":"ID of the job whose status you want to view.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["jobid"]}},"args":[],"hasDynamicHelp":true},"data:create:record":{"id":"data:create:record","summary":"Create and insert a record into a Salesforce or Tooling API object.","description":"You must specify a value for all required fields of the object.\n\nWhen 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.\n\nThis command inserts a record into Salesforce objects by default. Use the --use-tooling-api flag to insert into a Tooling API object.","strict":true,"pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":["force:data:record:create"],"examples":["Insert a record into the Account object of your default org; only the required Name field has a value:\n<%= config.bin %> <%= command.id %> --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\":\n<%= config.bin %> <%= command.id %> --sobject Account --values \"Name='Universal Containers' Website=www.example.com\" --target-org my-scratch","Insert a record into the Tooling API object TraceFlag:\n<%= config.bin %> <%= command.id %> --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\""],"deprecateAliases":true,"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false,"deprecateAliases":true},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"deprecateAliases":true,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."},"deprecateAliases":true},"sobject":{"name":"sobject","type":"option","char":"s","summary":"API name of the Salesforce or Tooling API object that you're inserting a record into.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["sobjecttype"]},"values":{"name":"values","type":"option","char":"v","summary":"Values for the flags in the form <fieldName>=<value>, separate multiple pairs with spaces.","required":true,"multiple":false,"deprecateAliases":true},"use-tooling-api":{"name":"use-tooling-api","type":"boolean","char":"t","summary":"Use Tooling API so you can insert a record in a Tooling API object.","allowNo":false,"deprecateAliases":true,"aliases":["usetoolingapi"]},"perflog":{"name":"perflog","type":"boolean","summary":"Get API performance data.","description":"Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.","hidden":true,"allowNo":false,"deprecated":{"version":"57"},"deprecateAliases":true}},"args":[],"hasDynamicHelp":true},"data:delete:bulk":{"id":"data:delete:bulk","summary":"Bulk delete records from an org using a CSV file.","description":"The CSV file must have only one column (\"Id\") and then the list of record IDs you want to delete, one ID per line.\n\nWhen you execute this command, it starts a job and one or more batches, displays their IDs, and then immediately returns control of the terminal to you by default. If you prefer to wait, set the --wait flag to the number of minutes; if it times out, the command outputs the IDs. Use the job and batch IDs to check the status of the job with the \"<%= config.bin %> data resume\" command. A single job can contain many batches, depending on the length of the CSV file.","strict":true,"pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":["force:data:bulk:delete"],"examples":["Bulk delete Account records using the list of IDs in the \"files/delete.csv\" file:\n<%= config.bin %> <%= command.id %> --sobject Account --file files/delete.csv","Bulk delete records from a custom object and wait 5 minutes for the command to complete:\n<%= config.bin %> <%= command.id %> --sobject MyObject__c --file files/delete.csv --wait 5"],"deprecateAliases":true,"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false,"deprecateAliases":true},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"deprecateAliases":true,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."},"deprecateAliases":true},"file":{"name":"file","type":"option","char":"f","summary":"CSV file that contains the IDs of the records to delete.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["csvfile"]},"sobject":{"name":"sobject","type":"option","char":"s","summary":"API name of the Salesforce object, either standard or custom, that you want to delete records from.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["sobjecttype"]},"wait":{"name":"wait","type":"option","char":"w","summary":"Number of minutes to wait for the command to complete before displaying the results.","multiple":false,"default":{"quantity":0,"unit":0},"deprecateAliases":true}},"args":[],"hasDynamicHelp":true},"data:delete:record":{"id":"data:delete:record","summary":"Deletes a single record from a Salesforce or Tooling API object.","description":"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.\n\nWhen 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.\n\nThis command deletes a record from Salesforce objects by default. Use the --use-tooling-api flag to delete from a Tooling API object.","strict":true,"pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":["force:data:record:delete"],"examples":["Delete a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX","Delete a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --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\":\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --use-tooling-api --sobject TraceFlag --record-id 7tf8c"],"deprecateAliases":true,"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false,"deprecateAliases":true},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"deprecateAliases":true,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."},"deprecateAliases":true},"sobject":{"name":"sobject","type":"option","char":"s","summary":"API name of the Salesforce or Tooling API object that you're deleting a record from.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["sobjecttype"]},"record-id":{"name":"record-id","type":"option","char":"i","summary":"ID of the record you’re deleting.","multiple":false,"deprecateAliases":true,"aliases":["sobjectid"]},"where":{"name":"where","type":"option","char":"w","summary":"List of <fieldName>=<value> pairs that identify the record you want to delete.","multiple":false,"deprecateAliases":true},"use-tooling-api":{"name":"use-tooling-api","type":"boolean","char":"t","summary":"Use Tooling API so you can delete a record from a Tooling API object.","allowNo":false,"deprecateAliases":true,"aliases":["usetoolingapi"]},"perflog":{"name":"perflog","type":"boolean","summary":"Get API performance data.","description":"Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.","hidden":true,"allowNo":false,"deprecated":{"version":"57"},"deprecateAliases":true}},"args":[],"hasDynamicHelp":true},"data:export:tree":{"id":"data:export:tree","summary":"Export data from an org into one or more JSON files.","description":"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 \"<%= config.bin %> data import tree\" command.\n\nIf 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.\n\nThe 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).","strict":true,"pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":["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:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --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\":\n<%= config.bin %> <%= command.id %> --query query.txt --plan --prefix export-demo --output-dir export-out --target-org my-scratch"],"deprecateAliases":true,"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false,"deprecateAliases":true},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"deprecateAliases":true,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."},"deprecateAliases":true},"query":{"name":"query","type":"option","char":"q","summary":"SOQL query, or filepath of a file that contains the query, to retrieve records.","required":true,"multiple":false,"deprecateAliases":true},"plan":{"name":"plan","type":"boolean","char":"p","summary":"Generate multiple sObject tree files and a plan definition file for aggregated import.","allowNo":false,"deprecateAliases":true},"prefix":{"name":"prefix","type":"option","char":"x","summary":"Prefix of generated files.","multiple":false,"deprecateAliases":true},"output-dir":{"name":"output-dir","type":"option","char":"d","summary":"Directory in which to generate the JSON files; default is current directory.","multiple":false,"deprecateAliases":true,"aliases":["outputdir"]}},"args":[],"hasDynamicHelp":true},"data:get:record":{"id":"data:get:record","summary":"Retrieve and display a single record of a Salesforce or Tooling API object.","description":"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.\n\nWhen 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.\n\nThe command displays all the record's fields and their values, one field per terminal line. Fields with no values are displayed as \"null\".\n\nThis command retrieves a record from Salesforce objects by default. Use the --use-tooling-api flag to retrieve from a Tooling API object.","strict":true,"pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":["force:data:record:get"],"examples":["Retrieve and display a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX","Retrieve a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --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\":\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --use-tooling-api --sobject TraceFlag --record-id 7tf8c"],"deprecateAliases":true,"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false,"deprecateAliases":true},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"deprecateAliases":true,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."},"deprecateAliases":true},"sobject":{"name":"sobject","type":"option","char":"s","summary":"API name of the Salesforce or Tooling API object that you're retrieving a record from.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["sobjecttype"]},"record-id":{"name":"record-id","type":"option","char":"i","summary":"ID of the record you’re retrieving.","multiple":false,"deprecateAliases":true,"aliases":["sobjectid"]},"where":{"name":"where","type":"option","char":"w","summary":"List of <fieldName>=<value> pairs that identify the record you want to display.","multiple":false,"deprecateAliases":true},"use-tooling-api":{"name":"use-tooling-api","type":"boolean","char":"t","summary":"Use Tooling API so you can retrieve a record from a Tooling API object.","allowNo":false,"deprecateAliases":true,"aliases":["usetoolingapi"]},"perflog":{"name":"perflog","type":"boolean","summary":"Get API performance data.","description":"Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.","hidden":true,"allowNo":false,"deprecated":{"version":"57"},"deprecateAliases":true}},"args":[],"hasDynamicHelp":true},"data:import:tree":{"id":"data:import:tree","summary":"Import data from one or more JSON files into an org.","description":"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 \"<%= config.bin %> data export tree\" command to generate these JSON files.\n\nIf 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.\n\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,"pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":["force:data:tree:import"],"examples":["Import the records contained in two JSON files into the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --files Contact.json,Account.json --target-org my-scratch","Import records using a plan definition file into your default org:\n<%= config.bin %> <%= command.id %> --plan Account-Contact-plan.json"],"deprecateAliases":true,"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false,"deprecateAliases":true},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"deprecateAliases":true,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."},"deprecateAliases":true},"files":{"name":"files","type":"option","char":"f","summary":"Comma-separated and in-order JSON files that contain the records, in sObject tree format, that you want to insert.","multiple":true,"exclusive":["plan"],"deprecateAliases":true,"aliases":["sobjecttreefiles"]},"plan":{"name":"plan","type":"option","char":"p","summary":"Plan definition file to insert multiple data files.","multiple":false,"deprecateAliases":true},"content-type":{"name":"content-type","type":"option","char":"c","summary":"Content type of import files if their extention is not .json.","hidden":true,"multiple":false,"deprecateAliases":true,"aliases":["contenttype"]},"config-help":{"name":"config-help","type":"boolean","summary":"Display schema information for the --plan configuration file to stdout; if you specify this flag, all other flags except --json are ignored.","allowNo":false,"deprecateAliases":true,"aliases":["confighelp"]}},"args":[],"hasDynamicHelp":true},"data:query:resume":{"id":"data:query:resume","summary":"View the status of a bulk query.","description":"Run this command using the job ID returned from the \"<%= config.bin %> data query --bulk\" command.","strict":true,"pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":["force:data:soql:bulk:report"],"examples":["View the status of a bulk query with the specified ID:\n<%= config.bin %> <%= command.id %> --bulk-query-id 7500x000005BdFzXXX"],"deprecateAliases":true,"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false,"deprecateAliases":true},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"deprecateAliases":true,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."},"deprecateAliases":true},"result-format":{"name":"result-format","type":"option","char":"r","summary":"Format to display the results; the --json flag overrides this flag.","helpValue":"(human|json|csv)","multiple":false,"options":["human","json","csv"],"default":"human","deprecateAliases":true,"aliases":["resultformat"]},"bulk-query-id":{"name":"bulk-query-id","type":"option","char":"i","summary":"Job ID of the bulk query.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["bulkqueryid"]}},"args":[],"hasDynamicHelp":true},"data:update:record":{"id":"data:update:record","summary":"Updates a single record of a Salesforce or Tooling API object.","description":"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 delete fails; the error displays how many records were found.\n\nWhen 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.\n\nThis command updates a record in Salesforce objects by default. Use the --use-tooling-api flag to update a Tooling API object.","strict":true,"pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":["force:data:record:update"],"examples":["Update the Name field of an Account record with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 001D0 --values \"Name=NewAcme\"","Update the Name field of an Account record whose current name is 'Old Acme':\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> -t --sobject TraceFlag --record-id 7tf170000009cUBAAY --values \"ExpirationDate=2017-12-01T00:58:04.000+0000\""],"deprecateAliases":true,"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false,"deprecateAliases":true},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"deprecateAliases":true,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."},"deprecateAliases":true},"sobject":{"name":"sobject","type":"option","char":"s","summary":"API name of the Salesforce or Tooling API object that contains the record you're updating.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["sobjecttype"]},"record-id":{"name":"record-id","type":"option","char":"i","summary":"ID of the record you’re updating.","multiple":false,"deprecateAliases":true,"aliases":["sobjectid"]},"where":{"name":"where","type":"option","char":"w","summary":"List of <fieldName>=<value> pairs that identify the record you want to update.","multiple":false,"deprecateAliases":true},"values":{"name":"values","type":"option","char":"v","summary":"Fields that you're updating, in the format of <fieldName>=<value> pairs.","required":true,"multiple":false,"deprecateAliases":true},"use-tooling-api":{"name":"use-tooling-api","type":"boolean","char":"t","summary":"Use Tooling API so you can update a record in a Tooling API object.","allowNo":false,"deprecateAliases":true,"aliases":["usetoolingapi"]},"perflog":{"name":"perflog","type":"boolean","summary":"Get API performance data.","hidden":true,"allowNo":false,"deprecated":{"version":"57"},"deprecateAliases":true}},"args":[],"hasDynamicHelp":true},"data:upsert:bulk":{"id":"data:upsert:bulk","summary":"Bulk upsert records to an org from a CSV file.","description":"An upsert refers to inserting a record into a Salesforce object if the record doesn't already exist, or updating it if it does exist.\n\nWhen you execute this command, it starts a job and one or more batches, displays their IDs, and then immediately returns control of the terminal to you by default. If you prefer to wait, set the --wait flag to the number of minutes; if it times out, the command outputs the IDs. Use the job and batch IDs to check the status of the job with the \"<%= config.bin %> data resume\" command. A single job can contain many batches, depending on the length of the CSV file.\n\nSee \"Prepare CSV Files\" in the Bulk API Developer Guide for details on formatting your CSV file. (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_csv_preparing.htm)\n\nBy default, the job runs the batches in parallel, which we recommend. You can run jobs serially by specifying the --serial flag. But don't process data in serial mode unless you know this would otherwise result in lock timeouts and you can't reorganize your batches to avoid the locks.","strict":true,"pluginName":"@salesforce/plugin-data","pluginAlias":"@salesforce/plugin-data","pluginType":"core","aliases":["force:data:bulk:upsert"],"examples":["Bulk upsert records to the Contact object:\n<%= config.bin %> --sobject Contact --file files/contacts.csv --external-id Id","Bulk upsert records to a custom object and wait 5 minutes for the command to complete:\n<%= config.bin %> <%= command.id %> --sobject MyObject__c --file files/file.csv --external-id MyField__c --wait 5"],"deprecateAliases":true,"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false,"deprecateAliases":true},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"deprecateAliases":true,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."},"deprecateAliases":true},"external-id":{"name":"external-id","type":"option","char":"i","summary":"Name of the external ID field, or the Id field.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["externalid"]},"file":{"name":"file","type":"option","char":"f","summary":"CSV file that contains the records to upsert.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["csvfile"]},"sobject":{"name":"sobject","type":"option","char":"s","summary":"API name of the Salesforce object, either standard or custom, that you want to upsert records to.","required":true,"multiple":false,"deprecateAliases":true,"aliases":["sobjecttype"]},"wait":{"name":"wait","type":"option","char":"w","summary":"Number of minutes to wait for the command to complete before displaying the results.","multiple":false,"default":{"quantity":0,"unit":0},"deprecateAliases":true},"serial":{"name":"serial","type":"boolean","char":"r","summary":"Run batches in serial mode.","allowNo":false,"deprecateAliases":true}},"args":[],"hasDynamicHelp":true}}}
1
+ {
2
+ "version": "2.1.24",
3
+ "commands": {
4
+ "data:query": {
5
+ "id": "data:query",
6
+ "summary": "Execute a SOQL query.",
7
+ "description": "Specify the SOQL query at the command line with the --query flag or read the query from a file with the --file flag.\n\nIf your query returns more than 10,000 records, specify the --bulk flag. The command then runs the query using Bulk API 2.0, which has higher limits than the default API used by the command.\n\nWhen using --bulk, the command waits 3 minutes by default for the query to complete. Use the --wait parameter to specify a different number of minutes to wait, or set --wait to 0 to immediately return control to the terminal. If you set --wait to 0, or you use the --async flag, or the command simply times out, the command displays an ID. Pass this ID to the the \"data query resume\" command using the --bulk-query-id flag to get the results; pass the ID to the \"data resume\" command to get the job status.",
8
+ "strict": true,
9
+ "pluginName": "@salesforce/plugin-data",
10
+ "pluginAlias": "@salesforce/plugin-data",
11
+ "pluginType": "core",
12
+ "aliases": [
13
+ "force:data:soql:query"
14
+ ],
15
+ "examples": [
16
+ "Specify a SOQL query at the command line; the command uses your default org:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id, Name, Account.Name FROM Contact\"",
17
+ "Read the SOQL query from a file called \"query.txt\"; the command uses the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --file query.txt --target-org my-scratch",
18
+ "Use Tooling API to run a query on the ApexTrigger Tooling API object:\n<%= config.bin %> <%= command.id %> --query \"SELECT Name FROM ApexTrigger\" --use-tooling-api",
19
+ "Use Bulk API 2.0 to run a query that returns many rows, and return control to the terminal immediately:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id FROM Contact\" --bulk --wait 0"
20
+ ],
21
+ "deprecateAliases": true,
22
+ "flags": {
23
+ "json": {
24
+ "name": "json",
25
+ "type": "boolean",
26
+ "description": "Format output as json.",
27
+ "helpGroup": "GLOBAL",
28
+ "allowNo": false,
29
+ "deprecateAliases": true
30
+ },
31
+ "target-org": {
32
+ "name": "target-org",
33
+ "type": "option",
34
+ "char": "o",
35
+ "summary": "Username or alias of the target org.",
36
+ "required": true,
37
+ "multiple": false,
38
+ "deprecateAliases": true,
39
+ "aliases": [
40
+ "targetusername",
41
+ "u"
42
+ ]
43
+ },
44
+ "api-version": {
45
+ "name": "api-version",
46
+ "type": "option",
47
+ "description": "Override the api version used for api requests made by this command",
48
+ "multiple": false,
49
+ "deprecateAliases": true,
50
+ "aliases": [
51
+ "apiversion"
52
+ ]
53
+ },
54
+ "loglevel": {
55
+ "name": "loglevel",
56
+ "type": "option",
57
+ "hidden": true,
58
+ "multiple": false,
59
+ "deprecated": {
60
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
61
+ },
62
+ "deprecateAliases": true
63
+ },
64
+ "query": {
65
+ "name": "query",
66
+ "type": "option",
67
+ "char": "q",
68
+ "summary": "SOQL query to execute.",
69
+ "multiple": false,
70
+ "deprecateAliases": true
71
+ },
72
+ "file": {
73
+ "name": "file",
74
+ "type": "option",
75
+ "char": "f",
76
+ "summary": "File that contains the SOQL query.",
77
+ "multiple": false,
78
+ "deprecateAliases": true,
79
+ "aliases": [
80
+ "soqlqueryfile"
81
+ ]
82
+ },
83
+ "use-tooling-api": {
84
+ "name": "use-tooling-api",
85
+ "type": "boolean",
86
+ "char": "t",
87
+ "summary": "Use Tooling API so you can run queries on Tooling API objects.",
88
+ "allowNo": false,
89
+ "deprecateAliases": true,
90
+ "aliases": [
91
+ "usetoolingapi"
92
+ ]
93
+ },
94
+ "bulk": {
95
+ "name": "bulk",
96
+ "type": "boolean",
97
+ "char": "b",
98
+ "summary": "Use Bulk API 2.0 to run the query.",
99
+ "allowNo": false,
100
+ "exclusive": [
101
+ "use-tooling-api"
102
+ ],
103
+ "deprecateAliases": true
104
+ },
105
+ "wait": {
106
+ "name": "wait",
107
+ "type": "option",
108
+ "char": "w",
109
+ "summary": "Time to wait for the command to finish, in minutes.",
110
+ "multiple": false,
111
+ "dependsOn": [
112
+ "bulk"
113
+ ],
114
+ "exclusive": [
115
+ "async"
116
+ ],
117
+ "deprecateAliases": true
118
+ },
119
+ "async": {
120
+ "name": "async",
121
+ "type": "boolean",
122
+ "summary": "Use Bulk API 2.0, but don't wait for the job to complete.",
123
+ "allowNo": false,
124
+ "dependsOn": [
125
+ "bulk"
126
+ ],
127
+ "exclusive": [
128
+ "wait"
129
+ ],
130
+ "deprecateAliases": true
131
+ },
132
+ "result-format": {
133
+ "name": "result-format",
134
+ "type": "option",
135
+ "char": "r",
136
+ "summary": "Format to display the results; the --json flag overrides this flag.",
137
+ "helpValue": "(human|json|csv)",
138
+ "multiple": false,
139
+ "options": [
140
+ "human",
141
+ "json",
142
+ "csv"
143
+ ],
144
+ "default": "human",
145
+ "deprecateAliases": true,
146
+ "aliases": [
147
+ "resultformat"
148
+ ]
149
+ },
150
+ "perflog": {
151
+ "name": "perflog",
152
+ "type": "boolean",
153
+ "summary": "Get API performance data.",
154
+ "description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
155
+ "hidden": true,
156
+ "allowNo": false,
157
+ "deprecated": {
158
+ "version": "57"
159
+ },
160
+ "deprecateAliases": true
161
+ }
162
+ },
163
+ "args": {},
164
+ "hasDynamicHelp": true
165
+ },
166
+ "data:resume": {
167
+ "id": "data:resume",
168
+ "summary": "View the status of a bulk data load job or batch.",
169
+ "description": "Run this command using the job ID or batch ID returned from the \"<%= config.bin %> data delete bulk\" or \"<%= config.bin %> data upsert bulk\" commands.",
170
+ "strict": true,
171
+ "pluginName": "@salesforce/plugin-data",
172
+ "pluginAlias": "@salesforce/plugin-data",
173
+ "pluginType": "core",
174
+ "aliases": [
175
+ "force:data:bulk:status"
176
+ ],
177
+ "examples": [
178
+ "View the status of a bulk load job:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
179
+ "View the status of a bulk load job and a specific batches:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA"
180
+ ],
181
+ "deprecateAliases": true,
182
+ "flags": {
183
+ "json": {
184
+ "name": "json",
185
+ "type": "boolean",
186
+ "description": "Format output as json.",
187
+ "helpGroup": "GLOBAL",
188
+ "allowNo": false,
189
+ "deprecateAliases": true
190
+ },
191
+ "target-org": {
192
+ "name": "target-org",
193
+ "type": "option",
194
+ "char": "o",
195
+ "summary": "Username or alias of the target org.",
196
+ "required": true,
197
+ "multiple": false,
198
+ "deprecateAliases": true,
199
+ "aliases": [
200
+ "targetusername",
201
+ "u"
202
+ ]
203
+ },
204
+ "api-version": {
205
+ "name": "api-version",
206
+ "type": "option",
207
+ "description": "Override the api version used for api requests made by this command",
208
+ "multiple": false,
209
+ "deprecateAliases": true,
210
+ "aliases": [
211
+ "apiversion"
212
+ ]
213
+ },
214
+ "loglevel": {
215
+ "name": "loglevel",
216
+ "type": "option",
217
+ "hidden": true,
218
+ "multiple": false,
219
+ "deprecated": {
220
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
221
+ },
222
+ "deprecateAliases": true
223
+ },
224
+ "batch-id": {
225
+ "name": "batch-id",
226
+ "type": "option",
227
+ "char": "b",
228
+ "summary": "ID of the batch whose status you want to view; you must also specify the job ID.",
229
+ "multiple": false,
230
+ "deprecateAliases": true,
231
+ "aliases": [
232
+ "batchid"
233
+ ]
234
+ },
235
+ "job-id": {
236
+ "name": "job-id",
237
+ "type": "option",
238
+ "char": "i",
239
+ "summary": "ID of the job whose status you want to view.",
240
+ "required": true,
241
+ "multiple": false,
242
+ "deprecateAliases": true,
243
+ "aliases": [
244
+ "jobid"
245
+ ]
246
+ }
247
+ },
248
+ "args": {},
249
+ "hasDynamicHelp": true
250
+ },
251
+ "data:create:record": {
252
+ "id": "data:create:record",
253
+ "summary": "Create and insert a record into a Salesforce or Tooling API object.",
254
+ "description": "You must specify a value for all required fields of the object.\n\nWhen 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.\n\nThis command inserts a record into Salesforce objects by default. Use the --use-tooling-api flag to insert into a Tooling API object.",
255
+ "strict": true,
256
+ "pluginName": "@salesforce/plugin-data",
257
+ "pluginAlias": "@salesforce/plugin-data",
258
+ "pluginType": "core",
259
+ "aliases": [
260
+ "force:data:record:create"
261
+ ],
262
+ "examples": [
263
+ "Insert a record into the Account object of your default org; only the required Name field has a value:\n<%= config.bin %> <%= command.id %> --sobject Account --values \"Name=Acme\"",
264
+ "Insert an Account record with values for two fields, one value contains a space; the command uses the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --sobject Account --values \"Name='Universal Containers' Website=www.example.com\" --target-org my-scratch",
265
+ "Insert a record into the Tooling API object TraceFlag:\n<%= config.bin %> <%= command.id %> --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\""
266
+ ],
267
+ "deprecateAliases": true,
268
+ "flags": {
269
+ "json": {
270
+ "name": "json",
271
+ "type": "boolean",
272
+ "description": "Format output as json.",
273
+ "helpGroup": "GLOBAL",
274
+ "allowNo": false,
275
+ "deprecateAliases": true
276
+ },
277
+ "target-org": {
278
+ "name": "target-org",
279
+ "type": "option",
280
+ "char": "o",
281
+ "summary": "Username or alias of the target org.",
282
+ "required": true,
283
+ "multiple": false,
284
+ "deprecateAliases": true,
285
+ "aliases": [
286
+ "targetusername",
287
+ "u"
288
+ ]
289
+ },
290
+ "api-version": {
291
+ "name": "api-version",
292
+ "type": "option",
293
+ "description": "Override the api version used for api requests made by this command",
294
+ "multiple": false,
295
+ "deprecateAliases": true,
296
+ "aliases": [
297
+ "apiversion"
298
+ ]
299
+ },
300
+ "loglevel": {
301
+ "name": "loglevel",
302
+ "type": "option",
303
+ "hidden": true,
304
+ "multiple": false,
305
+ "deprecated": {
306
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
307
+ },
308
+ "deprecateAliases": true
309
+ },
310
+ "sobject": {
311
+ "name": "sobject",
312
+ "type": "option",
313
+ "char": "s",
314
+ "summary": "API name of the Salesforce or Tooling API object that you're inserting a record into.",
315
+ "required": true,
316
+ "multiple": false,
317
+ "deprecateAliases": true,
318
+ "aliases": [
319
+ "sobjecttype"
320
+ ]
321
+ },
322
+ "values": {
323
+ "name": "values",
324
+ "type": "option",
325
+ "char": "v",
326
+ "summary": "Values for the flags in the form <fieldName>=<value>, separate multiple pairs with spaces.",
327
+ "required": true,
328
+ "multiple": false,
329
+ "deprecateAliases": true
330
+ },
331
+ "use-tooling-api": {
332
+ "name": "use-tooling-api",
333
+ "type": "boolean",
334
+ "char": "t",
335
+ "summary": "Use Tooling API so you can insert a record in a Tooling API object.",
336
+ "allowNo": false,
337
+ "deprecateAliases": true,
338
+ "aliases": [
339
+ "usetoolingapi"
340
+ ]
341
+ },
342
+ "perflog": {
343
+ "name": "perflog",
344
+ "type": "boolean",
345
+ "summary": "Get API performance data.",
346
+ "description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
347
+ "hidden": true,
348
+ "allowNo": false,
349
+ "deprecated": {
350
+ "version": "57"
351
+ },
352
+ "deprecateAliases": true
353
+ }
354
+ },
355
+ "args": {},
356
+ "hasDynamicHelp": true
357
+ },
358
+ "data:delete:bulk": {
359
+ "id": "data:delete:bulk",
360
+ "summary": "Bulk delete records from an org using a CSV file.",
361
+ "description": "The CSV file must have only one column (\"Id\") and then the list of record IDs you want to delete, one ID per line.\n\nWhen you execute this command, it starts a job and one or more batches, displays their IDs, and then immediately returns control of the terminal to you by default. If you prefer to wait, set the --wait flag to the number of minutes; if it times out, the command outputs the IDs. Use the job and batch IDs to check the status of the job with the \"<%= config.bin %> data resume\" command. A single job can contain many batches, depending on the length of the CSV file.",
362
+ "strict": true,
363
+ "pluginName": "@salesforce/plugin-data",
364
+ "pluginAlias": "@salesforce/plugin-data",
365
+ "pluginType": "core",
366
+ "aliases": [
367
+ "force:data:bulk:delete"
368
+ ],
369
+ "examples": [
370
+ "Bulk delete Account records using the list of IDs in the \"files/delete.csv\" file:\n<%= config.bin %> <%= command.id %> --sobject Account --file files/delete.csv",
371
+ "Bulk delete records from a custom object and wait 5 minutes for the command to complete:\n<%= config.bin %> <%= command.id %> --sobject MyObject__c --file files/delete.csv --wait 5"
372
+ ],
373
+ "deprecateAliases": true,
374
+ "flags": {
375
+ "json": {
376
+ "name": "json",
377
+ "type": "boolean",
378
+ "description": "Format output as json.",
379
+ "helpGroup": "GLOBAL",
380
+ "allowNo": false,
381
+ "deprecateAliases": true
382
+ },
383
+ "target-org": {
384
+ "name": "target-org",
385
+ "type": "option",
386
+ "char": "o",
387
+ "summary": "Username or alias of the target org.",
388
+ "required": true,
389
+ "multiple": false,
390
+ "deprecateAliases": true,
391
+ "aliases": [
392
+ "targetusername",
393
+ "u"
394
+ ]
395
+ },
396
+ "api-version": {
397
+ "name": "api-version",
398
+ "type": "option",
399
+ "description": "Override the api version used for api requests made by this command",
400
+ "multiple": false,
401
+ "deprecateAliases": true,
402
+ "aliases": [
403
+ "apiversion"
404
+ ]
405
+ },
406
+ "loglevel": {
407
+ "name": "loglevel",
408
+ "type": "option",
409
+ "hidden": true,
410
+ "multiple": false,
411
+ "deprecated": {
412
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
413
+ },
414
+ "deprecateAliases": true
415
+ },
416
+ "file": {
417
+ "name": "file",
418
+ "type": "option",
419
+ "char": "f",
420
+ "summary": "CSV file that contains the IDs of the records to delete.",
421
+ "required": true,
422
+ "multiple": false,
423
+ "deprecateAliases": true,
424
+ "aliases": [
425
+ "csvfile"
426
+ ]
427
+ },
428
+ "sobject": {
429
+ "name": "sobject",
430
+ "type": "option",
431
+ "char": "s",
432
+ "summary": "API name of the Salesforce object, either standard or custom, that you want to delete records from.",
433
+ "required": true,
434
+ "multiple": false,
435
+ "deprecateAliases": true,
436
+ "aliases": [
437
+ "sobjecttype"
438
+ ]
439
+ },
440
+ "wait": {
441
+ "name": "wait",
442
+ "type": "option",
443
+ "char": "w",
444
+ "summary": "Number of minutes to wait for the command to complete before displaying the results.",
445
+ "multiple": false,
446
+ "default": {
447
+ "quantity": 0,
448
+ "unit": 0
449
+ },
450
+ "deprecateAliases": true
451
+ }
452
+ },
453
+ "args": {},
454
+ "hasDynamicHelp": true
455
+ },
456
+ "data:delete:record": {
457
+ "id": "data:delete:record",
458
+ "summary": "Deletes a single record from a Salesforce or Tooling API object.",
459
+ "description": "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.\n\nWhen 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.\n\nThis command deletes a record from Salesforce objects by default. Use the --use-tooling-api flag to delete from a Tooling API object.",
460
+ "strict": true,
461
+ "pluginName": "@salesforce/plugin-data",
462
+ "pluginAlias": "@salesforce/plugin-data",
463
+ "pluginType": "core",
464
+ "aliases": [
465
+ "force:data:record:delete"
466
+ ],
467
+ "examples": [
468
+ "Delete a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX",
469
+ "Delete a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name=Acme\"",
470
+ "Delete a record from Account identified with two field values, one that contains a space; the command uses the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name='Universal Containers' Phone='(123) 456-7890'\" --target-org myscratch",
471
+ "Delete a record from the Tooling API object TraceFlag with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --use-tooling-api --sobject TraceFlag --record-id 7tf8c"
472
+ ],
473
+ "deprecateAliases": true,
474
+ "flags": {
475
+ "json": {
476
+ "name": "json",
477
+ "type": "boolean",
478
+ "description": "Format output as json.",
479
+ "helpGroup": "GLOBAL",
480
+ "allowNo": false,
481
+ "deprecateAliases": true
482
+ },
483
+ "target-org": {
484
+ "name": "target-org",
485
+ "type": "option",
486
+ "char": "o",
487
+ "summary": "Username or alias of the target org.",
488
+ "required": true,
489
+ "multiple": false,
490
+ "deprecateAliases": true,
491
+ "aliases": [
492
+ "targetusername",
493
+ "u"
494
+ ]
495
+ },
496
+ "api-version": {
497
+ "name": "api-version",
498
+ "type": "option",
499
+ "description": "Override the api version used for api requests made by this command",
500
+ "multiple": false,
501
+ "deprecateAliases": true,
502
+ "aliases": [
503
+ "apiversion"
504
+ ]
505
+ },
506
+ "loglevel": {
507
+ "name": "loglevel",
508
+ "type": "option",
509
+ "hidden": true,
510
+ "multiple": false,
511
+ "deprecated": {
512
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
513
+ },
514
+ "deprecateAliases": true
515
+ },
516
+ "sobject": {
517
+ "name": "sobject",
518
+ "type": "option",
519
+ "char": "s",
520
+ "summary": "API name of the Salesforce or Tooling API object that you're deleting a record from.",
521
+ "required": true,
522
+ "multiple": false,
523
+ "deprecateAliases": true,
524
+ "aliases": [
525
+ "sobjecttype"
526
+ ]
527
+ },
528
+ "record-id": {
529
+ "name": "record-id",
530
+ "type": "option",
531
+ "char": "i",
532
+ "summary": "ID of the record you’re deleting.",
533
+ "multiple": false,
534
+ "deprecateAliases": true,
535
+ "aliases": [
536
+ "sobjectid"
537
+ ]
538
+ },
539
+ "where": {
540
+ "name": "where",
541
+ "type": "option",
542
+ "char": "w",
543
+ "summary": "List of <fieldName>=<value> pairs that identify the record you want to delete.",
544
+ "multiple": false,
545
+ "deprecateAliases": true
546
+ },
547
+ "use-tooling-api": {
548
+ "name": "use-tooling-api",
549
+ "type": "boolean",
550
+ "char": "t",
551
+ "summary": "Use Tooling API so you can delete a record from a Tooling API object.",
552
+ "allowNo": false,
553
+ "deprecateAliases": true,
554
+ "aliases": [
555
+ "usetoolingapi"
556
+ ]
557
+ },
558
+ "perflog": {
559
+ "name": "perflog",
560
+ "type": "boolean",
561
+ "summary": "Get API performance data.",
562
+ "description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
563
+ "hidden": true,
564
+ "allowNo": false,
565
+ "deprecated": {
566
+ "version": "57"
567
+ },
568
+ "deprecateAliases": true
569
+ }
570
+ },
571
+ "args": {},
572
+ "hasDynamicHelp": true
573
+ },
574
+ "data:export:tree": {
575
+ "id": "data:export:tree",
576
+ "summary": "Export data from an org into one or more JSON files.",
577
+ "description": "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 \"<%= config.bin %> data import tree\" command.\n\nIf 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.\n\nThe 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).",
578
+ "strict": true,
579
+ "pluginName": "@salesforce/plugin-data",
580
+ "pluginAlias": "@salesforce/plugin-data",
581
+ "pluginType": "core",
582
+ "aliases": [
583
+ "force:data:tree:export"
584
+ ],
585
+ "examples": [
586
+ "Export records retrieved with the specified SOQL query into a single JSON file in the current directory; the command uses your default org:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id, Name, (SELECT Name, Address__c FROM Properties__r) FROM Broker__c\"",
587
+ "Export data using a SOQL query in the \"query.txt\" file and generate JSON files for each object and a plan that aggregates them:\n<%= config.bin %> <%= command.id %> --query query.txt --plan",
588
+ "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\":\n<%= config.bin %> <%= command.id %> --query query.txt --plan --prefix export-demo --output-dir export-out --target-org my-scratch"
589
+ ],
590
+ "deprecateAliases": true,
591
+ "flags": {
592
+ "json": {
593
+ "name": "json",
594
+ "type": "boolean",
595
+ "description": "Format output as json.",
596
+ "helpGroup": "GLOBAL",
597
+ "allowNo": false,
598
+ "deprecateAliases": true
599
+ },
600
+ "target-org": {
601
+ "name": "target-org",
602
+ "type": "option",
603
+ "char": "o",
604
+ "summary": "Username or alias of the target org.",
605
+ "required": true,
606
+ "multiple": false,
607
+ "deprecateAliases": true,
608
+ "aliases": [
609
+ "targetusername",
610
+ "u"
611
+ ]
612
+ },
613
+ "api-version": {
614
+ "name": "api-version",
615
+ "type": "option",
616
+ "description": "Override the api version used for api requests made by this command",
617
+ "multiple": false,
618
+ "deprecateAliases": true,
619
+ "aliases": [
620
+ "apiversion"
621
+ ]
622
+ },
623
+ "loglevel": {
624
+ "name": "loglevel",
625
+ "type": "option",
626
+ "hidden": true,
627
+ "multiple": false,
628
+ "deprecated": {
629
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
630
+ },
631
+ "deprecateAliases": true
632
+ },
633
+ "query": {
634
+ "name": "query",
635
+ "type": "option",
636
+ "char": "q",
637
+ "summary": "SOQL query, or filepath of a file that contains the query, to retrieve records.",
638
+ "required": true,
639
+ "multiple": false,
640
+ "deprecateAliases": true
641
+ },
642
+ "plan": {
643
+ "name": "plan",
644
+ "type": "boolean",
645
+ "char": "p",
646
+ "summary": "Generate multiple sObject tree files and a plan definition file for aggregated import.",
647
+ "allowNo": false,
648
+ "deprecateAliases": true
649
+ },
650
+ "prefix": {
651
+ "name": "prefix",
652
+ "type": "option",
653
+ "char": "x",
654
+ "summary": "Prefix of generated files.",
655
+ "multiple": false,
656
+ "deprecateAliases": true
657
+ },
658
+ "output-dir": {
659
+ "name": "output-dir",
660
+ "type": "option",
661
+ "char": "d",
662
+ "summary": "Directory in which to generate the JSON files; default is current directory.",
663
+ "multiple": false,
664
+ "deprecateAliases": true,
665
+ "aliases": [
666
+ "outputdir"
667
+ ]
668
+ }
669
+ },
670
+ "args": {},
671
+ "hasDynamicHelp": true
672
+ },
673
+ "data:get:record": {
674
+ "id": "data:get:record",
675
+ "summary": "Retrieve and display a single record of a Salesforce or Tooling API object.",
676
+ "description": "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.\n\nWhen 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.\n\nThe command displays all the record's fields and their values, one field per terminal line. Fields with no values are displayed as \"null\".\n\nThis command retrieves a record from Salesforce objects by default. Use the --use-tooling-api flag to retrieve from a Tooling API object.",
677
+ "strict": true,
678
+ "pluginName": "@salesforce/plugin-data",
679
+ "pluginAlias": "@salesforce/plugin-data",
680
+ "pluginType": "core",
681
+ "aliases": [
682
+ "force:data:record:get"
683
+ ],
684
+ "examples": [
685
+ "Retrieve and display a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX",
686
+ "Retrieve a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name=Acme\"",
687
+ "Retrieve a record from Account identified with two field values, one that contains a space; the command uses the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name='Universal Containers' Phone='(123) 456-7890'\" --target-org myscratch",
688
+ "Retrieve a record from the Tooling API object TraceFlag with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --use-tooling-api --sobject TraceFlag --record-id 7tf8c"
689
+ ],
690
+ "deprecateAliases": true,
691
+ "flags": {
692
+ "json": {
693
+ "name": "json",
694
+ "type": "boolean",
695
+ "description": "Format output as json.",
696
+ "helpGroup": "GLOBAL",
697
+ "allowNo": false,
698
+ "deprecateAliases": true
699
+ },
700
+ "target-org": {
701
+ "name": "target-org",
702
+ "type": "option",
703
+ "char": "o",
704
+ "summary": "Username or alias of the target org.",
705
+ "required": true,
706
+ "multiple": false,
707
+ "deprecateAliases": true,
708
+ "aliases": [
709
+ "targetusername",
710
+ "u"
711
+ ]
712
+ },
713
+ "api-version": {
714
+ "name": "api-version",
715
+ "type": "option",
716
+ "description": "Override the api version used for api requests made by this command",
717
+ "multiple": false,
718
+ "deprecateAliases": true,
719
+ "aliases": [
720
+ "apiversion"
721
+ ]
722
+ },
723
+ "loglevel": {
724
+ "name": "loglevel",
725
+ "type": "option",
726
+ "hidden": true,
727
+ "multiple": false,
728
+ "deprecated": {
729
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
730
+ },
731
+ "deprecateAliases": true
732
+ },
733
+ "sobject": {
734
+ "name": "sobject",
735
+ "type": "option",
736
+ "char": "s",
737
+ "summary": "API name of the Salesforce or Tooling API object that you're retrieving a record from.",
738
+ "required": true,
739
+ "multiple": false,
740
+ "deprecateAliases": true,
741
+ "aliases": [
742
+ "sobjecttype"
743
+ ]
744
+ },
745
+ "record-id": {
746
+ "name": "record-id",
747
+ "type": "option",
748
+ "char": "i",
749
+ "summary": "ID of the record you’re retrieving.",
750
+ "multiple": false,
751
+ "deprecateAliases": true,
752
+ "aliases": [
753
+ "sobjectid"
754
+ ]
755
+ },
756
+ "where": {
757
+ "name": "where",
758
+ "type": "option",
759
+ "char": "w",
760
+ "summary": "List of <fieldName>=<value> pairs that identify the record you want to display.",
761
+ "multiple": false,
762
+ "deprecateAliases": true
763
+ },
764
+ "use-tooling-api": {
765
+ "name": "use-tooling-api",
766
+ "type": "boolean",
767
+ "char": "t",
768
+ "summary": "Use Tooling API so you can retrieve a record from a Tooling API object.",
769
+ "allowNo": false,
770
+ "deprecateAliases": true,
771
+ "aliases": [
772
+ "usetoolingapi"
773
+ ]
774
+ },
775
+ "perflog": {
776
+ "name": "perflog",
777
+ "type": "boolean",
778
+ "summary": "Get API performance data.",
779
+ "description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
780
+ "hidden": true,
781
+ "allowNo": false,
782
+ "deprecated": {
783
+ "version": "57"
784
+ },
785
+ "deprecateAliases": true
786
+ }
787
+ },
788
+ "args": {},
789
+ "hasDynamicHelp": true
790
+ },
791
+ "data:import:tree": {
792
+ "id": "data:import:tree",
793
+ "summary": "Import data from one or more JSON files into an org.",
794
+ "description": "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 \"<%= config.bin %> data export tree\" command to generate these JSON files.\n\nIf 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.\n\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)",
795
+ "strict": true,
796
+ "pluginName": "@salesforce/plugin-data",
797
+ "pluginAlias": "@salesforce/plugin-data",
798
+ "pluginType": "core",
799
+ "aliases": [
800
+ "force:data:tree:import"
801
+ ],
802
+ "examples": [
803
+ "Import the records contained in two JSON files into the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --files Contact.json,Account.json --target-org my-scratch",
804
+ "Import records using a plan definition file into your default org:\n<%= config.bin %> <%= command.id %> --plan Account-Contact-plan.json"
805
+ ],
806
+ "deprecateAliases": true,
807
+ "flags": {
808
+ "json": {
809
+ "name": "json",
810
+ "type": "boolean",
811
+ "description": "Format output as json.",
812
+ "helpGroup": "GLOBAL",
813
+ "allowNo": false,
814
+ "deprecateAliases": true
815
+ },
816
+ "target-org": {
817
+ "name": "target-org",
818
+ "type": "option",
819
+ "char": "o",
820
+ "summary": "Username or alias of the target org.",
821
+ "required": true,
822
+ "multiple": false,
823
+ "deprecateAliases": true,
824
+ "aliases": [
825
+ "targetusername",
826
+ "u"
827
+ ]
828
+ },
829
+ "api-version": {
830
+ "name": "api-version",
831
+ "type": "option",
832
+ "description": "Override the api version used for api requests made by this command",
833
+ "multiple": false,
834
+ "deprecateAliases": true,
835
+ "aliases": [
836
+ "apiversion"
837
+ ]
838
+ },
839
+ "loglevel": {
840
+ "name": "loglevel",
841
+ "type": "option",
842
+ "hidden": true,
843
+ "multiple": false,
844
+ "deprecated": {
845
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
846
+ },
847
+ "deprecateAliases": true
848
+ },
849
+ "files": {
850
+ "name": "files",
851
+ "type": "option",
852
+ "char": "f",
853
+ "summary": "Comma-separated and in-order JSON files that contain the records, in sObject tree format, that you want to insert.",
854
+ "multiple": true,
855
+ "exclusive": [
856
+ "plan"
857
+ ],
858
+ "deprecateAliases": true,
859
+ "aliases": [
860
+ "sobjecttreefiles"
861
+ ]
862
+ },
863
+ "plan": {
864
+ "name": "plan",
865
+ "type": "option",
866
+ "char": "p",
867
+ "summary": "Plan definition file to insert multiple data files.",
868
+ "multiple": false,
869
+ "deprecateAliases": true
870
+ },
871
+ "content-type": {
872
+ "name": "content-type",
873
+ "type": "option",
874
+ "char": "c",
875
+ "summary": "Content type of import files if their extention is not .json.",
876
+ "hidden": true,
877
+ "multiple": false,
878
+ "deprecateAliases": true,
879
+ "aliases": [
880
+ "contenttype"
881
+ ]
882
+ },
883
+ "config-help": {
884
+ "name": "config-help",
885
+ "type": "boolean",
886
+ "summary": "Display schema information for the --plan configuration file to stdout; if you specify this flag, all other flags except --json are ignored.",
887
+ "allowNo": false,
888
+ "deprecateAliases": true,
889
+ "aliases": [
890
+ "confighelp"
891
+ ]
892
+ }
893
+ },
894
+ "args": {},
895
+ "hasDynamicHelp": true
896
+ },
897
+ "data:query:resume": {
898
+ "id": "data:query:resume",
899
+ "summary": "View the status of a bulk query.",
900
+ "description": "Run this command using the job ID returned from the \"<%= config.bin %> data query --bulk\" command.",
901
+ "strict": true,
902
+ "pluginName": "@salesforce/plugin-data",
903
+ "pluginAlias": "@salesforce/plugin-data",
904
+ "pluginType": "core",
905
+ "aliases": [
906
+ "force:data:soql:bulk:report"
907
+ ],
908
+ "examples": [
909
+ "View the status of a bulk query with the specified ID:\n<%= config.bin %> <%= command.id %> --bulk-query-id 7500x000005BdFzXXX"
910
+ ],
911
+ "deprecateAliases": true,
912
+ "flags": {
913
+ "json": {
914
+ "name": "json",
915
+ "type": "boolean",
916
+ "description": "Format output as json.",
917
+ "helpGroup": "GLOBAL",
918
+ "allowNo": false,
919
+ "deprecateAliases": true
920
+ },
921
+ "target-org": {
922
+ "name": "target-org",
923
+ "type": "option",
924
+ "char": "o",
925
+ "summary": "Username or alias of the target org.",
926
+ "required": true,
927
+ "multiple": false,
928
+ "deprecateAliases": true,
929
+ "aliases": [
930
+ "targetusername",
931
+ "u"
932
+ ]
933
+ },
934
+ "api-version": {
935
+ "name": "api-version",
936
+ "type": "option",
937
+ "description": "Override the api version used for api requests made by this command",
938
+ "multiple": false,
939
+ "deprecateAliases": true,
940
+ "aliases": [
941
+ "apiversion"
942
+ ]
943
+ },
944
+ "loglevel": {
945
+ "name": "loglevel",
946
+ "type": "option",
947
+ "hidden": true,
948
+ "multiple": false,
949
+ "deprecated": {
950
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
951
+ },
952
+ "deprecateAliases": true
953
+ },
954
+ "result-format": {
955
+ "name": "result-format",
956
+ "type": "option",
957
+ "char": "r",
958
+ "summary": "Format to display the results; the --json flag overrides this flag.",
959
+ "helpValue": "(human|json|csv)",
960
+ "multiple": false,
961
+ "options": [
962
+ "human",
963
+ "json",
964
+ "csv"
965
+ ],
966
+ "default": "human",
967
+ "deprecateAliases": true,
968
+ "aliases": [
969
+ "resultformat"
970
+ ]
971
+ },
972
+ "bulk-query-id": {
973
+ "name": "bulk-query-id",
974
+ "type": "option",
975
+ "char": "i",
976
+ "summary": "Job ID of the bulk query.",
977
+ "required": true,
978
+ "multiple": false,
979
+ "deprecateAliases": true,
980
+ "aliases": [
981
+ "bulkqueryid"
982
+ ]
983
+ }
984
+ },
985
+ "args": {},
986
+ "hasDynamicHelp": true
987
+ },
988
+ "data:update:record": {
989
+ "id": "data:update:record",
990
+ "summary": "Updates a single record of a Salesforce or Tooling API object.",
991
+ "description": "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 delete fails; the error displays how many records were found.\n\nWhen 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.\n\nThis command updates a record in Salesforce objects by default. Use the --use-tooling-api flag to update a Tooling API object.",
992
+ "strict": true,
993
+ "pluginName": "@salesforce/plugin-data",
994
+ "pluginAlias": "@salesforce/plugin-data",
995
+ "pluginType": "core",
996
+ "aliases": [
997
+ "force:data:record:update"
998
+ ],
999
+ "examples": [
1000
+ "Update the Name field of an Account record with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 001D0 --values \"Name=NewAcme\"",
1001
+ "Update the Name field of an Account record whose current name is 'Old Acme':\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name='Old Acme'\" --values \"Name='New Acme'\"",
1002
+ "Update the Name and Website fields of an Account record with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 001D0 --values \"Name='Acme III' Website=www.example.com\"",
1003
+ "Update the ExpirationDate field of a record of the Tooling API object TraceFlag using the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> -t --sobject TraceFlag --record-id 7tf170000009cUBAAY --values \"ExpirationDate=2017-12-01T00:58:04.000+0000\""
1004
+ ],
1005
+ "deprecateAliases": true,
1006
+ "flags": {
1007
+ "json": {
1008
+ "name": "json",
1009
+ "type": "boolean",
1010
+ "description": "Format output as json.",
1011
+ "helpGroup": "GLOBAL",
1012
+ "allowNo": false,
1013
+ "deprecateAliases": true
1014
+ },
1015
+ "target-org": {
1016
+ "name": "target-org",
1017
+ "type": "option",
1018
+ "char": "o",
1019
+ "summary": "Username or alias of the target org.",
1020
+ "required": true,
1021
+ "multiple": false,
1022
+ "deprecateAliases": true,
1023
+ "aliases": [
1024
+ "targetusername",
1025
+ "u"
1026
+ ]
1027
+ },
1028
+ "api-version": {
1029
+ "name": "api-version",
1030
+ "type": "option",
1031
+ "description": "Override the api version used for api requests made by this command",
1032
+ "multiple": false,
1033
+ "deprecateAliases": true,
1034
+ "aliases": [
1035
+ "apiversion"
1036
+ ]
1037
+ },
1038
+ "loglevel": {
1039
+ "name": "loglevel",
1040
+ "type": "option",
1041
+ "hidden": true,
1042
+ "multiple": false,
1043
+ "deprecated": {
1044
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
1045
+ },
1046
+ "deprecateAliases": true
1047
+ },
1048
+ "sobject": {
1049
+ "name": "sobject",
1050
+ "type": "option",
1051
+ "char": "s",
1052
+ "summary": "API name of the Salesforce or Tooling API object that contains the record you're updating.",
1053
+ "required": true,
1054
+ "multiple": false,
1055
+ "deprecateAliases": true,
1056
+ "aliases": [
1057
+ "sobjecttype"
1058
+ ]
1059
+ },
1060
+ "record-id": {
1061
+ "name": "record-id",
1062
+ "type": "option",
1063
+ "char": "i",
1064
+ "summary": "ID of the record you’re updating.",
1065
+ "multiple": false,
1066
+ "deprecateAliases": true,
1067
+ "aliases": [
1068
+ "sobjectid"
1069
+ ]
1070
+ },
1071
+ "where": {
1072
+ "name": "where",
1073
+ "type": "option",
1074
+ "char": "w",
1075
+ "summary": "List of <fieldName>=<value> pairs that identify the record you want to update.",
1076
+ "multiple": false,
1077
+ "deprecateAliases": true
1078
+ },
1079
+ "values": {
1080
+ "name": "values",
1081
+ "type": "option",
1082
+ "char": "v",
1083
+ "summary": "Fields that you're updating, in the format of <fieldName>=<value> pairs.",
1084
+ "required": true,
1085
+ "multiple": false,
1086
+ "deprecateAliases": true
1087
+ },
1088
+ "use-tooling-api": {
1089
+ "name": "use-tooling-api",
1090
+ "type": "boolean",
1091
+ "char": "t",
1092
+ "summary": "Use Tooling API so you can update a record in a Tooling API object.",
1093
+ "allowNo": false,
1094
+ "deprecateAliases": true,
1095
+ "aliases": [
1096
+ "usetoolingapi"
1097
+ ]
1098
+ },
1099
+ "perflog": {
1100
+ "name": "perflog",
1101
+ "type": "boolean",
1102
+ "summary": "Get API performance data.",
1103
+ "hidden": true,
1104
+ "allowNo": false,
1105
+ "deprecated": {
1106
+ "version": "57"
1107
+ },
1108
+ "deprecateAliases": true
1109
+ }
1110
+ },
1111
+ "args": {},
1112
+ "hasDynamicHelp": true
1113
+ },
1114
+ "data:upsert:bulk": {
1115
+ "id": "data:upsert:bulk",
1116
+ "summary": "Bulk upsert records to an org from a CSV file.",
1117
+ "description": "An upsert refers to inserting a record into a Salesforce object if the record doesn't already exist, or updating it if it does exist.\n\nWhen you execute this command, it starts a job and one or more batches, displays their IDs, and then immediately returns control of the terminal to you by default. If you prefer to wait, set the --wait flag to the number of minutes; if it times out, the command outputs the IDs. Use the job and batch IDs to check the status of the job with the \"<%= config.bin %> data resume\" command. A single job can contain many batches, depending on the length of the CSV file.\n\nSee \"Prepare CSV Files\" in the Bulk API Developer Guide for details on formatting your CSV file. (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_csv_preparing.htm)\n\nBy default, the job runs the batches in parallel, which we recommend. You can run jobs serially by specifying the --serial flag. But don't process data in serial mode unless you know this would otherwise result in lock timeouts and you can't reorganize your batches to avoid the locks.",
1118
+ "strict": true,
1119
+ "pluginName": "@salesforce/plugin-data",
1120
+ "pluginAlias": "@salesforce/plugin-data",
1121
+ "pluginType": "core",
1122
+ "aliases": [
1123
+ "force:data:bulk:upsert"
1124
+ ],
1125
+ "examples": [
1126
+ "Bulk upsert records to the Contact object:\n<%= config.bin %> --sobject Contact --file files/contacts.csv --external-id Id",
1127
+ "Bulk upsert records to a custom object and wait 5 minutes for the command to complete:\n<%= config.bin %> <%= command.id %> --sobject MyObject__c --file files/file.csv --external-id MyField__c --wait 5"
1128
+ ],
1129
+ "deprecateAliases": true,
1130
+ "flags": {
1131
+ "json": {
1132
+ "name": "json",
1133
+ "type": "boolean",
1134
+ "description": "Format output as json.",
1135
+ "helpGroup": "GLOBAL",
1136
+ "allowNo": false,
1137
+ "deprecateAliases": true
1138
+ },
1139
+ "target-org": {
1140
+ "name": "target-org",
1141
+ "type": "option",
1142
+ "char": "o",
1143
+ "summary": "Username or alias of the target org.",
1144
+ "required": true,
1145
+ "multiple": false,
1146
+ "deprecateAliases": true,
1147
+ "aliases": [
1148
+ "targetusername",
1149
+ "u"
1150
+ ]
1151
+ },
1152
+ "api-version": {
1153
+ "name": "api-version",
1154
+ "type": "option",
1155
+ "description": "Override the api version used for api requests made by this command",
1156
+ "multiple": false,
1157
+ "deprecateAliases": true,
1158
+ "aliases": [
1159
+ "apiversion"
1160
+ ]
1161
+ },
1162
+ "loglevel": {
1163
+ "name": "loglevel",
1164
+ "type": "option",
1165
+ "hidden": true,
1166
+ "multiple": false,
1167
+ "deprecated": {
1168
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
1169
+ },
1170
+ "deprecateAliases": true
1171
+ },
1172
+ "external-id": {
1173
+ "name": "external-id",
1174
+ "type": "option",
1175
+ "char": "i",
1176
+ "summary": "Name of the external ID field, or the Id field.",
1177
+ "required": true,
1178
+ "multiple": false,
1179
+ "deprecateAliases": true,
1180
+ "aliases": [
1181
+ "externalid"
1182
+ ]
1183
+ },
1184
+ "file": {
1185
+ "name": "file",
1186
+ "type": "option",
1187
+ "char": "f",
1188
+ "summary": "CSV file that contains the records to upsert.",
1189
+ "required": true,
1190
+ "multiple": false,
1191
+ "deprecateAliases": true,
1192
+ "aliases": [
1193
+ "csvfile"
1194
+ ]
1195
+ },
1196
+ "sobject": {
1197
+ "name": "sobject",
1198
+ "type": "option",
1199
+ "char": "s",
1200
+ "summary": "API name of the Salesforce object, either standard or custom, that you want to upsert records to.",
1201
+ "required": true,
1202
+ "multiple": false,
1203
+ "deprecateAliases": true,
1204
+ "aliases": [
1205
+ "sobjecttype"
1206
+ ]
1207
+ },
1208
+ "wait": {
1209
+ "name": "wait",
1210
+ "type": "option",
1211
+ "char": "w",
1212
+ "summary": "Number of minutes to wait for the command to complete before displaying the results.",
1213
+ "multiple": false,
1214
+ "default": {
1215
+ "quantity": 0,
1216
+ "unit": 0
1217
+ },
1218
+ "deprecateAliases": true
1219
+ },
1220
+ "serial": {
1221
+ "name": "serial",
1222
+ "type": "boolean",
1223
+ "char": "r",
1224
+ "summary": "Run batches in serial mode.",
1225
+ "allowNo": false,
1226
+ "deprecateAliases": true
1227
+ }
1228
+ },
1229
+ "args": {},
1230
+ "hasDynamicHelp": true
1231
+ }
1232
+ }
1233
+ }