@salesforce/plugin-data 3.13.2 → 3.13.4
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/oclif.manifest.json
CHANGED
|
@@ -775,13 +775,14 @@
|
|
|
775
775
|
"record:create:data"
|
|
776
776
|
]
|
|
777
777
|
},
|
|
778
|
-
"data:
|
|
778
|
+
"data:export:bulk": {
|
|
779
779
|
"aliases": [],
|
|
780
780
|
"args": {},
|
|
781
|
-
"description": "
|
|
781
|
+
"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).",
|
|
782
782
|
"examples": [
|
|
783
|
-
"
|
|
784
|
-
"
|
|
783
|
+
"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",
|
|
784
|
+
"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",
|
|
785
|
+
"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"
|
|
785
786
|
],
|
|
786
787
|
"flags": {
|
|
787
788
|
"json": {
|
|
@@ -800,12 +801,7 @@
|
|
|
800
801
|
"type": "option"
|
|
801
802
|
},
|
|
802
803
|
"target-org": {
|
|
803
|
-
"aliases": [
|
|
804
|
-
"targetusername",
|
|
805
|
-
"u"
|
|
806
|
-
],
|
|
807
804
|
"char": "o",
|
|
808
|
-
"deprecateAliases": true,
|
|
809
805
|
"name": "target-org",
|
|
810
806
|
"noCacheDefault": true,
|
|
811
807
|
"required": true,
|
|
@@ -815,144 +811,163 @@
|
|
|
815
811
|
"type": "option"
|
|
816
812
|
},
|
|
817
813
|
"api-version": {
|
|
818
|
-
"aliases": [
|
|
819
|
-
"apiversion"
|
|
820
|
-
],
|
|
821
|
-
"deprecateAliases": true,
|
|
822
814
|
"description": "Override the api version used for api requests made by this command",
|
|
823
815
|
"name": "api-version",
|
|
824
816
|
"hasDynamicHelp": false,
|
|
825
817
|
"multiple": false,
|
|
826
818
|
"type": "option"
|
|
827
819
|
},
|
|
828
|
-
"loglevel": {
|
|
829
|
-
"deprecated": {
|
|
830
|
-
"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."
|
|
831
|
-
},
|
|
832
|
-
"hidden": true,
|
|
833
|
-
"name": "loglevel",
|
|
834
|
-
"hasDynamicHelp": false,
|
|
835
|
-
"multiple": false,
|
|
836
|
-
"type": "option"
|
|
837
|
-
},
|
|
838
|
-
"file": {
|
|
839
|
-
"aliases": [
|
|
840
|
-
"csvfile"
|
|
841
|
-
],
|
|
842
|
-
"char": "f",
|
|
843
|
-
"deprecateAliases": true,
|
|
844
|
-
"name": "file",
|
|
845
|
-
"required": true,
|
|
846
|
-
"summary": "CSV file that contains the IDs of the records to update or delete.",
|
|
847
|
-
"hasDynamicHelp": false,
|
|
848
|
-
"multiple": false,
|
|
849
|
-
"type": "option"
|
|
850
|
-
},
|
|
851
|
-
"sobject": {
|
|
852
|
-
"aliases": [
|
|
853
|
-
"sobjecttype"
|
|
854
|
-
],
|
|
855
|
-
"char": "s",
|
|
856
|
-
"deprecateAliases": true,
|
|
857
|
-
"name": "sobject",
|
|
858
|
-
"required": true,
|
|
859
|
-
"summary": "API name of the Salesforce object, either standard or custom, that you want to update or delete records from.",
|
|
860
|
-
"hasDynamicHelp": false,
|
|
861
|
-
"multiple": false,
|
|
862
|
-
"type": "option"
|
|
863
|
-
},
|
|
864
820
|
"wait": {
|
|
865
821
|
"char": "w",
|
|
866
822
|
"exclusive": [
|
|
867
823
|
"async"
|
|
868
824
|
],
|
|
869
825
|
"name": "wait",
|
|
870
|
-
"summary": "
|
|
871
|
-
"default": "0 minutes",
|
|
826
|
+
"summary": "Time to wait for the command to finish, in minutes.",
|
|
872
827
|
"hasDynamicHelp": true,
|
|
828
|
+
"helpValue": "<minutes>",
|
|
873
829
|
"multiple": false,
|
|
874
830
|
"type": "option"
|
|
875
831
|
},
|
|
876
832
|
"async": {
|
|
877
|
-
"char": "a",
|
|
878
833
|
"exclusive": [
|
|
879
834
|
"wait"
|
|
880
835
|
],
|
|
881
836
|
"name": "async",
|
|
882
|
-
"summary": "
|
|
837
|
+
"summary": "Don't wait for the job to complete.",
|
|
883
838
|
"allowNo": false,
|
|
884
839
|
"type": "boolean"
|
|
885
840
|
},
|
|
886
|
-
"
|
|
887
|
-
"
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
"
|
|
841
|
+
"query": {
|
|
842
|
+
"char": "q",
|
|
843
|
+
"exclusive": [
|
|
844
|
+
"query-file"
|
|
845
|
+
],
|
|
846
|
+
"name": "query",
|
|
847
|
+
"summary": "SOQL query to execute.",
|
|
848
|
+
"hasDynamicHelp": false,
|
|
849
|
+
"multiple": false,
|
|
850
|
+
"type": "option"
|
|
851
|
+
},
|
|
852
|
+
"query-file": {
|
|
853
|
+
"exclusive": [
|
|
854
|
+
"query"
|
|
855
|
+
],
|
|
856
|
+
"name": "query-file",
|
|
857
|
+
"summary": "File that contains the SOQL query.",
|
|
858
|
+
"hasDynamicHelp": false,
|
|
859
|
+
"multiple": false,
|
|
860
|
+
"type": "option"
|
|
861
|
+
},
|
|
862
|
+
"all-rows": {
|
|
863
|
+
"name": "all-rows",
|
|
864
|
+
"summary": "Include records that have been soft-deleted due to a merge or delete. By default, deleted records are not returned.",
|
|
892
865
|
"allowNo": false,
|
|
893
866
|
"type": "boolean"
|
|
894
867
|
},
|
|
895
|
-
"
|
|
896
|
-
"
|
|
897
|
-
|
|
868
|
+
"output-file": {
|
|
869
|
+
"name": "output-file",
|
|
870
|
+
"required": true,
|
|
871
|
+
"summary": "File where records are written.",
|
|
872
|
+
"hasDynamicHelp": false,
|
|
873
|
+
"multiple": false,
|
|
874
|
+
"type": "option"
|
|
875
|
+
},
|
|
876
|
+
"result-format": {
|
|
877
|
+
"char": "r",
|
|
878
|
+
"name": "result-format",
|
|
879
|
+
"required": true,
|
|
880
|
+
"summary": "Format to write the results.",
|
|
881
|
+
"default": "csv",
|
|
882
|
+
"hasDynamicHelp": false,
|
|
883
|
+
"multiple": false,
|
|
884
|
+
"options": [
|
|
885
|
+
"csv",
|
|
886
|
+
"json"
|
|
898
887
|
],
|
|
899
|
-
"
|
|
900
|
-
|
|
888
|
+
"type": "option"
|
|
889
|
+
},
|
|
890
|
+
"column-delimiter": {
|
|
891
|
+
"name": "column-delimiter",
|
|
892
|
+
"relationships": [
|
|
893
|
+
{
|
|
894
|
+
"type": "some",
|
|
895
|
+
"flags": [
|
|
896
|
+
{
|
|
897
|
+
"name": "result-format"
|
|
898
|
+
}
|
|
899
|
+
]
|
|
900
|
+
}
|
|
901
|
+
],
|
|
902
|
+
"summary": "Column delimiter to be used when writing CSV output. Default is COMMA.",
|
|
901
903
|
"hasDynamicHelp": false,
|
|
902
904
|
"multiple": false,
|
|
903
905
|
"options": [
|
|
904
|
-
"
|
|
905
|
-
"
|
|
906
|
+
"BACKQUOTE",
|
|
907
|
+
"CARET",
|
|
908
|
+
"COMMA",
|
|
909
|
+
"PIPE",
|
|
910
|
+
"SEMICOLON",
|
|
911
|
+
"TAB"
|
|
906
912
|
],
|
|
907
913
|
"type": "option"
|
|
908
914
|
},
|
|
909
|
-
"
|
|
910
|
-
"
|
|
911
|
-
"
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
+
"line-ending": {
|
|
916
|
+
"name": "line-ending",
|
|
917
|
+
"relationships": [
|
|
918
|
+
{
|
|
919
|
+
"type": "some",
|
|
920
|
+
"flags": [
|
|
921
|
+
{
|
|
922
|
+
"name": "result-format"
|
|
923
|
+
}
|
|
924
|
+
]
|
|
925
|
+
}
|
|
926
|
+
],
|
|
927
|
+
"summary": "Line ending to be used when writing CSV output. Default value on Windows is is `CRLF`; on macOS and Linux it's `LR`.",
|
|
928
|
+
"hasDynamicHelp": false,
|
|
929
|
+
"multiple": false,
|
|
930
|
+
"options": [
|
|
931
|
+
"LF",
|
|
932
|
+
"CRLF"
|
|
933
|
+
],
|
|
934
|
+
"type": "option"
|
|
915
935
|
}
|
|
916
936
|
},
|
|
917
937
|
"hasDynamicHelp": true,
|
|
918
938
|
"hiddenAliases": [],
|
|
919
|
-
"id": "data:
|
|
939
|
+
"id": "data:export:bulk",
|
|
920
940
|
"pluginAlias": "@salesforce/plugin-data",
|
|
921
941
|
"pluginName": "@salesforce/plugin-data",
|
|
922
942
|
"pluginType": "core",
|
|
923
943
|
"strict": true,
|
|
924
|
-
"summary": "Bulk
|
|
944
|
+
"summary": "Bulk export records from an org into a file using a SOQL query. Uses Bulk API 2.0.",
|
|
925
945
|
"enableJsonFlag": true,
|
|
926
946
|
"isESM": true,
|
|
927
947
|
"relativePath": [
|
|
928
948
|
"lib",
|
|
929
949
|
"commands",
|
|
930
950
|
"data",
|
|
931
|
-
"
|
|
951
|
+
"export",
|
|
932
952
|
"bulk.js"
|
|
933
953
|
],
|
|
934
954
|
"aliasPermutations": [],
|
|
935
955
|
"permutations": [
|
|
936
|
-
"data:
|
|
937
|
-
"
|
|
938
|
-
"
|
|
939
|
-
"data:bulk:
|
|
940
|
-
"bulk:data:
|
|
941
|
-
"bulk:
|
|
956
|
+
"data:export:bulk",
|
|
957
|
+
"export:data:bulk",
|
|
958
|
+
"export:bulk:data",
|
|
959
|
+
"data:bulk:export",
|
|
960
|
+
"bulk:data:export",
|
|
961
|
+
"bulk:export:data"
|
|
942
962
|
]
|
|
943
963
|
},
|
|
944
|
-
"data:
|
|
945
|
-
"aliases": [
|
|
946
|
-
"force:data:record:delete"
|
|
947
|
-
],
|
|
964
|
+
"data:export:resume": {
|
|
965
|
+
"aliases": [],
|
|
948
966
|
"args": {},
|
|
949
|
-
"
|
|
950
|
-
"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.",
|
|
967
|
+
"description": "When the original \"data export bulk\" command either times out or is run with the --async flag, it displays a job ID. To see the status and get the results of the bulk export, run this command by either passing it the job ID or using the --use-most-recent flag to specify the most recent bulk export job.",
|
|
951
968
|
"examples": [
|
|
952
|
-
"
|
|
953
|
-
"
|
|
954
|
-
"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",
|
|
955
|
-
"Delete a record from the Tooling API object TraceFlag with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --use-tooling-api --sobject TraceFlag --record-id 7tf8c"
|
|
969
|
+
"Resume a bulk export job run on your default org by specifying a job ID:\nsf <%= command.id %> --job-id 750xx000000005sAAA",
|
|
970
|
+
"Resume the most recently-run bulk export job for an org with alias my-scratch:\nsf data export resume --use-most-recent --target-org my-scratch"
|
|
956
971
|
],
|
|
957
972
|
"flags": {
|
|
958
973
|
"json": {
|
|
@@ -970,158 +985,67 @@
|
|
|
970
985
|
"multiple": false,
|
|
971
986
|
"type": "option"
|
|
972
987
|
},
|
|
973
|
-
"
|
|
974
|
-
"
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
"char": "o",
|
|
979
|
-
"deprecateAliases": true,
|
|
980
|
-
"name": "target-org",
|
|
981
|
-
"noCacheDefault": true,
|
|
982
|
-
"required": true,
|
|
983
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
984
|
-
"hasDynamicHelp": true,
|
|
988
|
+
"job-id": {
|
|
989
|
+
"char": "i",
|
|
990
|
+
"name": "job-id",
|
|
991
|
+
"summary": "Job ID of the bulk export.",
|
|
992
|
+
"hasDynamicHelp": false,
|
|
985
993
|
"multiple": false,
|
|
986
994
|
"type": "option"
|
|
987
995
|
},
|
|
996
|
+
"use-most-recent": {
|
|
997
|
+
"name": "use-most-recent",
|
|
998
|
+
"summary": "Use the job ID of the bulk export job that was most recently run.",
|
|
999
|
+
"allowNo": false,
|
|
1000
|
+
"type": "boolean"
|
|
1001
|
+
},
|
|
988
1002
|
"api-version": {
|
|
989
|
-
"aliases": [
|
|
990
|
-
"apiversion"
|
|
991
|
-
],
|
|
992
|
-
"deprecateAliases": true,
|
|
993
1003
|
"description": "Override the api version used for api requests made by this command",
|
|
994
1004
|
"name": "api-version",
|
|
995
1005
|
"hasDynamicHelp": false,
|
|
996
1006
|
"multiple": false,
|
|
997
1007
|
"type": "option"
|
|
998
|
-
},
|
|
999
|
-
"loglevel": {
|
|
1000
|
-
"deprecated": {
|
|
1001
|
-
"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."
|
|
1002
|
-
},
|
|
1003
|
-
"hidden": true,
|
|
1004
|
-
"name": "loglevel",
|
|
1005
|
-
"hasDynamicHelp": false,
|
|
1006
|
-
"multiple": false,
|
|
1007
|
-
"type": "option"
|
|
1008
|
-
},
|
|
1009
|
-
"sobject": {
|
|
1010
|
-
"aliases": [
|
|
1011
|
-
"sobjecttype"
|
|
1012
|
-
],
|
|
1013
|
-
"char": "s",
|
|
1014
|
-
"deprecateAliases": true,
|
|
1015
|
-
"name": "sobject",
|
|
1016
|
-
"required": true,
|
|
1017
|
-
"summary": "API name of the Salesforce or Tooling API object that you're deleting a record from.",
|
|
1018
|
-
"hasDynamicHelp": false,
|
|
1019
|
-
"multiple": false,
|
|
1020
|
-
"type": "option"
|
|
1021
|
-
},
|
|
1022
|
-
"record-id": {
|
|
1023
|
-
"aliases": [
|
|
1024
|
-
"sobjectid"
|
|
1025
|
-
],
|
|
1026
|
-
"char": "i",
|
|
1027
|
-
"deprecateAliases": true,
|
|
1028
|
-
"name": "record-id",
|
|
1029
|
-
"summary": "ID of the record you’re deleting.",
|
|
1030
|
-
"hasDynamicHelp": false,
|
|
1031
|
-
"multiple": false,
|
|
1032
|
-
"type": "option"
|
|
1033
|
-
},
|
|
1034
|
-
"where": {
|
|
1035
|
-
"char": "w",
|
|
1036
|
-
"name": "where",
|
|
1037
|
-
"summary": "List of <fieldName>=<value> pairs that identify the record you want to delete.",
|
|
1038
|
-
"hasDynamicHelp": false,
|
|
1039
|
-
"multiple": false,
|
|
1040
|
-
"type": "option"
|
|
1041
|
-
},
|
|
1042
|
-
"use-tooling-api": {
|
|
1043
|
-
"aliases": [
|
|
1044
|
-
"usetoolingapi"
|
|
1045
|
-
],
|
|
1046
|
-
"char": "t",
|
|
1047
|
-
"deprecateAliases": true,
|
|
1048
|
-
"name": "use-tooling-api",
|
|
1049
|
-
"summary": "Use Tooling API so you can delete a record from a Tooling API object.",
|
|
1050
|
-
"allowNo": false,
|
|
1051
|
-
"type": "boolean"
|
|
1052
|
-
},
|
|
1053
|
-
"perflog": {
|
|
1054
|
-
"deprecated": {
|
|
1055
|
-
"version": "57"
|
|
1056
|
-
},
|
|
1057
|
-
"description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
|
|
1058
|
-
"hidden": true,
|
|
1059
|
-
"name": "perflog",
|
|
1060
|
-
"summary": "Get API performance data.",
|
|
1061
|
-
"allowNo": false,
|
|
1062
|
-
"type": "boolean"
|
|
1063
1008
|
}
|
|
1064
1009
|
},
|
|
1065
|
-
"hasDynamicHelp":
|
|
1010
|
+
"hasDynamicHelp": false,
|
|
1066
1011
|
"hiddenAliases": [],
|
|
1067
|
-
"id": "data:
|
|
1012
|
+
"id": "data:export:resume",
|
|
1068
1013
|
"pluginAlias": "@salesforce/plugin-data",
|
|
1069
1014
|
"pluginName": "@salesforce/plugin-data",
|
|
1070
1015
|
"pluginType": "core",
|
|
1071
1016
|
"strict": true,
|
|
1072
|
-
"summary": "
|
|
1017
|
+
"summary": "Resume a bulk export job that you previously started. Uses Bulk API 2.0.",
|
|
1073
1018
|
"enableJsonFlag": true,
|
|
1074
1019
|
"isESM": true,
|
|
1075
1020
|
"relativePath": [
|
|
1076
1021
|
"lib",
|
|
1077
1022
|
"commands",
|
|
1078
1023
|
"data",
|
|
1079
|
-
"
|
|
1080
|
-
"
|
|
1081
|
-
],
|
|
1082
|
-
"aliasPermutations": [
|
|
1083
|
-
"force:data:record:delete",
|
|
1084
|
-
"data:force:record:delete",
|
|
1085
|
-
"data:record:force:delete",
|
|
1086
|
-
"data:record:delete:force",
|
|
1087
|
-
"force:record:data:delete",
|
|
1088
|
-
"record:force:data:delete",
|
|
1089
|
-
"record:data:force:delete",
|
|
1090
|
-
"record:data:delete:force",
|
|
1091
|
-
"force:record:delete:data",
|
|
1092
|
-
"record:force:delete:data",
|
|
1093
|
-
"record:delete:force:data",
|
|
1094
|
-
"record:delete:data:force",
|
|
1095
|
-
"force:data:delete:record",
|
|
1096
|
-
"data:force:delete:record",
|
|
1097
|
-
"data:delete:force:record",
|
|
1098
|
-
"data:delete:record:force",
|
|
1099
|
-
"force:delete:data:record",
|
|
1100
|
-
"delete:force:data:record",
|
|
1101
|
-
"delete:data:force:record",
|
|
1102
|
-
"delete:data:record:force",
|
|
1103
|
-
"force:delete:record:data",
|
|
1104
|
-
"delete:force:record:data",
|
|
1105
|
-
"delete:record:force:data",
|
|
1106
|
-
"delete:record:data:force"
|
|
1024
|
+
"export",
|
|
1025
|
+
"resume.js"
|
|
1107
1026
|
],
|
|
1027
|
+
"aliasPermutations": [],
|
|
1108
1028
|
"permutations": [
|
|
1109
|
-
"data:
|
|
1110
|
-
"
|
|
1111
|
-
"
|
|
1112
|
-
"data:
|
|
1113
|
-
"
|
|
1114
|
-
"
|
|
1029
|
+
"data:export:resume",
|
|
1030
|
+
"export:data:resume",
|
|
1031
|
+
"export:resume:data",
|
|
1032
|
+
"data:resume:export",
|
|
1033
|
+
"resume:data:export",
|
|
1034
|
+
"resume:export:data"
|
|
1115
1035
|
]
|
|
1116
1036
|
},
|
|
1117
|
-
"data:
|
|
1118
|
-
"aliases": [
|
|
1037
|
+
"data:export:tree": {
|
|
1038
|
+
"aliases": [
|
|
1039
|
+
"force:data:tree:export",
|
|
1040
|
+
"data:export:beta:tree"
|
|
1041
|
+
],
|
|
1119
1042
|
"args": {},
|
|
1120
1043
|
"deprecateAliases": true,
|
|
1121
|
-
"description": "
|
|
1044
|
+
"description": "Specify a SOQL query, either directly at the command line or read from a file, to retrieve the data you want to export. The exported data is written to JSON files in sObject tree format, which is a collection of nested, parent-child records with a single root record. Use these JSON files to import data into an org with the \"<%= config.bin %> data import tree\" command.\n\nIf your SOQL query references multiple objects, the command generates a single JSON file by default. You can specify the --plan flag to generate separate JSON files for each object and a plan definition file that aggregates them. You then specify just this plan definition file when you import the data into an org.\n\nThe SOQL query can return a maximum of 2,000 records. For more information, see the REST API Developer Guide. (https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm).",
|
|
1122
1045
|
"examples": [
|
|
1123
|
-
"
|
|
1124
|
-
"
|
|
1046
|
+
"Export records retrieved with the specified SOQL query into a single JSON file in the current directory; the command uses your default org:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id, Name, (SELECT Name, Address__c FROM Properties__r) FROM Broker__c\"",
|
|
1047
|
+
"Export data using a SOQL query in the \"query.txt\" file and generate JSON files for each object and a plan that aggregates them:\n<%= config.bin %> <%= command.id %> --query query.txt --plan",
|
|
1048
|
+
"Prepend \"export-demo\" before each generated file and generate the files in the \"export-out\" directory; run the command on the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --query query.txt --plan --prefix export-demo --output-dir export-out --target-org my-scratch"
|
|
1125
1049
|
],
|
|
1126
1050
|
"flags": {
|
|
1127
1051
|
"json": {
|
|
@@ -1148,41 +1072,17 @@
|
|
|
1148
1072
|
"deprecateAliases": true,
|
|
1149
1073
|
"name": "target-org",
|
|
1150
1074
|
"noCacheDefault": true,
|
|
1151
|
-
"
|
|
1075
|
+
"required": true,
|
|
1076
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1152
1077
|
"hasDynamicHelp": true,
|
|
1153
1078
|
"multiple": false,
|
|
1154
1079
|
"type": "option"
|
|
1155
1080
|
},
|
|
1156
|
-
"
|
|
1081
|
+
"api-version": {
|
|
1157
1082
|
"aliases": [
|
|
1158
|
-
"
|
|
1083
|
+
"apiversion"
|
|
1159
1084
|
],
|
|
1160
|
-
"char": "i",
|
|
1161
1085
|
"deprecateAliases": true,
|
|
1162
|
-
"name": "job-id",
|
|
1163
|
-
"summary": "ID of the job you want to resume.",
|
|
1164
|
-
"hasDynamicHelp": false,
|
|
1165
|
-
"multiple": false,
|
|
1166
|
-
"type": "option"
|
|
1167
|
-
},
|
|
1168
|
-
"use-most-recent": {
|
|
1169
|
-
"exclusive": [
|
|
1170
|
-
"job-id"
|
|
1171
|
-
],
|
|
1172
|
-
"name": "use-most-recent",
|
|
1173
|
-
"summary": "Use the ID of the most recently-run bulk job.",
|
|
1174
|
-
"allowNo": false,
|
|
1175
|
-
"type": "boolean"
|
|
1176
|
-
},
|
|
1177
|
-
"wait": {
|
|
1178
|
-
"name": "wait",
|
|
1179
|
-
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
1180
|
-
"default": "5 minutes",
|
|
1181
|
-
"hasDynamicHelp": true,
|
|
1182
|
-
"multiple": false,
|
|
1183
|
-
"type": "option"
|
|
1184
|
-
},
|
|
1185
|
-
"api-version": {
|
|
1186
1086
|
"description": "Override the api version used for api requests made by this command",
|
|
1187
1087
|
"name": "api-version",
|
|
1188
1088
|
"hasDynamicHelp": false,
|
|
@@ -1198,43 +1098,127 @@
|
|
|
1198
1098
|
"hasDynamicHelp": false,
|
|
1199
1099
|
"multiple": false,
|
|
1200
1100
|
"type": "option"
|
|
1101
|
+
},
|
|
1102
|
+
"query": {
|
|
1103
|
+
"char": "q",
|
|
1104
|
+
"name": "query",
|
|
1105
|
+
"required": true,
|
|
1106
|
+
"summary": "SOQL query, or filepath of a file that contains the query, to retrieve records.",
|
|
1107
|
+
"hasDynamicHelp": false,
|
|
1108
|
+
"multiple": true,
|
|
1109
|
+
"type": "option"
|
|
1110
|
+
},
|
|
1111
|
+
"plan": {
|
|
1112
|
+
"char": "p",
|
|
1113
|
+
"name": "plan",
|
|
1114
|
+
"summary": "Generate multiple sObject tree files and a plan definition file for aggregated import.",
|
|
1115
|
+
"allowNo": false,
|
|
1116
|
+
"type": "boolean"
|
|
1117
|
+
},
|
|
1118
|
+
"prefix": {
|
|
1119
|
+
"char": "x",
|
|
1120
|
+
"name": "prefix",
|
|
1121
|
+
"summary": "Prefix of generated files.",
|
|
1122
|
+
"hasDynamicHelp": false,
|
|
1123
|
+
"multiple": false,
|
|
1124
|
+
"type": "option"
|
|
1125
|
+
},
|
|
1126
|
+
"output-dir": {
|
|
1127
|
+
"aliases": [
|
|
1128
|
+
"outputdir"
|
|
1129
|
+
],
|
|
1130
|
+
"char": "d",
|
|
1131
|
+
"deprecateAliases": true,
|
|
1132
|
+
"name": "output-dir",
|
|
1133
|
+
"summary": "Directory in which to generate the JSON files; default is current directory.",
|
|
1134
|
+
"hasDynamicHelp": false,
|
|
1135
|
+
"multiple": false,
|
|
1136
|
+
"type": "option"
|
|
1201
1137
|
}
|
|
1202
1138
|
},
|
|
1203
1139
|
"hasDynamicHelp": true,
|
|
1204
1140
|
"hiddenAliases": [],
|
|
1205
|
-
"id": "data:
|
|
1141
|
+
"id": "data:export:tree",
|
|
1206
1142
|
"pluginAlias": "@salesforce/plugin-data",
|
|
1207
1143
|
"pluginName": "@salesforce/plugin-data",
|
|
1208
1144
|
"pluginType": "core",
|
|
1209
1145
|
"strict": true,
|
|
1210
|
-
"summary": "
|
|
1146
|
+
"summary": "Export data from an org into one or more JSON files.",
|
|
1211
1147
|
"enableJsonFlag": true,
|
|
1212
1148
|
"isESM": true,
|
|
1213
1149
|
"relativePath": [
|
|
1214
1150
|
"lib",
|
|
1215
1151
|
"commands",
|
|
1216
1152
|
"data",
|
|
1217
|
-
"
|
|
1218
|
-
"
|
|
1153
|
+
"export",
|
|
1154
|
+
"tree.js"
|
|
1155
|
+
],
|
|
1156
|
+
"aliasPermutations": [
|
|
1157
|
+
"force:data:tree:export",
|
|
1158
|
+
"data:force:tree:export",
|
|
1159
|
+
"data:tree:force:export",
|
|
1160
|
+
"data:tree:export:force",
|
|
1161
|
+
"force:tree:data:export",
|
|
1162
|
+
"tree:force:data:export",
|
|
1163
|
+
"tree:data:force:export",
|
|
1164
|
+
"tree:data:export:force",
|
|
1165
|
+
"force:tree:export:data",
|
|
1166
|
+
"tree:force:export:data",
|
|
1167
|
+
"tree:export:force:data",
|
|
1168
|
+
"tree:export:data:force",
|
|
1169
|
+
"force:data:export:tree",
|
|
1170
|
+
"data:force:export:tree",
|
|
1171
|
+
"data:export:force:tree",
|
|
1172
|
+
"data:export:tree:force",
|
|
1173
|
+
"force:export:data:tree",
|
|
1174
|
+
"export:force:data:tree",
|
|
1175
|
+
"export:data:force:tree",
|
|
1176
|
+
"export:data:tree:force",
|
|
1177
|
+
"force:export:tree:data",
|
|
1178
|
+
"export:force:tree:data",
|
|
1179
|
+
"export:tree:force:data",
|
|
1180
|
+
"export:tree:data:force",
|
|
1181
|
+
"data:export:beta:tree",
|
|
1182
|
+
"export:data:beta:tree",
|
|
1183
|
+
"export:beta:data:tree",
|
|
1184
|
+
"export:beta:tree:data",
|
|
1185
|
+
"data:beta:export:tree",
|
|
1186
|
+
"beta:data:export:tree",
|
|
1187
|
+
"beta:export:data:tree",
|
|
1188
|
+
"beta:export:tree:data",
|
|
1189
|
+
"data:beta:tree:export",
|
|
1190
|
+
"beta:data:tree:export",
|
|
1191
|
+
"beta:tree:data:export",
|
|
1192
|
+
"beta:tree:export:data",
|
|
1193
|
+
"data:export:tree:beta",
|
|
1194
|
+
"export:data:tree:beta",
|
|
1195
|
+
"export:tree:data:beta",
|
|
1196
|
+
"export:tree:beta:data",
|
|
1197
|
+
"data:tree:export:beta",
|
|
1198
|
+
"tree:data:export:beta",
|
|
1199
|
+
"tree:export:data:beta",
|
|
1200
|
+
"tree:export:beta:data",
|
|
1201
|
+
"data:tree:beta:export",
|
|
1202
|
+
"tree:data:beta:export",
|
|
1203
|
+
"tree:beta:data:export",
|
|
1204
|
+
"tree:beta:export:data"
|
|
1219
1205
|
],
|
|
1220
|
-
"aliasPermutations": [],
|
|
1221
1206
|
"permutations": [
|
|
1222
|
-
"data:
|
|
1223
|
-
"
|
|
1224
|
-
"
|
|
1225
|
-
"data:
|
|
1226
|
-
"
|
|
1227
|
-
"
|
|
1207
|
+
"data:export:tree",
|
|
1208
|
+
"export:data:tree",
|
|
1209
|
+
"export:tree:data",
|
|
1210
|
+
"data:tree:export",
|
|
1211
|
+
"tree:data:export",
|
|
1212
|
+
"tree:export:data"
|
|
1228
1213
|
]
|
|
1229
1214
|
},
|
|
1230
|
-
"data:
|
|
1215
|
+
"data:delete:bulk": {
|
|
1231
1216
|
"aliases": [],
|
|
1232
1217
|
"args": {},
|
|
1233
|
-
"description": "
|
|
1218
|
+
"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.",
|
|
1234
1219
|
"examples": [
|
|
1235
|
-
"
|
|
1236
|
-
"
|
|
1237
|
-
"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"
|
|
1220
|
+
"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",
|
|
1221
|
+
"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"
|
|
1238
1222
|
],
|
|
1239
1223
|
"flags": {
|
|
1240
1224
|
"json": {
|
|
@@ -1253,7 +1237,12 @@
|
|
|
1253
1237
|
"type": "option"
|
|
1254
1238
|
},
|
|
1255
1239
|
"target-org": {
|
|
1240
|
+
"aliases": [
|
|
1241
|
+
"targetusername",
|
|
1242
|
+
"u"
|
|
1243
|
+
],
|
|
1256
1244
|
"char": "o",
|
|
1245
|
+
"deprecateAliases": true,
|
|
1257
1246
|
"name": "target-org",
|
|
1258
1247
|
"noCacheDefault": true,
|
|
1259
1248
|
"required": true,
|
|
@@ -1263,163 +1252,144 @@
|
|
|
1263
1252
|
"type": "option"
|
|
1264
1253
|
},
|
|
1265
1254
|
"api-version": {
|
|
1255
|
+
"aliases": [
|
|
1256
|
+
"apiversion"
|
|
1257
|
+
],
|
|
1258
|
+
"deprecateAliases": true,
|
|
1266
1259
|
"description": "Override the api version used for api requests made by this command",
|
|
1267
1260
|
"name": "api-version",
|
|
1268
1261
|
"hasDynamicHelp": false,
|
|
1269
1262
|
"multiple": false,
|
|
1270
1263
|
"type": "option"
|
|
1271
1264
|
},
|
|
1265
|
+
"loglevel": {
|
|
1266
|
+
"deprecated": {
|
|
1267
|
+
"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."
|
|
1268
|
+
},
|
|
1269
|
+
"hidden": true,
|
|
1270
|
+
"name": "loglevel",
|
|
1271
|
+
"hasDynamicHelp": false,
|
|
1272
|
+
"multiple": false,
|
|
1273
|
+
"type": "option"
|
|
1274
|
+
},
|
|
1275
|
+
"file": {
|
|
1276
|
+
"aliases": [
|
|
1277
|
+
"csvfile"
|
|
1278
|
+
],
|
|
1279
|
+
"char": "f",
|
|
1280
|
+
"deprecateAliases": true,
|
|
1281
|
+
"name": "file",
|
|
1282
|
+
"required": true,
|
|
1283
|
+
"summary": "CSV file that contains the IDs of the records to update or delete.",
|
|
1284
|
+
"hasDynamicHelp": false,
|
|
1285
|
+
"multiple": false,
|
|
1286
|
+
"type": "option"
|
|
1287
|
+
},
|
|
1288
|
+
"sobject": {
|
|
1289
|
+
"aliases": [
|
|
1290
|
+
"sobjecttype"
|
|
1291
|
+
],
|
|
1292
|
+
"char": "s",
|
|
1293
|
+
"deprecateAliases": true,
|
|
1294
|
+
"name": "sobject",
|
|
1295
|
+
"required": true,
|
|
1296
|
+
"summary": "API name of the Salesforce object, either standard or custom, that you want to update or delete records from.",
|
|
1297
|
+
"hasDynamicHelp": false,
|
|
1298
|
+
"multiple": false,
|
|
1299
|
+
"type": "option"
|
|
1300
|
+
},
|
|
1272
1301
|
"wait": {
|
|
1273
1302
|
"char": "w",
|
|
1274
1303
|
"exclusive": [
|
|
1275
1304
|
"async"
|
|
1276
1305
|
],
|
|
1277
1306
|
"name": "wait",
|
|
1278
|
-
"summary": "
|
|
1307
|
+
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
1308
|
+
"default": "0 minutes",
|
|
1279
1309
|
"hasDynamicHelp": true,
|
|
1280
|
-
"helpValue": "<minutes>",
|
|
1281
1310
|
"multiple": false,
|
|
1282
1311
|
"type": "option"
|
|
1283
1312
|
},
|
|
1284
1313
|
"async": {
|
|
1314
|
+
"char": "a",
|
|
1285
1315
|
"exclusive": [
|
|
1286
1316
|
"wait"
|
|
1287
1317
|
],
|
|
1288
1318
|
"name": "async",
|
|
1289
|
-
"summary": "
|
|
1319
|
+
"summary": "Run the command asynchronously.",
|
|
1290
1320
|
"allowNo": false,
|
|
1291
1321
|
"type": "boolean"
|
|
1292
1322
|
},
|
|
1293
|
-
"
|
|
1294
|
-
"
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
"
|
|
1299
|
-
"summary": "SOQL query to execute.",
|
|
1300
|
-
"hasDynamicHelp": false,
|
|
1301
|
-
"multiple": false,
|
|
1302
|
-
"type": "option"
|
|
1303
|
-
},
|
|
1304
|
-
"query-file": {
|
|
1305
|
-
"exclusive": [
|
|
1306
|
-
"query"
|
|
1307
|
-
],
|
|
1308
|
-
"name": "query-file",
|
|
1309
|
-
"summary": "File that contains the SOQL query.",
|
|
1310
|
-
"hasDynamicHelp": false,
|
|
1311
|
-
"multiple": false,
|
|
1312
|
-
"type": "option"
|
|
1313
|
-
},
|
|
1314
|
-
"all-rows": {
|
|
1315
|
-
"name": "all-rows",
|
|
1316
|
-
"summary": "Include records that have been soft-deleted due to a merge or delete. By default, deleted records are not returned.",
|
|
1323
|
+
"verbose": {
|
|
1324
|
+
"deprecated": {
|
|
1325
|
+
"message": "The --verbose flag is deprecated and will be removed after March 2025, use \"sf data bulk results\" to get job results instead."
|
|
1326
|
+
},
|
|
1327
|
+
"name": "verbose",
|
|
1328
|
+
"summary": "Print verbose output of failed records if result is available.",
|
|
1317
1329
|
"allowNo": false,
|
|
1318
1330
|
"type": "boolean"
|
|
1319
1331
|
},
|
|
1320
|
-
"output-file": {
|
|
1321
|
-
"name": "output-file",
|
|
1322
|
-
"required": true,
|
|
1323
|
-
"summary": "File where records are written.",
|
|
1324
|
-
"hasDynamicHelp": false,
|
|
1325
|
-
"multiple": false,
|
|
1326
|
-
"type": "option"
|
|
1327
|
-
},
|
|
1328
|
-
"result-format": {
|
|
1329
|
-
"char": "r",
|
|
1330
|
-
"name": "result-format",
|
|
1331
|
-
"required": true,
|
|
1332
|
-
"summary": "Format to write the results.",
|
|
1333
|
-
"default": "csv",
|
|
1334
|
-
"hasDynamicHelp": false,
|
|
1335
|
-
"multiple": false,
|
|
1336
|
-
"options": [
|
|
1337
|
-
"csv",
|
|
1338
|
-
"json"
|
|
1339
|
-
],
|
|
1340
|
-
"type": "option"
|
|
1341
|
-
},
|
|
1342
|
-
"column-delimiter": {
|
|
1343
|
-
"name": "column-delimiter",
|
|
1344
|
-
"relationships": [
|
|
1345
|
-
{
|
|
1346
|
-
"type": "some",
|
|
1347
|
-
"flags": [
|
|
1348
|
-
{
|
|
1349
|
-
"name": "result-format"
|
|
1350
|
-
}
|
|
1351
|
-
]
|
|
1352
|
-
}
|
|
1353
|
-
],
|
|
1354
|
-
"summary": "Column delimiter to be used when writing CSV output. Default is COMMA.",
|
|
1355
|
-
"hasDynamicHelp": false,
|
|
1356
|
-
"multiple": false,
|
|
1357
|
-
"options": [
|
|
1358
|
-
"BACKQUOTE",
|
|
1359
|
-
"CARET",
|
|
1360
|
-
"COMMA",
|
|
1361
|
-
"PIPE",
|
|
1362
|
-
"SEMICOLON",
|
|
1363
|
-
"TAB"
|
|
1364
|
-
],
|
|
1365
|
-
"type": "option"
|
|
1366
|
-
},
|
|
1367
1332
|
"line-ending": {
|
|
1368
|
-
"
|
|
1369
|
-
|
|
1370
|
-
{
|
|
1371
|
-
"type": "some",
|
|
1372
|
-
"flags": [
|
|
1373
|
-
{
|
|
1374
|
-
"name": "result-format"
|
|
1375
|
-
}
|
|
1376
|
-
]
|
|
1377
|
-
}
|
|
1333
|
+
"dependsOn": [
|
|
1334
|
+
"file"
|
|
1378
1335
|
],
|
|
1379
|
-
"
|
|
1336
|
+
"name": "line-ending",
|
|
1337
|
+
"summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LF`.",
|
|
1380
1338
|
"hasDynamicHelp": false,
|
|
1381
1339
|
"multiple": false,
|
|
1382
1340
|
"options": [
|
|
1383
|
-
"
|
|
1384
|
-
"
|
|
1341
|
+
"CRLF",
|
|
1342
|
+
"LF"
|
|
1385
1343
|
],
|
|
1386
1344
|
"type": "option"
|
|
1345
|
+
},
|
|
1346
|
+
"hard-delete": {
|
|
1347
|
+
"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.",
|
|
1348
|
+
"name": "hard-delete",
|
|
1349
|
+
"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.",
|
|
1350
|
+
"allowNo": false,
|
|
1351
|
+
"type": "boolean"
|
|
1387
1352
|
}
|
|
1388
1353
|
},
|
|
1389
1354
|
"hasDynamicHelp": true,
|
|
1390
1355
|
"hiddenAliases": [],
|
|
1391
|
-
"id": "data:
|
|
1356
|
+
"id": "data:delete:bulk",
|
|
1392
1357
|
"pluginAlias": "@salesforce/plugin-data",
|
|
1393
1358
|
"pluginName": "@salesforce/plugin-data",
|
|
1394
1359
|
"pluginType": "core",
|
|
1395
1360
|
"strict": true,
|
|
1396
|
-
"summary": "Bulk
|
|
1361
|
+
"summary": "Bulk delete records from an org using a CSV file. Uses Bulk API 2.0.",
|
|
1397
1362
|
"enableJsonFlag": true,
|
|
1398
1363
|
"isESM": true,
|
|
1399
1364
|
"relativePath": [
|
|
1400
1365
|
"lib",
|
|
1401
1366
|
"commands",
|
|
1402
1367
|
"data",
|
|
1403
|
-
"
|
|
1368
|
+
"delete",
|
|
1404
1369
|
"bulk.js"
|
|
1405
1370
|
],
|
|
1406
1371
|
"aliasPermutations": [],
|
|
1407
1372
|
"permutations": [
|
|
1408
|
-
"data:
|
|
1409
|
-
"
|
|
1410
|
-
"
|
|
1411
|
-
"data:bulk:
|
|
1412
|
-
"bulk:data:
|
|
1413
|
-
"bulk:
|
|
1373
|
+
"data:delete:bulk",
|
|
1374
|
+
"delete:data:bulk",
|
|
1375
|
+
"delete:bulk:data",
|
|
1376
|
+
"data:bulk:delete",
|
|
1377
|
+
"bulk:data:delete",
|
|
1378
|
+
"bulk:delete:data"
|
|
1414
1379
|
]
|
|
1415
1380
|
},
|
|
1416
|
-
"data:
|
|
1417
|
-
"aliases": [
|
|
1381
|
+
"data:delete:record": {
|
|
1382
|
+
"aliases": [
|
|
1383
|
+
"force:data:record:delete"
|
|
1384
|
+
],
|
|
1418
1385
|
"args": {},
|
|
1419
|
-
"
|
|
1386
|
+
"deprecateAliases": true,
|
|
1387
|
+
"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.",
|
|
1420
1388
|
"examples": [
|
|
1421
|
-
"
|
|
1422
|
-
"
|
|
1389
|
+
"Delete a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX",
|
|
1390
|
+
"Delete a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name=Acme\"",
|
|
1391
|
+
"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",
|
|
1392
|
+
"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"
|
|
1423
1393
|
],
|
|
1424
1394
|
"flags": {
|
|
1425
1395
|
"json": {
|
|
@@ -1437,67 +1407,158 @@
|
|
|
1437
1407
|
"multiple": false,
|
|
1438
1408
|
"type": "option"
|
|
1439
1409
|
},
|
|
1440
|
-
"
|
|
1410
|
+
"target-org": {
|
|
1411
|
+
"aliases": [
|
|
1412
|
+
"targetusername",
|
|
1413
|
+
"u"
|
|
1414
|
+
],
|
|
1415
|
+
"char": "o",
|
|
1416
|
+
"deprecateAliases": true,
|
|
1417
|
+
"name": "target-org",
|
|
1418
|
+
"noCacheDefault": true,
|
|
1419
|
+
"required": true,
|
|
1420
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1421
|
+
"hasDynamicHelp": true,
|
|
1422
|
+
"multiple": false,
|
|
1423
|
+
"type": "option"
|
|
1424
|
+
},
|
|
1425
|
+
"api-version": {
|
|
1426
|
+
"aliases": [
|
|
1427
|
+
"apiversion"
|
|
1428
|
+
],
|
|
1429
|
+
"deprecateAliases": true,
|
|
1430
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1431
|
+
"name": "api-version",
|
|
1432
|
+
"hasDynamicHelp": false,
|
|
1433
|
+
"multiple": false,
|
|
1434
|
+
"type": "option"
|
|
1435
|
+
},
|
|
1436
|
+
"loglevel": {
|
|
1437
|
+
"deprecated": {
|
|
1438
|
+
"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."
|
|
1439
|
+
},
|
|
1440
|
+
"hidden": true,
|
|
1441
|
+
"name": "loglevel",
|
|
1442
|
+
"hasDynamicHelp": false,
|
|
1443
|
+
"multiple": false,
|
|
1444
|
+
"type": "option"
|
|
1445
|
+
},
|
|
1446
|
+
"sobject": {
|
|
1447
|
+
"aliases": [
|
|
1448
|
+
"sobjecttype"
|
|
1449
|
+
],
|
|
1450
|
+
"char": "s",
|
|
1451
|
+
"deprecateAliases": true,
|
|
1452
|
+
"name": "sobject",
|
|
1453
|
+
"required": true,
|
|
1454
|
+
"summary": "API name of the Salesforce or Tooling API object that you're deleting a record from.",
|
|
1455
|
+
"hasDynamicHelp": false,
|
|
1456
|
+
"multiple": false,
|
|
1457
|
+
"type": "option"
|
|
1458
|
+
},
|
|
1459
|
+
"record-id": {
|
|
1460
|
+
"aliases": [
|
|
1461
|
+
"sobjectid"
|
|
1462
|
+
],
|
|
1441
1463
|
"char": "i",
|
|
1442
|
-
"
|
|
1443
|
-
"
|
|
1464
|
+
"deprecateAliases": true,
|
|
1465
|
+
"name": "record-id",
|
|
1466
|
+
"summary": "ID of the record you’re deleting.",
|
|
1444
1467
|
"hasDynamicHelp": false,
|
|
1445
1468
|
"multiple": false,
|
|
1446
1469
|
"type": "option"
|
|
1447
1470
|
},
|
|
1448
|
-
"
|
|
1449
|
-
"
|
|
1450
|
-
"
|
|
1451
|
-
"
|
|
1452
|
-
"type": "boolean"
|
|
1453
|
-
},
|
|
1454
|
-
"api-version": {
|
|
1455
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1456
|
-
"name": "api-version",
|
|
1471
|
+
"where": {
|
|
1472
|
+
"char": "w",
|
|
1473
|
+
"name": "where",
|
|
1474
|
+
"summary": "List of <fieldName>=<value> pairs that identify the record you want to delete.",
|
|
1457
1475
|
"hasDynamicHelp": false,
|
|
1458
1476
|
"multiple": false,
|
|
1459
1477
|
"type": "option"
|
|
1478
|
+
},
|
|
1479
|
+
"use-tooling-api": {
|
|
1480
|
+
"aliases": [
|
|
1481
|
+
"usetoolingapi"
|
|
1482
|
+
],
|
|
1483
|
+
"char": "t",
|
|
1484
|
+
"deprecateAliases": true,
|
|
1485
|
+
"name": "use-tooling-api",
|
|
1486
|
+
"summary": "Use Tooling API so you can delete a record from a Tooling API object.",
|
|
1487
|
+
"allowNo": false,
|
|
1488
|
+
"type": "boolean"
|
|
1489
|
+
},
|
|
1490
|
+
"perflog": {
|
|
1491
|
+
"deprecated": {
|
|
1492
|
+
"version": "57"
|
|
1493
|
+
},
|
|
1494
|
+
"description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
|
|
1495
|
+
"hidden": true,
|
|
1496
|
+
"name": "perflog",
|
|
1497
|
+
"summary": "Get API performance data.",
|
|
1498
|
+
"allowNo": false,
|
|
1499
|
+
"type": "boolean"
|
|
1460
1500
|
}
|
|
1461
1501
|
},
|
|
1462
|
-
"hasDynamicHelp":
|
|
1502
|
+
"hasDynamicHelp": true,
|
|
1463
1503
|
"hiddenAliases": [],
|
|
1464
|
-
"id": "data:
|
|
1504
|
+
"id": "data:delete:record",
|
|
1465
1505
|
"pluginAlias": "@salesforce/plugin-data",
|
|
1466
1506
|
"pluginName": "@salesforce/plugin-data",
|
|
1467
1507
|
"pluginType": "core",
|
|
1468
1508
|
"strict": true,
|
|
1469
|
-
"summary": "
|
|
1509
|
+
"summary": "Deletes a single record from a Salesforce or Tooling API object.",
|
|
1470
1510
|
"enableJsonFlag": true,
|
|
1471
1511
|
"isESM": true,
|
|
1472
1512
|
"relativePath": [
|
|
1473
1513
|
"lib",
|
|
1474
1514
|
"commands",
|
|
1475
1515
|
"data",
|
|
1476
|
-
"
|
|
1477
|
-
"
|
|
1516
|
+
"delete",
|
|
1517
|
+
"record.js"
|
|
1518
|
+
],
|
|
1519
|
+
"aliasPermutations": [
|
|
1520
|
+
"force:data:record:delete",
|
|
1521
|
+
"data:force:record:delete",
|
|
1522
|
+
"data:record:force:delete",
|
|
1523
|
+
"data:record:delete:force",
|
|
1524
|
+
"force:record:data:delete",
|
|
1525
|
+
"record:force:data:delete",
|
|
1526
|
+
"record:data:force:delete",
|
|
1527
|
+
"record:data:delete:force",
|
|
1528
|
+
"force:record:delete:data",
|
|
1529
|
+
"record:force:delete:data",
|
|
1530
|
+
"record:delete:force:data",
|
|
1531
|
+
"record:delete:data:force",
|
|
1532
|
+
"force:data:delete:record",
|
|
1533
|
+
"data:force:delete:record",
|
|
1534
|
+
"data:delete:force:record",
|
|
1535
|
+
"data:delete:record:force",
|
|
1536
|
+
"force:delete:data:record",
|
|
1537
|
+
"delete:force:data:record",
|
|
1538
|
+
"delete:data:force:record",
|
|
1539
|
+
"delete:data:record:force",
|
|
1540
|
+
"force:delete:record:data",
|
|
1541
|
+
"delete:force:record:data",
|
|
1542
|
+
"delete:record:force:data",
|
|
1543
|
+
"delete:record:data:force"
|
|
1478
1544
|
],
|
|
1479
|
-
"aliasPermutations": [],
|
|
1480
1545
|
"permutations": [
|
|
1481
|
-
"data:
|
|
1482
|
-
"
|
|
1483
|
-
"
|
|
1484
|
-
"data:
|
|
1485
|
-
"
|
|
1486
|
-
"
|
|
1546
|
+
"data:delete:record",
|
|
1547
|
+
"delete:data:record",
|
|
1548
|
+
"delete:record:data",
|
|
1549
|
+
"data:record:delete",
|
|
1550
|
+
"record:data:delete",
|
|
1551
|
+
"record:delete:data"
|
|
1487
1552
|
]
|
|
1488
1553
|
},
|
|
1489
|
-
"data:
|
|
1490
|
-
"aliases": [
|
|
1491
|
-
"force:data:tree:export",
|
|
1492
|
-
"data:export:beta:tree"
|
|
1493
|
-
],
|
|
1554
|
+
"data:delete:resume": {
|
|
1555
|
+
"aliases": [],
|
|
1494
1556
|
"args": {},
|
|
1495
1557
|
"deprecateAliases": true,
|
|
1496
|
-
"description": "
|
|
1558
|
+
"description": "The command uses the job ID returned by the \"<%= config.bin %> data delete bulk\" command or the most recently-run bulk delete job.",
|
|
1497
1559
|
"examples": [
|
|
1498
|
-
"
|
|
1499
|
-
"
|
|
1500
|
-
"Prepend \"export-demo\" before each generated file and generate the files in the \"export-out\" directory; run the command on the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --query query.txt --plan --prefix export-demo --output-dir export-out --target-org my-scratch"
|
|
1560
|
+
"Resume a bulk delete job from your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
|
|
1561
|
+
"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"
|
|
1501
1562
|
],
|
|
1502
1563
|
"flags": {
|
|
1503
1564
|
"json": {
|
|
@@ -1524,17 +1585,41 @@
|
|
|
1524
1585
|
"deprecateAliases": true,
|
|
1525
1586
|
"name": "target-org",
|
|
1526
1587
|
"noCacheDefault": true,
|
|
1527
|
-
"
|
|
1528
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1588
|
+
"summary": "Username or alias of the target org. Not required if the \"target-org\" configuration variable is already set.",
|
|
1529
1589
|
"hasDynamicHelp": true,
|
|
1530
1590
|
"multiple": false,
|
|
1531
1591
|
"type": "option"
|
|
1532
1592
|
},
|
|
1533
|
-
"
|
|
1593
|
+
"job-id": {
|
|
1534
1594
|
"aliases": [
|
|
1535
|
-
"
|
|
1595
|
+
"jobid"
|
|
1536
1596
|
],
|
|
1597
|
+
"char": "i",
|
|
1537
1598
|
"deprecateAliases": true,
|
|
1599
|
+
"name": "job-id",
|
|
1600
|
+
"summary": "ID of the job you want to resume.",
|
|
1601
|
+
"hasDynamicHelp": false,
|
|
1602
|
+
"multiple": false,
|
|
1603
|
+
"type": "option"
|
|
1604
|
+
},
|
|
1605
|
+
"use-most-recent": {
|
|
1606
|
+
"exclusive": [
|
|
1607
|
+
"job-id"
|
|
1608
|
+
],
|
|
1609
|
+
"name": "use-most-recent",
|
|
1610
|
+
"summary": "Use the ID of the most recently-run bulk job.",
|
|
1611
|
+
"allowNo": false,
|
|
1612
|
+
"type": "boolean"
|
|
1613
|
+
},
|
|
1614
|
+
"wait": {
|
|
1615
|
+
"name": "wait",
|
|
1616
|
+
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
1617
|
+
"default": "5 minutes",
|
|
1618
|
+
"hasDynamicHelp": true,
|
|
1619
|
+
"multiple": false,
|
|
1620
|
+
"type": "option"
|
|
1621
|
+
},
|
|
1622
|
+
"api-version": {
|
|
1538
1623
|
"description": "Override the api version used for api requests made by this command",
|
|
1539
1624
|
"name": "api-version",
|
|
1540
1625
|
"hasDynamicHelp": false,
|
|
@@ -1550,118 +1635,33 @@
|
|
|
1550
1635
|
"hasDynamicHelp": false,
|
|
1551
1636
|
"multiple": false,
|
|
1552
1637
|
"type": "option"
|
|
1553
|
-
},
|
|
1554
|
-
"query": {
|
|
1555
|
-
"char": "q",
|
|
1556
|
-
"name": "query",
|
|
1557
|
-
"required": true,
|
|
1558
|
-
"summary": "SOQL query, or filepath of a file that contains the query, to retrieve records.",
|
|
1559
|
-
"hasDynamicHelp": false,
|
|
1560
|
-
"multiple": true,
|
|
1561
|
-
"type": "option"
|
|
1562
|
-
},
|
|
1563
|
-
"plan": {
|
|
1564
|
-
"char": "p",
|
|
1565
|
-
"name": "plan",
|
|
1566
|
-
"summary": "Generate multiple sObject tree files and a plan definition file for aggregated import.",
|
|
1567
|
-
"allowNo": false,
|
|
1568
|
-
"type": "boolean"
|
|
1569
|
-
},
|
|
1570
|
-
"prefix": {
|
|
1571
|
-
"char": "x",
|
|
1572
|
-
"name": "prefix",
|
|
1573
|
-
"summary": "Prefix of generated files.",
|
|
1574
|
-
"hasDynamicHelp": false,
|
|
1575
|
-
"multiple": false,
|
|
1576
|
-
"type": "option"
|
|
1577
|
-
},
|
|
1578
|
-
"output-dir": {
|
|
1579
|
-
"aliases": [
|
|
1580
|
-
"outputdir"
|
|
1581
|
-
],
|
|
1582
|
-
"char": "d",
|
|
1583
|
-
"deprecateAliases": true,
|
|
1584
|
-
"name": "output-dir",
|
|
1585
|
-
"summary": "Directory in which to generate the JSON files; default is current directory.",
|
|
1586
|
-
"hasDynamicHelp": false,
|
|
1587
|
-
"multiple": false,
|
|
1588
|
-
"type": "option"
|
|
1589
1638
|
}
|
|
1590
1639
|
},
|
|
1591
1640
|
"hasDynamicHelp": true,
|
|
1592
1641
|
"hiddenAliases": [],
|
|
1593
|
-
"id": "data:
|
|
1642
|
+
"id": "data:delete:resume",
|
|
1594
1643
|
"pluginAlias": "@salesforce/plugin-data",
|
|
1595
1644
|
"pluginName": "@salesforce/plugin-data",
|
|
1596
1645
|
"pluginType": "core",
|
|
1597
1646
|
"strict": true,
|
|
1598
|
-
"summary": "
|
|
1647
|
+
"summary": "Resume a bulk delete job that you previously started. Uses Bulk API 2.0.",
|
|
1599
1648
|
"enableJsonFlag": true,
|
|
1600
1649
|
"isESM": true,
|
|
1601
1650
|
"relativePath": [
|
|
1602
1651
|
"lib",
|
|
1603
1652
|
"commands",
|
|
1604
1653
|
"data",
|
|
1605
|
-
"
|
|
1606
|
-
"
|
|
1607
|
-
],
|
|
1608
|
-
"aliasPermutations": [
|
|
1609
|
-
"force:data:tree:export",
|
|
1610
|
-
"data:force:tree:export",
|
|
1611
|
-
"data:tree:force:export",
|
|
1612
|
-
"data:tree:export:force",
|
|
1613
|
-
"force:tree:data:export",
|
|
1614
|
-
"tree:force:data:export",
|
|
1615
|
-
"tree:data:force:export",
|
|
1616
|
-
"tree:data:export:force",
|
|
1617
|
-
"force:tree:export:data",
|
|
1618
|
-
"tree:force:export:data",
|
|
1619
|
-
"tree:export:force:data",
|
|
1620
|
-
"tree:export:data:force",
|
|
1621
|
-
"force:data:export:tree",
|
|
1622
|
-
"data:force:export:tree",
|
|
1623
|
-
"data:export:force:tree",
|
|
1624
|
-
"data:export:tree:force",
|
|
1625
|
-
"force:export:data:tree",
|
|
1626
|
-
"export:force:data:tree",
|
|
1627
|
-
"export:data:force:tree",
|
|
1628
|
-
"export:data:tree:force",
|
|
1629
|
-
"force:export:tree:data",
|
|
1630
|
-
"export:force:tree:data",
|
|
1631
|
-
"export:tree:force:data",
|
|
1632
|
-
"export:tree:data:force",
|
|
1633
|
-
"data:export:beta:tree",
|
|
1634
|
-
"export:data:beta:tree",
|
|
1635
|
-
"export:beta:data:tree",
|
|
1636
|
-
"export:beta:tree:data",
|
|
1637
|
-
"data:beta:export:tree",
|
|
1638
|
-
"beta:data:export:tree",
|
|
1639
|
-
"beta:export:data:tree",
|
|
1640
|
-
"beta:export:tree:data",
|
|
1641
|
-
"data:beta:tree:export",
|
|
1642
|
-
"beta:data:tree:export",
|
|
1643
|
-
"beta:tree:data:export",
|
|
1644
|
-
"beta:tree:export:data",
|
|
1645
|
-
"data:export:tree:beta",
|
|
1646
|
-
"export:data:tree:beta",
|
|
1647
|
-
"export:tree:data:beta",
|
|
1648
|
-
"export:tree:beta:data",
|
|
1649
|
-
"data:tree:export:beta",
|
|
1650
|
-
"tree:data:export:beta",
|
|
1651
|
-
"tree:export:data:beta",
|
|
1652
|
-
"tree:export:beta:data",
|
|
1653
|
-
"data:tree:beta:export",
|
|
1654
|
-
"tree:data:beta:export",
|
|
1655
|
-
"tree:beta:data:export",
|
|
1656
|
-
"tree:beta:export:data"
|
|
1654
|
+
"delete",
|
|
1655
|
+
"resume.js"
|
|
1657
1656
|
],
|
|
1657
|
+
"aliasPermutations": [],
|
|
1658
1658
|
"permutations": [
|
|
1659
|
-
"data:
|
|
1660
|
-
"
|
|
1661
|
-
"
|
|
1662
|
-
"data:
|
|
1663
|
-
"
|
|
1664
|
-
"
|
|
1659
|
+
"data:delete:resume",
|
|
1660
|
+
"delete:data:resume",
|
|
1661
|
+
"delete:resume:data",
|
|
1662
|
+
"data:resume:delete",
|
|
1663
|
+
"resume:data:delete",
|
|
1664
|
+
"resume:delete:data"
|
|
1665
1665
|
]
|
|
1666
1666
|
},
|
|
1667
1667
|
"data:get:record": {
|
|
@@ -2218,6 +2218,9 @@
|
|
|
2218
2218
|
],
|
|
2219
2219
|
"args": {},
|
|
2220
2220
|
"deprecateAliases": true,
|
|
2221
|
+
"deprecationOptions": {
|
|
2222
|
+
"message": "Bulk mode for \"data query\" is deprecated, this command will be removed after April 2025.\nUse \"data export bulk | data export resume\" for bulk queries instead.\n"
|
|
2223
|
+
},
|
|
2221
2224
|
"description": "Run this command using the job ID returned from the \"<%= config.bin %> data query --bulk\" command.",
|
|
2222
2225
|
"examples": [
|
|
2223
2226
|
"View the status of a bulk query with the specified ID:\n<%= config.bin %> <%= command.id %> --bulk-query-id 7500x000005BdFzXXX"
|
|
@@ -2316,6 +2319,7 @@
|
|
|
2316
2319
|
"pluginAlias": "@salesforce/plugin-data",
|
|
2317
2320
|
"pluginName": "@salesforce/plugin-data",
|
|
2318
2321
|
"pluginType": "core",
|
|
2322
|
+
"state": "deprecated",
|
|
2319
2323
|
"strict": true,
|
|
2320
2324
|
"summary": "View the status of a bulk query.",
|
|
2321
2325
|
"enableJsonFlag": true,
|
|
@@ -3897,5 +3901,5 @@
|
|
|
3897
3901
|
]
|
|
3898
3902
|
}
|
|
3899
3903
|
},
|
|
3900
|
-
"version": "3.13.
|
|
3904
|
+
"version": "3.13.4"
|
|
3901
3905
|
}
|