@salesforce/plugin-data 4.0.31 → 4.0.33
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/lib/bulkIngest.js +6 -16
- package/lib/bulkIngest.js.map +1 -1
- package/oclif.manifest.json +485 -485
- package/package.json +4 -4
package/oclif.manifest.json
CHANGED
|
@@ -735,13 +735,18 @@
|
|
|
735
735
|
"record:create:data"
|
|
736
736
|
]
|
|
737
737
|
},
|
|
738
|
-
"data:
|
|
739
|
-
"aliases": [
|
|
738
|
+
"data:get:record": {
|
|
739
|
+
"aliases": [
|
|
740
|
+
"force:data:record:get"
|
|
741
|
+
],
|
|
740
742
|
"args": {},
|
|
741
|
-
"
|
|
743
|
+
"deprecateAliases": true,
|
|
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.",
|
|
742
745
|
"examples": [
|
|
743
|
-
"
|
|
744
|
-
"
|
|
746
|
+
"Retrieve and display a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX",
|
|
747
|
+
"Retrieve a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name=Acme\"",
|
|
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"
|
|
745
750
|
],
|
|
746
751
|
"flags": {
|
|
747
752
|
"json": {
|
|
@@ -795,116 +800,122 @@
|
|
|
795
800
|
"multiple": false,
|
|
796
801
|
"type": "option"
|
|
797
802
|
},
|
|
798
|
-
"
|
|
803
|
+
"sobject": {
|
|
799
804
|
"aliases": [
|
|
800
|
-
"
|
|
805
|
+
"sobjecttype"
|
|
801
806
|
],
|
|
802
|
-
"char": "
|
|
807
|
+
"char": "s",
|
|
803
808
|
"deprecateAliases": true,
|
|
804
|
-
"name": "
|
|
809
|
+
"name": "sobject",
|
|
805
810
|
"required": true,
|
|
806
|
-
"summary": "
|
|
811
|
+
"summary": "API name of the Salesforce or Tooling API object that you're retrieving a record from.",
|
|
807
812
|
"hasDynamicHelp": false,
|
|
808
813
|
"multiple": false,
|
|
809
814
|
"type": "option"
|
|
810
815
|
},
|
|
811
|
-
"
|
|
816
|
+
"record-id": {
|
|
812
817
|
"aliases": [
|
|
813
|
-
"
|
|
818
|
+
"sobjectid"
|
|
814
819
|
],
|
|
815
|
-
"char": "
|
|
820
|
+
"char": "i",
|
|
816
821
|
"deprecateAliases": true,
|
|
817
|
-
"name": "
|
|
818
|
-
"
|
|
819
|
-
"summary": "API name of the Salesforce object, either standard or custom, that you want to update or delete records from.",
|
|
822
|
+
"name": "record-id",
|
|
823
|
+
"summary": "ID of the record you’re retrieving.",
|
|
820
824
|
"hasDynamicHelp": false,
|
|
821
825
|
"multiple": false,
|
|
822
826
|
"type": "option"
|
|
823
827
|
},
|
|
824
|
-
"
|
|
828
|
+
"where": {
|
|
825
829
|
"char": "w",
|
|
826
|
-
"
|
|
827
|
-
|
|
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,
|
|
830
|
+
"name": "where",
|
|
831
|
+
"summary": "List of <fieldName>=<value> pairs that identify the record you want to display.",
|
|
832
|
+
"hasDynamicHelp": false,
|
|
833
833
|
"multiple": false,
|
|
834
834
|
"type": "option"
|
|
835
835
|
},
|
|
836
|
-
"
|
|
837
|
-
"
|
|
838
|
-
|
|
839
|
-
"exclusive": [
|
|
840
|
-
"wait"
|
|
836
|
+
"use-tooling-api": {
|
|
837
|
+
"aliases": [
|
|
838
|
+
"usetoolingapi"
|
|
841
839
|
],
|
|
842
|
-
"
|
|
843
|
-
"
|
|
840
|
+
"char": "t",
|
|
841
|
+
"deprecateAliases": true,
|
|
842
|
+
"name": "use-tooling-api",
|
|
843
|
+
"summary": "Use Tooling API so you can retrieve a record from a Tooling API object.",
|
|
844
844
|
"allowNo": false,
|
|
845
845
|
"type": "boolean"
|
|
846
846
|
},
|
|
847
|
-
"
|
|
848
|
-
"
|
|
849
|
-
"
|
|
850
|
-
|
|
851
|
-
"
|
|
852
|
-
"
|
|
853
|
-
"
|
|
854
|
-
"
|
|
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.",
|
|
847
|
+
"perflog": {
|
|
848
|
+
"deprecated": {
|
|
849
|
+
"version": "57"
|
|
850
|
+
},
|
|
851
|
+
"description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
|
|
852
|
+
"hidden": true,
|
|
853
|
+
"name": "perflog",
|
|
854
|
+
"summary": "Get API performance data.",
|
|
865
855
|
"allowNo": false,
|
|
866
856
|
"type": "boolean"
|
|
867
857
|
}
|
|
868
858
|
},
|
|
869
859
|
"hasDynamicHelp": true,
|
|
870
860
|
"hiddenAliases": [],
|
|
871
|
-
"id": "data:
|
|
861
|
+
"id": "data:get:record",
|
|
872
862
|
"pluginAlias": "@salesforce/plugin-data",
|
|
873
863
|
"pluginName": "@salesforce/plugin-data",
|
|
874
864
|
"pluginType": "core",
|
|
875
865
|
"strict": true,
|
|
876
|
-
"summary": "
|
|
866
|
+
"summary": "Retrieve and display a single record of a Salesforce or Tooling API object.",
|
|
877
867
|
"enableJsonFlag": true,
|
|
878
868
|
"isESM": true,
|
|
879
869
|
"relativePath": [
|
|
880
870
|
"lib",
|
|
881
871
|
"commands",
|
|
882
872
|
"data",
|
|
883
|
-
"
|
|
884
|
-
"
|
|
873
|
+
"get",
|
|
874
|
+
"record.js"
|
|
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"
|
|
885
901
|
],
|
|
886
|
-
"aliasPermutations": [],
|
|
887
902
|
"permutations": [
|
|
888
|
-
"data:
|
|
889
|
-
"
|
|
890
|
-
"
|
|
891
|
-
"data:
|
|
892
|
-
"
|
|
893
|
-
"
|
|
903
|
+
"data:get:record",
|
|
904
|
+
"get:data:record",
|
|
905
|
+
"get:record:data",
|
|
906
|
+
"data:record:get",
|
|
907
|
+
"record:data:get",
|
|
908
|
+
"record:get:data"
|
|
894
909
|
]
|
|
895
910
|
},
|
|
896
|
-
"data:
|
|
897
|
-
"aliases": [
|
|
898
|
-
"force:data:record:delete"
|
|
899
|
-
],
|
|
911
|
+
"data:export:bulk": {
|
|
912
|
+
"aliases": [],
|
|
900
913
|
"args": {},
|
|
901
|
-
"
|
|
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.",
|
|
914
|
+
"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).",
|
|
903
915
|
"examples": [
|
|
904
|
-
"
|
|
905
|
-
"
|
|
906
|
-
"
|
|
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"
|
|
916
|
+
"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",
|
|
917
|
+
"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",
|
|
918
|
+
"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"
|
|
908
919
|
],
|
|
909
920
|
"flags": {
|
|
910
921
|
"json": {
|
|
@@ -923,12 +934,7 @@
|
|
|
923
934
|
"type": "option"
|
|
924
935
|
},
|
|
925
936
|
"target-org": {
|
|
926
|
-
"aliases": [
|
|
927
|
-
"targetusername",
|
|
928
|
-
"u"
|
|
929
|
-
],
|
|
930
937
|
"char": "o",
|
|
931
|
-
"deprecateAliases": true,
|
|
932
938
|
"name": "target-org",
|
|
933
939
|
"noCacheDefault": true,
|
|
934
940
|
"required": true,
|
|
@@ -938,359 +944,82 @@
|
|
|
938
944
|
"type": "option"
|
|
939
945
|
},
|
|
940
946
|
"api-version": {
|
|
941
|
-
"aliases": [
|
|
942
|
-
"apiversion"
|
|
943
|
-
],
|
|
944
|
-
"deprecateAliases": true,
|
|
945
947
|
"description": "Override the api version used for api requests made by this command",
|
|
946
948
|
"name": "api-version",
|
|
947
949
|
"hasDynamicHelp": false,
|
|
948
950
|
"multiple": false,
|
|
949
951
|
"type": "option"
|
|
950
952
|
},
|
|
951
|
-
"
|
|
952
|
-
"
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
"name": "
|
|
957
|
-
"
|
|
953
|
+
"wait": {
|
|
954
|
+
"char": "w",
|
|
955
|
+
"exclusive": [
|
|
956
|
+
"async"
|
|
957
|
+
],
|
|
958
|
+
"name": "wait",
|
|
959
|
+
"summary": "Time to wait for the command to finish, in minutes.",
|
|
960
|
+
"hasDynamicHelp": true,
|
|
961
|
+
"helpValue": "<minutes>",
|
|
958
962
|
"multiple": false,
|
|
959
963
|
"type": "option"
|
|
960
964
|
},
|
|
961
|
-
"
|
|
962
|
-
"
|
|
963
|
-
|
|
965
|
+
"async": {
|
|
966
|
+
"deprecated": true,
|
|
967
|
+
"exclusive": [
|
|
968
|
+
"wait"
|
|
964
969
|
],
|
|
965
|
-
"
|
|
966
|
-
"
|
|
967
|
-
"
|
|
968
|
-
"
|
|
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"
|
|
979
|
+
],
|
|
980
|
+
"name": "query",
|
|
981
|
+
"summary": "SOQL query to execute.",
|
|
970
982
|
"hasDynamicHelp": false,
|
|
971
983
|
"multiple": false,
|
|
972
984
|
"type": "option"
|
|
973
985
|
},
|
|
974
|
-
"
|
|
975
|
-
"
|
|
976
|
-
"
|
|
986
|
+
"query-file": {
|
|
987
|
+
"exclusive": [
|
|
988
|
+
"query"
|
|
977
989
|
],
|
|
978
|
-
"
|
|
979
|
-
"
|
|
980
|
-
"name": "record-id",
|
|
981
|
-
"summary": "ID of the record you’re deleting.",
|
|
990
|
+
"name": "query-file",
|
|
991
|
+
"summary": "File that contains the SOQL query.",
|
|
982
992
|
"hasDynamicHelp": false,
|
|
983
993
|
"multiple": false,
|
|
984
994
|
"type": "option"
|
|
985
995
|
},
|
|
986
|
-
"
|
|
987
|
-
"
|
|
988
|
-
"
|
|
989
|
-
"
|
|
996
|
+
"all-rows": {
|
|
997
|
+
"name": "all-rows",
|
|
998
|
+
"summary": "Include records that have been soft-deleted due to a merge or delete. By default, deleted records are not returned.",
|
|
999
|
+
"allowNo": false,
|
|
1000
|
+
"type": "boolean"
|
|
1001
|
+
},
|
|
1002
|
+
"output-file": {
|
|
1003
|
+
"name": "output-file",
|
|
1004
|
+
"required": true,
|
|
1005
|
+
"summary": "File where records are written.",
|
|
990
1006
|
"hasDynamicHelp": false,
|
|
991
1007
|
"multiple": false,
|
|
992
1008
|
"type": "option"
|
|
993
1009
|
},
|
|
994
|
-
"
|
|
995
|
-
"
|
|
996
|
-
|
|
1010
|
+
"result-format": {
|
|
1011
|
+
"char": "r",
|
|
1012
|
+
"name": "result-format",
|
|
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"
|
|
997
1021
|
],
|
|
998
|
-
"
|
|
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"
|
|
1004
|
-
},
|
|
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"
|
|
1022
|
+
"type": "option"
|
|
1294
1023
|
},
|
|
1295
1024
|
"column-delimiter": {
|
|
1296
1025
|
"name": "column-delimiter",
|
|
@@ -1542,68 +1271,226 @@
|
|
|
1542
1271
|
},
|
|
1543
1272
|
"hasDynamicHelp": true,
|
|
1544
1273
|
"hiddenAliases": [],
|
|
1545
|
-
"id": "data:export:tree",
|
|
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
|
+
],
|
|
1445
|
+
"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
|
+
}
|
|
1454
|
+
},
|
|
1455
|
+
"hasDynamicHelp": true,
|
|
1456
|
+
"hiddenAliases": [],
|
|
1457
|
+
"id": "data:delete:bulk",
|
|
1546
1458
|
"pluginAlias": "@salesforce/plugin-data",
|
|
1547
1459
|
"pluginName": "@salesforce/plugin-data",
|
|
1548
1460
|
"pluginType": "core",
|
|
1549
1461
|
"strict": true,
|
|
1550
|
-
"summary": "
|
|
1462
|
+
"summary": "Bulk delete records from an org using a CSV file. Uses Bulk API 2.0.",
|
|
1551
1463
|
"enableJsonFlag": true,
|
|
1552
1464
|
"isESM": true,
|
|
1553
1465
|
"relativePath": [
|
|
1554
1466
|
"lib",
|
|
1555
1467
|
"commands",
|
|
1556
1468
|
"data",
|
|
1557
|
-
"
|
|
1558
|
-
"
|
|
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"
|
|
1469
|
+
"delete",
|
|
1470
|
+
"bulk.js"
|
|
1585
1471
|
],
|
|
1472
|
+
"aliasPermutations": [],
|
|
1586
1473
|
"permutations": [
|
|
1587
|
-
"data:
|
|
1588
|
-
"
|
|
1589
|
-
"
|
|
1590
|
-
"data:
|
|
1591
|
-
"
|
|
1592
|
-
"
|
|
1474
|
+
"data:delete:bulk",
|
|
1475
|
+
"delete:data:bulk",
|
|
1476
|
+
"delete:bulk:data",
|
|
1477
|
+
"data:bulk:delete",
|
|
1478
|
+
"bulk:data:delete",
|
|
1479
|
+
"bulk:delete:data"
|
|
1593
1480
|
]
|
|
1594
1481
|
},
|
|
1595
|
-
"data:
|
|
1482
|
+
"data:delete:record": {
|
|
1596
1483
|
"aliases": [
|
|
1597
|
-
"force:data:record:
|
|
1484
|
+
"force:data:record:delete"
|
|
1598
1485
|
],
|
|
1599
1486
|
"args": {},
|
|
1600
1487
|
"deprecateAliases": true,
|
|
1601
|
-
"description": "Specify the record you want to
|
|
1488
|
+
"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.",
|
|
1602
1489
|
"examples": [
|
|
1603
|
-
"
|
|
1604
|
-
"
|
|
1605
|
-
"
|
|
1606
|
-
"
|
|
1490
|
+
"Delete a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX",
|
|
1491
|
+
"Delete a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name=Acme\"",
|
|
1492
|
+
"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",
|
|
1493
|
+
"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"
|
|
1607
1494
|
],
|
|
1608
1495
|
"flags": {
|
|
1609
1496
|
"json": {
|
|
@@ -1665,7 +1552,7 @@
|
|
|
1665
1552
|
"deprecateAliases": true,
|
|
1666
1553
|
"name": "sobject",
|
|
1667
1554
|
"required": true,
|
|
1668
|
-
"summary": "API name of the Salesforce or Tooling API object that you're
|
|
1555
|
+
"summary": "API name of the Salesforce or Tooling API object that you're deleting a record from.",
|
|
1669
1556
|
"hasDynamicHelp": false,
|
|
1670
1557
|
"multiple": false,
|
|
1671
1558
|
"type": "option"
|
|
@@ -1677,7 +1564,7 @@
|
|
|
1677
1564
|
"char": "i",
|
|
1678
1565
|
"deprecateAliases": true,
|
|
1679
1566
|
"name": "record-id",
|
|
1680
|
-
"summary": "ID of the record you’re
|
|
1567
|
+
"summary": "ID of the record you’re deleting.",
|
|
1681
1568
|
"hasDynamicHelp": false,
|
|
1682
1569
|
"multiple": false,
|
|
1683
1570
|
"type": "option"
|
|
@@ -1685,7 +1572,7 @@
|
|
|
1685
1572
|
"where": {
|
|
1686
1573
|
"char": "w",
|
|
1687
1574
|
"name": "where",
|
|
1688
|
-
"summary": "List of <fieldName>=<value> pairs that identify the record you want to
|
|
1575
|
+
"summary": "List of <fieldName>=<value> pairs that identify the record you want to delete.",
|
|
1689
1576
|
"hasDynamicHelp": false,
|
|
1690
1577
|
"multiple": false,
|
|
1691
1578
|
"type": "option"
|
|
@@ -1697,7 +1584,7 @@
|
|
|
1697
1584
|
"char": "t",
|
|
1698
1585
|
"deprecateAliases": true,
|
|
1699
1586
|
"name": "use-tooling-api",
|
|
1700
|
-
"summary": "Use Tooling API so you can
|
|
1587
|
+
"summary": "Use Tooling API so you can delete a record from a Tooling API object.",
|
|
1701
1588
|
"allowNo": false,
|
|
1702
1589
|
"type": "boolean"
|
|
1703
1590
|
},
|
|
@@ -1715,54 +1602,167 @@
|
|
|
1715
1602
|
},
|
|
1716
1603
|
"hasDynamicHelp": true,
|
|
1717
1604
|
"hiddenAliases": [],
|
|
1718
|
-
"id": "data:
|
|
1605
|
+
"id": "data:delete:record",
|
|
1719
1606
|
"pluginAlias": "@salesforce/plugin-data",
|
|
1720
1607
|
"pluginName": "@salesforce/plugin-data",
|
|
1721
1608
|
"pluginType": "core",
|
|
1722
1609
|
"strict": true,
|
|
1723
|
-
"summary": "
|
|
1610
|
+
"summary": "Deletes a single record from a Salesforce or Tooling API object.",
|
|
1724
1611
|
"enableJsonFlag": true,
|
|
1725
1612
|
"isESM": true,
|
|
1726
1613
|
"relativePath": [
|
|
1727
1614
|
"lib",
|
|
1728
1615
|
"commands",
|
|
1729
1616
|
"data",
|
|
1730
|
-
"
|
|
1617
|
+
"delete",
|
|
1731
1618
|
"record.js"
|
|
1732
1619
|
],
|
|
1733
1620
|
"aliasPermutations": [
|
|
1734
|
-
"force:data:record:
|
|
1735
|
-
"data:force:record:
|
|
1736
|
-
"data:record:force:
|
|
1737
|
-
"data:record:
|
|
1738
|
-
"force:record:data:
|
|
1739
|
-
"record:force:data:
|
|
1740
|
-
"record:data:force:
|
|
1741
|
-
"record:data:
|
|
1742
|
-
"force:record:
|
|
1743
|
-
"record:force:
|
|
1744
|
-
"record:
|
|
1745
|
-
"record:
|
|
1746
|
-
"force:data:
|
|
1747
|
-
"data:force:
|
|
1748
|
-
"data:
|
|
1749
|
-
"data:
|
|
1750
|
-
"force:
|
|
1751
|
-
"
|
|
1752
|
-
"
|
|
1753
|
-
"
|
|
1754
|
-
"force:
|
|
1755
|
-
"
|
|
1756
|
-
"
|
|
1757
|
-
"
|
|
1621
|
+
"force:data:record:delete",
|
|
1622
|
+
"data:force:record:delete",
|
|
1623
|
+
"data:record:force:delete",
|
|
1624
|
+
"data:record:delete:force",
|
|
1625
|
+
"force:record:data:delete",
|
|
1626
|
+
"record:force:data:delete",
|
|
1627
|
+
"record:data:force:delete",
|
|
1628
|
+
"record:data:delete:force",
|
|
1629
|
+
"force:record:delete:data",
|
|
1630
|
+
"record:force:delete:data",
|
|
1631
|
+
"record:delete:force:data",
|
|
1632
|
+
"record:delete:data:force",
|
|
1633
|
+
"force:data:delete:record",
|
|
1634
|
+
"data:force:delete:record",
|
|
1635
|
+
"data:delete:force:record",
|
|
1636
|
+
"data:delete:record:force",
|
|
1637
|
+
"force:delete:data:record",
|
|
1638
|
+
"delete:force:data:record",
|
|
1639
|
+
"delete:data:force:record",
|
|
1640
|
+
"delete:data:record:force",
|
|
1641
|
+
"force:delete:record:data",
|
|
1642
|
+
"delete:force:record:data",
|
|
1643
|
+
"delete:record:force:data",
|
|
1644
|
+
"delete:record:data:force"
|
|
1758
1645
|
],
|
|
1759
1646
|
"permutations": [
|
|
1760
|
-
"data:
|
|
1761
|
-
"
|
|
1762
|
-
"
|
|
1763
|
-
"data:record:
|
|
1764
|
-
"record:data:
|
|
1765
|
-
"record:
|
|
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"
|
|
1757
|
+
],
|
|
1758
|
+
"aliasPermutations": [],
|
|
1759
|
+
"permutations": [
|
|
1760
|
+
"data:delete:resume",
|
|
1761
|
+
"delete:data:resume",
|
|
1762
|
+
"delete:resume:data",
|
|
1763
|
+
"data:resume:delete",
|
|
1764
|
+
"resume:data:delete",
|
|
1765
|
+
"resume:delete: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.33"
|
|
3236
3236
|
}
|