@salesforce/plugin-data 4.0.87 → 4.0.88

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 +24 -24
  2. package/oclif.manifest.json +442 -442
  3. package/package.json +6 -6
package/README.md CHANGED
@@ -144,7 +144,7 @@ EXAMPLES
144
144
  $ sf data bulk results --job-id 7507i000fake341G --target-org my-scratch
145
145
  ```
146
146
 
147
- _See code: [src/commands/data/bulk/results.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/bulk/results.ts)_
147
+ _See code: [src/commands/data/bulk/results.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/bulk/results.ts)_
148
148
 
149
149
  ## `sf data create file`
150
150
 
@@ -193,7 +193,7 @@ EXAMPLES
193
193
  $ sf data create file --file path/to/astro.png --parent-id a03fakeLoJWPIA3
194
194
  ```
195
195
 
196
- _See code: [src/commands/data/create/file.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/create/file.ts)_
196
+ _See code: [src/commands/data/create/file.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/create/file.ts)_
197
197
 
198
198
  ## `sf data create record`
199
199
 
@@ -249,7 +249,7 @@ EXAMPLES
249
249
  TracedEntityId=01p17000000R6bLAAS"
250
250
  ```
251
251
 
252
- _See code: [src/commands/data/create/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/create/record.ts)_
252
+ _See code: [src/commands/data/create/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/create/record.ts)_
253
253
 
254
254
  ## `sf data delete bulk`
255
255
 
@@ -308,7 +308,7 @@ FLAG DESCRIPTIONS
308
308
  and can be enabled only by a system administrator.
309
309
  ```
310
310
 
311
- _See code: [src/commands/data/delete/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/delete/bulk.ts)_
311
+ _See code: [src/commands/data/delete/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/delete/bulk.ts)_
312
312
 
313
313
  ## `sf data delete record`
314
314
 
@@ -369,7 +369,7 @@ EXAMPLES
369
369
  $ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
370
370
  ```
371
371
 
372
- _See code: [src/commands/data/delete/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/delete/record.ts)_
372
+ _See code: [src/commands/data/delete/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/delete/record.ts)_
373
373
 
374
374
  ## `sf data delete resume`
375
375
 
@@ -408,7 +408,7 @@ EXAMPLES
408
408
  $ sf data delete resume --use-most-recent --target-org my-scratch
409
409
  ```
410
410
 
411
- _See code: [src/commands/data/delete/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/delete/resume.ts)_
411
+ _See code: [src/commands/data/delete/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/delete/resume.ts)_
412
412
 
413
413
  ## `sf data export bulk`
414
414
 
@@ -475,7 +475,7 @@ EXAMPLES
475
475
  --result-format json --wait 10 --all-rows
476
476
  ```
477
477
 
478
- _See code: [src/commands/data/export/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/export/bulk.ts)_
478
+ _See code: [src/commands/data/export/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/export/bulk.ts)_
479
479
 
480
480
  ## `sf data export resume`
481
481
 
@@ -514,7 +514,7 @@ EXAMPLES
514
514
  $ sf data export resume --use-most-recent
515
515
  ```
516
516
 
517
- _See code: [src/commands/data/export/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/export/resume.ts)_
517
+ _See code: [src/commands/data/export/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/export/resume.ts)_
518
518
 
519
519
  ## `sf data export tree`
520
520
 
@@ -574,7 +574,7 @@ EXAMPLES
574
574
  my-scratch
575
575
  ```
576
576
 
577
- _See code: [src/commands/data/export/tree.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/export/tree.ts)_
577
+ _See code: [src/commands/data/export/tree.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/export/tree.ts)_
578
578
 
579
579
  ## `sf data get record`
580
580
 
@@ -638,7 +638,7 @@ EXAMPLES
638
638
  $ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
639
639
  ```
640
640
 
641
- _See code: [src/commands/data/get/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/get/record.ts)_
641
+ _See code: [src/commands/data/get/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/get/record.ts)_
642
642
 
643
643
  ## `sf data import bulk`
644
644
 
@@ -690,7 +690,7 @@ EXAMPLES
690
690
  $ sf data import bulk --file accounts.csv --sobject Account --wait 10 --target-org my-scratch
691
691
  ```
692
692
 
693
- _See code: [src/commands/data/import/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/import/bulk.ts)_
693
+ _See code: [src/commands/data/import/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/import/bulk.ts)_
694
694
 
695
695
  ## `sf data import resume`
696
696
 
@@ -726,7 +726,7 @@ EXAMPLES
726
726
  $ sf data import resume --use-most-recent --target-org my-scratch
727
727
  ```
728
728
 
729
- _See code: [src/commands/data/import/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/import/resume.ts)_
729
+ _See code: [src/commands/data/import/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/import/resume.ts)_
730
730
 
731
731
  ## `sf data import tree`
732
732
 
@@ -790,7 +790,7 @@ FLAG DESCRIPTIONS
790
790
  - files(array) - Files: An array of files paths to load
791
791
  ```
792
792
 
793
- _See code: [src/commands/data/import/tree.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/import/tree.ts)_
793
+ _See code: [src/commands/data/import/tree.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/import/tree.ts)_
794
794
 
795
795
  ## `sf data query`
796
796
 
@@ -843,7 +843,7 @@ EXAMPLES
843
843
  $ sf data query --query "SELECT Name FROM ApexTrigger" --use-tooling-api
844
844
  ```
845
845
 
846
- _See code: [src/commands/data/query.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/query.ts)_
846
+ _See code: [src/commands/data/query.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/query.ts)_
847
847
 
848
848
  ## `sf data resume`
849
849
 
@@ -880,7 +880,7 @@ EXAMPLES
880
880
  $ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
