@salesforce/plugin-data 4.0.33 → 4.0.34
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 +24 -24
- package/oclif.manifest.json +495 -495
- package/package.json +5 -5
package/oclif.manifest.json
CHANGED
|
@@ -735,18 +735,13 @@
|
|
|
735
735
|
"record:create:data"
|
|
736
736
|
]
|
|
737
737
|
},
|
|
738
|
-
"data:
|
|
739
|
-
"aliases": [
|
|
740
|
-
"force:data:record:get"
|
|
741
|
-
],
|
|
738
|
+
"data:delete:bulk": {
|
|
739
|
+
"aliases": [],
|
|
742
740
|
"args": {},
|
|
743
|
-
"
|
|
744
|
-
"description": "Specify the record you want to retrieve 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 command 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\nThe command displays all the record's fields and their values, one field per terminal line. Fields with no values are displayed as \"null\".\n\nThis command retrieves a record from Salesforce objects by default. Use the --use-tooling-api flag to retrieve from a Tooling API object.",
|
|
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.",
|
|
745
742
|
"examples": [
|
|
746
|
-
"
|
|
747
|
-
"
|
|
748
|
-
"Retrieve 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",
|
|
749
|
-
"Retrieve 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"
|
|
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"
|
|
750
745
|
],
|
|
751
746
|
"flags": {
|
|
752
747
|
"json": {
|
|
@@ -800,122 +795,116 @@
|
|
|
800
795
|
"multiple": false,
|
|
801
796
|
"type": "option"
|
|
802
797
|
},
|
|
803
|
-
"
|
|
798
|
+
"file": {
|
|
804
799
|
"aliases": [
|
|
805
|
-
"
|
|
800
|
+
"csvfile"
|
|
806
801
|
],
|
|
807
|
-
"char": "
|
|
802
|
+
"char": "f",
|
|
808
803
|
"deprecateAliases": true,
|
|
809
|
-
"name": "
|
|
804
|
+
"name": "file",
|
|
810
805
|
"required": true,
|
|
811
|
-
"summary": "
|
|
806
|
+
"summary": "CSV file that contains the IDs of the records to update or delete.",
|
|
812
807
|
"hasDynamicHelp": false,
|
|
813
808
|
"multiple": false,
|
|
814
809
|
"type": "option"
|
|
815
810
|
},
|
|
816
|
-
"
|
|
811
|
+
"sobject": {
|
|
817
812
|
"aliases": [
|
|
818
|
-
"
|
|
813
|
+
"sobjecttype"
|
|
819
814
|
],
|
|
820
|
-
"char": "
|
|
815
|
+
"char": "s",
|
|
821
816
|
"deprecateAliases": true,
|
|
822
|
-
"name": "
|
|
823
|
-
"
|
|
817
|
+
"name": "sobject",
|
|
818
|
+
"required": true,
|
|
819
|
+
"summary": "API name of the Salesforce object, either standard or custom, that you want to update or delete records from.",
|
|
824
820
|
"hasDynamicHelp": false,
|
|
825
821
|
"multiple": false,
|
|
826
822
|
"type": "option"
|
|
827
823
|
},
|
|
828
|
-
"
|
|
824
|
+
"wait": {
|
|
829
825
|
"char": "w",
|
|
830
|
-
"
|
|
831
|
-
|
|
832
|
-
|
|
826
|
+
"exclusive": [
|
|
827
|
+
"async"
|
|
828
|
+
],
|
|
829
|
+
"name": "wait",
|
|
830
|
+
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
831
|
+
"default": "0 minutes",
|
|
832
|
+
"hasDynamicHelp": true,
|
|
833
833
|
"multiple": false,
|
|
834
834
|
"type": "option"
|
|
835
835
|
},
|
|
836
|
-
"
|
|
837
|
-
"
|
|
838
|
-
|
|
836
|
+
"async": {
|
|
837
|
+
"char": "a",
|
|
838
|
+
"deprecated": true,
|
|
839
|
+
"exclusive": [
|
|
840
|
+
"wait"
|
|
839
841
|
],
|
|
840
|
-
"
|
|
841
|
-
"
|
|
842
|
-
"name": "use-tooling-api",
|
|
843
|
-
"summary": "Use Tooling API so you can retrieve a record from a Tooling API object.",
|
|
842
|
+
"name": "async",
|
|
843
|
+
"summary": "Run the command asynchronously.",
|
|
844
844
|
"allowNo": false,
|
|
845
845
|
"type": "boolean"
|
|
846
846
|
},
|
|
847
|
-
"
|
|
848
|
-
"
|
|
849
|
-
"
|
|
850
|
-
|
|
851
|
-
"
|
|
852
|
-
"
|
|
853
|
-
"
|
|
854
|
-
"
|
|
847
|
+
"line-ending": {
|
|
848
|
+
"dependsOn": [
|
|
849
|
+
"file"
|
|
850
|
+
],
|
|
851
|
+
"name": "line-ending",
|
|
852
|
+
"summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LF`.",
|
|
853
|
+
"hasDynamicHelp": false,
|
|
854
|
+
"multiple": false,
|
|
855
|
+
"options": [
|
|
856
|
+
"CRLF",
|
|
857
|
+
"LF"
|
|
858
|
+
],
|
|
859
|
+
"type": "option"
|
|
860
|
+
},
|
|
861
|
+
"hard-delete": {
|
|
862
|
+
"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.",
|
|
863
|
+
"name": "hard-delete",
|
|
864
|
+
"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.",
|
|
855
865
|
"allowNo": false,
|
|
856
866
|
"type": "boolean"
|
|
857
867
|
}
|
|
858
868
|
},
|
|
859
869
|
"hasDynamicHelp": true,
|
|
860
870
|
"hiddenAliases": [],
|
|
861
|
-
"id": "data:
|
|
871
|
+
"id": "data:delete:bulk",
|
|
862
872
|
"pluginAlias": "@salesforce/plugin-data",
|
|
863
873
|
"pluginName": "@salesforce/plugin-data",
|
|
864
874
|
"pluginType": "core",
|
|
865
875
|
"strict": true,
|
|
866
|
-
"summary": "
|
|
876
|
+
"summary": "Bulk delete records from an org using a CSV file. Uses Bulk API 2.0.",
|
|
867
877
|
"enableJsonFlag": true,
|
|
868
878
|
"isESM": true,
|
|
869
879
|
"relativePath": [
|
|
870
880
|
"lib",
|
|
871
881
|
"commands",
|
|
872
882
|
"data",
|
|
873
|
-
"
|
|
874
|
-
"
|
|
875
|
-
],
|
|
876
|
-
"aliasPermutations": [
|
|
877
|
-
"force:data:record:get",
|
|
878
|
-
"data:force:record:get",
|
|
879
|
-
"data:record:force:get",
|
|
880
|
-
"data:record:get:force",
|
|
881
|
-
"force:record:data:get",
|
|
882
|
-
"record:force:data:get",
|
|
883
|
-
"record:data:force:get",
|
|
884
|
-
"record:data:get:force",
|
|
885
|
-
"force:record:get:data",
|
|
886
|
-
"record:force:get:data",
|
|
887
|
-
"record:get:force:data",
|
|
888
|
-
"record:get:data:force",
|
|
889
|
-
"force:data:get:record",
|
|
890
|
-
"data:force:get:record",
|
|
891
|
-
"data:get:force:record",
|
|
892
|
-
"data:get:record:force",
|
|
893
|
-
"force:get:data:record",
|
|
894
|
-
"get:force:data:record",
|
|
895
|
-
"get:data:force:record",
|
|
896
|
-
"get:data:record:force",
|
|
897
|
-
"force:get:record:data",
|
|
898
|
-
"get:force:record:data",
|
|
899
|
-
"get:record:force:data",
|
|
900
|
-
"get:record:data:force"
|
|
883
|
+
"delete",
|
|
884
|
+
"bulk.js"
|
|
901
885
|
],
|
|
886
|
+
"aliasPermutations": [],
|
|
902
887
|
"permutations": [
|
|
903
|
-
"data:
|
|
904
|
-
"
|
|
905
|
-
"
|
|
906
|
-
"data:
|
|
907
|
-
"
|
|
908
|
-
"
|
|
888
|
+
"data:delete:bulk",
|
|
889
|
+
"delete:data:bulk",
|
|
890
|
+
"delete:bulk:data",
|
|
891
|
+
"data:bulk:delete",
|
|
892
|
+
"bulk:data:delete",
|
|
893
|
+
"bulk:delete:data"
|
|
909
894
|
]
|
|
910
895
|
},
|
|
911
|
-
"data:
|
|
912
|
-
"aliases": [
|
|
896
|
+
"data:delete:record": {
|
|
897
|
+
"aliases": [
|
|
898
|
+
"force:data:record:delete"
|
|
899
|
+
],
|
|
913
900
|
"args": {},
|
|
914
|
-
"
|
|
901
|
+
"deprecateAliases": true,
|
|
902
|
+
"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.",
|
|
915
903
|
"examples": [
|
|
916
|
-
"
|
|
917
|
-
"
|
|
918
|
-
"
|
|
904
|
+
"Delete a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX",
|
|
905
|
+
"Delete a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name=Acme\"",
|
|
906
|
+
"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",
|
|
907
|
+
"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"
|
|
919
908
|
],
|
|
920
909
|
"flags": {
|
|
921
910
|
"json": {
|
|
@@ -934,7 +923,12 @@
|
|
|
934
923
|
"type": "option"
|
|
935
924
|
},
|
|
936
925
|
"target-org": {
|
|
926
|
+
"aliases": [
|
|
927
|
+
"targetusername",
|
|
928
|
+
"u"
|
|
929
|
+
],
|
|
937
930
|
"char": "o",
|
|
931
|
+
"deprecateAliases": true,
|
|
938
932
|
"name": "target-org",
|
|
939
933
|
"noCacheDefault": true,
|
|
940
934
|
"required": true,
|
|
@@ -944,92 +938,369 @@
|
|
|
944
938
|
"type": "option"
|
|
945
939
|
},
|
|
946
940
|
"api-version": {
|
|
941
|
+
"aliases": [
|
|
942
|
+
"apiversion"
|
|
943
|
+
],
|
|
944
|
+
"deprecateAliases": true,
|
|
947
945
|
"description": "Override the api version used for api requests made by this command",
|
|
948
946
|
"name": "api-version",
|
|
949
947
|
"hasDynamicHelp": false,
|
|
950
948
|
"multiple": false,
|
|
951
949
|
"type": "option"
|
|
952
950
|
},
|
|
953
|
-
"
|
|
954
|
-
"
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
"name": "
|
|
959
|
-
"
|
|
960
|
-
"hasDynamicHelp": true,
|
|
961
|
-
"helpValue": "<minutes>",
|
|
951
|
+
"loglevel": {
|
|
952
|
+
"deprecated": {
|
|
953
|
+
"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."
|
|
954
|
+
},
|
|
955
|
+
"hidden": true,
|
|
956
|
+
"name": "loglevel",
|
|
957
|
+
"hasDynamicHelp": false,
|
|
962
958
|
"multiple": false,
|
|
963
959
|
"type": "option"
|
|
964
960
|
},
|
|
965
|
-
"
|
|
966
|
-
"
|
|
967
|
-
|
|
968
|
-
"wait"
|
|
969
|
-
],
|
|
970
|
-
"name": "async",
|
|
971
|
-
"summary": "Don't wait for the job to complete.",
|
|
972
|
-
"allowNo": false,
|
|
973
|
-
"type": "boolean"
|
|
974
|
-
},
|
|
975
|
-
"query": {
|
|
976
|
-
"char": "q",
|
|
977
|
-
"exclusive": [
|
|
978
|
-
"query-file"
|
|
961
|
+
"sobject": {
|
|
962
|
+
"aliases": [
|
|
963
|
+
"sobjecttype"
|
|
979
964
|
],
|
|
980
|
-
"
|
|
981
|
-
"
|
|
965
|
+
"char": "s",
|
|
966
|
+
"deprecateAliases": true,
|
|
967
|
+
"name": "sobject",
|
|
968
|
+
"required": true,
|
|
969
|
+
"summary": "API name of the Salesforce or Tooling API object that you're deleting a record from.",
|
|
982
970
|
"hasDynamicHelp": false,
|
|
983
971
|
"multiple": false,
|
|
984
972
|
"type": "option"
|
|
985
973
|
},
|
|
986
|
-
"
|
|
987
|
-
"
|
|
988
|
-
"
|
|
974
|
+
"record-id": {
|
|
975
|
+
"aliases": [
|
|
976
|
+
"sobjectid"
|
|
989
977
|
],
|
|
990
|
-
"
|
|
991
|
-
"
|
|
978
|
+
"char": "i",
|
|
979
|
+
"deprecateAliases": true,
|
|
980
|
+
"name": "record-id",
|
|
981
|
+
"summary": "ID of the record you’re deleting.",
|
|
992
982
|
"hasDynamicHelp": false,
|
|
993
983
|
"multiple": false,
|
|
994
984
|
"type": "option"
|
|
995
985
|
},
|
|
996
|
-
"
|
|
997
|
-
"
|
|
998
|
-
"
|
|
999
|
-
"
|
|
1000
|
-
"type": "boolean"
|
|
1001
|
-
},
|
|
1002
|
-
"output-file": {
|
|
1003
|
-
"name": "output-file",
|
|
1004
|
-
"required": true,
|
|
1005
|
-
"summary": "File where records are written.",
|
|
986
|
+
"where": {
|
|
987
|
+
"char": "w",
|
|
988
|
+
"name": "where",
|
|
989
|
+
"summary": "List of <fieldName>=<value> pairs that identify the record you want to delete.",
|
|
1006
990
|
"hasDynamicHelp": false,
|
|
1007
991
|
"multiple": false,
|
|
1008
992
|
"type": "option"
|
|
1009
993
|
},
|
|
1010
|
-
"
|
|
1011
|
-
"
|
|
1012
|
-
|
|
1013
|
-
"required": true,
|
|
1014
|
-
"summary": "Format to write the results.",
|
|
1015
|
-
"default": "csv",
|
|
1016
|
-
"hasDynamicHelp": false,
|
|
1017
|
-
"multiple": false,
|
|
1018
|
-
"options": [
|
|
1019
|
-
"csv",
|
|
1020
|
-
"json"
|
|
994
|
+
"use-tooling-api": {
|
|
995
|
+
"aliases": [
|
|
996
|
+
"usetoolingapi"
|
|
1021
997
|
],
|
|
1022
|
-
"
|
|
998
|
+
"char": "t",
|
|
999
|
+
"deprecateAliases": true,
|
|
1000
|
+
"name": "use-tooling-api",
|
|
1001
|
+
"summary": "Use Tooling API so you can delete a record from a Tooling API object.",
|
|
1002
|
+
"allowNo": false,
|
|
1003
|
+
"type": "boolean"
|
|
1023
1004
|
},
|
|
1024
|
-
"
|
|
1025
|
-
"
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1005
|
+
"perflog": {
|
|
1006
|
+
"deprecated": {
|
|
1007
|
+
"version": "57"
|
|
1008
|
+
},
|
|
1009
|
+
"description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
|
|
1010
|
+
"hidden": true,
|
|
1011
|
+
"name": "perflog",
|
|
1012
|
+
"summary": "Get API performance data.",
|
|
1013
|
+
"allowNo": false,
|
|
1014
|
+
"type": "boolean"
|
|
1015
|
+
}
|
|
1016
|
+
},
|
|
1017
|
+
"hasDynamicHelp": true,
|
|
1018
|
+
"hiddenAliases": [],
|
|
1019
|
+
"id": "data:delete:record",
|
|
1020
|
+
"pluginAlias": "@salesforce/plugin-data",
|
|
1021
|
+
"pluginName": "@salesforce/plugin-data",
|
|
1022
|
+
"pluginType": "core",
|
|
1023
|
+
"strict": true,
|
|
1024
|
+
"summary": "Deletes a single record from a Salesforce or Tooling API object.",
|
|
1025
|
+
"enableJsonFlag": true,
|
|
1026
|
+
"isESM": true,
|
|
1027
|
+
"relativePath": [
|
|
1028
|
+
"lib",
|
|
1029
|
+
"commands",
|
|
1030
|
+
"data",
|
|
1031
|
+
"delete",
|
|
1032
|
+
"record.js"
|
|
1033
|
+
],
|
|
1034
|
+
"aliasPermutations": [
|
|
1035
|
+
"force:data:record:delete",
|
|
1036
|
+
"data:force:record:delete",
|
|
1037
|
+
"data:record:force:delete",
|
|
1038
|
+
"data:record:delete:force",
|
|
1039
|
+
"force:record:data:delete",
|
|
1040
|
+
"record:force:data:delete",
|
|
1041
|
+
"record:data:force:delete",
|
|
1042
|
+
"record:data:delete:force",
|
|
1043
|
+
"force:record:delete:data",
|
|
1044
|
+
"record:force:delete:data",
|
|
1045
|
+
"record:delete:force:data",
|
|
1046
|
+
"record:delete:data:force",
|
|
1047
|
+
"force:data:delete:record",
|
|
1048
|
+
"data:force:delete:record",
|
|
1049
|
+
"data:delete:force:record",
|
|
1050
|
+
"data:delete:record:force",
|
|
1051
|
+
"force:delete:data:record",
|
|
1052
|
+
"delete:force:data:record",
|
|
1053
|
+
"delete:data:force:record",
|
|
1054
|
+
"delete:data:record:force",
|
|
1055
|
+
"force:delete:record:data",
|
|
1056
|
+
"delete:force:record:data",
|
|
1057
|
+
"delete:record:force:data",
|
|
1058
|
+
"delete:record:data:force"
|
|
1059
|
+
],
|
|
1060
|
+
"permutations": [
|
|
1061
|
+
"data:delete:record",
|
|
1062
|
+
"delete:data:record",
|
|
1063
|
+
"delete:record:data",
|
|
1064
|
+
"data:record:delete",
|
|
1065
|
+
"record:data:delete",
|
|
1066
|
+
"record:delete:data"
|
|
1067
|
+
]
|
|
1068
|
+
},
|
|
1069
|
+
"data:delete:resume": {
|
|
1070
|
+
"aliases": [],
|
|
1071
|
+
"args": {},
|
|
1072
|
+
"deprecateAliases": true,
|
|
1073
|
+
"description": "The command uses the job ID returned by the \"<%= config.bin %> data delete bulk\" command or the most recently-run bulk delete job.",
|
|
1074
|
+
"examples": [
|
|
1075
|
+
"Resume a bulk delete job from your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
|
|
1076
|
+
"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"
|
|
1077
|
+
],
|
|
1078
|
+
"flags": {
|
|
1079
|
+
"json": {
|
|
1080
|
+
"description": "Format output as json.",
|
|
1081
|
+
"helpGroup": "GLOBAL",
|
|
1082
|
+
"name": "json",
|
|
1083
|
+
"allowNo": false,
|
|
1084
|
+
"type": "boolean"
|
|
1085
|
+
},
|
|
1086
|
+
"flags-dir": {
|
|
1087
|
+
"helpGroup": "GLOBAL",
|
|
1088
|
+
"name": "flags-dir",
|
|
1089
|
+
"summary": "Import flag values from a directory.",
|
|
1090
|
+
"hasDynamicHelp": false,
|
|
1091
|
+
"multiple": false,
|
|
1092
|
+
"type": "option"
|
|
1093
|
+
},
|
|
1094
|
+
"target-org": {
|
|
1095
|
+
"aliases": [
|
|
1096
|
+
"targetusername",
|
|
1097
|
+
"u"
|
|
1098
|
+
],
|
|
1099
|
+
"char": "o",
|
|
1100
|
+
"deprecateAliases": true,
|
|
1101
|
+
"name": "target-org",
|
|
1102
|
+
"noCacheDefault": true,
|
|
1103
|
+
"summary": "Username or alias of the target org. Not required if the \"target-org\" configuration variable is already set.",
|
|
1104
|
+
"hasDynamicHelp": true,
|
|
1105
|
+
"multiple": false,
|
|
1106
|
+
"type": "option"
|
|
1107
|
+
},
|
|
1108
|
+
"job-id": {
|
|
1109
|
+
"aliases": [
|
|
1110
|
+
"jobid"
|
|
1111
|
+
],
|
|
1112
|
+
"char": "i",
|
|
1113
|
+
"deprecateAliases": true,
|
|
1114
|
+
"name": "job-id",
|
|
1115
|
+
"summary": "ID of the job you want to resume.",
|
|
1116
|
+
"hasDynamicHelp": false,
|
|
1117
|
+
"multiple": false,
|
|
1118
|
+
"type": "option"
|
|
1119
|
+
},
|
|
1120
|
+
"use-most-recent": {
|
|
1121
|
+
"exclusive": [
|
|
1122
|
+
"job-id"
|
|
1123
|
+
],
|
|
1124
|
+
"name": "use-most-recent",
|
|
1125
|
+
"summary": "Use the ID of the most recently-run bulk job.",
|
|
1126
|
+
"allowNo": false,
|
|
1127
|
+
"type": "boolean"
|
|
1128
|
+
},
|
|
1129
|
+
"wait": {
|
|
1130
|
+
"name": "wait",
|
|
1131
|
+
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
1132
|
+
"default": "5 minutes",
|
|
1133
|
+
"hasDynamicHelp": true,
|
|
1134
|
+
"multiple": false,
|
|
1135
|
+
"type": "option"
|
|
1136
|
+
},
|
|
1137
|
+
"api-version": {
|
|
1138
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1139
|
+
"name": "api-version",
|
|
1140
|
+
"hasDynamicHelp": false,
|
|
1141
|
+
"multiple": false,
|
|
1142
|
+
"type": "option"
|
|
1143
|
+
},
|
|
1144
|
+
"loglevel": {
|
|
1145
|
+
"deprecated": {
|
|
1146
|
+
"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."
|
|
1147
|
+
},
|
|
1148
|
+
"hidden": true,
|
|
1149
|
+
"name": "loglevel",
|
|
1150
|
+
"hasDynamicHelp": false,
|
|
1151
|
+
"multiple": false,
|
|
1152
|
+
"type": "option"
|
|
1153
|
+
}
|
|
1154
|
+
},
|
|
1155
|
+
"hasDynamicHelp": true,
|
|
1156
|
+
"hiddenAliases": [],
|
|
1157
|
+
"id": "data:delete:resume",
|
|
1158
|
+
"pluginAlias": "@salesforce/plugin-data",
|
|
1159
|
+
"pluginName": "@salesforce/plugin-data",
|
|
1160
|
+
"pluginType": "core",
|
|
1161
|
+
"strict": true,
|
|
1162
|
+
"summary": "Resume a bulk delete job that you previously started. Uses Bulk API 2.0.",
|
|
1163
|
+
"enableJsonFlag": true,
|
|
1164
|
+
"isESM": true,
|
|
1165
|
+
"relativePath": [
|
|
1166
|
+
"lib",
|
|
1167
|
+
"commands",
|
|
1168
|
+
"data",
|
|
1169
|
+
"delete",
|
|
1170
|
+
"resume.js"
|
|
1171
|
+
],
|
|
1172
|
+
"aliasPermutations": [],
|
|
1173
|
+
"permutations": [
|
|
1174
|
+
"data:delete:resume",
|
|
1175
|
+
"delete:data:resume",
|
|
1176
|
+
"delete:resume:data",
|
|
1177
|
+
"data:resume:delete",
|
|
1178
|
+
"resume:data:delete",
|
|
1179
|
+
"resume:delete:data"
|
|
1180
|
+
]
|
|
1181
|
+
},
|
|
1182
|
+
"data:export:bulk": {
|
|
1183
|
+
"aliases": [],
|
|
1184
|
+
"args": {},
|
|
1185
|
+
"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, 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 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).",
|
|
1186
|
+
"examples": [
|
|
1187
|
+
"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",
|
|
1188
|
+
"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",
|
|
1189
|
+
"Export asynchronously; the command immediately returns a job ID that you then pass to the \"sf data export resume\" command:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id, Name, Account.Name FROM Contact\" --output-file export-accounts.json --result-format json --async"
|
|
1190
|
+
],
|
|
1191
|
+
"flags": {
|
|
1192
|
+
"json": {
|
|
1193
|
+
"description": "Format output as json.",
|
|
1194
|
+
"helpGroup": "GLOBAL",
|
|
1195
|
+
"name": "json",
|
|
1196
|
+
"allowNo": false,
|
|
1197
|
+
"type": "boolean"
|
|
1198
|
+
},
|
|
1199
|
+
"flags-dir": {
|
|
1200
|
+
"helpGroup": "GLOBAL",
|
|
1201
|
+
"name": "flags-dir",
|
|
1202
|
+
"summary": "Import flag values from a directory.",
|
|
1203
|
+
"hasDynamicHelp": false,
|
|
1204
|
+
"multiple": false,
|
|
1205
|
+
"type": "option"
|
|
1206
|
+
},
|
|
1207
|
+
"target-org": {
|
|
1208
|
+
"char": "o",
|
|
1209
|
+
"name": "target-org",
|
|
1210
|
+
"noCacheDefault": true,
|
|
1211
|
+
"required": true,
|
|
1212
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1213
|
+
"hasDynamicHelp": true,
|
|
1214
|
+
"multiple": false,
|
|
1215
|
+
"type": "option"
|
|
1216
|
+
},
|
|
1217
|
+
"api-version": {
|
|
1218
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1219
|
+
"name": "api-version",
|
|
1220
|
+
"hasDynamicHelp": false,
|
|
1221
|
+
"multiple": false,
|
|
1222
|
+
"type": "option"
|
|
1223
|
+
},
|
|
1224
|
+
"wait": {
|
|
1225
|
+
"char": "w",
|
|
1226
|
+
"exclusive": [
|
|
1227
|
+
"async"
|
|
1228
|
+
],
|
|
1229
|
+
"name": "wait",
|
|
1230
|
+
"summary": "Time to wait for the command to finish, in minutes.",
|
|
1231
|
+
"hasDynamicHelp": true,
|
|
1232
|
+
"helpValue": "<minutes>",
|
|
1233
|
+
"multiple": false,
|
|
1234
|
+
"type": "option"
|
|
1235
|
+
},
|
|
1236
|
+
"async": {
|
|
1237
|
+
"deprecated": true,
|
|
1238
|
+
"exclusive": [
|
|
1239
|
+
"wait"
|
|
1240
|
+
],
|
|
1241
|
+
"name": "async",
|
|
1242
|
+
"summary": "Don't wait for the job to complete.",
|
|
1243
|
+
"allowNo": false,
|
|
1244
|
+
"type": "boolean"
|
|
1245
|
+
},
|
|
1246
|
+
"query": {
|
|
1247
|
+
"char": "q",
|
|
1248
|
+
"exclusive": [
|
|
1249
|
+
"query-file"
|
|
1250
|
+
],
|
|
1251
|
+
"name": "query",
|
|
1252
|
+
"summary": "SOQL query to execute.",
|
|
1253
|
+
"hasDynamicHelp": false,
|
|
1254
|
+
"multiple": false,
|
|
1255
|
+
"type": "option"
|
|
1256
|
+
},
|
|
1257
|
+
"query-file": {
|
|
1258
|
+
"exclusive": [
|
|
1259
|
+
"query"
|
|
1260
|
+
],
|
|
1261
|
+
"name": "query-file",
|
|
1262
|
+
"summary": "File that contains the SOQL query.",
|
|
1263
|
+
"hasDynamicHelp": false,
|
|
1264
|
+
"multiple": false,
|
|
1265
|
+
"type": "option"
|
|
1266
|
+
},
|
|
1267
|
+
"all-rows": {
|
|
1268
|
+
"name": "all-rows",
|
|
1269
|
+
"summary": "Include records that have been soft-deleted due to a merge or delete. By default, deleted records are not returned.",
|
|
1270
|
+
"allowNo": false,
|
|
1271
|
+
"type": "boolean"
|
|
1272
|
+
},
|
|
1273
|
+
"output-file": {
|
|
1274
|
+
"name": "output-file",
|
|
1275
|
+
"required": true,
|
|
1276
|
+
"summary": "File where records are written.",
|
|
1277
|
+
"hasDynamicHelp": false,
|
|
1278
|
+
"multiple": false,
|
|
1279
|
+
"type": "option"
|
|
1280
|
+
},
|
|
1281
|
+
"result-format": {
|
|
1282
|
+
"char": "r",
|
|
1283
|
+
"name": "result-format",
|
|
1284
|
+
"required": true,
|
|
1285
|
+
"summary": "Format to write the results.",
|
|
1286
|
+
"default": "csv",
|
|
1287
|
+
"hasDynamicHelp": false,
|
|
1288
|
+
"multiple": false,
|
|
1289
|
+
"options": [
|
|
1290
|
+
"csv",
|
|
1291
|
+
"json"
|
|
1292
|
+
],
|
|
1293
|
+
"type": "option"
|
|
1294
|
+
},
|
|
1295
|
+
"column-delimiter": {
|
|
1296
|
+
"name": "column-delimiter",
|
|
1297
|
+
"relationships": [
|
|
1298
|
+
{
|
|
1299
|
+
"type": "some",
|
|
1300
|
+
"flags": [
|
|
1301
|
+
{
|
|
1302
|
+
"name": "result-format"
|
|
1303
|
+
}
|
|
1033
1304
|
]
|
|
1034
1305
|
}
|
|
1035
1306
|
],
|
|
@@ -1265,232 +1536,74 @@
|
|
|
1265
1536
|
"name": "output-dir",
|
|
1266
1537
|
"summary": "Directory in which to generate the JSON files; default is current directory.",
|
|
1267
1538
|
"hasDynamicHelp": false,
|
|
1268
|
-
"multiple": false,
|
|
1269
|
-
"type": "option"
|
|
1270
|
-
}
|
|
1271
|
-
},
|
|
1272
|
-
"hasDynamicHelp": true,
|
|
1273
|
-
"hiddenAliases": [],
|
|
1274
|
-
"id": "data:export:tree",
|
|
1275
|
-
"pluginAlias": "@salesforce/plugin-data",
|
|
1276
|
-
"pluginName": "@salesforce/plugin-data",
|
|
1277
|
-
"pluginType": "core",
|
|
1278
|
-
"strict": true,
|
|
1279
|
-
"summary": "Export data from an org into one or more JSON files.",
|
|
1280
|
-
"enableJsonFlag": true,
|
|
1281
|
-
"isESM": true,
|
|
1282
|
-
"relativePath": [
|
|
1283
|
-
"lib",
|
|
1284
|
-
"commands",
|
|
1285
|
-
"data",
|
|
1286
|
-
"export",
|
|
1287
|
-
"tree.js"
|
|
1288
|
-
],
|
|
1289
|
-
"aliasPermutations": [
|
|
1290
|
-
"force:data:tree:export",
|
|
1291
|
-
"data:force:tree:export",
|
|
1292
|
-
"data:tree:force:export",
|
|
1293
|
-
"data:tree:export:force",
|
|
1294
|
-
"force:tree:data:export",
|
|
1295
|
-
"tree:force:data:export",
|
|
1296
|
-
"tree:data:force:export",
|
|
1297
|
-
"tree:data:export:force",
|
|
1298
|
-
"force:tree:export:data",
|
|
1299
|
-
"tree:force:export:data",
|
|
1300
|
-
"tree:export:force:data",
|
|
1301
|
-
"tree:export:data:force",
|
|
1302
|
-
"force:data:export:tree",
|
|
1303
|
-
"data:force:export:tree",
|
|
1304
|
-
"data:export:force:tree",
|
|
1305
|
-
"data:export:tree:force",
|
|
1306
|
-
"force:export:data:tree",
|
|
1307
|
-
"export:force:data:tree",
|
|
1308
|
-
"export:data:force:tree",
|
|
1309
|
-
"export:data:tree:force",
|
|
1310
|
-
"force:export:tree:data",
|
|
1311
|
-
"export:force:tree:data",
|
|
1312
|
-
"export:tree:force:data",
|
|
1313
|
-
"export:tree:data:force"
|
|
1314
|
-
],
|
|
1315
|
-
"permutations": [
|
|
1316
|
-
"data:export:tree",
|
|
1317
|
-
"export:data:tree",
|
|
1318
|
-
"export:tree:data",
|
|
1319
|
-
"data:tree:export",
|
|
1320
|
-
"tree:data:export",
|
|
1321
|
-
"tree:export:data"
|
|
1322
|
-
]
|
|
1323
|
-
},
|
|
1324
|
-
"data:delete:bulk": {
|
|
1325
|
-
"aliases": [],
|
|
1326
|
-
"args": {},
|
|
1327
|
-
"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.",
|
|
1328
|
-
"examples": [
|
|
1329
|
-
"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",
|
|
1330
|
-
"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"
|
|
1331
|
-
],
|
|
1332
|
-
"flags": {
|
|
1333
|
-
"json": {
|
|
1334
|
-
"description": "Format output as json.",
|
|
1335
|
-
"helpGroup": "GLOBAL",
|
|
1336
|
-
"name": "json",
|
|
1337
|
-
"allowNo": false,
|
|
1338
|
-
"type": "boolean"
|
|
1339
|
-
},
|
|
1340
|
-
"flags-dir": {
|
|
1341
|
-
"helpGroup": "GLOBAL",
|
|
1342
|
-
"name": "flags-dir",
|
|
1343
|
-
"summary": "Import flag values from a directory.",
|
|
1344
|
-
"hasDynamicHelp": false,
|
|
1345
|
-
"multiple": false,
|
|
1346
|
-
"type": "option"
|
|
1347
|
-
},
|
|
1348
|
-
"target-org": {
|
|
1349
|
-
"aliases": [
|
|
1350
|
-
"targetusername",
|
|
1351
|
-
"u"
|
|
1352
|
-
],
|
|
1353
|
-
"char": "o",
|
|
1354
|
-
"deprecateAliases": true,
|
|
1355
|
-
"name": "target-org",
|
|
1356
|
-
"noCacheDefault": true,
|
|
1357
|
-
"required": true,
|
|
1358
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1359
|
-
"hasDynamicHelp": true,
|
|
1360
|
-
"multiple": false,
|
|
1361
|
-
"type": "option"
|
|
1362
|
-
},
|
|
1363
|
-
"api-version": {
|
|
1364
|
-
"aliases": [
|
|
1365
|
-
"apiversion"
|
|
1366
|
-
],
|
|
1367
|
-
"deprecateAliases": true,
|
|
1368
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1369
|
-
"name": "api-version",
|
|
1370
|
-
"hasDynamicHelp": false,
|
|
1371
|
-
"multiple": false,
|
|
1372
|
-
"type": "option"
|
|
1373
|
-
},
|
|
1374
|
-
"loglevel": {
|
|
1375
|
-
"deprecated": {
|
|
1376
|
-
"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."
|
|
1377
|
-
},
|
|
1378
|
-
"hidden": true,
|
|
1379
|
-
"name": "loglevel",
|
|
1380
|
-
"hasDynamicHelp": false,
|
|
1381
|
-
"multiple": false,
|
|
1382
|
-
"type": "option"
|
|
1383
|
-
},
|
|
1384
|
-
"file": {
|
|
1385
|
-
"aliases": [
|
|
1386
|
-
"csvfile"
|
|
1387
|
-
],
|
|
1388
|
-
"char": "f",
|
|
1389
|
-
"deprecateAliases": true,
|
|
1390
|
-
"name": "file",
|
|
1391
|
-
"required": true,
|
|
1392
|
-
"summary": "CSV file that contains the IDs of the records to update or delete.",
|
|
1393
|
-
"hasDynamicHelp": false,
|
|
1394
|
-
"multiple": false,
|
|
1395
|
-
"type": "option"
|
|
1396
|
-
},
|
|
1397
|
-
"sobject": {
|
|
1398
|
-
"aliases": [
|
|
1399
|
-
"sobjecttype"
|
|
1400
|
-
],
|
|
1401
|
-
"char": "s",
|
|
1402
|
-
"deprecateAliases": true,
|
|
1403
|
-
"name": "sobject",
|
|
1404
|
-
"required": true,
|
|
1405
|
-
"summary": "API name of the Salesforce object, either standard or custom, that you want to update or delete records from.",
|
|
1406
|
-
"hasDynamicHelp": false,
|
|
1407
|
-
"multiple": false,
|
|
1408
|
-
"type": "option"
|
|
1409
|
-
},
|
|
1410
|
-
"wait": {
|
|
1411
|
-
"char": "w",
|
|
1412
|
-
"exclusive": [
|
|
1413
|
-
"async"
|
|
1414
|
-
],
|
|
1415
|
-
"name": "wait",
|
|
1416
|
-
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
1417
|
-
"default": "0 minutes",
|
|
1418
|
-
"hasDynamicHelp": true,
|
|
1419
|
-
"multiple": false,
|
|
1420
|
-
"type": "option"
|
|
1421
|
-
},
|
|
1422
|
-
"async": {
|
|
1423
|
-
"char": "a",
|
|
1424
|
-
"deprecated": true,
|
|
1425
|
-
"exclusive": [
|
|
1426
|
-
"wait"
|
|
1427
|
-
],
|
|
1428
|
-
"name": "async",
|
|
1429
|
-
"summary": "Run the command asynchronously.",
|
|
1430
|
-
"allowNo": false,
|
|
1431
|
-
"type": "boolean"
|
|
1432
|
-
},
|
|
1433
|
-
"line-ending": {
|
|
1434
|
-
"dependsOn": [
|
|
1435
|
-
"file"
|
|
1436
|
-
],
|
|
1437
|
-
"name": "line-ending",
|
|
1438
|
-
"summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LF`.",
|
|
1439
|
-
"hasDynamicHelp": false,
|
|
1440
|
-
"multiple": false,
|
|
1441
|
-
"options": [
|
|
1442
|
-
"CRLF",
|
|
1443
|
-
"LF"
|
|
1444
|
-
],
|
|
1539
|
+
"multiple": false,
|
|
1445
1540
|
"type": "option"
|
|
1446
|
-
},
|
|
1447
|
-
"hard-delete": {
|
|
1448
|
-
"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.",
|
|
1449
|
-
"name": "hard-delete",
|
|
1450
|
-
"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.",
|
|
1451
|
-
"allowNo": false,
|
|
1452
|
-
"type": "boolean"
|
|
1453
1541
|
}
|
|
1454
1542
|
},
|
|
1455
1543
|
"hasDynamicHelp": true,
|
|
1456
1544
|
"hiddenAliases": [],
|
|
1457
|
-
"id": "data:
|
|
1545
|
+
"id": "data:export:tree",
|
|
1458
1546
|
"pluginAlias": "@salesforce/plugin-data",
|
|
1459
1547
|
"pluginName": "@salesforce/plugin-data",
|
|
1460
1548
|
"pluginType": "core",
|
|
1461
1549
|
"strict": true,
|
|
1462
|
-
"summary": "
|
|
1550
|
+
"summary": "Export data from an org into one or more JSON files.",
|
|
1463
1551
|
"enableJsonFlag": true,
|
|
1464
1552
|
"isESM": true,
|
|
1465
1553
|
"relativePath": [
|
|
1466
1554
|
"lib",
|
|
1467
1555
|
"commands",
|
|
1468
1556
|
"data",
|
|
1469
|
-
"
|
|
1470
|
-
"
|
|
1557
|
+
"export",
|
|
1558
|
+
"tree.js"
|
|
1559
|
+
],
|
|
1560
|
+
"aliasPermutations": [
|
|
1561
|
+
"force:data:tree:export",
|
|
1562
|
+
"data:force:tree:export",
|
|
1563
|
+
"data:tree:force:export",
|
|
1564
|
+
"data:tree:export:force",
|
|
1565
|
+
"force:tree:data:export",
|
|
1566
|
+
"tree:force:data:export",
|
|
1567
|
+
"tree:data:force:export",
|
|
1568
|
+
"tree:data:export:force",
|
|
1569
|
+
"force:tree:export:data",
|
|
1570
|
+
"tree:force:export:data",
|
|
1571
|
+
"tree:export:force:data",
|
|
1572
|
+
"tree:export:data:force",
|
|
1573
|
+
"force:data:export:tree",
|
|
1574
|
+
"data:force:export:tree",
|
|
1575
|
+
"data:export:force:tree",
|
|
1576
|
+
"data:export:tree:force",
|
|
1577
|
+
"force:export:data:tree",
|
|
1578
|
+
"export:force:data:tree",
|
|
1579
|
+
"export:data:force:tree",
|
|
1580
|
+
"export:data:tree:force",
|
|
1581
|
+
"force:export:tree:data",
|
|
1582
|
+
"export:force:tree:data",
|
|
1583
|
+
"export:tree:force:data",
|
|
1584
|
+
"export:tree:data:force"
|
|
1471
1585
|
],
|
|
1472
|
-
"aliasPermutations": [],
|
|
1473
1586
|
"permutations": [
|
|
1474
|
-
"data:
|
|
1475
|
-
"
|
|
1476
|
-
"
|
|
1477
|
-
"data:
|
|
1478
|
-
"
|
|
1479
|
-
"
|
|
1587
|
+
"data:export:tree",
|
|
1588
|
+
"export:data:tree",
|
|
1589
|
+
"export:tree:data",
|
|
1590
|
+
"data:tree:export",
|
|
1591
|
+
"tree:data:export",
|
|
1592
|
+
"tree:export:data"
|
|
1480
1593
|
]
|
|
1481
1594
|
},
|
|
1482
|
-
"data:
|
|
1595
|
+
"data:get:record": {
|
|
1483
1596
|
"aliases": [
|
|
1484
|
-
"force:data:record:
|
|
1597
|
+
"force:data:record:get"
|
|
1485
1598
|
],
|
|
1486
1599
|
"args": {},
|
|
1487
1600
|
"deprecateAliases": true,
|
|
1488
|
-
"description": "Specify the record you want to
|
|
1601
|
+
"description": "Specify the record you want to retrieve 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 command 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\nThe command displays all the record's fields and their values, one field per terminal line. Fields with no values are displayed as \"null\".\n\nThis command retrieves a record from Salesforce objects by default. Use the --use-tooling-api flag to retrieve from a Tooling API object.",
|
|
1489
1602
|
"examples": [
|
|
1490
|
-
"
|
|
1491
|
-
"
|
|
1492
|
-
"
|
|
1493
|
-
"
|
|
1603
|
+
"Retrieve and display a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX",
|
|
1604
|
+
"Retrieve a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name=Acme\"",
|
|
1605
|
+
"Retrieve 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",
|
|
1606
|
+
"Retrieve 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"
|
|
1494
1607
|
],
|
|
1495
1608
|
"flags": {
|
|
1496
1609
|
"json": {
|
|
@@ -1552,7 +1665,7 @@
|
|
|
1552
1665
|
"deprecateAliases": true,
|
|
1553
1666
|
"name": "sobject",
|
|
1554
1667
|
"required": true,
|
|
1555
|
-
"summary": "API name of the Salesforce or Tooling API object that you're
|
|
1668
|
+
"summary": "API name of the Salesforce or Tooling API object that you're retrieving a record from.",
|
|
1556
1669
|
"hasDynamicHelp": false,
|
|
1557
1670
|
"multiple": false,
|
|
1558
1671
|
"type": "option"
|
|
@@ -1564,7 +1677,7 @@
|
|
|
1564
1677
|
"char": "i",
|
|
1565
1678
|
"deprecateAliases": true,
|
|
1566
1679
|
"name": "record-id",
|
|
1567
|
-
"summary": "ID of the record you’re
|
|
1680
|
+
"summary": "ID of the record you’re retrieving.",
|
|
1568
1681
|
"hasDynamicHelp": false,
|
|
1569
1682
|
"multiple": false,
|
|
1570
1683
|
"type": "option"
|
|
@@ -1572,7 +1685,7 @@
|
|
|
1572
1685
|
"where": {
|
|
1573
1686
|
"char": "w",
|
|
1574
1687
|
"name": "where",
|
|
1575
|
-
"summary": "List of <fieldName>=<value> pairs that identify the record you want to
|
|
1688
|
+
"summary": "List of <fieldName>=<value> pairs that identify the record you want to display.",
|
|
1576
1689
|
"hasDynamicHelp": false,
|
|
1577
1690
|
"multiple": false,
|
|
1578
1691
|
"type": "option"
|
|
@@ -1584,7 +1697,7 @@
|
|
|
1584
1697
|
"char": "t",
|
|
1585
1698
|
"deprecateAliases": true,
|
|
1586
1699
|
"name": "use-tooling-api",
|
|
1587
|
-
"summary": "Use Tooling API so you can
|
|
1700
|
+
"summary": "Use Tooling API so you can retrieve a record from a Tooling API object.",
|
|
1588
1701
|
"allowNo": false,
|
|
1589
1702
|
"type": "boolean"
|
|
1590
1703
|
},
|
|
@@ -1602,167 +1715,54 @@
|
|
|
1602
1715
|
},
|
|
1603
1716
|
"hasDynamicHelp": true,
|
|
1604
1717
|
"hiddenAliases": [],
|
|
1605
|
-
"id": "data:
|
|
1718
|
+
"id": "data:get:record",
|
|
1606
1719
|
"pluginAlias": "@salesforce/plugin-data",
|
|
1607
1720
|
"pluginName": "@salesforce/plugin-data",
|
|
1608
1721
|
"pluginType": "core",
|
|
1609
1722
|
"strict": true,
|
|
1610
|
-
"summary": "
|
|
1723
|
+
"summary": "Retrieve and display a single record of a Salesforce or Tooling API object.",
|
|
1611
1724
|
"enableJsonFlag": true,
|
|
1612
1725
|
"isESM": true,
|
|
1613
1726
|
"relativePath": [
|
|
1614
1727
|
"lib",
|
|
1615
1728
|
"commands",
|
|
1616
1729
|
"data",
|
|
1617
|
-
"
|
|
1730
|
+
"get",
|
|
1618
1731
|
"record.js"
|
|
1619
1732
|
],
|
|
1620
1733
|
"aliasPermutations": [
|
|
1621
|
-
"force:data:record:
|
|
1622
|
-
"data:force:record:
|
|
1623
|
-
"data:record:force:
|
|
1624
|
-
"data:record:
|
|
1625
|
-
"force:record:data:
|
|
1626
|
-
"record:force:data:
|
|
1627
|
-
"record:data:force:
|
|
1628
|
-
"record:data:
|
|
1629
|
-
"force:record:
|
|
1630
|
-
"record:force:
|
|
1631
|
-
"record:
|
|
1632
|
-
"record:
|
|
1633
|
-
"force:data:
|
|
1634
|
-
"data:force:
|
|
1635
|
-
"data:
|
|
1636
|
-
"data:
|
|
1637
|
-
"force:
|
|
1638
|
-
"
|
|
1639
|
-
"
|
|
1640
|
-
"
|
|
1641
|
-
"force:
|
|
1642
|
-
"
|
|
1643
|
-
"
|
|
1644
|
-
"
|
|
1645
|
-
],
|
|
1646
|
-
"permutations": [
|
|
1647
|
-
"data:delete:record",
|
|
1648
|
-
"delete:data:record",
|
|
1649
|
-
"delete:record:data",
|
|
1650
|
-
"data:record:delete",
|
|
1651
|
-
"record:data:delete",
|
|
1652
|
-
"record:delete:data"
|
|
1653
|
-
]
|
|
1654
|
-
},
|
|
1655
|
-
"data:delete:resume": {
|
|
1656
|
-
"aliases": [],
|
|
1657
|
-
"args": {},
|
|
1658
|
-
"deprecateAliases": true,
|
|
1659
|
-
"description": "The command uses the job ID returned by the \"<%= config.bin %> data delete bulk\" command or the most recently-run bulk delete job.",
|
|
1660
|
-
"examples": [
|
|
1661
|
-
"Resume a bulk delete job from your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
|
|
1662
|
-
"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"
|
|
1663
|
-
],
|
|
1664
|
-
"flags": {
|
|
1665
|
-
"json": {
|
|
1666
|
-
"description": "Format output as json.",
|
|
1667
|
-
"helpGroup": "GLOBAL",
|
|
1668
|
-
"name": "json",
|
|
1669
|
-
"allowNo": false,
|
|
1670
|
-
"type": "boolean"
|
|
1671
|
-
},
|
|
1672
|
-
"flags-dir": {
|
|
1673
|
-
"helpGroup": "GLOBAL",
|
|
1674
|
-
"name": "flags-dir",
|
|
1675
|
-
"summary": "Import flag values from a directory.",
|
|
1676
|
-
"hasDynamicHelp": false,
|
|
1677
|
-
"multiple": false,
|
|
1678
|
-
"type": "option"
|
|
1679
|
-
},
|
|
1680
|
-
"target-org": {
|
|
1681
|
-
"aliases": [
|
|
1682
|
-
"targetusername",
|
|
1683
|
-
"u"
|
|
1684
|
-
],
|
|
1685
|
-
"char": "o",
|
|
1686
|
-
"deprecateAliases": true,
|
|
1687
|
-
"name": "target-org",
|
|
1688
|
-
"noCacheDefault": true,
|
|
1689
|
-
"summary": "Username or alias of the target org. Not required if the \"target-org\" configuration variable is already set.",
|
|
1690
|
-
"hasDynamicHelp": true,
|
|
1691
|
-
"multiple": false,
|
|
1692
|
-
"type": "option"
|
|
1693
|
-
},
|
|
1694
|
-
"job-id": {
|
|
1695
|
-
"aliases": [
|
|
1696
|
-
"jobid"
|
|
1697
|
-
],
|
|
1698
|
-
"char": "i",
|
|
1699
|
-
"deprecateAliases": true,
|
|
1700
|
-
"name": "job-id",
|
|
1701
|
-
"summary": "ID of the job you want to resume.",
|
|
1702
|
-
"hasDynamicHelp": false,
|
|
1703
|
-
"multiple": false,
|
|
1704
|
-
"type": "option"
|
|
1705
|
-
},
|
|
1706
|
-
"use-most-recent": {
|
|
1707
|
-
"exclusive": [
|
|
1708
|
-
"job-id"
|
|
1709
|
-
],
|
|
1710
|
-
"name": "use-most-recent",
|
|
1711
|
-
"summary": "Use the ID of the most recently-run bulk job.",
|
|
1712
|
-
"allowNo": false,
|
|
1713
|
-
"type": "boolean"
|
|
1714
|
-
},
|
|
1715
|
-
"wait": {
|
|
1716
|
-
"name": "wait",
|
|
1717
|
-
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
1718
|
-
"default": "5 minutes",
|
|
1719
|
-
"hasDynamicHelp": true,
|
|
1720
|
-
"multiple": false,
|
|
1721
|
-
"type": "option"
|
|
1722
|
-
},
|
|
1723
|
-
"api-version": {
|
|
1724
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1725
|
-
"name": "api-version",
|
|
1726
|
-
"hasDynamicHelp": false,
|
|
1727
|
-
"multiple": false,
|
|
1728
|
-
"type": "option"
|
|
1729
|
-
},
|
|
1730
|
-
"loglevel": {
|
|
1731
|
-
"deprecated": {
|
|
1732
|
-
"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."
|
|
1733
|
-
},
|
|
1734
|
-
"hidden": true,
|
|
1735
|
-
"name": "loglevel",
|
|
1736
|
-
"hasDynamicHelp": false,
|
|
1737
|
-
"multiple": false,
|
|
1738
|
-
"type": "option"
|
|
1739
|
-
}
|
|
1740
|
-
},
|
|
1741
|
-
"hasDynamicHelp": true,
|
|
1742
|
-
"hiddenAliases": [],
|
|
1743
|
-
"id": "data:delete:resume",
|
|
1744
|
-
"pluginAlias": "@salesforce/plugin-data",
|
|
1745
|
-
"pluginName": "@salesforce/plugin-data",
|
|
1746
|
-
"pluginType": "core",
|
|
1747
|
-
"strict": true,
|
|
1748
|
-
"summary": "Resume a bulk delete job that you previously started. Uses Bulk API 2.0.",
|
|
1749
|
-
"enableJsonFlag": true,
|
|
1750
|
-
"isESM": true,
|
|
1751
|
-
"relativePath": [
|
|
1752
|
-
"lib",
|
|
1753
|
-
"commands",
|
|
1754
|
-
"data",
|
|
1755
|
-
"delete",
|
|
1756
|
-
"resume.js"
|
|
1734
|
+
"force:data:record:get",
|
|
1735
|
+
"data:force:record:get",
|
|
1736
|
+
"data:record:force:get",
|
|
1737
|
+
"data:record:get:force",
|
|
1738
|
+
"force:record:data:get",
|
|
1739
|
+
"record:force:data:get",
|
|
1740
|
+
"record:data:force:get",
|
|
1741
|
+
"record:data:get:force",
|
|
1742
|
+
"force:record:get:data",
|
|
1743
|
+
"record:force:get:data",
|
|
1744
|
+
"record:get:force:data",
|
|
1745
|
+
"record:get:data:force",
|
|
1746
|
+
"force:data:get:record",
|
|
1747
|
+
"data:force:get:record",
|
|
1748
|
+
"data:get:force:record",
|
|
1749
|
+
"data:get:record:force",
|
|
1750
|
+
"force:get:data:record",
|
|
1751
|
+
"get:force:data:record",
|
|
1752
|
+
"get:data:force:record",
|
|
1753
|
+
"get:data:record:force",
|
|
1754
|
+
"force:get:record:data",
|
|
1755
|
+
"get:force:record:data",
|
|
1756
|
+
"get:record:force:data",
|
|
1757
|
+
"get:record:data:force"
|
|
1757
1758
|
],
|
|
1758
|
-
"aliasPermutations": [],
|
|
1759
1759
|
"permutations": [
|
|
1760
|
-
"data:
|
|
1761
|
-
"
|
|
1762
|
-
"
|
|
1763
|
-
"data:
|
|
1764
|
-
"
|
|
1765
|
-
"
|
|
1760
|
+
"data:get:record",
|
|
1761
|
+
"get:data:record",
|
|
1762
|
+
"get:record:data",
|
|
1763
|
+
"data:record:get",
|
|
1764
|
+
"record:data:get",
|
|
1765
|
+
"record:get:data"
|
|
1766
1766
|
]
|
|
1767
1767
|
},
|
|
1768
1768
|
"data:import:bulk": {
|
|
@@ -3232,5 +3232,5 @@
|
|
|
3232
3232
|
]
|
|
3233
3233
|
}
|
|
3234
3234
|
},
|
|
3235
|
-
"version": "4.0.
|
|
3235
|
+
"version": "4.0.34"
|
|
3236
3236
|
}
|