@salesforce/plugin-data 3.13.5 → 3.13.6

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 (3) hide show
  1. package/README.md +25 -25
  2. package/oclif.manifest.json +294 -294
  3. package/package.json +6 -6
package/README.md CHANGED
@@ -145,7 +145,7 @@ EXAMPLES
145
145
  $ sf data bulk results --job-id 7507i000fake341G --target-org my-scratch
146
146
  ```
147
147
 
148
- _See code: [src/commands/data/bulk/results.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/bulk/results.ts)_
148
+ _See code: [src/commands/data/bulk/results.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/bulk/results.ts)_
149
149
 
150
150
  ## `sf data create file`
151
151
 
@@ -194,7 +194,7 @@ EXAMPLES
194
194
  $ sf data create file --file path/to/astro.png --parent-id a03fakeLoJWPIA3
195
195
  ```
196
196
 
197
- _See code: [src/commands/data/create/file.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/create/file.ts)_
197
+ _See code: [src/commands/data/create/file.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/create/file.ts)_
198
198
 
199
199
  ## `sf data create record`
200
200
 
@@ -250,7 +250,7 @@ EXAMPLES
250
250
  TracedEntityId=01p17000000R6bLAAS"
251
251
  ```
252
252
 
253
- _See code: [src/commands/data/create/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/create/record.ts)_
253
+ _See code: [src/commands/data/create/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/create/record.ts)_
254
254
 
255
255
  ## `sf data delete bulk`
256
256
 
@@ -311,7 +311,7 @@ FLAG DESCRIPTIONS
311
311
  and can be enabled only by a system administrator.
312
312
  ```
313
313
 
314
- _See code: [src/commands/data/delete/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/delete/bulk.ts)_
314
+ _See code: [src/commands/data/delete/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/delete/bulk.ts)_
315
315
 
316
316
  ## `sf data delete record`
317
317
 
@@ -372,7 +372,7 @@ EXAMPLES
372
372
  $ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
373
373
  ```
374
374
 
375
- _See code: [src/commands/data/delete/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/delete/record.ts)_
375
+ _See code: [src/commands/data/delete/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/delete/record.ts)_
376
376
 
377
377
  ## `sf data delete resume`
378
378
 
@@ -411,7 +411,7 @@ EXAMPLES
411
411
  $ sf data delete resume --use-most-recent --target-org my-scratch
412
412
  ```
413
413
 
414
- _See code: [src/commands/data/delete/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/delete/resume.ts)_
414
+ _See code: [src/commands/data/delete/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/delete/resume.ts)_
415
415
 
416
416
  ## `sf data export bulk`
417
417
 
@@ -485,7 +485,7 @@ EXAMPLES
485
485
  --result-format json --async
486
486
  ```
487
487
 
488
- _See code: [src/commands/data/export/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/export/bulk.ts)_
488
+ _See code: [src/commands/data/export/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/export/bulk.ts)_
489
489
 
490
490
  ## `sf data export resume`
491
491
 
@@ -521,7 +521,7 @@ EXAMPLES
521
521
  $ sf data export resume --use-most-recent --target-org my-scratch
522
522
  ```
523
523
 
524
- _See code: [src/commands/data/export/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/export/resume.ts)_
524
+ _See code: [src/commands/data/export/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/export/resume.ts)_
525
525
 
526
526
  ## `sf data export tree`
527
527
 
@@ -582,7 +582,7 @@ EXAMPLES
582
582
  my-scratch
583
583
  ```
584
584
 
585
- _See code: [src/commands/data/export/tree.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/export/tree.ts)_
585
+ _See code: [src/commands/data/export/tree.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/export/tree.ts)_
586
586
 
587
587
  ## `sf data get record`
588
588
 
@@ -646,7 +646,7 @@ EXAMPLES
646
646
  $ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
647
647
  ```
648
648
 
649
- _See code: [src/commands/data/get/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/get/record.ts)_
649
+ _See code: [src/commands/data/get/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/get/record.ts)_
650
650
 
651
651
  ## `sf data import bulk`
652
652
 
@@ -704,7 +704,7 @@ EXAMPLES
704
704
  $ sf data import bulk --file accounts.csv --sobject Account --async
705
705
  ```
706
706
 
707
- _See code: [src/commands/data/import/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/import/bulk.ts)_
707
+ _See code: [src/commands/data/import/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/import/bulk.ts)_
708
708
 
709
709
  ## `sf data import resume`
710
710
 
@@ -740,7 +740,7 @@ EXAMPLES
740
740
  $ sf data import resume --use-most-recent --target-org my-scratch
741
741
  ```
742
742
 
743
- _See code: [src/commands/data/import/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/import/resume.ts)_
743
+ _See code: [src/commands/data/import/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/import/resume.ts)_
744
744
 
745
745
  ## `sf data import tree`
746
746
 
@@ -805,7 +805,7 @@ FLAG DESCRIPTIONS
805
805
  - files(array) - Files: An array of files paths to load
806
806
  ```
807
807
 
808
- _See code: [src/commands/data/import/tree.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/import/tree.ts)_
808
+ _See code: [src/commands/data/import/tree.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/import/tree.ts)_
809
809
 
810
810
  ## `sf data query`
811
811
 
@@ -871,7 +871,7 @@ EXAMPLES
871
871
  $ sf data query --query "SELECT Id FROM Contact" --bulk --wait 0
872
872
  ```
873
873
 
874
- _See code: [src/commands/data/query.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/query.ts)_
874
+ _See code: [src/commands/data/query.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/query.ts)_
875
875
 
876
876
  ## `sf data query resume`
877
877
 
@@ -908,7 +908,7 @@ EXAMPLES
908
908
  $ sf data query resume --bulk-query-id 7500x000005BdFzXXX
