@salesforce/plugin-data 3.13.6 → 3.13.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -25
- package/oclif.manifest.json +372 -372
- package/package.json +5 -5
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.
|
|
148
|
+
_See code: [src/commands/data/bulk/results.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
197
|
+
_See code: [src/commands/data/create/file.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
253
|
+
_See code: [src/commands/data/create/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
314
|
+
_See code: [src/commands/data/delete/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
375
|
+
_See code: [src/commands/data/delete/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
414
|
+
_See code: [src/commands/data/delete/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
488
|
+
_See code: [src/commands/data/export/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
524
|
+
_See code: [src/commands/data/export/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
585
|
+
_See code: [src/commands/data/export/tree.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
649
|
+
_See code: [src/commands/data/get/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
707
|
+
_See code: [src/commands/data/import/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
743
|
+
_See code: [src/commands/data/import/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
808
|
+
_See code: [src/commands/data/import/tree.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
874
|
+
_See code: [src/commands/data/query.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
911
|
+
_See code: [src/commands/data/query/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
948
|
+
_See code: [src/commands/data/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
998
|
+
_See code: [src/commands/data/search.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
1059
|
+
_See code: [src/commands/data/update/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
1121
|
+
_See code: [src/commands/data/update/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
1157
|
+
_See code: [src/commands/data/update/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
1216
|
+
_See code: [src/commands/data/upsert/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
1255
|
+
_See code: [src/commands/data/upsert/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
1302
|
+
_See code: [src/commands/force/data/bulk/delete.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
1339
|
+
_See code: [src/commands/force/data/bulk/status.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/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.
|
|
1397
|
+
_See code: [src/commands/force/data/bulk/upsert.ts](https://github.com/salesforcecli/plugin-data/blob/3.13.7/src/commands/force/data/bulk/upsert.ts)_
|
|
1398
1398
|
|
|
1399
1399
|
<!-- commandsstop -->
|
package/oclif.manifest.json
CHANGED
|
@@ -441,83 +441,6 @@
|
|
|
441
441
|
"search:data"
|
|
442
442
|
]
|
|
443
443
|
},
|
|
444
|
-
"data:bulk:results": {
|
|
445
|
-
"aliases": [],
|
|
446
|
-
"args": {},
|
|
447
|
-
"description": "Use this command to get the complete results after running one of the CLI commands that uses Bulk API 2.0 to ingest (import, update, upsert, or delete) large datasets to your org, such as \"data import bulk\". The previously-run bulk command must have completed; if it's still processing, run the corresponding resume command first, such as \"data import resume.\" Make note of the job ID of the previous bulk command because you use it to run this command. \n\nYou can also use this command to get results from running a bulk ingest job with a different tool, such as Data Loader, as long as you have the job ID. For information on Data Loader, see https://developer.salesforce.com/docs/atlas.en-us.dataLoader.meta/dataLoader/data_loader_intro.htm. \n\nThis command first displays the status of the previous bulk job, the operation that was executed in the org (such as insert or hard delete), and the updated Salesforce object. The command then displays how many records were processed in total, and how many were successful or failed. Finally, the output displays the names of the generated CSV-formatted files that contain the specific results for each ingested record. Depending on the success or failure of the bulk command, the results files can include the IDs of inserted records or the specific errors. When possible, if the ingest job failed or was aborted, you also get a CSV file with the unprocessed results.",
|
|
448
|
-
"examples": [
|
|
449
|
-
"Get results from a bulk ingest job; use the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --job-id 7507i000fake341G --target-org my-scratch"
|
|
450
|
-
],
|
|
451
|
-
"flags": {
|
|
452
|
-
"json": {
|
|
453
|
-
"description": "Format output as json.",
|
|
454
|
-
"helpGroup": "GLOBAL",
|
|
455
|
-
"name": "json",
|
|
456
|
-
"allowNo": false,
|
|
457
|
-
"type": "boolean"
|
|
458
|
-
},
|
|
459
|
-
"flags-dir": {
|
|
460
|
-
"helpGroup": "GLOBAL",
|
|
461
|
-
"name": "flags-dir",
|
|
462
|
-
"summary": "Import flag values from a directory.",
|
|
463
|
-
"hasDynamicHelp": false,
|
|
464
|
-
"multiple": false,
|
|
465
|
-
"type": "option"
|
|
466
|
-
},
|
|
467
|
-
"job-id": {
|
|
468
|
-
"char": "i",
|
|
469
|
-
"name": "job-id",
|
|
470
|
-
"required": true,
|
|
471
|
-
"summary": "Job ID of the bulk job.",
|
|
472
|
-
"hasDynamicHelp": false,
|
|
473
|
-
"multiple": false,
|
|
474
|
-
"type": "option"
|
|
475
|
-
},
|
|
476
|
-
"target-org": {
|
|
477
|
-
"char": "o",
|
|
478
|
-
"name": "target-org",
|
|
479
|
-
"noCacheDefault": true,
|
|
480
|
-
"required": true,
|
|
481
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
482
|
-
"hasDynamicHelp": true,
|
|
483
|
-
"multiple": false,
|
|
484
|
-
"type": "option"
|
|
485
|
-
},
|
|
486
|
-
"api-version": {
|
|
487
|
-
"description": "Override the api version used for api requests made by this command",
|
|
488
|
-
"name": "api-version",
|
|
489
|
-
"hasDynamicHelp": false,
|
|
490
|
-
"multiple": false,
|
|
491
|
-
"type": "option"
|
|
492
|
-
}
|
|
493
|
-
},
|
|
494
|
-
"hasDynamicHelp": true,
|
|
495
|
-
"hiddenAliases": [],
|
|
496
|
-
"id": "data:bulk:results",
|
|
497
|
-
"pluginAlias": "@salesforce/plugin-data",
|
|
498
|
-
"pluginName": "@salesforce/plugin-data",
|
|
499
|
-
"pluginType": "core",
|
|
500
|
-
"strict": true,
|
|
501
|
-
"summary": "Get the results of a bulk ingest job that you previously ran.",
|
|
502
|
-
"enableJsonFlag": true,
|
|
503
|
-
"isESM": true,
|
|
504
|
-
"relativePath": [
|
|
505
|
-
"lib",
|
|
506
|
-
"commands",
|
|
507
|
-
"data",
|
|
508
|
-
"bulk",
|
|
509
|
-
"results.js"
|
|
510
|
-
],
|
|
511
|
-
"aliasPermutations": [],
|
|
512
|
-
"permutations": [
|
|
513
|
-
"data:bulk:results",
|
|
514
|
-
"bulk:data:results",
|
|
515
|
-
"bulk:results:data",
|
|
516
|
-
"data:results:bulk",
|
|
517
|
-
"results:data:bulk",
|
|
518
|
-
"results:bulk:data"
|
|
519
|
-
]
|
|
520
|
-
},
|
|
521
444
|
"data:create:file": {
|
|
522
445
|
"aliases": [],
|
|
523
446
|
"args": {},
|
|
@@ -775,6 +698,83 @@
|
|
|
775
698
|
"record:create:data"
|
|
776
699
|
]
|
|
777
700
|
},
|
|
701
|
+
"data:bulk:results": {
|
|
702
|
+
"aliases": [],
|
|
703
|
+
"args": {},
|
|
704
|
+
"description": "Use this command to get the complete results after running one of the CLI commands that uses Bulk API 2.0 to ingest (import, update, upsert, or delete) large datasets to your org, such as \"data import bulk\". The previously-run bulk command must have completed; if it's still processing, run the corresponding resume command first, such as \"data import resume.\" Make note of the job ID of the previous bulk command because you use it to run this command. \n\nYou can also use this command to get results from running a bulk ingest job with a different tool, such as Data Loader, as long as you have the job ID. For information on Data Loader, see https://developer.salesforce.com/docs/atlas.en-us.dataLoader.meta/dataLoader/data_loader_intro.htm. \n\nThis command first displays the status of the previous bulk job, the operation that was executed in the org (such as insert or hard delete), and the updated Salesforce object. The command then displays how many records were processed in total, and how many were successful or failed. Finally, the output displays the names of the generated CSV-formatted files that contain the specific results for each ingested record. Depending on the success or failure of the bulk command, the results files can include the IDs of inserted records or the specific errors. When possible, if the ingest job failed or was aborted, you also get a CSV file with the unprocessed results.",
|
|
705
|
+
"examples": [
|
|
706
|
+
"Get results from a bulk ingest job; use the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --job-id 7507i000fake341G --target-org my-scratch"
|
|
707
|
+
],
|
|
708
|
+
"flags": {
|
|
709
|
+
"json": {
|
|
710
|
+
"description": "Format output as json.",
|
|
711
|
+
"helpGroup": "GLOBAL",
|
|
712
|
+
"name": "json",
|
|
713
|
+
"allowNo": false,
|
|
714
|
+
"type": "boolean"
|
|
715
|
+
},
|
|
716
|
+
"flags-dir": {
|
|
717
|
+
"helpGroup": "GLOBAL",
|
|
718
|
+
"name": "flags-dir",
|
|
719
|
+
"summary": "Import flag values from a directory.",
|
|
720
|
+
"hasDynamicHelp": false,
|
|
721
|
+
"multiple": false,
|
|
722
|
+
"type": "option"
|
|
723
|
+
},
|
|
724
|
+
"job-id": {
|
|
725
|
+
"char": "i",
|
|
726
|
+
"name": "job-id",
|
|
727
|
+
"required": true,
|
|
728
|
+
"summary": "Job ID of the bulk job.",
|
|
729
|
+
"hasDynamicHelp": false,
|
|
730
|
+
"multiple": false,
|
|
731
|
+
"type": "option"
|
|
732
|
+
},
|
|
733
|
+
"target-org": {
|
|
734
|
+
"char": "o",
|
|
735
|
+
"name": "target-org",
|
|
736
|
+
"noCacheDefault": true,
|
|
737
|
+
"required": true,
|
|
738
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
739
|
+
"hasDynamicHelp": true,
|
|
740
|
+
"multiple": false,
|
|
741
|
+
"type": "option"
|
|
742
|
+
},
|
|
743
|
+
"api-version": {
|
|
744
|
+
"description": "Override the api version used for api requests made by this command",
|
|
745
|
+
"name": "api-version",
|
|
746
|
+
"hasDynamicHelp": false,
|
|
747
|
+
"multiple": false,
|
|
748
|
+
"type": "option"
|
|
749
|
+
}
|
|
750
|
+
},
|
|
751
|
+
"hasDynamicHelp": true,
|
|
752
|
+
"hiddenAliases": [],
|
|
753
|
+
"id": "data:bulk:results",
|
|
754
|
+
"pluginAlias": "@salesforce/plugin-data",
|
|
755
|
+
"pluginName": "@salesforce/plugin-data",
|
|
756
|
+
"pluginType": "core",
|
|
757
|
+
"strict": true,
|
|
758
|
+
"summary": "Get the results of a bulk ingest job that you previously ran.",
|
|
759
|
+
"enableJsonFlag": true,
|
|
760
|
+
"isESM": true,
|
|
761
|
+
"relativePath": [
|
|
762
|
+
"lib",
|
|
763
|
+
"commands",
|
|
764
|
+
"data",
|
|
765
|
+
"bulk",
|
|
766
|
+
"results.js"
|
|
767
|
+
],
|
|
768
|
+
"aliasPermutations": [],
|
|
769
|
+
"permutations": [
|
|
770
|
+
"data:bulk:results",
|
|
771
|
+
"bulk:data:results",
|
|
772
|
+
"bulk:results:data",
|
|
773
|
+
"data:results:bulk",
|
|
774
|
+
"results:data:bulk",
|
|
775
|
+
"results:bulk:data"
|
|
776
|
+
]
|
|
777
|
+
},
|
|
778
778
|
"data:delete:bulk": {
|
|
779
779
|
"aliases": [],
|
|
780
780
|
"args": {},
|
|
@@ -3148,13 +3148,18 @@
|
|
|
3148
3148
|
"resume:upsert:data"
|
|
3149
3149
|
]
|
|
3150
3150
|
},
|
|
3151
|
-
"
|
|
3151
|
+
"data:export:legacy:tree": {
|
|
3152
3152
|
"aliases": [],
|
|
3153
3153
|
"args": {},
|
|
3154
|
-
"
|
|
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).",
|
|
3155
3159
|
"examples": [
|
|
3156
|
-
"
|
|
3157
|
-
"
|
|
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"
|
|
3158
3163
|
],
|
|
3159
3164
|
"flags": {
|
|
3160
3165
|
"json": {
|
|
@@ -3208,95 +3213,101 @@
|
|
|
3208
3213
|
"multiple": false,
|
|
3209
3214
|
"type": "option"
|
|
3210
3215
|
},
|
|
3211
|
-
"
|
|
3212
|
-
"
|
|
3213
|
-
|
|
3214
|
-
],
|
|
3215
|
-
"char": "f",
|
|
3216
|
-
"deprecateAliases": true,
|
|
3217
|
-
"name": "file",
|
|
3216
|
+
"query": {
|
|
3217
|
+
"char": "q",
|
|
3218
|
+
"name": "query",
|
|
3218
3219
|
"required": true,
|
|
3219
|
-
"summary": "
|
|
3220
|
+
"summary": "SOQL query, or filepath of a file that contains the query, to retrieve records.",
|
|
3220
3221
|
"hasDynamicHelp": false,
|
|
3221
3222
|
"multiple": false,
|
|
3222
3223
|
"type": "option"
|
|
3223
3224
|
},
|
|
3224
|
-
"
|
|
3225
|
-
"
|
|
3226
|
-
|
|
3227
|
-
|
|
3228
|
-
"
|
|
3229
|
-
"
|
|
3230
|
-
|
|
3231
|
-
|
|
3232
|
-
"
|
|
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.",
|
|
3233
3236
|
"hasDynamicHelp": false,
|
|
3234
3237
|
"multiple": false,
|
|
3235
3238
|
"type": "option"
|
|
3236
3239
|
},
|
|
3237
|
-
"
|
|
3238
|
-
"
|
|
3239
|
-
|
|
3240
|
-
|
|
3241
|
-
"
|
|
3242
|
-
"
|
|
3240
|
+
"output-dir": {
|
|
3241
|
+
"aliases": [
|
|
3242
|
+
"outputdir"
|
|
3243
|
+
],
|
|
3244
|
+
"char": "d",
|
|
3245
|
+
"deprecateAliases": true,
|
|
3246
|
+
"name": "output-dir",
|
|
3247
|
+
"summary": "Directory in which to generate the JSON files; default is current directory.",
|
|
3248
|
+
"hasDynamicHelp": false,
|
|
3243
3249
|
"multiple": false,
|
|
3244
3250
|
"type": "option"
|
|
3245
3251
|
}
|
|
3246
3252
|
},
|
|
3247
3253
|
"hasDynamicHelp": true,
|
|
3254
|
+
"hidden": true,
|
|
3248
3255
|
"hiddenAliases": [],
|
|
3249
|
-
"id": "
|
|
3256
|
+
"id": "data:export:legacy:tree",
|
|
3250
3257
|
"pluginAlias": "@salesforce/plugin-data",
|
|
3251
3258
|
"pluginName": "@salesforce/plugin-data",
|
|
3252
3259
|
"pluginType": "core",
|
|
3260
|
+
"state": "deprecated",
|
|
3253
3261
|
"strict": true,
|
|
3254
|
-
"summary": "
|
|
3262
|
+
"summary": "Export data from an org into one or more JSON files.",
|
|
3255
3263
|
"enableJsonFlag": true,
|
|
3256
3264
|
"isESM": true,
|
|
3257
3265
|
"relativePath": [
|
|
3258
3266
|
"lib",
|
|
3259
3267
|
"commands",
|
|
3260
|
-
"force",
|
|
3261
3268
|
"data",
|
|
3262
|
-
"
|
|
3263
|
-
"
|
|
3269
|
+
"export",
|
|
3270
|
+
"legacy",
|
|
3271
|
+
"tree.js"
|
|
3264
3272
|
],
|
|
3265
3273
|
"aliasPermutations": [],
|
|
3266
3274
|
"permutations": [
|
|
3267
|
-
"
|
|
3268
|
-
"data:
|
|
3269
|
-
"
|
|
3270
|
-
"
|
|
3271
|
-
"
|
|
3272
|
-
"
|
|
3273
|
-
"
|
|
3274
|
-
"
|
|
3275
|
-
"
|
|
3276
|
-
"
|
|
3277
|
-
"
|
|
3278
|
-
"
|
|
3279
|
-
"
|
|
3280
|
-
"data:
|
|
3281
|
-
"
|
|
3282
|
-
"
|
|
3283
|
-
"
|
|
3284
|
-
"
|
|
3285
|
-
"
|
|
3286
|
-
"
|
|
3287
|
-
"
|
|
3288
|
-
"
|
|
3289
|
-
"
|
|
3290
|
-
"
|
|
3291
|
-
]
|
|
3292
|
-
},
|
|
3293
|
-
"
|
|
3294
|
-
"aliases": [],
|
|
3295
|
-
"args": {},
|
|
3296
|
-
"
|
|
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"
|
|
3299
|
+
]
|
|
3300
|
+
},
|
|
3301
|
+
"data:import:legacy:tree": {
|
|
3302
|
+
"aliases": [],
|
|
3303
|
+
"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)",
|
|
3297
3308
|
"examples": [
|
|
3298
|
-
"
|
|
3299
|
-
"
|
|
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"
|
|
3300
3311
|
],
|
|
3301
3312
|
"flags": {
|
|
3302
3313
|
"json": {
|
|
@@ -3350,85 +3361,116 @@
|
|
|
3350
3361
|
"multiple": false,
|
|
3351
3362
|
"type": "option"
|
|
3352
3363
|
},
|
|
3353
|
-
"
|
|
3364
|
+
"files": {
|
|
3354
3365
|
"aliases": [
|
|
3355
|
-
"
|
|
3366
|
+
"sobjecttreefiles"
|
|
3356
3367
|
],
|
|
3357
|
-
"char": "
|
|
3368
|
+
"char": "f",
|
|
3358
3369
|
"deprecateAliases": true,
|
|
3359
|
-
"
|
|
3360
|
-
|
|
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.",
|
|
3361
3384
|
"hasDynamicHelp": false,
|
|
3362
3385
|
"multiple": false,
|
|
3363
3386
|
"type": "option"
|
|
3364
3387
|
},
|
|
3365
|
-
"
|
|
3388
|
+
"content-type": {
|
|
3366
3389
|
"aliases": [
|
|
3367
|
-
"
|
|
3390
|
+
"contenttype"
|
|
3368
3391
|
],
|
|
3369
|
-
"char": "
|
|
3392
|
+
"char": "c",
|
|
3370
3393
|
"deprecateAliases": true,
|
|
3371
|
-
"
|
|
3372
|
-
|
|
3373
|
-
|
|
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.",
|
|
3374
3400
|
"hasDynamicHelp": false,
|
|
3375
3401
|
"multiple": false,
|
|
3376
3402
|
"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"
|
|
3377
3417
|
}
|
|
3378
3418
|
},
|
|
3379
3419
|
"hasDynamicHelp": true,
|
|
3420
|
+
"hidden": true,
|
|
3380
3421
|
"hiddenAliases": [],
|
|
3381
|
-
"id": "
|
|
3422
|
+
"id": "data:import:legacy:tree",
|
|
3382
3423
|
"pluginAlias": "@salesforce/plugin-data",
|
|
3383
3424
|
"pluginName": "@salesforce/plugin-data",
|
|
3384
3425
|
"pluginType": "core",
|
|
3426
|
+
"state": "deprecated",
|
|
3385
3427
|
"strict": true,
|
|
3386
|
-
"summary": "
|
|
3428
|
+
"summary": "Import data from one or more JSON files into an org.",
|
|
3387
3429
|
"enableJsonFlag": true,
|
|
3388
3430
|
"isESM": true,
|
|
3389
3431
|
"relativePath": [
|
|
3390
3432
|
"lib",
|
|
3391
3433
|
"commands",
|
|
3392
|
-
"force",
|
|
3393
3434
|
"data",
|
|
3394
|
-
"
|
|
3395
|
-
"
|
|
3435
|
+
"import",
|
|
3436
|
+
"legacy",
|
|
3437
|
+
"tree.js"
|
|
3396
3438
|
],
|
|
3397
3439
|
"aliasPermutations": [],
|
|
3398
3440
|
"permutations": [
|
|
3399
|
-
"
|
|
3400
|
-
"data:
|
|
3401
|
-
"
|
|
3402
|
-
"
|
|
3403
|
-
"
|
|
3404
|
-
"
|
|
3405
|
-
"
|
|
3406
|
-
"
|
|
3407
|
-
"
|
|
3408
|
-
"
|
|
3409
|
-
"
|
|
3410
|
-
"
|
|
3411
|
-
"
|
|
3412
|
-
"data:
|
|
3413
|
-
"
|
|
3414
|
-
"
|
|
3415
|
-
"
|
|
3416
|
-
"
|
|
3417
|
-
"
|
|
3418
|
-
"
|
|
3419
|
-
"
|
|
3420
|
-
"
|
|
3421
|
-
"
|
|
3422
|
-
"
|
|
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"
|
|
3423
3465
|
]
|
|
3424
3466
|
},
|
|
3425
|
-
"force:data:bulk:
|
|
3467
|
+
"force:data:bulk:delete": {
|
|
3426
3468
|
"aliases": [],
|
|
3427
3469
|
"args": {},
|
|
3428
|
-
"description": "
|
|
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.",
|
|
3429
3471
|
"examples": [
|
|
3430
|
-
"Bulk
|
|
3431
|
-
"Bulk
|
|
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"
|
|
3432
3474
|
],
|
|
3433
3475
|
"flags": {
|
|
3434
3476
|
"json": {
|
|
@@ -3482,19 +3524,6 @@
|
|
|
3482
3524
|
"multiple": false,
|
|
3483
3525
|
"type": "option"
|
|
3484
3526
|
},
|
|
3485
|
-
"external-id": {
|
|
3486
|
-
"aliases": [
|
|
3487
|
-
"externalid"
|
|
3488
|
-
],
|
|
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
3527
|
"file": {
|
|
3499
3528
|
"aliases": [
|
|
3500
3529
|
"csvfile"
|
|
@@ -3503,7 +3532,7 @@
|
|
|
3503
3532
|
"deprecateAliases": true,
|
|
3504
3533
|
"name": "file",
|
|
3505
3534
|
"required": true,
|
|
3506
|
-
"summary": "CSV file that contains the records to
|
|
3535
|
+
"summary": "CSV file that contains the IDs of the records to delete.",
|
|
3507
3536
|
"hasDynamicHelp": false,
|
|
3508
3537
|
"multiple": false,
|
|
3509
3538
|
"type": "option"
|
|
@@ -3516,7 +3545,7 @@
|
|
|
3516
3545
|
"deprecateAliases": true,
|
|
3517
3546
|
"name": "sobject",
|
|
3518
3547
|
"required": true,
|
|
3519
|
-
"summary": "API name of the Salesforce object, either standard or custom, that you want to
|
|
3548
|
+
"summary": "API name of the Salesforce object, either standard or custom, that you want to delete records from.",
|
|
3520
3549
|
"hasDynamicHelp": false,
|
|
3521
3550
|
"multiple": false,
|
|
3522
3551
|
"type": "option"
|
|
@@ -3529,23 +3558,16 @@
|
|
|
3529
3558
|
"hasDynamicHelp": true,
|
|
3530
3559
|
"multiple": false,
|
|
3531
3560
|
"type": "option"
|
|
3532
|
-
},
|
|
3533
|
-
"serial": {
|
|
3534
|
-
"char": "r",
|
|
3535
|
-
"name": "serial",
|
|
3536
|
-
"summary": "Run batches in serial mode.",
|
|
3537
|
-
"allowNo": false,
|
|
3538
|
-
"type": "boolean"
|
|
3539
3561
|
}
|
|
3540
3562
|
},
|
|
3541
3563
|
"hasDynamicHelp": true,
|
|
3542
3564
|
"hiddenAliases": [],
|
|
3543
|
-
"id": "force:data:bulk:
|
|
3565
|
+
"id": "force:data:bulk:delete",
|
|
3544
3566
|
"pluginAlias": "@salesforce/plugin-data",
|
|
3545
3567
|
"pluginName": "@salesforce/plugin-data",
|
|
3546
3568
|
"pluginType": "core",
|
|
3547
3569
|
"strict": true,
|
|
3548
|
-
"summary": "Bulk
|
|
3570
|
+
"summary": "Bulk delete records from an org using a CSV file. Uses Bulk API 1.0.",
|
|
3549
3571
|
"enableJsonFlag": true,
|
|
3550
3572
|
"isESM": true,
|
|
3551
3573
|
"relativePath": [
|
|
@@ -3554,48 +3576,43 @@
|
|
|
3554
3576
|
"force",
|
|
3555
3577
|
"data",
|
|
3556
3578
|
"bulk",
|
|
3557
|
-
"
|
|
3579
|
+
"delete.js"
|
|
3558
3580
|
],
|
|
3559
3581
|
"aliasPermutations": [],
|
|
3560
3582
|
"permutations": [
|
|
3561
|
-
"force:data:bulk:
|
|
3562
|
-
"data:force:bulk:
|
|
3563
|
-
"data:bulk:force:
|
|
3564
|
-
"data:bulk:
|
|
3565
|
-
"force:bulk:data:
|
|
3566
|
-
"bulk:force:data:
|
|
3567
|
-
"bulk:data:force:
|
|
3568
|
-
"bulk:data:
|
|
3569
|
-
"force:bulk:
|
|
3570
|
-
"bulk:force:
|
|
3571
|
-
"bulk:
|
|
3572
|
-
"bulk:
|
|
3573
|
-
"force:data:
|
|
3574
|
-
"data:force:
|
|
3575
|
-
"data:
|
|
3576
|
-
"data:
|
|
3577
|
-
"force:
|
|
3578
|
-
"
|
|
3579
|
-
"
|
|
3580
|
-
"
|
|
3581
|
-
"force:
|
|
3582
|
-
"
|
|
3583
|
-
"
|
|
3584
|
-
"
|
|
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"
|
|
3585
3607
|
]
|
|
3586
3608
|
},
|
|
3587
|
-
"data:
|
|
3609
|
+
"force:data:bulk:status": {
|
|
3588
3610
|
"aliases": [],
|
|
3589
3611
|
"args": {},
|
|
3590
|
-
"
|
|
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).",
|
|
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.",
|
|
3595
3613
|
"examples": [
|
|
3596
|
-
"
|
|
3597
|
-
"
|
|
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"
|
|
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"
|
|
3599
3616
|
],
|
|
3600
3617
|
"flags": {
|
|
3601
3618
|
"json": {
|
|
@@ -3649,101 +3666,85 @@
|
|
|
3649
3666
|
"multiple": false,
|
|
3650
3667
|
"type": "option"
|
|
3651
3668
|
},
|
|
3652
|
-
"
|
|
3653
|
-
"
|
|
3654
|
-
|
|
3655
|
-
|
|
3656
|
-
"
|
|
3657
|
-
"
|
|
3658
|
-
"
|
|
3659
|
-
"
|
|
3660
|
-
},
|
|
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.",
|
|
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.",
|
|
3672
3677
|
"hasDynamicHelp": false,
|
|
3673
3678
|
"multiple": false,
|
|
3674
3679
|
"type": "option"
|
|
3675
3680
|
},
|
|
3676
|
-
"
|
|
3681
|
+
"job-id": {
|
|
3677
3682
|
"aliases": [
|
|
3678
|
-
"
|
|
3683
|
+
"jobid"
|
|
3679
3684
|
],
|
|
3680
|
-
"char": "
|
|
3685
|
+
"char": "i",
|
|
3681
3686
|
"deprecateAliases": true,
|
|
3682
|
-
"name": "
|
|
3683
|
-
"
|
|
3687
|
+
"name": "job-id",
|
|
3688
|
+
"required": true,
|
|
3689
|
+
"summary": "ID of the job whose status you want to view.",
|
|
3684
3690
|
"hasDynamicHelp": false,
|
|
3685
3691
|
"multiple": false,
|
|
3686
3692
|
"type": "option"
|
|
3687
3693
|
}
|
|
3688
3694
|
},
|
|
3689
3695
|
"hasDynamicHelp": true,
|
|
3690
|
-
"hidden": true,
|
|
3691
3696
|
"hiddenAliases": [],
|
|
3692
|
-
"id": "data:
|
|
3697
|
+
"id": "force:data:bulk:status",
|
|
3693
3698
|
"pluginAlias": "@salesforce/plugin-data",
|
|
3694
3699
|
"pluginName": "@salesforce/plugin-data",
|
|
3695
3700
|
"pluginType": "core",
|
|
3696
|
-
"state": "deprecated",
|
|
3697
3701
|
"strict": true,
|
|
3698
|
-
"summary": "
|
|
3702
|
+
"summary": "View the status of a bulk data load job or batch. Uses Bulk API 1.0.",
|
|
3699
3703
|
"enableJsonFlag": true,
|
|
3700
3704
|
"isESM": true,
|
|
3701
3705
|
"relativePath": [
|
|
3702
3706
|
"lib",
|
|
3703
3707
|
"commands",
|
|
3708
|
+
"force",
|
|
3704
3709
|
"data",
|
|
3705
|
-
"
|
|
3706
|
-
"
|
|
3707
|
-
"tree.js"
|
|
3710
|
+
"bulk",
|
|
3711
|
+
"status.js"
|
|
3708
3712
|
],
|
|
3709
3713
|
"aliasPermutations": [],
|
|
3710
3714
|
"permutations": [
|
|
3711
|
-
"data:
|
|
3712
|
-
"
|
|
3713
|
-
"
|
|
3714
|
-
"
|
|
3715
|
-
"
|
|
3716
|
-
"
|
|
3717
|
-
"
|
|
3718
|
-
"
|
|
3719
|
-
"
|
|
3720
|
-
"
|
|
3721
|
-
"
|
|
3722
|
-
"
|
|
3723
|
-
"data:
|
|
3724
|
-
"
|
|
3725
|
-
"
|
|
3726
|
-
"
|
|
3727
|
-
"
|
|
3728
|
-
"
|
|
3729
|
-
"
|
|
3730
|
-
"
|
|
3731
|
-
"
|
|
3732
|
-
"
|
|
3733
|
-
"
|
|
3734
|
-
"
|
|
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"
|
|
3735
3739
|
]
|
|
3736
3740
|
},
|
|
3737
|
-
"data:
|
|
3741
|
+
"force:data:bulk:upsert": {
|
|
3738
3742
|
"aliases": [],
|
|
3739
3743
|
"args": {},
|
|
3740
|
-
"
|
|
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)",
|
|
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.",
|
|
3744
3745
|
"examples": [
|
|
3745
|
-
"
|
|
3746
|
-
"
|
|
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"
|
|
3747
3748
|
],
|
|
3748
3749
|
"flags": {
|
|
3749
3750
|
"json": {
|
|
@@ -3797,109 +3798,108 @@
|
|
|
3797
3798
|
"multiple": false,
|
|
3798
3799
|
"type": "option"
|
|
3799
3800
|
},
|
|
3800
|
-
"
|
|
3801
|
+
"external-id": {
|
|
3801
3802
|
"aliases": [
|
|
3802
|
-
"
|
|
3803
|
+
"externalid"
|
|
3803
3804
|
],
|
|
3804
|
-
"char": "
|
|
3805
|
+
"char": "i",
|
|
3805
3806
|
"deprecateAliases": true,
|
|
3806
|
-
"
|
|
3807
|
-
|
|
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": ",",
|
|
3812
|
-
"hasDynamicHelp": false,
|
|
3813
|
-
"multiple": true,
|
|
3814
|
-
"type": "option"
|
|
3815
|
-
},
|
|
3816
|
-
"plan": {
|
|
3817
|
-
"char": "p",
|
|
3818
|
-
"name": "plan",
|
|
3819
|
-
"summary": "Plan definition file to insert multiple data files.",
|
|
3807
|
+
"name": "external-id",
|
|
3808
|
+
"required": true,
|
|
3809
|
+
"summary": "Name of the external ID field, or the Id field.",
|
|
3820
3810
|
"hasDynamicHelp": false,
|
|
3821
3811
|
"multiple": false,
|
|
3822
3812
|
"type": "option"
|
|
3823
3813
|
},
|
|
3824
|
-
"
|
|
3814
|
+
"file": {
|
|
3825
3815
|
"aliases": [
|
|
3826
|
-
"
|
|
3816
|
+
"csvfile"
|
|
3827
3817
|
],
|
|
3828
|
-
"char": "
|
|
3818
|
+
"char": "f",
|
|
3829
3819
|
"deprecateAliases": true,
|
|
3830
|
-
"
|
|
3831
|
-
|
|
3832
|
-
|
|
3833
|
-
"hidden": true,
|
|
3834
|
-
"name": "content-type",
|
|
3835
|
-
"summary": "Content type of import files if their extention is not .json.",
|
|
3820
|
+
"name": "file",
|
|
3821
|
+
"required": true,
|
|
3822
|
+
"summary": "CSV file that contains the records to upsert.",
|
|
3836
3823
|
"hasDynamicHelp": false,
|
|
3837
3824
|
"multiple": false,
|
|
3838
3825
|
"type": "option"
|
|
3839
3826
|
},
|
|
3840
|
-
"
|
|
3827
|
+
"sobject": {
|
|
3841
3828
|
"aliases": [
|
|
3842
|
-
"
|
|
3829
|
+
"sobjecttype"
|
|
3843
3830
|
],
|
|
3831
|
+
"char": "s",
|
|
3844
3832
|
"deprecateAliases": true,
|
|
3845
|
-
"
|
|
3846
|
-
|
|
3847
|
-
|
|
3848
|
-
"
|
|
3849
|
-
"
|
|
3850
|
-
"
|
|
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.",
|
|
3836
|
+
"hasDynamicHelp": false,
|
|
3837
|
+
"multiple": false,
|
|
3838
|
+
"type": "option"
|
|
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.",
|
|
3851
3853
|
"allowNo": false,
|
|
3852
3854
|
"type": "boolean"
|
|
3853
3855
|
}
|
|
3854
3856
|
},
|
|
3855
3857
|
"hasDynamicHelp": true,
|
|
3856
|
-
"hidden": true,
|
|
3857
3858
|
"hiddenAliases": [],
|
|
3858
|
-
"id": "data:
|
|
3859
|
+
"id": "force:data:bulk:upsert",
|
|
3859
3860
|
"pluginAlias": "@salesforce/plugin-data",
|
|
3860
3861
|
"pluginName": "@salesforce/plugin-data",
|
|
3861
3862
|
"pluginType": "core",
|
|
3862
|
-
"state": "deprecated",
|
|
3863
3863
|
"strict": true,
|
|
3864
|
-
"summary": "
|
|
3864
|
+
"summary": "Bulk upsert records to an org from a CSV file. Uses Bulk API 1.0.",
|
|
3865
3865
|
"enableJsonFlag": true,
|
|
3866
3866
|
"isESM": true,
|
|
3867
3867
|
"relativePath": [
|
|
3868
3868
|
"lib",
|
|
3869
3869
|
"commands",
|
|
3870
|
+
"force",
|
|
3870
3871
|
"data",
|
|
3871
|
-
"
|
|
3872
|
-
"
|
|
3873
|
-
"tree.js"
|
|
3872
|
+
"bulk",
|
|
3873
|
+
"upsert.js"
|
|
3874
3874
|
],
|
|
3875
3875
|
"aliasPermutations": [],
|
|
3876
3876
|
"permutations": [
|
|
3877
|
-
"data:
|
|
3878
|
-
"
|
|
3879
|
-
"
|
|
3880
|
-
"
|
|
3881
|
-
"
|
|
3882
|
-
"
|
|
3883
|
-
"
|
|
3884
|
-
"
|
|
3885
|
-
"
|
|
3886
|
-
"
|
|
3887
|
-
"
|
|
3888
|
-
"
|
|
3889
|
-
"data:
|
|
3890
|
-
"
|
|
3891
|
-
"
|
|
3892
|
-
"
|
|
3893
|
-
"
|
|
3894
|
-
"
|
|
3895
|
-
"
|
|
3896
|
-
"
|
|
3897
|
-
"
|
|
3898
|
-
"
|
|
3899
|
-
"
|
|
3900
|
-
"
|
|
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"
|
|
3901
3901
|
]
|
|
3902
3902
|
}
|
|
3903
3903
|
},
|
|
3904
|
-
"version": "3.13.
|
|
3904
|
+
"version": "3.13.7"
|
|
3905
3905
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-data",
|
|
3
|
-
"version": "3.13.
|
|
3
|
+
"version": "3.13.7",
|
|
4
4
|
"description": "Plugin for salesforce data commands",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"homepage": "https://github.com/salesforcecli/plugin-data",
|
|
@@ -122,7 +122,7 @@
|
|
|
122
122
|
"@oclif/multi-stage-output": "^0.8.0",
|
|
123
123
|
"@salesforce/core": "^8.6.1",
|
|
124
124
|
"@salesforce/kit": "^3.2.2",
|
|
125
|
-
"@salesforce/sf-plugins-core": "^12.1.
|
|
125
|
+
"@salesforce/sf-plugins-core": "^12.1.1",
|
|
126
126
|
"@salesforce/ts-types": "^2.0.11",
|
|
127
127
|
"ansis": "^3.4.0",
|
|
128
128
|
"change-case": "^5.4.4",
|
|
@@ -134,7 +134,7 @@
|
|
|
134
134
|
"devDependencies": {
|
|
135
135
|
"@oclif/core": "^4.2.0",
|
|
136
136
|
"@oclif/plugin-command-snapshot": "^5.2.23",
|
|
137
|
-
"@oclif/test": "^4.1.
|
|
137
|
+
"@oclif/test": "^4.1.4",
|
|
138
138
|
"@salesforce/cli-plugins-testkit": "^5.3.39",
|
|
139
139
|
"@salesforce/dev-scripts": "^10.2.11",
|
|
140
140
|
"@salesforce/plugin-command-reference": "^3.1.37",
|
|
@@ -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.
|
|
269
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.13.
|
|
268
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.13.7.crt",
|
|
269
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.13.7.sig"
|
|
270
270
|
}
|
|
271
271
|
}
|