@salesforce/plugin-data 3.13.6 → 3.13.8

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 (4) hide show
  1. package/LICENSE.txt +1 -1
  2. package/README.md +25 -25
  3. package/oclif.manifest.json +487 -487
  4. package/package.json +8 -8
package/oclif.manifest.json CHANGED
@@ -1227,6 +1227,179 @@
1227
1227
  "resume:delete:data"
1228
1228
  ]
1229
1229
  },
1230
+ "data:get:record": {
1231
+ "aliases": [
1232
+ "force:data:record:get"
1233
+ ],
1234
+ "args": {},
1235
+ "deprecateAliases": true,
1236
+ "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.",
1237
+ "examples": [
1238
+ "Retrieve and display a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX",
1239
+ "Retrieve a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name=Acme\"",
1240
+ "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",
1241
+ "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"
1242
+ ],
1243
+ "flags": {
1244
+ "json": {
1245
+ "description": "Format output as json.",
1246
+ "helpGroup": "GLOBAL",
1247
+ "name": "json",
1248
+ "allowNo": false,
1249
+ "type": "boolean"
1250
+ },
1251
+ "flags-dir": {
1252
+ "helpGroup": "GLOBAL",
1253
+ "name": "flags-dir",
1254
+ "summary": "Import flag values from a directory.",
1255
+ "hasDynamicHelp": false,
1256
+ "multiple": false,
1257
+ "type": "option"
1258
+ },
1259
+ "target-org": {
1260
+ "aliases": [
1261
+ "targetusername",
1262
+ "u"
1263
+ ],
1264
+ "char": "o",
1265
+ "deprecateAliases": true,
1266
+ "name": "target-org",
1267
+ "noCacheDefault": true,
1268
+ "required": true,
1269
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1270
+ "hasDynamicHelp": true,
1271
+ "multiple": false,
1272
+ "type": "option"
1273
+ },
1274
+ "api-version": {
1275
+ "aliases": [
1276
+ "apiversion"
1277
+ ],
1278
+ "deprecateAliases": true,
1279
+ "description": "Override the api version used for api requests made by this command",
1280
+ "name": "api-version",
1281
+ "hasDynamicHelp": false,
1282
+ "multiple": false,
1283
+ "type": "option"
1284
+ },
1285
+ "loglevel": {
1286
+ "deprecated": {
1287
+ "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."
1288
+ },
1289
+ "hidden": true,
1290
+ "name": "loglevel",
1291
+ "hasDynamicHelp": false,
1292
+ "multiple": false,
1293
+ "type": "option"
1294
+ },
1295
+ "sobject": {
1296
+ "aliases": [
1297
+ "sobjecttype"
1298
+ ],
1299
+ "char": "s",
1300
+ "deprecateAliases": true,
1301
+ "name": "sobject",
1302
+ "required": true,
1303
+ "summary": "API name of the Salesforce or Tooling API object that you're retrieving a record from.",
1304
+ "hasDynamicHelp": false,
1305
+ "multiple": false,
1306
+ "type": "option"
1307
+ },
1308
+ "record-id": {
1309
+ "aliases": [
1310
+ "sobjectid"
1311
+ ],
1312
+ "char": "i",
1313
+ "deprecateAliases": true,
1314
+ "name": "record-id",
1315
+ "summary": "ID of the record you’re retrieving.",
1316
+ "hasDynamicHelp": false,
1317
+ "multiple": false,
1318
+ "type": "option"
1319
+ },
1320
+ "where": {
1321
+ "char": "w",
1322
+ "name": "where",
1323
+ "summary": "List of <fieldName>=<value> pairs that identify the record you want to display.",
1324
+ "hasDynamicHelp": false,
1325
+ "multiple": false,
1326
+ "type": "option"
1327
+ },
1328
+ "use-tooling-api": {
1329
+ "aliases": [
1330
+ "usetoolingapi"
1331
+ ],
1332
+ "char": "t",
1333
+ "deprecateAliases": true,
1334
+ "name": "use-tooling-api",
1335
+ "summary": "Use Tooling API so you can retrieve a record from a Tooling API object.",
1336
+ "allowNo": false,
1337
+ "type": "boolean"
1338
+ },
1339
+ "perflog": {
1340
+ "deprecated": {
1341
+ "version": "57"
1342
+ },
1343
+ "description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
1344
+ "hidden": true,
1345
+ "name": "perflog",
1346
+ "summary": "Get API performance data.",
1347
+ "allowNo": false,
1348
+ "type": "boolean"
1349
+ }
1350
+ },
1351
+ "hasDynamicHelp": true,
1352
+ "hiddenAliases": [],
1353
+ "id": "data:get:record",
1354
+ "pluginAlias": "@salesforce/plugin-data",
1355
+ "pluginName": "@salesforce/plugin-data",
1356
+ "pluginType": "core",
1357
+ "strict": true,
1358
+ "summary": "Retrieve and display a single record of a Salesforce or Tooling API object.",
1359
+ "enableJsonFlag": true,
1360
+ "isESM": true,
1361
+ "relativePath": [
1362
+ "lib",
1363
+ "commands",
1364
+ "data",
1365
+ "get",
1366
+ "record.js"
1367
+ ],
1368
+ "aliasPermutations": [
1369
+ "force:data:record:get",
1370
+ "data:force:record:get",
1371
+ "data:record:force:get",
1372
+ "data:record:get:force",
1373
+ "force:record:data:get",
1374
+ "record:force:data:get",
1375
+ "record:data:force:get",
1376
+ "record:data:get:force",
1377
+ "force:record:get:data",
1378
+ "record:force:get:data",
1379
+ "record:get:force:data",
1380
+ "record:get:data:force",
1381
+ "force:data:get:record",
1382
+ "data:force:get:record",
1383
+ "data:get:force:record",
1384
+ "data:get:record:force",
1385
+ "force:get:data:record",
1386
+ "get:force:data:record",
1387
+ "get:data:force:record",
1388
+ "get:data:record:force",
1389
+ "force:get:record:data",
1390
+ "get:force:record:data",
1391
+ "get:record:force:data",
1392
+ "get:record:data:force"
1393
+ ],
1394
+ "permutations": [
1395
+ "data:get:record",
1396
+ "get:data:record",
1397
+ "get:record:data",
1398
+ "data:record:get",
1399
+ "record:data:get",
1400
+ "record:get:data"
1401
+ ]
1402
+ },
1230
1403
  "data:export:bulk": {
1231
1404
  "aliases": [],
1232
1405
  "args": {},
@@ -1664,18 +1837,13 @@
1664
1837
  "tree:export:data"
1665
1838
  ]