881
881
  ```
882
882
 
883
- _See code: [src/commands/data/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/resume.ts)_
883
+ _See code: [src/commands/data/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/resume.ts)_
884
884
 
885
885
  ## `sf data search`
886
886
 
@@ -930,7 +930,7 @@ EXAMPLES
930
930
  $ sf data search --file query.txt --target-org my-scratch --result-format csv
931
931
  ```
932
932
 
933
- _See code: [src/commands/data/search.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/search.ts)_
933
+ _See code: [src/commands/data/search.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/search.ts)_
934
934
 
935
935
  ## `sf data update bulk`
936
936
 
@@ -985,7 +985,7 @@ EXAMPLES
985
985
  $ sf data update bulk --file accounts.csv --sobject Account --wait 10 --target-org my-scratch
986
986
  ```
987
987
 
988
- _See code: [src/commands/data/update/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/update/bulk.ts)_
988
+ _See code: [src/commands/data/update/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/update/bulk.ts)_
989
989
 
990
990
  ## `sf data update record`
991
991
 
@@ -1047,7 +1047,7 @@ EXAMPLES
1047
1047
  "ExpirationDate=2017-12-01T00:58:04.000+0000"
1048
1048
  ```
1049
1049
 
1050
- _See code: [src/commands/data/update/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/update/record.ts)_
1050
+ _See code: [src/commands/data/update/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/update/record.ts)_
1051
1051
 
1052
1052
  ## `sf data update resume`
1053
1053
 
@@ -1086,7 +1086,7 @@ EXAMPLES
1086
1086
  $ sf data update resume --use-most-recent
1087
1087
  ```
1088
1088
 
1089
- _See code: [src/commands/data/update/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/update/resume.ts)_
1089
+ _See code: [src/commands/data/update/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/update/resume.ts)_
1090
1090
 
1091
1091
  ## `sf data upsert bulk`
1092
1092
 
@@ -1142,7 +1142,7 @@ EXAMPLES
1142
1142
  my-scratch
1143
1143
  ```
1144
1144
 
1145
- _See code: [src/commands/data/upsert/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/upsert/bulk.ts)_
1145
+ _See code: [src/commands/data/upsert/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/upsert/bulk.ts)_
1146
1146
 
1147
1147
  ## `sf data upsert resume`
1148
1148
 
@@ -1181,7 +1181,7 @@ EXAMPLES
1181
1181
  $ sf data upsert resume --use-most-recent --target-org my-scratch
1182
1182
  ```
1183
1183
 
1184
- _See code: [src/commands/data/upsert/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/data/upsert/resume.ts)_
1184
+ _See code: [src/commands/data/upsert/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/data/upsert/resume.ts)_
1185
1185
 
1186
1186
  ## `sf force data bulk delete`
1187
1187
 
@@ -1228,7 +1228,7 @@ EXAMPLES
1228
1228
  $ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
1229
1229
  ```
1230
1230
 
1231
- _See code: [src/commands/force/data/bulk/delete.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/force/data/bulk/delete.ts)_
1231
+ _See code: [src/commands/force/data/bulk/delete.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/force/data/bulk/delete.ts)_
1232
1232
 
1233
1233
  ## `sf force data bulk status`
1234
1234
 
@@ -1265,7 +1265,7 @@ EXAMPLES
1265
1265
  $ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
1266
1266
  ```
1267
1267
 
1268
- _See code: [src/commands/force/data/bulk/status.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/force/data/bulk/status.ts)_
1268
+ _See code: [src/commands/force/data/bulk/status.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/force/data/bulk/status.ts)_
1269
1269
 
1270
1270
  ## `sf force data bulk upsert`
1271
1271
 
@@ -1323,6 +1323,6 @@ EXAMPLES
1323
1323
  --target-org my-scratch
1324
1324
  ```
1325
1325
 
1326
- _See code: [src/commands/force/data/bulk/upsert.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.87/src/commands/force/data/bulk/upsert.ts)_
1326
+ _See code: [src/commands/force/data/bulk/upsert.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.88/src/commands/force/data/bulk/upsert.ts)_
1327
1327
 
1328
1328
  <!-- commandsstop -->
@@ -401,83 +401,6 @@
401
401
  "search:data"
402
402
  ]
403
403
  },
404
- "data:bulk:results": {
405
- "aliases": [],
406
- "args": {},
407
- "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.",
408
- "examples": [
409
- "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"
410
- ],
411
- "flags": {
412
- "json": {
413
- "description": "Format output as json.",
414
- "helpGroup": "GLOBAL",
415
- "name": "json",
416
- "allowNo": false,
417
- "type": "boolean"
418
- },
419
- "flags-dir": {
420
- "helpGroup": "GLOBAL",
421
- "name": "flags-dir",
422
- "summary": "Import flag values from a directory.",
423
- "hasDynamicHelp": false,
424
- "multiple": false,
425
- "type": "option"
426
- },
427
- "job-id": {
428
- "char": "i",
429
- "name": "job-id",
430
- "required": true,
431
- "summary": "Job ID of the bulk job.",
432
- "hasDynamicHelp": false,
433
- "multiple": false,
434
- "type": "option"
435
- },
436
- "target-org": {
437
- "char": "o",
438
- "name": "target-org",
439
- "noCacheDefault": true,
440
- "required": true,
441
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
442
- "hasDynamicHelp": true,
443
- "multiple": false,
444
- "type": "option"
445
- },
446
- "api-version": {
447
- "description": "Override the api version used for api requests made by this command",
448
- "name": "api-version",
449
- "hasDynamicHelp": false,
450
- "multiple": false,
451
- "type": "option"
452
- }
453
- },
454
- "hasDynamicHelp": true,
455
- "hiddenAliases": [],
456
- "id": "data:bulk:results",
457
- "pluginAlias": "@salesforce/plugin-data",
458
- "pluginName": "@salesforce/plugin-data",
459
- "pluginType": "core",
460
- "strict": true,
461
- "summary": "Get the results of a bulk ingest job that you previously ran.",
462
- "enableJsonFlag": true,
463
- "isESM": true,
464
- "relativePath": [
465
- "lib",
466
- "commands",
467
- "data",
468
- "bulk",
469
- "results.js"
470
- ],
471
- "aliasPermutations": [],
472
- "permutations": [
473
- "data:bulk:results",
474
- "bulk:data:results",
475
- "bulk:results:data",
476
- "data:results:bulk",
477
- "results:data:bulk",
478
- "results:bulk:data"
479
- ]
480
- },
481
404
  "data:create:file": {
482
405
  "aliases": [],
483
406
  "args": {},
@@ -735,13 +658,12 @@
735
658
  "record:create:data"
736
659
  ]
