@salesforce/plugin-data 3.9.0 → 3.11.0

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.
@@ -424,6 +424,340 @@
424
424
  "search:data"
425
425
  ]
426
426
  },
427
+ "data:bulk:results": {
428
+ "aliases": [],
429
+ "args": {},
430
+ "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.",
431
+ "examples": [
432
+ "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"
433
+ ],
434
+ "flags": {
435
+ "json": {
436
+ "description": "Format output as json.",
437
+ "helpGroup": "GLOBAL",
438
+ "name": "json",
439
+ "allowNo": false,
440
+ "type": "boolean"
441
+ },
442
+ "flags-dir": {
443
+ "helpGroup": "GLOBAL",
444
+ "name": "flags-dir",
445
+ "summary": "Import flag values from a directory.",
446
+ "hasDynamicHelp": false,
447
+ "multiple": false,
448
+ "type": "option"
449
+ },
450
+ "job-id": {
451
+ "char": "i",
452
+ "name": "job-id",
453
+ "required": true,
454
+ "summary": "Job ID of the bulk job.",
455
+ "hasDynamicHelp": false,
456
+ "multiple": false,
457
+ "type": "option"
458
+ },
459
+ "target-org": {
460
+ "char": "o",
461
+ "name": "target-org",
462
+ "noCacheDefault": true,
463
+ "required": true,
464
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
465
+ "hasDynamicHelp": true,
466
+ "multiple": false,
467
+ "type": "option"
468
+ },
469
+ "api-version": {
470
+ "description": "Override the api version used for api requests made by this command",
471
+ "name": "api-version",
472
+ "hasDynamicHelp": false,
473
+ "multiple": false,
474
+ "type": "option"
475
+ }
476
+ },
477
+ "hasDynamicHelp": true,
478
+ "hiddenAliases": [],
479
+ "id": "data:bulk:results",
480
+ "pluginAlias": "@salesforce/plugin-data",
481
+ "pluginName": "@salesforce/plugin-data",
482
+ "pluginType": "core",
483
+ "strict": true,
484
+ "summary": "Get the results of a bulk ingest job that you previously ran.",
485
+ "enableJsonFlag": true,
486
+ "isESM": true,
487
+ "relativePath": [
488
+ "lib",
489
+ "commands",
490
+ "data",
491
+ "bulk",
492
+ "results.js"
493
+ ],
494
+ "aliasPermutations": [],
495
+ "permutations": [
496
+ "data:bulk:results",
497
+ "bulk:data:results",
498
+ "bulk:results:data",
499
+ "data:results:bulk",
500
+ "results:data:bulk",
501
+ "results:bulk:data"
502
+ ]
503
+ },
504
+ "data:create:file": {
505
+ "aliases": [],
506
+ "args": {},
507
+ "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.",
508
+ "examples": [
509
+ "Upload the local file \"resources/astro.png\" to your default org:\n<%= config.bin %> <%= command.id %> --file resources/astro.png",
510
+ "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",
511
+ "Attach the file to a record in the org:\n<%= config.bin %> <%= command.id %> --file path/to/astro.png --parent-id a03fakeLoJWPIA3"
512
+ ],
513
+ "flags": {
514
+ "json": {
515
+ "description": "Format output as json.",
516
+ "helpGroup": "GLOBAL",
517
+ "name": "json",
518
+ "allowNo": false,
519
+ "type": "boolean"
520
+ },
521
+ "flags-dir": {
522
+ "helpGroup": "GLOBAL",
523
+ "name": "flags-dir",
524
+ "summary": "Import flag values from a directory.",
525
+ "hasDynamicHelp": false,
526
+ "multiple": false,
527
+ "type": "option"
528
+ },
529
+ "target-org": {
530
+ "char": "o",
531
+ "name": "target-org",
532
+ "noCacheDefault": true,
533
+ "required": true,
534
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
535
+ "hasDynamicHelp": true,
536
+ "multiple": false,
537
+ "type": "option"
538
+ },
539
+ "api-version": {
540
+ "description": "Override the api version used for api requests made by this command",
541
+ "name": "api-version",
542
+ "hasDynamicHelp": false,
543
+ "multiple": false,
544
+ "type": "option"
545
+ },
546
+ "title": {
547
+ "char": "t",
548
+ "name": "title",
549
+ "required": false,
550
+ "summary": "New title given to the file (ContentDocument) after it's uploaded.",
551
+ "hasDynamicHelp": false,
552
+ "multiple": false,
553
+ "type": "option"
554
+ },
555
+ "file": {
556
+ "char": "f",
557
+ "name": "file",
558
+ "required": true,
559
+ "summary": "Path of file to upload.",
560
+ "hasDynamicHelp": false,
561
+ "multiple": false,
562
+ "type": "option"
563
+ },
564
+ "parent-id": {
565
+ "char": "i",
566
+ "name": "parent-id",
567
+ "summary": "ID of the record to attach the file to.",
568
+ "hasDynamicHelp": false,
569
+ "multiple": false,
570
+ "type": "option"
571
+ }
572
+ },
573
+ "hasDynamicHelp": true,
574
+ "hiddenAliases": [],
575
+ "id": "data:create:file",
576
+ "pluginAlias": "@salesforce/plugin-data",
577
+ "pluginName": "@salesforce/plugin-data",
578
+ "pluginType": "core",
579
+ "strict": true,
580
+ "summary": "Upload a local file to an org.",
581
+ "enableJsonFlag": true,
582
+ "isESM": true,
583
+ "relativePath": [
584
+ "lib",
585
+ "commands",
586
+ "data",
587
+ "create",
588
+ "file.js"
589
+ ],
590
+ "aliasPermutations": [],
591
+ "permutations": [
592
+ "data:create:file",
593
+ "create:data:file",
594
+ "create:file:data",
595
+ "data:file:create",
596
+ "file:data:create",
597
+ "file:create:data"
598
+ ]
599
+ },
600
+ "data:create:record": {
601
+ "aliases": [
602
+ "force:data:record:create"
603
+ ],
604
+ "args": {},
605
+ "deprecateAliases": true,
606
+ "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.",
607
+ "examples": [
608
+ "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\"",
609
+ "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",
610
+ "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\""
611
+ ],
612
+ "flags": {
613
+ "json": {
614
+ "description": "Format output as json.",
615
+ "helpGroup": "GLOBAL",
616
+ "name": "json",
617
+ "allowNo": false,
618
+ "type": "boolean"
619
+ },
620
+ "flags-dir": {
621
+ "helpGroup": "GLOBAL",
622
+ "name": "flags-dir",
623
+ "summary": "Import flag values from a directory.",
624
+ "hasDynamicHelp": false,
625
+ "multiple": false,
626
+ "type": "option"
627
+ },
628
+ "target-org": {
629
+ "aliases": [
630
+ "targetusername",
631
+ "u"
632
+ ],
633
+ "char": "o",
634
+ "deprecateAliases": true,
635
+ "name": "target-org",
636
+ "noCacheDefault": true,
637
+ "required": true,
638
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
639
+ "hasDynamicHelp": true,
640
+ "multiple": false,
641
+ "type": "option"
642
+ },
643
+ "api-version": {
644
+ "aliases": [
645
+ "apiversion"
646
+ ],
647
+ "deprecateAliases": true,
648
+ "description": "Override the api version used for api requests made by this command",
649
+ "name": "api-version",
650
+ "hasDynamicHelp": false,
651
+ "multiple": false,
652
+ "type": "option"
653
+ },
654
+ "loglevel": {
655
+ "deprecated": {
656
+ "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."
657
+ },
658
+ "hidden": true,
659
+ "name": "loglevel",
660
+ "hasDynamicHelp": false,
661
+ "multiple": false,
662
+ "type": "option"
663
+ },
664
+ "sobject": {
665
+ "aliases": [
666
+ "sobjecttype"
667
+ ],
668
+ "char": "s",
669
+ "deprecateAliases": true,
670
+ "name": "sobject",
671
+ "required": true,
672
+ "summary": "API name of the Salesforce or Tooling API object that you're inserting a record into.",
673
+ "hasDynamicHelp": false,
674
+ "multiple": false,
675
+ "type": "option"
676
+ },
677
+ "values": {
678
+ "char": "v",
679
+ "name": "values",
680
+ "required": true,
681
+ "summary": "Values for the flags in the form <fieldName>=<value>, separate multiple pairs with spaces.",
682
+ "hasDynamicHelp": false,
683
+ "multiple": false,
684
+ "type": "option"
685
+ },
686
+ "use-tooling-api": {
687
+ "aliases": [
688
+ "usetoolingapi"
689
+ ],
690
+ "char": "t",
691
+ "deprecateAliases": true,
692
+ "name": "use-tooling-api",
693
+ "summary": "Use Tooling API so you can insert a record in a Tooling API object.",
694
+ "allowNo": false,
695
+ "type": "boolean"
696
+ },
697
+ "perflog": {
698
+ "deprecated": {
699
+ "version": "57"
700
+ },
701
+ "description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
702
+ "hidden": true,
703
+ "name": "perflog",
704
+ "summary": "Get API performance data.",
705
+ "allowNo": false,
706
+ "type": "boolean"
707
+ }
708
+ },
709
+ "hasDynamicHelp": true,
710
+ "hiddenAliases": [],
711
+ "id": "data:create:record",
712
+ "pluginAlias": "@salesforce/plugin-data",
713
+ "pluginName": "@salesforce/plugin-data",
714
+ "pluginType": "core",
715
+ "strict": true,
716
+ "summary": "Create and insert a record into a Salesforce or Tooling API object.",
717
+ "enableJsonFlag": true,
718
+ "isESM": true,
719
+ "relativePath": [
720
+ "lib",
721
+ "commands",
722
+ "data",
723
+ "create",
724
+ "record.js"
725
+ ],
726
+ "aliasPermutations": [
727
+ "force:data:record:create",
728
+ "data:force:record:create",
729
+ "data:record:force:create",
730
+ "data:record:create:force",
731
+ "force:record:data:create",
732
+ "record:force:data:create",
733
+ "record:data:force:create",
734
+ "record:data:create:force",
735
+ "force:record:create:data",
736
+ "record:force:create:data",
737
+ "record:create:force:data",
738
+ "record:create:data:force",
739
+ "force:data:create:record",
740
+ "data:force:create:record",
741
+ "data:create:force:record",
742
+ "data:create:record:force",
743
+ "force:create:data:record",
744
+ "create:force:data:record",
745
+ "create:data:force:record",
746
+ "create:data:record:force",
747
+ "force:create:record:data",
748
+ "create:force:record:data",
749
+ "create:record:force:data",
750
+ "create:record:data:force"
751
+ ],
752
+ "permutations": [
753
+ "data:create:record",
754
+ "create:data:record",
755
+ "create:record:data",
756
+ "data:record:create",
757
+ "record:data:create",
758
+ "record:create:data"
759
+ ]
760
+ },
427
761
  "data:delete:bulk": {
428
762
  "aliases": [],
429
763
  "args": {},
@@ -533,6 +867,9 @@
533
867
  "type": "boolean"
534
868
  },