909
909
  ```
910
910
 
911
- _See code: [src/commands/data/query/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/query/resume.ts)_
911
+ _See code: [src/commands/data/query/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/query/resume.ts)_
912
912
 
913
913
  ## `sf data resume`
914
914
 
@@ -945,7 +945,7 @@ EXAMPLES
945
945
  $ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
946
946
  ```
947
947
 
948
- _See code: [src/commands/data/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/resume.ts)_
948
+ _See code: [src/commands/data/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/resume.ts)_
949
949
 
950
950
  ## `sf data search`
951
951
 
@@ -995,7 +995,7 @@ EXAMPLES
995
995
  $ sf data search --file query.txt --target-org my-scratch --result-format csv
996
996
  ```
997
997
 
998
- _See code: [src/commands/data/search.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/search.ts)_
998
+ _See code: [src/commands/data/search.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/search.ts)_
999
999
 
1000
1000
  ## `sf data update bulk`
1001
1001
 
@@ -1056,7 +1056,7 @@ EXAMPLES
1056
1056
  $ sf data update bulk --file accounts.csv --sobject Account --async
1057
1057
  ```
1058
1058
 
1059
- _See code: [src/commands/data/update/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/update/bulk.ts)_
1059
+ _See code: [src/commands/data/update/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/update/bulk.ts)_
1060
1060
 
1061
1061
  ## `sf data update record`
1062
1062
 
@@ -1118,7 +1118,7 @@ EXAMPLES
1118
1118
  "ExpirationDate=2017-12-01T00:58:04.000+0000"
1119
1119
  ```
1120
1120
 
1121
- _See code: [src/commands/data/update/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/update/record.ts)_
1121
+ _See code: [src/commands/data/update/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/update/record.ts)_
1122
1122
 
1123
1123
  ## `sf data update resume`
1124
1124
 
@@ -1154,7 +1154,7 @@ EXAMPLES
1154
1154
  $ sf data update resume --use-most-recent --target-org my-scratch
1155
1155
  ```
1156
1156
 
1157
- _See code: [src/commands/data/update/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/update/resume.ts)_
1157
+ _See code: [src/commands/data/update/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/update/resume.ts)_
1158
1158
 
1159
1159
  ## `sf data upsert bulk`
1160
1160
 
@@ -1213,7 +1213,7 @@ EXAMPLES
1213
1213
  my-scratch
1214
1214
  ```
1215
1215
 
1216
- _See code: [src/commands/data/upsert/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/upsert/bulk.ts)_
1216
+ _See code: [src/commands/data/upsert/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/upsert/bulk.ts)_
1217
1217
 
1218
1218
  ## `sf data upsert resume`
1219
1219
 
@@ -1252,7 +1252,7 @@ EXAMPLES
1252
1252
  $ sf data upsert resume --use-most-recent --target-org my-scratch
1253
1253
  ```
1254
1254
 
1255
- _See code: [src/commands/data/upsert/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/data/upsert/resume.ts)_
1255
+ _See code: [src/commands/data/upsert/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/data/upsert/resume.ts)_
1256
1256
 
1257
1257
  ## `sf force data bulk delete`
1258
1258
 
@@ -1299,7 +1299,7 @@ EXAMPLES
1299
1299
  $ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
1300
1300
  ```
1301
1301
 
1302
- _See code: [src/commands/force/data/bulk/delete.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/force/data/bulk/delete.ts)_
1302
+ _See code: [src/commands/force/data/bulk/delete.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/force/data/bulk/delete.ts)_
1303
1303
 
1304
1304
  ## `sf force data bulk status`
1305
1305
 
@@ -1336,7 +1336,7 @@ EXAMPLES
1336
1336
  $ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
1337
1337
  ```
1338
1338
 
1339
- _See code: [src/commands/force/data/bulk/status.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/force/data/bulk/status.ts)_
1339
+ _See code: [src/commands/force/data/bulk/status.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/force/data/bulk/status.ts)_
1340
1340
 
1341
1341
  ## `sf force data bulk upsert`
1342
1342
 
@@ -1394,6 +1394,6 @@ EXAMPLES
1394
1394
  --target-org my-scratch