737
660
  },
738
- "data:export:bulk": {
661
+ "data:bulk:results": {
739
662
  "aliases": [],
740
663
  "args": {},
741
- "description": "You can use this command to export millions of records from an org, either to migrate data or to back it up.\n\nUse a SOQL query to specify the fields of a standard or custom object that you want to export. Specify the SOQL query either at the command line with the --query flag or read it from a file with the --query-file flag; you can't specify both flags. The --output-file flag is required, which means you can only write the records to a file, in either CSV or JSON format.\n\nBulk exports can take a while, depending on how many records are returned by the SOQL query. If the command times out, the command displays the job ID. To see the status and get the results of the job, run \"sf data export resume\" and pass the job ID to the --job-id flag.\n\nIMPORTANT: This command uses Bulk API 2.0, which limits the type of SOQL queries you can run. For example, you can't use aggregate functions such as count(). For the complete list of limitations, see the \"SOQL Considerations\" section in the \"Bulk API 2.0 and Bulk API Developer Guide\" (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm).",
664
+ "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.",
742
665
  "examples": [
743
- "Export the Id, Name, and Account.Name fields of the Contact object into a CSV-formatted file; if the export doesn't complete in 10 minutes, the command ends and displays a job ID. Use the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --query \"SELECT Id, Name, Account.Name FROM Contact\" --output-file export-accounts.csv --wait 10 --target-org my-scratch",
744
- "Similar to previous example, but use the default org, export the records into a JSON-formatted file, and include records that have been soft deleted:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id, Name, Account.Name FROM Contact\" --output-file export-accounts.json --result-format json --wait 10 --all-rows"
666
+ "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"
745
667
  ],
746
668
  "flags": {
747
669
  "json": {
@@ -759,6 +681,15 @@
759
681
  "multiple": false,
760
682
  "type": "option"
761
683
  },
684
+ "job-id": {
685
+ "char": "i",
686
+ "name": "job-id",
687
+ "required": true,
688
+ "summary": "Job ID of the bulk job.",
689
+ "hasDynamicHelp": false,
690
+ "multiple": false,
691
+ "type": "option"
692
+ },
762
693
  "target-org": {
763
694
  "char": "o",
764
695
  "name": "target-org",
@@ -775,146 +706,42 @@
775
706
  "hasDynamicHelp": false,
776
707
  "multiple": false,
777
708
  "type": "option"
778
- },
779
- "wait": {
780
- "char": "w",
781
- "name": "wait",
782
- "summary": "Time to wait for the command to finish, in minutes.",
783
- "hasDynamicHelp": true,
784
- "helpValue": "<minutes>",
785
- "multiple": false,
786
- "type": "option"
787
- },
788
- "query": {
789
- "char": "q",
790
- "exclusive": [
791
- "query-file"
792
- ],
793
- "name": "query",
794
- "summary": "SOQL query to execute.",
795
- "hasDynamicHelp": false,
796
- "multiple": false,
797
- "type": "option"
798
- },
799
- "query-file": {
800
- "exclusive": [
801
- "query"
802
- ],
803
- "name": "query-file",
804
- "summary": "File that contains the SOQL query.",
805
- "hasDynamicHelp": false,
806
- "multiple": false,
807
- "type": "option"
808
- },
809
- "all-rows": {
810
- "name": "all-rows",
811
- "summary": "Include records that have been soft-deleted due to a merge or delete. By default, deleted records are not returned.",
812
- "allowNo": false,
813
- "type": "boolean"
814
- },
815
- "output-file": {
816
- "name": "output-file",
817
- "required": true,
818
- "summary": "File where records are written.",
819
- "hasDynamicHelp": false,
820
- "multiple": false,
821
- "type": "option"
822
- },
823
- "result-format": {
824
- "char": "r",
825
- "name": "result-format",
826
- "required": true,
827
- "summary": "Format to write the results.",
828
- "default": "csv",
829
- "hasDynamicHelp": false,
830
- "multiple": false,
831
- "options": [
832
- "csv",
833
- "json"
834
- ],
835
- "type": "option"
836
- },
837
- "column-delimiter": {
838
- "name": "column-delimiter",
839
- "relationships": [
840
- {
841
- "type": "some",
842
- "flags": [
843
- {
844
- "name": "result-format"
845
- }
846
- ]
847
- }
848
- ],
849
- "summary": "Column delimiter to be used when writing CSV output. Default is COMMA.",
850
- "hasDynamicHelp": false,
851
- "multiple": false,
852
- "options": [
853
- "BACKQUOTE",
854
- "CARET",
855
- "COMMA",
856
- "PIPE",
857
- "SEMICOLON",
858
- "TAB"
859
- ],
860
- "type": "option"
861
- },
862
- "line-ending": {
863
- "name": "line-ending",
864
- "relationships": [
865
- {
866
- "type": "some",
867
- "flags": [
868
- {
869
- "name": "result-format"
870
- }
871
- ]
872
- }
873
- ],
874
- "summary": "Line ending to be used when writing CSV output. Default value on Windows is is `CRLF`; on macOS and Linux it's `LR`.",
875
- "hasDynamicHelp": false,
876
- "multiple": false,
877
- "options": [
878
- "LF",
879
- "CRLF"
880
- ],
881
- "type": "option"
882
709
  }
883
710
  },
884
711
  "hasDynamicHelp": true,
885
712
  "hiddenAliases": [],
886
- "id": "data:export:bulk",
713
+ "id": "data:bulk:results",
887
714
  "pluginAlias": "@salesforce/plugin-data",
888
715
  "pluginName": "@salesforce/plugin-data",
889
716
  "pluginType": "core",
890
717
  "strict": true,
891
- "summary": "Bulk export records from an org into a file using a SOQL query. Uses Bulk API 2.0.",
718
+ "summary": "Get the results of a bulk ingest job that you previously ran.",
892
719
  "enableJsonFlag": true,
893
720
  "isESM": true,
894
721
  "relativePath": [
895
722
  "lib",
896
723
  "commands",
897
724
  "data",
898
- "export",
899
- "bulk.js"
725
+ "bulk",
726
+ "results.js"
900
727
  ],
901
728
  "aliasPermutations": [],
902
729
  "permutations": [
903
- "data:export:bulk",
904
- "export:data:bulk",
905
- "export:bulk:data",
906
- "data:bulk:export",
907
- "bulk:data:export",
908
- "bulk:export:data"
730
+ "data:bulk:results",
731
+ "bulk:data:results",
732
+ "bulk:results:data",
733
+ "data:results:bulk",
734
+ "results:data:bulk",
735
+ "results:bulk:data"
909
736
  ]
910
737
  },
911
- "data:export:resume": {
738
+ "data:delete:bulk": {
912
739
  "aliases": [],
913
740
  "args": {},
914
- "description": "When the original \"data export bulk\" command times out, it displays a job ID. To see the status and get the results of the bulk export, run this command by either passing it the job ID or using the --use-most-recent flag to specify the most recent bulk export job.\n\nUsing either `--job-id` or `--use-most-recent` will properly resolve to the correct org where the bulk job was started based on the cached data by \"data export bulk\".",
741
+ "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, displays the ID, 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 ID to check the status of the job with the \"<%= config.bin %> data delete resume\" command.",
915
742
  "examples": [
916
- "Resume a bulk export job run by specifying a job ID:\nsf <%= command.id %> --job-id 750xx000000005sAAA",
917
- "Resume the most recently-run bulk export job:\nsf data export resume --use-most-recent"
743
+ "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",
744
+ "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"
918
745
  ],
919
746
  "flags": {
920
747
  "json": {
@@ -932,252 +759,26 @@
932
759
  "multiple": false,
933
760
  "type": "option"
934
761
  },
935
- "job-id": {
936
- "char": "i",
937
- "name": "job-id",
938
- "summary": "Job ID of the bulk export.",
939
- "hasDynamicHelp": false,
762
+ "target-org": {
763
+ "aliases": [
764
+ "targetusername",
765
+ "u"
766
+ ],
767
+ "char": "o",
768
+ "deprecateAliases": true,
769
+ "name": "target-org",
770
+ "noCacheDefault": true,
771
+ "required": true,
772
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
773
+ "hasDynamicHelp": true,
940
774
  "multiple": false,
941
775
  "type": "option"
942
776
  },
943
- "use-most-recent": {
944
- "name": "use-most-recent",
945
- "summary": "Use the job ID of the bulk export job that was most recently run.",
946
- "allowNo": false,
947
- "type": "boolean"
948
- },
949
777
  "api-version": {
950
- "description": "Override the api version used for api requests made by this command",
951
- "name": "api-version",
952
- "hasDynamicHelp": false,
953
- "multiple": false,
954
- "type": "option"
955
- }
956
- },
957
- "hasDynamicHelp": false,
958
- "hiddenAliases": [],
959
- "id": "data:export:resume",
960
- "pluginAlias": "@salesforce/plugin-data",
961
- "pluginName": "@salesforce/plugin-data",
962
- "pluginType": "core",
963
- "strict": true,
964
- "summary": "Resume a bulk export job that you previously started. Uses Bulk API 2.0.",
965
- "enableJsonFlag": true,
966
- "isESM": true,
967
- "relativePath": [
968
- "lib",
969
- "commands",
970
- "data",
971
- "export",
972
- "resume.js"
973
- ],
974
- "aliasPermutations": [],
975
- "permutations": [
976
- "data:export:resume",
977
- "export:data:resume",
978
- "export:resume:data",
979
- "data:resume:export",
980
- "resume:data:export",
981
- "resume:export:data"
982
- ]
983
- },
984
- "data:export:tree": {
985
- "aliases": [
986
- "force:data:tree:export"
987
- ],
988
- "args": {},
989
- "deprecateAliases": true,
990
- "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).",
991
- "examples": [
992
- "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\"",
993
- "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",
994
- "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"
995
- ],
996
- "flags": {
997
- "json": {
998
- "description": "Format output as json.",
999
- "helpGroup": "GLOBAL",
1000
- "name": "json",
1001
- "allowNo": false,
1002
- "type": "boolean"
1003
- },
1004
- "flags-dir": {
1005
- "helpGroup": "GLOBAL",
1006
- "name": "flags-dir",
1007
- "summary": "Import flag values from a directory.",
1008
- "hasDynamicHelp": false,
1009
- "multiple": false,
1010
- "type": "option"
1011
- },
1012
- "target-org": {
1013
- "aliases": [
1014
- "targetusername",
1015
- "u"
1016
- ],
1017
- "char": "o",
1018
- "deprecateAliases": true,
1019
- "name": "target-org",
1020
- "noCacheDefault": true,
1021
- "required": true,
1022
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1023
- "hasDynamicHelp": true,
1024
- "multiple": false,
1025
- "type": "option"
1026
- },
1027
- "api-version": {
1028
- "aliases": [
1029
- "apiversion"
1030
- ],
1031
- "deprecateAliases": true,
1032
- "description": "Override the api version used for api requests made by this command",
1033
- "name": "api-version",
1034
- "hasDynamicHelp": false,
1035
- "multiple": false,
1036
- "type": "option"
1037
- },
1038
- "loglevel": {
1039
- "deprecated": {
1040
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
1041
- },
1042
- "hidden": true,
1043
- "name": "loglevel",
1044
- "hasDynamicHelp": false,
1045
- "multiple": false,
1046
- "type": "option"
1047
- },
1048
- "query": {
1049
- "char": "q",
1050
- "name": "query",
1051
- "required": true,
1052
- "summary": "SOQL query, or filepath of a file that contains the query, to retrieve records.",
1053
- "hasDynamicHelp": false,
1054
- "multiple": true,
1055
- "type": "option"
1056
- },
1057
- "plan": {
1058
- "char": "p",
1059
- "name": "plan",
1060
- "summary": "Generate multiple sObject tree files and a plan definition file for aggregated import.",
1061
- "allowNo": false,
1062
- "type": "boolean"
1063
- },
1064
- "prefix": {
1065
- "char": "x",
1066
- "name": "prefix",
1067
- "summary": "Prefix of generated files.",
1068
- "hasDynamicHelp": false,
1069
- "multiple": false,
1070
- "type": "option"
1071
- },
1072
- "output-dir": {
1073
- "aliases": [
1074
- "outputdir"
1075
- ],
1076
- "char": "d",
1077
- "deprecateAliases": true,
1078
- "name": "output-dir",
1079
- "summary": "Directory in which to generate the JSON files; default is current directory.",
1080
- "hasDynamicHelp": false,
1081
- "multiple": false,
1082
- "type": "option"
1083
- }
1084
- },
1085
- "hasDynamicHelp": true,
1086
- "hiddenAliases": [],
1087
- "id": "data:export:tree",
1088
- "pluginAlias": "@salesforce/plugin-data",
1089
- "pluginName": "@salesforce/plugin-data",
1090
- "pluginType": "core",
1091
- "strict": true,
1092
- "summary": "Export data from an org into one or more JSON files.",
1093
- "enableJsonFlag": true,
1094
- "isESM": true,
1095
- "relativePath": [
1096
- "lib",
1097
- "commands",
1098
- "data",
1099
- "export",
1100
- "tree.js"
1101
- ],
1102
- "aliasPermutations": [
1103
- "force:data:tree:export",
1104
- "data:force:tree:export",
1105
- "data:tree:force:export",
1106
- "data:tree:export:force",
1107
- "force:tree:data:export",
1108
- "tree:force:data:export",
1109
- "tree:data:force:export",
1110
- "tree:data:export:force",
1111
- "force:tree:export:data",
1112
- "tree:force:export:data",
1113
- "tree:export:force:data",
1114
- "tree:export:data:force",
1115
- "force:data:export:tree",
1116
- "data:force:export:tree",
1117
- "data:export:force:tree",
1118
- "data:export:tree:force",
1119
- "force:export:data:tree",
1120
- "export:force:data:tree",
1121
- "export:data:force:tree",
1122
- "export:data:tree:force",
1123
- "force:export:tree:data",
1124
- "export:force:tree:data",
1125
- "export:tree:force:data",
1126
- "export:tree:data:force"
1127
- ],
1128
- "permutations": [
1129
- "data:export:tree",
1130
- "export:data:tree",
1131
- "export:tree:data",
1132
- "data:tree:export",
1133
- "tree:data:export",
1134
- "tree:export:data"
1135
- ]
1136
- },
1137
- "data:delete:bulk": {
1138
- "aliases": [],
1139
- "args": {},
1140
- "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, displays the ID, 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 ID to check the status of the job with the \"<%= config.bin %> data delete resume\" command.",
1141
- "examples": [
1142
- "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",
1143
- "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"
1144
- ],
1145
- "flags": {
1146
- "json": {
1147
- "description": "Format output as json.",
1148
- "helpGroup": "GLOBAL",
1149
- "name": "json",
1150
- "allowNo": false,
1151
- "type": "boolean"
1152
- },
1153
- "flags-dir": {
1154
- "helpGroup": "GLOBAL",
1155
- "name": "flags-dir",
1156
- "summary": "Import flag values from a directory.",
1157
- "hasDynamicHelp": false,
1158
- "multiple": false,
1159
- "type": "option"
1160
- },
1161
- "target-org": {
1162
- "aliases": [
1163
- "targetusername",
1164
- "u"
1165
- ],
1166
- "char": "o",
1167
- "deprecateAliases": true,
1168
- "name": "target-org",
1169
- "noCacheDefault": true,
1170
- "required": true,
1171
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1172
- "hasDynamicHelp": true,
1173
- "multiple": false,
1174
- "type": "option"
1175
- },
1176
- "api-version": {
1177
- "aliases": [
1178
- "apiversion"
1179
- ],
1180
- "deprecateAliases": true,
778
+ "aliases": [
779
+ "apiversion"
780
+ ],
781
+ "deprecateAliases": true,
1181
782
  "description": "Override the api version used for api requests made by this command",
1182
783
  "name": "api-version",
1183
784
  "hasDynamicHelp": false,
@@ -1564,6 +1165,405 @@
1564
1165
  "resume:delete:data"
1565
1166
  ]
1566
1167
  },
1168
+ "data:export:bulk": {
1169
+ "aliases": [],
1170
+ "args": {},
1171
+ "description": "You can use this command to export millions of records from an org, either to migrate data or to back it up.\n\nUse a SOQL query to specify the fields of a standard or custom object that you want to export. Specify the SOQL query either at the command line with the --query flag or read it from a file with the --query-file flag; you can't specify both flags. The --output-file flag is required, which means you can only write the records to a file, in either CSV or JSON format.\n\nBulk exports can take a while, depending on how many records are returned by the SOQL query. If the command times out, the command displays the job ID. To see the status and get the results of the job, run \"sf data export resume\" and pass the job ID to the --job-id flag.\n\nIMPORTANT: This command uses Bulk API 2.0, which limits the type of SOQL queries you can run. For example, you can't use aggregate functions such as count(). For the complete list of limitations, see the \"SOQL Considerations\" section in the \"Bulk API 2.0 and Bulk API Developer Guide\" (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm).",
1172
+ "examples": [
1173
+ "Export the Id, Name, and Account.Name fields of the Contact object into a CSV-formatted file; if the export doesn't complete in 10 minutes, the command ends and displays a job ID. Use the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --query \"SELECT Id, Name, Account.Name FROM Contact\" --output-file export-accounts.csv --wait 10 --target-org my-scratch",
1174
+ "Similar to previous example, but use the default org, export the records into a JSON-formatted file, and include records that have been soft deleted:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id, Name, Account.Name FROM Contact\" --output-file export-accounts.json --result-format json --wait 10 --all-rows"
1175
+ ],
1176
+ "flags": {
1177
+ "json": {
1178
+ "description": "Format output as json.",
1179
+ "helpGroup": "GLOBAL",
1180
+ "name": "json",
1181
+ "allowNo": false,
1182
+ "type": "boolean"
1183
+ },
1184
+ "flags-dir": {
1185
+ "helpGroup": "GLOBAL",
1186
+ "name": "flags-dir",
1187
+ "summary": "Import flag values from a directory.",
1188
+ "hasDynamicHelp": false,
1189
+ "multiple": false,
1190
+ "type": "option"
1191
+ },
1192
+ "target-org": {
1193
+ "char": "o",
1194
+ "name": "target-org",
1195
+ "noCacheDefault": true,
1196
+ "required": true,
1197
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1198
+ "hasDynamicHelp": true,
1199
+ "multiple": false,
1200
+ "type": "option"
1201
+ },
1202
+ "api-version": {
1203
+ "description": "Override the api version used for api requests made by this command",
1204
+ "name": "api-version",
1205
+ "hasDynamicHelp": false,
1206
+ "multiple": false,
1207
+ "type": "option"
1208
+ },
1209
+ "wait": {
1210
+ "char": "w",
1211
+ "name": "wait",
1212
+ "summary": "Time to wait for the command to finish, in minutes.",
1213
+ "hasDynamicHelp": true,
1214
+ "helpValue": "<minutes>",
1215
+ "multiple": false,
1216
+ "type": "option"
1217
+ },
1218
+ "query": {
1219
+ "char": "q",
1220
+ "exclusive": [
1221
+ "query-file"
1222
+ ],
1223
+ "name": "query",
1224
+ "summary": "SOQL query to execute.",
1225
+ "hasDynamicHelp": false,
1226
+ "multiple": false,
1227
+ "type": "option"
1228
+ },
1229
+ "query-file": {
1230
+ "exclusive": [
1231
+ "query"
1232
+ ],
1233
+ "name": "query-file",
1234
+ "summary": "File that contains the SOQL query.",
1235
+ "hasDynamicHelp": false,
1236
+ "multiple": false,
1237
+ "type": "option"
1238
+ },
1239
+ "all-rows": {
1240
+ "name": "all-rows",
1241
+ "summary": "Include records that have been soft-deleted due to a merge or delete. By default, deleted records are not returned.",
1242
+ "allowNo": false,
1243
+ "type": "boolean"
1244
+ },
1245
+ "output-file": {
1246
+ "name": "output-file",
1247
+ "required": true,
1248
+ "summary": "File where records are written.",
1249
+ "hasDynamicHelp": false,
1250
+ "multiple": false,
1251
+ "type": "option"
1252
+ },
1253
+ "result-format": {
1254
+ "char": "r",
1255
+ "name": "result-format",
1256
+ "required": true,
1257
+ "summary": "Format to write the results.",
1258
+ "default": "csv",
1259
+ "hasDynamicHelp": false,
1260
+ "multiple": false,
1261
+ "options": [
1262
+ "csv",
1263
+ "json"
1264
+ ],
1265
+ "type": "option"
1266
+ },
1267
+ "column-delimiter": {
1268
+ "name": "column-delimiter",
1269
+ "relationships": [
1270
+ {
1271
+ "type": "some",
1272
+ "flags": [
1273
+ {
1274
+ "name": "result-format"
1275
+ }
1276
+ ]
1277
+ }
1278
+ ],
1279
+ "summary": "Column delimiter to be used when writing CSV output. Default is COMMA.",
1280
+ "hasDynamicHelp": false,
1281
+ "multiple": false,
1282
+ "options": [
1283
+ "BACKQUOTE",
1284
+ "CARET",
1285
+ "COMMA",
1286
+ "PIPE",
1287
+ "SEMICOLON",
1288
+ "TAB"
1289
+ ],
1290
+ "type": "option"
1291
+ },
1292
+ "line-ending": {
1293
+ "name": "line-ending",
1294
+ "relationships": [
1295
+ {
1296
+ "type": "some",
1297
+ "flags": [
1298
+ {
1299
+ "name": "result-format"
1300
+ }
1301
+ ]
1302
+ }
1303
+ ],
1304
+ "summary": "Line ending to be used when writing CSV output. Default value on Windows is is `CRLF`; on macOS and Linux it's `LR`.",
1305
+ "hasDynamicHelp": false,
1306
+ "multiple": false,
1307
+ "options": [
1308
+ "LF",
1309
+ "CRLF"
1310
+ ],
1311
+ "type": "option"
1312
+ }
1313
+ },
1314
+ "hasDynamicHelp": true,
1315
+ "hiddenAliases": [],
1316
+ "id": "data:export:bulk",
1317
+ "pluginAlias": "@salesforce/plugin-data",
1318
+ "pluginName": "@salesforce/plugin-data",
1319
+ "pluginType": "core",
1320
+ "strict": true,
1321
+ "summary": "Bulk export records from an org into a file using a SOQL query. Uses Bulk API 2.0.",
1322
+ "enableJsonFlag": true,
1323
+ "isESM": true,
1324
+ "relativePath": [
1325
+ "lib",
1326
+ "commands",
1327
+ "data",
1328
+ "export",
1329
+ "bulk.js"
1330
+ ],
1331
+ "aliasPermutations": [],
1332
+ "permutations": [
1333
+ "data:export:bulk",
1334
+ "export:data:bulk",
1335
+ "export:bulk:data",
1336
+ "data:bulk:export",
1337
+ "bulk:data:export",
1338
+ "bulk:export:data"
1339
+ ]
1340
+ },
1341
+ "data:export:resume": {
1342
+ "aliases": [],
1343
+ "args": {},
1344
+ "description": "When the original \"data export bulk\" command times out, it displays a job ID. To see the status and get the results of the bulk export, run this command by either passing it the job ID or using the --use-most-recent flag to specify the most recent bulk export job.\n\nUsing either `--job-id` or `--use-most-recent` will properly resolve to the correct org where the bulk job was started based on the cached data by \"data export bulk\".",
1345
+ "examples": [
1346
+ "Resume a bulk export job run by specifying a job ID:\nsf <%= command.id %> --job-id 750xx000000005sAAA",
1347
+ "Resume the most recently-run bulk export job:\nsf data export resume --use-most-recent"
1348
+ ],
1349
+ "flags": {
1350
+ "json": {
1351
+ "description": "Format output as json.",
1352
+ "helpGroup": "GLOBAL",
1353
+ "name": "json",
1354
+ "allowNo": false,
1355
+ "type": "boolean"
1356
+ },
1357
+ "flags-dir": {
1358
+ "helpGroup": "GLOBAL",
1359
+ "name": "flags-dir",
1360
+ "summary": "Import flag values from a directory.",
1361
+ "hasDynamicHelp": false,
1362
+ "multiple": false,
1363
+ "type": "option"
1364
+ },
1365
+ "job-id": {
1366
+ "char": "i",
1367
+ "name": "job-id",
1368
+ "summary": "Job ID of the bulk export.",
1369
+ "hasDynamicHelp": false,
1370
+ "multiple": false,
1371
+ "type": "option"
1372
+ },
1373
+ "use-most-recent": {
1374
+ "name": "use-most-recent",
1375
+ "summary": "Use the job ID of the bulk export job that was most recently run.",
1376
+ "allowNo": false,
1377
+ "type": "boolean"
1378
+ },
1379
+ "api-version": {
1380
+ "description": "Override the api version used for api requests made by this command",
1381
+ "name": "api-version",
1382
+ "hasDynamicHelp": false,
1383
+ "multiple": false,
1384
+ "type": "option"
1385
+ }
1386
+ },
1387
+ "hasDynamicHelp": false,
1388
+ "hiddenAliases": [],
1389
+ "id": "data:export:resume",
1390
+ "pluginAlias": "@salesforce/plugin-data",
1391
+ "pluginName": "@salesforce/plugin-data",
1392
+ "pluginType": "core",
1393
+ "strict": true,
1394
+ "summary": "Resume a bulk export job that you previously started. Uses Bulk API 2.0.",
1395
+ "enableJsonFlag": true,
1396
+ "isESM": true,
1397
+ "relativePath": [
1398
+ "lib",
1399
+ "commands",
1400
+ "data",
1401
+ "export",
1402
+ "resume.js"
1403
+ ],
1404
+ "aliasPermutations": [],
1405
+ "permutations": [
1406
+ "data:export:resume",
1407
+ "export:data:resume",
1408
+ "export:resume:data",
1409
+ "data:resume:export",
1410
+ "resume:data:export",
1411
+ "resume:export:data"
1412
+ ]
1413
+ },
1414
+ "data:export:tree": {
1415
+ "aliases": [
1416
+ "force:data:tree:export"
1417
+ ],
1418
+ "args": {},
1419
+ "deprecateAliases": true,
1420
+ "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).",
1421
+ "examples": [
1422
+ "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\"",
1423
+ "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",
1424
+ "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"
1425
+ ],
1426
+ "flags": {
1427
+ "json": {
1428
+ "description": "Format output as json.",
1429
+ "helpGroup": "GLOBAL",
1430
+ "name": "json",
1431
+ "allowNo": false,
1432
+ "type": "boolean"
1433
+ },
1434
+ "flags-dir": {
1435
+ "helpGroup": "GLOBAL",
1436
+ "name": "flags-dir",
1437
+ "summary": "Import flag values from a directory.",
1438
+ "hasDynamicHelp": false,
1439
+ "multiple": false,
1440
+ "type": "option"
1441
+ },
1442
+ "target-org": {
1443
+ "aliases": [
1444
+ "targetusername",
1445
+ "u"
1446
+ ],
1447
+ "char": "o",
1448
+ "deprecateAliases": true,
1449
+ "name": "target-org",
1450
+ "noCacheDefault": true,
1451
+ "required": true,
1452
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1453
+ "hasDynamicHelp": true,
1454
+ "multiple": false,
1455
+ "type": "option"
1456
+ },
1457
+ "api-version": {
1458
+ "aliases": [
1459
+ "apiversion"
1460
+ ],
1461
+ "deprecateAliases": true,
1462
+ "description": "Override the api version used for api requests made by this command",
1463
+ "name": "api-version",
1464
+ "hasDynamicHelp": false,
1465
+ "multiple": false,
1466
+ "type": "option"
1467
+ },
1468
+ "loglevel": {
1469
+ "deprecated": {
1470
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
1471
+ },
1472
+ "hidden": true,
1473
+ "name": "loglevel",
1474
+ "hasDynamicHelp": false,
1475
+ "multiple": false,
1476
+ "type": "option"
1477
+ },
1478
+ "query": {
1479
+ "char": "q",
1480
+ "name": "query",
1481
+ "required": true,
1482
+ "summary": "SOQL query, or filepath of a file that contains the query, to retrieve records.",
1483
+ "hasDynamicHelp": false,
1484
+ "multiple": true,
1485
+ "type": "option"
1486
+ },
1487
+ "plan": {
1488
+ "char": "p",
1489
+ "name": "plan",
1490
+ "summary": "Generate multiple sObject tree files and a plan definition file for aggregated import.",
1491
+ "allowNo": false,
1492
+ "type": "boolean"
1493
+ },
1494
+ "prefix": {
1495
+ "char": "x",
1496
+ "name": "prefix",
1497
+ "summary": "Prefix of generated files.",
1498
+ "hasDynamicHelp": false,
1499
+ "multiple": false,
1500
+ "type": "option"
1501
+ },
1502
+ "output-dir": {
1503
+ "aliases": [
1504
+ "outputdir"
1505
+ ],
1506
+ "char": "d",
1507
+ "deprecateAliases": true,
1508
+ "name": "output-dir",
1509
+ "summary": "Directory in which to generate the JSON files; default is current directory.",
1510
+ "hasDynamicHelp": false,
1511
+ "multiple": false,
1512
+ "type": "option"
1513
+ }
1514
+ },
1515
+ "hasDynamicHelp": true,
1516
+ "hiddenAliases": [],
1517
+ "id": "data:export:tree",
1518
+ "pluginAlias": "@salesforce/plugin-data",
1519
+ "pluginName": "@salesforce/plugin-data",
1520
+ "pluginType": "core",
1521
+ "strict": true,
1522
+ "summary": "Export data from an org into one or more JSON files.",
1523
+ "enableJsonFlag": true,
1524
+ "isESM": true,
1525
+ "relativePath": [
1526
+ "lib",
1527
+ "commands",
1528
+ "data",
1529
+ "export",
1530
+ "tree.js"
1531
+ ],
1532
+ "aliasPermutations": [
1533
+ "force:data:tree:export",
1534
+ "data:force:tree:export",
1535
+ "data:tree:force:export",
1536
+ "data:tree:export:force",
1537
+ "force:tree:data:export",
1538
+ "tree:force:data:export",
1539
+ "tree:data:force:export",
1540
+ "tree:data:export:force",
1541
+ "force:tree:export:data",
1542
+ "tree:force:export:data",
1543
+ "tree:export:force:data",
1544
+ "tree:export:data:force",
1545
+ "force:data:export:tree",
1546
+ "data:force:export:tree",
1547
+ "data:export:force:tree",
1548
+ "data:export:tree:force",
1549
+ "force:export:data:tree",
1550
+ "export:force:data:tree",
1551
+ "export:data:force:tree",
1552
+ "export:data:tree:force",
1553
+ "force:export:tree:data",
1554
+ "export:force:tree:data",
1555
+ "export:tree:force:data",
1556
+ "export:tree:data:force"
1557
+ ],
1558
+ "permutations": [
1559
+ "data:export:tree",
1560
+ "export:data:tree",
1561
+ "export:tree:data",
1562
+ "data:tree:export",
1563
+ "tree:data:export",
1564
+ "tree:export:data"
1565
+ ]
1566
+ },
1567
1567
  "data:get:record": {
1568
1568
  "aliases": [
1569
1569
  "force:data:record:get"
@@ -3166,5 +3166,5 @@
3166
3166
  ]
3167
3167
  }
3168
3168
  },
3169
- "version": "4.0.87"
3169
+ "version": "4.0.88"
3170
3170
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-data",
3
- "version": "4.0.87",
3
+ "version": "4.0.88",
4
4
  "description": "Plugin for salesforce data commands",
5
5
  "author": "Salesforce",
6
6
  "homepage": "https://github.com/salesforcecli/plugin-data",
@@ -124,7 +124,7 @@
124
124
  "o11yUploadEndpoint": "https://794testsite.my.site.com/byolwr/webruntime/log/metrics",
125
125
  "dependencies": {
126
126
  "@jsforce/jsforce-node": "^3.10.14",
127
- "@oclif/multi-stage-output": "^0.8.30",
127
+ "@oclif/multi-stage-output": "^0.8.34",
128
128
  "@salesforce/core": "^8.28.1",
129
129
  "@salesforce/kit": "^3.2.6",
130
130
  "@salesforce/sf-plugins-core": "^12.2.6",
@@ -139,7 +139,7 @@
139
139
  "zod": "^4.3.6"
140
140
  },
141
141
  "devDependencies": {
142
- "@oclif/core": "^4.10.3",
142
+ "@oclif/core": "^4.10.5",
143
143
  "@oclif/plugin-command-snapshot": "^5.3.12",
144
144
  "@oclif/test": "^4.1.17",
145
145
  "@salesforce/cli-plugins-testkit": "^5.3.50",
@@ -147,7 +147,7 @@
147
147
  "@salesforce/plugin-command-reference": "^3.1.86",
148
148
  "@salesforce/types": "^1.6.0",
149
149
  "eslint-plugin-sf-plugin": "^1.20.33",
150
- "oclif": "^4.22.95",
150
+ "oclif": "^4.22.96",
151
151
  "ts-node": "^10.9.2",
152
152
  "typescript": "^5.8.3"
153
153
  },
@@ -274,7 +274,7 @@
274
274
  "exports": "./lib/index.js",
275
275
  "type": "module",
276
276
  "sfdx": {
277
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/4.0.87.crt",
278
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/4.0.87.sig"
277
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/4.0.88.crt",
278
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/4.0.88.sig"
279
279
  }
280
280
  }