535
869
  "verbose": {
870
+ "deprecated": {
871
+ "message": "The --verbose flag is deprecated and will be removed after March 2025, use \"sf data bulk results\" to get job results instead."
872
+ },
536
873
  "name": "verbose",
537
874
  "summary": "Print verbose output of failed records if result is available.",
538
875
  "allowNo": false,
@@ -816,304 +1153,47 @@
816
1153
  },
817
1154
  "api-version": {
818
1155
  "description": "Override the api version used for api requests made by this command",
819
- "name": "api-version",
820
- "hasDynamicHelp": false,
821
- "multiple": false,
822
- "type": "option"
823
- },
824
- "loglevel": {
825
- "deprecated": {
826
- "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."
827
- },
828
- "hidden": true,
829
- "name": "loglevel",
830
- "hasDynamicHelp": false,
831
- "multiple": false,
832
- "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
- },
879
- "flags-dir": {
880
- "helpGroup": "GLOBAL",
881
- "name": "flags-dir",
882
- "summary": "Import flag values from a directory.",
883
- "hasDynamicHelp": false,
884
- "multiple": false,
885
- "type": "option"
886
- },
887
- "target-org": {
888
- "char": "o",
889
- "name": "target-org",
890
- "noCacheDefault": true,
891
- "required": true,
892
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
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",
900
- "hasDynamicHelp": false,
901
- "multiple": false,
902
- "type": "option"
903
- },
904
- "title": {
905
- "char": "t",
906
- "name": "title",
907
- "required": false,
908
- "summary": "New title given to the file (ContentDocument) after it's uploaded.",
909
- "hasDynamicHelp": false,
910
- "multiple": false,
911
- "type": "option"
912
- },
913
- "file": {
914
- "char": "f",
915
- "name": "file",
916
- "required": true,
917
- "summary": "Path of file to upload.",
918
- "hasDynamicHelp": false,
919
- "multiple": false,
920
- "type": "option"
921
- },
922
- "parent-id": {
923
- "char": "i",
924
- "name": "parent-id",
925
- "summary": "ID of the record to attach the file to.",
926
- "hasDynamicHelp": false,
927
- "multiple": false,
928
- "type": "option"
929
- }
930
- },
931
- "hasDynamicHelp": true,
932
- "hiddenAliases": [],
933
- "id": "data:create:file",
934
- "pluginAlias": "@salesforce/plugin-data",
935
- "pluginName": "@salesforce/plugin-data",
936
- "pluginType": "core",
937
- "strict": true,
938
- "summary": "Upload a local file to an org.",
939
- "enableJsonFlag": true,
940
- "isESM": true,
941
- "relativePath": [
942
- "lib",
943
- "commands",
944
- "data",
945
- "create",
946
- "file.js"
947
- ],
948
- "aliasPermutations": [],
949
- "permutations": [
950
- "data:create:file",
951
- "create:data:file",
952
- "create:file:data",
953
- "data:file:create",
954
- "file:data:create",
955
- "file:create:data"
956
- ]
957
- },
958
- "data:create:record": {
959
- "aliases": [
960
- "force:data:record:create"
961
- ],
962
- "args": {},
963
- "deprecateAliases": true,
964
- "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.",
965
- "examples": [
966
- "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\"",
967
- "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",
968
- "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\""
969
- ],
970
- "flags": {
971
- "json": {
972
- "description": "Format output as json.",
973
- "helpGroup": "GLOBAL",
974
- "name": "json",
975
- "allowNo": false,
976
- "type": "boolean"
977
- },
978
- "flags-dir": {
979
- "helpGroup": "GLOBAL",
980
- "name": "flags-dir",
981
- "summary": "Import flag values from a directory.",
982
- "hasDynamicHelp": false,
983
- "multiple": false,
984
- "type": "option"
985
- },
986
- "target-org": {
987
- "aliases": [
988
- "targetusername",
989
- "u"
990
- ],
991
- "char": "o",
992
- "deprecateAliases": true,
993
- "name": "target-org",
994
- "noCacheDefault": true,
995
- "required": true,
996
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
997
- "hasDynamicHelp": true,
998
- "multiple": false,
999
- "type": "option"
1000
- },
1001
- "api-version": {
1002
- "aliases": [
1003
- "apiversion"
1004
- ],
1005
- "deprecateAliases": true,
1006
- "description": "Override the api version used for api requests made by this command",
1007
- "name": "api-version",
1008
- "hasDynamicHelp": false,
1009
- "multiple": false,
1010
- "type": "option"
1011
- },
1012
- "loglevel": {
1013
- "deprecated": {
1014
- "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."
1015
- },
1016
- "hidden": true,
1017
- "name": "loglevel",
1018
- "hasDynamicHelp": false,
1019
- "multiple": false,
1020
- "type": "option"
1021
- },
1022
- "sobject": {
1023
- "aliases": [
1024
- "sobjecttype"
1025
- ],
1026
- "char": "s",
1027
- "deprecateAliases": true,
1028
- "name": "sobject",
1029
- "required": true,
1030
- "summary": "API name of the Salesforce or Tooling API object that you're inserting a record into.",
1031
- "hasDynamicHelp": false,
1032
- "multiple": false,
1033
- "type": "option"
1034
- },
1035
- "values": {
1036
- "char": "v",
1037
- "name": "values",
1038
- "required": true,
1039
- "summary": "Values for the flags in the form <fieldName>=<value>, separate multiple pairs with spaces.",
1040
- "hasDynamicHelp": false,
1041
- "multiple": false,
1042
- "type": "option"
1043
- },
1044
- "use-tooling-api": {
1045
- "aliases": [
1046
- "usetoolingapi"
1047
- ],
1048
- "char": "t",
1049
- "deprecateAliases": true,
1050
- "name": "use-tooling-api",
1051
- "summary": "Use Tooling API so you can insert a record in a Tooling API object.",
1052
- "allowNo": false,
1053
- "type": "boolean"
1156
+ "name": "api-version",
1157
+ "hasDynamicHelp": false,
1158
+ "multiple": false,
1159
+ "type": "option"
1054
1160
  },
1055
- "perflog": {
1161
+ "loglevel": {
1056
1162
  "deprecated": {
1057
- "version": "57"
1163
+ "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."
1058
1164
  },
1059
- "description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
1060
1165
  "hidden": true,
1061
- "name": "perflog",
1062
- "summary": "Get API performance data.",
1063
- "allowNo": false,
1064
- "type": "boolean"
1166
+ "name": "loglevel",
1167
+ "hasDynamicHelp": false,
1168
+ "multiple": false,
1169
+ "type": "option"
1065
1170
  }
1066
1171
  },
1067
1172
  "hasDynamicHelp": true,
1068
1173
  "hiddenAliases": [],
1069
- "id": "data:create:record",
1174
+ "id": "data:delete:resume",
1070
1175
  "pluginAlias": "@salesforce/plugin-data",
1071
1176
  "pluginName": "@salesforce/plugin-data",
1072
1177
  "pluginType": "core",
1073
1178
  "strict": true,
1074
- "summary": "Create and insert a record into a Salesforce or Tooling API object.",
1179
+ "summary": "Resume a bulk delete job that you previously started. Uses Bulk API 2.0.",
1075
1180
  "enableJsonFlag": true,
1076
1181
  "isESM": true,
1077
1182
  "relativePath": [
1078
1183
  "lib",
1079
1184
  "commands",
1080
1185
  "data",
1081
- "create",
1082
- "record.js"
1083
- ],
1084
- "aliasPermutations": [
1085
- "force:data:record:create",
1086
- "data:force:record:create",
1087
- "data:record:force:create",
1088
- "data:record:create:force",
1089
- "force:record:data:create",
1090
- "record:force:data:create",
1091
- "record:data:force:create",
1092
- "record:data:create:force",
1093
- "force:record:create:data",
1094
- "record:force:create:data",
1095
- "record:create:force:data",
1096
- "record:create:data:force",
1097
- "force:data:create:record",
1098
- "data:force:create:record",
1099
- "data:create:force:record",
1100
- "data:create:record:force",
1101
- "force:create:data:record",
1102
- "create:force:data:record",
1103
- "create:data:force:record",
1104
- "create:data:record:force",
1105
- "force:create:record:data",
1106
- "create:force:record:data",
1107
- "create:record:force:data",
1108
- "create:record:data:force"
1186
+ "delete",
1187
+ "resume.js"
1109
1188
  ],
1189
+ "aliasPermutations": [],
1110
1190
  "permutations": [
1111
- "data:create:record",
1112
- "create:data:record",
1113
- "create:record:data",
1114
- "data:record:create",
1115
- "record:data:create",
1116
- "record:create:data"
1191
+ "data:delete:resume",
1192
+ "delete:data:resume",
1193
+ "delete:resume:data",
1194
+ "data:resume:delete",
1195
+ "resume:data:delete",
1196
+ "resume:delete:data"
1117
1197
  ]
1118
1198
  },
1119
1199
  "data:export:bulk": {
@@ -1355,7 +1435,7 @@
1355
1435
  "pluginName": "@salesforce/plugin-data",
1356
1436
  "pluginType": "core",
1357
1437
  "strict": true,
1358
- "summary": "Resume a bulk export job that you previously started.",
1438
+ "summary": "Resume a bulk export job that you previously started. Uses Bulk API 2.0.",
1359
1439
  "enableJsonFlag": true,
1360
1440
  "isESM": true,
1361
1441
  "relativePath": [
@@ -1811,7 +1891,7 @@
1811
1891
  "file"
1812
1892
  ],
1813
1893
  "name": "line-ending",
1814
- "summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LR`.",
1894
+ "summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LF`.",
1815
1895
  "hasDynamicHelp": false,
1816
1896
  "multiple": false,
1817
1897
  "options": [
@@ -1819,6 +1899,21 @@
1819
1899
  "LF"
1820
1900
  ],
1821
1901
  "type": "option"
1902
+ },
1903
+ "column-delimiter": {
1904
+ "name": "column-delimiter",
1905
+ "summary": "Column delimiter used in the CSV file. Default is COMMA.",
1906
+ "hasDynamicHelp": false,
1907
+ "multiple": false,
1908
+ "options": [
1909
+ "BACKQUOTE",
1910
+ "CARET",
1911
+ "COMMA",
1912
+ "PIPE",
1913
+ "SEMICOLON",
1914
+ "TAB"
1915
+ ],
1916
+ "type": "option"
1822
1917
  }
1823
1918
  },