1666
1839
  },
1667
- "data:get:record": {
1668
- "aliases": [
1669
- "force:data:record:get"
1670
- ],
1840
+ "data:import:bulk": {
1841
+ "aliases": [],
1671
1842
  "args": {},
1672
- "deprecateAliases": true,
1673
- "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.",
1843
+ "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).",
1674
1844
  "examples": [
1675
- "Retrieve and display a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX",
1676
- "Retrieve a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name=Acme\"",
1677
- "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",
1678
- "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"
1845
+ "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",
1846
+ "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"
1679
1847
  ],
1680
1848
  "flags": {
1681
1849
  "json": {
@@ -1693,210 +1861,42 @@
1693
1861
  "multiple": false,
1694
1862
  "type": "option"
1695
1863
  },
1696
- "target-org": {
1697
- "aliases": [
1698
- "targetusername",
1699
- "u"
1700
- ],
1701
- "char": "o",
1702
- "deprecateAliases": true,
1703
- "name": "target-org",
1704
- "noCacheDefault": true,
1705
- "required": true,
1706
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1707
- "hasDynamicHelp": true,
1708
- "multiple": false,
1709
- "type": "option"
1710
- },
1711
- "api-version": {
1712
- "aliases": [
1713
- "apiversion"
1864
+ "async": {
1865
+ "char": "a",
1866
+ "exclusive": [
1867
+ "wait"
1714
1868
  ],
1715
- "deprecateAliases": true,
1716
- "description": "Override the api version used for api requests made by this command",
1717
- "name": "api-version",
1718
- "hasDynamicHelp": false,
1719
- "multiple": false,
1720
- "type": "option"
1869
+ "name": "async",
1870
+ "summary": "Don't wait for the command to complete.",
1871
+ "allowNo": false,
1872
+ "type": "boolean"
1721
1873
  },
1722
- "loglevel": {
1723
- "deprecated": {
1724
- "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."
1725
- },
1726
- "hidden": true,
1727
- "name": "loglevel",
1874
+ "file": {
1875
+ "char": "f",
1876
+ "name": "file",
1877
+ "required": true,
1878
+ "summary": "CSV file that contains the Salesforce object records you want to import.",
1728
1879
  "hasDynamicHelp": false,
1729
1880
  "multiple": false,
1730
1881
  "type": "option"
1731
1882
  },
1732
1883
  "sobject": {
1733
- "aliases": [
1734
- "sobjecttype"
1735
- ],
1736
1884
  "char": "s",
1737
- "deprecateAliases": true,
1738
1885
  "name": "sobject",
1739
1886
  "required": true,
1740
- "summary": "API name of the Salesforce or Tooling API object that you're retrieving a record from.",
1887
+ "summary": "API name of the Salesforce object, either standard or custom, into which you're importing records.",
1741
1888
  "hasDynamicHelp": false,
1742
1889
  "multiple": false,
1743
1890
  "type": "option"
1744
1891
  },
1745
- "record-id": {
1746
- "aliases": [
1747
- "sobjectid"
1748
- ],
1749
- "char": "i",
1750
- "deprecateAliases": true,
1751
- "name": "record-id",
1752
- "summary": "ID of the record you’re retrieving.",
1892
+ "api-version": {
1893
+ "description": "Override the api version used for api requests made by this command",
1894
+ "name": "api-version",
1753
1895
  "hasDynamicHelp": false,
1754
1896
  "multiple": false,
1755
1897
  "type": "option"
1756
1898
  },
1757
- "where": {
1758
- "char": "w",
1759
- "name": "where",
1760
- "summary": "List of <fieldName>=<value> pairs that identify the record you want to display.",
1761
- "hasDynamicHelp": false,
1762
- "multiple": false,
1763
- "type": "option"
1764
- },
1765
- "use-tooling-api": {
1766
- "aliases": [
1767
- "usetoolingapi"
1768
- ],
1769
- "char": "t",
1770
- "deprecateAliases": true,
1771
- "name": "use-tooling-api",
1772
- "summary": "Use Tooling API so you can retrieve a record from a Tooling API object.",
1773
- "allowNo": false,
1774
- "type": "boolean"
1775
- },
1776
- "perflog": {
1777
- "deprecated": {
1778
- "version": "57"
1779
- },
1780
- "description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
1781
- "hidden": true,
1782
- "name": "perflog",
1783
- "summary": "Get API performance data.",
1784
- "allowNo": false,
1785
- "type": "boolean"
1786
- }
1787
- },
1788
- "hasDynamicHelp": true,
1789
- "hiddenAliases": [],
1790
- "id": "data:get:record",
1791
- "pluginAlias": "@salesforce/plugin-data",
1792
- "pluginName": "@salesforce/plugin-data",
1793
- "pluginType": "core",
1794
- "strict": true,
1795
- "summary": "Retrieve and display a single record of a Salesforce or Tooling API object.",
1796
- "enableJsonFlag": true,
1797
- "isESM": true,
1798
- "relativePath": [
1799
- "lib",
1800
- "commands",
1801
- "data",
1802
- "get",
1803
- "record.js"
1804
- ],
1805
- "aliasPermutations": [
1806
- "force:data:record:get",
1807
- "data:force:record:get",
1808
- "data:record:force:get",
1809
- "data:record:get:force",
1810
- "force:record:data:get",
1811
- "record:force:data:get",
1812
- "record:data:force:get",
1813
- "record:data:get:force",
1814
- "force:record:get:data",
1815
- "record:force:get:data",
1816
- "record:get:force:data",
1817
- "record:get:data:force",
1818
- "force:data:get:record",
1819
- "data:force:get:record",
1820
- "data:get:force:record",
1821
- "data:get:record:force",
1822
- "force:get:data:record",
1823
- "get:force:data:record",
1824
- "get:data:force:record",
1825
- "get:data:record:force",
1826
- "force:get:record:data",
1827
- "get:force:record:data",
1828
- "get:record:force:data",
1829
- "get:record:data:force"
1830
- ],
1831
- "permutations": [
1832
- "data:get:record",
1833
- "get:data:record",
1834
- "get:record:data",
1835
- "data:record:get",
1836
- "record:data:get",
1837
- "record:get:data"
1838
- ]
1839
- },
1840
- "data:import:bulk": {
1841
- "aliases": [],
1842
- "args": {},
1843
- "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).",
1844
- "examples": [
1845
- "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",
1846
- "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"
1847
- ],
1848
- "flags": {
1849
- "json": {
1850
- "description": "Format output as json.",
1851
- "helpGroup": "GLOBAL",
1852
- "name": "json",
1853
- "allowNo": false,
1854
- "type": "boolean"
1855
- },
1856
- "flags-dir": {
1857
- "helpGroup": "GLOBAL",
1858
- "name": "flags-dir",
1859
- "summary": "Import flag values from a directory.",
1860
- "hasDynamicHelp": false,
1861
- "multiple": false,
1862
- "type": "option"
1863
- },
1864
- "async": {
1865
- "char": "a",
1866
- "exclusive": [
1867
- "wait"
1868
- ],
1869
- "name": "async",
1870
- "summary": "Don't wait for the command to complete.",
1871
- "allowNo": false,
1872
- "type": "boolean"
1873
- },
1874
- "file": {
1875
- "char": "f",
1876
- "name": "file",
1877
- "required": true,
1878
- "summary": "CSV file that contains the Salesforce object records you want to import.",
1879
- "hasDynamicHelp": false,
1880
- "multiple": false,
1881
- "type": "option"
1882
- },
1883
- "sobject": {
1884
- "char": "s",
1885
- "name": "sobject",
1886
- "required": true,
1887
- "summary": "API name of the Salesforce object, either standard or custom, into which you're importing records.",
1888
- "hasDynamicHelp": false,
1889
- "multiple": false,
1890
- "type": "option"
1891
- },
1892
- "api-version": {
1893
- "description": "Override the api version used for api requests made by this command",
1894
- "name": "api-version",
1895
- "hasDynamicHelp": false,
1896
- "multiple": false,
1897
- "type": "option"
1898
- },
1899
- "wait": {
1899
+ "wait": {
1900
1900
  "char": "w",
1901
1901
  "exclusive": [
1902
1902
  "async"
@@ -3148,13 +3148,18 @@
3148
3148
  "resume:upsert:data"
3149
3149
  ]
3150
3150
  },
3151
- "force:data:bulk:delete": {
3151
+ "data:export:legacy:tree": {
3152
3152
  "aliases": [],
3153
3153
  "args": {},
3154
- "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 and one or more batches, displays their IDs, 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 and batch IDs to check the status of the job with the \"<%= config.bin %> force data bulk status\" command. A single job can contain many batches, depending on the length of the CSV file.",
3154
+ "deprecationOptions": {
3155
+ "to": "data tree export",
3156
+ "message": "Starting on Nov 10, 2024, this command will no longer be available. Use `data export tree` instead."
3157
+ },
3158
+ "description": "Specify a SOQL query, either directly at the command line or read from a file, to retrieve the data you want to export. The exported data is written to JSON files in sObject tree format, which is a collection of nested, parent-child records with a single root record. Use these JSON files to import data into an org with the \"<%= config.bin %> data import tree\" command.\n\nIf your SOQL query references multiple objects, the command generates a single JSON file by default. You can specify the --plan flag to generate separate JSON files for each object and a plan definition file that aggregates them. You then specify just this plan definition file when you import the data into an org.\n\nThe SOQL query can return a maximum of 2,000 records. For more information, see the REST API Developer Guide. (https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm).",
3155
3159
  "examples": [
3156
- "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",
3157
- "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"
3160
+ "Export records retrieved with the specified SOQL query into a single JSON file in the current directory; the command uses your default org:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id, Name, (SELECT Name, Address__c FROM Properties__r) FROM Broker__c\"",
3161
+ "Export data using a SOQL query in the \"query.txt\" file and generate JSON files for each object and a plan that aggregates them:\n<%= config.bin %> <%= command.id %> --query query.txt --plan",
3162
+ "Prepend \"export-demo\" before each generated file and generate the files in the \"export-out\" directory; run the command on the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --query query.txt --plan --prefix export-demo --output-dir export-out --target-org my-scratch"
3158
3163
  ],
3159
3164
  "flags": {
3160
3165
  "json": {
@@ -3208,95 +3213,101 @@
3208
3213
  "multiple": false,
3209
3214
  "type": "option"
3210
3215
  },
3211
- "file": {
3212
- "aliases": [
3213
- "csvfile"
3214
- ],
3215
- "char": "f",
3216
- "deprecateAliases": true,
3217
- "name": "file",
3216
+ "query": {
3217
+ "char": "q",
3218
+ "name": "query",
3218
3219
  "required": true,
3219
- "summary": "CSV file that contains the IDs of the records to delete.",
3220
+ "summary": "SOQL query, or filepath of a file that contains the query, to retrieve records.",
3220
3221
  "hasDynamicHelp": false,
3221
3222
  "multiple": false,
3222
3223
  "type": "option"
3223
3224
  },
3224
- "sobject": {
3225
- "aliases": [
3226
- "sobjecttype"
3227
- ],
3228
- "char": "s",
3229
- "deprecateAliases": true,
3230
- "name": "sobject",
3231
- "required": true,
3232
- "summary": "API name of the Salesforce object, either standard or custom, that you want to delete records from.",
3225
+ "plan": {
3226
+ "char": "p",
3227
+ "name": "plan",
3228
+ "summary": "Generate multiple sObject tree files and a plan definition file for aggregated import.",
3229
+ "allowNo": false,
3230
+ "type": "boolean"
3231
+ },
3232
+ "prefix": {
3233
+ "char": "x",
3234
+ "name": "prefix",
3235
+ "summary": "Prefix of generated files.",
3233
3236
  "hasDynamicHelp": false,
3234
3237
  "multiple": false,
3235
3238
  "type": "option"
3236
3239
  },
3237
- "wait": {
3238
- "char": "w",
3239
- "name": "wait",
3240
- "summary": "Number of minutes to wait for the command to complete before displaying the results.",
3241
- "default": "0 minutes",
3242
- "hasDynamicHelp": true,
3240
+ "output-dir": {
3241
+ "aliases": [
3242
+ "outputdir"
3243
+ ],
3244
+ "char": "d",
3245
+ "deprecateAliases": true,
3246
+ "name": "output-dir",
3247
+ "summary": "Directory in which to generate the JSON files; default is current directory.",
3248
+ "hasDynamicHelp": false,
3243
3249
  "multiple": false,
3244
3250
  "type": "option"
3245
3251
  }
3246
3252
  },
3247
3253
  "hasDynamicHelp": true,
3254
+ "hidden": true,
3248
3255
  "hiddenAliases": [],
3249
- "id": "force:data:bulk:delete",
3256
+ "id": "data:export:legacy:tree",
3250
3257
  "pluginAlias": "@salesforce/plugin-data",
3251
3258
  "pluginName": "@salesforce/plugin-data",
3252
3259
  "pluginType": "core",
3260
+ "state": "deprecated",
3253
3261
  "strict": true,
3254
- "summary": "Bulk delete records from an org using a CSV file. Uses Bulk API 1.0.",
3262
+ "summary": "Export data from an org into one or more JSON files.",
3255
3263
  "enableJsonFlag": true,
3256
3264
  "isESM": true,
3257
3265
  "relativePath": [
3258
3266
  "lib",
3259
3267
  "commands",
3260
- "force",
3261
3268
  "data",
3262
- "bulk",
3263
- "delete.js"
3269
+ "export",
3270
+ "legacy",
3271
+ "tree.js"
3264
3272
  ],
3265
3273
  "aliasPermutations": [],
3266
3274
  "permutations": [
3267
- "force:data:bulk:delete",
3268
- "data:force:bulk:delete",
3269
- "data:bulk:force:delete",
3270
- "data:bulk:delete:force",
3271
- "force:bulk:data:delete",
3272
- "bulk:force:data:delete",
3273
- "bulk:data:force:delete",
3274
- "bulk:data:delete:force",
3275
- "force:bulk:delete:data",
3276
- "bulk:force:delete:data",
3277
- "bulk:delete:force:data",
3278
- "bulk:delete:data:force",
3279
- "force:data:delete:bulk",
3280
- "data:force:delete:bulk",
3281
- "data:delete:force:bulk",
3282
- "data:delete:bulk:force",
3283
- "force:delete:data:bulk",
3284
- "delete:force:data:bulk",
3285
- "delete:data:force:bulk",
3286
- "delete:data:bulk:force",
3287
- "force:delete:bulk:data",
3288
- "delete:force:bulk:data",
3289
- "delete:bulk:force:data",
3290
- "delete:bulk:data:force"
3275
+ "data:export:legacy:tree",
3276
+ "export:data:legacy:tree",
3277
+ "export:legacy:data:tree",
3278
+ "export:legacy:tree:data",
3279
+ "data:legacy:export:tree",
3280
+ "legacy:data:export:tree",
3281
+ "legacy:export:data:tree",
3282
+ "legacy:export:tree:data",
3283
+ "data:legacy:tree:export",
3284
+ "legacy:data:tree:export",
3285
+ "legacy:tree:data:export",
3286
+ "legacy:tree:export:data",
3287
+ "data:export:tree:legacy",
3288
+ "export:data:tree:legacy",
3289
+ "export:tree:data:legacy",
3290
+ "export:tree:legacy:data",
3291
+ "data:tree:export:legacy",
3292
+ "tree:data:export:legacy",
3293
+ "tree:export:data:legacy",
3294
+ "tree:export:legacy:data",
3295
+ "data:tree:legacy:export",
3296
+ "tree:data:legacy:export",
3297
+ "tree:legacy:data:export",
3298
+ "tree:legacy:export:data"
3291
3299
  ]
3292
3300
  },
3293
- "force:data:bulk:status": {
3301
+ "data:import:legacy:tree": {
3294
3302
  "aliases": [],
3295
3303
  "args": {},
3296
- "description": "Run this command using the job ID or batch ID returned from the \"<%= config.bin %> force data bulk delete\" or \"<%= config.bin %> force data bulk upsert\" commands.",
3304
+ "deprecationOptions": {
3305
+ "message": "After Nov 10, 2024, this command will no longer be available. Use `data export tree`."
3306
+ },
3307
+ "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.\n\nThe sObject Tree API supports requests that contain up to 200 records. For more information, see the REST API Developer Guide. (https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm)",
3297
3308
  "examples": [
3298
- "View the status of a bulk load job in your default org:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
3299
- "View the status of a bulk load job and a specific batches in an org with alias my-scratch:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch"
3309
+ "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",
3310
+ "Import records using a plan definition file into your default org:\n<%= config.bin %> <%= command.id %> --plan Account-Contact-plan.json"
3300
3311
  ],
3301
3312
  "flags": {
3302
3313
  "json": {
@@ -3350,85 +3361,116 @@
3350
3361
  "multiple": false,
3351
3362
  "type": "option"
3352
3363
  },
3353
- "batch-id": {
3364
+ "files": {
3354
3365
  "aliases": [
3355
- "batchid"
3366
+ "sobjecttreefiles"
3356
3367
  ],
3357
- "char": "b",
3368
+ "char": "f",
3358
3369
  "deprecateAliases": true,
3359
- "name": "batch-id",
3360
- "summary": "ID of the batch whose status you want to view; you must also specify the job ID.",
3370
+ "exclusive": [
3371
+ "plan"
3372
+ ],
3373
+ "name": "files",
3374
+ "summary": "Comma-separated and in-order JSON files that contain the records, in sObject tree format, that you want to insert.",
3375
+ "delimiter": ",",
3376
+ "hasDynamicHelp": false,
3377
+ "multiple": true,
3378
+ "type": "option"
3379
+ },
3380
+ "plan": {
3381
+ "char": "p",
3382
+ "name": "plan",
3383
+ "summary": "Plan definition file to insert multiple data files.",
3361
3384
  "hasDynamicHelp": false,
3362
3385
  "multiple": false,
3363
3386
  "type": "option"
3364
3387
  },
3365
- "job-id": {
3388
+ "content-type": {
3366
3389
  "aliases": [
3367
- "jobid"
3390
+ "contenttype"
3368
3391
  ],
3369
- "char": "i",
3392
+ "char": "c",
3370
3393
  "deprecateAliases": true,
3371
- "name": "job-id",
3372
- "required": true,
3373
- "summary": "ID of the job whose status you want to view.",
3394
+ "deprecated": {
3395
+ "message": "The `config-type` flag is deprecated and will be moved to a `legacy` command after July 10, 2024. It will be completely removed after Nov 10, 2024. Use the new `data tree beta import` command."
3396
+ },
3397
+ "hidden": true,
3398
+ "name": "content-type",
3399
+ "summary": "Content type of import files if their extention is not .json.",
3374
3400
  "hasDynamicHelp": false,
3375
3401
  "multiple": false,
3376
3402
  "type": "option"
3403
+ },
3404
+ "config-help": {
3405
+ "aliases": [
3406
+ "confighelp"
3407
+ ],
3408
+ "deprecateAliases": true,
3409
+ "deprecated": {
3410
+ "message": "The `config-help` flag is deprecated and will be moved to a `legacy` command after July 10, 2024. It will be completely removed after Nov 10, 2024. Use the new `data tree beta import` command."
3411
+ },
3412
+ "hidden": true,
3413
+ "name": "config-help",
3414
+ "summary": "Display schema information for the --plan configuration file to stdout; if you specify this flag, all other flags except --json are ignored.",
3415
+ "allowNo": false,
3416
+ "type": "boolean"
3377
3417
  }
3378
3418
  },
3379
3419
  "hasDynamicHelp": true,
3420
+ "hidden": true,
3380
3421
  "hiddenAliases": [],
3381
- "id": "force:data:bulk:status",
3422
+ "id": "data:import:legacy:tree",
3382
3423
  "pluginAlias": "@salesforce/plugin-data",
3383
3424
  "pluginName": "@salesforce/plugin-data",
3384
3425
  "pluginType": "core",
3426
+ "state": "deprecated",
3385
3427
  "strict": true,
3386
- "summary": "View the status of a bulk data load job or batch. Uses Bulk API 1.0.",
3428
+ "summary": "Import data from one or more JSON files into an org.",
3387
3429
  "enableJsonFlag": true,
3388
3430
  "isESM": true,
3389
3431
  "relativePath": [
3390
3432
  "lib",
3391
3433
  "commands",
3392
- "force",
3393
3434
  "data",
3394
- "bulk",
3395
- "status.js"
3435
+ "import",
3436
+ "legacy",
3437
+ "tree.js"
3396
3438
  ],
3397
3439
  "aliasPermutations": [],
3398
3440
  "permutations": [
3399
- "force:data:bulk:status",
3400
- "data:force:bulk:status",
3401
- "data:bulk:force:status",
3402
- "data:bulk:status:force",
3403
- "force:bulk:data:status",
3404
- "bulk:force:data:status",
3405
- "bulk:data:force:status",
3406
- "bulk:data:status:force",
3407
- "force:bulk:status:data",
3408
- "bulk:force:status:data",
3409
- "bulk:status:force:data",
3410
- "bulk:status:data:force",
3411
- "force:data:status:bulk",
3412
- "data:force:status:bulk",
3413
- "data:status:force:bulk",
3414
- "data:status:bulk:force",
3415
- "force:status:data:bulk",
3416
- "status:force:data:bulk",
3417
- "status:data:force:bulk",
3418
- "status:data:bulk:force",
3419
- "force:status:bulk:data",
3420
- "status:force:bulk:data",
3421
- "status:bulk:force:data",
3422
- "status:bulk:data:force"
3441
+ "data:import:legacy:tree",
3442
+ "import:data:legacy:tree",
3443
+ "import:legacy:data:tree",
3444
+ "import:legacy:tree:data",
3445
+ "data:legacy:import:tree",
3446
+ "legacy:data:import:tree",
3447
+ "legacy:import:data:tree",
3448
+ "legacy:import:tree:data",
3449
+ "data:legacy:tree:import",
3450
+ "legacy:data:tree:import",
3451
+ "legacy:tree:data:import",
3452
+ "legacy:tree:import:data",
3453
+ "data:import:tree:legacy",
3454
+ "import:data:tree:legacy",
3455
+ "import:tree:data:legacy",
3456
+ "import:tree:legacy:data",
3457
+ "data:tree:import:legacy",
3458
+ "tree:data:import:legacy",
3459
+ "tree:import:data:legacy",
3460
+ "tree:import:legacy:data",
3461
+ "data:tree:legacy:import",
3462
+ "tree:data:legacy:import",
3463
+ "tree:legacy:data:import",
3464
+ "tree:legacy:import:data"
3423
3465
  ]
3424
3466
  },
3425
- "force:data:bulk:upsert": {
3467
+ "force:data:bulk:delete": {
3426
3468
  "aliases": [],
3427
3469
  "args": {},
3428
- "description": "An upsert refers to inserting a record into a Salesforce object if the record doesn't already exist, or updating it if it does exist.\n\nWhen you execute this command, it starts a job and one or more batches, displays their IDs, 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 and batch IDs to check the status of the job with the \"<%= config.bin %> force data bulk status\" command. A single job can contain many batches, depending on the length of the CSV file.\n\nSee \"Prepare CSV Files\" in the Bulk API Developer Guide for details on formatting your CSV file. (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_csv_preparing.htm)\n\nBy default, the job runs the batches in parallel, which we recommend. You can run jobs serially by specifying the --serial flag. But don't process data in serial mode unless you know this would otherwise result in lock timeouts and you can't reorganize your batches to avoid the locks.",
3470
+ "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 and one or more batches, displays their IDs, 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 and batch IDs to check the status of the job with the \"<%= config.bin %> force data bulk status\" command. A single job can contain many batches, depending on the length of the CSV file.",
3429
3471
  "examples": [
3430
- "Bulk upsert records to the Contact object in your default org:\n<%= config.bin %> --sobject Contact --file files/contacts.csv --external-id Id",
3431
- "Bulk upsert records to 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/file.csv --external-id MyField__c --wait 5 --target-org my-scratch"
3472
+ "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",
3473
+ "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"
3432
3474
  ],
3433
3475
  "flags": {
3434
3476
  "json": {
@@ -3482,19 +3524,6 @@
3482
3524
  "multiple": false,
3483
3525
  "type": "option"
3484
3526
  },
3485
- "external-id": {
3486
- "aliases": [
3487
- "externalid"
3488
- ],
3489
- "char": "i",
3490
- "deprecateAliases": true,
3491
- "name": "external-id",
3492
- "required": true,
3493
- "summary": "Name of the external ID field, or the Id field.",
3494
- "hasDynamicHelp": false,
3495
- "multiple": false,
3496
- "type": "option"
3497
- },
3498
3527
  "file": {
3499
3528
  "aliases": [
3500
3529
  "csvfile"
@@ -3503,7 +3532,7 @@
3503
3532
  "deprecateAliases": true,
3504
3533
  "name": "file",
3505
3534
  "required": true,
3506
- "summary": "CSV file that contains the records to upsert.",
3535
+ "summary": "CSV file that contains the IDs of the records to delete.",
3507
3536
  "hasDynamicHelp": false,
3508
3537
  "multiple": false,
3509
3538
  "type": "option"
@@ -3516,7 +3545,7 @@
3516
3545
  "deprecateAliases": true,
3517
3546
  "name": "sobject",
3518
3547
  "required": true,
3519
- "summary": "API name of the Salesforce object, either standard or custom, that you want to upsert records to.",
3548
+ "summary": "API name of the Salesforce object, either standard or custom, that you want to delete records from.",
3520
3549
  "hasDynamicHelp": false,
3521
3550
  "multiple": false,
3522
3551
  "type": "option"
@@ -3529,23 +3558,16 @@
3529
3558
  "hasDynamicHelp": true,
3530
3559
  "multiple": false,
3531
3560
  "type": "option"
3532
- },
3533
- "serial": {
3534
- "char": "r",
3535
- "name": "serial",
3536
- "summary": "Run batches in serial mode.",
3537
- "allowNo": false,
3538
- "type": "boolean"
3539
3561
  }
3540
3562
  },
3541
3563
  "hasDynamicHelp": true,
3542
3564
  "hiddenAliases": [],
3543
- "id": "force:data:bulk:upsert",
3565
+ "id": "force:data:bulk:delete",
3544
3566
  "pluginAlias": "@salesforce/plugin-data",
3545
3567
  "pluginName": "@salesforce/plugin-data",
3546
3568
  "pluginType": "core",
3547
3569
  "strict": true,
3548
- "summary": "Bulk upsert records to an org from a CSV file. Uses Bulk API 1.0.",
3570
+ "summary": "Bulk delete records from an org using a CSV file. Uses Bulk API 1.0.",
3549
3571
  "enableJsonFlag": true,
3550
3572
  "isESM": true,
3551
3573
  "relativePath": [
@@ -3554,48 +3576,43 @@
3554
3576
  "force",
3555
3577
  "data",
3556
3578
  "bulk",
3557
- "upsert.js"
3579
+ "delete.js"
3558
3580
  ],
3559
3581
  "aliasPermutations": [],
3560
3582
  "permutations": [
3561
- "force:data:bulk:upsert",
3562
- "data:force:bulk:upsert",
3563
- "data:bulk:force:upsert",
3564
- "data:bulk:upsert:force",
3565
- "force:bulk:data:upsert",
3566
- "bulk:force:data:upsert",
3567
- "bulk:data:force:upsert",
3568
- "bulk:data:upsert:force",
3569
- "force:bulk:upsert:data",
3570
- "bulk:force:upsert:data",
3571
- "bulk:upsert:force:data",
3572
- "bulk:upsert:data:force",
3573
- "force:data:upsert:bulk",
3574
- "data:force:upsert:bulk",
3575
- "data:upsert:force:bulk",
3576
- "data:upsert:bulk:force",
3577
- "force:upsert:data:bulk",
3578
- "upsert:force:data:bulk",
3579
- "upsert:data:force:bulk",
3580
- "upsert:data:bulk:force",
3581
- "force:upsert:bulk:data",
3582
- "upsert:force:bulk:data",
3583
- "upsert:bulk:force:data",
3584
- "upsert:bulk:data:force"
3583
+ "force:data:bulk:delete",
3584
+ "data:force:bulk:delete",
3585
+ "data:bulk:force:delete",
3586
+ "data:bulk:delete:force",
3587
+ "force:bulk:data:delete",
3588
+ "bulk:force:data:delete",
3589
+ "bulk:data:force:delete",
3590
+ "bulk:data:delete:force",
3591
+ "force:bulk:delete:data",
3592
+ "bulk:force:delete:data",
3593
+ "bulk:delete:force:data",
3594
+ "bulk:delete:data:force",
3595
+ "force:data:delete:bulk",
3596
+ "data:force:delete:bulk",
3597
+ "data:delete:force:bulk",
3598
+ "data:delete:bulk:force",
3599
+ "force:delete:data:bulk",
3600
+ "delete:force:data:bulk",
3601
+ "delete:data:force:bulk",
3602
+ "delete:data:bulk:force",
3603
+ "force:delete:bulk:data",
3604
+ "delete:force:bulk:data",
3605
+ "delete:bulk:force:data",
3606
+ "delete:bulk:data:force"
3585
3607
  ]
3586
3608
  },
3587
- "data:export:legacy:tree": {
3609
+ "force:data:bulk:status": {
3588
3610
  "aliases": [],
3589
3611
  "args": {},
3590
- "deprecationOptions": {
3591
- "to": "data tree export",
3592
- "message": "Starting on Nov 10, 2024, this command will no longer be available. Use `data export tree` instead."
3593
- },
3594
- "description": "Specify a SOQL query, either directly at the command line or read from a file, to retrieve the data you want to export. The exported data is written to JSON files in sObject tree format, which is a collection of nested, parent-child records with a single root record. Use these JSON files to import data into an org with the \"<%= config.bin %> data import tree\" command.\n\nIf your SOQL query references multiple objects, the command generates a single JSON file by default. You can specify the --plan flag to generate separate JSON files for each object and a plan definition file that aggregates them. You then specify just this plan definition file when you import the data into an org.\n\nThe SOQL query can return a maximum of 2,000 records. For more information, see the REST API Developer Guide. (https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm).",
3612
+ "description": "Run this command using the job ID or batch ID returned from the \"<%= config.bin %> force data bulk delete\" or \"<%= config.bin %> force data bulk upsert\" commands.",
3595
3613
  "examples": [
3596
- "Export records retrieved with the specified SOQL query into a single JSON file in the current directory; the command uses your default org:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id, Name, (SELECT Name, Address__c FROM Properties__r) FROM Broker__c\"",
3597
- "Export data using a SOQL query in the \"query.txt\" file and generate JSON files for each object and a plan that aggregates them:\n<%= config.bin %> <%= command.id %> --query query.txt --plan",
3598
- "Prepend \"export-demo\" before each generated file and generate the files in the \"export-out\" directory; run the command on the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --query query.txt --plan --prefix export-demo --output-dir export-out --target-org my-scratch"
3614
+ "View the status of a bulk load job in your default org:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
3615
+ "View the status of a bulk load job and a specific batches in an org with alias my-scratch:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch"
3599
3616
  ],
3600
3617
  "flags": {
3601
3618
  "json": {
@@ -3649,101 +3666,85 @@
3649
3666
  "multiple": false,
3650
3667
  "type": "option"
3651
3668
  },
3652
- "query": {
3653
- "char": "q",
3654
- "name": "query",
3655
- "required": true,
3656
- "summary": "SOQL query, or filepath of a file that contains the query, to retrieve records.",
3657
- "hasDynamicHelp": false,
3658
- "multiple": false,
3659
- "type": "option"
3660
- },
3661
- "plan": {
3662
- "char": "p",
3663
- "name": "plan",
3664
- "summary": "Generate multiple sObject tree files and a plan definition file for aggregated import.",
3665
- "allowNo": false,
3666
- "type": "boolean"
3667
- },
3668
- "prefix": {
3669
- "char": "x",
3670
- "name": "prefix",
3671
- "summary": "Prefix of generated files.",
3669
+ "batch-id": {
3670
+ "aliases": [
3671
+ "batchid"
3672
+ ],
3673
+ "char": "b",
3674
+ "deprecateAliases": true,
3675
+ "name": "batch-id",
3676
+ "summary": "ID of the batch whose status you want to view; you must also specify the job ID.",
3672
3677
  "hasDynamicHelp": false,
3673
3678
  "multiple": false,
3674
3679
  "type": "option"
3675
3680
  },
3676
- "output-dir": {
3681
+ "job-id": {
3677
3682
  "aliases": [
3678
- "outputdir"
3683
+ "jobid"
3679
3684
  ],
3680
- "char": "d",
3685
+ "char": "i",
3681
3686
  "deprecateAliases": true,
3682
- "name": "output-dir",
3683
- "summary": "Directory in which to generate the JSON files; default is current directory.",
3687
+ "name": "job-id",
3688
+ "required": true,
3689
+ "summary": "ID of the job whose status you want to view.",
3684
3690
  "hasDynamicHelp": false,
3685
3691
  "multiple": false,
3686
3692
  "type": "option"
3687
3693
  }
3688
3694
  },
3689
3695
  "hasDynamicHelp": true,
3690
- "hidden": true,
3691
3696
  "hiddenAliases": [],
3692
- "id": "data:export:legacy:tree",
3697
+ "id": "force:data:bulk:status",
3693
3698
  "pluginAlias": "@salesforce/plugin-data",
3694
3699
  "pluginName": "@salesforce/plugin-data",
3695
3700
  "pluginType": "core",
3696
- "state": "deprecated",
3697
3701
  "strict": true,
3698
- "summary": "Export data from an org into one or more JSON files.",
3702
+ "summary": "View the status of a bulk data load job or batch. Uses Bulk API 1.0.",
3699
3703
  "enableJsonFlag": true,
3700
3704
  "isESM": true,
3701
3705
  "relativePath": [
3702
3706
  "lib",
3703
3707
  "commands",
3708
+ "force",
3704
3709
  "data",
3705
- "export",
3706
- "legacy",
3707
- "tree.js"
3710
+ "bulk",
3711
+ "status.js"
3708
3712
  ],
3709
3713
  "aliasPermutations": [],
3710
3714
  "permutations": [
3711
- "data:export:legacy:tree",
3712
- "export:data:legacy:tree",
3713
- "export:legacy:data:tree",
3714
- "export:legacy:tree:data",
3715
- "data:legacy:export:tree",
3716
- "legacy:data:export:tree",
3717
- "legacy:export:data:tree",
3718
- "legacy:export:tree:data",
3719
- "data:legacy:tree:export",
3720
- "legacy:data:tree:export",
3721
- "legacy:tree:data:export",
3722
- "legacy:tree:export:data",
3723
- "data:export:tree:legacy",
3724
- "export:data:tree:legacy",
3725
- "export:tree:data:legacy",
3726
- "export:tree:legacy:data",
3727
- "data:tree:export:legacy",
3728
- "tree:data:export:legacy",
3729
- "tree:export:data:legacy",
3730
- "tree:export:legacy:data",
3731
- "data:tree:legacy:export",
3732
- "tree:data:legacy:export",
3733
- "tree:legacy:data:export",
3734
- "tree:legacy:export:data"
3715
+ "force:data:bulk:status",
3716
+ "data:force:bulk:status",
3717
+ "data:bulk:force:status",
3718
+ "data:bulk:status:force",
3719
+ "force:bulk:data:status",
3720
+ "bulk:force:data:status",
3721
+ "bulk:data:force:status",
3722
+ "bulk:data:status:force",
3723
+ "force:bulk:status:data",
3724
+ "bulk:force:status:data",
3725
+ "bulk:status:force:data",
3726
+ "bulk:status:data:force",
3727
+ "force:data:status:bulk",
3728
+ "data:force:status:bulk",
3729
+ "data:status:force:bulk",
3730
+ "data:status:bulk:force",
3731
+ "force:status:data:bulk",
3732
+ "status:force:data:bulk",
3733
+ "status:data:force:bulk",
3734
+ "status:data:bulk:force",
3735
+ "force:status:bulk:data",
3736
+ "status:force:bulk:data",
3737
+ "status:bulk:force:data",
3738
+ "status:bulk:data:force"
3735
3739
  ]
3736
3740
  },
3737
- "data:import:legacy:tree": {
3741
+ "force:data:bulk:upsert": {
3738
3742
  "aliases": [],
3739
3743
  "args": {},
3740
- "deprecationOptions": {
3741
- "message": "After Nov 10, 2024, this command will no longer be available. Use `data export tree`."
3742
- },
3743
- "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.\n\nThe sObject Tree API supports requests that contain up to 200 records. For more information, see the REST API Developer Guide. (https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm)",
3744
+ "description": "An upsert refers to inserting a record into a Salesforce object if the record doesn't already exist, or updating it if it does exist.\n\nWhen you execute this command, it starts a job and one or more batches, displays their IDs, 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 and batch IDs to check the status of the job with the \"<%= config.bin %> force data bulk status\" command. A single job can contain many batches, depending on the length of the CSV file.\n\nSee \"Prepare CSV Files\" in the Bulk API Developer Guide for details on formatting your CSV file. (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_csv_preparing.htm)\n\nBy default, the job runs the batches in parallel, which we recommend. You can run jobs serially by specifying the --serial flag. But don't process data in serial mode unless you know this would otherwise result in lock timeouts and you can't reorganize your batches to avoid the locks.",
3744
3745
  "examples": [
3745
- "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",
3746
- "Import records using a plan definition file into your default org:\n<%= config.bin %> <%= command.id %> --plan Account-Contact-plan.json"
3746
+ "Bulk upsert records to the Contact object in your default org:\n<%= config.bin %> --sobject Contact --file files/contacts.csv --external-id Id",
3747
+ "Bulk upsert records to 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/file.csv --external-id MyField__c --wait 5 --target-org my-scratch"
3747
3748
  ],
3748
3749
  "flags": {
3749
3750
  "json": {
@@ -3797,109 +3798,108 @@
3797
3798
  "multiple": false,
3798
3799
  "type": "option"
3799
3800
  },
3800
- "files": {
3801
+ "external-id": {
3801
3802
  "aliases": [
3802
- "sobjecttreefiles"
3803
+ "externalid"
3803
3804
  ],
3804
- "char": "f",
3805
+ "char": "i",
3805
3806
  "deprecateAliases": true,
3806
- "exclusive": [
3807
- "plan"
3808
- ],
3809
- "name": "files",
3810
- "summary": "Comma-separated and in-order JSON files that contain the records, in sObject tree format, that you want to insert.",
3811
- "delimiter": ",",
3812
- "hasDynamicHelp": false,
3813
- "multiple": true,
3814
- "type": "option"
3815
- },
3816
- "plan": {
3817
- "char": "p",
3818
- "name": "plan",
3819
- "summary": "Plan definition file to insert multiple data files.",
3807
+ "name": "external-id",
3808
+ "required": true,
3809
+ "summary": "Name of the external ID field, or the Id field.",
3820
3810
  "hasDynamicHelp": false,
3821
3811
  "multiple": false,
3822
3812
  "type": "option"
3823
3813
  },
3824
- "content-type": {
3814
+ "file": {
3825
3815
  "aliases": [
3826
- "contenttype"
3816
+ "csvfile"
3827
3817
  ],
3828
- "char": "c",
3818
+ "char": "f",
3829
3819
  "deprecateAliases": true,
3830
- "deprecated": {
3831
- "message": "The `config-type` flag is deprecated and will be moved to a `legacy` command after July 10, 2024. It will be completely removed after Nov 10, 2024. Use the new `data tree beta import` command."
3832
- },
3833
- "hidden": true,
3834
- "name": "content-type",
3835
- "summary": "Content type of import files if their extention is not .json.",
3820
+ "name": "file",
3821
+ "required": true,
3822
+ "summary": "CSV file that contains the records to upsert.",
3836
3823
  "hasDynamicHelp": false,
3837
3824
  "multiple": false,
3838
3825
  "type": "option"
3839
3826
  },
3840
- "config-help": {
3827
+ "sobject": {
3841
3828
  "aliases": [
3842
- "confighelp"
3829
+ "sobjecttype"
3843
3830
  ],
3831
+ "char": "s",
3844
3832
  "deprecateAliases": true,
3845
- "deprecated": {
3846
- "message": "The `config-help` flag is deprecated and will be moved to a `legacy` command after July 10, 2024. It will be completely removed after Nov 10, 2024. Use the new `data tree beta import` command."
3847
- },
3848
- "hidden": true,
3849
- "name": "config-help",
3850
- "summary": "Display schema information for the --plan configuration file to stdout; if you specify this flag, all other flags except --json are ignored.",
3833
+ "name": "sobject",
3834
+ "required": true,
3835
+ "summary": "API name of the Salesforce object, either standard or custom, that you want to upsert records to.",
3836
+ "hasDynamicHelp": false,
3837
+ "multiple": false,
3838
+ "type": "option"
3839
+ },
3840
+ "wait": {
3841
+ "char": "w",
3842
+ "name": "wait",
3843
+ "summary": "Number of minutes to wait for the command to complete before displaying the results.",
3844
+ "default": "0 minutes",
3845
+ "hasDynamicHelp": true,
3846
+ "multiple": false,
3847
+ "type": "option"
3848
+ },
3849
+ "serial": {
3850
+ "char": "r",
3851
+ "name": "serial",
3852
+ "summary": "Run batches in serial mode.",
3851
3853
  "allowNo": false,
3852
3854
  "type": "boolean"
3853
3855
  }
3854
3856
  },
3855
3857
  "hasDynamicHelp": true,
3856
- "hidden": true,
3857
3858
  "hiddenAliases": [],
3858
- "id": "data:import:legacy:tree",
3859
+ "id": "force:data:bulk:upsert",
3859
3860
  "pluginAlias": "@salesforce/plugin-data",
3860
3861
  "pluginName": "@salesforce/plugin-data",
3861
3862
  "pluginType": "core",
3862
- "state": "deprecated",
3863
3863
  "strict": true,
3864
- "summary": "Import data from one or more JSON files into an org.",
3864
+ "summary": "Bulk upsert records to an org from a CSV file. Uses Bulk API 1.0.",
3865
3865
  "enableJsonFlag": true,
3866
3866
  "isESM": true,
3867
3867
  "relativePath": [
3868
3868
  "lib",
3869
3869
  "commands",
3870
+ "force",
3870
3871
  "data",
3871
- "import",
3872
- "legacy",
3873
- "tree.js"
3872
+ "bulk",
3873
+ "upsert.js"
3874
3874
  ],
3875
3875
  "aliasPermutations": [],
3876
3876
  "permutations": [
3877
- "data:import:legacy:tree",
3878
- "import:data:legacy:tree",
3879
- "import:legacy:data:tree",
3880
- "import:legacy:tree:data",
3881
- "data:legacy:import:tree",
3882
- "legacy:data:import:tree",
3883
- "legacy:import:data:tree",
3884
- "legacy:import:tree:data",
3885
- "data:legacy:tree:import",
3886
- "legacy:data:tree:import",
3887
- "legacy:tree:data:import",
3888
- "legacy:tree:import:data",
3889
- "data:import:tree:legacy",
3890
- "import:data:tree:legacy",
3891
- "import:tree:data:legacy",
3892
- "import:tree:legacy:data",
3893
- "data:tree:import:legacy",
3894
- "tree:data:import:legacy",
3895
- "tree:import:data:legacy",
3896
- "tree:import:legacy:data",
3897
- "data:tree:legacy:import",
3898
- "tree:data:legacy:import",
3899
- "tree:legacy:data:import",
3900
- "tree:legacy:import:data"
3877
+ "force:data:bulk:upsert",
3878
+ "data:force:bulk:upsert",
3879
+ "data:bulk:force:upsert",
3880
+ "data:bulk:upsert:force",
3881
+ "force:bulk:data:upsert",
3882
+ "bulk:force:data:upsert",
3883
+ "bulk:data:force:upsert",
3884
+ "bulk:data:upsert:force",
3885
+ "force:bulk:upsert:data",
3886
+ "bulk:force:upsert:data",
3887
+ "bulk:upsert:force:data",
3888
+ "bulk:upsert:data:force",
3889
+ "force:data:upsert:bulk",
3890
+ "data:force:upsert:bulk",
3891
+ "data:upsert:force:bulk",
3892
+ "data:upsert:bulk:force",
3893
+ "force:upsert:data:bulk",
3894
+ "upsert:force:data:bulk",
3895
+ "upsert:data:force:bulk",
3896
+ "upsert:data:bulk:force",
3897
+ "force:upsert:bulk:data",
3898
+ "upsert:force:bulk:data",
3899
+ "upsert:bulk:force:data",
3900
+ "upsert:bulk:data:force"
3901
3901
  ]
3902
3902
  }
3903
3903
  },
3904
- "version": "3.13.6"
3904
+ "version": "3.13.8"
3905
3905
  }