@salesforce/plugin-data 4.0.30 → 4.0.32
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 +440 -440
- package/package.json +7 -7
package/oclif.manifest.json
CHANGED
|
@@ -401,83 +401,6 @@
|
|
|
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
|
-
},
|
|
481
404
|
"data:create:file": {
|
|
482
405
|
"aliases": [],
|
|
483
406
|
"args": {},
|
|
@@ -735,6 +658,83 @@
|
|
|
735
658
|
"record:create:data"
|
|
736
659
|
]
|
|
737
660
|
},
|
|
661
|
+
"data:bulk:results": {
|
|
662
|
+
"aliases": [],
|
|
663
|
+
"args": {},
|
|
664
|
+
"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.",
|
|
665
|
+
"examples": [
|
|
666
|
+
"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"
|
|
667
|
+
],
|
|
668
|
+
"flags": {
|
|
669
|
+
"json": {
|
|
670
|
+
"description": "Format output as json.",
|
|
671
|
+
"helpGroup": "GLOBAL",
|
|
672
|
+
"name": "json",
|
|
673
|
+
"allowNo": false,
|
|
674
|
+
"type": "boolean"
|
|
675
|
+
},
|
|
676
|
+
"flags-dir": {
|
|
677
|
+
"helpGroup": "GLOBAL",
|
|
678
|
+
"name": "flags-dir",
|
|
679
|
+
"summary": "Import flag values from a directory.",
|
|
680
|
+
"hasDynamicHelp": false,
|
|
681
|
+
"multiple": false,
|
|
682
|
+
"type": "option"
|
|
683
|
+
},
|
|
684
|
+
"job-id": {
|
|
685
|
+
"char": "i",
|
|
686
|
+
"name": "job-id",
|
|
687
|
+
"required": true,
|
|
688
|
+
"summary": "Job ID of the bulk job.",
|
|
689
|
+
"hasDynamicHelp": false,
|
|
690
|
+
"multiple": false,
|
|
691
|
+
"type": "option"
|
|
692
|
+
},
|
|
693
|
+
"target-org": {
|
|
694
|
+
"char": "o",
|
|
695
|
+
"name": "target-org",
|
|
696
|
+
"noCacheDefault": true,
|
|
697
|
+
"required": true,
|
|
698
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
699
|
+
"hasDynamicHelp": true,
|
|
700
|
+
"multiple": false,
|
|
701
|
+
"type": "option"
|
|
702
|
+
},
|
|
703
|
+
"api-version": {
|
|
704
|
+
"description": "Override the api version used for api requests made by this command",
|
|
705
|
+
"name": "api-version",
|
|
706
|
+
"hasDynamicHelp": false,
|
|
707
|
+
"multiple": false,
|
|
708
|
+
"type": "option"
|
|
709
|
+
}
|
|
710
|
+
},
|
|
711
|
+
"hasDynamicHelp": true,
|
|
712
|
+
"hiddenAliases": [],
|
|
713
|
+
"id": "data:bulk:results",
|
|
714
|
+
"pluginAlias": "@salesforce/plugin-data",
|
|
715
|
+
"pluginName": "@salesforce/plugin-data",
|
|
716
|
+
"pluginType": "core",
|
|
717
|
+
"strict": true,
|
|
718
|
+
"summary": "Get the results of a bulk ingest job that you previously ran.",
|
|
719
|
+
"enableJsonFlag": true,
|
|
720
|
+
"isESM": true,
|
|
721
|
+
"relativePath": [
|
|
722
|
+
"lib",
|
|
723
|
+
"commands",
|
|
724
|
+
"data",
|
|
725
|
+
"bulk",
|
|
726
|
+
"results.js"
|
|
727
|
+
],
|
|
728
|
+
"aliasPermutations": [],
|
|
729
|
+
"permutations": [
|
|
730
|
+
"data:bulk:results",
|
|
731
|
+
"bulk:data:results",
|
|
732
|
+
"bulk:results:data",
|
|
733
|
+
"data:results:bulk",
|
|
734
|
+
"results:data:bulk",
|
|
735
|
+
"results:bulk:data"
|
|
736
|
+
]
|
|
737
|
+
},
|
|
738
738
|
"data:delete:bulk": {
|
|
739
739
|
"aliases": [],
|
|
740
740
|
"args": {},
|
|
@@ -1765,13 +1765,13 @@
|
|
|
1765
1765
|
"record:get:data"
|
|
1766
1766
|
]
|
|
1767
1767
|
},
|
|
1768
|
-
"data:
|
|
1768
|
+
"data:import:bulk": {
|
|
1769
1769
|
"aliases": [],
|
|
1770
1770
|
"args": {},
|
|
1771
|
-
"description": "You can use this command to
|
|
1771
|
+
"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).",
|
|
1772
1772
|
"examples": [
|
|
1773
|
-
"
|
|
1774
|
-
"
|
|
1773
|
+
"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",
|
|
1774
|
+
"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"
|
|
1775
1775
|
],
|
|
1776
1776
|
"flags": {
|
|
1777
1777
|
"json": {
|
|
@@ -1792,24 +1792,19 @@
|
|
|
1792
1792
|
"async": {
|
|
1793
1793
|
"char": "a",
|
|
1794
1794
|
"deprecated": true,
|
|
1795
|
+
"exclusive": [
|
|
1796
|
+
"wait"
|
|
1797
|
+
],
|
|
1795
1798
|
"name": "async",
|
|
1796
1799
|
"summary": "Don't wait for the command to complete.",
|
|
1797
1800
|
"allowNo": false,
|
|
1798
1801
|
"type": "boolean"
|
|
1799
1802
|
},
|
|
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
|
-
},
|
|
1808
1803
|
"file": {
|
|
1809
1804
|
"char": "f",
|
|
1810
1805
|
"name": "file",
|
|
1811
1806
|
"required": true,
|
|
1812
|
-
"summary": "CSV file that contains the Salesforce object records you want to
|
|
1807
|
+
"summary": "CSV file that contains the Salesforce object records you want to import.",
|
|
1813
1808
|
"hasDynamicHelp": false,
|
|
1814
1809
|
"multiple": false,
|
|
1815
1810
|
"type": "option"
|
|
@@ -1818,7 +1813,7 @@
|
|
|
1818
1813
|
"char": "s",
|
|
1819
1814
|
"name": "sobject",
|
|
1820
1815
|
"required": true,
|
|
1821
|
-
"summary": "API name of the Salesforce object, either standard or custom, which you
|
|
1816
|
+
"summary": "API name of the Salesforce object, either standard or custom, into which you're importing records.",
|
|
1822
1817
|
"hasDynamicHelp": false,
|
|
1823
1818
|
"multiple": false,
|
|
1824
1819
|
"type": "option"
|
|
@@ -1830,6 +1825,17 @@
|
|
|
1830
1825
|
"multiple": false,
|
|
1831
1826
|
"type": "option"
|
|
1832
1827
|
},
|
|
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
|
+
},
|
|
1833
1839
|
"target-org": {
|
|
1834
1840
|
"char": "o",
|
|
1835
1841
|
"name": "target-org",
|
|
@@ -1872,43 +1878,38 @@
|
|
|
1872
1878
|
},
|
|
1873
1879
|
"hasDynamicHelp": true,
|
|
1874
1880
|
"hiddenAliases": [],
|
|
1875
|
-
"id": "data:
|
|
1881
|
+
"id": "data:import:bulk",
|
|
1876
1882
|
"pluginAlias": "@salesforce/plugin-data",
|
|
1877
1883
|
"pluginName": "@salesforce/plugin-data",
|
|
1878
1884
|
"pluginType": "core",
|
|
1879
1885
|
"strict": true,
|
|
1880
|
-
"summary": "Bulk
|
|
1886
|
+
"summary": "Bulk import records into a Salesforce object from a CSV file. Uses Bulk API 2.0.",
|
|
1881
1887
|
"enableJsonFlag": true,
|
|
1882
1888
|
"isESM": true,
|
|
1883
1889
|
"relativePath": [
|
|
1884
1890
|
"lib",
|
|
1885
1891
|
"commands",
|
|
1886
1892
|
"data",
|
|
1887
|
-
"
|
|
1893
|
+
"import",
|
|
1888
1894
|
"bulk.js"
|
|
1889
1895
|
],
|
|
1890
1896
|
"aliasPermutations": [],
|
|
1891
1897
|
"permutations": [
|
|
1892
|
-
"data:
|
|
1893
|
-
"
|
|
1894
|
-
"
|
|
1895
|
-
"data:bulk:
|
|
1896
|
-
"bulk:data:
|
|
1897
|
-
"bulk:
|
|
1898
|
+
"data:import:bulk",
|
|
1899
|
+
"import:data:bulk",
|
|
1900
|
+
"import:bulk:data",
|
|
1901
|
+
"data:bulk:import",
|
|
1902
|
+
"bulk:data:import",
|
|
1903
|
+
"bulk:import:data"
|
|
1898
1904
|
]
|
|
1899
1905
|
},
|
|
1900
|
-
"data:
|
|
1901
|
-
"aliases": [
|
|
1902
|
-
"force:data:record:update"
|
|
1903
|
-
],
|
|
1906
|
+
"data:import:resume": {
|
|
1907
|
+
"aliases": [],
|
|
1904
1908
|
"args": {},
|
|
1905
|
-
"
|
|
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.",
|
|
1909
|
+
"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.",
|
|
1907
1910
|
"examples": [
|
|
1908
|
-
"
|
|
1909
|
-
"
|
|
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\""
|
|
1911
|
+
"Resume a bulk import job to your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
|
|
1912
|
+
"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"
|
|
1912
1913
|
],
|
|
1913
1914
|
"flags": {
|
|
1914
1915
|
"json": {
|
|
@@ -1926,165 +1927,67 @@
|
|
|
1926
1927
|
"multiple": false,
|
|
1927
1928
|
"type": "option"
|
|
1928
1929
|
},
|
|
1929
|
-
"
|
|
1930
|
-
"
|
|
1931
|
-
|
|
1932
|
-
|
|
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"
|
|
1930
|
+
"use-most-recent": {
|
|
1931
|
+
"name": "use-most-recent",
|
|
1932
|
+
"summary": "Use the job ID of the bulk import job that was most recently run.",
|
|
1933
|
+
"allowNo": false,
|
|
1934
|
+
"type": "boolean"
|
|
1943
1935
|
},
|
|
1944
|
-
"
|
|
1945
|
-
"
|
|
1946
|
-
|
|
1947
|
-
|
|
1948
|
-
"deprecateAliases": true,
|
|
1949
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1950
|
-
"name": "api-version",
|
|
1936
|
+
"job-id": {
|
|
1937
|
+
"char": "i",
|
|
1938
|
+
"name": "job-id",
|
|
1939
|
+
"summary": "Job ID of the bulk import.",
|
|
1951
1940
|
"hasDynamicHelp": false,
|
|
1952
1941
|
"multiple": false,
|
|
1953
1942
|
"type": "option"
|
|
1954
1943
|
},
|
|
1955
|
-
"
|
|
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",
|
|
1961
|
-
"hasDynamicHelp": false,
|
|
1962
|
-
"multiple": false,
|
|
1963
|
-
"type": "option"
|
|
1964
|
-
},
|
|
1965
|
-
"sobject": {
|
|
1966
|
-
"aliases": [
|
|
1967
|
-
"sobjecttype"
|
|
1968
|
-
],
|
|
1969
|
-
"char": "s",
|
|
1970
|
-
"deprecateAliases": true,
|
|
1971
|
-
"name": "sobject",
|
|
1972
|
-
"required": true,
|
|
1973
|
-
"summary": "API name of the Salesforce or Tooling API object that contains the record you're updating.",
|
|
1974
|
-
"hasDynamicHelp": false,
|
|
1975
|
-
"multiple": false,
|
|
1976
|
-
"type": "option"
|
|
1977
|
-
},
|
|
1978
|
-
"record-id": {
|
|
1979
|
-
"aliases": [
|
|
1980
|
-
"sobjectid"
|
|
1981
|
-
],
|
|
1982
|
-
"char": "i",
|
|
1983
|
-
"deprecateAliases": true,
|
|
1984
|
-
"name": "record-id",
|
|
1985
|
-
"summary": "ID of the record you’re updating.",
|
|
1986
|
-
"hasDynamicHelp": false,
|
|
1987
|
-
"multiple": false,
|
|
1988
|
-
"type": "option"
|
|
1989
|
-
},
|
|
1990
|
-
"where": {
|
|
1944
|
+
"wait": {
|
|
1991
1945
|
"char": "w",
|
|
1992
|
-
"name": "
|
|
1993
|
-
"summary": "
|
|
1994
|
-
"
|
|
1995
|
-
"
|
|
1996
|
-
"type": "option"
|
|
1997
|
-
},
|
|
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,
|
|
1946
|
+
"name": "wait",
|
|
1947
|
+
"summary": "Time to wait for the command to finish, in minutes.",
|
|
1948
|
+
"default": "5 minutes",
|
|
1949
|
+
"hasDynamicHelp": true,
|
|
2004
1950
|
"multiple": false,
|
|
2005
1951
|
"type": "option"
|
|
2006
|
-
},
|
|
2007
|
-
"use-tooling-api": {
|
|
2008
|
-
"aliases": [
|
|
2009
|
-
"usetoolingapi"
|
|
2010
|
-
],
|
|
2011
|
-
"char": "t",
|
|
2012
|
-
"deprecateAliases": true,
|
|
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"
|
|
2017
|
-
},
|
|
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"
|
|
2027
1952
|
}
|
|
2028
1953
|
},
|
|
2029
1954
|
"hasDynamicHelp": true,
|
|
2030
1955
|
"hiddenAliases": [],
|
|
2031
|
-
"id": "data:
|
|
1956
|
+
"id": "data:import:resume",
|
|
2032
1957
|
"pluginAlias": "@salesforce/plugin-data",
|
|
2033
1958
|
"pluginName": "@salesforce/plugin-data",
|
|
2034
1959
|
"pluginType": "core",
|
|
2035
1960
|
"strict": true,
|
|
2036
|
-
"summary": "
|
|
1961
|
+
"summary": "Resume a bulk import job that you previously started. Uses Bulk API 2.0.",
|
|
2037
1962
|
"enableJsonFlag": true,
|
|
2038
1963
|
"isESM": true,
|
|
2039
1964
|
"relativePath": [
|
|
2040
1965
|
"lib",
|
|
2041
1966
|
"commands",
|
|
2042
1967
|
"data",
|
|
2043
|
-
"
|
|
2044
|
-
"
|
|
2045
|
-
],
|
|
2046
|
-
"aliasPermutations": [
|
|
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"
|
|
1968
|
+
"import",
|
|
1969
|
+
"resume.js"
|
|
2071
1970
|
],
|
|
1971
|
+
"aliasPermutations": [],
|
|
2072
1972
|
"permutations": [
|
|
2073
|
-
"data:
|
|
2074
|
-
"
|
|
2075
|
-
"
|
|
2076
|
-
"data:
|
|
2077
|
-
"
|
|
2078
|
-
"
|
|
1973
|
+
"data:import:resume",
|
|
1974
|
+
"import:data:resume",
|
|
1975
|
+
"import:resume:data",
|
|
1976
|
+
"data:resume:import",
|
|
1977
|
+
"resume:data:import",
|
|
1978
|
+
"resume:import:data"
|
|
2079
1979
|
]
|
|
2080
1980
|
},
|
|
2081
|
-
"data:
|
|
2082
|
-
"aliases": [
|
|
1981
|
+
"data:import:tree": {
|
|
1982
|
+
"aliases": [
|
|
1983
|
+
"force:data:tree:import"
|
|
1984
|
+
],
|
|
2083
1985
|
"args": {},
|
|
2084
|
-
"
|
|
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.",
|
|
2085
1988
|
"examples": [
|
|
2086
|
-
"
|
|
2087
|
-
"
|
|
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"
|
|
2088
1991
|
],
|
|
2089
1992
|
"flags": {
|
|
2090
1993
|
"json": {
|
|
@@ -2102,64 +2005,124 @@
|
|
|
2102
2005
|
"multiple": false,
|
|
2103
2006
|
"type": "option"
|
|
2104
2007
|
},
|
|
2105
|
-
"
|
|
2106
|
-
"
|
|
2107
|
-
|
|
2108
|
-
|
|
2109
|
-
|
|
2008
|
+
"target-org": {
|
|
2009
|
+
"aliases": [
|
|
2010
|
+
"targetusername",
|
|
2011
|
+
"u"
|
|
2012
|
+
],
|
|
2013
|
+
"char": "o",
|
|
2014
|
+
"deprecateAliases": true,
|
|
2015
|
+
"name": "target-org",
|
|
2016
|
+
"noCacheDefault": true,
|
|
2017
|
+
"required": true,
|
|
2018
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2019
|
+
"hasDynamicHelp": true,
|
|
2020
|
+
"multiple": false,
|
|
2021
|
+
"type": "option"
|
|
2110
2022
|
},
|
|
2111
|
-
"
|
|
2112
|
-
"
|
|
2113
|
-
|
|
2114
|
-
|
|
2023
|
+
"api-version": {
|
|
2024
|
+
"aliases": [
|
|
2025
|
+
"apiversion"
|
|
2026
|
+
],
|
|
2027
|
+
"deprecateAliases": true,
|
|
2028
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2029
|
+
"name": "api-version",
|
|
2115
2030
|
"hasDynamicHelp": false,
|
|
2116
2031
|
"multiple": false,
|
|
2117
2032
|
"type": "option"
|
|
2118
2033
|
},
|
|
2119
|
-
"
|
|
2120
|
-
"
|
|
2121
|
-
|
|
2122
|
-
|
|
2123
|
-
"
|
|
2124
|
-
"
|
|
2034
|
+
"loglevel": {
|
|
2035
|
+
"deprecated": {
|
|
2036
|
+
"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."
|
|
2037
|
+
},
|
|
2038
|
+
"hidden": true,
|
|
2039
|
+
"name": "loglevel",
|
|
2040
|
+
"hasDynamicHelp": false,
|
|
2041
|
+
"multiple": false,
|
|
2042
|
+
"type": "option"
|
|
2043
|
+
},
|
|
2044
|
+
"files": {
|
|
2045
|
+
"aliases": [
|
|
2046
|
+
"sobjecttreefiles"
|
|
2047
|
+
],
|
|
2048
|
+
"char": "f",
|
|
2049
|
+
"deprecateAliases": true,
|
|
2050
|
+
"name": "files",
|
|
2051
|
+
"summary": "Comma-separated and in-order JSON files that contain the records, in sObject tree format, that you want to insert.",
|
|
2052
|
+
"delimiter": ",",
|
|
2053
|
+
"hasDynamicHelp": false,
|
|
2054
|
+
"multiple": true,
|
|
2055
|
+
"type": "option"
|
|
2056
|
+
},
|
|
2057
|
+
"plan": {
|
|
2058
|
+
"char": "p",
|
|
2059
|
+
"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",
|
|
2060
|
+
"name": "plan",
|
|
2061
|
+
"summary": "Plan definition file to insert multiple data files.",
|
|
2062
|
+
"hasDynamicHelp": false,
|
|
2125
2063
|
"multiple": false,
|
|
2126
2064
|
"type": "option"
|
|
2127
2065
|
}
|
|
2128
2066
|
},
|
|
2129
2067
|
"hasDynamicHelp": true,
|
|
2130
2068
|
"hiddenAliases": [],
|
|
2131
|
-
"id": "data:
|
|
2069
|
+
"id": "data:import:tree",
|
|
2132
2070
|
"pluginAlias": "@salesforce/plugin-data",
|
|
2133
2071
|
"pluginName": "@salesforce/plugin-data",
|
|
2134
2072
|
"pluginType": "core",
|
|
2135
2073
|
"strict": true,
|
|
2136
|
-
"summary": "
|
|
2074
|
+
"summary": "Import data from one or more JSON files into an org.",
|
|
2137
2075
|
"enableJsonFlag": true,
|
|
2138
2076
|
"isESM": true,
|
|
2139
2077
|
"relativePath": [
|
|
2140
2078
|
"lib",
|
|
2141
2079
|
"commands",
|
|
2142
2080
|
"data",
|
|
2143
|
-
"
|
|
2144
|
-
"
|
|
2081
|
+
"import",
|
|
2082
|
+
"tree.js"
|
|
2083
|
+
],
|
|
2084
|
+
"aliasPermutations": [
|
|
2085
|
+
"force:data:tree:import",
|
|
2086
|
+
"data:force:tree:import",
|
|
2087
|
+
"data:tree:force:import",
|
|
2088
|
+
"data:tree:import:force",
|
|
2089
|
+
"force:tree:data:import",
|
|
2090
|
+
"tree:force:data:import",
|
|
2091
|
+
"tree:data:force:import",
|
|
2092
|
+
"tree:data:import:force",
|
|
2093
|
+
"force:tree:import:data",
|
|
2094
|
+
"tree:force:import:data",
|
|
2095
|
+
"tree:import:force:data",
|
|
2096
|
+
"tree:import:data:force",
|
|
2097
|
+
"force:data:import:tree",
|
|
2098
|
+
"data:force:import:tree",
|
|
2099
|
+
"data:import:force:tree",
|
|
2100
|
+
"data:import:tree:force",
|
|
2101
|
+
"force:import:data:tree",
|
|
2102
|
+
"import:force:data:tree",
|
|
2103
|
+
"import:data:force:tree",
|
|
2104
|
+
"import:data:tree:force",
|
|
2105
|
+
"force:import:tree:data",
|
|
2106
|
+
"import:force:tree:data",
|
|
2107
|
+
"import:tree:force:data",
|
|
2108
|
+
"import:tree:data:force"
|
|
2145
2109
|
],
|
|
2146
|
-
"aliasPermutations": [],
|
|
2147
2110
|
"permutations": [
|
|
2148
|
-
"data:
|
|
2149
|
-
"
|
|
2150
|
-
"
|
|
2151
|
-
"data:
|
|
2152
|
-
"
|
|
2153
|
-
"
|
|
2111
|
+
"data:import:tree",
|
|
2112
|
+
"import:data:tree",
|
|
2113
|
+
"import:tree:data",
|
|
2114
|
+
"data:tree:import",
|
|
2115
|
+
"tree:data:import",
|
|
2116
|
+
"tree:import:data"
|
|
2154
2117
|
]
|
|
2155
2118
|
},
|
|
2156
|
-
"data:
|
|
2119
|
+
"data:update:bulk": {
|
|
2157
2120
|
"aliases": [],
|
|
2158
2121
|
"args": {},
|
|
2159
|
-
"description": "You can use this command to
|
|
2122
|
+
"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).",
|
|
2160
2123
|
"examples": [
|
|
2161
|
-
"
|
|
2162
|
-
"
|
|
2124
|
+
"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",
|
|
2125
|
+
"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"
|
|
2163
2126
|
],
|
|
2164
2127
|
"flags": {
|
|
2165
2128
|
"json": {
|
|
@@ -2180,19 +2143,24 @@
|
|
|
2180
2143
|
"async": {
|
|
2181
2144
|
"char": "a",
|
|
2182
2145
|
"deprecated": true,
|
|
2183
|
-
"exclusive": [
|
|
2184
|
-
"wait"
|
|
2185
|
-
],
|
|
2186
2146
|
"name": "async",
|
|
2187
2147
|
"summary": "Don't wait for the command to complete.",
|
|
2188
2148
|
"allowNo": false,
|
|
2189
2149
|
"type": "boolean"
|
|
2190
2150
|
},
|
|
2151
|
+
"wait": {
|
|
2152
|
+
"char": "w",
|
|
2153
|
+
"name": "wait",
|
|
2154
|
+
"summary": "Time to wait for the command to finish, in minutes.",
|
|
2155
|
+
"hasDynamicHelp": true,
|
|
2156
|
+
"multiple": false,
|
|
2157
|
+
"type": "option"
|
|
2158
|
+
},
|
|
2191
2159
|
"file": {
|
|
2192
2160
|
"char": "f",
|
|
2193
2161
|
"name": "file",
|
|
2194
2162
|
"required": true,
|
|
2195
|
-
"summary": "CSV file that contains the Salesforce object records you want to
|
|
2163
|
+
"summary": "CSV file that contains the Salesforce object records you want to update.",
|
|
2196
2164
|
"hasDynamicHelp": false,
|
|
2197
2165
|
"multiple": false,
|
|
2198
2166
|
"type": "option"
|
|
@@ -2201,7 +2169,7 @@
|
|
|
2201
2169
|
"char": "s",
|
|
2202
2170
|
"name": "sobject",
|
|
2203
2171
|
"required": true,
|
|
2204
|
-
"summary": "API name of the Salesforce object, either standard or custom,
|
|
2172
|
+
"summary": "API name of the Salesforce object, either standard or custom, which you are updating.",
|
|
2205
2173
|
"hasDynamicHelp": false,
|
|
2206
2174
|
"multiple": false,
|
|
2207
2175
|
"type": "option"
|
|
@@ -2213,17 +2181,6 @@
|
|
|
2213
2181
|
"multiple": false,
|
|
2214
2182
|
"type": "option"
|
|
2215
2183
|
},
|
|
2216
|
-
"wait": {
|
|
2217
|
-
"char": "w",
|
|
2218
|
-
"exclusive": [
|
|
2219
|
-
"async"
|
|
2220
|
-
],
|
|
2221
|
-
"name": "wait",
|
|
2222
|
-
"summary": "Time to wait for the command to finish, in minutes.",
|
|
2223
|
-
"hasDynamicHelp": true,
|
|
2224
|
-
"multiple": false,
|
|
2225
|
-
"type": "option"
|
|
2226
|
-
},
|
|
2227
2184
|
"target-org": {
|
|
2228
2185
|
"char": "o",
|
|
2229
2186
|
"name": "target-org",
|
|
@@ -2244,138 +2201,65 @@
|
|
|
2244
2201
|
"multiple": false,
|
|
2245
2202
|
"options": [
|
|
2246
2203
|
"CRLF",
|
|
2247
|
-
"LF"
|
|
2248
|
-
],
|
|
2249
|
-
"type": "option"
|
|
2250
|
-
},
|
|
2251
|
-
"column-delimiter": {
|
|
2252
|
-
"name": "column-delimiter",
|
|
2253
|
-
"summary": "Column delimiter used in the CSV file.",
|
|
2254
|
-
"hasDynamicHelp": false,
|
|
2255
|
-
"multiple": false,
|
|
2256
|
-
"options": [
|
|
2257
|
-
"BACKQUOTE",
|
|
2258
|
-
"CARET",
|
|
2259
|
-
"COMMA",
|
|
2260
|
-
"PIPE",
|
|
2261
|
-
"SEMICOLON",
|
|
2262
|
-
"TAB"
|
|
2263
|
-
],
|
|
2264
|
-
"type": "option"
|
|
2265
|
-
}
|
|
2266
|
-
},
|
|
2267
|
-
"hasDynamicHelp": true,
|
|
2268
|
-
"hiddenAliases": [],
|
|
2269
|
-
"id": "data:import:bulk",
|
|
2270
|
-
"pluginAlias": "@salesforce/plugin-data",
|
|
2271
|
-
"pluginName": "@salesforce/plugin-data",
|
|
2272
|
-
"pluginType": "core",
|
|
2273
|
-
"strict": true,
|
|
2274
|
-
"summary": "Bulk import records into a Salesforce object from a CSV file. Uses Bulk API 2.0.",
|
|
2275
|
-
"enableJsonFlag": true,
|
|
2276
|
-
"isESM": true,
|
|
2277
|
-
"relativePath": [
|
|
2278
|
-
"lib",
|
|
2279
|
-
"commands",
|
|
2280
|
-
"data",
|
|
2281
|
-
"import",
|
|
2282
|
-
"bulk.js"
|
|
2283
|
-
],
|
|
2284
|
-
"aliasPermutations": [],
|
|
2285
|
-
"permutations": [
|
|
2286
|
-
"data:import:bulk",
|
|
2287
|
-
"import:data:bulk",
|
|
2288
|
-
"import:bulk:data",
|
|
2289
|
-
"data:bulk:import",
|
|
2290
|
-
"bulk:data:import",
|
|
2291
|
-
"bulk:import:data"
|
|
2292
|
-
]
|
|
2293
|
-
},
|
|
2294
|
-
"data:import:resume": {
|
|
2295
|
-
"aliases": [],
|
|
2296
|
-
"args": {},
|
|
2297
|
-
"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.",
|
|
2298
|
-
"examples": [
|
|
2299
|
-
"Resume a bulk import job to your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
|
|
2300
|
-
"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"
|
|
2301
|
-
],
|
|
2302
|
-
"flags": {
|
|
2303
|
-
"json": {
|
|
2304
|
-
"description": "Format output as json.",
|
|
2305
|
-
"helpGroup": "GLOBAL",
|
|
2306
|
-
"name": "json",
|
|
2307
|
-
"allowNo": false,
|
|
2308
|
-
"type": "boolean"
|
|
2309
|
-
},
|
|
2310
|
-
"flags-dir": {
|
|
2311
|
-
"helpGroup": "GLOBAL",
|
|
2312
|
-
"name": "flags-dir",
|
|
2313
|
-
"summary": "Import flag values from a directory.",
|
|
2314
|
-
"hasDynamicHelp": false,
|
|
2315
|
-
"multiple": false,
|
|
2316
|
-
"type": "option"
|
|
2317
|
-
},
|
|
2318
|
-
"use-most-recent": {
|
|
2319
|
-
"name": "use-most-recent",
|
|
2320
|
-
"summary": "Use the job ID of the bulk import job that was most recently run.",
|
|
2321
|
-
"allowNo": false,
|
|
2322
|
-
"type": "boolean"
|
|
2323
|
-
},
|
|
2324
|
-
"job-id": {
|
|
2325
|
-
"char": "i",
|
|
2326
|
-
"name": "job-id",
|
|
2327
|
-
"summary": "Job ID of the bulk import.",
|
|
2328
|
-
"hasDynamicHelp": false,
|
|
2329
|
-
"multiple": false,
|
|
2330
|
-
"type": "option"
|
|
2331
|
-
},
|
|
2332
|
-
"wait": {
|
|
2333
|
-
"char": "w",
|
|
2334
|
-
"name": "wait",
|
|
2335
|
-
"summary": "Time to wait for the command to finish, in minutes.",
|
|
2336
|
-
"default": "5 minutes",
|
|
2337
|
-
"hasDynamicHelp": true,
|
|
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,
|
|
2338
2212
|
"multiple": false,
|
|
2213
|
+
"options": [
|
|
2214
|
+
"BACKQUOTE",
|
|
2215
|
+
"CARET",
|
|
2216
|
+
"COMMA",
|
|
2217
|
+
"PIPE",
|
|
2218
|
+
"SEMICOLON",
|
|
2219
|
+
"TAB"
|
|
2220
|
+
],
|
|
2339
2221
|
"type": "option"
|
|
2340
2222
|
}
|
|
2341
2223
|
},
|
|
2342
2224
|
"hasDynamicHelp": true,
|
|
2343
2225
|
"hiddenAliases": [],
|
|
2344
|
-
"id": "data:
|
|
2226
|
+
"id": "data:update:bulk",
|
|
2345
2227
|
"pluginAlias": "@salesforce/plugin-data",
|
|
2346
2228
|
"pluginName": "@salesforce/plugin-data",
|
|
2347
2229
|
"pluginType": "core",
|
|
2348
2230
|
"strict": true,
|
|
2349
|
-
"summary": "
|
|
2231
|
+
"summary": "Bulk update records to an org from a CSV file. Uses Bulk API 2.0.",
|
|
2350
2232
|
"enableJsonFlag": true,
|
|
2351
2233
|
"isESM": true,
|
|
2352
2234
|
"relativePath": [
|
|
2353
2235
|
"lib",
|
|
2354
2236
|
"commands",
|
|
2355
2237
|
"data",
|
|
2356
|
-
"
|
|
2357
|
-
"
|
|
2238
|
+
"update",
|
|
2239
|
+
"bulk.js"
|
|
2358
2240
|
],
|
|
2359
2241
|
"aliasPermutations": [],
|
|
2360
2242
|
"permutations": [
|
|
2361
|
-
"data:
|
|
2362
|
-
"
|
|
2363
|
-
"
|
|
2364
|
-
"data:
|
|
2365
|
-
"
|
|
2366
|
-
"
|
|
2243
|
+
"data:update:bulk",
|
|
2244
|
+
"update:data:bulk",
|
|
2245
|
+
"update:bulk:data",
|
|
2246
|
+
"data:bulk:update",
|
|
2247
|
+
"bulk:data:update",
|
|
2248
|
+
"bulk:update:data"
|
|
2367
2249
|
]
|
|
2368
2250
|
},
|
|
2369
|
-
"data:
|
|
2251
|
+
"data:update:record": {
|
|
2370
2252
|
"aliases": [
|
|
2371
|
-
"force:data:
|
|
2253
|
+
"force:data:record:update"
|
|
2372
2254
|
],
|
|
2373
2255
|
"args": {},
|
|
2374
2256
|
"deprecateAliases": true,
|
|
2375
|
-
"description": "
|
|
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.",
|
|
2376
2258
|
"examples": [
|
|
2377
|
-
"
|
|
2378
|
-
"
|
|
2259
|
+
"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\"",
|
|
2260
|
+
"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'\"",
|
|
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\""
|
|
2379
2263
|
],
|
|
2380
2264
|
"flags": {
|
|
2381
2265
|
"json": {
|
|
@@ -2429,79 +2313,195 @@
|
|
|
2429
2313
|
"multiple": false,
|
|
2430
2314
|
"type": "option"
|
|
2431
2315
|
},
|
|
2432
|
-
"
|
|
2316
|
+
"sobject": {
|
|
2433
2317
|
"aliases": [
|
|
2434
|
-
"
|
|
2318
|
+
"sobjecttype"
|
|
2435
2319
|
],
|
|
2436
|
-
"char": "
|
|
2320
|
+
"char": "s",
|
|
2437
2321
|
"deprecateAliases": true,
|
|
2438
|
-
"name": "
|
|
2439
|
-
"
|
|
2440
|
-
"
|
|
2322
|
+
"name": "sobject",
|
|
2323
|
+
"required": true,
|
|
2324
|
+
"summary": "API name of the Salesforce or Tooling API object that contains the record you're updating.",
|
|
2441
2325
|
"hasDynamicHelp": false,
|
|
2442
|
-
"multiple":
|
|
2326
|
+
"multiple": false,
|
|
2443
2327
|
"type": "option"
|
|
2444
2328
|
},
|
|
2445
|
-
"
|
|
2446
|
-
"
|
|
2447
|
-
|
|
2448
|
-
|
|
2449
|
-
"
|
|
2329
|
+
"record-id": {
|
|
2330
|
+
"aliases": [
|
|
2331
|
+
"sobjectid"
|
|
2332
|
+
],
|
|
2333
|
+
"char": "i",
|
|
2334
|
+
"deprecateAliases": true,
|
|
2335
|
+
"name": "record-id",
|
|
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",
|
|
2352
|
+
"required": true,
|
|
2353
|
+
"summary": "Fields that you're updating, in the format of <fieldName>=<value> pairs.",
|
|
2450
2354
|
"hasDynamicHelp": false,
|
|
2451
2355
|
"multiple": false,
|
|
2452
2356
|
"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"
|
|
2453
2378
|
}
|
|
2454
2379
|
},
|
|
2455
2380
|
"hasDynamicHelp": true,
|
|
2456
2381
|
"hiddenAliases": [],
|
|
2457
|
-
"id": "data:
|
|
2382
|
+
"id": "data:update:record",
|
|
2458
2383
|
"pluginAlias": "@salesforce/plugin-data",
|
|
2459
2384
|
"pluginName": "@salesforce/plugin-data",
|
|
2460
2385
|
"pluginType": "core",
|
|
2461
2386
|
"strict": true,
|
|
2462
|
-
"summary": "
|
|
2387
|
+
"summary": "Updates a single record of a Salesforce or Tooling API object.",
|
|
2463
2388
|
"enableJsonFlag": true,
|
|
2464
2389
|
"isESM": true,
|
|
2465
2390
|
"relativePath": [
|
|
2466
2391
|
"lib",
|
|
2467
2392
|
"commands",
|
|
2468
2393
|
"data",
|
|
2469
|
-
"
|
|
2470
|
-
"
|
|
2394
|
+
"update",
|
|
2395
|
+
"record.js"
|
|
2471
2396
|
],
|
|
2472
2397
|
"aliasPermutations": [
|
|
2473
|
-
"force:data:
|
|
2474
|
-
"data:force:
|
|
2475
|
-
"data:
|
|
2476
|
-
"data:
|
|
2477
|
-
"force:
|
|
2478
|
-
"
|
|
2479
|
-
"
|
|
2480
|
-
"
|
|
2481
|
-
"force:
|
|
2482
|
-
"
|
|
2483
|
-
"
|
|
2484
|
-
"
|
|
2485
|
-
"force:data:
|
|
2486
|
-
"data:force:
|
|
2487
|
-
"data:
|
|
2488
|
-
"data:
|
|
2489
|
-
"force:
|
|
2490
|
-
"
|
|
2491
|
-
"
|
|
2492
|
-
"
|
|
2493
|
-
"force:
|
|
2494
|
-
"
|
|
2495
|
-
"
|
|
2496
|
-
"
|
|
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"
|
|
2497
2422
|
],
|
|
2498
2423
|
"permutations": [
|
|
2499
|
-
"data:
|
|
2500
|
-
"
|
|
2501
|
-
"
|
|
2502
|
-
"data:
|
|
2503
|
-
"
|
|
2504
|
-
"
|
|
2424
|
+
"data:update:record",
|
|
2425
|
+
"update:data:record",
|
|
2426
|
+
"update:record:data",
|
|
2427
|
+
"data:record:update",
|
|
2428
|
+
"record:data:update",
|
|
2429
|
+
"record:update:data"
|
|
2430
|
+
]
|
|
2431
|
+
},
|
|
2432
|
+
"data:update:resume": {
|
|
2433
|
+
"aliases": [],
|
|
2434
|
+
"args": {},
|
|
2435
|
+
"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.",
|
|
2436
|
+
"examples": [
|
|
2437
|
+
"Resume a bulk update job of your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
|
|
2438
|
+
"Resume the most recently run bulk update job for an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-scratch"
|
|
2439
|
+
],
|
|
2440
|
+
"flags": {
|
|
2441
|
+
"json": {
|
|
2442
|
+
"description": "Format output as json.",
|
|
2443
|
+
"helpGroup": "GLOBAL",
|
|
2444
|
+
"name": "json",
|
|
2445
|
+
"allowNo": false,
|
|
2446
|
+
"type": "boolean"
|
|
2447
|
+
},
|
|
2448
|
+
"flags-dir": {
|
|
2449
|
+
"helpGroup": "GLOBAL",
|
|
2450
|
+
"name": "flags-dir",
|
|
2451
|
+
"summary": "Import flag values from a directory.",
|
|
2452
|
+
"hasDynamicHelp": false,
|
|
2453
|
+
"multiple": false,
|
|
2454
|
+
"type": "option"
|
|
2455
|
+
},
|
|
2456
|
+
"use-most-recent": {
|
|
2457
|
+
"name": "use-most-recent",
|
|
2458
|
+
"summary": "Use the job ID of the bulk update job that was most recently run.",
|
|
2459
|
+
"allowNo": false,
|
|
2460
|
+
"type": "boolean"
|
|
2461
|
+
},
|
|
2462
|
+
"job-id": {
|
|
2463
|
+
"char": "i",
|
|
2464
|
+
"name": "job-id",
|
|
2465
|
+
"summary": "Job ID of the bulk update.",
|
|
2466
|
+
"hasDynamicHelp": false,
|
|
2467
|
+
"multiple": false,
|
|
2468
|
+
"type": "option"
|
|
2469
|
+
},
|
|
2470
|
+
"wait": {
|
|
2471
|
+
"char": "w",
|
|
2472
|
+
"name": "wait",
|
|
2473
|
+
"summary": "Time to wait for the command to finish, in minutes.",
|
|
2474
|
+
"default": "5 minutes",
|
|
2475
|
+
"hasDynamicHelp": true,
|
|
2476
|
+
"multiple": false,
|
|
2477
|
+
"type": "option"
|
|
2478
|
+
}
|
|
2479
|
+
},
|
|
2480
|
+
"hasDynamicHelp": true,
|
|
2481
|
+
"hiddenAliases": [],
|
|
2482
|
+
"id": "data:update:resume",
|
|
2483
|
+
"pluginAlias": "@salesforce/plugin-data",
|
|
2484
|
+
"pluginName": "@salesforce/plugin-data",
|
|
2485
|
+
"pluginType": "core",
|
|
2486
|
+
"strict": true,
|
|
2487
|
+
"summary": "Resume a bulk update job that you previously started. Uses Bulk API 2.0.",
|
|
2488
|
+
"enableJsonFlag": true,
|
|
2489
|
+
"isESM": true,
|
|
2490
|
+
"relativePath": [
|
|
2491
|
+
"lib",
|
|
2492
|
+
"commands",
|
|
2493
|
+
"data",
|
|
2494
|
+
"update",
|
|
2495
|
+
"resume.js"
|
|
2496
|
+
],
|
|
2497
|
+
"aliasPermutations": [],
|
|
2498
|
+
"permutations": [
|
|
2499
|
+
"data:update:resume",
|
|
2500
|
+
"update:data:resume",
|
|
2501
|
+
"update:resume:data",
|
|
2502
|
+
"data:resume:update",
|
|
2503
|
+
"resume:data:update",
|
|
2504
|
+
"resume:update:data"
|
|
2505
2505
|
]
|
|
2506
2506
|
},
|
|
2507
2507
|
"data:upsert:bulk": {
|
|
@@ -3232,5 +3232,5 @@
|
|
|
3232
3232
|
]
|
|
3233
3233
|
}
|
|
3234
3234
|
},
|
|
3235
|
-
"version": "4.0.
|
|
3235
|
+
"version": "4.0.32"
|
|
3236
3236
|
}
|