1824
1919
  "hasDynamicHelp": true,
@@ -2332,6 +2427,137 @@
2332
2427
  "resume:query:data"
2333
2428
  ]
2334
2429
  },
2430
+ "data:update:bulk": {
2431
+ "aliases": [],
2432
+ "args": {},
2433
+ "description": "You can use this command to update millions of Salesforce object records based on a file in comma-separated values (CSV) format.\n\nAll the records in the CSV file must be for the same Salesforce object. Specify the object with the `--sobject` flag. The first column of every line in the CSV file must be an ID of the record you want to update. The CSV file can contain only existing records; if a record in the file doesn't currently exist in the Salesforce object, the command fails. Consider using \"sf data upsert bulk\" if you also want to insert new records.\n\nBulk updates can take a while, depending on how many records are in the CSV file. If the command times out, or you specified the --async flag, the command displays the job ID. To see the status and get the results of the job, run \"sf data update resume\" and pass the job ID to the --job-id flag.\n\nFor information and examples about how to prepare your CSV files, see \"Prepare Data to Ingest\" in the \"Bulk API 2.0 and Bulk API Developer Guide\" (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_prepare_data.htm).",
2434
+ "examples": [
2435
+ "Update Account records from a CSV-formatted file into an org with alias \"my-scratch\"; if the update doesn't complete in 10 minutes, the command ends and displays a job ID:\n<%= config.bin %> <%= command.id %> --file accounts.csv --sobject Account --wait 10 --target-org my-scratch",
2436
+ "Update asynchronously and use the default org; the command immediately returns a job ID that you then pass to the \"sf data update resume\" command:\n<%= config.bin %> <%= command.id %> --file accounts.csv --sobject Account --async"
2437
+ ],
2438
+ "flags": {
2439
+ "json": {
2440
+ "description": "Format output as json.",
2441
+ "helpGroup": "GLOBAL",
2442
+ "name": "json",
2443
+ "allowNo": false,
2444
+ "type": "boolean"
2445
+ },
2446
+ "flags-dir": {
2447
+ "helpGroup": "GLOBAL",
2448
+ "name": "flags-dir",
2449
+ "summary": "Import flag values from a directory.",
2450
+ "hasDynamicHelp": false,
2451
+ "multiple": false,
2452
+ "type": "option"
2453
+ },
2454
+ "async": {
2455
+ "char": "a",
2456
+ "name": "async",
2457
+ "summary": "Don't wait for the command to complete.",
2458
+ "allowNo": false,
2459
+ "type": "boolean"
2460
+ },
2461
+ "wait": {
2462
+ "char": "w",
2463
+ "name": "wait",
2464
+ "summary": "Time to wait for the command to finish, in minutes.",
2465
+ "hasDynamicHelp": true,
2466
+ "multiple": false,
2467
+ "type": "option"
2468
+ },
2469
+ "file": {
2470
+ "char": "f",
2471
+ "name": "file",
2472
+ "required": true,
2473
+ "summary": "CSV file that contains the Salesforce object records you want to update.",
2474
+ "hasDynamicHelp": false,
2475
+ "multiple": false,
2476
+ "type": "option"
2477
+ },
2478
+ "sobject": {
2479
+ "char": "s",
2480
+ "name": "sobject",
2481
+ "required": true,
2482
+ "summary": "API name of the Salesforce object, either standard or custom, which you are updating.",
2483
+ "hasDynamicHelp": false,
2484
+ "multiple": false,
2485
+ "type": "option"
2486
+ },
2487
+ "api-version": {
2488
+ "description": "Override the api version used for api requests made by this command",
2489
+ "name": "api-version",
2490
+ "hasDynamicHelp": false,
2491
+ "multiple": false,
2492
+ "type": "option"
2493
+ },
2494
+ "target-org": {
2495
+ "char": "o",
2496
+ "name": "target-org",
2497
+ "noCacheDefault": true,
2498
+ "required": true,
2499
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2500
+ "hasDynamicHelp": true,
2501
+ "multiple": false,
2502
+ "type": "option"
2503
+ },
2504
+ "line-ending": {
2505
+ "dependsOn": [
2506
+ "file"
2507
+ ],
2508
+ "name": "line-ending",
2509
+ "summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LF`.",
2510
+ "hasDynamicHelp": false,
2511
+ "multiple": false,
2512
+ "options": [
2513
+ "CRLF",
2514
+ "LF"
2515
+ ],
2516
+ "type": "option"
2517
+ },
2518
+ "column-delimiter": {
2519
+ "name": "column-delimiter",
2520
+ "summary": "Column delimiter used in the CSV file. Default is COMMA.",
2521
+ "hasDynamicHelp": false,
2522
+ "multiple": false,
2523
+ "options": [
2524
+ "BACKQUOTE",
2525
+ "CARET",
2526
+ "COMMA",
2527
+ "PIPE",
2528
+ "SEMICOLON",
2529
+ "TAB"
2530
+ ],
2531
+ "type": "option"
2532
+ }
2533
+ },
2534
+ "hasDynamicHelp": true,
2535
+ "hiddenAliases": [],
2536
+ "id": "data:update:bulk",
2537
+ "pluginAlias": "@salesforce/plugin-data",
2538
+ "pluginName": "@salesforce/plugin-data",
2539
+ "pluginType": "core",
2540
+ "strict": true,
2541
+ "summary": "Bulk update records to an org from a CSV file. Uses Bulk API 2.0.",
2542
+ "enableJsonFlag": true,
2543
+ "isESM": true,
2544
+ "relativePath": [
2545
+ "lib",
2546
+ "commands",
2547
+ "data",
2548
+ "update",
2549
+ "bulk.js"
2550
+ ],
2551
+ "aliasPermutations": [],
2552
+ "permutations": [
2553
+ "data:update:bulk",
2554
+ "update:data:bulk",
2555
+ "update:bulk:data",
2556
+ "data:bulk:update",
2557
+ "bulk:data:update",
2558
+ "bulk:update:data"
2559
+ ]
2560
+ },
2335
2561
  "data:update:record": {
2336
2562
  "aliases": [
2337
2563
  "force:data:record:update"
@@ -2513,6 +2739,81 @@
2513
2739
  "record:update:data"
2514
2740
  ]
2515
2741
  },
