@salesforce/plugin-data 4.0.16 → 4.0.17
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 +25 -25
- package/oclif.manifest.json +500 -500
- package/package.json +13 -13
package/oclif.manifest.json
CHANGED
|
@@ -1639,13 +1639,18 @@
|
|
|
1639
1639
|
"tree:export:data"
|
|
1640
1640
|
]
|
|
1641
1641
|
},
|
|
1642
|
-
"data:
|
|
1643
|
-
"aliases": [
|
|
1642
|
+
"data:get:record": {
|
|
1643
|
+
"aliases": [
|
|
1644
|
+
"force:data:record:get"
|
|
1645
|
+
],
|
|
1644
1646
|
"args": {},
|
|
1645
|
-
"
|
|
1647
|
+
"deprecateAliases": true,
|
|
1648
|
+
"description": "Specify the record you want to retrieve with either its ID or with a list of field-value pairs that identify the record. If your list of fields identifies more than one record, the command fails; the error displays how many records were found.\n\nWhen specifying field-value pairs, use the format <fieldName>=<value>. Enclose all field-value pairs in one set of double quotation marks, delimited by spaces. Enclose values that contain spaces in single quotes.\n\nThe command displays all the record's fields and their values, one field per terminal line. Fields with no values are displayed as \"null\".\n\nThis command retrieves a record from Salesforce objects by default. Use the --use-tooling-api flag to retrieve from a Tooling API object.",
|
|
1646
1649
|
"examples": [
|
|
1647
|
-
"
|
|
1648
|
-
"
|
|
1650
|
+
"Retrieve and display a record from Account with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX",
|
|
1651
|
+
"Retrieve a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name=Acme\"",
|
|
1652
|
+
"Retrieve a record from Account identified with two field values, one that contains a space; the command uses the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name='Universal Containers' Phone='(123) 456-7890'\" --target-org myscratch",
|
|
1653
|
+
"Retrieve a record from the Tooling API object TraceFlag with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --use-tooling-api --sobject TraceFlag --record-id 7tf8c"
|
|
1649
1654
|
],
|
|
1650
1655
|
"flags": {
|
|
1651
1656
|
"json": {
|
|
@@ -1663,126 +1668,162 @@
|
|
|
1663
1668
|
"multiple": false,
|
|
1664
1669
|
"type": "option"
|
|
1665
1670
|
},
|
|
1666
|
-
"
|
|
1667
|
-
"
|
|
1668
|
-
|
|
1669
|
-
"
|
|
1671
|
+
"target-org": {
|
|
1672
|
+
"aliases": [
|
|
1673
|
+
"targetusername",
|
|
1674
|
+
"u"
|
|
1670
1675
|
],
|
|
1671
|
-
"
|
|
1672
|
-
"
|
|
1673
|
-
"
|
|
1674
|
-
"
|
|
1675
|
-
},
|
|
1676
|
-
"file": {
|
|
1677
|
-
"char": "f",
|
|
1678
|
-
"name": "file",
|
|
1679
|
-
"required": true,
|
|
1680
|
-
"summary": "CSV file that contains the Salesforce object records you want to import.",
|
|
1681
|
-
"hasDynamicHelp": false,
|
|
1682
|
-
"multiple": false,
|
|
1683
|
-
"type": "option"
|
|
1684
|
-
},
|
|
1685
|
-
"sobject": {
|
|
1686
|
-
"char": "s",
|
|
1687
|
-
"name": "sobject",
|
|
1676
|
+
"char": "o",
|
|
1677
|
+
"deprecateAliases": true,
|
|
1678
|
+
"name": "target-org",
|
|
1679
|
+
"noCacheDefault": true,
|
|
1688
1680
|
"required": true,
|
|
1689
|
-
"summary": "
|
|
1690
|
-
"hasDynamicHelp":
|
|
1681
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1682
|
+
"hasDynamicHelp": true,
|
|
1691
1683
|
"multiple": false,
|
|
1692
1684
|
"type": "option"
|
|
1693
1685
|
},
|
|
1694
1686
|
"api-version": {
|
|
1687
|
+
"aliases": [
|
|
1688
|
+
"apiversion"
|
|
1689
|
+
],
|
|
1690
|
+
"deprecateAliases": true,
|
|
1695
1691
|
"description": "Override the api version used for api requests made by this command",
|
|
1696
1692
|
"name": "api-version",
|
|
1697
1693
|
"hasDynamicHelp": false,
|
|
1698
1694
|
"multiple": false,
|
|
1699
1695
|
"type": "option"
|
|
1700
1696
|
},
|
|
1701
|
-
"
|
|
1702
|
-
"
|
|
1703
|
-
|
|
1704
|
-
|
|
1705
|
-
|
|
1706
|
-
"name": "
|
|
1707
|
-
"
|
|
1708
|
-
"hasDynamicHelp": true,
|
|
1697
|
+
"loglevel": {
|
|
1698
|
+
"deprecated": {
|
|
1699
|
+
"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."
|
|
1700
|
+
},
|
|
1701
|
+
"hidden": true,
|
|
1702
|
+
"name": "loglevel",
|
|
1703
|
+
"hasDynamicHelp": false,
|
|
1709
1704
|
"multiple": false,
|
|
1710
1705
|
"type": "option"
|
|
1711
1706
|
},
|
|
1712
|
-
"
|
|
1713
|
-
"
|
|
1714
|
-
|
|
1715
|
-
|
|
1707
|
+
"sobject": {
|
|
1708
|
+
"aliases": [
|
|
1709
|
+
"sobjecttype"
|
|
1710
|
+
],
|
|
1711
|
+
"char": "s",
|
|
1712
|
+
"deprecateAliases": true,
|
|
1713
|
+
"name": "sobject",
|
|
1716
1714
|
"required": true,
|
|
1717
|
-
"summary": "
|
|
1718
|
-
"hasDynamicHelp":
|
|
1715
|
+
"summary": "API name of the Salesforce or Tooling API object that you're retrieving a record from.",
|
|
1716
|
+
"hasDynamicHelp": false,
|
|
1719
1717
|
"multiple": false,
|
|
1720
1718
|
"type": "option"
|
|
1721
1719
|
},
|
|
1722
|
-
"
|
|
1723
|
-
"
|
|
1724
|
-
"
|
|
1720
|
+
"record-id": {
|
|
1721
|
+
"aliases": [
|
|
1722
|
+
"sobjectid"
|
|
1725
1723
|
],
|
|
1726
|
-
"
|
|
1727
|
-
"
|
|
1724
|
+
"char": "i",
|
|
1725
|
+
"deprecateAliases": true,
|
|
1726
|
+
"name": "record-id",
|
|
1727
|
+
"summary": "ID of the record you’re retrieving.",
|
|
1728
1728
|
"hasDynamicHelp": false,
|
|
1729
1729
|
"multiple": false,
|
|
1730
|
-
"options": [
|
|
1731
|
-
"CRLF",
|
|
1732
|
-
"LF"
|
|
1733
|
-
],
|
|
1734
1730
|
"type": "option"
|
|
1735
1731
|
},
|
|
1736
|
-
"
|
|
1737
|
-
"
|
|
1738
|
-
"
|
|
1732
|
+
"where": {
|
|
1733
|
+
"char": "w",
|
|
1734
|
+
"name": "where",
|
|
1735
|
+
"summary": "List of <fieldName>=<value> pairs that identify the record you want to display.",
|
|
1739
1736
|
"hasDynamicHelp": false,
|
|
1740
1737
|
"multiple": false,
|
|
1741
|
-
"options": [
|
|
1742
|
-
"BACKQUOTE",
|
|
1743
|
-
"CARET",
|
|
1744
|
-
"COMMA",
|
|
1745
|
-
"PIPE",
|
|
1746
|
-
"SEMICOLON",
|
|
1747
|
-
"TAB"
|
|
1748
|
-
],
|
|
1749
1738
|
"type": "option"
|
|
1739
|
+
},
|
|
1740
|
+
"use-tooling-api": {
|
|
1741
|
+
"aliases": [
|
|
1742
|
+
"usetoolingapi"
|
|
1743
|
+
],
|
|
1744
|
+
"char": "t",
|
|
1745
|
+
"deprecateAliases": true,
|
|
1746
|
+
"name": "use-tooling-api",
|
|
1747
|
+
"summary": "Use Tooling API so you can retrieve a record from a Tooling API object.",
|
|
1748
|
+
"allowNo": false,
|
|
1749
|
+
"type": "boolean"
|
|
1750
|
+
},
|
|
1751
|
+
"perflog": {
|
|
1752
|
+
"deprecated": {
|
|
1753
|
+
"version": "57"
|
|
1754
|
+
},
|
|
1755
|
+
"description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
|
|
1756
|
+
"hidden": true,
|
|
1757
|
+
"name": "perflog",
|
|
1758
|
+
"summary": "Get API performance data.",
|
|
1759
|
+
"allowNo": false,
|
|
1760
|
+
"type": "boolean"
|
|
1750
1761
|
}
|
|
1751
1762
|
},
|
|
1752
1763
|
"hasDynamicHelp": true,
|
|
1753
1764
|
"hiddenAliases": [],
|
|
1754
|
-
"id": "data:
|
|
1765
|
+
"id": "data:get:record",
|
|
1755
1766
|
"pluginAlias": "@salesforce/plugin-data",
|
|
1756
1767
|
"pluginName": "@salesforce/plugin-data",
|
|
1757
1768
|
"pluginType": "core",
|
|
1758
1769
|
"strict": true,
|
|
1759
|
-
"summary": "
|
|
1770
|
+
"summary": "Retrieve and display a single record of a Salesforce or Tooling API object.",
|
|
1760
1771
|
"enableJsonFlag": true,
|
|
1761
1772
|
"isESM": true,
|
|
1762
1773
|
"relativePath": [
|
|
1763
1774
|
"lib",
|
|
1764
1775
|
"commands",
|
|
1765
1776
|
"data",
|
|
1766
|
-
"
|
|
1767
|
-
"
|
|
1777
|
+
"get",
|
|
1778
|
+
"record.js"
|
|
1779
|
+
],
|
|
1780
|
+
"aliasPermutations": [
|
|
1781
|
+
"force:data:record:get",
|
|
1782
|
+
"data:force:record:get",
|
|
1783
|
+
"data:record:force:get",
|
|
1784
|
+
"data:record:get:force",
|
|
1785
|
+
"force:record:data:get",
|
|
1786
|
+
"record:force:data:get",
|
|
1787
|
+
"record:data:force:get",
|
|
1788
|
+
"record:data:get:force",
|
|
1789
|
+
"force:record:get:data",
|
|
1790
|
+
"record:force:get:data",
|
|
1791
|
+
"record:get:force:data",
|
|
1792
|
+
"record:get:data:force",
|
|
1793
|
+
"force:data:get:record",
|
|
1794
|
+
"data:force:get:record",
|
|
1795
|
+
"data:get:force:record",
|
|
1796
|
+
"data:get:record:force",
|
|
1797
|
+
"force:get:data:record",
|
|
1798
|
+
"get:force:data:record",
|
|
1799
|
+
"get:data:force:record",
|
|
1800
|
+
"get:data:record:force",
|
|
1801
|
+
"force:get:record:data",
|
|
1802
|
+
"get:force:record:data",
|
|
1803
|
+
"get:record:force:data",
|
|
1804
|
+
"get:record:data:force"
|
|
1768
1805
|
],
|
|
1769
|
-
"aliasPermutations": [],
|
|
1770
1806
|
"permutations": [
|
|
1771
|
-
"data:
|
|
1772
|
-
"
|
|
1773
|
-
"
|
|
1774
|
-
"data:
|
|
1775
|
-
"
|
|
1776
|
-
"
|
|
1807
|
+
"data:get:record",
|
|
1808
|
+
"get:data:record",
|
|
1809
|
+
"get:record:data",
|
|
1810
|
+
"data:record:get",
|
|
1811
|
+
"record:data:get",
|
|
1812
|
+
"record:get:data"
|
|
1777
1813
|
]
|
|
1778
1814
|
},
|
|
1779
|
-
"data:
|
|
1780
|
-
"aliases": [
|
|
1815
|
+
"data:query:resume": {
|
|
1816
|
+
"aliases": [
|
|
1817
|
+
"force:data:soql:bulk:report"
|
|
1818
|
+
],
|
|
1781
1819
|
"args": {},
|
|
1782
|
-
"
|
|
1820
|
+
"deprecateAliases": true,
|
|
1821
|
+
"deprecationOptions": {
|
|
1822
|
+
"message": "Bulk mode for \"data query\" is deprecated, this command will be removed after April 2025.\nUse \"data export bulk | data export resume\" for bulk queries instead.\n"
|
|
1823
|
+
},
|
|
1824
|
+
"description": "Run this command using the job ID returned from the \"<%= config.bin %> data query --bulk\" command.",
|
|
1783
1825
|
"examples": [
|
|
1784
|
-
"
|
|
1785
|
-
"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"
|
|
1826
|
+
"View the status of a bulk query with the specified ID:\n<%= config.bin %> <%= command.id %> --bulk-query-id 7500x000005BdFzXXX"
|
|
1786
1827
|
],
|
|
1787
1828
|
"flags": {
|
|
1788
1829
|
"json": {
|
|
@@ -1800,207 +1841,234 @@
|
|
|
1800
1841
|
"multiple": false,
|
|
1801
1842
|
"type": "option"
|
|
1802
1843
|
},
|
|
1803
|
-
"
|
|
1804
|
-
"
|
|
1805
|
-
|
|
1806
|
-
|
|
1807
|
-
|
|
1844
|
+
"target-org": {
|
|
1845
|
+
"aliases": [
|
|
1846
|
+
"targetusername",
|
|
1847
|
+
"u"
|
|
1848
|
+
],
|
|
1849
|
+
"char": "o",
|
|
1850
|
+
"deprecateAliases": true,
|
|
1851
|
+
"name": "target-org",
|
|
1852
|
+
"noCacheDefault": true,
|
|
1853
|
+
"summary": "Username or alias of the target org.",
|
|
1854
|
+
"hasDynamicHelp": true,
|
|
1855
|
+
"multiple": false,
|
|
1856
|
+
"type": "option"
|
|
1808
1857
|
},
|
|
1809
|
-
"
|
|
1810
|
-
"
|
|
1811
|
-
|
|
1812
|
-
|
|
1858
|
+
"api-version": {
|
|
1859
|
+
"aliases": [
|
|
1860
|
+
"apiversion"
|
|
1861
|
+
],
|
|
1862
|
+
"deprecateAliases": true,
|
|
1863
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1864
|
+
"name": "api-version",
|
|
1813
1865
|
"hasDynamicHelp": false,
|
|
1814
1866
|
"multiple": false,
|
|
1815
1867
|
"type": "option"
|
|
1816
1868
|
},
|
|
1817
|
-
"
|
|
1818
|
-
"
|
|
1819
|
-
|
|
1820
|
-
|
|
1821
|
-
"
|
|
1822
|
-
"
|
|
1869
|
+
"loglevel": {
|
|
1870
|
+
"deprecated": {
|
|
1871
|
+
"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."
|
|
1872
|
+
},
|
|
1873
|
+
"hidden": true,
|
|
1874
|
+
"name": "loglevel",
|
|
1875
|
+
"hasDynamicHelp": false,
|
|
1823
1876
|
"multiple": false,
|
|
1824
1877
|
"type": "option"
|
|
1825
|
-
}
|
|
1826
|
-
},
|
|
1827
|
-
"hasDynamicHelp": true,
|
|
1828
|
-
"hiddenAliases": [],
|
|
1829
|
-
"id": "data:import:resume",
|
|
1830
|
-
"pluginAlias": "@salesforce/plugin-data",
|
|
1831
|
-
"pluginName": "@salesforce/plugin-data",
|
|
1832
|
-
"pluginType": "core",
|
|
1833
|
-
"strict": true,
|
|
1834
|
-
"summary": "Resume a bulk import job that you previously started. Uses Bulk API 2.0.",
|
|
1835
|
-
"enableJsonFlag": true,
|
|
1836
|
-
"isESM": true,
|
|
1837
|
-
"relativePath": [
|
|
1838
|
-
"lib",
|
|
1839
|
-
"commands",
|
|
1840
|
-
"data",
|
|
1841
|
-
"import",
|
|
1842
|
-
"resume.js"
|
|
1843
|
-
],
|
|
1844
|
-
"aliasPermutations": [],
|
|
1845
|
-
"permutations": [
|
|
1846
|
-
"data:import:resume",
|
|
1847
|
-
"import:data:resume",
|
|
1848
|
-
"import:resume:data",
|
|
1849
|
-
"data:resume:import",
|
|
1850
|
-
"resume:data:import",
|
|
1851
|
-
"resume:import:data"
|
|
1852
|
-
]
|
|
1853
|
-
},
|
|
1854
|
-
"data:import:tree": {
|
|
1855
|
-
"aliases": [
|
|
1856
|
-
"force:data:tree:import"
|
|
1857
|
-
],
|
|
1858
|
-
"args": {},
|
|
1859
|
-
"deprecateAliases": true,
|
|
1860
|
-
"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.",
|
|
1861
|
-
"examples": [
|
|
1862
|
-
"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",
|
|
1863
|
-
"Import records using a plan definition file into your default org:\n<%= config.bin %> <%= command.id %> --plan Account-Contact-plan.json"
|
|
1864
|
-
],
|
|
1865
|
-
"flags": {
|
|
1866
|
-
"json": {
|
|
1867
|
-
"description": "Format output as json.",
|
|
1868
|
-
"helpGroup": "GLOBAL",
|
|
1869
|
-
"name": "json",
|
|
1870
|
-
"allowNo": false,
|
|
1871
|
-
"type": "boolean"
|
|
1872
1878
|
},
|
|
1873
|
-
"
|
|
1874
|
-
"helpGroup": "GLOBAL",
|
|
1875
|
-
"name": "flags-dir",
|
|
1876
|
-
"summary": "Import flag values from a directory.",
|
|
1877
|
-
"hasDynamicHelp": false,
|
|
1878
|
-
"multiple": false,
|
|
1879
|
-
"type": "option"
|
|
1880
|
-
},
|
|
1881
|
-
"target-org": {
|
|
1882
|
-
"aliases": [
|
|
1883
|
-
"targetusername",
|
|
1884
|
-
"u"
|
|
1885
|
-
],
|
|
1886
|
-
"char": "o",
|
|
1887
|
-
"deprecateAliases": true,
|
|
1888
|
-
"name": "target-org",
|
|
1889
|
-
"noCacheDefault": true,
|
|
1890
|
-
"required": true,
|
|
1891
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1892
|
-
"hasDynamicHelp": true,
|
|
1893
|
-
"multiple": false,
|
|
1894
|
-
"type": "option"
|
|
1895
|
-
},
|
|
1896
|
-
"api-version": {
|
|
1879
|
+
"result-format": {
|
|
1897
1880
|
"aliases": [
|
|
1898
|
-
"
|
|
1881
|
+
"resultformat"
|
|
1899
1882
|
],
|
|
1883
|
+
"char": "r",
|
|
1900
1884
|
"deprecateAliases": true,
|
|
1901
|
-
"
|
|
1902
|
-
"
|
|
1903
|
-
"
|
|
1904
|
-
"multiple": false,
|
|
1905
|
-
"type": "option"
|
|
1906
|
-
},
|
|
1907
|
-
"loglevel": {
|
|
1908
|
-
"deprecated": {
|
|
1909
|
-
"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."
|
|
1910
|
-
},
|
|
1911
|
-
"hidden": true,
|
|
1912
|
-
"name": "loglevel",
|
|
1885
|
+
"name": "result-format",
|
|
1886
|
+
"summary": "Format to display the results; the --json flag overrides this flag.",
|
|
1887
|
+
"default": "human",
|
|
1913
1888
|
"hasDynamicHelp": false,
|
|
1914
1889
|
"multiple": false,
|
|
1890
|
+
"options": [
|
|
1891
|
+
"human",
|
|
1892
|
+
"csv",
|
|
1893
|
+
"json"
|
|
1894
|
+
],
|
|
1915
1895
|
"type": "option"
|
|
1916
1896
|
},
|
|
1917
|
-
"
|
|
1897
|
+
"bulk-query-id": {
|
|
1918
1898
|
"aliases": [
|
|
1919
|
-
"
|
|
1899
|
+
"bulkqueryid"
|
|
1920
1900
|
],
|
|
1921
|
-
"char": "
|
|
1901
|
+
"char": "i",
|
|
1922
1902
|
"deprecateAliases": true,
|
|
1923
|
-
"name": "
|
|
1924
|
-
"summary": "
|
|
1925
|
-
"delimiter": ",",
|
|
1926
|
-
"hasDynamicHelp": false,
|
|
1927
|
-
"multiple": true,
|
|
1928
|
-
"type": "option"
|
|
1929
|
-
},
|
|
1930
|
-
"plan": {
|
|
1931
|
-
"char": "p",
|
|
1932
|
-
"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",
|
|
1933
|
-
"name": "plan",
|
|
1934
|
-
"summary": "Plan definition file to insert multiple data files.",
|
|
1903
|
+
"name": "bulk-query-id",
|
|
1904
|
+
"summary": "Job ID of the bulk query.",
|
|
1935
1905
|
"hasDynamicHelp": false,
|
|
1936
1906
|
"multiple": false,
|
|
1937
1907
|
"type": "option"
|
|
1908
|
+
},
|
|
1909
|
+
"use-most-recent": {
|
|
1910
|
+
"name": "use-most-recent",
|
|
1911
|
+
"summary": "Use the most recent bulk query ID from cache.",
|
|
1912
|
+
"allowNo": false,
|
|
1913
|
+
"type": "boolean"
|
|
1938
1914
|
}
|
|
1939
1915
|
},
|
|
1940
1916
|
"hasDynamicHelp": true,
|
|
1941
1917
|
"hiddenAliases": [],
|
|
1942
|
-
"id": "data:
|
|
1918
|
+
"id": "data:query:resume",
|
|
1943
1919
|
"pluginAlias": "@salesforce/plugin-data",
|
|
1944
1920
|
"pluginName": "@salesforce/plugin-data",
|
|
1945
1921
|
"pluginType": "core",
|
|
1922
|
+
"state": "deprecated",
|
|
1946
1923
|
"strict": true,
|
|
1947
|
-
"summary": "
|
|
1924
|
+
"summary": "View the status of a bulk query.",
|
|
1948
1925
|
"enableJsonFlag": true,
|
|
1949
1926
|
"isESM": true,
|
|
1950
1927
|
"relativePath": [
|
|
1951
1928
|
"lib",
|
|
1952
1929
|
"commands",
|
|
1953
1930
|
"data",
|
|
1954
|
-
"
|
|
1955
|
-
"
|
|
1931
|
+
"query",
|
|
1932
|
+
"resume.js"
|
|
1956
1933
|
],
|
|
1957
1934
|
"aliasPermutations": [
|
|
1958
|
-
"force:data:
|
|
1959
|
-
"data:force:
|
|
1960
|
-
"data:
|
|
1961
|
-
"data:
|
|
1962
|
-
"
|
|
1963
|
-
"
|
|
1964
|
-
"
|
|
1965
|
-
"
|
|
1966
|
-
"
|
|
1967
|
-
"
|
|
1968
|
-
"
|
|
1969
|
-
"
|
|
1970
|
-
"force:data:
|
|
1971
|
-
"data:force:
|
|
1972
|
-
"data:
|
|
1973
|
-
"
|
|
1974
|
-
"force:
|
|
1975
|
-
"
|
|
1976
|
-
"
|
|
1977
|
-
"
|
|
1978
|
-
"force:
|
|
1979
|
-
"
|
|
1980
|
-
"
|
|
1981
|
-
"
|
|
1935
|
+
"force:data:soql:bulk:report",
|
|
1936
|
+
"data:force:soql:bulk:report",
|
|
1937
|
+
"data:soql:force:bulk:report",
|
|
1938
|
+
"data:soql:bulk:force:report",
|
|
1939
|
+
"data:soql:bulk:report:force",
|
|
1940
|
+
"force:soql:data:bulk:report",
|
|
1941
|
+
"soql:force:data:bulk:report",
|
|
1942
|
+
"soql:data:force:bulk:report",
|
|
1943
|
+
"soql:data:bulk:force:report",
|
|
1944
|
+
"soql:data:bulk:report:force",
|
|
1945
|
+
"force:soql:bulk:data:report",
|
|
1946
|
+
"soql:force:bulk:data:report",
|
|
1947
|
+
"soql:bulk:force:data:report",
|
|
1948
|
+
"soql:bulk:data:force:report",
|
|
1949
|
+
"soql:bulk:data:report:force",
|
|
1950
|
+
"force:soql:bulk:report:data",
|
|
1951
|
+
"soql:force:bulk:report:data",
|
|
1952
|
+
"soql:bulk:force:report:data",
|
|
1953
|
+
"soql:bulk:report:force:data",
|
|
1954
|
+
"soql:bulk:report:data:force",
|
|
1955
|
+
"force:data:bulk:soql:report",
|
|
1956
|
+
"data:force:bulk:soql:report",
|
|
1957
|
+
"data:bulk:force:soql:report",
|
|
1958
|
+
"data:bulk:soql:force:report",
|
|
1959
|
+
"data:bulk:soql:report:force",
|
|
1960
|
+
"force:bulk:data:soql:report",
|
|
1961
|
+
"bulk:force:data:soql:report",
|
|
1962
|
+
"bulk:data:force:soql:report",
|
|
1963
|
+
"bulk:data:soql:force:report",
|
|
1964
|
+
"bulk:data:soql:report:force",
|
|
1965
|
+
"force:bulk:soql:data:report",
|
|
1966
|
+
"bulk:force:soql:data:report",
|
|
1967
|
+
"bulk:soql:force:data:report",
|
|
1968
|
+
"bulk:soql:data:force:report",
|
|
1969
|
+
"bulk:soql:data:report:force",
|
|
1970
|
+
"force:bulk:soql:report:data",
|
|
1971
|
+
"bulk:force:soql:report:data",
|
|
1972
|
+
"bulk:soql:force:report:data",
|
|
1973
|
+
"bulk:soql:report:force:data",
|
|
1974
|
+
"bulk:soql:report:data:force",
|
|
1975
|
+
"force:data:bulk:report:soql",
|
|
1976
|
+
"data:force:bulk:report:soql",
|
|
1977
|
+
"data:bulk:force:report:soql",
|
|
1978
|
+
"data:bulk:report:force:soql",
|
|
1979
|
+
"data:bulk:report:soql:force",
|
|
1980
|
+
"force:bulk:data:report:soql",
|
|
1981
|
+
"bulk:force:data:report:soql",
|
|
1982
|
+
"bulk:data:force:report:soql",
|
|
1983
|
+
"bulk:data:report:force:soql",
|
|
1984
|
+
"bulk:data:report:soql:force",
|
|
1985
|
+
"force:bulk:report:data:soql",
|
|
1986
|
+
"bulk:force:report:data:soql",
|
|
1987
|
+
"bulk:report:force:data:soql",
|
|
1988
|
+
"bulk:report:data:force:soql",
|
|
1989
|
+
"bulk:report:data:soql:force",
|
|
1990
|
+
"force:bulk:report:soql:data",
|
|
1991
|
+
"bulk:force:report:soql:data",
|
|
1992
|
+
"bulk:report:force:soql:data",
|
|
1993
|
+
"bulk:report:soql:force:data",
|
|
1994
|
+
"bulk:report:soql:data:force",
|
|
1995
|
+
"force:data:soql:report:bulk",
|
|
1996
|
+
"data:force:soql:report:bulk",
|
|
1997
|
+
"data:soql:force:report:bulk",
|
|
1998
|
+
"data:soql:report:force:bulk",
|
|
1999
|
+
"data:soql:report:bulk:force",
|
|
2000
|
+
"force:soql:data:report:bulk",
|
|
2001
|
+
"soql:force:data:report:bulk",
|
|
2002
|
+
"soql:data:force:report:bulk",
|
|
2003
|
+
"soql:data:report:force:bulk",
|
|
2004
|
+
"soql:data:report:bulk:force",
|
|
2005
|
+
"force:soql:report:data:bulk",
|
|
2006
|
+
"soql:force:report:data:bulk",
|
|
2007
|
+
"soql:report:force:data:bulk",
|
|
2008
|
+
"soql:report:data:force:bulk",
|
|
2009
|
+
"soql:report:data:bulk:force",
|
|
2010
|
+
"force:soql:report:bulk:data",
|
|
2011
|
+
"soql:force:report:bulk:data",
|
|
2012
|
+
"soql:report:force:bulk:data",
|
|
2013
|
+
"soql:report:bulk:force:data",
|
|
2014
|
+
"soql:report:bulk:data:force",
|
|
2015
|
+
"force:data:report:soql:bulk",
|
|
2016
|
+
"data:force:report:soql:bulk",
|
|
2017
|
+
"data:report:force:soql:bulk",
|
|
2018
|
+
"data:report:soql:force:bulk",
|
|
2019
|
+
"data:report:soql:bulk:force",
|
|
2020
|
+
"force:report:data:soql:bulk",
|
|
2021
|
+
"report:force:data:soql:bulk",
|
|
2022
|
+
"report:data:force:soql:bulk",
|
|
2023
|
+
"report:data:soql:force:bulk",
|
|
2024
|
+
"report:data:soql:bulk:force",
|
|
2025
|
+
"force:report:soql:data:bulk",
|
|
2026
|
+
"report:force:soql:data:bulk",
|
|
2027
|
+
"report:soql:force:data:bulk",
|
|
2028
|
+
"report:soql:data:force:bulk",
|
|
2029
|
+
"report:soql:data:bulk:force",
|
|
2030
|
+
"force:report:soql:bulk:data",
|
|
2031
|
+
"report:force:soql:bulk:data",
|
|
2032
|
+
"report:soql:force:bulk:data",
|
|
2033
|
+
"report:soql:bulk:force:data",
|
|
2034
|
+
"report:soql:bulk:data:force",
|
|
2035
|
+
"force:data:report:bulk:soql",
|
|
2036
|
+
"data:force:report:bulk:soql",
|
|
2037
|
+
"data:report:force:bulk:soql",
|
|
2038
|
+
"data:report:bulk:force:soql",
|
|
2039
|
+
"data:report:bulk:soql:force",
|
|
2040
|
+
"force:report:data:bulk:soql",
|
|
2041
|
+
"report:force:data:bulk:soql",
|
|
2042
|
+
"report:data:force:bulk:soql",
|
|
2043
|
+
"report:data:bulk:force:soql",
|
|
2044
|
+
"report:data:bulk:soql:force",
|
|
2045
|
+
"force:report:bulk:data:soql",
|
|
2046
|
+
"report:force:bulk:data:soql",
|
|
2047
|
+
"report:bulk:force:data:soql",
|
|
2048
|
+
"report:bulk:data:force:soql",
|
|
2049
|
+
"report:bulk:data:soql:force",
|
|
2050
|
+
"force:report:bulk:soql:data",
|
|
2051
|
+
"report:force:bulk:soql:data",
|
|
2052
|
+
"report:bulk:force:soql:data",
|
|
2053
|
+
"report:bulk:soql:force:data",
|
|
2054
|
+
"report:bulk:soql:data:force"
|
|
1982
2055
|
],
|
|
1983
2056
|
"permutations": [
|
|
1984
|
-
"data:
|
|
1985
|
-
"
|
|
1986
|
-
"
|
|
1987
|
-
"data:
|
|
1988
|
-
"
|
|
1989
|
-
"
|
|
2057
|
+
"data:query:resume",
|
|
2058
|
+
"query:data:resume",
|
|
2059
|
+
"query:resume:data",
|
|
2060
|
+
"data:resume:query",
|
|
2061
|
+
"resume:data:query",
|
|
2062
|
+
"resume:query:data"
|
|
1990
2063
|
]
|
|
1991
2064
|
},
|
|
1992
|
-
"data:
|
|
1993
|
-
"aliases": [
|
|
1994
|
-
"force:data:record:get"
|
|
1995
|
-
],
|
|
2065
|
+
"data:import:bulk": {
|
|
2066
|
+
"aliases": [],
|
|
1996
2067
|
"args": {},
|
|
1997
|
-
"
|
|
1998
|
-
"description": "Specify the record you want to retrieve with either its ID or with a list of field-value pairs that identify the record. If your list of fields identifies more than one record, the command fails; the error displays how many records were found.\n\nWhen specifying field-value pairs, use the format <fieldName>=<value>. Enclose all field-value pairs in one set of double quotation marks, delimited by spaces. Enclose values that contain spaces in single quotes.\n\nThe command displays all the record's fields and their values, one field per terminal line. Fields with no values are displayed as \"null\".\n\nThis command retrieves a record from Salesforce objects by default. Use the --use-tooling-api flag to retrieve from a Tooling API object.",
|
|
2068
|
+
"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).",
|
|
1999
2069
|
"examples": [
|
|
2000
|
-
"
|
|
2001
|
-
"
|
|
2002
|
-
"Retrieve a record from Account identified with two field values, one that contains a space; the command uses the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name='Universal Containers' Phone='(123) 456-7890'\" --target-org myscratch",
|
|
2003
|
-
"Retrieve a record from the Tooling API object TraceFlag with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --use-tooling-api --sobject TraceFlag --record-id 7tf8c"
|
|
2070
|
+
"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",
|
|
2071
|
+
"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"
|
|
2004
2072
|
],
|
|
2005
2073
|
"flags": {
|
|
2006
2074
|
"json": {
|
|
@@ -2018,162 +2086,204 @@
|
|
|
2018
2086
|
"multiple": false,
|
|
2019
2087
|
"type": "option"
|
|
2020
2088
|
},
|
|
2021
|
-
"
|
|
2022
|
-
"
|
|
2023
|
-
|
|
2024
|
-
"
|
|
2089
|
+
"async": {
|
|
2090
|
+
"char": "a",
|
|
2091
|
+
"exclusive": [
|
|
2092
|
+
"wait"
|
|
2025
2093
|
],
|
|
2026
|
-
"
|
|
2027
|
-
"
|
|
2028
|
-
"
|
|
2029
|
-
"
|
|
2094
|
+
"name": "async",
|
|
2095
|
+
"summary": "Don't wait for the command to complete.",
|
|
2096
|
+
"allowNo": false,
|
|
2097
|
+
"type": "boolean"
|
|
2098
|
+
},
|
|
2099
|
+
"file": {
|
|
2100
|
+
"char": "f",
|
|
2101
|
+
"name": "file",
|
|
2030
2102
|
"required": true,
|
|
2031
|
-
"summary": "
|
|
2032
|
-
"hasDynamicHelp":
|
|
2103
|
+
"summary": "CSV file that contains the Salesforce object records you want to import.",
|
|
2104
|
+
"hasDynamicHelp": false,
|
|
2105
|
+
"multiple": false,
|
|
2106
|
+
"type": "option"
|
|
2107
|
+
},
|
|
2108
|
+
"sobject": {
|
|
2109
|
+
"char": "s",
|
|
2110
|
+
"name": "sobject",
|
|
2111
|
+
"required": true,
|
|
2112
|
+
"summary": "API name of the Salesforce object, either standard or custom, into which you're importing records.",
|
|
2113
|
+
"hasDynamicHelp": false,
|
|
2033
2114
|
"multiple": false,
|
|
2034
2115
|
"type": "option"
|
|
2035
2116
|
},
|
|
2036
2117
|
"api-version": {
|
|
2037
|
-
"aliases": [
|
|
2038
|
-
"apiversion"
|
|
2039
|
-
],
|
|
2040
|
-
"deprecateAliases": true,
|
|
2041
2118
|
"description": "Override the api version used for api requests made by this command",
|
|
2042
2119
|
"name": "api-version",
|
|
2043
2120
|
"hasDynamicHelp": false,
|
|
2044
2121
|
"multiple": false,
|
|
2045
2122
|
"type": "option"
|
|
2046
2123
|
},
|
|
2047
|
-
"
|
|
2048
|
-
"
|
|
2049
|
-
|
|
2050
|
-
|
|
2051
|
-
|
|
2052
|
-
"name": "
|
|
2053
|
-
"
|
|
2124
|
+
"wait": {
|
|
2125
|
+
"char": "w",
|
|
2126
|
+
"exclusive": [
|
|
2127
|
+
"async"
|
|
2128
|
+
],
|
|
2129
|
+
"name": "wait",
|
|
2130
|
+
"summary": "Time to wait for the command to finish, in minutes.",
|
|
2131
|
+
"hasDynamicHelp": true,
|
|
2054
2132
|
"multiple": false,
|
|
2055
2133
|
"type": "option"
|
|
2056
2134
|
},
|
|
2057
|
-
"
|
|
2058
|
-
"
|
|
2059
|
-
|
|
2060
|
-
|
|
2061
|
-
"char": "s",
|
|
2062
|
-
"deprecateAliases": true,
|
|
2063
|
-
"name": "sobject",
|
|
2135
|
+
"target-org": {
|
|
2136
|
+
"char": "o",
|
|
2137
|
+
"name": "target-org",
|
|
2138
|
+
"noCacheDefault": true,
|
|
2064
2139
|
"required": true,
|
|
2065
|
-
"summary": "
|
|
2066
|
-
"hasDynamicHelp":
|
|
2140
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2141
|
+
"hasDynamicHelp": true,
|
|
2067
2142
|
"multiple": false,
|
|
2068
2143
|
"type": "option"
|
|
2069
2144
|
},
|
|
2070
|
-
"
|
|
2071
|
-
"
|
|
2072
|
-
"
|
|
2145
|
+
"line-ending": {
|
|
2146
|
+
"dependsOn": [
|
|
2147
|
+
"file"
|
|
2073
2148
|
],
|
|
2074
|
-
"
|
|
2075
|
-
"
|
|
2076
|
-
"name": "record-id",
|
|
2077
|
-
"summary": "ID of the record you’re retrieving.",
|
|
2149
|
+
"name": "line-ending",
|
|
2150
|
+
"summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LF`.",
|
|
2078
2151
|
"hasDynamicHelp": false,
|
|
2079
2152
|
"multiple": false,
|
|
2153
|
+
"options": [
|
|
2154
|
+
"CRLF",
|
|
2155
|
+
"LF"
|
|
2156
|
+
],
|
|
2080
2157
|
"type": "option"
|
|
2081
2158
|
},
|
|
2082
|
-
"
|
|
2083
|
-
"
|
|
2084
|
-
"
|
|
2085
|
-
"summary": "List of <fieldName>=<value> pairs that identify the record you want to display.",
|
|
2159
|
+
"column-delimiter": {
|
|
2160
|
+
"name": "column-delimiter",
|
|
2161
|
+
"summary": "Column delimiter used in the CSV file.",
|
|
2086
2162
|
"hasDynamicHelp": false,
|
|
2087
2163
|
"multiple": false,
|
|
2088
|
-
"
|
|
2089
|
-
|
|
2090
|
-
|
|
2091
|
-
|
|
2092
|
-
"
|
|
2164
|
+
"options": [
|
|
2165
|
+
"BACKQUOTE",
|
|
2166
|
+
"CARET",
|
|
2167
|
+
"COMMA",
|
|
2168
|
+
"PIPE",
|
|
2169
|
+
"SEMICOLON",
|
|
2170
|
+
"TAB"
|
|
2093
2171
|
],
|
|
2094
|
-
"
|
|
2095
|
-
"deprecateAliases": true,
|
|
2096
|
-
"name": "use-tooling-api",
|
|
2097
|
-
"summary": "Use Tooling API so you can retrieve a record from a Tooling API object.",
|
|
2098
|
-
"allowNo": false,
|
|
2099
|
-
"type": "boolean"
|
|
2100
|
-
},
|
|
2101
|
-
"perflog": {
|
|
2102
|
-
"deprecated": {
|
|
2103
|
-
"version": "57"
|
|
2104
|
-
},
|
|
2105
|
-
"description": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json.",
|
|
2106
|
-
"hidden": true,
|
|
2107
|
-
"name": "perflog",
|
|
2108
|
-
"summary": "Get API performance data.",
|
|
2109
|
-
"allowNo": false,
|
|
2110
|
-
"type": "boolean"
|
|
2172
|
+
"type": "option"
|
|
2111
2173
|
}
|
|
2112
2174
|
},
|
|
2113
2175
|
"hasDynamicHelp": true,
|
|
2114
2176
|
"hiddenAliases": [],
|
|
2115
|
-
"id": "data:
|
|
2177
|
+
"id": "data:import:bulk",
|
|
2116
2178
|
"pluginAlias": "@salesforce/plugin-data",
|
|
2117
2179
|
"pluginName": "@salesforce/plugin-data",
|
|
2118
2180
|
"pluginType": "core",
|
|
2119
2181
|
"strict": true,
|
|
2120
|
-
"summary": "
|
|
2182
|
+
"summary": "Bulk import records into a Salesforce object from a CSV file. Uses Bulk API 2.0.",
|
|
2121
2183
|
"enableJsonFlag": true,
|
|
2122
2184
|
"isESM": true,
|
|
2123
2185
|
"relativePath": [
|
|
2124
2186
|
"lib",
|
|
2125
2187
|
"commands",
|
|
2126
2188
|
"data",
|
|
2127
|
-
"
|
|
2128
|
-
"
|
|
2189
|
+
"import",
|
|
2190
|
+
"bulk.js"
|
|
2129
2191
|
],
|
|
2130
|
-
"aliasPermutations": [
|
|
2131
|
-
|
|
2132
|
-
"data:
|
|
2133
|
-
"data:
|
|
2134
|
-
"
|
|
2135
|
-
"
|
|
2136
|
-
"
|
|
2137
|
-
"
|
|
2138
|
-
|
|
2139
|
-
|
|
2140
|
-
|
|
2141
|
-
|
|
2142
|
-
|
|
2143
|
-
|
|
2144
|
-
|
|
2145
|
-
"
|
|
2146
|
-
"
|
|
2147
|
-
|
|
2148
|
-
|
|
2149
|
-
"
|
|
2150
|
-
|
|
2151
|
-
|
|
2152
|
-
|
|
2153
|
-
|
|
2154
|
-
|
|
2192
|
+
"aliasPermutations": [],
|
|
2193
|
+
"permutations": [
|
|
2194
|
+
"data:import:bulk",
|
|
2195
|
+
"import:data:bulk",
|
|
2196
|
+
"import:bulk:data",
|
|
2197
|
+
"data:bulk:import",
|
|
2198
|
+
"bulk:data:import",
|
|
2199
|
+
"bulk:import:data"
|
|
2200
|
+
]
|
|
2201
|
+
},
|
|
2202
|
+
"data:import:resume": {
|
|
2203
|
+
"aliases": [],
|
|
2204
|
+
"args": {},
|
|
2205
|
+
"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.",
|
|
2206
|
+
"examples": [
|
|
2207
|
+
"Resume a bulk import job to your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
|
|
2208
|
+
"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"
|
|
2209
|
+
],
|
|
2210
|
+
"flags": {
|
|
2211
|
+
"json": {
|
|
2212
|
+
"description": "Format output as json.",
|
|
2213
|
+
"helpGroup": "GLOBAL",
|
|
2214
|
+
"name": "json",
|
|
2215
|
+
"allowNo": false,
|
|
2216
|
+
"type": "boolean"
|
|
2217
|
+
},
|
|
2218
|
+
"flags-dir": {
|
|
2219
|
+
"helpGroup": "GLOBAL",
|
|
2220
|
+
"name": "flags-dir",
|
|
2221
|
+
"summary": "Import flag values from a directory.",
|
|
2222
|
+
"hasDynamicHelp": false,
|
|
2223
|
+
"multiple": false,
|
|
2224
|
+
"type": "option"
|
|
2225
|
+
},
|
|
2226
|
+
"use-most-recent": {
|
|
2227
|
+
"name": "use-most-recent",
|
|
2228
|
+
"summary": "Use the job ID of the bulk import job that was most recently run.",
|
|
2229
|
+
"allowNo": false,
|
|
2230
|
+
"type": "boolean"
|
|
2231
|
+
},
|
|
2232
|
+
"job-id": {
|
|
2233
|
+
"char": "i",
|
|
2234
|
+
"name": "job-id",
|
|
2235
|
+
"summary": "Job ID of the bulk import.",
|
|
2236
|
+
"hasDynamicHelp": false,
|
|
2237
|
+
"multiple": false,
|
|
2238
|
+
"type": "option"
|
|
2239
|
+
},
|
|
2240
|
+
"wait": {
|
|
2241
|
+
"char": "w",
|
|
2242
|
+
"name": "wait",
|
|
2243
|
+
"summary": "Time to wait for the command to finish, in minutes.",
|
|
2244
|
+
"default": "5 minutes",
|
|
2245
|
+
"hasDynamicHelp": true,
|
|
2246
|
+
"multiple": false,
|
|
2247
|
+
"type": "option"
|
|
2248
|
+
}
|
|
2249
|
+
},
|
|
2250
|
+
"hasDynamicHelp": true,
|
|
2251
|
+
"hiddenAliases": [],
|
|
2252
|
+
"id": "data:import:resume",
|
|
2253
|
+
"pluginAlias": "@salesforce/plugin-data",
|
|
2254
|
+
"pluginName": "@salesforce/plugin-data",
|
|
2255
|
+
"pluginType": "core",
|
|
2256
|
+
"strict": true,
|
|
2257
|
+
"summary": "Resume a bulk import job that you previously started. Uses Bulk API 2.0.",
|
|
2258
|
+
"enableJsonFlag": true,
|
|
2259
|
+
"isESM": true,
|
|
2260
|
+
"relativePath": [
|
|
2261
|
+
"lib",
|
|
2262
|
+
"commands",
|
|
2263
|
+
"data",
|
|
2264
|
+
"import",
|
|
2265
|
+
"resume.js"
|
|
2155
2266
|
],
|
|
2267
|
+
"aliasPermutations": [],
|
|
2156
2268
|
"permutations": [
|
|
2157
|
-
"data:
|
|
2158
|
-
"
|
|
2159
|
-
"
|
|
2160
|
-
"data:
|
|
2161
|
-
"
|
|
2162
|
-
"
|
|
2269
|
+
"data:import:resume",
|
|
2270
|
+
"import:data:resume",
|
|
2271
|
+
"import:resume:data",
|
|
2272
|
+
"data:resume:import",
|
|
2273
|
+
"resume:data:import",
|
|
2274
|
+
"resume:import:data"
|
|
2163
2275
|
]
|
|
2164
2276
|
},
|
|
2165
|
-
"data:
|
|
2277
|
+
"data:import:tree": {
|
|
2166
2278
|
"aliases": [
|
|
2167
|
-
"force:data:
|
|
2279
|
+
"force:data:tree:import"
|
|
2168
2280
|
],
|
|
2169
2281
|
"args": {},
|
|
2170
2282
|
"deprecateAliases": true,
|
|
2171
|
-
"
|
|
2172
|
-
"message": "Bulk mode for \"data query\" is deprecated, this command will be removed after April 2025.\nUse \"data export bulk | data export resume\" for bulk queries instead.\n"
|
|
2173
|
-
},
|
|
2174
|
-
"description": "Run this command using the job ID returned from the \"<%= config.bin %> data query --bulk\" command.",
|
|
2283
|
+
"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.",
|
|
2175
2284
|
"examples": [
|
|
2176
|
-
"
|
|
2285
|
+
"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",
|
|
2286
|
+
"Import records using a plan definition file into your default org:\n<%= config.bin %> <%= command.id %> --plan Account-Contact-plan.json"
|
|
2177
2287
|
],
|
|
2178
2288
|
"flags": {
|
|
2179
2289
|
"json": {
|
|
@@ -2200,7 +2310,8 @@
|
|
|
2200
2310
|
"deprecateAliases": true,
|
|
2201
2311
|
"name": "target-org",
|
|
2202
2312
|
"noCacheDefault": true,
|
|
2203
|
-
"
|
|
2313
|
+
"required": true,
|
|
2314
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2204
2315
|
"hasDynamicHelp": true,
|
|
2205
2316
|
"multiple": false,
|
|
2206
2317
|
"type": "option"
|
|
@@ -2226,190 +2337,79 @@
|
|
|
2226
2337
|
"multiple": false,
|
|
2227
2338
|
"type": "option"
|
|
2228
2339
|
},
|
|
2229
|
-
"
|
|
2340
|
+
"files": {
|
|
2230
2341
|
"aliases": [
|
|
2231
|
-
"
|
|
2342
|
+
"sobjecttreefiles"
|
|
2232
2343
|
],
|
|
2233
|
-
"char": "
|
|
2344
|
+
"char": "f",
|
|
2234
2345
|
"deprecateAliases": true,
|
|
2235
|
-
"name": "
|
|
2236
|
-
"summary": "
|
|
2237
|
-
"
|
|
2346
|
+
"name": "files",
|
|
2347
|
+
"summary": "Comma-separated and in-order JSON files that contain the records, in sObject tree format, that you want to insert.",
|
|
2348
|
+
"delimiter": ",",
|
|
2238
2349
|
"hasDynamicHelp": false,
|
|
2239
|
-
"multiple":
|
|
2240
|
-
"options": [
|
|
2241
|
-
"human",
|
|
2242
|
-
"csv",
|
|
2243
|
-
"json"
|
|
2244
|
-
],
|
|
2350
|
+
"multiple": true,
|
|
2245
2351
|
"type": "option"
|
|
2246
2352
|
},
|
|
2247
|
-
"
|
|
2248
|
-
"
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
"
|
|
2252
|
-
"deprecateAliases": true,
|
|
2253
|
-
"name": "bulk-query-id",
|
|
2254
|
-
"summary": "Job ID of the bulk query.",
|
|
2353
|
+
"plan": {
|
|
2354
|
+
"char": "p",
|
|
2355
|
+
"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",
|
|
2356
|
+
"name": "plan",
|
|
2357
|
+
"summary": "Plan definition file to insert multiple data files.",
|
|
2255
2358
|
"hasDynamicHelp": false,
|
|
2256
2359
|
"multiple": false,
|
|
2257
2360
|
"type": "option"
|
|
2258
|
-
},
|
|
2259
|
-
"use-most-recent": {
|
|
2260
|
-
"name": "use-most-recent",
|
|
2261
|
-
"summary": "Use the most recent bulk query ID from cache.",
|
|
2262
|
-
"allowNo": false,
|
|
2263
|
-
"type": "boolean"
|
|
2264
2361
|
}
|
|
2265
2362
|
},
|
|
2266
2363
|
"hasDynamicHelp": true,
|
|
2267
2364
|
"hiddenAliases": [],
|
|
2268
|
-
"id": "data:
|
|
2365
|
+
"id": "data:import:tree",
|
|
2269
2366
|
"pluginAlias": "@salesforce/plugin-data",
|
|
2270
2367
|
"pluginName": "@salesforce/plugin-data",
|
|
2271
2368
|
"pluginType": "core",
|
|
2272
|
-
"state": "deprecated",
|
|
2273
2369
|
"strict": true,
|
|
2274
|
-
"summary": "
|
|
2370
|
+
"summary": "Import data from one or more JSON files into an org.",
|
|
2275
2371
|
"enableJsonFlag": true,
|
|
2276
2372
|
"isESM": true,
|
|
2277
2373
|
"relativePath": [
|
|
2278
2374
|
"lib",
|
|
2279
2375
|
"commands",
|
|
2280
2376
|
"data",
|
|
2281
|
-
"
|
|
2282
|
-
"
|
|
2377
|
+
"import",
|
|
2378
|
+
"tree.js"
|
|
2283
2379
|
],
|
|
2284
2380
|
"aliasPermutations": [
|
|
2285
|
-
"force:data:
|
|
2286
|
-
"data:force:
|
|
2287
|
-
"data:
|
|
2288
|
-
"data:
|
|
2289
|
-
"
|
|
2290
|
-
"force:
|
|
2291
|
-
"
|
|
2292
|
-
"
|
|
2293
|
-
"
|
|
2294
|
-
"
|
|
2295
|
-
"
|
|
2296
|
-
"
|
|
2297
|
-
"
|
|
2298
|
-
"
|
|
2299
|
-
"
|
|
2300
|
-
"
|
|
2301
|
-
"
|
|
2302
|
-
"
|
|
2303
|
-
"
|
|
2304
|
-
"
|
|
2305
|
-
"force:
|
|
2306
|
-
"
|
|
2307
|
-
"
|
|
2308
|
-
"
|
|
2309
|
-
"data:bulk:soql:report:force",
|
|
2310
|
-
"force:bulk:data:soql:report",
|
|
2311
|
-
"bulk:force:data:soql:report",
|
|
2312
|
-
"bulk:data:force:soql:report",
|
|
2313
|
-
"bulk:data:soql:force:report",
|
|
2314
|
-
"bulk:data:soql:report:force",
|
|
2315
|
-
"force:bulk:soql:data:report",
|
|
2316
|
-
"bulk:force:soql:data:report",
|
|
2317
|
-
"bulk:soql:force:data:report",
|
|
2318
|
-
"bulk:soql:data:force:report",
|
|
2319
|
-
"bulk:soql:data:report:force",
|
|
2320
|
-
"force:bulk:soql:report:data",
|
|
2321
|
-
"bulk:force:soql:report:data",
|
|
2322
|
-
"bulk:soql:force:report:data",
|
|
2323
|
-
"bulk:soql:report:force:data",
|
|
2324
|
-
"bulk:soql:report:data:force",
|
|
2325
|
-
"force:data:bulk:report:soql",
|
|
2326
|
-
"data:force:bulk:report:soql",
|
|
2327
|
-
"data:bulk:force:report:soql",
|
|
2328
|
-
"data:bulk:report:force:soql",
|
|
2329
|
-
"data:bulk:report:soql:force",
|
|
2330
|
-
"force:bulk:data:report:soql",
|
|
2331
|
-
"bulk:force:data:report:soql",
|
|
2332
|
-
"bulk:data:force:report:soql",
|
|
2333
|
-
"bulk:data:report:force:soql",
|
|
2334
|
-
"bulk:data:report:soql:force",
|
|
2335
|
-
"force:bulk:report:data:soql",
|
|
2336
|
-
"bulk:force:report:data:soql",
|
|
2337
|
-
"bulk:report:force:data:soql",
|
|
2338
|
-
"bulk:report:data:force:soql",
|
|
2339
|
-
"bulk:report:data:soql:force",
|
|
2340
|
-
"force:bulk:report:soql:data",
|
|
2341
|
-
"bulk:force:report:soql:data",
|
|
2342
|
-
"bulk:report:force:soql:data",
|
|
2343
|
-
"bulk:report:soql:force:data",
|
|
2344
|
-
"bulk:report:soql:data:force",
|
|
2345
|
-
"force:data:soql:report:bulk",
|
|
2346
|
-
"data:force:soql:report:bulk",
|
|
2347
|
-
"data:soql:force:report:bulk",
|
|
2348
|
-
"data:soql:report:force:bulk",
|
|
2349
|
-
"data:soql:report:bulk:force",
|
|
2350
|
-
"force:soql:data:report:bulk",
|
|
2351
|
-
"soql:force:data:report:bulk",
|
|
2352
|
-
"soql:data:force:report:bulk",
|
|
2353
|
-
"soql:data:report:force:bulk",
|
|
2354
|
-
"soql:data:report:bulk:force",
|
|
2355
|
-
"force:soql:report:data:bulk",
|
|
2356
|
-
"soql:force:report:data:bulk",
|
|
2357
|
-
"soql:report:force:data:bulk",
|
|
2358
|
-
"soql:report:data:force:bulk",
|
|
2359
|
-
"soql:report:data:bulk:force",
|
|
2360
|
-
"force:soql:report:bulk:data",
|
|
2361
|
-
"soql:force:report:bulk:data",
|
|
2362
|
-
"soql:report:force:bulk:data",
|
|
2363
|
-
"soql:report:bulk:force:data",
|
|
2364
|
-
"soql:report:bulk:data:force",
|
|
2365
|
-
"force:data:report:soql:bulk",
|
|
2366
|
-
"data:force:report:soql:bulk",
|
|
2367
|
-
"data:report:force:soql:bulk",
|
|
2368
|
-
"data:report:soql:force:bulk",
|
|
2369
|
-
"data:report:soql:bulk:force",
|
|
2370
|
-
"force:report:data:soql:bulk",
|
|
2371
|
-
"report:force:data:soql:bulk",
|
|
2372
|
-
"report:data:force:soql:bulk",
|
|
2373
|
-
"report:data:soql:force:bulk",
|
|
2374
|
-
"report:data:soql:bulk:force",
|
|
2375
|
-
"force:report:soql:data:bulk",
|
|
2376
|
-
"report:force:soql:data:bulk",
|
|
2377
|
-
"report:soql:force:data:bulk",
|
|
2378
|
-
"report:soql:data:force:bulk",
|
|
2379
|
-
"report:soql:data:bulk:force",
|
|
2380
|
-
"force:report:soql:bulk:data",
|
|
2381
|
-
"report:force:soql:bulk:data",
|
|
2382
|
-
"report:soql:force:bulk:data",
|
|
2383
|
-
"report:soql:bulk:force:data",
|
|
2384
|
-
"report:soql:bulk:data:force",
|
|
2385
|
-
"force:data:report:bulk:soql",
|
|
2386
|
-
"data:force:report:bulk:soql",
|
|
2387
|
-
"data:report:force:bulk:soql",
|
|
2388
|
-
"data:report:bulk:force:soql",
|
|
2389
|
-
"data:report:bulk:soql:force",
|
|
2390
|
-
"force:report:data:bulk:soql",
|
|
2391
|
-
"report:force:data:bulk:soql",
|
|
2392
|
-
"report:data:force:bulk:soql",
|
|
2393
|
-
"report:data:bulk:force:soql",
|
|
2394
|
-
"report:data:bulk:soql:force",
|
|
2395
|
-
"force:report:bulk:data:soql",
|
|
2396
|
-
"report:force:bulk:data:soql",
|
|
2397
|
-
"report:bulk:force:data:soql",
|
|
2398
|
-
"report:bulk:data:force:soql",
|
|
2399
|
-
"report:bulk:data:soql:force",
|
|
2400
|
-
"force:report:bulk:soql:data",
|
|
2401
|
-
"report:force:bulk:soql:data",
|
|
2402
|
-
"report:bulk:force:soql:data",
|
|
2403
|
-
"report:bulk:soql:force:data",
|
|
2404
|
-
"report:bulk:soql:data:force"
|
|
2381
|
+
"force:data:tree:import",
|
|
2382
|
+
"data:force:tree:import",
|
|
2383
|
+
"data:tree:force:import",
|
|
2384
|
+
"data:tree:import:force",
|
|
2385
|
+
"force:tree:data:import",
|
|
2386
|
+
"tree:force:data:import",
|
|
2387
|
+
"tree:data:force:import",
|
|
2388
|
+
"tree:data:import:force",
|
|
2389
|
+
"force:tree:import:data",
|
|
2390
|
+
"tree:force:import:data",
|
|
2391
|
+
"tree:import:force:data",
|
|
2392
|
+
"tree:import:data:force",
|
|
2393
|
+
"force:data:import:tree",
|
|
2394
|
+
"data:force:import:tree",
|
|
2395
|
+
"data:import:force:tree",
|
|
2396
|
+
"data:import:tree:force",
|
|
2397
|
+
"force:import:data:tree",
|
|
2398
|
+
"import:force:data:tree",
|
|
2399
|
+
"import:data:force:tree",
|
|
2400
|
+
"import:data:tree:force",
|
|
2401
|
+
"force:import:tree:data",
|
|
2402
|
+
"import:force:tree:data",
|
|
2403
|
+
"import:tree:force:data",
|
|
2404
|
+
"import:tree:data:force"
|
|
2405
2405
|
],
|
|
2406
2406
|
"permutations": [
|
|
2407
|
-
"data:
|
|
2408
|
-
"
|
|
2409
|
-
"
|
|
2410
|
-
"data:
|
|
2411
|
-
"
|
|
2412
|
-
"
|
|
2407
|
+
"data:import:tree",
|
|
2408
|
+
"import:data:tree",
|
|
2409
|
+
"import:tree:data",
|
|
2410
|
+
"data:tree:import",
|
|
2411
|
+
"tree:data:import",
|
|
2412
|
+
"tree:import:data"
|
|
2413
2413
|
]
|
|
2414
2414
|
},
|
|
2415
2415
|
"data:update:bulk": {
|
|
@@ -3535,5 +3535,5 @@
|
|
|
3535
3535
|
]
|
|
3536
3536
|
}
|
|
3537
3537
|
},
|
|
3538
|
-
"version": "4.0.
|
|
3538
|
+
"version": "4.0.17"
|
|
3539
3539
|
}
|