@salesforce/plugin-data 2.1.21 → 2.1.22

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.
Files changed (109) hide show
  1. package/README.md +947 -320
  2. package/lib/api/data/tree/exportApi.js +66 -73
  3. package/lib/api/data/tree/exportApi.js.map +1 -1
  4. package/lib/api/data/tree/importApi.js +62 -62
  5. package/lib/api/data/tree/importApi.js.map +1 -1
  6. package/lib/batcher.js +80 -101
  7. package/lib/batcher.js.map +1 -1
  8. package/lib/commands/data/create/record.js +64 -0
  9. package/lib/commands/data/create/record.js.map +1 -0
  10. package/lib/commands/data/delete/bulk.js +78 -0
  11. package/lib/commands/data/delete/bulk.js.map +1 -0
  12. package/lib/commands/data/delete/record.js +83 -0
  13. package/lib/commands/data/delete/record.js.map +1 -0
  14. package/lib/commands/data/export/tree.js +57 -0
  15. package/lib/commands/data/export/tree.js.map +1 -0
  16. package/lib/commands/data/get/record.js +73 -0
  17. package/lib/commands/data/get/record.js.map +1 -0
  18. package/lib/commands/data/import/tree.js +85 -0
  19. package/lib/commands/data/import/tree.js.map +1 -0
  20. package/lib/commands/data/query/resume.js +55 -0
  21. package/lib/commands/data/query/resume.js.map +1 -0
  22. package/lib/commands/data/query.js +283 -0
  23. package/lib/commands/data/query.js.map +1 -0
  24. package/lib/commands/data/resume.js +64 -0
  25. package/lib/commands/data/resume.js.map +1 -0
  26. package/lib/commands/data/update/record.js +101 -0
  27. package/lib/commands/data/update/record.js.map +1 -0
  28. package/lib/commands/data/upsert/bulk.js +88 -0
  29. package/lib/commands/data/upsert/bulk.js.map +1 -0
  30. package/lib/dataCommand.js +103 -202
  31. package/lib/dataCommand.js.map +1 -1
  32. package/lib/dataSoqlQueryTypes.js +2 -6
  33. package/lib/dataSoqlQueryTypes.js.map +1 -1
  34. package/lib/flags.js +27 -0
  35. package/lib/flags.js.map +1 -0
  36. package/lib/reporters.js +58 -66
  37. package/lib/reporters.js.map +1 -1
  38. package/messages/batcher.md +39 -0
  39. package/messages/bulk.delete.md +31 -0
  40. package/messages/bulk.report.md +17 -0
  41. package/messages/bulk.status.md +29 -0
  42. package/messages/bulk.upsert.md +43 -0
  43. package/messages/exportApi.md +25 -0
  44. package/messages/importApi.md +52 -0
  45. package/messages/messages.md +20 -0
  46. package/messages/record.create.md +45 -0
  47. package/messages/record.delete.md +53 -0
  48. package/messages/record.get.md +47 -0
  49. package/messages/record.update.md +61 -0
  50. package/messages/soql.query.md +72 -0
  51. package/messages/tree.export.md +41 -0
  52. package/messages/tree.import.md +37 -0
  53. package/oclif.manifest.json +1 -1
  54. package/package.json +50 -51
  55. package/lib/api/data/tree/exportApi.d.ts +0 -77
  56. package/lib/api/data/tree/importApi.d.ts +0 -60
  57. package/lib/batcher.d.ts +0 -79
  58. package/lib/commands/force/data/bulk/delete.d.ts +0 -11
  59. package/lib/commands/force/data/bulk/delete.js +0 -58
  60. package/lib/commands/force/data/bulk/delete.js.map +0 -1
  61. package/lib/commands/force/data/bulk/status.d.ts +0 -11
  62. package/lib/commands/force/data/bulk/status.js +0 -61
  63. package/lib/commands/force/data/bulk/status.js.map +0 -1
  64. package/lib/commands/force/data/bulk/upsert.d.ts +0 -11
  65. package/lib/commands/force/data/bulk/upsert.js +0 -76
  66. package/lib/commands/force/data/bulk/upsert.js.map +0 -1
  67. package/lib/commands/force/data/record/create.d.ts +0 -10
  68. package/lib/commands/force/data/record/create.js +0 -58
  69. package/lib/commands/force/data/record/create.js.map +0 -1
  70. package/lib/commands/force/data/record/delete.d.ts +0 -10
  71. package/lib/commands/force/data/record/delete.js +0 -72
  72. package/lib/commands/force/data/record/delete.js.map +0 -1
  73. package/lib/commands/force/data/record/get.d.ts +0 -10
  74. package/lib/commands/force/data/record/get.js +0 -65
  75. package/lib/commands/force/data/record/get.js.map +0 -1
  76. package/lib/commands/force/data/record/update.d.ts +0 -10
  77. package/lib/commands/force/data/record/update.js +0 -90
  78. package/lib/commands/force/data/record/update.js.map +0 -1
  79. package/lib/commands/force/data/soql/bulk/report.d.ts +0 -9
  80. package/lib/commands/force/data/soql/bulk/report.js +0 -45
  81. package/lib/commands/force/data/soql/bulk/report.js.map +0 -1
  82. package/lib/commands/force/data/soql/query.d.ts +0 -64
  83. package/lib/commands/force/data/soql/query.js +0 -300
  84. package/lib/commands/force/data/soql/query.js.map +0 -1
  85. package/lib/commands/force/data/tree/export.d.ts +0 -10
  86. package/lib/commands/force/data/tree/export.js +0 -52
  87. package/lib/commands/force/data/tree/export.js.map +0 -1
  88. package/lib/commands/force/data/tree/import.d.ts +0 -19
  89. package/lib/commands/force/data/tree/import.js +0 -81
  90. package/lib/commands/force/data/tree/import.js.map +0 -1
  91. package/lib/dataCommand.d.ts +0 -57
  92. package/lib/dataSoqlQueryTypes.d.ts +0 -63
  93. package/lib/index.d.ts +0 -2
  94. package/lib/reporters.d.ts +0 -57
  95. package/messages/batcher.json +0 -12
  96. package/messages/bulk.delete.json +0 -12
  97. package/messages/bulk.report.json +0 -7
  98. package/messages/bulk.status.json +0 -12
  99. package/messages/bulk.upsert.json +0 -14
  100. package/messages/exportApi.json +0 -8
  101. package/messages/importApi.json +0 -16
  102. package/messages/messages.json +0 -11
  103. package/messages/record.create.json +0 -15
  104. package/messages/record.delete.json +0 -16
  105. package/messages/record.get.json +0 -14
  106. package/messages/record.update.json +0 -18
  107. package/messages/soql.query.json +0 -26
  108. package/messages/tree.export.json +0 -11
  109. package/messages/tree.import.json +0 -13