2742
+ "data:update:resume": {
2743
+ "aliases": [],
2744
+ "args": {},
2745
+ "description": "When the original \"sf data update bulk\" command either times out or is run with the --async flag, it displays a job ID. To see the status and get the results of the bulk update, run this command by either passing it the job ID or using the --use-most-recent flag to specify the most recent bulk update job.",
2746
+ "examples": [
2747
+ "Resume a bulk update job of your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
2748
+ "Resume the most recently run bulk update job for an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-scratch"
2749
+ ],
2750
+ "flags": {
2751
+ "json": {
2752
+ "description": "Format output as json.",
2753
+ "helpGroup": "GLOBAL",
2754
+ "name": "json",
2755
+ "allowNo": false,
2756
+ "type": "boolean"
2757
+ },
2758
+ "flags-dir": {
2759
+ "helpGroup": "GLOBAL",
2760
+ "name": "flags-dir",
2761
+ "summary": "Import flag values from a directory.",
2762
+ "hasDynamicHelp": false,
2763
+ "multiple": false,
2764
+ "type": "option"
2765
+ },
2766
+ "use-most-recent": {
2767
+ "name": "use-most-recent",
2768
+ "summary": "Use the job ID of the bulk update job that was most recently run.",
2769
+ "allowNo": false,
2770
+ "type": "boolean"
2771
+ },
2772
+ "job-id": {
2773
+ "char": "i",
2774
+ "name": "job-id",
2775
+ "summary": "Job ID of the bulk update.",
2776
+ "hasDynamicHelp": false,
2777
+ "multiple": false,
2778
+ "type": "option"
2779
+ },
2780
+ "wait": {
2781
+ "char": "w",
2782
+ "name": "wait",
2783
+ "summary": "Time to wait for the command to finish, in minutes.",
2784
+ "default": "5 minutes",
2785
+ "hasDynamicHelp": true,
2786
+ "multiple": false,
2787
+ "type": "option"
2788
+ }
2789
+ },
2790
+ "hasDynamicHelp": true,
2791
+ "hiddenAliases": [],
2792
+ "id": "data:update:resume",
2793
+ "pluginAlias": "@salesforce/plugin-data",
2794
+ "pluginName": "@salesforce/plugin-data",
2795
+ "pluginType": "core",
2796
+ "strict": true,
2797
+ "summary": "Resume a bulk update job that you previously started. Uses Bulk API 2.0.",
2798
+ "enableJsonFlag": true,
2799
+ "isESM": true,
2800
+ "relativePath": [
2801
+ "lib",
2802
+ "commands",
2803
+ "data",
2804
+ "update",
2805
+ "resume.js"
2806
+ ],
2807
+ "aliasPermutations": [],
2808
+ "permutations": [
2809
+ "data:update:resume",
2810
+ "update:data:resume",
2811
+ "update:resume:data",
2812
+ "data:resume:update",
2813
+ "resume:data:update",
2814
+ "resume:update:data"
2815
+ ]
2816
+ },
2516
2817
  "data:upsert:bulk": {
2517
2818
  "aliases": [],
2518
2819
  "args": {},
@@ -2622,6 +2923,9 @@
2622
2923
  "type": "boolean"
2623
2924
  },
2624
2925
  "verbose": {
2926
+ "deprecated": {
2927
+ "message": "The --verbose flag is deprecated and will be removed after March 2025, use \"sf data bulk results\" to get job results instead."
2928
+ },
2625
2929
  "name": "verbose",
2626
2930
  "summary": "Print verbose output of failed records if result is available.",
2627
2931
  "allowNo": false,
@@ -3533,5 +3837,5 @@
3533
3837
  ]
3534
3838
  }
3535
3839
  },
3536
- "version": "3.9.0"
3840
+ "version": "3.11.0"
3537
3841
  }