@salesforce/plugin-data 4.0.49 → 4.0.51
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -24
- package/oclif.manifest.json +583 -583
- package/package.json +7 -7
package/oclif.manifest.json
CHANGED
|
@@ -401,6 +401,83 @@
|
|
|
401
401
|
"search:data"
|
|
402
402
|
]
|
|
403
403
|
},
|
|
404
|
+
"data:bulk:results": {
|
|
405
|
+
"aliases": [],
|
|
406
|
+
"args": {},
|
|
407
|
+
"description": "Use this command to get the complete results after running one of the CLI commands that uses Bulk API 2.0 to ingest (import, update, upsert, or delete) large datasets to your org, such as \"data import bulk\". The previously-run bulk command must have completed; if it's still processing, run the corresponding resume command first, such as \"data import resume.\" Make note of the job ID of the previous bulk command because you use it to run this command. \n\nYou can also use this command to get results from running a bulk ingest job with a different tool, such as Data Loader, as long as you have the job ID. For information on Data Loader, see https://developer.salesforce.com/docs/atlas.en-us.dataLoader.meta/dataLoader/data_loader_intro.htm. \n\nThis command first displays the status of the previous bulk job, the operation that was executed in the org (such as insert or hard delete), and the updated Salesforce object. The command then displays how many records were processed in total, and how many were successful or failed. Finally, the output displays the names of the generated CSV-formatted files that contain the specific results for each ingested record. Depending on the success or failure of the bulk command, the results files can include the IDs of inserted records or the specific errors. When possible, if the ingest job failed or was aborted, you also get a CSV file with the unprocessed results.",
|
|
408
|
+
"examples": [
|
|
409
|
+
"Get results from a bulk ingest job; use the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --job-id 7507i000fake341G --target-org my-scratch"
|
|
410
|
+
],
|
|
411
|
+
"flags": {
|
|
412
|
+
"json": {
|
|
413
|
+
"description": "Format output as json.",
|
|
414
|
+
"helpGroup": "GLOBAL",
|
|
415
|
+
"name": "json",
|
|
416
|
+
"allowNo": false,
|
|
417
|
+
"type": "boolean"
|
|
418
|
+
},
|
|
419
|
+
"flags-dir": {
|
|
420
|
+
"helpGroup": "GLOBAL",
|
|
421
|
+
"name": "flags-dir",
|
|
422
|
+
"summary": "Import flag values from a directory.",
|
|
423
|
+
"hasDynamicHelp": false,
|
|
424
|
+
"multiple": false,
|
|
425
|
+
"type": "option"
|
|
426
|
+
},
|
|
427
|
+
"job-id": {
|
|
428
|
+
"char": "i",
|
|
429
|
+
"name": "job-id",
|
|
430
|
+
"required": true,
|
|
431
|
+
"summary": "Job ID of the bulk job.",
|
|
432
|
+
"hasDynamicHelp": false,
|
|
433
|
+
"multiple": false,
|
|
434
|
+
"type": "option"
|
|
435
|
+
},
|
|
436
|
+
"target-org": {
|
|
437
|
+
"char": "o",
|
|
438
|
+
"name": "target-org",
|
|
439
|
+
"noCacheDefault": true,
|
|
440
|
+
"required": true,
|
|
441
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
442
|
+
"hasDynamicHelp": true,
|
|
443
|
+
"multiple": false,
|
|
444
|
+
"type": "option"
|
|
445
|
+
},
|
|
446
|
+
"api-version": {
|
|
447
|
+
"description": "Override the api version used for api requests made by this command",
|
|
448
|
+
"name": "api-version",
|
|
449
|
+
"hasDynamicHelp": false,
|
|
450
|
+
"multiple": false,
|
|
451
|
+
"type": "option"
|
|
452
|
+
}
|
|
453
|
+
},
|
|
454
|
+
"hasDynamicHelp": true,
|
|
455
|
+
"hiddenAliases": [],
|
|
456
|
+
"id": "data:bulk:results",
|
|
457
|
+
"pluginAlias": "@salesforce/plugin-data",
|
|
458
|
+
"pluginName": "@salesforce/plugin-data",
|
|
459
|
+
"pluginType": "core",
|
|
460
|
+
"strict": true,
|
|
461
|
+
"summary": "Get the results of a bulk ingest job that you previously ran.",
|
|
462
|
+
"enableJsonFlag": true,
|
|
463
|
+
"isESM": true,
|
|
464
|
+
"relativePath": [
|
|
465
|
+
"lib",
|
|
466
|
+
"commands",
|
|
467
|
+
"data",
|
|
468
|
+
"bulk",
|
|
469
|
+
"results.js"
|
|
470
|
+
],
|
|
471
|
+
"aliasPermutations": [],
|
|
472
|
+
"permutations": [
|
|
473
|
+
"data:bulk:results",
|
|
474
|
+
"bulk:data:results",
|
|
475
|
+
"bulk:results:data",
|
|
476
|
+
"data:results:bulk",
|
|
477
|
+
"results:data:bulk",
|
|
478
|
+
"results:bulk:data"
|
|
479
|
+
]
|
|
480
|
+
},
|
|
404
481
|
"data:create:file": {
|
|
405
482
|
"aliases": [],
|
|
406
483
|
"args": {},
|
|
@@ -1102,83 +1179,6 @@
|
|
|
1102
1179
|
"resume:delete:data"
|
|
1103
1180
|
]
|
|
1104
1181
|
},
|
|
1105
|
-
"data:bulk:results": {
|
|
1106
|
-
"aliases": [],
|
|
1107
|
-
"args": {},
|
|
1108
|
-
"description": "Use this command to get the complete results after running one of the CLI commands that uses Bulk API 2.0 to ingest (import, update, upsert, or delete) large datasets to your org, such as \"data import bulk\". The previously-run bulk command must have completed; if it's still processing, run the corresponding resume command first, such as \"data import resume.\" Make note of the job ID of the previous bulk command because you use it to run this command. \n\nYou can also use this command to get results from running a bulk ingest job with a different tool, such as Data Loader, as long as you have the job ID. For information on Data Loader, see https://developer.salesforce.com/docs/atlas.en-us.dataLoader.meta/dataLoader/data_loader_intro.htm. \n\nThis command first displays the status of the previous bulk job, the operation that was executed in the org (such as insert or hard delete), and the updated Salesforce object. The command then displays how many records were processed in total, and how many were successful or failed. Finally, the output displays the names of the generated CSV-formatted files that contain the specific results for each ingested record. Depending on the success or failure of the bulk command, the results files can include the IDs of inserted records or the specific errors. When possible, if the ingest job failed or was aborted, you also get a CSV file with the unprocessed results.",
|
|
1109
|
-
"examples": [
|
|
1110
|
-
"Get results from a bulk ingest job; use the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --job-id 7507i000fake341G --target-org my-scratch"
|
|
1111
|
-
],
|
|
1112
|
-
"flags": {
|
|
1113
|
-
"json": {
|
|
1114
|
-
"description": "Format output as json.",
|
|
1115
|
-
"helpGroup": "GLOBAL",
|
|
1116
|
-
"name": "json",
|
|
1117
|
-
"allowNo": false,
|
|
1118
|
-
"type": "boolean"
|
|
1119
|
-
},
|
|
1120
|
-
"flags-dir": {
|
|
1121
|
-
"helpGroup": "GLOBAL",
|
|
1122
|
-
"name": "flags-dir",
|
|
1123
|
-
"summary": "Import flag values from a directory.",
|
|
1124
|
-
"hasDynamicHelp": false,
|
|
1125
|
-
"multiple": false,
|
|
1126
|
-
"type": "option"
|
|
1127
|
-
},
|
|
1128
|
-
"job-id": {
|
|
1129
|
-
"char": "i",
|
|
1130
|
-
"name": "job-id",
|
|
1131
|
-
"required": true,
|
|
1132
|
-
"summary": "Job ID of the bulk job.",
|
|
1133
|
-
"hasDynamicHelp": false,
|
|
1134
|
-
"multiple": false,
|
|
1135
|
-
"type": "option"
|
|
1136
|
-
},
|
|
1137
|
-
"target-org": {
|
|
1138
|
-
"char": "o",
|
|
1139
|
-
"name": "target-org",
|
|
1140
|
-
"noCacheDefault": true,
|
|
1141
|
-
"required": true,
|
|
1142
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1143
|
-
"hasDynamicHelp": true,
|
|
1144
|
-
"multiple": false,
|
|
1145
|
-
"type": "option"
|
|
1146
|
-
},
|
|
1147
|
-
"api-version": {
|
|
1148
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1149
|
-
"name": "api-version",
|
|
1150
|
-
"hasDynamicHelp": false,
|
|
1151
|
-
"multiple": false,
|
|
1152
|
-
"type": "option"
|
|
1153
|
-
}
|
|
1154
|
-
},
|
|
1155
|
-
"hasDynamicHelp": true,
|
|
1156
|
-
"hiddenAliases": [],
|
|
1157
|
-
"id": "data:bulk:results",
|
|
1158
|
-
"pluginAlias": "@salesforce/plugin-data",
|
|
1159
|
-
"pluginName": "@salesforce/plugin-data",
|
|
1160
|
-
"pluginType": "core",
|
|
1161
|
-
"strict": true,
|
|
1162
|
-
"summary": "Get the results of a bulk ingest job that you previously ran.",
|
|
1163
|
-
"enableJsonFlag": true,
|
|
1164
|
-
"isESM": true,
|
|
1165
|
-
"relativePath": [
|
|
1166
|
-
"lib",
|
|
1167
|
-
"commands",
|
|
1168
|
-
"data",
|
|
1169
|
-
"bulk",
|
|
1170
|
-
"results.js"
|
|
1171
|
-
],
|
|
1172
|
-
"aliasPermutations": [],
|
|
1173
|
-
"permutations": [
|
|
1174
|
-
"data:bulk:results",
|
|
1175
|
-
"bulk:data:results",
|
|
1176
|
-
"bulk:results:data",
|
|
1177
|
-
"data:results:bulk",
|
|
1178
|
-
"results:data:bulk",
|
|
1179
|
-
"results:bulk:data"
|
|
1180
|
-
]
|
|
1181
|
-
},
|
|
1182
1182
|
"data:export:bulk": {
|
|
1183
1183
|
"aliases": [],
|
|
1184
1184
|
"args": {},
|
|
@@ -1765,13 +1765,13 @@
|
|
|
1765
1765
|
"record:get:data"
|
|
1766
1766
|
]
|
|
1767
1767
|
},
|
|
1768
|
-
"data:
|
|
1768
|
+
"data:update:bulk": {
|
|
1769
1769
|
"aliases": [],
|
|
1770
1770
|
"args": {},
|
|
1771
|
-
"description": "You can use this command to
|
|
1771
|
+
"description": "You can use this command to update millions of Salesforce object records based on 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. The first column of every line in the CSV file must be an ID of the record you want to update. The CSV file can contain only existing records; if a record in the file doesn't currently exist in the Salesforce object, the command fails. Consider using \"sf data upsert bulk\" if you also want to insert new records.\n\nBulk updates 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 update 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).",
|
|
1772
1772
|
"examples": [
|
|
1773
|
-
"
|
|
1774
|
-
"
|
|
1773
|
+
"Update Account records from a CSV-formatted file into an org with alias \"my-scratch\"; if the update 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",
|
|
1774
|
+
"Update asynchronously and use the default org; the command immediately returns a job ID that you then pass to the \"sf data update resume\" command:\n<%= config.bin %> <%= command.id %> --file accounts.csv --sobject Account --async"
|
|
1775
1775
|
],
|
|
1776
1776
|
"flags": {
|
|
1777
1777
|
"json": {
|
|
@@ -1792,19 +1792,24 @@
|
|
|
1792
1792
|
"async": {
|
|
1793
1793
|
"char": "a",
|
|
1794
1794
|
"deprecated": true,
|
|
1795
|
-
"exclusive": [
|
|
1796
|
-
"wait"
|
|
1797
|
-
],
|
|
1798
1795
|
"name": "async",
|
|
1799
1796
|
"summary": "Don't wait for the command to complete.",
|
|
1800
1797
|
"allowNo": false,
|
|
1801
1798
|
"type": "boolean"
|
|
1802
1799
|
},
|
|
1800
|
+
"wait": {
|
|
1801
|
+
"char": "w",
|
|
1802
|
+
"name": "wait",
|
|
1803
|
+
"summary": "Time to wait for the command to finish, in minutes.",
|
|
1804
|
+
"hasDynamicHelp": true,
|
|
1805
|
+
"multiple": false,
|
|
1806
|
+
"type": "option"
|
|
1807
|
+
},
|
|
1803
1808
|
"file": {
|
|
1804
1809
|
"char": "f",
|
|
1805
1810
|
"name": "file",
|
|
1806
1811
|
"required": true,
|
|
1807
|
-
"summary": "CSV file that contains the Salesforce object records you want to
|
|
1812
|
+
"summary": "CSV file that contains the Salesforce object records you want to update.",
|
|
1808
1813
|
"hasDynamicHelp": false,
|
|
1809
1814
|
"multiple": false,
|
|
1810
1815
|
"type": "option"
|
|
@@ -1813,7 +1818,7 @@
|
|
|
1813
1818
|
"char": "s",
|
|
1814
1819
|
"name": "sobject",
|
|
1815
1820
|
"required": true,
|
|
1816
|
-
"summary": "API name of the Salesforce object, either standard or custom,
|
|
1821
|
+
"summary": "API name of the Salesforce object, either standard or custom, which you are updating.",
|
|
1817
1822
|
"hasDynamicHelp": false,
|
|
1818
1823
|
"multiple": false,
|
|
1819
1824
|
"type": "option"
|
|
@@ -1825,17 +1830,6 @@
|
|
|
1825
1830
|
"multiple": false,
|
|
1826
1831
|
"type": "option"
|
|
1827
1832
|
},
|
|
1828
|
-
"wait": {
|
|
1829
|
-
"char": "w",
|
|
1830
|
-
"exclusive": [
|
|
1831
|
-
"async"
|
|
1832
|
-
],
|
|
1833
|
-
"name": "wait",
|
|
1834
|
-
"summary": "Time to wait for the command to finish, in minutes.",
|
|
1835
|
-
"hasDynamicHelp": true,
|
|
1836
|
-
"multiple": false,
|
|
1837
|
-
"type": "option"
|
|
1838
|
-
},
|
|
1839
1833
|
"target-org": {
|
|
1840
1834
|
"char": "o",
|
|
1841
1835
|
"name": "target-org",
|
|
@@ -1878,38 +1872,43 @@
|
|
|
1878
1872
|
},
|
|
1879
1873
|
"hasDynamicHelp": true,
|
|
1880
1874
|
"hiddenAliases": [],
|
|
1881
|
-
"id": "data:
|
|
1875
|
+
"id": "data:update:bulk",
|
|
1882
1876
|
"pluginAlias": "@salesforce/plugin-data",
|
|
1883
1877
|
"pluginName": "@salesforce/plugin-data",
|
|
1884
1878
|
"pluginType": "core",
|
|
1885
1879
|
"strict": true,
|
|
1886
|
-
"summary": "Bulk
|
|
1880
|
+
"summary": "Bulk update records to an org from a CSV file. Uses Bulk API 2.0.",
|
|
1887
1881
|
"enableJsonFlag": true,
|
|
1888
1882
|
"isESM": true,
|
|
1889
1883
|
"relativePath": [
|
|
1890
1884
|
"lib",
|
|
1891
1885
|
"commands",
|
|
1892
1886
|
"data",
|
|
1893
|
-
"
|
|
1887
|
+
"update",
|
|
1894
1888
|
"bulk.js"
|
|
1895
1889
|
],
|
|
1896
1890
|
"aliasPermutations": [],
|
|
1897
1891
|
"permutations": [
|
|
1898
|
-
"data:
|
|
1899
|
-
"
|
|
1900
|
-
"
|
|
1901
|
-
"data:bulk:
|
|
1902
|
-
"bulk:data:
|
|
1903
|
-
"bulk:
|
|
1892
|
+
"data:update:bulk",
|
|
1893
|
+
"update:data:bulk",
|
|
1894
|
+
"update:bulk:data",
|
|
1895
|
+
"data:bulk:update",
|
|
1896
|
+
"bulk:data:update",
|
|
1897
|
+
"bulk:update:data"
|
|
1904
1898
|
]
|
|
1905
1899
|
},
|
|
1906
|
-
"data:
|
|
1907
|
-
"aliases": [
|
|
1900
|
+
"data:update:record": {
|
|
1901
|
+
"aliases": [
|
|
1902
|
+
"force:data:record:update"
|
|
1903
|
+
],
|
|
1908
1904
|
"args": {},
|
|
1909
|
-
"
|
|
1905
|
+
"deprecateAliases": true,
|
|
1906
|
+
"description": "Specify the record you want to update 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 update fails; the error displays how many records were found.\n\nWhen using field-value pairs for both identifying the record and specifiyng the new field values, 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 updates a record in Salesforce objects by default. Use the --use-tooling-api flag to update a Tooling API object.",
|
|
1910
1907
|
"examples": [
|
|
1911
|
-
"
|
|
1912
|
-
"
|
|
1908
|
+
"Update the Name field of an Account record with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 001D0 --values \"Name=NewAcme\"",
|
|
1909
|
+
"Update the Name field of an Account record whose current name is 'Old Acme':\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name='Old Acme'\" --values \"Name='New Acme'\"",
|
|
1910
|
+
"Update the Name and Website fields of an Account record with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 001D0 --values \"Name='Acme III' Website=www.example.com\"",
|
|
1911
|
+
"Update the ExpirationDate field of a record of the Tooling API object TraceFlag using the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> -t --sobject TraceFlag --record-id 7tf170000009cUBAAY --values \"ExpirationDate=2017-12-01T00:58:04.000+0000\""
|
|
1913
1912
|
],
|
|
1914
1913
|
"flags": {
|
|
1915
1914
|
"json": {
|
|
@@ -1927,202 +1926,165 @@
|
|
|
1927
1926
|
"multiple": false,
|
|
1928
1927
|
"type": "option"
|
|
1929
1928
|
},
|
|
1930
|
-
"
|
|
1931
|
-
"
|
|
1932
|
-
|
|
1933
|
-
|
|
1934
|
-
|
|
1929
|
+
"target-org": {
|
|
1930
|
+
"aliases": [
|
|
1931
|
+
"targetusername",
|
|
1932
|
+
"u"
|
|
1933
|
+
],
|
|
1934
|
+
"char": "o",
|
|
1935
|
+
"deprecateAliases": true,
|
|
1936
|
+
"name": "target-org",
|
|
1937
|
+
"noCacheDefault": true,
|
|
1938
|
+
"required": true,
|
|
1939
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1940
|
+
"hasDynamicHelp": true,
|
|
1941
|
+
"multiple": false,
|
|
1942
|
+
"type": "option"
|
|
1935
1943
|
},
|
|
1936
|
-
"
|
|
1937
|
-
"
|
|
1938
|
-
|
|
1939
|
-
|
|
1944
|
+
"api-version": {
|
|
1945
|
+
"aliases": [
|
|
1946
|
+
"apiversion"
|
|
1947
|
+
],
|
|
1948
|
+
"deprecateAliases": true,
|
|
1949
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1950
|
+
"name": "api-version",
|
|
1940
1951
|
"hasDynamicHelp": false,
|
|
1941
1952
|
"multiple": false,
|
|
1942
1953
|
"type": "option"
|
|
1943
1954
|
},
|
|
1944
|
-
"
|
|
1945
|
-
"
|
|
1946
|
-
|
|
1947
|
-
|
|
1948
|
-
"
|
|
1949
|
-
"
|
|
1950
|
-
"multiple": false,
|
|
1951
|
-
"type": "option"
|
|
1952
|
-
}
|
|
1953
|
-
},
|
|
1954
|
-
"hasDynamicHelp": true,
|
|
1955
|
-
"hiddenAliases": [],
|
|
1956
|
-
"id": "data:import:resume",
|
|
1957
|
-
"pluginAlias": "@salesforce/plugin-data",
|
|
1958
|
-
"pluginName": "@salesforce/plugin-data",
|
|
1959
|
-
"pluginType": "core",
|
|
1960
|
-
"strict": true,
|
|
1961
|
-
"summary": "Resume a bulk import job that you previously started. Uses Bulk API 2.0.",
|
|
1962
|
-
"enableJsonFlag": true,
|
|
1963
|
-
"isESM": true,
|
|
1964
|
-
"relativePath": [
|
|
1965
|
-
"lib",
|
|
1966
|
-
"commands",
|
|
1967
|
-
"data",
|
|
1968
|
-
"import",
|
|
1969
|
-
"resume.js"
|
|
1970
|
-
],
|
|
1971
|
-
"aliasPermutations": [],
|
|
1972
|
-
"permutations": [
|
|
1973
|
-
"data:import:resume",
|
|
1974
|
-
"import:data:resume",
|
|
1975
|
-
"import:resume:data",
|
|
1976
|
-
"data:resume:import",
|
|
1977
|
-
"resume:data:import",
|
|
1978
|
-
"resume:import:data"
|
|
1979
|
-
]
|
|
1980
|
-
},
|
|
1981
|
-
"data:import:tree": {
|
|
1982
|
-
"aliases": [
|
|
1983
|
-
"force:data:tree:import"
|
|
1984
|
-
],
|
|
1985
|
-
"args": {},
|
|
1986
|
-
"deprecateAliases": true,
|
|
1987
|
-
"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.",
|
|
1988
|
-
"examples": [
|
|
1989
|
-
"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",
|
|
1990
|
-
"Import records using a plan definition file into your default org:\n<%= config.bin %> <%= command.id %> --plan Account-Contact-plan.json"
|
|
1991
|
-
],
|
|
1992
|
-
"flags": {
|
|
1993
|
-
"json": {
|
|
1994
|
-
"description": "Format output as json.",
|
|
1995
|
-
"helpGroup": "GLOBAL",
|
|
1996
|
-
"name": "json",
|
|
1997
|
-
"allowNo": false,
|
|
1998
|
-
"type": "boolean"
|
|
1999
|
-
},
|
|
2000
|
-
"flags-dir": {
|
|
2001
|
-
"helpGroup": "GLOBAL",
|
|
2002
|
-
"name": "flags-dir",
|
|
2003
|
-
"summary": "Import flag values from a directory.",
|
|
1955
|
+
"loglevel": {
|
|
1956
|
+
"deprecated": {
|
|
1957
|
+
"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."
|
|
1958
|
+
},
|
|
1959
|
+
"hidden": true,
|
|
1960
|
+
"name": "loglevel",
|
|
2004
1961
|
"hasDynamicHelp": false,
|
|
2005
1962
|
"multiple": false,
|
|
2006
1963
|
"type": "option"
|
|
2007
1964
|
},
|
|
2008
|
-
"
|
|
1965
|
+
"sobject": {
|
|
2009
1966
|
"aliases": [
|
|
2010
|
-
"
|
|
2011
|
-
"u"
|
|
1967
|
+
"sobjecttype"
|
|
2012
1968
|
],
|
|
2013
|
-
"char": "
|
|
1969
|
+
"char": "s",
|
|
2014
1970
|
"deprecateAliases": true,
|
|
2015
|
-
"name": "
|
|
2016
|
-
"noCacheDefault": true,
|
|
1971
|
+
"name": "sobject",
|
|
2017
1972
|
"required": true,
|
|
2018
|
-
"summary": "
|
|
2019
|
-
"hasDynamicHelp":
|
|
1973
|
+
"summary": "API name of the Salesforce or Tooling API object that contains the record you're updating.",
|
|
1974
|
+
"hasDynamicHelp": false,
|
|
2020
1975
|
"multiple": false,
|
|
2021
1976
|
"type": "option"
|
|
2022
1977
|
},
|
|
2023
|
-
"
|
|
1978
|
+
"record-id": {
|
|
2024
1979
|
"aliases": [
|
|
2025
|
-
"
|
|
1980
|
+
"sobjectid"
|
|
2026
1981
|
],
|
|
1982
|
+
"char": "i",
|
|
2027
1983
|
"deprecateAliases": true,
|
|
2028
|
-
"
|
|
2029
|
-
"
|
|
1984
|
+
"name": "record-id",
|
|
1985
|
+
"summary": "ID of the record you’re updating.",
|
|
2030
1986
|
"hasDynamicHelp": false,
|
|
2031
1987
|
"multiple": false,
|
|
2032
1988
|
"type": "option"
|
|
2033
1989
|
},
|
|
2034
|
-
"
|
|
2035
|
-
"
|
|
2036
|
-
|
|
2037
|
-
|
|
2038
|
-
"hidden": true,
|
|
2039
|
-
"name": "loglevel",
|
|
1990
|
+
"where": {
|
|
1991
|
+
"char": "w",
|
|
1992
|
+
"name": "where",
|
|
1993
|
+
"summary": "List of <fieldName>=<value> pairs that identify the record you want to update.",
|
|
2040
1994
|
"hasDynamicHelp": false,
|
|
2041
1995
|
"multiple": false,
|
|
2042
1996
|
"type": "option"
|
|
2043
1997
|
},
|
|
2044
|
-
"
|
|
1998
|
+
"values": {
|
|
1999
|
+
"char": "v",
|
|
2000
|
+
"name": "values",
|
|
2001
|
+
"required": true,
|
|
2002
|
+
"summary": "Fields that you're updating, in the format of <fieldName>=<value> pairs.",
|
|
2003
|
+
"hasDynamicHelp": false,
|
|
2004
|
+
"multiple": false,
|
|
2005
|
+
"type": "option"
|
|
2006
|
+
},
|
|
2007
|
+
"use-tooling-api": {
|
|
2045
2008
|
"aliases": [
|
|
2046
|
-
"
|
|
2009
|
+
"usetoolingapi"
|
|
2047
2010
|
],
|
|
2048
|
-
"char": "
|
|
2011
|
+
"char": "t",
|
|
2049
2012
|
"deprecateAliases": true,
|
|
2050
|
-
"name": "
|
|
2051
|
-
"summary": "
|
|
2052
|
-
"
|
|
2053
|
-
"
|
|
2054
|
-
"multiple": true,
|
|
2055
|
-
"type": "option"
|
|
2013
|
+
"name": "use-tooling-api",
|
|
2014
|
+
"summary": "Use Tooling API so you can update a record in a Tooling API object.",
|
|
2015
|
+
"allowNo": false,
|
|
2016
|
+
"type": "boolean"
|
|
2056
2017
|
},
|
|
2057
|
-
"
|
|
2058
|
-
"
|
|
2059
|
-
|
|
2060
|
-
|
|
2061
|
-
"
|
|
2062
|
-
"
|
|
2063
|
-
"
|
|
2064
|
-
"
|
|
2018
|
+
"perflog": {
|
|
2019
|
+
"deprecated": {
|
|
2020
|
+
"version": "57"
|
|
2021
|
+
},
|
|
2022
|
+
"hidden": true,
|
|
2023
|
+
"name": "perflog",
|
|
2024
|
+
"summary": "Get API performance data.",
|
|
2025
|
+
"allowNo": false,
|
|
2026
|
+
"type": "boolean"
|
|
2065
2027
|
}
|
|
2066
2028
|
},
|
|
2067
2029
|
"hasDynamicHelp": true,
|
|
2068
2030
|
"hiddenAliases": [],
|
|
2069
|
-
"id": "data:
|
|
2031
|
+
"id": "data:update:record",
|
|
2070
2032
|
"pluginAlias": "@salesforce/plugin-data",
|
|
2071
2033
|
"pluginName": "@salesforce/plugin-data",
|
|
2072
2034
|
"pluginType": "core",
|
|
2073
2035
|
"strict": true,
|
|
2074
|
-
"summary": "
|
|
2036
|
+
"summary": "Updates a single record of a Salesforce or Tooling API object.",
|
|
2075
2037
|
"enableJsonFlag": true,
|
|
2076
2038
|
"isESM": true,
|
|
2077
2039
|
"relativePath": [
|
|
2078
2040
|
"lib",
|
|
2079
2041
|
"commands",
|
|
2080
2042
|
"data",
|
|
2081
|
-
"
|
|
2082
|
-
"
|
|
2043
|
+
"update",
|
|
2044
|
+
"record.js"
|
|
2083
2045
|
],
|
|
2084
2046
|
"aliasPermutations": [
|
|
2085
|
-
"force:data:
|
|
2086
|
-
"data:force:
|
|
2087
|
-
"data:
|
|
2088
|
-
"data:
|
|
2089
|
-
"force:
|
|
2090
|
-
"
|
|
2091
|
-
"
|
|
2092
|
-
"
|
|
2093
|
-
"force:
|
|
2094
|
-
"
|
|
2095
|
-
"
|
|
2096
|
-
"
|
|
2097
|
-
"force:data:
|
|
2098
|
-
"data:force:
|
|
2099
|
-
"data:
|
|
2100
|
-
"data:
|
|
2101
|
-
"force:
|
|
2102
|
-
"
|
|
2103
|
-
"
|
|
2104
|
-
"
|
|
2105
|
-
"force:
|
|
2106
|
-
"
|
|
2107
|
-
"
|
|
2108
|
-
"
|
|
2047
|
+
"force:data:record:update",
|
|
2048
|
+
"data:force:record:update",
|
|
2049
|
+
"data:record:force:update",
|
|
2050
|
+
"data:record:update:force",
|
|
2051
|
+
"force:record:data:update",
|
|
2052
|
+
"record:force:data:update",
|
|
2053
|
+
"record:data:force:update",
|
|
2054
|
+
"record:data:update:force",
|
|
2055
|
+
"force:record:update:data",
|
|
2056
|
+
"record:force:update:data",
|
|
2057
|
+
"record:update:force:data",
|
|
2058
|
+
"record:update:data:force",
|
|
2059
|
+
"force:data:update:record",
|
|
2060
|
+
"data:force:update:record",
|
|
2061
|
+
"data:update:force:record",
|
|
2062
|
+
"data:update:record:force",
|
|
2063
|
+
"force:update:data:record",
|
|
2064
|
+
"update:force:data:record",
|
|
2065
|
+
"update:data:force:record",
|
|
2066
|
+
"update:data:record:force",
|
|
2067
|
+
"force:update:record:data",
|
|
2068
|
+
"update:force:record:data",
|
|
2069
|
+
"update:record:force:data",
|
|
2070
|
+
"update:record:data:force"
|
|
2109
2071
|
],
|
|
2110
2072
|
"permutations": [
|
|
2111
|
-
"data:
|
|
2112
|
-
"
|
|
2113
|
-
"
|
|
2114
|
-
"data:
|
|
2115
|
-
"
|
|
2116
|
-
"
|
|
2073
|
+
"data:update:record",
|
|
2074
|
+
"update:data:record",
|
|
2075
|
+
"update:record:data",
|
|
2076
|
+
"data:record:update",
|
|
2077
|
+
"record:data:update",
|
|
2078
|
+
"record:update:data"
|
|
2117
2079
|
]
|
|
2118
2080
|
},
|
|
2119
|
-
"data:update:
|
|
2081
|
+
"data:update:resume": {
|
|
2120
2082
|
"aliases": [],
|
|
2121
2083
|
"args": {},
|
|
2122
|
-
"description": "
|
|
2084
|
+
"description": "When the original \"sf data update 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 update, run this command by either passing it the job ID or using the --use-most-recent flag to specify the most recent bulk update job.\n\nUsing either `--job-id` or `--use-most-recent` will properly resolve to the correct org where the bulk job was started based on the cached data by \"data update bulk\".",
|
|
2123
2085
|
"examples": [
|
|
2124
|
-
"
|
|
2125
|
-
"
|
|
2086
|
+
"Resume a bulk update job using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
|
|
2087
|
+
"Resume the most recently run bulk update job:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
2126
2088
|
],
|
|
2127
2089
|
"flags": {
|
|
2128
2090
|
"json": {
|
|
@@ -2140,95 +2102,38 @@
|
|
|
2140
2102
|
"multiple": false,
|
|
2141
2103
|
"type": "option"
|
|
2142
2104
|
},
|
|
2143
|
-
"
|
|
2144
|
-
"
|
|
2145
|
-
"
|
|
2146
|
-
"name": "async",
|
|
2147
|
-
"summary": "Don't wait for the command to complete.",
|
|
2105
|
+
"use-most-recent": {
|
|
2106
|
+
"name": "use-most-recent",
|
|
2107
|
+
"summary": "Use the job ID of the bulk update job that was most recently run.",
|
|
2148
2108
|
"allowNo": false,
|
|
2149
2109
|
"type": "boolean"
|
|
2150
2110
|
},
|
|
2151
|
-
"
|
|
2152
|
-
"char": "
|
|
2153
|
-
"name": "
|
|
2154
|
-
"summary": "
|
|
2155
|
-
"hasDynamicHelp": true,
|
|
2156
|
-
"multiple": false,
|
|
2157
|
-
"type": "option"
|
|
2158
|
-
},
|
|
2159
|
-
"file": {
|
|
2160
|
-
"char": "f",
|
|
2161
|
-
"name": "file",
|
|
2162
|
-
"required": true,
|
|
2163
|
-
"summary": "CSV file that contains the Salesforce object records you want to update.",
|
|
2164
|
-
"hasDynamicHelp": false,
|
|
2165
|
-
"multiple": false,
|
|
2166
|
-
"type": "option"
|
|
2167
|
-
},
|
|
2168
|
-
"sobject": {
|
|
2169
|
-
"char": "s",
|
|
2170
|
-
"name": "sobject",
|
|
2171
|
-
"required": true,
|
|
2172
|
-
"summary": "API name of the Salesforce object, either standard or custom, which you are updating.",
|
|
2173
|
-
"hasDynamicHelp": false,
|
|
2174
|
-
"multiple": false,
|
|
2175
|
-
"type": "option"
|
|
2176
|
-
},
|
|
2177
|
-
"api-version": {
|
|
2178
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2179
|
-
"name": "api-version",
|
|
2111
|
+
"job-id": {
|
|
2112
|
+
"char": "i",
|
|
2113
|
+
"name": "job-id",
|
|
2114
|
+
"summary": "Job ID of the bulk update.",
|
|
2180
2115
|
"hasDynamicHelp": false,
|
|
2181
2116
|
"multiple": false,
|
|
2182
2117
|
"type": "option"
|
|
2183
2118
|
},
|
|
2184
|
-
"
|
|
2185
|
-
"char": "
|
|
2186
|
-
"name": "
|
|
2187
|
-
"
|
|
2188
|
-
"
|
|
2189
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2119
|
+
"wait": {
|
|
2120
|
+
"char": "w",
|
|
2121
|
+
"name": "wait",
|
|
2122
|
+
"summary": "Time to wait for the command to finish, in minutes.",
|
|
2123
|
+
"default": "5 minutes",
|
|
2190
2124
|
"hasDynamicHelp": true,
|
|
2191
2125
|
"multiple": false,
|
|
2192
2126
|
"type": "option"
|
|
2193
|
-
},
|
|
2194
|
-
"line-ending": {
|
|
2195
|
-
"dependsOn": [
|
|
2196
|
-
"file"
|
|
2197
|
-
],
|
|
2198
|
-
"name": "line-ending",
|
|
2199
|
-
"summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LF`.",
|
|
2200
|
-
"hasDynamicHelp": false,
|
|
2201
|
-
"multiple": false,
|
|
2202
|
-
"options": [
|
|
2203
|
-
"CRLF",
|
|
2204
|
-
"LF"
|
|
2205
|
-
],
|
|
2206
|
-
"type": "option"
|
|
2207
|
-
},
|
|
2208
|
-
"column-delimiter": {
|
|
2209
|
-
"name": "column-delimiter",
|
|
2210
|
-
"summary": "Column delimiter used in the CSV file.",
|
|
2211
|
-
"hasDynamicHelp": false,
|
|
2212
|
-
"multiple": false,
|
|
2213
|
-
"options": [
|
|
2214
|
-
"BACKQUOTE",
|
|
2215
|
-
"CARET",
|
|
2216
|
-
"COMMA",
|
|
2217
|
-
"PIPE",
|
|
2218
|
-
"SEMICOLON",
|
|
2219
|
-
"TAB"
|
|
2220
|
-
],
|
|
2221
|
-
"type": "option"
|
|
2222
2127
|
}
|
|
2223
2128
|
},
|
|
2224
2129
|
"hasDynamicHelp": true,
|
|
2225
2130
|
"hiddenAliases": [],
|
|
2226
|
-
"id": "data:update:
|
|
2131
|
+
"id": "data:update:resume",
|
|
2227
2132
|
"pluginAlias": "@salesforce/plugin-data",
|
|
2228
2133
|
"pluginName": "@salesforce/plugin-data",
|
|
2229
2134
|
"pluginType": "core",
|
|
2230
2135
|
"strict": true,
|
|
2231
|
-
"summary": "
|
|
2136
|
+
"summary": "Resume a bulk update job that you previously started. Uses Bulk API 2.0.",
|
|
2232
2137
|
"enableJsonFlag": true,
|
|
2233
2138
|
"isESM": true,
|
|
2234
2139
|
"relativePath": [
|
|
@@ -2236,30 +2141,25 @@
|
|
|
2236
2141
|
"commands",
|
|
2237
2142
|
"data",
|
|
2238
2143
|
"update",
|
|
2239
|
-
"
|
|
2144
|
+
"resume.js"
|
|
2240
2145
|
],
|
|
2241
2146
|
"aliasPermutations": [],
|
|
2242
2147
|
"permutations": [
|
|
2243
|
-
"data:update:
|
|
2244
|
-
"update:data:
|
|
2245
|
-
"update:
|
|
2246
|
-
"data:
|
|
2247
|
-
"
|
|
2248
|
-
"
|
|
2148
|
+
"data:update:resume",
|
|
2149
|
+
"update:data:resume",
|
|
2150
|
+
"update:resume:data",
|
|
2151
|
+
"data:resume:update",
|
|
2152
|
+
"resume:data:update",
|
|
2153
|
+
"resume:update:data"
|
|
2249
2154
|
]
|
|
2250
2155
|
},
|
|
2251
|
-
"data:
|
|
2252
|
-
"aliases": [
|
|
2253
|
-
"force:data:record:update"
|
|
2254
|
-
],
|
|
2156
|
+
"data:upsert:bulk": {
|
|
2157
|
+
"aliases": [],
|
|
2255
2158
|
"args": {},
|
|
2256
|
-
"
|
|
2257
|
-
"description": "Specify the record you want to update 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 update fails; the error displays how many records were found.\n\nWhen using field-value pairs for both identifying the record and specifiyng the new field values, 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 updates a record in Salesforce objects by default. Use the --use-tooling-api flag to update a Tooling API object.",
|
|
2159
|
+
"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, 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 and batch IDs to check the status of the job with the \"<%= config.bin %> data upsert resume\" command.\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_prepare_csv.htm)",
|
|
2258
2160
|
"examples": [
|
|
2259
|
-
"
|
|
2260
|
-
"
|
|
2261
|
-
"Update the Name and Website fields of an Account record with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 001D0 --values \"Name='Acme III' Website=www.example.com\"",
|
|
2262
|
-
"Update the ExpirationDate field of a record of the Tooling API object TraceFlag using the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> -t --sobject TraceFlag --record-id 7tf170000009cUBAAY --values \"ExpirationDate=2017-12-01T00:58:04.000+0000\""
|
|
2161
|
+
"Bulk upsert records to the Contact object in your default org:\n<%= config.bin %> <%= command.id %> --sobject Contact --file files/contacts.csv --external-id Id",
|
|
2162
|
+
"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"
|
|
2263
2163
|
],
|
|
2264
2164
|
"flags": {
|
|
2265
2165
|
"json": {
|
|
@@ -2296,146 +2196,149 @@
|
|
|
2296
2196
|
"aliases": [
|
|
2297
2197
|
"apiversion"
|
|
2298
2198
|
],
|
|
2299
|
-
"deprecateAliases": true,
|
|
2300
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2301
|
-
"name": "api-version",
|
|
2199
|
+
"deprecateAliases": true,
|
|
2200
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2201
|
+
"name": "api-version",
|
|
2202
|
+
"hasDynamicHelp": false,
|
|
2203
|
+
"multiple": false,
|
|
2204
|
+
"type": "option"
|
|
2205
|
+
},
|
|
2206
|
+
"loglevel": {
|
|
2207
|
+
"deprecated": {
|
|
2208
|
+
"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."
|
|
2209
|
+
},
|
|
2210
|
+
"hidden": true,
|
|
2211
|
+
"name": "loglevel",
|
|
2212
|
+
"hasDynamicHelp": false,
|
|
2213
|
+
"multiple": false,
|
|
2214
|
+
"type": "option"
|
|
2215
|
+
},
|
|
2216
|
+
"file": {
|
|
2217
|
+
"aliases": [
|
|
2218
|
+
"csvfile"
|
|
2219
|
+
],
|
|
2220
|
+
"char": "f",
|
|
2221
|
+
"deprecateAliases": true,
|
|
2222
|
+
"name": "file",
|
|
2223
|
+
"required": true,
|
|
2224
|
+
"summary": "CSV file that contains the IDs of the records to update or delete.",
|
|
2225
|
+
"hasDynamicHelp": false,
|
|
2226
|
+
"multiple": false,
|
|
2227
|
+
"type": "option"
|
|
2228
|
+
},
|
|
2229
|
+
"sobject": {
|
|
2230
|
+
"aliases": [
|
|
2231
|
+
"sobjecttype"
|
|
2232
|
+
],
|
|
2233
|
+
"char": "s",
|
|
2234
|
+
"deprecateAliases": true,
|
|
2235
|
+
"name": "sobject",
|
|
2236
|
+
"required": true,
|
|
2237
|
+
"summary": "API name of the Salesforce object, either standard or custom, that you want to update or delete records from.",
|
|
2238
|
+
"hasDynamicHelp": false,
|
|
2239
|
+
"multiple": false,
|
|
2240
|
+
"type": "option"
|
|
2241
|
+
},
|
|
2242
|
+
"wait": {
|
|
2243
|
+
"char": "w",
|
|
2244
|
+
"exclusive": [
|
|
2245
|
+
"async"
|
|
2246
|
+
],
|
|
2247
|
+
"name": "wait",
|
|
2248
|
+
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
2249
|
+
"default": "0 minutes",
|
|
2250
|
+
"hasDynamicHelp": true,
|
|
2251
|
+
"multiple": false,
|
|
2252
|
+
"type": "option"
|
|
2253
|
+
},
|
|
2254
|
+
"async": {
|
|
2255
|
+
"char": "a",
|
|
2256
|
+
"deprecated": true,
|
|
2257
|
+
"exclusive": [
|
|
2258
|
+
"wait"
|
|
2259
|
+
],
|
|
2260
|
+
"name": "async",
|
|
2261
|
+
"summary": "Run the command asynchronously.",
|
|
2262
|
+
"allowNo": false,
|
|
2263
|
+
"type": "boolean"
|
|
2264
|
+
},
|
|
2265
|
+
"line-ending": {
|
|
2266
|
+
"dependsOn": [
|
|
2267
|
+
"file"
|
|
2268
|
+
],
|
|
2269
|
+
"name": "line-ending",
|
|
2270
|
+
"summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LF`.",
|
|
2302
2271
|
"hasDynamicHelp": false,
|
|
2303
2272
|
"multiple": false,
|
|
2273
|
+
"options": [
|
|
2274
|
+
"CRLF",
|
|
2275
|
+
"LF"
|
|
2276
|
+
],
|
|
2304
2277
|
"type": "option"
|
|
2305
2278
|
},
|
|
2306
|
-
"
|
|
2307
|
-
"
|
|
2308
|
-
|
|
2309
|
-
},
|
|
2310
|
-
"hidden": true,
|
|
2311
|
-
"name": "loglevel",
|
|
2279
|
+
"column-delimiter": {
|
|
2280
|
+
"name": "column-delimiter",
|
|
2281
|
+
"summary": "Column delimiter used in the CSV file.",
|
|
2312
2282
|
"hasDynamicHelp": false,
|
|
2313
2283
|
"multiple": false,
|
|
2314
|
-
"
|
|
2315
|
-
|
|
2316
|
-
|
|
2317
|
-
|
|
2318
|
-
"
|
|
2284
|
+
"options": [
|
|
2285
|
+
"BACKQUOTE",
|
|
2286
|
+
"CARET",
|
|
2287
|
+
"COMMA",
|
|
2288
|
+
"PIPE",
|
|
2289
|
+
"SEMICOLON",
|
|
2290
|
+
"TAB"
|
|
2319
2291
|
],
|
|
2320
|
-
"char": "s",
|
|
2321
|
-
"deprecateAliases": true,
|
|
2322
|
-
"name": "sobject",
|
|
2323
|
-
"required": true,
|
|
2324
|
-
"summary": "API name of the Salesforce or Tooling API object that contains the record you're updating.",
|
|
2325
|
-
"hasDynamicHelp": false,
|
|
2326
|
-
"multiple": false,
|
|
2327
2292
|
"type": "option"
|
|
2328
2293
|
},
|
|
2329
|
-
"
|
|
2294
|
+
"external-id": {
|
|
2330
2295
|
"aliases": [
|
|
2331
|
-
"
|
|
2296
|
+
"externalid"
|
|
2332
2297
|
],
|
|
2333
2298
|
"char": "i",
|
|
2334
2299
|
"deprecateAliases": true,
|
|
2335
|
-
"name": "
|
|
2336
|
-
"summary": "ID of the record you’re updating.",
|
|
2337
|
-
"hasDynamicHelp": false,
|
|
2338
|
-
"multiple": false,
|
|
2339
|
-
"type": "option"
|
|
2340
|
-
},
|
|
2341
|
-
"where": {
|
|
2342
|
-
"char": "w",
|
|
2343
|
-
"name": "where",
|
|
2344
|
-
"summary": "List of <fieldName>=<value> pairs that identify the record you want to update.",
|
|
2345
|
-
"hasDynamicHelp": false,
|
|
2346
|
-
"multiple": false,
|
|
2347
|
-
"type": "option"
|
|
2348
|
-
},
|
|
2349
|
-
"values": {
|
|
2350
|
-
"char": "v",
|
|
2351
|
-
"name": "values",
|
|
2300
|
+
"name": "external-id",
|
|
2352
2301
|
"required": true,
|
|
2353
|
-
"summary": "
|
|
2302
|
+
"summary": "Name of the external ID field, or the Id field.",
|
|
2354
2303
|
"hasDynamicHelp": false,
|
|
2355
2304
|
"multiple": false,
|
|
2356
2305
|
"type": "option"
|
|
2357
|
-
},
|
|
2358
|
-
"use-tooling-api": {
|
|
2359
|
-
"aliases": [
|
|
2360
|
-
"usetoolingapi"
|
|
2361
|
-
],
|
|
2362
|
-
"char": "t",
|
|
2363
|
-
"deprecateAliases": true,
|
|
2364
|
-
"name": "use-tooling-api",
|
|
2365
|
-
"summary": "Use Tooling API so you can update a record in a Tooling API object.",
|
|
2366
|
-
"allowNo": false,
|
|
2367
|
-
"type": "boolean"
|
|
2368
|
-
},
|
|
2369
|
-
"perflog": {
|
|
2370
|
-
"deprecated": {
|
|
2371
|
-
"version": "57"
|
|
2372
|
-
},
|
|
2373
|
-
"hidden": true,
|
|
2374
|
-
"name": "perflog",
|
|
2375
|
-
"summary": "Get API performance data.",
|
|
2376
|
-
"allowNo": false,
|
|
2377
|
-
"type": "boolean"
|
|
2378
2306
|
}
|
|
2379
2307
|
},
|
|
2380
2308
|
"hasDynamicHelp": true,
|
|
2381
2309
|
"hiddenAliases": [],
|
|
2382
|
-
"id": "data:
|
|
2310
|
+
"id": "data:upsert:bulk",
|
|
2383
2311
|
"pluginAlias": "@salesforce/plugin-data",
|
|
2384
2312
|
"pluginName": "@salesforce/plugin-data",
|
|
2385
2313
|
"pluginType": "core",
|
|
2386
2314
|
"strict": true,
|
|
2387
|
-
"summary": "
|
|
2315
|
+
"summary": "Bulk upsert records to an org from a CSV file. Uses Bulk API 2.0.",
|
|
2388
2316
|
"enableJsonFlag": true,
|
|
2389
2317
|
"isESM": true,
|
|
2390
2318
|
"relativePath": [
|
|
2391
2319
|
"lib",
|
|
2392
2320
|
"commands",
|
|
2393
2321
|
"data",
|
|
2394
|
-
"
|
|
2395
|
-
"
|
|
2396
|
-
],
|
|
2397
|
-
"aliasPermutations": [
|
|
2398
|
-
"force:data:record:update",
|
|
2399
|
-
"data:force:record:update",
|
|
2400
|
-
"data:record:force:update",
|
|
2401
|
-
"data:record:update:force",
|
|
2402
|
-
"force:record:data:update",
|
|
2403
|
-
"record:force:data:update",
|
|
2404
|
-
"record:data:force:update",
|
|
2405
|
-
"record:data:update:force",
|
|
2406
|
-
"force:record:update:data",
|
|
2407
|
-
"record:force:update:data",
|
|
2408
|
-
"record:update:force:data",
|
|
2409
|
-
"record:update:data:force",
|
|
2410
|
-
"force:data:update:record",
|
|
2411
|
-
"data:force:update:record",
|
|
2412
|
-
"data:update:force:record",
|
|
2413
|
-
"data:update:record:force",
|
|
2414
|
-
"force:update:data:record",
|
|
2415
|
-
"update:force:data:record",
|
|
2416
|
-
"update:data:force:record",
|
|
2417
|
-
"update:data:record:force",
|
|
2418
|
-
"force:update:record:data",
|
|
2419
|
-
"update:force:record:data",
|
|
2420
|
-
"update:record:force:data",
|
|
2421
|
-
"update:record:data:force"
|
|
2322
|
+
"upsert",
|
|
2323
|
+
"bulk.js"
|
|
2422
2324
|
],
|
|
2325
|
+
"aliasPermutations": [],
|
|
2423
2326
|
"permutations": [
|
|
2424
|
-
"data:
|
|
2425
|
-
"
|
|
2426
|
-
"
|
|
2427
|
-
"data:
|
|
2428
|
-
"
|
|
2429
|
-
"
|
|
2327
|
+
"data:upsert:bulk",
|
|
2328
|
+
"upsert:data:bulk",
|
|
2329
|
+
"upsert:bulk:data",
|
|
2330
|
+
"data:bulk:upsert",
|
|
2331
|
+
"bulk:data:upsert",
|
|
2332
|
+
"bulk:upsert:data"
|
|
2430
2333
|
]
|
|
2431
2334
|
},
|
|
2432
|
-
"data:
|
|
2335
|
+
"data:upsert:resume": {
|
|
2433
2336
|
"aliases": [],
|
|
2434
2337
|
"args": {},
|
|
2435
|
-
"description": "
|
|
2338
|
+
"description": "The command uses the job ID returned from the \"<%= config.bin %> data upsert bulk\" command or the most recently-run bulk upsert job.",
|
|
2436
2339
|
"examples": [
|
|
2437
|
-
"Resume a bulk
|
|
2438
|
-
"Resume the most recently run bulk
|
|
2340
|
+
"Resume a bulk upsert job from your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
|
|
2341
|
+
"Resume the most recently run bulk upsert job for an org with alias my-scratch:\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-scratch"
|
|
2439
2342
|
],
|
|
2440
2343
|
"flags": {
|
|
2441
2344
|
"json": {
|
|
@@ -2453,64 +2356,101 @@
|
|
|
2453
2356
|
"multiple": false,
|
|
2454
2357
|
"type": "option"
|
|
2455
2358
|
},
|
|
2456
|
-
"
|
|
2457
|
-
"
|
|
2458
|
-
|
|
2459
|
-
|
|
2460
|
-
|
|
2359
|
+
"target-org": {
|
|
2360
|
+
"aliases": [
|
|
2361
|
+
"targetusername",
|
|
2362
|
+
"u"
|
|
2363
|
+
],
|
|
2364
|
+
"char": "o",
|
|
2365
|
+
"deprecateAliases": true,
|
|
2366
|
+
"name": "target-org",
|
|
2367
|
+
"noCacheDefault": true,
|
|
2368
|
+
"summary": "Username or alias of the target org. Not required if the \"target-org\" configuration variable is already set.",
|
|
2369
|
+
"hasDynamicHelp": true,
|
|
2370
|
+
"multiple": false,
|
|
2371
|
+
"type": "option"
|
|
2461
2372
|
},
|
|
2462
2373
|
"job-id": {
|
|
2374
|
+
"aliases": [
|
|
2375
|
+
"jobid"
|
|
2376
|
+
],
|
|
2463
2377
|
"char": "i",
|
|
2378
|
+
"deprecateAliases": true,
|
|
2464
2379
|
"name": "job-id",
|
|
2465
|
-
"summary": "
|
|
2380
|
+
"summary": "ID of the job you want to resume.",
|
|
2466
2381
|
"hasDynamicHelp": false,
|
|
2467
2382
|
"multiple": false,
|
|
2468
2383
|
"type": "option"
|
|
2469
2384
|
},
|
|
2385
|
+
"use-most-recent": {
|
|
2386
|
+
"exclusive": [
|
|
2387
|
+
"job-id"
|
|
2388
|
+
],
|
|
2389
|
+
"name": "use-most-recent",
|
|
2390
|
+
"summary": "Use the ID of the most recently-run bulk job.",
|
|
2391
|
+
"allowNo": false,
|
|
2392
|
+
"type": "boolean"
|
|
2393
|
+
},
|
|
2470
2394
|
"wait": {
|
|
2471
|
-
"char": "w",
|
|
2472
2395
|
"name": "wait",
|
|
2473
|
-
"summary": "
|
|
2396
|
+
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
2474
2397
|
"default": "5 minutes",
|
|
2475
2398
|
"hasDynamicHelp": true,
|
|
2476
2399
|
"multiple": false,
|
|
2477
2400
|
"type": "option"
|
|
2401
|
+
},
|
|
2402
|
+
"api-version": {
|
|
2403
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2404
|
+
"name": "api-version",
|
|
2405
|
+
"hasDynamicHelp": false,
|
|
2406
|
+
"multiple": false,
|
|
2407
|
+
"type": "option"
|
|
2408
|
+
},
|
|
2409
|
+
"loglevel": {
|
|
2410
|
+
"deprecated": {
|
|
2411
|
+
"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."
|
|
2412
|
+
},
|
|
2413
|
+
"hidden": true,
|
|
2414
|
+
"name": "loglevel",
|
|
2415
|
+
"hasDynamicHelp": false,
|
|
2416
|
+
"multiple": false,
|
|
2417
|
+
"type": "option"
|
|
2478
2418
|
}
|
|
2479
2419
|
},
|
|
2480
2420
|
"hasDynamicHelp": true,
|
|
2481
2421
|
"hiddenAliases": [],
|
|
2482
|
-
"id": "data:
|
|
2422
|
+
"id": "data:upsert:resume",
|
|
2483
2423
|
"pluginAlias": "@salesforce/plugin-data",
|
|
2484
2424
|
"pluginName": "@salesforce/plugin-data",
|
|
2485
2425
|
"pluginType": "core",
|
|
2486
2426
|
"strict": true,
|
|
2487
|
-
"summary": "Resume a bulk
|
|
2427
|
+
"summary": "Resume a bulk upsert job that you previously started. Uses Bulk API 2.0.",
|
|
2488
2428
|
"enableJsonFlag": true,
|
|
2489
2429
|
"isESM": true,
|
|
2490
2430
|
"relativePath": [
|
|
2491
2431
|
"lib",
|
|
2492
2432
|
"commands",
|
|
2493
2433
|
"data",
|
|
2494
|
-
"
|
|
2434
|
+
"upsert",
|
|
2495
2435
|
"resume.js"
|
|
2496
2436
|
],
|
|
2497
2437
|
"aliasPermutations": [],
|
|
2498
2438
|
"permutations": [
|
|
2499
|
-
"data:
|
|
2500
|
-
"
|
|
2501
|
-
"
|
|
2502
|
-
"data:resume:
|
|
2503
|
-
"resume:data:
|
|
2504
|
-
"resume:
|
|
2439
|
+
"data:upsert:resume",
|
|
2440
|
+
"upsert:data:resume",
|
|
2441
|
+
"upsert:resume:data",
|
|
2442
|
+
"data:resume:upsert",
|
|
2443
|
+
"resume:data:upsert",
|
|
2444
|
+
"resume:upsert:data"
|
|
2505
2445
|
]
|
|
2506
2446
|
},
|
|
2507
|
-
"data:
|
|
2447
|
+
"data:import:bulk": {
|
|
2508
2448
|
"aliases": [],
|
|
2509
2449
|
"args": {},
|
|
2510
|
-
"description": "
|
|
2450
|
+
"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).",
|
|
2511
2451
|
"examples": [
|
|
2512
|
-
"
|
|
2513
|
-
"
|
|
2452
|
+
"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",
|
|
2453
|
+
"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"
|
|
2514
2454
|
],
|
|
2515
2455
|
"flags": {
|
|
2516
2456
|
"json": {
|
|
@@ -2528,64 +2468,38 @@
|
|
|
2528
2468
|
"multiple": false,
|
|
2529
2469
|
"type": "option"
|
|
2530
2470
|
},
|
|
2531
|
-
"
|
|
2532
|
-
"
|
|
2533
|
-
|
|
2534
|
-
|
|
2535
|
-
|
|
2536
|
-
"char": "o",
|
|
2537
|
-
"deprecateAliases": true,
|
|
2538
|
-
"name": "target-org",
|
|
2539
|
-
"noCacheDefault": true,
|
|
2540
|
-
"required": true,
|
|
2541
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2542
|
-
"hasDynamicHelp": true,
|
|
2543
|
-
"multiple": false,
|
|
2544
|
-
"type": "option"
|
|
2545
|
-
},
|
|
2546
|
-
"api-version": {
|
|
2547
|
-
"aliases": [
|
|
2548
|
-
"apiversion"
|
|
2471
|
+
"async": {
|
|
2472
|
+
"char": "a",
|
|
2473
|
+
"deprecated": true,
|
|
2474
|
+
"exclusive": [
|
|
2475
|
+
"wait"
|
|
2549
2476
|
],
|
|
2550
|
-
"
|
|
2551
|
-
"
|
|
2552
|
-
"
|
|
2553
|
-
"
|
|
2554
|
-
"multiple": false,
|
|
2555
|
-
"type": "option"
|
|
2556
|
-
},
|
|
2557
|
-
"loglevel": {
|
|
2558
|
-
"deprecated": {
|
|
2559
|
-
"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."
|
|
2560
|
-
},
|
|
2561
|
-
"hidden": true,
|
|
2562
|
-
"name": "loglevel",
|
|
2563
|
-
"hasDynamicHelp": false,
|
|
2564
|
-
"multiple": false,
|
|
2565
|
-
"type": "option"
|
|
2477
|
+
"name": "async",
|
|
2478
|
+
"summary": "Don't wait for the command to complete.",
|
|
2479
|
+
"allowNo": false,
|
|
2480
|
+
"type": "boolean"
|
|
2566
2481
|
},
|
|
2567
2482
|
"file": {
|
|
2568
|
-
"aliases": [
|
|
2569
|
-
"csvfile"
|
|
2570
|
-
],
|
|
2571
2483
|
"char": "f",
|
|
2572
|
-
"deprecateAliases": true,
|
|
2573
2484
|
"name": "file",
|
|
2574
2485
|
"required": true,
|
|
2575
|
-
"summary": "CSV file that contains the
|
|
2486
|
+
"summary": "CSV file that contains the Salesforce object records you want to import.",
|
|
2576
2487
|
"hasDynamicHelp": false,
|
|
2577
2488
|
"multiple": false,
|
|
2578
2489
|
"type": "option"
|
|
2579
2490
|
},
|
|
2580
2491
|
"sobject": {
|
|
2581
|
-
"aliases": [
|
|
2582
|
-
"sobjecttype"
|
|
2583
|
-
],
|
|
2584
2492
|
"char": "s",
|
|
2585
|
-
"deprecateAliases": true,
|
|
2586
2493
|
"name": "sobject",
|
|
2587
2494
|
"required": true,
|
|
2588
|
-
"summary": "API name of the Salesforce object, either standard or custom,
|
|
2495
|
+
"summary": "API name of the Salesforce object, either standard or custom, into which you're importing records.",
|
|
2496
|
+
"hasDynamicHelp": false,
|
|
2497
|
+
"multiple": false,
|
|
2498
|
+
"type": "option"
|
|
2499
|
+
},
|
|
2500
|
+
"api-version": {
|
|
2501
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2502
|
+
"name": "api-version",
|
|
2589
2503
|
"hasDynamicHelp": false,
|
|
2590
2504
|
"multiple": false,
|
|
2591
2505
|
"type": "option"
|
|
@@ -2596,22 +2510,20 @@
|
|
|
2596
2510
|
"async"
|
|
2597
2511
|
],
|
|
2598
2512
|
"name": "wait",
|
|
2599
|
-
"summary": "
|
|
2600
|
-
"default": "0 minutes",
|
|
2513
|
+
"summary": "Time to wait for the command to finish, in minutes.",
|
|
2601
2514
|
"hasDynamicHelp": true,
|
|
2602
2515
|
"multiple": false,
|
|
2603
2516
|
"type": "option"
|
|
2604
2517
|
},
|
|
2605
|
-
"
|
|
2606
|
-
"char": "
|
|
2607
|
-
"
|
|
2608
|
-
"
|
|
2609
|
-
|
|
2610
|
-
|
|
2611
|
-
"
|
|
2612
|
-
"
|
|
2613
|
-
"
|
|
2614
|
-
"type": "boolean"
|
|
2518
|
+
"target-org": {
|
|
2519
|
+
"char": "o",
|
|
2520
|
+
"name": "target-org",
|
|
2521
|
+
"noCacheDefault": true,
|
|
2522
|
+
"required": true,
|
|
2523
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2524
|
+
"hasDynamicHelp": true,
|
|
2525
|
+
"multiple": false,
|
|
2526
|
+
"type": "option"
|
|
2615
2527
|
},
|
|
2616
2528
|
"line-ending": {
|
|
2617
2529
|
"dependsOn": [
|
|
@@ -2641,55 +2553,120 @@
|
|
|
2641
2553
|
"TAB"
|
|
2642
2554
|
],
|
|
2643
2555
|
"type": "option"
|
|
2556
|
+
}
|
|
2557
|
+
},
|
|
2558
|
+
"hasDynamicHelp": true,
|
|
2559
|
+
"hiddenAliases": [],
|
|
2560
|
+
"id": "data:import:bulk",
|
|
2561
|
+
"pluginAlias": "@salesforce/plugin-data",
|
|
2562
|
+
"pluginName": "@salesforce/plugin-data",
|
|
2563
|
+
"pluginType": "core",
|
|
2564
|
+
"strict": true,
|
|
2565
|
+
"summary": "Bulk import records into a Salesforce object from a CSV file. Uses Bulk API 2.0.",
|
|
2566
|
+
"enableJsonFlag": true,
|
|
2567
|
+
"isESM": true,
|
|
2568
|
+
"relativePath": [
|
|
2569
|
+
"lib",
|
|
2570
|
+
"commands",
|
|
2571
|
+
"data",
|
|
2572
|
+
"import",
|
|
2573
|
+
"bulk.js"
|
|
2574
|
+
],
|
|
2575
|
+
"aliasPermutations": [],
|
|
2576
|
+
"permutations": [
|
|
2577
|
+
"data:import:bulk",
|
|
2578
|
+
"import:data:bulk",
|
|
2579
|
+
"import:bulk:data",
|
|
2580
|
+
"data:bulk:import",
|
|
2581
|
+
"bulk:data:import",
|
|
2582
|
+
"bulk:import:data"
|
|
2583
|
+
]
|
|
2584
|
+
},
|
|
2585
|
+
"data:import:resume": {
|
|
2586
|
+
"aliases": [],
|
|
2587
|
+
"args": {},
|
|
2588
|
+
"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.",
|
|
2589
|
+
"examples": [
|
|
2590
|
+
"Resume a bulk import job to your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
|
|
2591
|
+
"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"
|
|
2592
|
+
],
|
|
2593
|
+
"flags": {
|
|
2594
|
+
"json": {
|
|
2595
|
+
"description": "Format output as json.",
|
|
2596
|
+
"helpGroup": "GLOBAL",
|
|
2597
|
+
"name": "json",
|
|
2598
|
+
"allowNo": false,
|
|
2599
|
+
"type": "boolean"
|
|
2600
|
+
},
|
|
2601
|
+
"flags-dir": {
|
|
2602
|
+
"helpGroup": "GLOBAL",
|
|
2603
|
+
"name": "flags-dir",
|
|
2604
|
+
"summary": "Import flag values from a directory.",
|
|
2605
|
+
"hasDynamicHelp": false,
|
|
2606
|
+
"multiple": false,
|
|
2607
|
+
"type": "option"
|
|
2644
2608
|
},
|
|
2645
|
-
"
|
|
2646
|
-
"
|
|
2647
|
-
|
|
2648
|
-
|
|
2609
|
+
"use-most-recent": {
|
|
2610
|
+
"name": "use-most-recent",
|
|
2611
|
+
"summary": "Use the job ID of the bulk import job that was most recently run.",
|
|
2612
|
+
"allowNo": false,
|
|
2613
|
+
"type": "boolean"
|
|
2614
|
+
},
|
|
2615
|
+
"job-id": {
|
|
2649
2616
|
"char": "i",
|
|
2650
|
-
"
|
|
2651
|
-
"
|
|
2652
|
-
"required": true,
|
|
2653
|
-
"summary": "Name of the external ID field, or the Id field.",
|
|
2617
|
+
"name": "job-id",
|
|
2618
|
+
"summary": "Job ID of the bulk import.",
|
|
2654
2619
|
"hasDynamicHelp": false,
|
|
2655
2620
|
"multiple": false,
|
|
2656
2621
|
"type": "option"
|
|
2622
|
+
},
|
|
2623
|
+
"wait": {
|
|
2624
|
+
"char": "w",
|
|
2625
|
+
"name": "wait",
|
|
2626
|
+
"summary": "Time to wait for the command to finish, in minutes.",
|
|
2627
|
+
"default": "5 minutes",
|
|
2628
|
+
"hasDynamicHelp": true,
|
|
2629
|
+
"multiple": false,
|
|
2630
|
+
"type": "option"
|
|
2657
2631
|
}
|
|
2658
2632
|
},
|
|
2659
2633
|
"hasDynamicHelp": true,
|
|
2660
2634
|
"hiddenAliases": [],
|
|
2661
|
-
"id": "data:
|
|
2635
|
+
"id": "data:import:resume",
|
|
2662
2636
|
"pluginAlias": "@salesforce/plugin-data",
|
|
2663
2637
|
"pluginName": "@salesforce/plugin-data",
|
|
2664
2638
|
"pluginType": "core",
|
|
2665
2639
|
"strict": true,
|
|
2666
|
-
"summary": "
|
|
2640
|
+
"summary": "Resume a bulk import job that you previously started. Uses Bulk API 2.0.",
|
|
2667
2641
|
"enableJsonFlag": true,
|
|
2668
2642
|
"isESM": true,
|
|
2669
2643
|
"relativePath": [
|
|
2670
2644
|
"lib",
|
|
2671
2645
|
"commands",
|
|
2672
2646
|
"data",
|
|
2673
|
-
"
|
|
2674
|
-
"
|
|
2647
|
+
"import",
|
|
2648
|
+
"resume.js"
|
|
2675
2649
|
],
|
|
2676
2650
|
"aliasPermutations": [],
|
|
2677
2651
|
"permutations": [
|
|
2678
|
-
"data:
|
|
2679
|
-
"
|
|
2680
|
-
"
|
|
2681
|
-
"data:
|
|
2682
|
-
"
|
|
2683
|
-
"
|
|
2652
|
+
"data:import:resume",
|
|
2653
|
+
"import:data:resume",
|
|
2654
|
+
"import:resume:data",
|
|
2655
|
+
"data:resume:import",
|
|
2656
|
+
"resume:data:import",
|
|
2657
|
+
"resume:import:data"
|
|
2684
2658
|
]
|
|
2685
2659
|
},
|
|
2686
|
-
"data:
|
|
2687
|
-
"aliases": [
|
|
2660
|
+
"data:import:tree": {
|
|
2661
|
+
"aliases": [
|
|
2662
|
+
"force:data:tree:import"
|
|
2663
|
+
],
|
|
2688
2664
|
"args": {},
|
|
2689
|
-
"
|
|
2665
|
+
"deprecateAliases": true,
|
|
2666
|
+
"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.",
|
|
2690
2667
|
"examples": [
|
|
2691
|
-
"
|
|
2692
|
-
"
|
|
2668
|
+
"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",
|
|
2669
|
+
"Import records using a plan definition file into your default org:\n<%= config.bin %> <%= command.id %> --plan Account-Contact-plan.json"
|
|
2693
2670
|
],
|
|
2694
2671
|
"flags": {
|
|
2695
2672
|
"json": {
|
|
@@ -2716,41 +2693,17 @@
|
|
|
2716
2693
|
"deprecateAliases": true,
|
|
2717
2694
|
"name": "target-org",
|
|
2718
2695
|
"noCacheDefault": true,
|
|
2719
|
-
"
|
|
2696
|
+
"required": true,
|
|
2697
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2720
2698
|
"hasDynamicHelp": true,
|
|
2721
2699
|
"multiple": false,
|
|
2722
2700
|
"type": "option"
|
|
2723
2701
|
},
|
|
2724
|
-
"
|
|
2702
|
+
"api-version": {
|
|
2725
2703
|
"aliases": [
|
|
2726
|
-
"
|
|
2704
|
+
"apiversion"
|
|
2727
2705
|
],
|
|
2728
|
-
"char": "i",
|
|
2729
2706
|
"deprecateAliases": true,
|
|
2730
|
-
"name": "job-id",
|
|
2731
|
-
"summary": "ID of the job you want to resume.",
|
|
2732
|
-
"hasDynamicHelp": false,
|
|
2733
|
-
"multiple": false,
|
|
2734
|
-
"type": "option"
|
|
2735
|
-
},
|
|
2736
|
-
"use-most-recent": {
|
|
2737
|
-
"exclusive": [
|
|
2738
|
-
"job-id"
|
|
2739
|
-
],
|
|
2740
|
-
"name": "use-most-recent",
|
|
2741
|
-
"summary": "Use the ID of the most recently-run bulk job.",
|
|
2742
|
-
"allowNo": false,
|
|
2743
|
-
"type": "boolean"
|
|
2744
|
-
},
|
|
2745
|
-
"wait": {
|
|
2746
|
-
"name": "wait",
|
|
2747
|
-
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
2748
|
-
"default": "5 minutes",
|
|
2749
|
-
"hasDynamicHelp": true,
|
|
2750
|
-
"multiple": false,
|
|
2751
|
-
"type": "option"
|
|
2752
|
-
},
|
|
2753
|
-
"api-version": {
|
|
2754
2707
|
"description": "Override the api version used for api requests made by this command",
|
|
2755
2708
|
"name": "api-version",
|
|
2756
2709
|
"hasDynamicHelp": false,
|
|
@@ -2766,33 +2719,80 @@
|
|
|
2766
2719
|
"hasDynamicHelp": false,
|
|
2767
2720
|
"multiple": false,
|
|
2768
2721
|
"type": "option"
|
|
2722
|
+
},
|
|
2723
|
+
"files": {
|
|
2724
|
+
"aliases": [
|
|
2725
|
+
"sobjecttreefiles"
|
|
2726
|
+
],
|
|
2727
|
+
"char": "f",
|
|
2728
|
+
"deprecateAliases": true,
|
|
2729
|
+
"name": "files",
|
|
2730
|
+
"summary": "Comma-separated and in-order JSON files that contain the records, in sObject tree format, that you want to insert.",
|
|
2731
|
+
"delimiter": ",",
|
|
2732
|
+
"hasDynamicHelp": false,
|
|
2733
|
+
"multiple": true,
|
|
2734
|
+
"type": "option"
|
|
2735
|
+
},
|
|
2736
|
+
"plan": {
|
|
2737
|
+
"char": "p",
|
|
2738
|
+
"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",
|
|
2739
|
+
"name": "plan",
|
|
2740
|
+
"summary": "Plan definition file to insert multiple data files.",
|
|
2741
|
+
"hasDynamicHelp": false,
|
|
2742
|
+
"multiple": false,
|
|
2743
|
+
"type": "option"
|
|
2769
2744
|
}
|
|
2770
2745
|
},
|
|
2771
2746
|
"hasDynamicHelp": true,
|
|
2772
2747
|
"hiddenAliases": [],
|
|
2773
|
-
"id": "data:
|
|
2748
|
+
"id": "data:import:tree",
|
|
2774
2749
|
"pluginAlias": "@salesforce/plugin-data",
|
|
2775
2750
|
"pluginName": "@salesforce/plugin-data",
|
|
2776
2751
|
"pluginType": "core",
|
|
2777
2752
|
"strict": true,
|
|
2778
|
-
"summary": "
|
|
2753
|
+
"summary": "Import data from one or more JSON files into an org.",
|
|
2779
2754
|
"enableJsonFlag": true,
|
|
2780
2755
|
"isESM": true,
|
|
2781
2756
|
"relativePath": [
|
|
2782
2757
|
"lib",
|
|
2783
2758
|
"commands",
|
|
2784
2759
|
"data",
|
|
2785
|
-
"
|
|
2786
|
-
"
|
|
2760
|
+
"import",
|
|
2761
|
+
"tree.js"
|
|
2762
|
+
],
|
|
2763
|
+
"aliasPermutations": [
|
|
2764
|
+
"force:data:tree:import",
|
|
2765
|
+
"data:force:tree:import",
|
|
2766
|
+
"data:tree:force:import",
|
|
2767
|
+
"data:tree:import:force",
|
|
2768
|
+
"force:tree:data:import",
|
|
2769
|
+
"tree:force:data:import",
|
|
2770
|
+
"tree:data:force:import",
|
|
2771
|
+
"tree:data:import:force",
|
|
2772
|
+
"force:tree:import:data",
|
|
2773
|
+
"tree:force:import:data",
|
|
2774
|
+
"tree:import:force:data",
|
|
2775
|
+
"tree:import:data:force",
|
|
2776
|
+
"force:data:import:tree",
|
|
2777
|
+
"data:force:import:tree",
|
|
2778
|
+
"data:import:force:tree",
|
|
2779
|
+
"data:import:tree:force",
|
|
2780
|
+
"force:import:data:tree",
|
|
2781
|
+
"import:force:data:tree",
|
|
2782
|
+
"import:data:force:tree",
|
|
2783
|
+
"import:data:tree:force",
|
|
2784
|
+
"force:import:tree:data",
|
|
2785
|
+
"import:force:tree:data",
|
|
2786
|
+
"import:tree:force:data",
|
|
2787
|
+
"import:tree:data:force"
|
|
2787
2788
|
],
|
|
2788
|
-
"aliasPermutations": [],
|
|
2789
2789
|
"permutations": [
|
|
2790
|
-
"data:
|
|
2791
|
-
"
|
|
2792
|
-
"
|
|
2793
|
-
"data:
|
|
2794
|
-
"
|
|
2795
|
-
"
|
|
2790
|
+
"data:import:tree",
|
|
2791
|
+
"import:data:tree",
|
|
2792
|
+
"import:tree:data",
|
|
2793
|
+
"data:tree:import",
|
|
2794
|
+
"tree:data:import",
|
|
2795
|
+
"tree:import:data"
|
|
2796
2796
|
]
|
|
2797
2797
|
},
|
|
2798
2798
|
"force:data:bulk:delete": {
|
|
@@ -3232,5 +3232,5 @@
|
|
|
3232
3232
|
]
|
|
3233
3233
|
}
|
|
3234
3234
|
},
|
|
3235
|
-
"version": "4.0.
|
|
3235
|
+
"version": "4.0.51"
|
|
3236
3236
|
}
|