@@ -0,0 +1,47 @@
1
+ # summary
2
+
3
+ Retrieve and display a single record of a Salesforce or Tooling API object.
4
+
5
+ # description
6
+
7
+ 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.
8
+
9
+ When specifying field-value pairs, use the format <fieldName>=<value>. Enclose all field-value pairs in one set of double quotation marks, delimited by spaces. Enclose values that contain spaces in single quotes.
10
+
11
+ The command displays all the record's fields and their values, one field per terminal line. Fields with no values are displayed as "null".
12
+
13
+ This command retrieves a record from Salesforce objects by default. Use the --use-tooling-api flag to retrieve from a Tooling API object.
14
+
15
+ # flags.sobject
16
+
17
+ API name of the Salesforce or Tooling API object that you're retrieving a record from.
18
+
19
+ # flags.recordId
20
+
21
+ ID of the record you’re retrieving.
22
+
23
+ # flags.where
24
+
25
+ List of <fieldName>=<value> pairs that identify the record you want to display.
26
+
27
+ # flags.useToolingApi
28
+
29
+ Use Tooling API so you can retrieve a record from a Tooling API object.
30
+
31
+ # examples
32
+
33
+ - Retrieve and display a record from Account with the specified (truncated) ID:
34
+
35
+ <%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX
36
+
37
+ - Retrieve a record from Account whose name equals "Acme":
38
+
39
+ <%= config.bin %> <%= command.id %> --sobject Account --where "Name=Acme"
40
+
41
+ - Retrieve a record from Account identified with two field values, one that contains a space; the command uses the org with alias "my-scratch":
42
+
43
+ <%= config.bin %> <%= command.id %> --sobject Account --where "Name='Universal Containers' Phone='(123) 456-7890'" --target-org myscratch
44
+
45
+ - Retrieve a record from the Tooling API object TraceFlag with the specified (truncated) ID:
46
+
47
+ <%= config.bin %> <%= command.id %> --use-tooling-api --sobject TraceFlag --record-id 7tf8c
@@ -0,0 +1,61 @@
1
+ # summary
2
+
3
+ Updates a single record of a Salesforce or Tooling API object.
4
+
5
+ # description
6
+
7
+ 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.
8
+
9
+ When using field-value pairs for both identifying the record and specifiyng the new field values, use the format <fieldName>=<value>. Enclose all field-value pairs in one set of double quotation marks, delimited by spaces. Enclose values that contain spaces in single quotes.
10
+
11
+ This command updates a record in Salesforce objects by default. Use the --use-tooling-api flag to update a Tooling API object.
12
+
13
+ # flags.sobject
14
+
15
+ API name of the Salesforce or Tooling API object that contains the record you're updating.
16
+
17
+ # flags.recordId
18
+
19
+ ID of the record you’re updating.
20
+
21
+ # flags.where
22
+
23
+ List of <fieldName>=<value> pairs that identify the record you want to update.
24
+
25
+ # flags.useToolingApi
26
+
27
+ Use Tooling API so you can update a record in a Tooling API object.
28
+
29
+ # flags.values
30
+
31
+ Fields that you're updating, in the format of <fieldName>=<value> pairs.
32
+
33
+ # examples
34
+
35
+ - Update the Name field of an Account record with the specified (truncated) ID:
36
+
37
+ <%= config.bin %> <%= command.id %> --sobject Account --record-id 001D0 --values "Name=NewAcme"
38
+
39
+ - Update the Name field of an Account record whose current name is 'Old Acme':
40
+
41
+ <%= config.bin %> <%= command.id %> --sobject Account --where "Name='Old Acme'" --values "Name='New Acme'"
42
+
43
+ - Update the Name and Website fields of an Account record with the specified (truncated) ID:
44
+
45
+ <%= config.bin %> <%= command.id %> --sobject Account --record-id 001D0 --values "Name='Acme III' Website=www.example.com"
46
+
47
+ - Update the ExpirationDate field of a record of the Tooling API object TraceFlag using the specified (truncated) ID:
48
+
49
+ <%= config.bin %> <%= command.id %> -t --sobject TraceFlag --record-id 7tf170000009cUBAAY --values "ExpirationDate=2017-12-01T00:58:04.000+0000"
50
+
51
+ # updateSuccess
52
+
53
+ Successfully updated record: %s.
54
+
55
+ # updateFailure
56
+
57
+ Failed to update record. %s
58
+
59
+ # updateFailureWithFields
60
+
61
+ Failed to update record with code %s. Message: %s. Fields: %s.
@@ -0,0 +1,72 @@
1
+ # summary
2
+
3
+ Execute a SOQL query.
4
+
5
+ # description
6
+
7
+ Specify the SOQL query at the command line with the --query flag or read the query from a file with the --file flag.
8
+
9
+ If 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.
10
+
11
+ When 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.
12
+
13
+ # examples
14
+
15
+ - Specify a SOQL query at the command line; the command uses your default org:
16
+
17
+ <%= config.bin %> <%= command.id %> --query "SELECT Id, Name, Account.Name FROM Contact"
18
+
19
+ - Read the SOQL query from a file called "query.txt"; the command uses the org with alias "my-scratch":
20
+
21
+ <%= config.bin %> <%= command.id %> --file query.txt --target-org my-scratch
22
+
23
+ - Use Tooling API to run a query on the ApexTrigger Tooling API object:
24
+
25
+ <%= config.bin %> <%= command.id %> --query "SELECT Name FROM ApexTrigger" --use-tooling-api
26
+
27
+ - Use Bulk API 2.0 to run a query that returns many rows, and return control to the terminal immediately:
28
+
29
+ <%= config.bin %> <%= command.id %> --query "SELECT Id FROM Contact" --bulk --wait 0
30
+
31
+ # flags.queryToExecute
32
+
33
+ SOQL query to execute.
34
+
35
+ # flags.useToolingApi
36
+
37
+ Use Tooling API so you can run queries on Tooling API objects.
38
+
39
+ # flags.file
40
+
41
+ File that contains the SOQL query.
42
+
43
+ # flags.bulk
44
+
45
+ Use Bulk API 2.0 to run the query.
46
+
47
+ # flags.async
48
+
49
+ Use Bulk API 2.0, but don't wait for the job to complete.
50
+
51
+ # flags.wait
52
+
53
+ Time to wait for the command to finish, in minutes.
54
+
55
+ # flags.resultFormat
56
+
57
+ Format to display the results; the --json flag overrides this flag.
58
+
59
+ # displayQueryRecordsRetrieved
60
+
61
+ Total number of records retrieved: %s.
62
+
63
+ # queryRunningMessage
64
+
65
+ Querying Data
66
+
67
+ # bulkQueryTimeout
68
+
69
+ Query ID: %s
70
+ Query is in progress.
71
+
72
+ Run "data query resume -i %s -o %s" to get the latest status and results.
@@ -0,0 +1,41 @@
1
+ # summary
2
+
3
+ Export data from an org into one or more JSON files.
4
+
5
+ # description
6
+
7
+ 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.
8
+
9
+ If your SOQL query references multiple objects, the command generates a single JSON file by default. You can specify the --plan flag to generate separate JSON files for each object and a plan definition file that aggregates them. You then specify just this plan definition file when you import the data into an org.
10
+
11
+ The SOQL query can return a maximum of 2,000 records. For more information, see the REST API Developer Guide. (https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm).
12
+
13
+ # flags.query
14
+
15
+ SOQL query, or filepath of a file that contains the query, to retrieve records.
16
+
17
+ # flags.plan
18
+
19
+ Generate multiple sObject tree files and a plan definition file for aggregated import.
20
+
21
+ # flags.prefix
22
+
23
+ Prefix of generated files.
24
+
25
+ # flags.outputdir
26
+
27
+ Directory in which to generate the JSON files; default is current directory.
28
+
29
+ # examples
30
+
31
+ - Export records retrieved with the specified SOQL query into a single JSON file in the current directory; the command uses your default org:
32
+
33
+ <%= config.bin %> <%= command.id %> --query "SELECT Id, Name, (SELECT Name, Address__c FROM Properties__r) FROM Broker__c"
34
+
35
+ - Export data using a SOQL query in the "query.txt" file and generate JSON files for each object and a plan that aggregates them:
36
+
37
+ <%= config.bin %> <%= command.id %> --query query.txt --plan
38
+
39
+ - 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":
40
+
41
+ <%= config.bin %> <%= command.id %> --query query.txt --plan --prefix export-demo --output-dir export-out --target-org my-scratch
@@ -0,0 +1,37 @@
1
+ # summary
2
+
3
+ Import data from one or more JSON files into an org.
4
+
5
+ # description
6
+
7
+ 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.
8
+
9
+ If you used the --plan flag when exporting the data to generate a plan definition file, use the --plan flag to reference the file when you import. If you're not using a plan, use the --files flag to list the files. If you specify multiple JSON files that depend on each other in a parent-child relationship, be sure you list them in the correct order.
10
+
11
+ The 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)
12
+
13
+ # flags.files
14
+
15
+ Comma-separated and in-order JSON files that contain the records, in sObject tree format, that you want to insert.
16
+
17
+ # flags.plan
18
+
19
+ Plan definition file to insert multiple data files.
20
+
21
+ # flags.contenttype
22
+
23
+ Content type of import files if their extention is not .json.
24
+
25
+ # flags.confighelp
26
+
27
+ Display schema information for the --plan configuration file to stdout; if you specify this flag, all other flags except --json are ignored.
28
+
29
+ # examples
30
+
31
+ - Import the records contained in two JSON files into the org with alias "my-scratch":
32
+
33
+ <%= config.bin %> <%= command.id %> --files Contact.json,Account.json --target-org my-scratch
34
+
35
+ - Import records using a plan definition file into your default org:
36
+
37
+ <%= config.bin %> <%= command.id %> --plan Account-Contact-plan.json
@@ -1 +1 @@
1
- {"version":"2.1.21","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.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}}}