@salesforce/plugin-data 4.0.10 → 4.0.11

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 +502 -502
  3. package/package.json +4 -4
@@ -775,18 +775,13 @@
775
775
  "record:create:data"
776
776
  ]
777
777
  },
778
- "data:get:record": {
779
- "aliases": [
780
- "force:data:record:get"
781
- ],
778
+ "data:delete:bulk": {
779
+ "aliases": [],
782
780
  "args": {},
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.",
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.",
785
782
  "examples": [
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"
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"
790
785
  ],
791
786
  "flags": {
792
787
  "json": {
@@ -840,121 +835,124 @@
840
835
  "multiple": false,
841
836
  "type": "option"
842
837
  },
843
- "sobject": {
838
+ "file": {
844
839
  "aliases": [
845
- "sobjecttype"
840
+ "csvfile"
846
841
  ],
847
- "char": "s",
842
+ "char": "f",
848
843
  "deprecateAliases": true,
849
- "name": "sobject",
844
+ "name": "file",
850
845
  "required": true,
851
- "summary": "API name of the Salesforce or Tooling API object that you're retrieving a record from.",
846
+ "summary": "CSV file that contains the IDs of the records to update or delete.",
852
847
  "hasDynamicHelp": false,
853
848
  "multiple": false,
854
849
  "type": "option"
855
850
  },
856
- "record-id": {
851
+ "sobject": {
857
852
  "aliases": [
858
- "sobjectid"
853
+ "sobjecttype"
859
854
  ],
860
- "char": "i",
855
+ "char": "s",
861
856
  "deprecateAliases": true,
862
- "name": "record-id",
863
- "summary": "ID of the record you’re retrieving.",
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.",
864
860
  "hasDynamicHelp": false,
865
861
  "multiple": false,
866
862
  "type": "option"
867
863
  },
868
- "where": {
864
+ "wait": {
869
865
  "char": "w",
870
- "name": "where",
871
- "summary": "List of <fieldName>=<value> pairs that identify the record you want to display.",
872
- "hasDynamicHelp": false,
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,
873
873
  "multiple": false,
874
874
  "type": "option"
875
875
  },
876
- "use-tooling-api": {
877
- "aliases": [
878
- "usetoolingapi"
876
+ "async": {
877
+ "char": "a",
878
+ "exclusive": [
879
+ "wait"
879
880
  ],
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.",
881
+ "name": "async",
882
+ "summary": "Run the command asynchronously.",
884
883
  "allowNo": false,
885
884
  "type": "boolean"
886
885
  },
887
- "perflog": {
886
+ "verbose": {
888
887
  "deprecated": {
889
- "version": "57"
888
+ "message": "The --verbose flag is deprecated and will be removed after March 2025, use \"sf data bulk results\" to get job results instead."
890
889
  },
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.",
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.",
895
913
  "allowNo": false,
896
914
  "type": "boolean"
897
915
  }
898
916
  },
899
917
  "hasDynamicHelp": true,
900
918
  "hiddenAliases": [],
901
- "id": "data:get:record",
919
+ "id": "data:delete:bulk",
902
920
  "pluginAlias": "@salesforce/plugin-data",
903
921
  "pluginName": "@salesforce/plugin-data",
904
922
  "pluginType": "core",
905
923
  "strict": true,
906
- "summary": "Retrieve and display a single record of a Salesforce or Tooling API object.",
924
+ "summary": "Bulk delete records from an org using a CSV file. Uses Bulk API 2.0.",
907
925
  "enableJsonFlag": true,
908
926
  "isESM": true,
909
927
  "relativePath": [
910
928
  "lib",
911
929
  "commands",
912
930
  "data",
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"
931
+ "delete",
932
+ "bulk.js"
941
933
  ],
934
+ "aliasPermutations": [],
942
935
  "permutations": [
943
- "data:get:record",
944
- "get:data:record",
945
- "get:record:data",
946
- "data:record:get",
947
- "record:data:get",
948
- "record:get:data"
936
+ "data:delete:bulk",
937
+ "delete:data:bulk",
938
+ "delete:bulk:data",
939
+ "data:bulk:delete",
940
+ "bulk:data:delete",
941
+ "bulk:delete:data"
949
942
  ]
950
943
  },
951
- "data:import:bulk": {
952
- "aliases": [],
944
+ "data:delete:record": {
945
+ "aliases": [
946
+ "force:data:record:delete"
947
+ ],
953
948
  "args": {},
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).",
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.",
955
951
  "examples": [
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"
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"
958
956
  ],
959
957
  "flags": {
960
958
  "json": {
@@ -972,204 +970,158 @@
972
970
  "multiple": false,
973
971
  "type": "option"
974
972
  },
975
- "async": {
976
- "char": "a",
977
- "exclusive": [
978
- "wait"
973
+ "target-org": {
974
+ "aliases": [
975
+ "targetusername",
976
+ "u"
979
977
  ],
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",
988
- "required": 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",
978
+ "char": "o",
979
+ "deprecateAliases": true,
980
+ "name": "target-org",
981
+ "noCacheDefault": true,
997
982
  "required": true,
998
- "summary": "API name of the Salesforce object, either standard or custom, into which you're importing records.",
999
- "hasDynamicHelp": false,
983
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
984
+ "hasDynamicHelp": true,
1000
985
  "multiple": false,
1001
986
  "type": "option"
1002
987
  },
1003
988
  "api-version": {
989
+ "aliases": [
990
+ "apiversion"
991
+ ],
992
+ "deprecateAliases": true,
1004
993
  "description": "Override the api version used for api requests made by this command",
1005
994
  "name": "api-version",
1006
995
  "hasDynamicHelp": false,
1007
996
  "multiple": false,
1008
997
  "type": "option"
1009
998
  },
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,
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,
1018
1006
  "multiple": false,
1019
1007
  "type": "option"
1020
1008
  },
1021
- "target-org": {
1022
- "char": "o",
1023
- "name": "target-org",
1024
- "noCacheDefault": true,
1009
+ "sobject": {
1010
+ "aliases": [
1011
+ "sobjecttype"
1012
+ ],
1013
+ "char": "s",
1014
+ "deprecateAliases": true,
1015
+ "name": "sobject",
1025
1016
  "required": true,
1026
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1027
- "hasDynamicHelp": true,
1017
+ "summary": "API name of the Salesforce or Tooling API object that you're deleting a record from.",
1018
+ "hasDynamicHelp": false,
1028
1019
  "multiple": false,
1029
1020
  "type": "option"
1030
1021
  },
1031
- "line-ending": {
1032
- "dependsOn": [
1033
- "file"
1022
+ "record-id": {
1023
+ "aliases": [
1024
+ "sobjectid"
1034
1025
  ],
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`.",
1026
+ "char": "i",
1027
+ "deprecateAliases": true,
1028
+ "name": "record-id",
1029
+ "summary": "ID of the record you’re deleting.",
1037
1030
  "hasDynamicHelp": false,
1038
1031
  "multiple": false,
1039
- "options": [
1040
- "CRLF",
1041
- "LF"
1042
- ],
1043
1032
  "type": "option"
1044
1033
  },
1045
- "column-delimiter": {
1046
- "name": "column-delimiter",
1047
- "summary": "Column delimiter used in the CSV file.",
1034
+ "where": {
1035
+ "char": "w",
1036
+ "name": "where",
1037
+ "summary": "List of <fieldName>=<value> pairs that identify the record you want to delete.",
1048
1038
  "hasDynamicHelp": false,
1049
1039
  "multiple": false,
1050
- "options": [
1051
- "BACKQUOTE",
1052
- "CARET",
1053
- "COMMA",
1054
- "PIPE",
1055
- "SEMICOLON",
1056
- "TAB"
1057
- ],
1058
1040
  "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",
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.",
1101
1050
  "allowNo": false,
1102
1051
  "type": "boolean"
1103
1052
  },
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.",
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.",
1115
1061
  "allowNo": false,
1116
1062
  "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"
1134
1063
  }
1135
1064
  },
1136
1065
  "hasDynamicHelp": true,
1137
1066
  "hiddenAliases": [],
1138
- "id": "data:import:resume",
1067
+ "id": "data:delete:record",
1139
1068
  "pluginAlias": "@salesforce/plugin-data",
1140
1069
  "pluginName": "@salesforce/plugin-data",
1141
1070
  "pluginType": "core",
1142
1071
  "strict": true,
1143
- "summary": "Resume a bulk import job that you previously started. Uses Bulk API 2.0.",
1072
+ "summary": "Deletes a single record from a Salesforce or Tooling API object.",
1144
1073
  "enableJsonFlag": true,
1145
1074
  "isESM": true,
1146
1075
  "relativePath": [
1147
1076
  "lib",
1148
1077
  "commands",
1149
1078
  "data",
1150
- "import",
1151
- "resume.js"
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"
1152
1107
  ],
1153
- "aliasPermutations": [],
1154
1108
  "permutations": [
1155
- "data:import:resume",
1156
- "import:data:resume",
1157
- "import:resume:data",
1158
- "data:resume:import",
1159
- "resume:data:import",
1160
- "resume:import:data"
1109
+ "data:delete:record",
1110
+ "delete:data:record",
1111
+ "delete:record:data",
1112
+ "data:record:delete",
1113
+ "record:data:delete",
1114
+ "record:delete:data"
1161
1115
  ]
1162
1116
  },
1163
- "data:import:tree": {
1164
- "aliases": [
1165
- "force:data:tree:import"
1166
- ],
1117
+ "data:delete:resume": {
1118
+ "aliases": [],
1167
1119
  "args": {},
1168
1120
  "deprecateAliases": true,
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.",
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.",
1170
1122
  "examples": [
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"
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"
1173
1125
  ],
1174
1126
  "flags": {
1175
1127
  "json": {
@@ -1196,17 +1148,41 @@
1196
1148
  "deprecateAliases": true,
1197
1149
  "name": "target-org",
1198
1150
  "noCacheDefault": true,
1199
- "required": true,
1200
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1151
+ "summary": "Username or alias of the target org. Not required if the \"target-org\" configuration variable is already set.",
1201
1152
  "hasDynamicHelp": true,
1202
1153
  "multiple": false,
1203
1154
  "type": "option"
1204
1155
  },
1205
- "api-version": {
1156
+ "job-id": {
1206
1157
  "aliases": [
1207
- "apiversion"
1158
+ "jobid"
1208
1159
  ],
1160
+ "char": "i",
1209
1161
  "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": {
1210
1186
  "description": "Override the api version used for api requests made by this command",
1211
1187
  "name": "api-version",
1212
1188
  "hasDynamicHelp": false,
@@ -1222,80 +1198,33 @@
1222
1198
  "hasDynamicHelp": false,
1223
1199
  "multiple": false,
1224
1200
  "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"
1247
1201
  }
1248
1202
  },
1249
1203
  "hasDynamicHelp": true,
1250
1204
  "hiddenAliases": [],
1251
- "id": "data:import:tree",
1205
+ "id": "data:delete:resume",
1252
1206
  "pluginAlias": "@salesforce/plugin-data",
1253
1207
  "pluginName": "@salesforce/plugin-data",
1254
1208
  "pluginType": "core",
1255
1209
  "strict": true,
1256
- "summary": "Import data from one or more JSON files into an org.",
1210
+ "summary": "Resume a bulk delete job that you previously started. Uses Bulk API 2.0.",
1257
1211
  "enableJsonFlag": true,
1258
1212
  "isESM": true,
1259
1213
  "relativePath": [
1260
1214
  "lib",
1261
1215
  "commands",
1262
1216
  "data",
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"
1217
+ "delete",
1218
+ "resume.js"
1291
1219
  ],
1220
+ "aliasPermutations": [],
1292
1221
  "permutations": [
1293
- "data:import:tree",
1294
- "import:data:tree",
1295
- "import:tree:data",
1296
- "data:tree:import",
1297
- "tree:data:import",
1298
- "tree:import:data"
1222
+ "data:delete:resume",
1223
+ "delete:data:resume",
1224
+ "delete:resume:data",
1225
+ "data:resume:delete",
1226
+ "resume:data:delete",
1227
+ "resume:delete:data"
1299
1228
  ]
1300
1229
  },
1301
1230
  "data:export:bulk": {
@@ -1710,15 +1639,20 @@
1710
1639
  "tree:export:data"
1711
1640
  ]
1712
1641
  },
1713
- "data:delete:bulk": {
1714
- "aliases": [],
1642
+ "data:get:record": {
1643
+ "aliases": [
1644
+ "force:data:record:get"
1645
+ ],
1715
1646
  "args": {},
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.",
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.",
1717
1649
  "examples": [
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"
1720
- ],
1721
- "flags": {
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"
1654
+ ],
1655
+ "flags": {
1722
1656
  "json": {
1723
1657
  "description": "Format output as json.",
1724
1658
  "helpGroup": "GLOBAL",
@@ -1770,124 +1704,121 @@
1770
1704
  "multiple": false,
1771
1705
  "type": "option"
1772
1706
  },
1773
- "file": {
1707
+ "sobject": {
1774
1708
  "aliases": [
1775
- "csvfile"
1709
+ "sobjecttype"
1776
1710
  ],
1777
- "char": "f",
1711
+ "char": "s",
1778
1712
  "deprecateAliases": true,
1779
- "name": "file",
1713
+ "name": "sobject",
1780
1714
  "required": true,
1781
- "summary": "CSV file that contains the IDs of the records to update or delete.",
1715
+ "summary": "API name of the Salesforce or Tooling API object that you're retrieving a record from.",
1782
1716
  "hasDynamicHelp": false,
1783
1717
  "multiple": false,
1784
1718
  "type": "option"
1785
1719
  },
1786
- "sobject": {
1720
+ "record-id": {
1787
1721
  "aliases": [
1788
- "sobjecttype"
1722
+ "sobjectid"
1789
1723
  ],
1790
- "char": "s",
1724
+ "char": "i",
1791
1725
  "deprecateAliases": true,
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.",
1726
+ "name": "record-id",
1727
+ "summary": "ID of the record you’re retrieving.",
1795
1728
  "hasDynamicHelp": false,
1796
1729
  "multiple": false,
1797
1730
  "type": "option"
1798
1731
  },
1799
- "wait": {
1732
+ "where": {
1800
1733
  "char": "w",
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,
1734
+ "name": "where",
1735
+ "summary": "List of <fieldName>=<value> pairs that identify the record you want to display.",
1736
+ "hasDynamicHelp": false,
1808
1737
  "multiple": false,
1809
1738
  "type": "option"
1810
1739
  },
1811
- "async": {
1812
- "char": "a",
1813
- "exclusive": [
1814
- "wait"
1740
+ "use-tooling-api": {
1741
+ "aliases": [
1742
+ "usetoolingapi"
1815
1743
  ],
1816
- "name": "async",
1817
- "summary": "Run the command asynchronously.",
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.",
1818
1748
  "allowNo": false,
1819
1749
  "type": "boolean"
1820
1750
  },
1821
- "verbose": {
1751
+ "perflog": {
1822
1752
  "deprecated": {
1823
- "message": "The --verbose flag is deprecated and will be removed after March 2025, use \"sf data bulk results\" to get job results instead."
1753
+ "version": "57"
1824
1754
  },
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.",
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.",
1848
1759
  "allowNo": false,
1849
1760
  "type": "boolean"
1850
1761
  }
1851
1762
  },
1852
1763
  "hasDynamicHelp": true,
1853
1764
  "hiddenAliases": [],
1854
- "id": "data:delete:bulk",
1765
+ "id": "data:get:record",
1855
1766
  "pluginAlias": "@salesforce/plugin-data",
1856
1767
  "pluginName": "@salesforce/plugin-data",
1857
1768
  "pluginType": "core",
1858
1769
  "strict": true,
1859
- "summary": "Bulk delete records from an org using a CSV file. Uses Bulk API 2.0.",
1770
+ "summary": "Retrieve and display a single record of a Salesforce or Tooling API object.",
1860
1771
  "enableJsonFlag": true,
1861
1772
  "isESM": true,
1862
1773
  "relativePath": [
1863
1774
  "lib",
1864
1775
  "commands",
1865
1776
  "data",
1866
- "delete",
1867
- "bulk.js"
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"
1868
1805
  ],
1869
- "aliasPermutations": [],
1870
1806
  "permutations": [
1871
- "data:delete:bulk",
1872
- "delete:data:bulk",
1873
- "delete:bulk:data",
1874
- "data:bulk:delete",
1875
- "bulk:data:delete",
1876
- "bulk:delete:data"
1807
+ "data:get:record",
1808
+ "get:data:record",
1809
+ "get:record:data",
1810
+ "data:record:get",
1811
+ "record:data:get",
1812
+ "record:get:data"
1877
1813
  ]
1878
1814
  },
1879
- "data:delete:record": {
1880
- "aliases": [
1881
- "force:data:record:delete"
1882
- ],
1815
+ "data:import:bulk": {
1816
+ "aliases": [],
1883
1817
  "args": {},
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.",
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).",
1886
1819
  "examples": [
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"
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"
1891
1822
  ],
1892
1823
  "flags": {
1893
1824
  "json": {
@@ -1905,158 +1836,204 @@
1905
1836
  "multiple": false,
1906
1837
  "type": "option"
1907
1838
  },
1908
- "target-org": {
1909
- "aliases": [
1910
- "targetusername",
1911
- "u"
1839
+ "async": {
1840
+ "char": "a",
1841
+ "exclusive": [
1842
+ "wait"
1912
1843
  ],
1913
- "char": "o",
1914
- "deprecateAliases": true,
1915
- "name": "target-org",
1916
- "noCacheDefault": true,
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",
1917
1852
  "required": true,
1918
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1919
- "hasDynamicHelp": 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",
1861
+ "required": true,
1862
+ "summary": "API name of the Salesforce object, either standard or custom, into which you're importing records.",
1863
+ "hasDynamicHelp": false,
1920
1864
  "multiple": false,
1921
1865
  "type": "option"
1922
1866
  },
1923
1867
  "api-version": {
1924
- "aliases": [
1925
- "apiversion"
1926
- ],
1927
- "deprecateAliases": true,
1928
1868
  "description": "Override the api version used for api requests made by this command",
1929
1869
  "name": "api-version",
1930
1870
  "hasDynamicHelp": false,
1931
1871
  "multiple": false,
1932
1872
  "type": "option"
1933
1873
  },
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,
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,
1941
1882
  "multiple": false,
1942
1883
  "type": "option"
1943
1884
  },
1944
- "sobject": {
1945
- "aliases": [
1946
- "sobjecttype"
1947
- ],
1948
- "char": "s",
1949
- "deprecateAliases": true,
1950
- "name": "sobject",
1885
+ "target-org": {
1886
+ "char": "o",
1887
+ "name": "target-org",
1888
+ "noCacheDefault": true,
1951
1889
  "required": true,
1952
- "summary": "API name of the Salesforce or Tooling API object that you're deleting a record from.",
1953
- "hasDynamicHelp": false,
1890
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1891
+ "hasDynamicHelp": true,
1954
1892
  "multiple": false,
1955
1893
  "type": "option"
1956
1894
  },
1957
- "record-id": {
1958
- "aliases": [
1959
- "sobjectid"
1895
+ "line-ending": {
1896
+ "dependsOn": [
1897
+ "file"
1960
1898
  ],
1961
- "char": "i",
1962
- "deprecateAliases": true,
1963
- "name": "record-id",
1964
- "summary": "ID of the record you’re deleting.",
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`.",
1965
1901
  "hasDynamicHelp": false,
1966
1902
  "multiple": false,
1903
+ "options": [
1904
+ "CRLF",
1905
+ "LF"
1906
+ ],
1967
1907
  "type": "option"
1968
1908
  },
1969
- "where": {
1970
- "char": "w",
1971
- "name": "where",
1972
- "summary": "List of <fieldName>=<value> pairs that identify the record you want to delete.",
1909
+ "column-delimiter": {
1910
+ "name": "column-delimiter",
1911
+ "summary": "Column delimiter used in the CSV file.",
1973
1912
  "hasDynamicHelp": false,
1974
1913
  "multiple": false,
1975
- "type": "option"
1976
- },
1977
- "use-tooling-api": {
1978
- "aliases": [
1979
- "usetoolingapi"
1914
+ "options": [
1915
+ "BACKQUOTE",
1916
+ "CARET",
1917
+ "COMMA",
1918
+ "PIPE",
1919
+ "SEMICOLON",
1920
+ "TAB"
1980
1921
  ],
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.",
1922
+ "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",
1985
1965
  "allowNo": false,
1986
1966
  "type": "boolean"
1987
1967
  },
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.",
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.",
1996
1979
  "allowNo": false,
1997
1980
  "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:delete:record",
2002
+ "id": "data:import:resume",
2003
2003
  "pluginAlias": "@salesforce/plugin-data",
2004
2004
  "pluginName": "@salesforce/plugin-data",
2005
2005
  "pluginType": "core",
2006
2006
  "strict": true,
2007
- "summary": "Deletes a single record from a Salesforce or Tooling API object.",
2007
+ "summary": "Resume a bulk import job that you previously started. Uses Bulk API 2.0.",
2008
2008
  "enableJsonFlag": true,
2009
2009
  "isESM": true,
2010
2010
  "relativePath": [
2011
2011
  "lib",
2012
2012
  "commands",
2013
2013
  "data",
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"
2014
+ "import",
2015
+ "resume.js"
2042
2016
  ],
2017
+ "aliasPermutations": [],
2043
2018
  "permutations": [
2044
- "data:delete:record",
2045
- "delete:data:record",
2046
- "delete:record:data",
2047
- "data:record:delete",
2048
- "record:data:delete",
2049
- "record:delete:data"
2019
+ "data:import:resume",
2020
+ "import:data:resume",
2021
+ "import:resume:data",
2022
+ "data:resume:import",
2023
+ "resume:data:import",
2024
+ "resume:import:data"
2050
2025
  ]
2051
2026
  },
2052
- "data:delete:resume": {
2053
- "aliases": [],
2027
+ "data:import:tree": {
2028
+ "aliases": [
2029
+ "force:data:tree:import"
2030
+ ],
2054
2031
  "args": {},
2055
2032
  "deprecateAliases": true,
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.",
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.",
2057
2034
  "examples": [
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"
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"
2060
2037
  ],
2061
2038
  "flags": {
2062
2039
  "json": {
@@ -2083,41 +2060,17 @@
2083
2060
  "deprecateAliases": true,
2084
2061
  "name": "target-org",
2085
2062
  "noCacheDefault": true,
2086
- "summary": "Username or alias of the target org. Not required if the \"target-org\" configuration variable is already set.",
2063
+ "required": true,
2064
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2087
2065
  "hasDynamicHelp": true,
2088
2066
  "multiple": false,
2089
2067
  "type": "option"
2090
2068
  },
2091
- "job-id": {
2069
+ "api-version": {
2092
2070
  "aliases": [
2093
- "jobid"
2071
+ "apiversion"
2094
2072
  ],
2095
- "char": "i",
2096
2073
  "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": {
2121
2074
  "description": "Override the api version used for api requests made by this command",
2122
2075
  "name": "api-version",
2123
2076
  "hasDynamicHelp": false,
@@ -2133,33 +2086,80 @@
2133
2086
  "hasDynamicHelp": false,
2134
2087
  "multiple": false,
2135
2088
  "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"
2136
2111
  }
2137
2112
  },
2138
2113
  "hasDynamicHelp": true,
2139
2114
  "hiddenAliases": [],
2140
- "id": "data:delete:resume",
2115
+ "id": "data:import:tree",
2141
2116
  "pluginAlias": "@salesforce/plugin-data",
2142
2117
  "pluginName": "@salesforce/plugin-data",
2143
2118
  "pluginType": "core",
2144
2119
  "strict": true,
2145
- "summary": "Resume a bulk delete job that you previously started. Uses Bulk API 2.0.",
2120
+ "summary": "Import data from one or more JSON files into an org.",
2146
2121
  "enableJsonFlag": true,
2147
2122
  "isESM": true,
2148
2123
  "relativePath": [
2149
2124
  "lib",
2150
2125
  "commands",
2151
2126
  "data",
2152
- "delete",
2153
- "resume.js"
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"
2154
2155
  ],
2155
- "aliasPermutations": [],
2156
2156
  "permutations": [
2157
- "data:delete:resume",
2158
- "delete:data:resume",
2159
- "delete:resume:data",
2160
- "data:resume:delete",
2161
- "resume:data:delete",
2162
- "resume:delete:data"
2157
+ "data:import:tree",
2158
+ "import:data:tree",
2159
+ "import:tree:data",
2160
+ "data:tree:import",
2161
+ "tree:data:import",
2162
+ "tree:import:data"
2163
2163
  ]
2164
2164
  },
2165
2165
  "data:query:resume": {
@@ -3535,5 +3535,5 @@
3535
3535
  ]
3536
3536
  }
3537
3537
  },
3538
- "version": "4.0.10"
3538
+ "version": "4.0.11"
3539
3539
  }