@salesforce/plugin-data 4.0.8 → 4.0.10

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.
Files changed (3) hide show
  1. package/README.md +25 -25
  2. package/oclif.manifest.json +500 -500
  3. package/package.json +6 -6
package/oclif.manifest.json CHANGED
@@ -775,13 +775,18 @@
775
775
  "record:create:data"
776
776
  ]
777
777
  },
778
- "data:delete:bulk": {
779
- "aliases": [],
778
+ "data:get:record": {
779
+ "aliases": [
780
+ "force:data:record:get"
781
+ ],
780
782
  "args": {},
781
- "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.",
783
+ "deprecateAliases": true,
784
+ "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.",
782
785
  "examples": [
783
- "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",
784
- "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"
786
+ "Retrieve and display a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX",
787
+ "Retrieve a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name=Acme\"",
788
+ "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",
789
+ "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"
785
790
  ],
786
791
  "flags": {
787
792
  "json": {
@@ -835,124 +840,121 @@
835
840
  "multiple": false,
836
841
  "type": "option"
837
842
  },
838
- "file": {
843
+ "sobject": {
839
844
  "aliases": [
840
- "csvfile"
845
+ "sobjecttype"
841
846
  ],
842
- "char": "f",
847
+ "char": "s",
843
848
  "deprecateAliases": true,
844
- "name": "file",
849
+ "name": "sobject",
845
850
  "required": true,
846
- "summary": "CSV file that contains the IDs of the records to update or delete.",
851
+ "summary": "API name of the Salesforce or Tooling API object that you're retrieving a record from.",
847
852
  "hasDynamicHelp": false,
848
853
  "multiple": false,
849
854
  "type": "option"
850
855
  },
851
- "sobject": {
856
+ "record-id": {
852
857
  "aliases": [
853
- "sobjecttype"
858
+ "sobjectid"
854
859
  ],
855
- "char": "s",
860
+ "char": "i",
856
861
  "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.",
862
+ "name": "record-id",
863
+ "summary": "ID of the record you’re retrieving.",
860
864
  "hasDynamicHelp": false,
861
865
  "multiple": false,
862
866
  "type": "option"
863
867
  },
864
- "wait": {
868
+ "where": {
865
869
  "char": "w",
866
- "exclusive": [
867
- "async"
868
- ],
869
- "name": "wait",
870
- "summary": "Number of minutes to wait for the command to complete before displaying the results.",
871
- "default": "0 minutes",
872
- "hasDynamicHelp": true,
870
+ "name": "where",
871
+ "summary": "List of <fieldName>=<value> pairs that identify the record you want to display.",
872
+ "hasDynamicHelp": false,
873
873
  "multiple": false,
874
874
  "type": "option"
875
875
  },
876
- "async": {
877
- "char": "a",
878
- "exclusive": [
879
- "wait"
876
+ "use-tooling-api": {
877
+ "aliases": [
878
+ "usetoolingapi"
880
879
  ],
881
- "name": "async",
882
- "summary": "Run the command asynchronously.",
880
+ "char": "t",
881
+ "deprecateAliases": true,
882
+ "name": "use-tooling-api",
883
+ "summary": "Use Tooling API so you can retrieve a record from a Tooling API object.",
883
884
  "allowNo": false,
884
885
  "type": "boolean"
885
886
  },
886
- "verbose": {
887
+ "perflog": {
887
888
  "deprecated": {
888
- "message": "The --verbose flag is deprecated and will be removed after March 2025, use \"sf data bulk results\" to get job results instead."
889
+ "version": "57"
889
890
  },
890
- "name": "verbose",
891
- "summary": "Print verbose output of failed records if result is available.",
892
- "allowNo": false,
893
- "type": "boolean"
894
- },
895
- "line-ending": {
896
- "dependsOn": [
897
- "file"
898
- ],
899
- "name": "line-ending",
900
- "summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LF`.",
901
- "hasDynamicHelp": false,
902
- "multiple": false,
903
- "options": [
904
- "CRLF",
905
- "LF"
906
- ],
907
- "type": "option"
908
- },
909
- "hard-delete": {
910
- "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.",
911
- "name": "hard-delete",
912
- "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.",
891
+ "description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
892
+ "hidden": true,
893
+ "name": "perflog",
894
+ "summary": "Get API performance data.",
913
895
  "allowNo": false,
914
896
  "type": "boolean"
915
897
  }
916
898
  },
917
899
  "hasDynamicHelp": true,
918
900
  "hiddenAliases": [],
919
- "id": "data:delete:bulk",
901
+ "id": "data:get:record",
920
902
  "pluginAlias": "@salesforce/plugin-data",
921
903
  "pluginName": "@salesforce/plugin-data",
922
904
  "pluginType": "core",
923
905
  "strict": true,
924
- "summary": "Bulk delete records from an org using a CSV file. Uses Bulk API 2.0.",
906
+ "summary": "Retrieve and display a single record of a Salesforce or Tooling API object.",
925
907
  "enableJsonFlag": true,
926
908
  "isESM": true,
927
909
  "relativePath": [
928
910
  "lib",
929
911
  "commands",
930
912
  "data",
931
- "delete",
932
- "bulk.js"
913
+ "get",
914
+ "record.js"
915
+ ],
916
+ "aliasPermutations": [
917
+ "force:data:record:get",
918
+ "data:force:record:get",
919
+ "data:record:force:get",
920
+ "data:record:get:force",
921
+ "force:record:data:get",
922
+ "record:force:data:get",
923
+ "record:data:force:get",
924
+ "record:data:get:force",
925
+ "force:record:get:data",
926
+ "record:force:get:data",
927
+ "record:get:force:data",
928
+ "record:get:data:force",
929
+ "force:data:get:record",
930
+ "data:force:get:record",
931
+ "data:get:force:record",
932
+ "data:get:record:force",
933
+ "force:get:data:record",
934
+ "get:force:data:record",
935
+ "get:data:force:record",
936
+ "get:data:record:force",
937
+ "force:get:record:data",
938
+ "get:force:record:data",
939
+ "get:record:force:data",
940
+ "get:record:data:force"
933
941
  ],
934
- "aliasPermutations": [],
935
942
  "permutations": [
936
- "data:delete:bulk",
937
- "delete:data:bulk",
938
- "delete:bulk:data",
939
- "data:bulk:delete",
940
- "bulk:data:delete",
941
- "bulk:delete:data"
943
+ "data:get:record",
944
+ "get:data:record",
945
+ "get:record:data",
946
+ "data:record:get",
947
+ "record:data:get",
948
+ "record:get:data"
942
949
  ]
943
950
  },
944
- "data:delete:record": {
945
- "aliases": [
946
- "force:data:record:delete"
947
- ],
951
+ "data:import:bulk": {
952
+ "aliases": [],
948
953
  "args": {},
949
- "deprecateAliases": true,
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.",
954
+ "description": "You can use this command to import millions of records into the object from a file in comma-separated values (CSV) format.\n\nAll the records in the CSV file must be for the same Salesforce object. Specify the object with the `--sobject` flag.\n\nBulk imports can take a while, depending on how many records are in the CSV file. If the command times out, or you specified the --async flag, the command displays the job ID. To see the status and get the results of the job, run \"sf data import resume\" and pass the job ID to the --job-id flag.\n\nFor information and examples about how to prepare your CSV files, see \"Prepare Data to Ingest\" in the \"Bulk API 2.0 and Bulk API Developer Guide\" (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_prepare_data.htm).",
951
955
  "examples": [
952
- "Delete a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX",
953
- "Delete a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name=Acme\"",
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"
956
+ "Import Account records from a CSV-formatted file into an org with alias \"my-scratch\"; if the import doesn't complete in 10 minutes, the command ends and displays a job ID:\n<%= config.bin %> <%= command.id %> --file accounts.csv --sobject Account --wait 10 --target-org my-scratch",
957
+ "Import asynchronously and use the default org; the command immediately returns a job ID that you then pass to the \"sf data import resume\" command:\n<%= config.bin %> <%= command.id %> --file accounts.csv --sobject Account --async"
956
958
  ],
957
959
  "flags": {
958
960
  "json": {
@@ -970,158 +972,204 @@
970
972
  "multiple": false,
971
973
  "type": "option"
972
974
  },
973
- "target-org": {
974
- "aliases": [
975
- "targetusername",
976
- "u"
975
+ "async": {
976
+ "char": "a",
977
+ "exclusive": [
978
+ "wait"
977
979
  ],
978
- "char": "o",
979
- "deprecateAliases": true,
980
- "name": "target-org",
981
- "noCacheDefault": true,
980
+ "name": "async",
981
+ "summary": "Don't wait for the command to complete.",
982
+ "allowNo": false,
983
+ "type": "boolean"
984
+ },
985
+ "file": {
986
+ "char": "f",
987
+ "name": "file",
982
988
  "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,
989
+ "summary": "CSV file that contains the Salesforce object records you want to import.",
990
+ "hasDynamicHelp": false,
991
+ "multiple": false,
992
+ "type": "option"
993
+ },
994
+ "sobject": {
995
+ "char": "s",
996
+ "name": "sobject",
997
+ "required": true,
998
+ "summary": "API name of the Salesforce object, either standard or custom, into which you're importing records.",
999
+ "hasDynamicHelp": false,
985
1000
  "multiple": false,
986
1001
  "type": "option"
987
1002
  },
988
1003
  "api-version": {
989
- "aliases": [
990
- "apiversion"
991
- ],
992
- "deprecateAliases": true,
993
1004
  "description": "Override the api version used for api requests made by this command",
994
1005
  "name": "api-version",
995
1006
  "hasDynamicHelp": false,
996
1007
  "multiple": false,
997
1008
  "type": "option"
998
1009
  },
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,
1010
+ "wait": {
1011
+ "char": "w",
1012
+ "exclusive": [
1013
+ "async"
1014
+ ],
1015
+ "name": "wait",
1016
+ "summary": "Time to wait for the command to finish, in minutes.",
1017
+ "hasDynamicHelp": true,
1006
1018
  "multiple": false,
1007
1019
  "type": "option"
1008
1020
  },
1009
- "sobject": {
1010
- "aliases": [
1011
- "sobjecttype"
1012
- ],
1013
- "char": "s",
1014
- "deprecateAliases": true,
1015
- "name": "sobject",
1021
+ "target-org": {
1022
+ "char": "o",
1023
+ "name": "target-org",
1024
+ "noCacheDefault": true,
1016
1025
  "required": true,
1017
- "summary": "API name of the Salesforce or Tooling API object that you're deleting a record from.",
1018
- "hasDynamicHelp": false,
1026
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1027
+ "hasDynamicHelp": true,
1019
1028
  "multiple": false,
1020
1029
  "type": "option"
1021
1030
  },
1022
- "record-id": {
1023
- "aliases": [
1024
- "sobjectid"
1031
+ "line-ending": {
1032
+ "dependsOn": [
1033
+ "file"
1025
1034
  ],
1026
- "char": "i",
1027
- "deprecateAliases": true,
1028
- "name": "record-id",
1029
- "summary": "ID of the record you’re deleting.",
1035
+ "name": "line-ending",
1036
+ "summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LF`.",
1030
1037
  "hasDynamicHelp": false,
1031
1038
  "multiple": false,
1039
+ "options": [
1040
+ "CRLF",
1041
+ "LF"
1042
+ ],
1032
1043
  "type": "option"
1033
1044
  },
1034
- "where": {
1035
- "char": "w",
1036
- "name": "where",
1037
- "summary": "List of <fieldName>=<value> pairs that identify the record you want to delete.",
1045
+ "column-delimiter": {
1046
+ "name": "column-delimiter",
1047
+ "summary": "Column delimiter used in the CSV file.",
1038
1048
  "hasDynamicHelp": false,
1039
1049
  "multiple": false,
1040
- "type": "option"
1041
- },
1042
- "use-tooling-api": {
1043
- "aliases": [
1044
- "usetoolingapi"
1050
+ "options": [
1051
+ "BACKQUOTE",
1052
+ "CARET",
1053
+ "COMMA",
1054
+ "PIPE",
1055
+ "SEMICOLON",
1056
+ "TAB"
1045
1057
  ],
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.",
1058
+ "type": "option"
1059
+ }
1060
+ },
1061
+ "hasDynamicHelp": true,
1062
+ "hiddenAliases": [],
1063
+ "id": "data:import:bulk",
1064
+ "pluginAlias": "@salesforce/plugin-data",
1065
+ "pluginName": "@salesforce/plugin-data",
1066
+ "pluginType": "core",
1067
+ "strict": true,
1068
+ "summary": "Bulk import records into a Salesforce object from a CSV file. Uses Bulk API 2.0.",
1069
+ "enableJsonFlag": true,
1070
+ "isESM": true,
1071
+ "relativePath": [
1072
+ "lib",
1073
+ "commands",
1074
+ "data",
1075
+ "import",
1076
+ "bulk.js"
1077
+ ],
1078
+ "aliasPermutations": [],
1079
+ "permutations": [
1080
+ "data:import:bulk",
1081
+ "import:data:bulk",
1082
+ "import:bulk:data",
1083
+ "data:bulk:import",
1084
+ "bulk:data:import",
1085
+ "bulk:import:data"
1086
+ ]
1087
+ },
1088
+ "data:import:resume": {
1089
+ "aliases": [],
1090
+ "args": {},
1091
+ "description": "When the original \"sf data import 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 import, run this command by either passing it the job ID or using the --use-most-recent flag to specify the most recent bulk import job.",
1092
+ "examples": [
1093
+ "Resume a bulk import job to your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
1094
+ "Resume the most recently run bulk import job for an org with alias my-scratch:\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-scratch"
1095
+ ],
1096
+ "flags": {
1097
+ "json": {
1098
+ "description": "Format output as json.",
1099
+ "helpGroup": "GLOBAL",
1100
+ "name": "json",
1050
1101
  "allowNo": false,
1051
1102
  "type": "boolean"
1052
1103
  },
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.",
1104
+ "flags-dir": {
1105
+ "helpGroup": "GLOBAL",
1106
+ "name": "flags-dir",
1107
+ "summary": "Import flag values from a directory.",
1108
+ "hasDynamicHelp": false,
1109
+ "multiple": false,
1110
+ "type": "option"
1111
+ },
1112
+ "use-most-recent": {
1113
+ "name": "use-most-recent",
1114
+ "summary": "Use the job ID of the bulk import job that was most recently run.",
1061
1115
  "allowNo": false,
1062
1116
  "type": "boolean"
1117
+ },
1118
+ "job-id": {
1119
+ "char": "i",
1120
+ "name": "job-id",
1121
+ "summary": "Job ID of the bulk import.",
1122
+ "hasDynamicHelp": false,
1123
+ "multiple": false,
1124
+ "type": "option"
1125
+ },
1126
+ "wait": {
1127
+ "char": "w",
1128
+ "name": "wait",
1129
+ "summary": "Time to wait for the command to finish, in minutes.",
1130
+ "default": "5 minutes",
1131
+ "hasDynamicHelp": true,
1132
+ "multiple": false,
1133
+ "type": "option"
1063
1134
  }
1064
1135
  },
1065
1136
  "hasDynamicHelp": true,
1066
1137
  "hiddenAliases": [],
1067
- "id": "data:delete:record",
1138
+ "id": "data:import:resume",
1068
1139
  "pluginAlias": "@salesforce/plugin-data",
1069
1140
  "pluginName": "@salesforce/plugin-data",
1070
1141
  "pluginType": "core",
1071
1142
  "strict": true,
1072
- "summary": "Deletes a single record from a Salesforce or Tooling API object.",
1143
+ "summary": "Resume a bulk import job that you previously started. Uses Bulk API 2.0.",
1073
1144
  "enableJsonFlag": true,
1074
1145
  "isESM": true,
1075
1146
  "relativePath": [
1076
1147
  "lib",
1077
1148
  "commands",
1078
1149
  "data",
1079
- "delete",
1080
- "record.js"
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"
1150
+ "import",
1151
+ "resume.js"
1107
1152
  ],
1153
+ "aliasPermutations": [],
1108
1154
  "permutations": [
1109
- "data:delete:record",
1110
- "delete:data:record",
1111
- "delete:record:data",
1112
- "data:record:delete",
1113
- "record:data:delete",
1114
- "record:delete:data"
1155
+ "data:import:resume",
1156
+ "import:data:resume",
1157
+ "import:resume:data",
1158
+ "data:resume:import",
1159
+ "resume:data:import",
1160
+ "resume:import:data"
1115
1161
  ]
1116
1162
  },
1117
- "data:delete:resume": {
1118
- "aliases": [],
1163
+ "data:import:tree": {
1164
+ "aliases": [
1165
+ "force:data:tree:import"
1166
+ ],
1119
1167
  "args": {},
1120
1168
  "deprecateAliases": true,
1121
- "description": "The command uses the job ID returned by the \"<%= config.bin %> data delete bulk\" command or the most recently-run bulk delete job.",
1169
+ "description": "The JSON files that contain the data are in sObject tree format, which is a collection of nested, parent-child records with a single root record. Use the \"<%= config.bin %> data export tree\" command to generate these JSON files.\n\nIf you used the --plan flag when exporting the data to generate a plan definition file, use the --plan flag to reference the file when you import. If you're not using a plan, use the --files flag to list the files. If you specify multiple JSON files that depend on each other in a parent-child relationship, be sure you list them in the correct order.",
1122
1170
  "examples": [
1123
- "Resume a bulk delete job from your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
1124
- "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"
1171
+ "Import the records contained in two JSON files into the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --files Contact.json,Account.json --target-org my-scratch",
1172
+ "Import records using a plan definition file into your default org:\n<%= config.bin %> <%= command.id %> --plan Account-Contact-plan.json"
1125
1173
  ],
1126
1174
  "flags": {
1127
1175
  "json": {
@@ -1148,41 +1196,17 @@
1148
1196
  "deprecateAliases": true,
1149
1197
  "name": "target-org",
1150
1198
  "noCacheDefault": true,
1151
- "summary": "Username or alias of the target org. Not required if the \"target-org\" configuration variable is already set.",
1199
+ "required": true,
1200
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1152
1201
  "hasDynamicHelp": true,
1153
1202
  "multiple": false,
1154
1203
  "type": "option"
1155
1204
  },
1156
- "job-id": {
1205
+ "api-version": {
1157
1206
  "aliases": [
1158
- "jobid"
1207
+ "apiversion"
1159
1208
  ],
1160
- "char": "i",
1161
1209
  "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
1210
  "description": "Override the api version used for api requests made by this command",
1187
1211
  "name": "api-version",
1188
1212
  "hasDynamicHelp": false,
@@ -1198,33 +1222,80 @@
1198
1222
  "hasDynamicHelp": false,
1199
1223
  "multiple": false,
1200
1224
  "type": "option"
1225
+ },
1226
+ "files": {
1227
+ "aliases": [
1228
+ "sobjecttreefiles"
1229
+ ],
1230
+ "char": "f",
1231
+ "deprecateAliases": true,
1232
+ "name": "files",
1233
+ "summary": "Comma-separated and in-order JSON files that contain the records, in sObject tree format, that you want to insert.",
1234
+ "delimiter": ",",
1235
+ "hasDynamicHelp": false,
1236
+ "multiple": true,
1237
+ "type": "option"
1238
+ },
1239
+ "plan": {
1240
+ "char": "p",
1241
+ "description": "Unlike when you use the `--files` flag, the files listed in the plan definition file **can** contain more then 200 records. When the CLI executes the import, it automatically batches the records to comply with the 200 record limit set by the API.\n\nThe order in which you list the files in the plan definition file matters. Specifically, records with lookups to records in another file should be listed AFTER that file. For example, let's say you're loading Account and Contact records, and the contacts have references to those accounts. Be sure you list the Accounts file before the Contacts file.\n\nThe plan definition file has the following schema:\n\n- items(object) - SObject Type: Definition of records to be insert per SObject Type\n - sobject(string) - Name of SObject: Child file references must have SObject roots of this type\n - files(array) - Files: An array of files paths to load",
1242
+ "name": "plan",
1243
+ "summary": "Plan definition file to insert multiple data files.",
1244
+ "hasDynamicHelp": false,
1245
+ "multiple": false,
1246
+ "type": "option"
1201
1247
  }
1202
1248
  },
1203
1249
  "hasDynamicHelp": true,
1204
1250
  "hiddenAliases": [],
1205
- "id": "data:delete:resume",
1251
+ "id": "data:import:tree",
1206
1252
  "pluginAlias": "@salesforce/plugin-data",
1207
1253
  "pluginName": "@salesforce/plugin-data",
1208
1254
  "pluginType": "core",
1209
1255
  "strict": true,
1210
- "summary": "Resume a bulk delete job that you previously started. Uses Bulk API 2.0.",
1256
+ "summary": "Import data from one or more JSON files into an org.",
1211
1257
  "enableJsonFlag": true,
1212
1258
  "isESM": true,
1213
1259
  "relativePath": [
1214
1260
  "lib",
1215
1261
  "commands",
1216
1262
  "data",
1217
- "delete",
1218
- "resume.js"
1263
+ "import",
1264
+ "tree.js"
1265
+ ],
1266
+ "aliasPermutations": [
1267
+ "force:data:tree:import",
1268
+ "data:force:tree:import",
1269
+ "data:tree:force:import",
1270
+ "data:tree:import:force",
1271
+ "force:tree:data:import",
1272
+ "tree:force:data:import",
1273
+ "tree:data:force:import",
1274
+ "tree:data:import:force",
1275
+ "force:tree:import:data",
1276
+ "tree:force:import:data",
1277
+ "tree:import:force:data",
1278
+ "tree:import:data:force",
1279
+ "force:data:import:tree",
1280
+ "data:force:import:tree",
1281
+ "data:import:force:tree",
1282
+ "data:import:tree:force",
1283
+ "force:import:data:tree",
1284
+ "import:force:data:tree",
1285
+ "import:data:force:tree",
1286
+ "import:data:tree:force",
1287
+ "force:import:tree:data",
1288
+ "import:force:tree:data",
1289
+ "import:tree:force:data",
1290
+ "import:tree:data:force"
1219
1291
  ],
1220
- "aliasPermutations": [],
1221
1292
  "permutations": [
1222
- "data:delete:resume",
1223
- "delete:data:resume",
1224
- "delete:resume:data",
1225
- "data:resume:delete",
1226
- "resume:data:delete",
1227
- "resume:delete:data"
1293
+ "data:import:tree",
1294
+ "import:data:tree",
1295
+ "import:tree:data",
1296
+ "data:tree:import",
1297
+ "tree:data:import",
1298
+ "tree:import:data"
1228
1299
  ]
1229
1300
  },
1230
1301
  "data:export:bulk": {
@@ -1639,18 +1710,13 @@
1639
1710
  "tree:export:data"
1640
1711
  ]
1641
1712
  },
1642
- "data:get:record": {
1643
- "aliases": [
1644
- "force:data:record:get"
1645
- ],
1713
+ "data:delete:bulk": {
1714
+ "aliases": [],
1646
1715
  "args": {},
1647
- "deprecateAliases": true,
1648
- "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.",
1716
+ "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.",
1649
1717
  "examples": [
1650
- "Retrieve and display a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX",
1651
- "Retrieve a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name=Acme\"",
1652
- "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",
1653
- "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"
1718
+ "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",
1719
+ "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"
1654
1720
  ],
1655
1721
  "flags": {
1656
1722
  "json": {
@@ -1704,121 +1770,124 @@
1704
1770
  "multiple": false,
1705
1771
  "type": "option"
1706
1772
  },
1707
- "sobject": {
1773
+ "file": {
1708
1774
  "aliases": [
1709
- "sobjecttype"
1775
+ "csvfile"
1710
1776
  ],
1711
- "char": "s",
1777
+ "char": "f",
1712
1778
  "deprecateAliases": true,
1713
- "name": "sobject",
1779
+ "name": "file",
1714
1780
  "required": true,
1715
- "summary": "API name of the Salesforce or Tooling API object that you're retrieving a record from.",
1781
+ "summary": "CSV file that contains the IDs of the records to update or delete.",
1716
1782
  "hasDynamicHelp": false,
1717
1783
  "multiple": false,
1718
1784
  "type": "option"
1719
1785
  },
1720
- "record-id": {
1786
+ "sobject": {
1721
1787
  "aliases": [
1722
- "sobjectid"
1788
+ "sobjecttype"
1723
1789
  ],
1724
- "char": "i",
1790
+ "char": "s",
1725
1791
  "deprecateAliases": true,
1726
- "name": "record-id",
1727
- "summary": "ID of the record you’re retrieving.",
1792
+ "name": "sobject",
1793
+ "required": true,
1794
+ "summary": "API name of the Salesforce object, either standard or custom, that you want to update or delete records from.",
1728
1795
  "hasDynamicHelp": false,
1729
1796
  "multiple": false,
1730
1797
  "type": "option"
1731
1798
  },
1732
- "where": {
1799
+ "wait": {
1733
1800
  "char": "w",
1734
- "name": "where",
1735
- "summary": "List of <fieldName>=<value> pairs that identify the record you want to display.",
1736
- "hasDynamicHelp": false,
1801
+ "exclusive": [
1802
+ "async"
1803
+ ],
1804
+ "name": "wait",
1805
+ "summary": "Number of minutes to wait for the command to complete before displaying the results.",
1806
+ "default": "0 minutes",
1807
+ "hasDynamicHelp": true,
1737
1808
  "multiple": false,
1738
1809
  "type": "option"
1739
1810
  },
1740
- "use-tooling-api": {
1741
- "aliases": [
1742
- "usetoolingapi"
1811
+ "async": {
1812
+ "char": "a",
1813
+ "exclusive": [
1814
+ "wait"
1743
1815
  ],
1744
- "char": "t",
1745
- "deprecateAliases": true,
1746
- "name": "use-tooling-api",
1747
- "summary": "Use Tooling API so you can retrieve a record from a Tooling API object.",
1816
+ "name": "async",
1817
+ "summary": "Run the command asynchronously.",
1748
1818
  "allowNo": false,
1749
1819
  "type": "boolean"
1750
1820
  },
1751
- "perflog": {
1821
+ "verbose": {
1752
1822
  "deprecated": {
1753
- "version": "57"
1823
+ "message": "The --verbose flag is deprecated and will be removed after March 2025, use \"sf data bulk results\" to get job results instead."
1754
1824
  },
1755
- "description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
1756
- "hidden": true,
1757
- "name": "perflog",
1758
- "summary": "Get API performance data.",
1825
+ "name": "verbose",
1826
+ "summary": "Print verbose output of failed records if result is available.",
1827
+ "allowNo": false,
1828
+ "type": "boolean"
1829
+ },
1830
+ "line-ending": {
1831
+ "dependsOn": [
1832
+ "file"
1833
+ ],
1834
+ "name": "line-ending",
1835
+ "summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LF`.",
1836
+ "hasDynamicHelp": false,
1837
+ "multiple": false,
1838
+ "options": [
1839
+ "CRLF",
1840
+ "LF"
1841
+ ],
1842
+ "type": "option"
1843
+ },
1844
+ "hard-delete": {
1845
+ "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.",
1846
+ "name": "hard-delete",
1847
+ "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.",
1759
1848
  "allowNo": false,
1760
1849
  "type": "boolean"
1761
1850
  }
1762
1851
  },
1763
1852
  "hasDynamicHelp": true,
1764
1853
  "hiddenAliases": [],
1765
- "id": "data:get:record",
1854
+ "id": "data:delete:bulk",
1766
1855
  "pluginAlias": "@salesforce/plugin-data",
1767
1856
  "pluginName": "@salesforce/plugin-data",
1768
1857
  "pluginType": "core",
1769
1858
  "strict": true,
1770
- "summary": "Retrieve and display a single record of a Salesforce or Tooling API object.",
1859
+ "summary": "Bulk delete records from an org using a CSV file. Uses Bulk API 2.0.",
1771
1860
  "enableJsonFlag": true,
1772
1861
  "isESM": true,
1773
1862
  "relativePath": [
1774
1863
  "lib",
1775
1864
  "commands",
1776
1865
  "data",
1777
- "get",
1778
- "record.js"
1779
- ],
1780
- "aliasPermutations": [
1781
- "force:data:record:get",
1782
- "data:force:record:get",
1783
- "data:record:force:get",
1784
- "data:record:get:force",
1785
- "force:record:data:get",
1786
- "record:force:data:get",
1787
- "record:data:force:get",
1788
- "record:data:get:force",
1789
- "force:record:get:data",
1790
- "record:force:get:data",
1791
- "record:get:force:data",
1792
- "record:get:data:force",
1793
- "force:data:get:record",
1794
- "data:force:get:record",
1795
- "data:get:force:record",
1796
- "data:get:record:force",
1797
- "force:get:data:record",
1798
- "get:force:data:record",
1799
- "get:data:force:record",
1800
- "get:data:record:force",
1801
- "force:get:record:data",
1802
- "get:force:record:data",
1803
- "get:record:force:data",
1804
- "get:record:data:force"
1866
+ "delete",
1867
+ "bulk.js"
1805
1868
  ],
1869
+ "aliasPermutations": [],
1806
1870
  "permutations": [
1807
- "data:get:record",
1808
- "get:data:record",
1809
- "get:record:data",
1810
- "data:record:get",
1811
- "record:data:get",
1812
- "record:get:data"
1871
+ "data:delete:bulk",
1872
+ "delete:data:bulk",
1873
+ "delete:bulk:data",
1874
+ "data:bulk:delete",
1875
+ "bulk:data:delete",
1876
+ "bulk:delete:data"
1813
1877
  ]
1814
1878
  },
1815
- "data:import:bulk": {
1816
- "aliases": [],
1879
+ "data:delete:record": {
1880
+ "aliases": [
1881
+ "force:data:record:delete"
1882
+ ],
1817
1883
  "args": {},
1818
- "description": "You can use this command to import millions of records into the object from a file in comma-separated values (CSV) format.\n\nAll the records in the CSV file must be for the same Salesforce object. Specify the object with the `--sobject` flag.\n\nBulk imports can take a while, depending on how many records are in the CSV file. If the command times out, or you specified the --async flag, the command displays the job ID. To see the status and get the results of the job, run \"sf data import resume\" and pass the job ID to the --job-id flag.\n\nFor information and examples about how to prepare your CSV files, see \"Prepare Data to Ingest\" in the \"Bulk API 2.0 and Bulk API Developer Guide\" (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_prepare_data.htm).",
1884
+ "deprecateAliases": true,
1885
+ "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.",
1819
1886
  "examples": [
1820
- "Import Account records from a CSV-formatted file into an org with alias \"my-scratch\"; if the import doesn't complete in 10 minutes, the command ends and displays a job ID:\n<%= config.bin %> <%= command.id %> --file accounts.csv --sobject Account --wait 10 --target-org my-scratch",
1821
- "Import asynchronously and use the default org; the command immediately returns a job ID that you then pass to the \"sf data import resume\" command:\n<%= config.bin %> <%= command.id %> --file accounts.csv --sobject Account --async"
1887
+ "Delete a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX",
1888
+ "Delete a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name=Acme\"",
1889
+ "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",
1890
+ "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"
1822
1891
  ],
1823
1892
  "flags": {
1824
1893
  "json": {
@@ -1836,204 +1905,158 @@
1836
1905
  "multiple": false,
1837
1906
  "type": "option"
1838
1907
  },
1839
- "async": {
1840
- "char": "a",
1841
- "exclusive": [
1842
- "wait"
1908
+ "target-org": {
1909
+ "aliases": [
1910
+ "targetusername",
1911
+ "u"
1843
1912
  ],
1844
- "name": "async",
1845
- "summary": "Don't wait for the command to complete.",
1846
- "allowNo": false,
1847
- "type": "boolean"
1848
- },
1849
- "file": {
1850
- "char": "f",
1851
- "name": "file",
1852
- "required": true,
1853
- "summary": "CSV file that contains the Salesforce object records you want to import.",
1854
- "hasDynamicHelp": false,
1855
- "multiple": false,
1856
- "type": "option"
1857
- },
1858
- "sobject": {
1859
- "char": "s",
1860
- "name": "sobject",
1913
+ "char": "o",
1914
+ "deprecateAliases": true,
1915
+ "name": "target-org",
1916
+ "noCacheDefault": true,
1861
1917
  "required": true,
1862
- "summary": "API name of the Salesforce object, either standard or custom, into which you're importing records.",
1863
- "hasDynamicHelp": false,
1918
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1919
+ "hasDynamicHelp": true,
1864
1920
  "multiple": false,
1865
1921
  "type": "option"
1866
1922
  },
1867
1923
  "api-version": {
1924
+ "aliases": [
1925
+ "apiversion"
1926
+ ],
1927
+ "deprecateAliases": true,
1868
1928
  "description": "Override the api version used for api requests made by this command",
1869
1929
  "name": "api-version",
1870
1930
  "hasDynamicHelp": false,
1871
1931
  "multiple": false,
1872
1932
  "type": "option"
1873
1933
  },
1874
- "wait": {
1875
- "char": "w",
1876
- "exclusive": [
1877
- "async"
1878
- ],
1879
- "name": "wait",
1880
- "summary": "Time to wait for the command to finish, in minutes.",
1881
- "hasDynamicHelp": true,
1934
+ "loglevel": {
1935
+ "deprecated": {
1936
+ "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."
1937
+ },
1938
+ "hidden": true,
1939
+ "name": "loglevel",
1940
+ "hasDynamicHelp": false,
1882
1941
  "multiple": false,
1883
1942
  "type": "option"
1884
1943
  },
1885
- "target-org": {
1886
- "char": "o",
1887
- "name": "target-org",
1888
- "noCacheDefault": true,
1944
+ "sobject": {
1945
+ "aliases": [
1946
+ "sobjecttype"
1947
+ ],
1948
+ "char": "s",
1949
+ "deprecateAliases": true,
1950
+ "name": "sobject",
1889
1951
  "required": true,
1890
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1891
- "hasDynamicHelp": true,
1952
+ "summary": "API name of the Salesforce or Tooling API object that you're deleting a record from.",
1953
+ "hasDynamicHelp": false,
1892
1954
  "multiple": false,
1893
1955
  "type": "option"
1894
1956
  },
1895
- "line-ending": {
1896
- "dependsOn": [
1897
- "file"
1957
+ "record-id": {
1958
+ "aliases": [
1959
+ "sobjectid"
1898
1960
  ],
1899
- "name": "line-ending",
1900
- "summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LF`.",
1961
+ "char": "i",
1962
+ "deprecateAliases": true,
1963
+ "name": "record-id",
1964
+ "summary": "ID of the record you’re deleting.",
1901
1965
  "hasDynamicHelp": false,
1902
1966
  "multiple": false,
1903
- "options": [
1904
- "CRLF",
1905
- "LF"
1906
- ],
1907
1967
  "type": "option"
1908
1968
  },
1909
- "column-delimiter": {
1910
- "name": "column-delimiter",
1911
- "summary": "Column delimiter used in the CSV file.",
1969
+ "where": {
1970
+ "char": "w",
1971
+ "name": "where",
1972
+ "summary": "List of <fieldName>=<value> pairs that identify the record you want to delete.",
1912
1973
  "hasDynamicHelp": false,
1913
1974
  "multiple": false,
1914
- "options": [
1915
- "BACKQUOTE",
1916
- "CARET",
1917
- "COMMA",
1918
- "PIPE",
1919
- "SEMICOLON",
1920
- "TAB"
1921
- ],
1922
1975
  "type": "option"
1923
- }
1924
- },
1925
- "hasDynamicHelp": true,
1926
- "hiddenAliases": [],
1927
- "id": "data:import:bulk",
1928
- "pluginAlias": "@salesforce/plugin-data",
1929
- "pluginName": "@salesforce/plugin-data",
1930
- "pluginType": "core",
1931
- "strict": true,
1932
- "summary": "Bulk import records into a Salesforce object from a CSV file. Uses Bulk API 2.0.",
1933
- "enableJsonFlag": true,
1934
- "isESM": true,
1935
- "relativePath": [
1936
- "lib",
1937
- "commands",
1938
- "data",
1939
- "import",
1940
- "bulk.js"
1941
- ],
1942
- "aliasPermutations": [],
1943
- "permutations": [
1944
- "data:import:bulk",
1945
- "import:data:bulk",
1946
- "import:bulk:data",
1947
- "data:bulk:import",
1948
- "bulk:data:import",
1949
- "bulk:import:data"
1950
- ]
1951
- },
1952
- "data:import:resume": {
1953
- "aliases": [],
1954
- "args": {},
1955
- "description": "When the original \"sf data import 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 import, run this command by either passing it the job ID or using the --use-most-recent flag to specify the most recent bulk import job.",
1956
- "examples": [
1957
- "Resume a bulk import job to your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
1958
- "Resume the most recently run bulk import job for an org with alias my-scratch:\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-scratch"
1959
- ],
1960
- "flags": {
1961
- "json": {
1962
- "description": "Format output as json.",
1963
- "helpGroup": "GLOBAL",
1964
- "name": "json",
1976
+ },
1977
+ "use-tooling-api": {
1978
+ "aliases": [
1979
+ "usetoolingapi"
1980
+ ],
1981
+ "char": "t",
1982
+ "deprecateAliases": true,
1983
+ "name": "use-tooling-api",
1984
+ "summary": "Use Tooling API so you can delete a record from a Tooling API object.",
1965
1985
  "allowNo": false,
1966
1986
  "type": "boolean"
1967
1987
  },
1968
- "flags-dir": {
1969
- "helpGroup": "GLOBAL",
1970
- "name": "flags-dir",
1971
- "summary": "Import flag values from a directory.",
1972
- "hasDynamicHelp": false,
1973
- "multiple": false,
1974
- "type": "option"
1975
- },
1976
- "use-most-recent": {
1977
- "name": "use-most-recent",
1978
- "summary": "Use the job ID of the bulk import job that was most recently run.",
1988
+ "perflog": {
1989
+ "deprecated": {
1990
+ "version": "57"
1991
+ },
1992
+ "description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
1993
+ "hidden": true,
1994
+ "name": "perflog",
1995
+ "summary": "Get API performance data.",
1979
1996
  "allowNo": false,
1980
1997
  "type": "boolean"
1981
- },
1982
- "job-id": {
1983
- "char": "i",
1984
- "name": "job-id",
1985
- "summary": "Job ID of the bulk import.",
1986
- "hasDynamicHelp": false,
1987
- "multiple": false,
1988
- "type": "option"
1989
- },
1990
- "wait": {
1991
- "char": "w",
1992
- "name": "wait",
1993
- "summary": "Time to wait for the command to finish, in minutes.",
1994
- "default": "5 minutes",
1995
- "hasDynamicHelp": true,
1996
- "multiple": false,
1997
- "type": "option"
1998
1998
  }
1999
1999
  },
2000
2000
  "hasDynamicHelp": true,
2001
2001
  "hiddenAliases": [],
2002
- "id": "data:import:resume",
2002
+ "id": "data:delete:record",
2003
2003
  "pluginAlias": "@salesforce/plugin-data",
2004
2004
  "pluginName": "@salesforce/plugin-data",
2005
2005
  "pluginType": "core",
2006
2006
  "strict": true,
2007
- "summary": "Resume a bulk import job that you previously started. Uses Bulk API 2.0.",
2007
+ "summary": "Deletes a single record from a Salesforce or Tooling API object.",
2008
2008
  "enableJsonFlag": true,
2009
2009
  "isESM": true,
2010
2010
  "relativePath": [
2011
2011
  "lib",
2012
2012
  "commands",
2013
2013
  "data",
2014
- "import",
2015
- "resume.js"
2014
+ "delete",
2015
+ "record.js"
2016
+ ],
2017
+ "aliasPermutations": [
2018
+ "force:data:record:delete",
2019
+ "data:force:record:delete",
2020
+ "data:record:force:delete",
2021
+ "data:record:delete:force",
2022
+ "force:record:data:delete",
2023
+ "record:force:data:delete",
2024
+ "record:data:force:delete",
2025
+ "record:data:delete:force",
2026
+ "force:record:delete:data",
2027
+ "record:force:delete:data",
2028
+ "record:delete:force:data",
2029
+ "record:delete:data:force",
2030
+ "force:data:delete:record",
2031
+ "data:force:delete:record",
2032
+ "data:delete:force:record",
2033
+ "data:delete:record:force",
2034
+ "force:delete:data:record",
2035
+ "delete:force:data:record",
2036
+ "delete:data:force:record",
2037
+ "delete:data:record:force",
2038
+ "force:delete:record:data",
2039
+ "delete:force:record:data",
2040
+ "delete:record:force:data",
2041
+ "delete:record:data:force"
2016
2042
  ],
2017
- "aliasPermutations": [],
2018
2043
  "permutations": [
2019
- "data:import:resume",
2020
- "import:data:resume",
2021
- "import:resume:data",
2022
- "data:resume:import",
2023
- "resume:data:import",
2024
- "resume:import:data"
2044
+ "data:delete:record",
2045
+ "delete:data:record",
2046
+ "delete:record:data",
2047
+ "data:record:delete",
2048
+ "record:data:delete",
2049
+ "record:delete:data"
2025
2050
  ]
2026
2051
  },
2027
- "data:import:tree": {
2028
- "aliases": [
2029
- "force:data:tree:import"
2030
- ],
2052
+ "data:delete:resume": {
2053
+ "aliases": [],
2031
2054
  "args": {},
2032
2055
  "deprecateAliases": true,
2033
- "description": "The JSON files that contain the data are in sObject tree format, which is a collection of nested, parent-child records with a single root record. Use the \"<%= config.bin %> data export tree\" command to generate these JSON files.\n\nIf you used the --plan flag when exporting the data to generate a plan definition file, use the --plan flag to reference the file when you import. If you're not using a plan, use the --files flag to list the files. If you specify multiple JSON files that depend on each other in a parent-child relationship, be sure you list them in the correct order.",
2056
+ "description": "The command uses the job ID returned by the \"<%= config.bin %> data delete bulk\" command or the most recently-run bulk delete job.",
2034
2057
  "examples": [
2035
- "Import the records contained in two JSON files into the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --files Contact.json,Account.json --target-org my-scratch",
2036
- "Import records using a plan definition file into your default org:\n<%= config.bin %> <%= command.id %> --plan Account-Contact-plan.json"
2058
+ "Resume a bulk delete job from your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
2059
+ "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"
2037
2060
  ],
2038
2061
  "flags": {
2039
2062
  "json": {
@@ -2060,17 +2083,41 @@
2060
2083
  "deprecateAliases": true,
2061
2084
  "name": "target-org",
2062
2085
  "noCacheDefault": true,
2063
- "required": true,
2064
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2086
+ "summary": "Username or alias of the target org. Not required if the \"target-org\" configuration variable is already set.",
2065
2087
  "hasDynamicHelp": true,
2066
2088
  "multiple": false,
2067
2089
  "type": "option"
2068
2090
  },
2069
- "api-version": {
2091
+ "job-id": {
2070
2092
  "aliases": [
2071
- "apiversion"
2093
+ "jobid"
2072
2094
  ],
2095
+ "char": "i",
2073
2096
  "deprecateAliases": true,
2097
+ "name": "job-id",
2098
+ "summary": "ID of the job you want to resume.",
2099
+ "hasDynamicHelp": false,
2100
+ "multiple": false,
2101
+ "type": "option"
2102
+ },
2103
+ "use-most-recent": {
2104
+ "exclusive": [
2105
+ "job-id"
2106
+ ],
2107
+ "name": "use-most-recent",
2108
+ "summary": "Use the ID of the most recently-run bulk job.",
2109
+ "allowNo": false,
2110
+ "type": "boolean"
2111
+ },
2112
+ "wait": {
2113
+ "name": "wait",
2114
+ "summary": "Number of minutes to wait for the command to complete before displaying the results.",
2115
+ "default": "5 minutes",
2116
+ "hasDynamicHelp": true,
2117
+ "multiple": false,
2118
+ "type": "option"
2119
+ },
2120
+ "api-version": {
2074
2121
  "description": "Override the api version used for api requests made by this command",
2075
2122
  "name": "api-version",
2076
2123
  "hasDynamicHelp": false,
@@ -2086,80 +2133,33 @@
2086
2133
  "hasDynamicHelp": false,
2087
2134
  "multiple": false,
2088
2135
  "type": "option"
2089
- },
2090
- "files": {
2091
- "aliases": [
2092
- "sobjecttreefiles"
2093
- ],
2094
- "char": "f",
2095
- "deprecateAliases": true,
2096
- "name": "files",
2097
- "summary": "Comma-separated and in-order JSON files that contain the records, in sObject tree format, that you want to insert.",
2098
- "delimiter": ",",
2099
- "hasDynamicHelp": false,
2100
- "multiple": true,
2101
- "type": "option"
2102
- },
2103
- "plan": {
2104
- "char": "p",
2105
- "description": "Unlike when you use the `--files` flag, the files listed in the plan definition file **can** contain more then 200 records. When the CLI executes the import, it automatically batches the records to comply with the 200 record limit set by the API.\n\nThe order in which you list the files in the plan definition file matters. Specifically, records with lookups to records in another file should be listed AFTER that file. For example, let's say you're loading Account and Contact records, and the contacts have references to those accounts. Be sure you list the Accounts file before the Contacts file.\n\nThe plan definition file has the following schema:\n\n- items(object) - SObject Type: Definition of records to be insert per SObject Type\n - sobject(string) - Name of SObject: Child file references must have SObject roots of this type\n - files(array) - Files: An array of files paths to load",
2106
- "name": "plan",
2107
- "summary": "Plan definition file to insert multiple data files.",
2108
- "hasDynamicHelp": false,
2109
- "multiple": false,
2110
- "type": "option"
2111
2136
  }
2112
2137
  },
2113
2138
  "hasDynamicHelp": true,
2114
2139
  "hiddenAliases": [],
2115
- "id": "data:import:tree",
2140
+ "id": "data:delete:resume",
2116
2141
  "pluginAlias": "@salesforce/plugin-data",
2117
2142
  "pluginName": "@salesforce/plugin-data",
2118
2143
  "pluginType": "core",
2119
2144
  "strict": true,
2120
- "summary": "Import data from one or more JSON files into an org.",
2145
+ "summary": "Resume a bulk delete job that you previously started. Uses Bulk API 2.0.",
2121
2146
  "enableJsonFlag": true,
2122
2147
  "isESM": true,
2123
2148
  "relativePath": [
2124
2149
  "lib",
2125
2150
  "commands",
2126
2151
  "data",
2127
- "import",
2128
- "tree.js"
2129
- ],
2130
- "aliasPermutations": [
2131
- "force:data:tree:import",
2132
- "data:force:tree:import",
2133
- "data:tree:force:import",
2134
- "data:tree:import:force",
2135
- "force:tree:data:import",
2136
- "tree:force:data:import",
2137
- "tree:data:force:import",
2138
- "tree:data:import:force",
2139
- "force:tree:import:data",
2140
- "tree:force:import:data",
2141
- "tree:import:force:data",
2142
- "tree:import:data:force",
2143
- "force:data:import:tree",
2144
- "data:force:import:tree",
2145
- "data:import:force:tree",
2146
- "data:import:tree:force",
2147
- "force:import:data:tree",
2148
- "import:force:data:tree",
2149
- "import:data:force:tree",
2150
- "import:data:tree:force",
2151
- "force:import:tree:data",
2152
- "import:force:tree:data",
2153
- "import:tree:force:data",
2154
- "import:tree:data:force"
2152
+ "delete",
2153
+ "resume.js"
2155
2154
  ],
2155
+ "aliasPermutations": [],
2156
2156
  "permutations": [
2157
- "data:import:tree",
2158
- "import:data:tree",
2159
- "import:tree:data",
2160
- "data:tree:import",
2161
- "tree:data:import",
2162
- "tree:import:data"
2157
+ "data:delete:resume",
2158
+ "delete:data:resume",
2159
+ "delete:resume:data",
2160
+ "data:resume:delete",
2161
+ "resume:data:delete",
2162
+ "resume:delete:data"
2163
2163
  ]
2164
2164
  },
2165
2165
  "data:query:resume": {
@@ -3535,5 +3535,5 @@
3535
3535
  ]
3536
3536
  }
3537
3537
  },
3538
- "version": "4.0.8"
3538
+ "version": "4.0.10"
3539
3539
  }