1395
1395
  ```
1396
1396
 
1397
- _See code: [src/commands/force/data/bulk/upsert.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.5/src/commands/force/data/bulk/upsert.ts)_
1397
+ _See code: [src/commands/force/data/bulk/upsert.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.6/src/commands/force/data/bulk/upsert.ts)_
1398
1398
 
1399
1399
  <!-- commandsstop -->
@@ -3148,18 +3148,13 @@
3148
3148
  "resume:upsert:data"
3149
3149
  ]
3150
3150
  },
3151
- "data:export:legacy:tree": {
3151
+ "force:data:bulk:delete": {
3152
3152
  "aliases": [],
3153
3153
  "args": {},
3154
- "deprecationOptions": {
3155
- "to": "data tree export",
3156
- "message": "Starting on Nov 10, 2024, this command will no longer be available. Use `data export tree` instead."
3157
- },
3158
- "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).",
3154
+ "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 %> force data bulk status\" command. A single job can contain many batches, depending on the length of the CSV file.",
3159
3155
  "examples": [
3160
- "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\"",
3161
- "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",
3162
- "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"
3156
+ "Bulk delete Account records from your default org using the list of IDs in the \"files/delete.csv\" file:\n<%= config.bin %> <%= command.id %> --sobject Account --file files/delete.csv",
3157
+ "Bulk delete records from a custom object in an org with alias my-scratch and wait 5 minutes for the command to complete:\n<%= config.bin %> <%= command.id %> --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch"
3163
3158
  ],
3164
3159
  "flags": {
3165
3160
  "json": {
@@ -3213,101 +3208,95 @@
3213
3208
  "multiple": false,
3214
3209
  "type": "option"
3215
3210
  },
3216
- "query": {
3217
- "char": "q",
3218
- "name": "query",
3211
+ "file": {
3212
+ "aliases": [
3213
+ "csvfile"
3214
+ ],
3215
+ "char": "f",
3216
+ "deprecateAliases": true,
3217
+ "name": "file",
3219
3218
  "required": true,
3220
- "summary": "SOQL query, or filepath of a file that contains the query, to retrieve records.",
3221
- "hasDynamicHelp": false,
3222
- "multiple": false,
3223
- "type": "option"
3224
- },
3225
- "plan": {
3226
- "char": "p",
3227
- "name": "plan",
3228
- "summary": "Generate multiple sObject tree files and a plan definition file for aggregated import.",
3229
- "allowNo": false,
3230
- "type": "boolean"
3231
- },
3232
- "prefix": {
3233
- "char": "x",
3234
- "name": "prefix",
3235
- "summary": "Prefix of generated files.",
3219
+ "summary": "CSV file that contains the IDs of the records to delete.",
3236
3220
  "hasDynamicHelp": false,
3237
3221
  "multiple": false,
3238
3222
  "type": "option"
3239
3223
  },
3240
- "output-dir": {
3224
+ "sobject": {
3241
3225
  "aliases": [
3242
- "outputdir"
3226
+ "sobjecttype"
3243
3227
  ],
3244
- "char": "d",
3228
+ "char": "s",
3245
3229
  "deprecateAliases": true,
3246
- "name": "output-dir",
3247
- "summary": "Directory in which to generate the JSON files; default is current directory.",
3230
+ "name": "sobject",
3231
+ "required": true,
3232
+ "summary": "API name of the Salesforce object, either standard or custom, that you want to delete records from.",
3248
3233
  "hasDynamicHelp": false,
3249
3234
  "multiple": false,
3250
3235
  "type": "option"
3236
+ },
3237
+ "wait": {
3238
+ "char": "w",
3239
+ "name": "wait",
3240
+ "summary": "Number of minutes to wait for the command to complete before displaying the results.",
3241
+ "default": "0 minutes",
3242
+ "hasDynamicHelp": true,
3243
+ "multiple": false,
3244
+ "type": "option"
3251
3245
  }
3252
3246
  },
3253
3247
  "hasDynamicHelp": true,
3254
- "hidden": true,
3255
3248
  "hiddenAliases": [],
3256
- "id": "data:export:legacy:tree",
3249
+ "id": "force:data:bulk:delete",
3257
3250
  "pluginAlias": "@salesforce/plugin-data",
3258
3251
  "pluginName": "@salesforce/plugin-data",
3259
3252
  "pluginType": "core",
3260
- "state": "deprecated",
3261
3253
  "strict": true,
3262
- "summary": "Export data from an org into one or more JSON files.",
3254
+ "summary": "Bulk delete records from an org using a CSV file. Uses Bulk API 1.0.",
3263
3255
  "enableJsonFlag": true,
3264
3256
  "isESM": true,
3265
3257
  "relativePath": [
3266
3258
  "lib",
3267
3259
  "commands",
3260
+ "force",
3268
3261
  "data",
3269
- "export",
3270
- "legacy",
3271
- "tree.js"
3262
+ "bulk",
3263
+ "delete.js"
3272
3264
  ],
3273
3265
  "aliasPermutations": [],
3274
3266
  "permutations": [
3275
- "data:export:legacy:tree",
3276
- "export:data:legacy:tree",
3277
- "export:legacy:data:tree",
3278
- "export:legacy:tree:data",
3279
- "data:legacy:export:tree",
3280
- "legacy:data:export:tree",
3281
- "legacy:export:data:tree",
3282
- "legacy:export:tree:data",
3283
- "data:legacy:tree:export",
3284
- "legacy:data:tree:export",
3285
- "legacy:tree:data:export",
3286
- "legacy:tree:export:data",
3287
- "data:export:tree:legacy",
3288
- "export:data:tree:legacy",
3289
- "export:tree:data:legacy",
3290
- "export:tree:legacy:data",
3291
- "data:tree:export:legacy",
3292
- "tree:data:export:legacy",
3293
- "tree:export:data:legacy",
3294
- "tree:export:legacy:data",
3295
- "data:tree:legacy:export",
3296
- "tree:data:legacy:export",
3297
- "tree:legacy:data:export",
3298
- "tree:legacy:export:data"
3267
+ "force:data:bulk:delete",
3268
+ "data:force:bulk:delete",
3269
+ "data:bulk:force:delete",
3270
+ "data:bulk:delete:force",
3271
+ "force:bulk:data:delete",
3272
+ "bulk:force:data:delete",
3273
+ "bulk:data:force:delete",
3274
+ "bulk:data:delete:force",
3275
+ "force:bulk:delete:data",
3276
+ "bulk:force:delete:data",
3277
+ "bulk:delete:force:data",
3278
+ "bulk:delete:data:force",
3279
+ "force:data:delete:bulk",
3280
+ "data:force:delete:bulk",
3281
+ "data:delete:force:bulk",
3282
+ "data:delete:bulk:force",
3283
+ "force:delete:data:bulk",
3284
+ "delete:force:data:bulk",
3285
+ "delete:data:force:bulk",
3286
+ "delete:data:bulk:force",
3287
+ "force:delete:bulk:data",
3288
+ "delete:force:bulk:data",
3289
+ "delete:bulk:force:data",
3290
+ "delete:bulk:data:force"
3299
3291
  ]
3300
3292
  },
3301
- "data:import:legacy:tree": {
3293
+ "force:data:bulk:status": {
3302
3294
  "aliases": [],
3303
3295
  "args": {},
3304
- "deprecationOptions": {
3305
- "message": "After Nov 10, 2024, this command will no longer be available. Use `data export tree`."
3306
- },
3307
- "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)",
3296
+ "description": "Run this command using the job ID or batch ID returned from the \"<%= config.bin %> force data bulk delete\" or \"<%= config.bin %> force data bulk upsert\" commands.",
3308
3297
  "examples": [
3309
- "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",
3310
- "Import records using a plan definition file into your default org:\n<%= config.bin %> <%= command.id %> --plan Account-Contact-plan.json"
3298
+ "View the status of a bulk load job in your default org:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
3299
+ "View the status of a bulk load job and a specific batches in an org with alias my-scratch:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch"
3311
3300
  ],
3312
3301
  "flags": {
3313
3302
  "json": {
@@ -3361,116 +3350,85 @@
3361
3350
  "multiple": false,
3362
3351
  "type": "option"
3363
3352
  },
3364
- "files": {
3353
+ "batch-id": {
3365
3354
  "aliases": [
3366
- "sobjecttreefiles"
3355
+ "batchid"
3367
3356
  ],
3368
- "char": "f",
3357
+ "char": "b",
3369
3358
  "deprecateAliases": true,
3370
- "exclusive": [
3371
- "plan"
3372
- ],
3373
- "name": "files",
3374
- "summary": "Comma-separated and in-order JSON files that contain the records, in sObject tree format, that you want to insert.",
3375
- "delimiter": ",",
3376
- "hasDynamicHelp": false,
3377
- "multiple": true,
3378
- "type": "option"
3379
- },
3380
- "plan": {
3381
- "char": "p",
3382
- "name": "plan",
3383
- "summary": "Plan definition file to insert multiple data files.",
3359
+ "name": "batch-id",
3360
+ "summary": "ID of the batch whose status you want to view; you must also specify the job ID.",
3384
3361
  "hasDynamicHelp": false,
3385
3362
  "multiple": false,
3386
3363
  "type": "option"
3387
3364
  },
3388
- "content-type": {
3365
+ "job-id": {
3389
3366
  "aliases": [
3390
- "contenttype"
3367
+ "jobid"
3391
3368
  ],
3392
- "char": "c",
3369
+ "char": "i",
3393
3370
  "deprecateAliases": true,
3394
- "deprecated": {
3395
- "message": "The `config-type` flag is deprecated and will be moved to a `legacy` command after July 10, 2024. It will be completely removed after Nov 10, 2024. Use the new `data tree beta import` command."
3396
- },
3397
- "hidden": true,
3398
- "name": "content-type",
3399
- "summary": "Content type of import files if their extention is not .json.",
3371
+ "name": "job-id",
3372
+ "required": true,
3373
+ "summary": "ID of the job whose status you want to view.",
3400
3374
  "hasDynamicHelp": false,
3401
3375
  "multiple": false,
3402
3376
  "type": "option"
3403
- },
3404
- "config-help": {
3405
- "aliases": [
3406
- "confighelp"
3407
- ],
3408
- "deprecateAliases": true,
3409
- "deprecated": {
3410
- "message": "The `config-help` flag is deprecated and will be moved to a `legacy` command after July 10, 2024. It will be completely removed after Nov 10, 2024. Use the new `data tree beta import` command."
3411
- },
3412
- "hidden": true,
3413
- "name": "config-help",
3414
- "summary": "Display schema information for the --plan configuration file to stdout; if you specify this flag, all other flags except --json are ignored.",
3415
- "allowNo": false,
3416
- "type": "boolean"
3417
3377
  }
3418
3378
  },
3419
3379
  "hasDynamicHelp": true,
3420
- "hidden": true,
3421
3380
  "hiddenAliases": [],
3422
- "id": "data:import:legacy:tree",
3381
+ "id": "force:data:bulk:status",
3423
3382
  "pluginAlias": "@salesforce/plugin-data",
3424
3383
  "pluginName": "@salesforce/plugin-data",
3425
3384
  "pluginType": "core",
3426
- "state": "deprecated",
3427
3385
  "strict": true,
3428
- "summary": "Import data from one or more JSON files into an org.",
3386
+ "summary": "View the status of a bulk data load job or batch. Uses Bulk API 1.0.",
3429
3387
  "enableJsonFlag": true,
3430
3388
  "isESM": true,
3431
3389
  "relativePath": [
3432
3390
  "lib",
3433
3391
  "commands",
3392
+ "force",
3434
3393
  "data",
3435
- "import",
3436
- "legacy",
3437
- "tree.js"
3394
+ "bulk",
3395
+ "status.js"
3438
3396
  ],
3439
3397
  "aliasPermutations": [],
3440
3398
  "permutations": [
3441
- "data:import:legacy:tree",
3442
- "import:data:legacy:tree",
3443
- "import:legacy:data:tree",
3444
- "import:legacy:tree:data",
3445
- "data:legacy:import:tree",
3446
- "legacy:data:import:tree",
3447
- "legacy:import:data:tree",
3448
- "legacy:import:tree:data",
3449
- "data:legacy:tree:import",
3450
- "legacy:data:tree:import",
3451
- "legacy:tree:data:import",
3452
- "legacy:tree:import:data",
3453
- "data:import:tree:legacy",
3454
- "import:data:tree:legacy",
3455
- "import:tree:data:legacy",
3456
- "import:tree:legacy:data",
3457
- "data:tree:import:legacy",
3458
- "tree:data:import:legacy",
3459
- "tree:import:data:legacy",
3460
- "tree:import:legacy:data",
3461
- "data:tree:legacy:import",
3462
- "tree:data:legacy:import",
3463
- "tree:legacy:data:import",
3464
- "tree:legacy:import:data"
3399
+ "force:data:bulk:status",
3400
+ "data:force:bulk:status",
3401
+ "data:bulk:force:status",
3402
+ "data:bulk:status:force",
3403
+ "force:bulk:data:status",
3404
+ "bulk:force:data:status",
3405
+ "bulk:data:force:status",
3406
+ "bulk:data:status:force",
3407
+ "force:bulk:status:data",
3408
+ "bulk:force:status:data",
3409
+ "bulk:status:force:data",
3410
+ "bulk:status:data:force",
3411
+ "force:data:status:bulk",
3412
+ "data:force:status:bulk",
3413
+ "data:status:force:bulk",
3414
+ "data:status:bulk:force",
3415
+ "force:status:data:bulk",
3416
+ "status:force:data:bulk",
3417
+ "status:data:force:bulk",
3418
+ "status:data:bulk:force",
3419
+ "force:status:bulk:data",
3420
+ "status:force:bulk:data",
3421
+ "status:bulk:force:data",
3422
+ "status:bulk:data:force"
3465
3423
  ]
3466
3424
  },
3467
- "force:data:bulk:delete": {
3425
+ "force:data:bulk:upsert": {
3468
3426
  "aliases": [],
3469
3427
  "args": {},
3470
- "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 %> force data bulk status\" command. A single job can contain many batches, depending on the length of the CSV file.",
3428
+ "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 %> force data bulk status\" 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.",
3471
3429
  "examples": [
3472
- "Bulk delete Account records from your default org using the list of IDs in the \"files/delete.csv\" file:\n<%= config.bin %> <%= command.id %> --sobject Account --file files/delete.csv",
3473
- "Bulk delete records from a custom object in an org with alias my-scratch and wait 5 minutes for the command to complete:\n<%= config.bin %> <%= command.id %> --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch"
3430
+ "Bulk upsert records to the Contact object in your default org:\n<%= config.bin %> --sobject Contact --file files/contacts.csv --external-id Id",
3431
+ "Bulk upsert records to a custom object in an org with alias my-scratch 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 --target-org my-scratch"
3474
3432
  ],
3475
3433
  "flags": {
3476
3434
  "json": {
@@ -3524,15 +3482,28 @@
3524
3482
  "multiple": false,
3525
3483
  "type": "option"
3526
3484
  },
3527
- "file": {
3485
+ "external-id": {
3528
3486
  "aliases": [
3529
- "csvfile"
3487
+ "externalid"
3530
3488
  ],
3531
- "char": "f",
3489
+ "char": "i",
3490
+ "deprecateAliases": true,
3491
+ "name": "external-id",
3492
+ "required": true,
3493
+ "summary": "Name of the external ID field, or the Id field.",
3494
+ "hasDynamicHelp": false,
3495
+ "multiple": false,
3496
+ "type": "option"
3497
+ },
3498
+ "file": {
3499
+ "aliases": [
3500
+ "csvfile"
3501
+ ],
3502
+ "char": "f",
3532
3503
  "deprecateAliases": true,
3533
3504
  "name": "file",
3534
3505
  "required": true,
3535
- "summary": "CSV file that contains the IDs of the records to delete.",
3506
+ "summary": "CSV file that contains the records to upsert.",
3536
3507
  "hasDynamicHelp": false,
3537
3508
  "multiple": false,
3538
3509
  "type": "option"
@@ -3545,7 +3516,7 @@
3545
3516
  "deprecateAliases": true,
3546
3517
  "name": "sobject",
3547
3518
  "required": true,
3548
- "summary": "API name of the Salesforce object, either standard or custom, that you want to delete records from.",
3519
+ "summary": "API name of the Salesforce object, either standard or custom, that you want to upsert records to.",
3549
3520
  "hasDynamicHelp": false,
3550
3521
  "multiple": false,
3551
3522
  "type": "option"
@@ -3558,16 +3529,23 @@
3558
3529
  "hasDynamicHelp": true,
3559
3530
  "multiple": false,
3560
3531
  "type": "option"
3532
+ },
3533
+ "serial": {
3534
+ "char": "r",
3535
+ "name": "serial",
3536
+ "summary": "Run batches in serial mode.",
3537
+ "allowNo": false,
3538
+ "type": "boolean"
3561
3539
  }
3562
3540
  },
3563
3541
  "hasDynamicHelp": true,
3564
3542
  "hiddenAliases": [],
3565
- "id": "force:data:bulk:delete",
3543
+ "id": "force:data:bulk:upsert",
3566
3544
  "pluginAlias": "@salesforce/plugin-data",
3567
3545
  "pluginName": "@salesforce/plugin-data",
3568
3546
  "pluginType": "core",
3569
3547
  "strict": true,
3570
- "summary": "Bulk delete records from an org using a CSV file. Uses Bulk API 1.0.",
3548
+ "summary": "Bulk upsert records to an org from a CSV file. Uses Bulk API 1.0.",
3571
3549
  "enableJsonFlag": true,
3572
3550
  "isESM": true,
3573
3551
  "relativePath": [
@@ -3576,43 +3554,48 @@
3576
3554
  "force",
3577
3555
  "data",
3578
3556
  "bulk",
3579
- "delete.js"
3557
+ "upsert.js"
3580
3558
  ],
3581
3559
  "aliasPermutations": [],
3582
3560
  "permutations": [
3583
- "force:data:bulk:delete",
3584
- "data:force:bulk:delete",
3585
- "data:bulk:force:delete",
3586
- "data:bulk:delete:force",
3587
- "force:bulk:data:delete",
3588
- "bulk:force:data:delete",
3589
- "bulk:data:force:delete",
3590
- "bulk:data:delete:force",
3591
- "force:bulk:delete:data",
3592
- "bulk:force:delete:data",
3593
- "bulk:delete:force:data",
3594
- "bulk:delete:data:force",
3595
- "force:data:delete:bulk",
3596
- "data:force:delete:bulk",
3597
- "data:delete:force:bulk",
3598
- "data:delete:bulk:force",
3599
- "force:delete:data:bulk",
3600
- "delete:force:data:bulk",
3601
- "delete:data:force:bulk",
3602
- "delete:data:bulk:force",
3603
- "force:delete:bulk:data",
3604
- "delete:force:bulk:data",
3605
- "delete:bulk:force:data",
3606
- "delete:bulk:data:force"
3561
+ "force:data:bulk:upsert",
3562
+ "data:force:bulk:upsert",
3563
+ "data:bulk:force:upsert",
3564
+ "data:bulk:upsert:force",
3565
+ "force:bulk:data:upsert",
3566
+ "bulk:force:data:upsert",
3567
+ "bulk:data:force:upsert",
3568
+ "bulk:data:upsert:force",
3569
+ "force:bulk:upsert:data",
3570
+ "bulk:force:upsert:data",
3571
+ "bulk:upsert:force:data",
3572
+ "bulk:upsert:data:force",
3573
+ "force:data:upsert:bulk",
3574
+ "data:force:upsert:bulk",
3575
+ "data:upsert:force:bulk",
3576
+ "data:upsert:bulk:force",
3577
+ "force:upsert:data:bulk",
3578
+ "upsert:force:data:bulk",
3579
+ "upsert:data:force:bulk",
3580
+ "upsert:data:bulk:force",
3581
+ "force:upsert:bulk:data",
3582
+ "upsert:force:bulk:data",
3583
+ "upsert:bulk:force:data",
3584
+ "upsert:bulk:data:force"
3607
3585
  ]
3608
3586
  },
3609
- "force:data:bulk:status": {
3587
+ "data:export:legacy:tree": {
3610
3588
  "aliases": [],
3611
3589
  "args": {},
3612
- "description": "Run this command using the job ID or batch ID returned from the \"<%= config.bin %> force data bulk delete\" or \"<%= config.bin %> force data bulk upsert\" commands.",
3590
+ "deprecationOptions": {
3591
+ "to": "data tree export",
3592
+ "message": "Starting on Nov 10, 2024, this command will no longer be available. Use `data export tree` instead."
3593
+ },
3594
+ "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).",
3613
3595
  "examples": [
3614
- "View the status of a bulk load job in your default org:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
3615
- "View the status of a bulk load job and a specific batches in an org with alias my-scratch:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch"
3596
+ "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\"",
3597
+ "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",
3598
+ "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"
3616
3599
  ],
3617
3600
  "flags": {
3618
3601
  "json": {
@@ -3666,85 +3649,101 @@
3666
3649
  "multiple": false,
3667
3650
  "type": "option"
3668
3651
  },
3669
- "batch-id": {
3670
- "aliases": [
3671
- "batchid"
3672
- ],
3673
- "char": "b",
3674
- "deprecateAliases": true,
3675
- "name": "batch-id",
3676
- "summary": "ID of the batch whose status you want to view; you must also specify the job ID.",
3652
+ "query": {
3653
+ "char": "q",
3654
+ "name": "query",
3655
+ "required": true,
3656
+ "summary": "SOQL query, or filepath of a file that contains the query, to retrieve records.",
3677
3657
  "hasDynamicHelp": false,
3678
3658
  "multiple": false,
3679
3659
  "type": "option"
3680
3660
  },
3681
- "job-id": {
3661
+ "plan": {
3662
+ "char": "p",
3663
+ "name": "plan",
3664
+ "summary": "Generate multiple sObject tree files and a plan definition file for aggregated import.",
3665
+ "allowNo": false,
3666
+ "type": "boolean"
3667
+ },
3668
+ "prefix": {
3669
+ "char": "x",
3670
+ "name": "prefix",
3671
+ "summary": "Prefix of generated files.",
3672
+ "hasDynamicHelp": false,
3673
+ "multiple": false,
3674
+ "type": "option"
3675
+ },
3676
+ "output-dir": {
3682
3677
  "aliases": [
3683
- "jobid"
3678
+ "outputdir"
3684
3679
  ],
3685
- "char": "i",
3680
+ "char": "d",
3686
3681
  "deprecateAliases": true,
3687
- "name": "job-id",
3688
- "required": true,
3689
- "summary": "ID of the job whose status you want to view.",
3682
+ "name": "output-dir",
3683
+ "summary": "Directory in which to generate the JSON files; default is current directory.",
3690
3684
  "hasDynamicHelp": false,
3691
3685
  "multiple": false,
3692
3686
  "type": "option"
3693
3687
  }
3694
3688
  },
3695
3689
  "hasDynamicHelp": true,
3690
+ "hidden": true,
3696
3691
  "hiddenAliases": [],
3697
- "id": "force:data:bulk:status",
3692
+ "id": "data:export:legacy:tree",
3698
3693
  "pluginAlias": "@salesforce/plugin-data",
3699
3694
  "pluginName": "@salesforce/plugin-data",
3700
3695
  "pluginType": "core",
3696
+ "state": "deprecated",
3701
3697
  "strict": true,
3702
- "summary": "View the status of a bulk data load job or batch. Uses Bulk API 1.0.",
3698
+ "summary": "Export data from an org into one or more JSON files.",
3703
3699
  "enableJsonFlag": true,
3704
3700
  "isESM": true,
3705
3701
  "relativePath": [
3706
3702
  "lib",
3707
3703
  "commands",
3708
- "force",
3709
3704
  "data",
3710
- "bulk",
3711
- "status.js"
3705
+ "export",
3706
+ "legacy",
3707
+ "tree.js"
3712
3708
  ],
3713
3709
  "aliasPermutations": [],
3714
3710
  "permutations": [
3715
- "force:data:bulk:status",
3716
- "data:force:bulk:status",
3717
- "data:bulk:force:status",
3718
- "data:bulk:status:force",
3719
- "force:bulk:data:status",
3720
- "bulk:force:data:status",
3721
- "bulk:data:force:status",
3722
- "bulk:data:status:force",
3723
- "force:bulk:status:data",
3724
- "bulk:force:status:data",
3725
- "bulk:status:force:data",
3726
- "bulk:status:data:force",
3727
- "force:data:status:bulk",
3728
- "data:force:status:bulk",
3729
- "data:status:force:bulk",
3730
- "data:status:bulk:force",
3731
- "force:status:data:bulk",
3732
- "status:force:data:bulk",
3733
- "status:data:force:bulk",
3734
- "status:data:bulk:force",
3735
- "force:status:bulk:data",
3736
- "status:force:bulk:data",
3737
- "status:bulk:force:data",
3738
- "status:bulk:data:force"
3711
+ "data:export:legacy:tree",
3712
+ "export:data:legacy:tree",
3713
+ "export:legacy:data:tree",
3714
+ "export:legacy:tree:data",
3715
+ "data:legacy:export:tree",
3716
+ "legacy:data:export:tree",
3717
+ "legacy:export:data:tree",
3718
+ "legacy:export:tree:data",
3719
+ "data:legacy:tree:export",
3720
+ "legacy:data:tree:export",
3721
+ "legacy:tree:data:export",
3722
+ "legacy:tree:export:data",
3723
+ "data:export:tree:legacy",
3724
+ "export:data:tree:legacy",
3725
+ "export:tree:data:legacy",
3726
+ "export:tree:legacy:data",
3727
+ "data:tree:export:legacy",
3728
+ "tree:data:export:legacy",
3729
+ "tree:export:data:legacy",
3730
+ "tree:export:legacy:data",
3731
+ "data:tree:legacy:export",
3732
+ "tree:data:legacy:export",
3733
+ "tree:legacy:data:export",
3734
+ "tree:legacy:export:data"
3739
3735
  ]
3740
3736
  },
3741
- "force:data:bulk:upsert": {
3737
+ "data:import:legacy:tree": {
3742
3738
  "aliases": [],
3743
3739
  "args": {},
3744
- "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 %> force data bulk status\" 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.",
3740
+ "deprecationOptions": {
3741
+ "message": "After Nov 10, 2024, this command will no longer be available. Use `data export tree`."
3742
+ },
3743
+ "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)",
3745
3744
  "examples": [
3746
- "Bulk upsert records to the Contact object in your default org:\n<%= config.bin %> --sobject Contact --file files/contacts.csv --external-id Id",
3747
- "Bulk upsert records to a custom object in an org with alias my-scratch 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 --target-org my-scratch"
3745
+ "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",
3746
+ "Import records using a plan definition file into your default org:\n<%= config.bin %> <%= command.id %> --plan Account-Contact-plan.json"
3748
3747
  ],
3749
3748
  "flags": {
3750
3749
  "json": {
@@ -3798,108 +3797,109 @@
3798
3797
  "multiple": false,
3799
3798
  "type": "option"
3800
3799
  },
3801
- "external-id": {
3800
+ "files": {
3802
3801
  "aliases": [
3803
- "externalid"
3802
+ "sobjecttreefiles"
3804
3803
  ],
3805
- "char": "i",
3804
+ "char": "f",
3806
3805
  "deprecateAliases": true,
3807
- "name": "external-id",
3808
- "required": true,
3809
- "summary": "Name of the external ID field, or the Id field.",
3806
+ "exclusive": [
3807
+ "plan"
3808
+ ],
3809
+ "name": "files",
3810
+ "summary": "Comma-separated and in-order JSON files that contain the records, in sObject tree format, that you want to insert.",
3811
+ "delimiter": ",",
3810
3812
  "hasDynamicHelp": false,
3811
- "multiple": false,
3813
+ "multiple": true,
3812
3814
  "type": "option"
3813
3815
  },
3814
- "file": {
3815
- "aliases": [
3816
- "csvfile"
3817
- ],
3818
- "char": "f",
3819
- "deprecateAliases": true,
3820
- "name": "file",
3821
- "required": true,
3822
- "summary": "CSV file that contains the records to upsert.",
3816
+ "plan": {
3817
+ "char": "p",
3818
+ "name": "plan",
3819
+ "summary": "Plan definition file to insert multiple data files.",
3823
3820
  "hasDynamicHelp": false,
3824
3821
  "multiple": false,
3825
3822
  "type": "option"
3826
3823
  },
3827
- "sobject": {
3824
+ "content-type": {
3828
3825
  "aliases": [
3829
- "sobjecttype"
3826
+ "contenttype"
3830
3827
  ],
3831
- "char": "s",
3828
+ "char": "c",
3832
3829
  "deprecateAliases": true,
3833
- "name": "sobject",
3834
- "required": true,
3835
- "summary": "API name of the Salesforce object, either standard or custom, that you want to upsert records to.",
3830
+ "deprecated": {
3831
+ "message": "The `config-type` flag is deprecated and will be moved to a `legacy` command after July 10, 2024. It will be completely removed after Nov 10, 2024. Use the new `data tree beta import` command."
3832
+ },
3833
+ "hidden": true,
3834
+ "name": "content-type",
3835
+ "summary": "Content type of import files if their extention is not .json.",
3836
3836
  "hasDynamicHelp": false,
3837
3837
  "multiple": false,
3838
3838
  "type": "option"
3839
3839
  },
3840
- "wait": {
3841
- "char": "w",
3842
- "name": "wait",
3843
- "summary": "Number of minutes to wait for the command to complete before displaying the results.",
3844
- "default": "0 minutes",
3845
- "hasDynamicHelp": true,
3846
- "multiple": false,
3847
- "type": "option"
3848
- },
3849
- "serial": {
3850
- "char": "r",
3851
- "name": "serial",
3852
- "summary": "Run batches in serial mode.",
3840
+ "config-help": {
3841
+ "aliases": [
3842
+ "confighelp"
3843
+ ],
3844
+ "deprecateAliases": true,
3845
+ "deprecated": {
3846
+ "message": "The `config-help` flag is deprecated and will be moved to a `legacy` command after July 10, 2024. It will be completely removed after Nov 10, 2024. Use the new `data tree beta import` command."
3847
+ },
3848
+ "hidden": true,
3849
+ "name": "config-help",
3850
+ "summary": "Display schema information for the --plan configuration file to stdout; if you specify this flag, all other flags except --json are ignored.",
3853
3851
  "allowNo": false,
3854
3852
  "type": "boolean"
3855
3853
  }
3856
3854
  },
3857
3855
  "hasDynamicHelp": true,
3856
+ "hidden": true,
3858
3857
  "hiddenAliases": [],
3859
- "id": "force:data:bulk:upsert",
3858
+ "id": "data:import:legacy:tree",
3860
3859
  "pluginAlias": "@salesforce/plugin-data",
3861
3860
  "pluginName": "@salesforce/plugin-data",
3862
3861
  "pluginType": "core",
3862
+ "state": "deprecated",
3863
3863
  "strict": true,
3864
- "summary": "Bulk upsert records to an org from a CSV file. Uses Bulk API 1.0.",
3864
+ "summary": "Import data from one or more JSON files into an org.",
3865
3865
  "enableJsonFlag": true,
3866
3866
  "isESM": true,
3867
3867
  "relativePath": [
3868
3868
  "lib",
3869
3869
  "commands",
3870
- "force",
3871
3870
  "data",
3872
- "bulk",
3873
- "upsert.js"
3871
+ "import",
3872
+ "legacy",
3873
+ "tree.js"
3874
3874
  ],
3875
3875
  "aliasPermutations": [],
3876
3876
  "permutations": [
3877
- "force:data:bulk:upsert",
3878
- "data:force:bulk:upsert",
3879
- "data:bulk:force:upsert",
3880
- "data:bulk:upsert:force",
3881
- "force:bulk:data:upsert",
3882
- "bulk:force:data:upsert",
3883
- "bulk:data:force:upsert",
3884
- "bulk:data:upsert:force",
3885
- "force:bulk:upsert:data",
3886
- "bulk:force:upsert:data",
3887
- "bulk:upsert:force:data",
3888
- "bulk:upsert:data:force",
3889
- "force:data:upsert:bulk",
3890
- "data:force:upsert:bulk",
3891
- "data:upsert:force:bulk",
3892
- "data:upsert:bulk:force",
3893
- "force:upsert:data:bulk",
3894
- "upsert:force:data:bulk",
3895
- "upsert:data:force:bulk",
3896
- "upsert:data:bulk:force",
3897
- "force:upsert:bulk:data",
3898
- "upsert:force:bulk:data",
3899
- "upsert:bulk:force:data",
3900
- "upsert:bulk:data:force"
3877
+ "data:import:legacy:tree",
3878
+ "import:data:legacy:tree",
3879
+ "import:legacy:data:tree",
3880
+ "import:legacy:tree:data",
3881
+ "data:legacy:import:tree",
3882
+ "legacy:data:import:tree",
3883
+ "legacy:import:data:tree",
3884
+ "legacy:import:tree:data",
3885
+ "data:legacy:tree:import",
3886
+ "legacy:data:tree:import",
3887
+ "legacy:tree:data:import",
3888
+ "legacy:tree:import:data",
3889
+ "data:import:tree:legacy",
3890
+ "import:data:tree:legacy",
3891
+ "import:tree:data:legacy",
3892
+ "import:tree:legacy:data",
3893
+ "data:tree:import:legacy",
3894
+ "tree:data:import:legacy",
3895
+ "tree:import:data:legacy",
3896
+ "tree:import:legacy:data",
3897
+ "data:tree:legacy:import",
3898
+ "tree:data:legacy:import",
3899
+ "tree:legacy:data:import",
3900
+ "tree:legacy:import:data"
3901
3901
  ]
3902
3902
  }
3903
3903
  },
3904
- "version": "3.13.5"
3904
+ "version": "3.13.6"
3905
3905
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-data",
3
- "version": "3.13.5",
3
+ "version": "3.13.6",
4
4
  "description": "Plugin for salesforce data commands",
5
5
  "author": "Salesforce",
6
6
  "homepage": "https://github.com/salesforcecli/plugin-data",
@@ -119,7 +119,7 @@
119
119
  },
120
120
  "dependencies": {
121
121
  "@jsforce/jsforce-node": "^3.6.3",
122
- "@oclif/multi-stage-output": "^0.7.15",
122
+ "@oclif/multi-stage-output": "^0.8.0",
123
123
  "@salesforce/core": "^8.6.1",
124
124
  "@salesforce/kit": "^3.2.2",
125
125
  "@salesforce/sf-plugins-core": "^12.1.0",
@@ -132,7 +132,7 @@
132
132
  "terminal-link": "^3.0.0"
133
133
  },
134
134
  "devDependencies": {
135
- "@oclif/core": "^4.0.37",
135
+ "@oclif/core": "^4.2.0",
136
136
  "@oclif/plugin-command-snapshot": "^5.2.23",
137
137
  "@oclif/test": "^4.1.3",
138
138
  "@salesforce/cli-plugins-testkit": "^5.3.39",
@@ -140,7 +140,7 @@
140
140
  "@salesforce/plugin-command-reference": "^3.1.37",
141
141
  "@salesforce/types": "^1.3.0",
142
142
  "eslint-plugin-sf-plugin": "^1.20.13",
143
- "oclif": "^4.16.0",
143
+ "oclif": "^4.17.0",
144
144
  "ts-node": "^10.9.2",
145
145
  "typescript": "^5.7.2"
146
146
  },
@@ -265,7 +265,7 @@
265
265
  "exports": "./lib/index.js",
266
266
  "type": "module",
267
267
  "sfdx": {
268
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.13.5.crt",
269
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.13.5.sig"
268
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.13.6.crt",
269
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.13.6.sig"
270
270
  }
271
271
  }