@salesforce/plugin-data 3.8.0 → 3.8.1
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/lib/commands/data/export/tree.js +2 -1
- package/lib/commands/data/export/tree.js.map +1 -1
- package/lib/export.js +72 -38
- package/lib/export.js.map +1 -1
- package/messages/exportApi.md +4 -0
- package/oclif.manifest.json +309 -309
- package/package.json +4 -4
package/oclif.manifest.json
CHANGED
|
@@ -424,13 +424,14 @@
|
|
|
424
424
|
"search:data"
|
|
425
425
|
]
|
|
426
426
|
},
|
|
427
|
-
"data:
|
|
427
|
+
"data:create:file": {
|
|
428
428
|
"aliases": [],
|
|
429
429
|
"args": {},
|
|
430
|
-
"description": "
|
|
430
|
+
"description": "This command always creates a new file in the org; you can't update an existing file. After a successful upload, the command displays the ID of the new ContentDocument record which represents the uploaded file.\n\nBy default, the uploaded file isn't attached to a record; in the Salesforce UI the file shows up in the Files tab. You can optionally attach the file to an existing record, such as an account, as long as you know its record ID.\n\nYou can also give the file a new name after it's been uploaded; by default its name in the org is the same as the local file name.",
|
|
431
431
|
"examples": [
|
|
432
|
-
"
|
|
433
|
-
"
|
|
432
|
+
"Upload the local file \"resources/astro.png\" to your default org:\n<%= config.bin %> <%= command.id %> --file resources/astro.png",
|
|
433
|
+
"Give the file a different filename after it's uploaded to the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --file resources/astro.png --title AstroOnABoat.png --target-org my-scratch",
|
|
434
|
+
"Attach the file to a record in the org:\n<%= config.bin %> <%= command.id %> --file path/to/astro.png --parent-id a03fakeLoJWPIA3"
|
|
434
435
|
],
|
|
435
436
|
"flags": {
|
|
436
437
|
"json": {
|
|
@@ -449,12 +450,7 @@
|
|
|
449
450
|
"type": "option"
|
|
450
451
|
},
|
|
451
452
|
"target-org": {
|
|
452
|
-
"aliases": [
|
|
453
|
-
"targetusername",
|
|
454
|
-
"u"
|
|
455
|
-
],
|
|
456
453
|
"char": "o",
|
|
457
|
-
"deprecateAliases": true,
|
|
458
454
|
"name": "target-org",
|
|
459
455
|
"noCacheDefault": true,
|
|
460
456
|
"required": true,
|
|
@@ -464,127 +460,77 @@
|
|
|
464
460
|
"type": "option"
|
|
465
461
|
},
|
|
466
462
|
"api-version": {
|
|
467
|
-
"aliases": [
|
|
468
|
-
"apiversion"
|
|
469
|
-
],
|
|
470
|
-
"deprecateAliases": true,
|
|
471
463
|
"description": "Override the api version used for api requests made by this command",
|
|
472
464
|
"name": "api-version",
|
|
473
465
|
"hasDynamicHelp": false,
|
|
474
466
|
"multiple": false,
|
|
475
467
|
"type": "option"
|
|
476
468
|
},
|
|
477
|
-
"
|
|
478
|
-
"
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
"
|
|
482
|
-
"name": "loglevel",
|
|
469
|
+
"title": {
|
|
470
|
+
"char": "t",
|
|
471
|
+
"name": "title",
|
|
472
|
+
"required": false,
|
|
473
|
+
"summary": "New title given to the file (ContentDocument) after it's uploaded.",
|
|
483
474
|
"hasDynamicHelp": false,
|
|
484
475
|
"multiple": false,
|
|
485
476
|
"type": "option"
|
|
486
477
|
},
|
|
487
478
|
"file": {
|
|
488
|
-
"aliases": [
|
|
489
|
-
"csvfile"
|
|
490
|
-
],
|
|
491
479
|
"char": "f",
|
|
492
|
-
"deprecateAliases": true,
|
|
493
480
|
"name": "file",
|
|
494
481
|
"required": true,
|
|
495
|
-
"summary": "
|
|
482
|
+
"summary": "Path of file to upload.",
|
|
496
483
|
"hasDynamicHelp": false,
|
|
497
484
|
"multiple": false,
|
|
498
485
|
"type": "option"
|
|
499
486
|
},
|
|
500
|
-
"
|
|
501
|
-
"
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
"char": "s",
|
|
505
|
-
"deprecateAliases": true,
|
|
506
|
-
"name": "sobject",
|
|
507
|
-
"required": true,
|
|
508
|
-
"summary": "API name of the Salesforce object, either standard or custom, that you want to update or delete records from.",
|
|
487
|
+
"parent-id": {
|
|
488
|
+
"char": "i",
|
|
489
|
+
"name": "parent-id",
|
|
490
|
+
"summary": "ID of the record to attach the file to.",
|
|
509
491
|
"hasDynamicHelp": false,
|
|
510
492
|
"multiple": false,
|
|
511
493
|
"type": "option"
|
|
512
|
-
},
|
|
513
|
-
"wait": {
|
|
514
|
-
"char": "w",
|
|
515
|
-
"exclusive": [
|
|
516
|
-
"async"
|
|
517
|
-
],
|
|
518
|
-
"name": "wait",
|
|
519
|
-
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
520
|
-
"default": "0 minutes",
|
|
521
|
-
"hasDynamicHelp": true,
|
|
522
|
-
"multiple": false,
|
|
523
|
-
"type": "option"
|
|
524
|
-
},
|
|
525
|
-
"async": {
|
|
526
|
-
"char": "a",
|
|
527
|
-
"exclusive": [
|
|
528
|
-
"wait"
|
|
529
|
-
],
|
|
530
|
-
"name": "async",
|
|
531
|
-
"summary": "Run the command asynchronously.",
|
|
532
|
-
"allowNo": false,
|
|
533
|
-
"type": "boolean"
|
|
534
|
-
},
|
|
535
|
-
"verbose": {
|
|
536
|
-
"name": "verbose",
|
|
537
|
-
"summary": "Print verbose output of failed records if result is available.",
|
|
538
|
-
"allowNo": false,
|
|
539
|
-
"type": "boolean"
|
|
540
|
-
},
|
|
541
|
-
"hard-delete": {
|
|
542
|
-
"description": "You must have the \"Bulk API Hard Delete\" system permission to use this flag. The permission is disabled by default and can be enabled only by a system administrator.",
|
|
543
|
-
"name": "hard-delete",
|
|
544
|
-
"summary": "Mark the records as immediately eligible for deletion by your org. If you don't specify this flag, the deleted records go into the Recycle Bin.",
|
|
545
|
-
"allowNo": false,
|
|
546
|
-
"type": "boolean"
|
|
547
494
|
}
|
|
548
495
|
},
|
|
549
496
|
"hasDynamicHelp": true,
|
|
550
497
|
"hiddenAliases": [],
|
|
551
|
-
"id": "data:
|
|
498
|
+
"id": "data:create:file",
|
|
552
499
|
"pluginAlias": "@salesforce/plugin-data",
|
|
553
500
|
"pluginName": "@salesforce/plugin-data",
|
|
554
501
|
"pluginType": "core",
|
|
555
502
|
"strict": true,
|
|
556
|
-
"summary": "
|
|
503
|
+
"summary": "Upload a local file to an org.",
|
|
557
504
|
"enableJsonFlag": true,
|
|
558
505
|
"isESM": true,
|
|
559
506
|
"relativePath": [
|
|
560
507
|
"lib",
|
|
561
508
|
"commands",
|
|
562
509
|
"data",
|
|
563
|
-
"
|
|
564
|
-
"
|
|
510
|
+
"create",
|
|
511
|
+
"file.js"
|
|
565
512
|
],
|
|
566
513
|
"aliasPermutations": [],
|
|
567
514
|
"permutations": [
|
|
568
|
-
"data:
|
|
569
|
-
"
|
|
570
|
-
"
|
|
571
|
-
"data:
|
|
572
|
-
"
|
|
573
|
-
"
|
|
515
|
+
"data:create:file",
|
|
516
|
+
"create:data:file",
|
|
517
|
+
"create:file:data",
|
|
518
|
+
"data:file:create",
|
|
519
|
+
"file:data:create",
|
|
520
|
+
"file:create:data"
|
|
574
521
|
]
|
|
575
522
|
},
|
|
576
|
-
"data:
|
|
523
|
+
"data:create:record": {
|
|
577
524
|
"aliases": [
|
|
578
|
-
"force:data:record:
|
|
525
|
+
"force:data:record:create"
|
|
579
526
|
],
|
|
580
527
|
"args": {},
|
|
581
528
|
"deprecateAliases": true,
|
|
582
|
-
"description": "
|
|
529
|
+
"description": "You must specify a value for all required fields of the object.\n\nWhen specifying fields, use the format <fieldName>=<value>. Enclose all field-value pairs in one set of double quotation marks, delimited by spaces. Enclose values that contain spaces in single quotes.\n\nThis command inserts a record into Salesforce objects by default. Use the --use-tooling-api flag to insert into a Tooling API object.",
|
|
583
530
|
"examples": [
|
|
584
|
-
"
|
|
585
|
-
"
|
|
586
|
-
"
|
|
587
|
-
"Delete a record from the Tooling API object TraceFlag with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --use-tooling-api --sobject TraceFlag --record-id 7tf8c"
|
|
531
|
+
"Insert a record into the Account object of your default org; only the required Name field has a value:\n<%= config.bin %> <%= command.id %> --sobject Account --values \"Name=Acme\"",
|
|
532
|
+
"Insert an Account record with values for two fields, one value contains a space; the command uses the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --sobject Account --values \"Name='Universal Containers' Website=www.example.com\" --target-org my-scratch",
|
|
533
|
+
"Insert a record into the Tooling API object TraceFlag:\n<%= config.bin %> <%= command.id %> --use-tooling-api --sobject TraceFlag --values \"DebugLevelId=7dl170000008U36AAE StartDate=2022-12-15T00:26:04.000+0000 ExpirationDate=2022-12-15T00:56:04.000+0000 LogType=CLASS_TRACING TracedEntityId=01p17000000R6bLAAS\""
|
|
588
534
|
],
|
|
589
535
|
"flags": {
|
|
590
536
|
"json": {
|
|
@@ -646,27 +592,16 @@
|
|
|
646
592
|
"deprecateAliases": true,
|
|
647
593
|
"name": "sobject",
|
|
648
594
|
"required": true,
|
|
649
|
-
"summary": "API name of the Salesforce or Tooling API object that you're
|
|
650
|
-
"hasDynamicHelp": false,
|
|
651
|
-
"multiple": false,
|
|
652
|
-
"type": "option"
|
|
653
|
-
},
|
|
654
|
-
"record-id": {
|
|
655
|
-
"aliases": [
|
|
656
|
-
"sobjectid"
|
|
657
|
-
],
|
|
658
|
-
"char": "i",
|
|
659
|
-
"deprecateAliases": true,
|
|
660
|
-
"name": "record-id",
|
|
661
|
-
"summary": "ID of the record you’re deleting.",
|
|
595
|
+
"summary": "API name of the Salesforce or Tooling API object that you're inserting a record into.",
|
|
662
596
|
"hasDynamicHelp": false,
|
|
663
597
|
"multiple": false,
|
|
664
598
|
"type": "option"
|
|
665
599
|
},
|
|
666
|
-
"
|
|
667
|
-
"char": "
|
|
668
|
-
"name": "
|
|
669
|
-
"
|
|
600
|
+
"values": {
|
|
601
|
+
"char": "v",
|
|
602
|
+
"name": "values",
|
|
603
|
+
"required": true,
|
|
604
|
+
"summary": "Values for the flags in the form <fieldName>=<value>, separate multiple pairs with spaces.",
|
|
670
605
|
"hasDynamicHelp": false,
|
|
671
606
|
"multiple": false,
|
|
672
607
|
"type": "option"
|
|
@@ -678,7 +613,7 @@
|
|
|
678
613
|
"char": "t",
|
|
679
614
|
"deprecateAliases": true,
|
|
680
615
|
"name": "use-tooling-api",
|
|
681
|
-
"summary": "Use Tooling API so you can
|
|
616
|
+
"summary": "Use Tooling API so you can insert a record in a Tooling API object.",
|
|
682
617
|
"allowNo": false,
|
|
683
618
|
"type": "boolean"
|
|
684
619
|
},
|
|
@@ -696,64 +631,63 @@
|
|
|
696
631
|
},
|
|
697
632
|
"hasDynamicHelp": true,
|
|
698
633
|
"hiddenAliases": [],
|
|
699
|
-
"id": "data:
|
|
634
|
+
"id": "data:create:record",
|
|
700
635
|
"pluginAlias": "@salesforce/plugin-data",
|
|
701
636
|
"pluginName": "@salesforce/plugin-data",
|
|
702
637
|
"pluginType": "core",
|
|
703
638
|
"strict": true,
|
|
704
|
-
"summary": "
|
|
639
|
+
"summary": "Create and insert a record into a Salesforce or Tooling API object.",
|
|
705
640
|
"enableJsonFlag": true,
|
|
706
641
|
"isESM": true,
|
|
707
642
|
"relativePath": [
|
|
708
643
|
"lib",
|
|
709
644
|
"commands",
|
|
710
645
|
"data",
|
|
711
|
-
"
|
|
646
|
+
"create",
|
|
712
647
|
"record.js"
|
|
713
648
|
],
|
|
714
649
|
"aliasPermutations": [
|
|
715
|
-
"force:data:record:
|
|
716
|
-
"data:force:record:
|
|
717
|
-
"data:record:force:
|
|
718
|
-
"data:record:
|
|
719
|
-
"force:record:data:
|
|
720
|
-
"record:force:data:
|
|
721
|
-
"record:data:force:
|
|
722
|
-
"record:data:
|
|
723
|
-
"force:record:
|
|
724
|
-
"record:force:
|
|
725
|
-
"record:
|
|
726
|
-
"record:
|
|
727
|
-
"force:data:
|
|
728
|
-
"data:force:
|
|
729
|
-
"data:
|
|
730
|
-
"data:
|
|
731
|
-
"force:
|
|
732
|
-
"
|
|
733
|
-
"
|
|
734
|
-
"
|
|
735
|
-
"force:
|
|
736
|
-
"
|
|
737
|
-
"
|
|
738
|
-
"
|
|
650
|
+
"force:data:record:create",
|
|
651
|
+
"data:force:record:create",
|
|
652
|
+
"data:record:force:create",
|
|
653
|
+
"data:record:create:force",
|
|
654
|
+
"force:record:data:create",
|
|
655
|
+
"record:force:data:create",
|
|
656
|
+
"record:data:force:create",
|
|
657
|
+
"record:data:create:force",
|
|
658
|
+
"force:record:create:data",
|
|
659
|
+
"record:force:create:data",
|
|
660
|
+
"record:create:force:data",
|
|
661
|
+
"record:create:data:force",
|
|
662
|
+
"force:data:create:record",
|
|
663
|
+
"data:force:create:record",
|
|
664
|
+
"data:create:force:record",
|
|
665
|
+
"data:create:record:force",
|
|
666
|
+
"force:create:data:record",
|
|
667
|
+
"create:force:data:record",
|
|
668
|
+
"create:data:force:record",
|
|
669
|
+
"create:data:record:force",
|
|
670
|
+
"force:create:record:data",
|
|
671
|
+
"create:force:record:data",
|
|
672
|
+
"create:record:force:data",
|
|
673
|
+
"create:record:data:force"
|
|
739
674
|
],
|
|
740
675
|
"permutations": [
|
|
741
|
-
"data:
|
|
742
|
-
"
|
|
743
|
-
"
|
|
744
|
-
"data:record:
|
|
745
|
-
"record:data:
|
|
746
|
-
"record:
|
|
676
|
+
"data:create:record",
|
|
677
|
+
"create:data:record",
|
|
678
|
+
"create:record:data",
|
|
679
|
+
"data:record:create",
|
|
680
|
+
"record:data:create",
|
|
681
|
+
"record:create:data"
|
|
747
682
|
]
|
|
748
683
|
},
|
|
749
|
-
"data:delete:
|
|
684
|
+
"data:delete:bulk": {
|
|
750
685
|
"aliases": [],
|
|
751
686
|
"args": {},
|
|
752
|
-
"
|
|
753
|
-
"description": "The command uses the job ID returned by the \"<%= config.bin %> data delete bulk\" command or the most recently-run bulk delete job.",
|
|
687
|
+
"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.",
|
|
754
688
|
"examples": [
|
|
755
|
-
"
|
|
756
|
-
"
|
|
689
|
+
"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",
|
|
690
|
+
"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"
|
|
757
691
|
],
|
|
758
692
|
"flags": {
|
|
759
693
|
"json": {
|
|
@@ -780,41 +714,17 @@
|
|
|
780
714
|
"deprecateAliases": true,
|
|
781
715
|
"name": "target-org",
|
|
782
716
|
"noCacheDefault": true,
|
|
783
|
-
"
|
|
717
|
+
"required": true,
|
|
718
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
784
719
|
"hasDynamicHelp": true,
|
|
785
720
|
"multiple": false,
|
|
786
721
|
"type": "option"
|
|
787
722
|
},
|
|
788
|
-
"
|
|
723
|
+
"api-version": {
|
|
789
724
|
"aliases": [
|
|
790
|
-
"
|
|
725
|
+
"apiversion"
|
|
791
726
|
],
|
|
792
|
-
"char": "i",
|
|
793
727
|
"deprecateAliases": true,
|
|
794
|
-
"name": "job-id",
|
|
795
|
-
"summary": "ID of the job you want to resume.",
|
|
796
|
-
"hasDynamicHelp": false,
|
|
797
|
-
"multiple": false,
|
|
798
|
-
"type": "option"
|
|
799
|
-
},
|
|
800
|
-
"use-most-recent": {
|
|
801
|
-
"exclusive": [
|
|
802
|
-
"job-id"
|
|
803
|
-
],
|
|
804
|
-
"name": "use-most-recent",
|
|
805
|
-
"summary": "Use the ID of the most recently-run bulk job.",
|
|
806
|
-
"allowNo": false,
|
|
807
|
-
"type": "boolean"
|
|
808
|
-
},
|
|
809
|
-
"wait": {
|
|
810
|
-
"name": "wait",
|
|
811
|
-
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
812
|
-
"default": "0 minutes",
|
|
813
|
-
"hasDynamicHelp": true,
|
|
814
|
-
"multiple": false,
|
|
815
|
-
"type": "option"
|
|
816
|
-
},
|
|
817
|
-
"api-version": {
|
|
818
728
|
"description": "Override the api version used for api requests made by this command",
|
|
819
729
|
"name": "api-version",
|
|
820
730
|
"hasDynamicHelp": false,
|
|
@@ -830,142 +740,108 @@
|
|
|
830
740
|
"hasDynamicHelp": false,
|
|
831
741
|
"multiple": false,
|
|
832
742
|
"type": "option"
|
|
833
|
-
}
|
|
834
|
-
},
|
|
835
|
-
"hasDynamicHelp": true,
|
|
836
|
-
"hiddenAliases": [],
|
|
837
|
-
"id": "data:delete:resume",
|
|
838
|
-
"pluginAlias": "@salesforce/plugin-data",
|
|
839
|
-
"pluginName": "@salesforce/plugin-data",
|
|
840
|
-
"pluginType": "core",
|
|
841
|
-
"strict": true,
|
|
842
|
-
"summary": "Resume a bulk delete job that you previously started. Uses Bulk API 2.0.",
|
|
843
|
-
"enableJsonFlag": true,
|
|
844
|
-
"isESM": true,
|
|
845
|
-
"relativePath": [
|
|
846
|
-
"lib",
|
|
847
|
-
"commands",
|
|
848
|
-
"data",
|
|
849
|
-
"delete",
|
|
850
|
-
"resume.js"
|
|
851
|
-
],
|
|
852
|
-
"aliasPermutations": [],
|
|
853
|
-
"permutations": [
|
|
854
|
-
"data:delete:resume",
|
|
855
|
-
"delete:data:resume",
|
|
856
|
-
"delete:resume:data",
|
|
857
|
-
"data:resume:delete",
|
|
858
|
-
"resume:data:delete",
|
|
859
|
-
"resume:delete:data"
|
|
860
|
-
]
|
|
861
|
-
},
|
|
862
|
-
"data:create:file": {
|
|
863
|
-
"aliases": [],
|
|
864
|
-
"args": {},
|
|
865
|
-
"description": "This command always creates a new file in the org; you can't update an existing file. After a successful upload, the command displays the ID of the new ContentDocument record which represents the uploaded file.\n\nBy default, the uploaded file isn't attached to a record; in the Salesforce UI the file shows up in the Files tab. You can optionally attach the file to an existing record, such as an account, as long as you know its record ID.\n\nYou can also give the file a new name after it's been uploaded; by default its name in the org is the same as the local file name.",
|
|
866
|
-
"examples": [
|
|
867
|
-
"Upload the local file \"resources/astro.png\" to your default org:\n<%= config.bin %> <%= command.id %> --file resources/astro.png",
|
|
868
|
-
"Give the file a different filename after it's uploaded to the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --file resources/astro.png --title AstroOnABoat.png --target-org my-scratch",
|
|
869
|
-
"Attach the file to a record in the org:\n<%= config.bin %> <%= command.id %> --file path/to/astro.png --parent-id a03fakeLoJWPIA3"
|
|
870
|
-
],
|
|
871
|
-
"flags": {
|
|
872
|
-
"json": {
|
|
873
|
-
"description": "Format output as json.",
|
|
874
|
-
"helpGroup": "GLOBAL",
|
|
875
|
-
"name": "json",
|
|
876
|
-
"allowNo": false,
|
|
877
|
-
"type": "boolean"
|
|
878
743
|
},
|
|
879
|
-
"
|
|
880
|
-
"
|
|
881
|
-
|
|
882
|
-
|
|
744
|
+
"file": {
|
|
745
|
+
"aliases": [
|
|
746
|
+
"csvfile"
|
|
747
|
+
],
|
|
748
|
+
"char": "f",
|
|
749
|
+
"deprecateAliases": true,
|
|
750
|
+
"name": "file",
|
|
751
|
+
"required": true,
|
|
752
|
+
"summary": "CSV file that contains the IDs of the records to update or delete.",
|
|
883
753
|
"hasDynamicHelp": false,
|
|
884
754
|
"multiple": false,
|
|
885
755
|
"type": "option"
|
|
886
756
|
},
|
|
887
|
-
"
|
|
888
|
-
"
|
|
889
|
-
|
|
890
|
-
|
|
757
|
+
"sobject": {
|
|
758
|
+
"aliases": [
|
|
759
|
+
"sobjecttype"
|
|
760
|
+
],
|
|
761
|
+
"char": "s",
|
|
762
|
+
"deprecateAliases": true,
|
|
763
|
+
"name": "sobject",
|
|
891
764
|
"required": true,
|
|
892
|
-
"summary": "
|
|
893
|
-
"hasDynamicHelp": true,
|
|
894
|
-
"multiple": false,
|
|
895
|
-
"type": "option"
|
|
896
|
-
},
|
|
897
|
-
"api-version": {
|
|
898
|
-
"description": "Override the api version used for api requests made by this command",
|
|
899
|
-
"name": "api-version",
|
|
765
|
+
"summary": "API name of the Salesforce object, either standard or custom, that you want to update or delete records from.",
|
|
900
766
|
"hasDynamicHelp": false,
|
|
901
767
|
"multiple": false,
|
|
902
768
|
"type": "option"
|
|
903
769
|
},
|
|
904
|
-
"
|
|
905
|
-
"char": "
|
|
906
|
-
"
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
"
|
|
770
|
+
"wait": {
|
|
771
|
+
"char": "w",
|
|
772
|
+
"exclusive": [
|
|
773
|
+
"async"
|
|
774
|
+
],
|
|
775
|
+
"name": "wait",
|
|
776
|
+
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
777
|
+
"default": "0 minutes",
|
|
778
|
+
"hasDynamicHelp": true,
|
|
910
779
|
"multiple": false,
|
|
911
780
|
"type": "option"
|
|
912
781
|
},
|
|
913
|
-
"
|
|
914
|
-
"char": "
|
|
915
|
-
"
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
"
|
|
919
|
-
"
|
|
920
|
-
"
|
|
782
|
+
"async": {
|
|
783
|
+
"char": "a",
|
|
784
|
+
"exclusive": [
|
|
785
|
+
"wait"
|
|
786
|
+
],
|
|
787
|
+
"name": "async",
|
|
788
|
+
"summary": "Run the command asynchronously.",
|
|
789
|
+
"allowNo": false,
|
|
790
|
+
"type": "boolean"
|
|
791
|
+
},
|
|
792
|
+
"verbose": {
|
|
793
|
+
"name": "verbose",
|
|
794
|
+
"summary": "Print verbose output of failed records if result is available.",
|
|
795
|
+
"allowNo": false,
|
|
796
|
+
"type": "boolean"
|
|
921
797
|
},
|
|
922
|
-
"
|
|
923
|
-
"
|
|
924
|
-
"name": "
|
|
925
|
-
"summary": "
|
|
926
|
-
"
|
|
927
|
-
"
|
|
928
|
-
"type": "option"
|
|
798
|
+
"hard-delete": {
|
|
799
|
+
"description": "You must have the \"Bulk API Hard Delete\" system permission to use this flag. The permission is disabled by default and can be enabled only by a system administrator.",
|
|
800
|
+
"name": "hard-delete",
|
|
801
|
+
"summary": "Mark the records as immediately eligible for deletion by your org. If you don't specify this flag, the deleted records go into the Recycle Bin.",
|
|
802
|
+
"allowNo": false,
|
|
803
|
+
"type": "boolean"
|
|
929
804
|
}
|
|
930
805
|
},
|
|
931
806
|
"hasDynamicHelp": true,
|
|
932
807
|
"hiddenAliases": [],
|
|
933
|
-
"id": "data:
|
|
808
|
+
"id": "data:delete:bulk",
|
|
934
809
|
"pluginAlias": "@salesforce/plugin-data",
|
|
935
810
|
"pluginName": "@salesforce/plugin-data",
|
|
936
811
|
"pluginType": "core",
|
|
937
812
|
"strict": true,
|
|
938
|
-
"summary": "
|
|
813
|
+
"summary": "Bulk delete records from an org using a CSV file. Uses Bulk API 2.0.",
|
|
939
814
|
"enableJsonFlag": true,
|
|
940
815
|
"isESM": true,
|
|
941
816
|
"relativePath": [
|
|
942
817
|
"lib",
|
|
943
818
|
"commands",
|
|
944
819
|
"data",
|
|
945
|
-
"
|
|
946
|
-
"
|
|
820
|
+
"delete",
|
|
821
|
+
"bulk.js"
|
|
947
822
|
],
|
|
948
823
|
"aliasPermutations": [],
|
|
949
824
|
"permutations": [
|
|
950
|
-
"data:
|
|
951
|
-
"
|
|
952
|
-
"
|
|
953
|
-
"data:
|
|
954
|
-
"
|
|
955
|
-
"
|
|
825
|
+
"data:delete:bulk",
|
|
826
|
+
"delete:data:bulk",
|
|
827
|
+
"delete:bulk:data",
|
|
828
|
+
"data:bulk:delete",
|
|
829
|
+
"bulk:data:delete",
|
|
830
|
+
"bulk:delete:data"
|
|
956
831
|
]
|
|
957
832
|
},
|
|
958
|
-
"data:
|
|
833
|
+
"data:delete:record": {
|
|
959
834
|
"aliases": [
|
|
960
|
-
"force:data:record:
|
|
835
|
+
"force:data:record:delete"
|
|
961
836
|
],
|
|
962
837
|
"args": {},
|
|
963
838
|
"deprecateAliases": true,
|
|
964
|
-
"description": "
|
|
839
|
+
"description": "Specify the record you want to delete with either its ID or with a list of field-value pairs that identify the record. If your list of fields identifies more than one record, the delete fails; the error displays how many records were found.\n\nWhen specifying field-value pairs, use the format <fieldName>=<value>. Enclose all field-value pairs in one set of double quotation marks, delimited by spaces. Enclose values that contain spaces in single quotes.\n\nThis command deletes a record from Salesforce objects by default. Use the --use-tooling-api flag to delete from a Tooling API object.",
|
|
965
840
|
"examples": [
|
|
966
|
-
"
|
|
967
|
-
"
|
|
968
|
-
"
|
|
841
|
+
"Delete a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX",
|
|
842
|
+
"Delete a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name=Acme\"",
|
|
843
|
+
"Delete a record from Account identified with two field values, one that contains a space; the command uses the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name='Universal Containers' Phone='(123) 456-7890'\" --target-org myscratch",
|
|
844
|
+
"Delete a record from the Tooling API object TraceFlag with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --use-tooling-api --sobject TraceFlag --record-id 7tf8c"
|
|
969
845
|
],
|
|
970
846
|
"flags": {
|
|
971
847
|
"json": {
|
|
@@ -1027,16 +903,27 @@
|
|
|
1027
903
|
"deprecateAliases": true,
|
|
1028
904
|
"name": "sobject",
|
|
1029
905
|
"required": true,
|
|
1030
|
-
"summary": "API name of the Salesforce or Tooling API object that you're
|
|
906
|
+
"summary": "API name of the Salesforce or Tooling API object that you're deleting a record from.",
|
|
1031
907
|
"hasDynamicHelp": false,
|
|
1032
908
|
"multiple": false,
|
|
1033
909
|
"type": "option"
|
|
1034
910
|
},
|
|
1035
|
-
"
|
|
1036
|
-
"
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
"
|
|
911
|
+
"record-id": {
|
|
912
|
+
"aliases": [
|
|
913
|
+
"sobjectid"
|
|
914
|
+
],
|
|
915
|
+
"char": "i",
|
|
916
|
+
"deprecateAliases": true,
|
|
917
|
+
"name": "record-id",
|
|
918
|
+
"summary": "ID of the record you’re deleting.",
|
|
919
|
+
"hasDynamicHelp": false,
|
|
920
|
+
"multiple": false,
|
|
921
|
+
"type": "option"
|
|
922
|
+
},
|
|
923
|
+
"where": {
|
|
924
|
+
"char": "w",
|
|
925
|
+
"name": "where",
|
|
926
|
+
"summary": "List of <fieldName>=<value> pairs that identify the record you want to delete.",
|
|
1040
927
|
"hasDynamicHelp": false,
|
|
1041
928
|
"multiple": false,
|
|
1042
929
|
"type": "option"
|
|
@@ -1048,7 +935,7 @@
|
|
|
1048
935
|
"char": "t",
|
|
1049
936
|
"deprecateAliases": true,
|
|
1050
937
|
"name": "use-tooling-api",
|
|
1051
|
-
"summary": "Use Tooling API so you can
|
|
938
|
+
"summary": "Use Tooling API so you can delete a record from a Tooling API object.",
|
|
1052
939
|
"allowNo": false,
|
|
1053
940
|
"type": "boolean"
|
|
1054
941
|
},
|
|
@@ -1066,54 +953,167 @@
|
|
|
1066
953
|
},
|
|
1067
954
|
"hasDynamicHelp": true,
|
|
1068
955
|
"hiddenAliases": [],
|
|
1069
|
-
"id": "data:
|
|
956
|
+
"id": "data:delete:record",
|
|
1070
957
|
"pluginAlias": "@salesforce/plugin-data",
|
|
1071
958
|
"pluginName": "@salesforce/plugin-data",
|
|
1072
959
|
"pluginType": "core",
|
|
1073
960
|
"strict": true,
|
|
1074
|
-
"summary": "
|
|
961
|
+
"summary": "Deletes a single record from a Salesforce or Tooling API object.",
|
|
1075
962
|
"enableJsonFlag": true,
|
|
1076
963
|
"isESM": true,
|
|
1077
964
|
"relativePath": [
|
|
1078
965
|
"lib",
|
|
1079
966
|
"commands",
|
|
1080
967
|
"data",
|
|
1081
|
-
"
|
|
968
|
+
"delete",
|
|
1082
969
|
"record.js"
|
|
1083
970
|
],
|
|
1084
971
|
"aliasPermutations": [
|
|
1085
|
-
"force:data:record:
|
|
1086
|
-
"data:force:record:
|
|
1087
|
-
"data:record:force:
|
|
1088
|
-
"data:record:
|
|
1089
|
-
"force:record:data:
|
|
1090
|
-
"record:force:data:
|
|
1091
|
-
"record:data:force:
|
|
1092
|
-
"record:data:
|
|
1093
|
-
"force:record:
|
|
1094
|
-
"record:force:
|
|
1095
|
-
"record:
|
|
1096
|
-
"record:
|
|
1097
|
-
"force:data:
|
|
1098
|
-
"data:force:
|
|
1099
|
-
"data:
|
|
1100
|
-
"data:
|
|
1101
|
-
"force:
|
|
1102
|
-
"
|
|
1103
|
-
"
|
|
1104
|
-
"
|
|
1105
|
-
"force:
|
|
1106
|
-
"
|
|
1107
|
-
"
|
|
1108
|
-
"
|
|
972
|
+
"force:data:record:delete",
|
|
973
|
+
"data:force:record:delete",
|
|
974
|
+
"data:record:force:delete",
|
|
975
|
+
"data:record:delete:force",
|
|
976
|
+
"force:record:data:delete",
|
|
977
|
+
"record:force:data:delete",
|
|
978
|
+
"record:data:force:delete",
|
|
979
|
+
"record:data:delete:force",
|
|
980
|
+
"force:record:delete:data",
|
|
981
|
+
"record:force:delete:data",
|
|
982
|
+
"record:delete:force:data",
|
|
983
|
+
"record:delete:data:force",
|
|
984
|
+
"force:data:delete:record",
|
|
985
|
+
"data:force:delete:record",
|
|
986
|
+
"data:delete:force:record",
|
|
987
|
+
"data:delete:record:force",
|
|
988
|
+
"force:delete:data:record",
|
|
989
|
+
"delete:force:data:record",
|
|
990
|
+
"delete:data:force:record",
|
|
991
|
+
"delete:data:record:force",
|
|
992
|
+
"force:delete:record:data",
|
|
993
|
+
"delete:force:record:data",
|
|
994
|
+
"delete:record:force:data",
|
|
995
|
+
"delete:record:data:force"
|
|
1109
996
|
],
|
|
1110
997
|
"permutations": [
|
|
1111
|
-
"data:
|
|
1112
|
-
"
|
|
1113
|
-
"
|
|
1114
|
-
"data:record:
|
|
1115
|
-
"record:data:
|
|
1116
|
-
"record:
|
|
998
|
+
"data:delete:record",
|
|
999
|
+
"delete:data:record",
|
|
1000
|
+
"delete:record:data",
|
|
1001
|
+
"data:record:delete",
|
|
1002
|
+
"record:data:delete",
|
|
1003
|
+
"record:delete:data"
|
|
1004
|
+
]
|
|
1005
|
+
},
|
|
1006
|
+
"data:delete:resume": {
|
|
1007
|
+
"aliases": [],
|
|
1008
|
+
"args": {},
|
|
1009
|
+
"deprecateAliases": true,
|
|
1010
|
+
"description": "The command uses the job ID returned by the \"<%= config.bin %> data delete bulk\" command or the most recently-run bulk delete job.",
|
|
1011
|
+
"examples": [
|
|
1012
|
+
"Resume a bulk delete job from your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
|
|
1013
|
+
"Resume the most recently run bulk delete job for an org with alias my-scratch:\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-scratch"
|
|
1014
|
+
],
|
|
1015
|
+
"flags": {
|
|
1016
|
+
"json": {
|
|
1017
|
+
"description": "Format output as json.",
|
|
1018
|
+
"helpGroup": "GLOBAL",
|
|
1019
|
+
"name": "json",
|
|
1020
|
+
"allowNo": false,
|
|
1021
|
+
"type": "boolean"
|
|
1022
|
+
},
|
|
1023
|
+
"flags-dir": {
|
|
1024
|
+
"helpGroup": "GLOBAL",
|
|
1025
|
+
"name": "flags-dir",
|
|
1026
|
+
"summary": "Import flag values from a directory.",
|
|
1027
|
+
"hasDynamicHelp": false,
|
|
1028
|
+
"multiple": false,
|
|
1029
|
+
"type": "option"
|
|
1030
|
+
},
|
|
1031
|
+
"target-org": {
|
|
1032
|
+
"aliases": [
|
|
1033
|
+
"targetusername",
|
|
1034
|
+
"u"
|
|
1035
|
+
],
|
|
1036
|
+
"char": "o",
|
|
1037
|
+
"deprecateAliases": true,
|
|
1038
|
+
"name": "target-org",
|
|
1039
|
+
"noCacheDefault": true,
|
|
1040
|
+
"summary": "Username or alias of the target org. Not required if the \"target-org\" configuration variable is already set.",
|
|
1041
|
+
"hasDynamicHelp": true,
|
|
1042
|
+
"multiple": false,
|
|
1043
|
+
"type": "option"
|
|
1044
|
+
},
|
|
1045
|
+
"job-id": {
|
|
1046
|
+
"aliases": [
|
|
1047
|
+
"jobid"
|
|
1048
|
+
],
|
|
1049
|
+
"char": "i",
|
|
1050
|
+
"deprecateAliases": true,
|
|
1051
|
+
"name": "job-id",
|
|
1052
|
+
"summary": "ID of the job you want to resume.",
|
|
1053
|
+
"hasDynamicHelp": false,
|
|
1054
|
+
"multiple": false,
|
|
1055
|
+
"type": "option"
|
|
1056
|
+
},
|
|
1057
|
+
"use-most-recent": {
|
|
1058
|
+
"exclusive": [
|
|
1059
|
+
"job-id"
|
|
1060
|
+
],
|
|
1061
|
+
"name": "use-most-recent",
|
|
1062
|
+
"summary": "Use the ID of the most recently-run bulk job.",
|
|
1063
|
+
"allowNo": false,
|
|
1064
|
+
"type": "boolean"
|
|
1065
|
+
},
|
|
1066
|
+
"wait": {
|
|
1067
|
+
"name": "wait",
|
|
1068
|
+
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
1069
|
+
"default": "0 minutes",
|
|
1070
|
+
"hasDynamicHelp": true,
|
|
1071
|
+
"multiple": false,
|
|
1072
|
+
"type": "option"
|
|
1073
|
+
},
|
|
1074
|
+
"api-version": {
|
|
1075
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1076
|
+
"name": "api-version",
|
|
1077
|
+
"hasDynamicHelp": false,
|
|
1078
|
+
"multiple": false,
|
|
1079
|
+
"type": "option"
|
|
1080
|
+
},
|
|
1081
|
+
"loglevel": {
|
|
1082
|
+
"deprecated": {
|
|
1083
|
+
"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."
|
|
1084
|
+
},
|
|
1085
|
+
"hidden": true,
|
|
1086
|
+
"name": "loglevel",
|
|
1087
|
+
"hasDynamicHelp": false,
|
|
1088
|
+
"multiple": false,
|
|
1089
|
+
"type": "option"
|
|
1090
|
+
}
|
|
1091
|
+
},
|
|
1092
|
+
"hasDynamicHelp": true,
|
|
1093
|
+
"hiddenAliases": [],
|
|
1094
|
+
"id": "data:delete:resume",
|
|
1095
|
+
"pluginAlias": "@salesforce/plugin-data",
|
|
1096
|
+
"pluginName": "@salesforce/plugin-data",
|
|
1097
|
+
"pluginType": "core",
|
|
1098
|
+
"strict": true,
|
|
1099
|
+
"summary": "Resume a bulk delete job that you previously started. Uses Bulk API 2.0.",
|
|
1100
|
+
"enableJsonFlag": true,
|
|
1101
|
+
"isESM": true,
|
|
1102
|
+
"relativePath": [
|
|
1103
|
+
"lib",
|
|
1104
|
+
"commands",
|
|
1105
|
+
"data",
|
|
1106
|
+
"delete",
|
|
1107
|
+
"resume.js"
|
|
1108
|
+
],
|
|
1109
|
+
"aliasPermutations": [],
|
|
1110
|
+
"permutations": [
|
|
1111
|
+
"data:delete:resume",
|
|
1112
|
+
"delete:data:resume",
|
|
1113
|
+
"delete:resume:data",
|
|
1114
|
+
"data:resume:delete",
|
|
1115
|
+
"resume:data:delete",
|
|
1116
|
+
"resume:delete:data"
|
|
1117
1117
|
]
|
|
1118
1118
|
},
|
|
1119
1119
|
"data:export:bulk": {
|
|
@@ -1446,7 +1446,7 @@
|
|
|
1446
1446
|
"required": true,
|
|
1447
1447
|
"summary": "SOQL query, or filepath of a file that contains the query, to retrieve records.",
|
|
1448
1448
|
"hasDynamicHelp": false,
|
|
1449
|
-
"multiple":
|
|
1449
|
+
"multiple": true,
|
|
1450
1450
|
"type": "option"
|
|
1451
1451
|
},
|
|
1452
1452
|
"plan": {
|
|
@@ -3533,5 +3533,5 @@
|
|
|
3533
3533
|
]
|
|
3534
3534
|
}
|
|
3535
3535
|
},
|
|
3536
|
-
"version": "3.8.
|
|
3536
|
+
"version": "3.8.1"
|
|
3537
3537
|
}
|