@salesforce/plugin-data 4.0.28 → 4.0.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/README.md +27 -78
  2. package/lib/bulkDataRequestCache.js +0 -19
  3. package/lib/bulkDataRequestCache.js.map +1 -1
  4. package/lib/commands/data/query.js +3 -83
  5. package/lib/commands/data/query.js.map +1 -1
  6. package/lib/queryUtils.js +0 -22
  7. package/lib/queryUtils.js.map +1 -1
  8. package/messages/soql.query.md +1 -26
  9. package/oclif.manifest.json +346 -637
  10. package/package.json +6 -6
  11. package/lib/commands/data/query/resume.js +0 -67
  12. package/lib/commands/data/query/resume.js.map +0 -1
  13. package/messages/bulk.report.md +0 -21
package/oclif.manifest.json CHANGED
@@ -6,12 +6,11 @@
6
6
  ],
7
7
  "args": {},
8
8
  "deprecateAliases": true,
9
- "description": "Specify the SOQL query at the command line with the --query flag or read the query from a file with the --file flag.\n\nIf your query returns more than 10,000 records, specify the --bulk flag. The command then runs the query using Bulk API 2.0, which has higher limits than the default API used by the command.\n\nWhen using --bulk, the command waits 3 minutes by default for the query to complete. Use the --wait parameter to specify a different number of minutes to wait, or set --wait to 0 to immediately return control to the terminal. If you set --wait to 0, or you use the --async flag, or the command simply times out, the command displays an ID. Pass this ID to the the \"data query resume\" command using the --bulk-query-id flag to get the results; pass the ID to the \"data resume\" command to get the job status.",
9
+ "description": "Specify the SOQL query at the command line with the --query flag or read the query from a file with the --file flag.\n\nIf your query returns more than 10,000 records, prefer to use the `sf data export bulk` command instead. It runs the query using Bulk API 2.0, which has higher limits than the default API used by the command.",
10
10
  "examples": [
11
11
  "Specify a SOQL query at the command line; the command uses your default org:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id, Name, Account.Name FROM Contact\"",
12
12
  "Read the SOQL query from a file called \"query.txt\" and write the CSV-formatted output to a file; the command uses the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --file query.txt --output-file output.csv --result-format csv --target-org my-scratch",
13
- "Use Tooling API to run a query on the ApexTrigger Tooling API object:\n<%= config.bin %> <%= command.id %> --query \"SELECT Name FROM ApexTrigger\" --use-tooling-api",
14
- "Use Bulk API 2.0 to run a query that returns many rows, and return control to the terminal immediately:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id FROM Contact\" --bulk --wait 0"
13
+ "Use Tooling API to run a query on the ApexTrigger Tooling API object:\n<%= config.bin %> <%= command.id %> --query \"SELECT Name FROM ApexTrigger\" --use-tooling-api"
15
14
  ],
16
15
  "flags": {
17
16
  "json": {
@@ -91,51 +90,11 @@
91
90
  ],
92
91
  "char": "t",
93
92
  "deprecateAliases": true,
94
- "exclusive": [
95
- "bulk"
96
- ],
97
93
  "name": "use-tooling-api",
98
94
  "summary": "Use Tooling API so you can run queries on Tooling API objects.",
99
95
  "allowNo": false,
100
96
  "type": "boolean"
101
97
  },
102
- "bulk": {
103
- "char": "b",
104
- "exclusive": [
105
- "use-tooling-api"
106
- ],
107
- "name": "bulk",
108
- "summary": "Use Bulk API 2.0 to run the query.",
109
- "allowNo": false,
110
- "type": "boolean"
111
- },
112
- "wait": {
113
- "char": "w",
114
- "dependsOn": [
115
- "bulk"
116
- ],
117
- "exclusive": [
118
- "async"
119
- ],
120
- "name": "wait",
121
- "summary": "Time to wait for the command to finish, in minutes.",
122
- "hasDynamicHelp": true,
123
- "multiple": false,
124
- "type": "option"
125
- },
126
- "async": {
127
- "dependsOn": [
128
- "bulk"
129
- ],
130
- "deprecated": true,
131
- "exclusive": [
132
- "wait"
133
- ],
134
- "name": "async",
135
- "summary": "Use Bulk API 2.0, but don't wait for the job to complete.",
136
- "allowNo": false,
137
- "type": "boolean"
138
- },
139
98
  "all-rows": {
140
99
  "name": "all-rows",
141
100
  "summary": "Include deleted records. By default, deleted records are not returned.",
@@ -1806,263 +1765,13 @@
1806
1765
  "record:get:data"
1807
1766
  ]
1808
1767
  },
1809
- "data:query:resume": {
1810
- "aliases": [
1811
- "force:data:soql:bulk:report"
1812
- ],
1813
- "args": {},
1814
- "deprecateAliases": true,
1815
- "deprecationOptions": {
1816
- "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"
1817
- },
1818
- "description": "Run this command using the job ID returned from the \"<%= config.bin %> data query --bulk\" command.",
1819
- "examples": [
1820
- "View the status of a bulk query with the specified ID:\n<%= config.bin %> <%= command.id %> --bulk-query-id 7500x000005BdFzXXX"
1821
- ],
1822
- "flags": {
1823
- "json": {
1824
- "description": "Format output as json.",
1825
- "helpGroup": "GLOBAL",
1826
- "name": "json",
1827
- "allowNo": false,
1828
- "type": "boolean"
1829
- },
1830
- "flags-dir": {
1831
- "helpGroup": "GLOBAL",
1832
- "name": "flags-dir",
1833
- "summary": "Import flag values from a directory.",
1834
- "hasDynamicHelp": false,
1835
- "multiple": false,
1836
- "type": "option"
1837
- },
1838
- "target-org": {
1839
- "aliases": [
1840
- "targetusername",
1841
- "u"
1842
- ],
1843
- "char": "o",
1844
- "deprecateAliases": true,
1845
- "name": "target-org",
1846
- "noCacheDefault": true,
1847
- "summary": "Username or alias of the target org.",
1848
- "hasDynamicHelp": true,
1849
- "multiple": false,
1850
- "type": "option"
1851
- },
1852
- "api-version": {
1853
- "aliases": [
1854
- "apiversion"
1855
- ],
1856
- "deprecateAliases": true,
1857
- "description": "Override the api version used for api requests made by this command",
1858
- "name": "api-version",
1859
- "hasDynamicHelp": false,
1860
- "multiple": false,
1861
- "type": "option"
1862
- },
1863
- "loglevel": {
1864
- "deprecated": {
1865
- "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."
1866
- },
1867
- "hidden": true,
1868
- "name": "loglevel",
1869
- "hasDynamicHelp": false,
1870
- "multiple": false,
1871
- "type": "option"
1872
- },
1873
- "result-format": {
1874
- "aliases": [
1875
- "resultformat"
1876
- ],
1877
- "char": "r",
1878
- "deprecateAliases": true,
1879
- "name": "result-format",
1880
- "summary": "Format to display the results; the --json flag overrides this flag.",
1881
- "default": "human",
1882
- "hasDynamicHelp": false,
1883
- "multiple": false,
1884
- "options": [
1885
- "human",
1886
- "csv",
1887
- "json"
1888
- ],
1889
- "type": "option"
1890
- },
1891
- "bulk-query-id": {
1892
- "aliases": [
1893
- "bulkqueryid"
1894
- ],
1895
- "char": "i",
1896
- "deprecateAliases": true,
1897
- "name": "bulk-query-id",
1898
- "summary": "Job ID of the bulk query.",
1899
- "hasDynamicHelp": false,
1900
- "multiple": false,
1901
- "type": "option"
1902
- },
1903
- "use-most-recent": {
1904
- "name": "use-most-recent",
1905
- "summary": "Use the most recent bulk query ID from cache.",
1906
- "allowNo": false,
1907
- "type": "boolean"
1908
- }
1909
- },
1910
- "hasDynamicHelp": true,
1911
- "hiddenAliases": [],
1912
- "id": "data:query:resume",
1913
- "pluginAlias": "@salesforce/plugin-data",
1914
- "pluginName": "@salesforce/plugin-data",
1915
- "pluginType": "core",
1916
- "state": "deprecated",
1917
- "strict": true,
1918
- "summary": "View the status of a bulk query.",
1919
- "enableJsonFlag": true,
1920
- "isESM": true,
1921
- "relativePath": [
1922
- "lib",
1923
- "commands",
1924
- "data",
1925
- "query",
1926
- "resume.js"
1927
- ],
1928
- "aliasPermutations": [
1929
- "force:data:soql:bulk:report",
1930
- "data:force:soql:bulk:report",
1931
- "data:soql:force:bulk:report",
1932
- "data:soql:bulk:force:report",
1933
- "data:soql:bulk:report:force",
1934
- "force:soql:data:bulk:report",
1935
- "soql:force:data:bulk:report",
1936
- "soql:data:force:bulk:report",
1937
- "soql:data:bulk:force:report",
1938
- "soql:data:bulk:report:force",
1939
- "force:soql:bulk:data:report",
1940
- "soql:force:bulk:data:report",
1941
- "soql:bulk:force:data:report",
1942
- "soql:bulk:data:force:report",
1943
- "soql:bulk:data:report:force",
1944
- "force:soql:bulk:report:data",
1945
- "soql:force:bulk:report:data",
1946
- "soql:bulk:force:report:data",
1947
- "soql:bulk:report:force:data",
1948
- "soql:bulk:report:data:force",
1949
- "force:data:bulk:soql:report",
1950
- "data:force:bulk:soql:report",
1951
- "data:bulk:force:soql:report",
1952
- "data:bulk:soql:force:report",
1953
- "data:bulk:soql:report:force",
1954
- "force:bulk:data:soql:report",
1955
- "bulk:force:data:soql:report",
1956
- "bulk:data:force:soql:report",
1957
- "bulk:data:soql:force:report",
1958
- "bulk:data:soql:report:force",
1959
- "force:bulk:soql:data:report",
1960
- "bulk:force:soql:data:report",
1961
- "bulk:soql:force:data:report",
1962
- "bulk:soql:data:force:report",
1963
- "bulk:soql:data:report:force",
1964
- "force:bulk:soql:report:data",
1965
- "bulk:force:soql:report:data",
1966
- "bulk:soql:force:report:data",
1967
- "bulk:soql:report:force:data",
1968
- "bulk:soql:report:data:force",
1969
- "force:data:bulk:report:soql",
1970
- "data:force:bulk:report:soql",
1971
- "data:bulk:force:report:soql",
1972
- "data:bulk:report:force:soql",
1973
- "data:bulk:report:soql:force",
1974
- "force:bulk:data:report:soql",
1975
- "bulk:force:data:report:soql",
1976
- "bulk:data:force:report:soql",
1977
- "bulk:data:report:force:soql",
1978
- "bulk:data:report:soql:force",
1979
- "force:bulk:report:data:soql",
1980
- "bulk:force:report:data:soql",
1981
- "bulk:report:force:data:soql",
1982
- "bulk:report:data:force:soql",
1983
- "bulk:report:data:soql:force",
1984
- "force:bulk:report:soql:data",
1985
- "bulk:force:report:soql:data",
1986
- "bulk:report:force:soql:data",
1987
- "bulk:report:soql:force:data",
1988
- "bulk:report:soql:data:force",
1989
- "force:data:soql:report:bulk",
1990
- "data:force:soql:report:bulk",
1991
- "data:soql:force:report:bulk",
1992
- "data:soql:report:force:bulk",
1993
- "data:soql:report:bulk:force",
1994
- "force:soql:data:report:bulk",
1995
- "soql:force:data:report:bulk",
1996
- "soql:data:force:report:bulk",
1997
- "soql:data:report:force:bulk",
1998
- "soql:data:report:bulk:force",
1999
- "force:soql:report:data:bulk",
2000
- "soql:force:report:data:bulk",
2001
- "soql:report:force:data:bulk",
2002
- "soql:report:data:force:bulk",
2003
- "soql:report:data:bulk:force",
2004
- "force:soql:report:bulk:data",
2005
- "soql:force:report:bulk:data",
2006
- "soql:report:force:bulk:data",
2007
- "soql:report:bulk:force:data",
2008
- "soql:report:bulk:data:force",
2009
- "force:data:report:soql:bulk",
2010
- "data:force:report:soql:bulk",
2011
- "data:report:force:soql:bulk",
2012
- "data:report:soql:force:bulk",
2013
- "data:report:soql:bulk:force",
2014
- "force:report:data:soql:bulk",
2015
- "report:force:data:soql:bulk",
2016
- "report:data:force:soql:bulk",
2017
- "report:data:soql:force:bulk",
2018
- "report:data:soql:bulk:force",
2019
- "force:report:soql:data:bulk",
2020
- "report:force:soql:data:bulk",
2021
- "report:soql:force:data:bulk",
2022
- "report:soql:data:force:bulk",
2023
- "report:soql:data:bulk:force",
2024
- "force:report:soql:bulk:data",
2025
- "report:force:soql:bulk:data",
2026
- "report:soql:force:bulk:data",
2027
- "report:soql:bulk:force:data",
2028
- "report:soql:bulk:data:force",
2029
- "force:data:report:bulk:soql",
2030
- "data:force:report:bulk:soql",
2031
- "data:report:force:bulk:soql",
2032
- "data:report:bulk:force:soql",
2033
- "data:report:bulk:soql:force",
2034
- "force:report:data:bulk:soql",
2035
- "report:force:data:bulk:soql",
2036
- "report:data:force:bulk:soql",
2037
- "report:data:bulk:force:soql",
2038
- "report:data:bulk:soql:force",
2039
- "force:report:bulk:data:soql",
2040
- "report:force:bulk:data:soql",
2041
- "report:bulk:force:data:soql",
2042
- "report:bulk:data:force:soql",
2043
- "report:bulk:data:soql:force",
2044
- "force:report:bulk:soql:data",
2045
- "report:force:bulk:soql:data",
2046
- "report:bulk:force:soql:data",
2047
- "report:bulk:soql:force:data",
2048
- "report:bulk:soql:data:force"
2049
- ],
2050
- "permutations": [
2051
- "data:query:resume",
2052
- "query:data:resume",
2053
- "query:resume:data",
2054
- "data:resume:query",
2055
- "resume:data:query",
2056
- "resume:query:data"
2057
- ]
2058
- },
2059
- "data:update:bulk": {
1768
+ "data:import:bulk": {
2060
1769
  "aliases": [],
2061
1770
  "args": {},
2062
- "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).",
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).",
2063
1772
  "examples": [
2064
- "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",
2065
- "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"
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"
2066
1775
  ],
2067
1776
  "flags": {
2068
1777
  "json": {
@@ -2083,24 +1792,19 @@
2083
1792
  "async": {
2084
1793
  "char": "a",
2085
1794
  "deprecated": true,
1795
+ "exclusive": [
1796
+ "wait"
1797
+ ],
2086
1798
  "name": "async",
2087
1799
  "summary": "Don't wait for the command to complete.",
2088
1800
  "allowNo": false,
2089
1801
  "type": "boolean"
2090
1802
  },
2091
- "wait": {
2092
- "char": "w",
2093
- "name": "wait",
2094
- "summary": "Time to wait for the command to finish, in minutes.",
2095
- "hasDynamicHelp": true,
2096
- "multiple": false,
2097
- "type": "option"
2098
- },
2099
1803
  "file": {
2100
1804
  "char": "f",
2101
1805
  "name": "file",
2102
1806
  "required": true,
2103
- "summary": "CSV file that contains the Salesforce object records you want to update.",
1807
+ "summary": "CSV file that contains the Salesforce object records you want to import.",
2104
1808
  "hasDynamicHelp": false,
2105
1809
  "multiple": false,
2106
1810
  "type": "option"
@@ -2109,7 +1813,7 @@
2109
1813
  "char": "s",
2110
1814
  "name": "sobject",
2111
1815
  "required": true,
2112
- "summary": "API name of the Salesforce object, either standard or custom, which you are updating.",
1816
+ "summary": "API name of the Salesforce object, either standard or custom, into which you're importing records.",
2113
1817
  "hasDynamicHelp": false,
2114
1818
  "multiple": false,
2115
1819
  "type": "option"
@@ -2121,6 +1825,17 @@
2121
1825
  "multiple": false,
2122
1826
  "type": "option"
2123
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
+ },
2124
1839
  "target-org": {
2125
1840
  "char": "o",
2126
1841
  "name": "target-org",
@@ -2163,43 +1878,38 @@
2163
1878
  },
2164
1879
  "hasDynamicHelp": true,
2165
1880
  "hiddenAliases": [],
2166
- "id": "data:update:bulk",
1881
+ "id": "data:import:bulk",
2167
1882
  "pluginAlias": "@salesforce/plugin-data",
2168
1883
  "pluginName": "@salesforce/plugin-data",
2169
1884
  "pluginType": "core",
2170
1885
  "strict": true,
2171
- "summary": "Bulk update records to an org from a CSV file. Uses Bulk API 2.0.",
1886
+ "summary": "Bulk import records into a Salesforce object from a CSV file. Uses Bulk API 2.0.",
2172
1887
  "enableJsonFlag": true,
2173
1888
  "isESM": true,
2174
1889
  "relativePath": [
2175
1890
  "lib",
2176
1891
  "commands",
2177
1892
  "data",
2178
- "update",
1893
+ "import",
2179
1894
  "bulk.js"
2180
1895
  ],
2181
1896
  "aliasPermutations": [],
2182
1897
  "permutations": [
2183
- "data:update:bulk",
2184
- "update:data:bulk",
2185
- "update:bulk:data",
2186
- "data:bulk:update",
2187
- "bulk:data:update",
2188
- "bulk:update:data"
1898
+ "data:import:bulk",
1899
+ "import:data:bulk",
1900
+ "import:bulk:data",
1901
+ "data:bulk:import",
1902
+ "bulk:data:import",
1903
+ "bulk:import:data"
2189
1904
  ]
2190
1905
  },
2191
- "data:update:record": {
2192
- "aliases": [
2193
- "force:data:record:update"
2194
- ],
1906
+ "data:import:resume": {
1907
+ "aliases": [],
2195
1908
  "args": {},
2196
- "deprecateAliases": true,
2197
- "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.",
2198
1910
  "examples": [
2199
- "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\"",
2200
- "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'\"",
2201
- "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\"",
2202
- "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"
2203
1913
  ],
2204
1914
  "flags": {
2205
1915
  "json": {
@@ -2217,165 +1927,67 @@
2217
1927
  "multiple": false,
2218
1928
  "type": "option"
2219
1929
  },
2220
- "target-org": {
2221
- "aliases": [
2222
- "targetusername",
2223
- "u"
2224
- ],
2225
- "char": "o",
2226
- "deprecateAliases": true,
2227
- "name": "target-org",
2228
- "noCacheDefault": true,
2229
- "required": true,
2230
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2231
- "hasDynamicHelp": true,
2232
- "multiple": false,
2233
- "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"
2234
1935
  },
2235
- "api-version": {
2236
- "aliases": [
2237
- "apiversion"
2238
- ],
2239
- "deprecateAliases": true,
2240
- "description": "Override the api version used for api requests made by this command",
2241
- "name": "api-version",
1936
+ "job-id": {
1937
+ "char": "i",
1938
+ "name": "job-id",
1939
+ "summary": "Job ID of the bulk import.",
2242
1940
  "hasDynamicHelp": false,
2243
1941
  "multiple": false,
2244
1942
  "type": "option"
2245
1943
  },
2246
- "loglevel": {
2247
- "deprecated": {
2248
- "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."
2249
- },
2250
- "hidden": true,
2251
- "name": "loglevel",
2252
- "hasDynamicHelp": false,
1944
+ "wait": {
1945
+ "char": "w",
1946
+ "name": "wait",
1947
+ "summary": "Time to wait for the command to finish, in minutes.",
1948
+ "default": "5 minutes",
1949
+ "hasDynamicHelp": true,
2253
1950
  "multiple": false,
2254
1951
  "type": "option"
2255
- },
2256
- "sobject": {
2257
- "aliases": [
2258
- "sobjecttype"
2259
- ],
2260
- "char": "s",
2261
- "deprecateAliases": true,
2262
- "name": "sobject",
2263
- "required": true,
2264
- "summary": "API name of the Salesforce or Tooling API object that contains the record you're updating.",
2265
- "hasDynamicHelp": false,
2266
- "multiple": false,
2267
- "type": "option"
2268
- },
2269
- "record-id": {
2270
- "aliases": [
2271
- "sobjectid"
2272
- ],
2273
- "char": "i",
2274
- "deprecateAliases": true,
2275
- "name": "record-id",
2276
- "summary": "ID of the record you’re updating.",
2277
- "hasDynamicHelp": false,
2278
- "multiple": false,
2279
- "type": "option"
2280
- },
2281
- "where": {
2282
- "char": "w",
2283
- "name": "where",
2284
- "summary": "List of <fieldName>=<value> pairs that identify the record you want to update.",
2285
- "hasDynamicHelp": false,
2286
- "multiple": false,
2287
- "type": "option"
2288
- },
2289
- "values": {
2290
- "char": "v",
2291
- "name": "values",
2292
- "required": true,
2293
- "summary": "Fields that you're updating, in the format of <fieldName>=<value> pairs.",
2294
- "hasDynamicHelp": false,
2295
- "multiple": false,
2296
- "type": "option"
2297
- },
2298
- "use-tooling-api": {
2299
- "aliases": [
2300
- "usetoolingapi"
2301
- ],
2302
- "char": "t",
2303
- "deprecateAliases": true,
2304
- "name": "use-tooling-api",
2305
- "summary": "Use Tooling API so you can update a record in a Tooling API object.",
2306
- "allowNo": false,
2307
- "type": "boolean"
2308
- },
2309
- "perflog": {
2310
- "deprecated": {
2311
- "version": "57"
2312
- },
2313
- "hidden": true,
2314
- "name": "perflog",
2315
- "summary": "Get API performance data.",
2316
- "allowNo": false,
2317
- "type": "boolean"
2318
1952
  }
2319
1953
  },
2320
1954
  "hasDynamicHelp": true,
2321
1955
  "hiddenAliases": [],
2322
- "id": "data:update:record",
1956
+ "id": "data:import:resume",
2323
1957
  "pluginAlias": "@salesforce/plugin-data",
2324
1958
  "pluginName": "@salesforce/plugin-data",
2325
1959
  "pluginType": "core",
2326
1960
  "strict": true,
2327
- "summary": "Updates a single record of a Salesforce or Tooling API object.",
1961
+ "summary": "Resume a bulk import job that you previously started. Uses Bulk API 2.0.",
2328
1962
  "enableJsonFlag": true,
2329
1963
  "isESM": true,
2330
1964
  "relativePath": [
2331
1965
  "lib",
2332
1966
  "commands",
2333
1967
  "data",
2334
- "update",
2335
- "record.js"
2336
- ],
2337
- "aliasPermutations": [
2338
- "force:data:record:update",
2339
- "data:force:record:update",
2340
- "data:record:force:update",
2341
- "data:record:update:force",
2342
- "force:record:data:update",
2343
- "record:force:data:update",
2344
- "record:data:force:update",
2345
- "record:data:update:force",
2346
- "force:record:update:data",
2347
- "record:force:update:data",
2348
- "record:update:force:data",
2349
- "record:update:data:force",
2350
- "force:data:update:record",
2351
- "data:force:update:record",
2352
- "data:update:force:record",
2353
- "data:update:record:force",
2354
- "force:update:data:record",
2355
- "update:force:data:record",
2356
- "update:data:force:record",
2357
- "update:data:record:force",
2358
- "force:update:record:data",
2359
- "update:force:record:data",
2360
- "update:record:force:data",
2361
- "update:record:data:force"
1968
+ "import",
1969
+ "resume.js"
2362
1970
  ],
1971
+ "aliasPermutations": [],
2363
1972
  "permutations": [
2364
- "data:update:record",
2365
- "update:data:record",
2366
- "update:record:data",
2367
- "data:record:update",
2368
- "record:data:update",
2369
- "record:update:data"
1973
+ "data:import:resume",
1974
+ "import:data:resume",
1975
+ "import:resume:data",
1976
+ "data:resume:import",
1977
+ "resume:data:import",
1978
+ "resume:import:data"
2370
1979
  ]
2371
1980
  },
2372
- "data:update:resume": {
2373
- "aliases": [],
1981
+ "data:import:tree": {
1982
+ "aliases": [
1983
+ "force:data:tree:import"
1984
+ ],
2374
1985
  "args": {},
2375
- "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.",
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.",
2376
1988
  "examples": [
2377
- "Resume a bulk update job of your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
2378
- "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"
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"
2379
1991
  ],
2380
1992
  "flags": {
2381
1993
  "json": {
@@ -2393,64 +2005,124 @@
2393
2005
  "multiple": false,
2394
2006
  "type": "option"
2395
2007
  },
2396
- "use-most-recent": {
2397
- "name": "use-most-recent",
2398
- "summary": "Use the job ID of the bulk update job that was most recently run.",
2399
- "allowNo": false,
2400
- "type": "boolean"
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"
2401
2022
  },
2402
- "job-id": {
2403
- "char": "i",
2404
- "name": "job-id",
2405
- "summary": "Job ID of the bulk update.",
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",
2406
2030
  "hasDynamicHelp": false,
2407
2031
  "multiple": false,
2408
2032
  "type": "option"
2409
2033
  },
2410
- "wait": {
2411
- "char": "w",
2412
- "name": "wait",
2413
- "summary": "Time to wait for the command to finish, in minutes.",
2414
- "default": "5 minutes",
2415
- "hasDynamicHelp": true,
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,
2416
2063
  "multiple": false,
2417
2064
  "type": "option"
2418
2065
  }
2419
2066
  },
2420
2067
  "hasDynamicHelp": true,
2421
2068
  "hiddenAliases": [],
2422
- "id": "data:update:resume",
2069
+ "id": "data:import:tree",
2423
2070
  "pluginAlias": "@salesforce/plugin-data",
2424
2071
  "pluginName": "@salesforce/plugin-data",
2425
2072
  "pluginType": "core",
2426
2073
  "strict": true,
2427
- "summary": "Resume a bulk update job that you previously started. Uses Bulk API 2.0.",
2074
+ "summary": "Import data from one or more JSON files into an org.",
2428
2075
  "enableJsonFlag": true,
2429
2076
  "isESM": true,
2430
2077
  "relativePath": [
2431
2078
  "lib",
2432
2079
  "commands",
2433
2080
  "data",
2434
- "update",
2435
- "resume.js"
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"
2436
2109
  ],
2437
- "aliasPermutations": [],
2438
2110
  "permutations": [
2439
- "data:update:resume",
2440
- "update:data:resume",
2441
- "update:resume:data",
2442
- "data:resume:update",
2443
- "resume:data:update",
2444
- "resume:update:data"
2111
+ "data:import:tree",
2112
+ "import:data:tree",
2113
+ "import:tree:data",
2114
+ "data:tree:import",
2115
+ "tree:data:import",
2116
+ "tree:import:data"
2445
2117
  ]
2446
2118
  },
2447
- "data:import:bulk": {
2119
+ "data:update:bulk": {
2448
2120
  "aliases": [],
2449
2121
  "args": {},
2450
- "description": "You can use this command to import millions of records into the object from a file in comma-separated values (CSV) format.\n\nAll the records in the CSV file must be for the same Salesforce object. Specify the object with the `--sobject` flag.\n\nBulk imports can take a while, depending on how many records are in the CSV file. If the command times out, or you specified the --async flag, the command displays the job ID. To see the status and get the results of the job, run \"sf data import resume\" and pass the job ID to the --job-id flag.\n\nFor information and examples about how to prepare your CSV files, see \"Prepare Data to Ingest\" in the \"Bulk API 2.0 and Bulk API Developer Guide\" (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_prepare_data.htm).",
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).",
2451
2123
  "examples": [
2452
- "Import Account records from a CSV-formatted file into an org with alias \"my-scratch\"; if the import doesn't complete in 10 minutes, the command ends and displays a job ID:\n<%= config.bin %> <%= command.id %> --file accounts.csv --sobject Account --wait 10 --target-org my-scratch",
2453
- "Import asynchronously and use the default org; the command immediately returns a job ID that you then pass to the \"sf data import resume\" command:\n<%= config.bin %> <%= command.id %> --file accounts.csv --sobject Account --async"
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"
2454
2126
  ],
2455
2127
  "flags": {
2456
2128
  "json": {
@@ -2471,19 +2143,24 @@
2471
2143
  "async": {
2472
2144
  "char": "a",
2473
2145
  "deprecated": true,
2474
- "exclusive": [
2475
- "wait"
2476
- ],
2477
2146
  "name": "async",
2478
2147
  "summary": "Don't wait for the command to complete.",
2479
2148
  "allowNo": false,
2480
2149
  "type": "boolean"
2481
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
+ },
2482
2159
  "file": {
2483
2160
  "char": "f",
2484
2161
  "name": "file",
2485
2162
  "required": true,
2486
- "summary": "CSV file that contains the Salesforce object records you want to import.",
2163
+ "summary": "CSV file that contains the Salesforce object records you want to update.",
2487
2164
  "hasDynamicHelp": false,
2488
2165
  "multiple": false,
2489
2166
  "type": "option"
@@ -2492,7 +2169,7 @@
2492
2169
  "char": "s",
2493
2170
  "name": "sobject",
2494
2171
  "required": true,
2495
- "summary": "API name of the Salesforce object, either standard or custom, into which you're importing records.",
2172
+ "summary": "API name of the Salesforce object, either standard or custom, which you are updating.",
2496
2173
  "hasDynamicHelp": false,
2497
2174
  "multiple": false,
2498
2175
  "type": "option"
@@ -2504,17 +2181,6 @@
2504
2181
  "multiple": false,
2505
2182
  "type": "option"
2506
2183
  },
2507
- "wait": {
2508
- "char": "w",
2509
- "exclusive": [
2510
- "async"
2511
- ],
2512
- "name": "wait",
2513
- "summary": "Time to wait for the command to finish, in minutes.",
2514
- "hasDynamicHelp": true,
2515
- "multiple": false,
2516
- "type": "option"
2517
- },
2518
2184
  "target-org": {
2519
2185
  "char": "o",
2520
2186
  "name": "target-org",
@@ -2557,38 +2223,43 @@
2557
2223
  },
2558
2224
  "hasDynamicHelp": true,
2559
2225
  "hiddenAliases": [],
2560
- "id": "data:import:bulk",
2226
+ "id": "data:update:bulk",
2561
2227
  "pluginAlias": "@salesforce/plugin-data",
2562
2228
  "pluginName": "@salesforce/plugin-data",
2563
2229
  "pluginType": "core",
2564
2230
  "strict": true,
2565
- "summary": "Bulk import records into a Salesforce object from a CSV file. Uses Bulk API 2.0.",
2231
+ "summary": "Bulk update records to an org from a CSV file. Uses Bulk API 2.0.",
2566
2232
  "enableJsonFlag": true,
2567
2233
  "isESM": true,
2568
2234
  "relativePath": [
2569
2235
  "lib",
2570
2236
  "commands",
2571
2237
  "data",
2572
- "import",
2238
+ "update",
2573
2239
  "bulk.js"
2574
2240
  ],
2575
2241
  "aliasPermutations": [],
2576
2242
  "permutations": [
2577
- "data:import:bulk",
2578
- "import:data:bulk",
2579
- "import:bulk:data",
2580
- "data:bulk:import",
2581
- "bulk:data:import",
2582
- "bulk:import:data"
2243
+ "data:update:bulk",
2244
+ "update:data:bulk",
2245
+ "update:bulk:data",
2246
+ "data:bulk:update",
2247
+ "bulk:data:update",
2248
+ "bulk:update:data"
2583
2249
  ]
2584
2250
  },
2585
- "data:import:resume": {
2586
- "aliases": [],
2251
+ "data:update:record": {
2252
+ "aliases": [
2253
+ "force:data:record:update"
2254
+ ],
2587
2255
  "args": {},
2588
- "description": "When the original \"sf data import bulk\" command either times out or is run with the --async flag, it displays a job ID. To see the status and get the results of the bulk import, run this command by either passing it the job ID or using the --use-most-recent flag to specify the most recent bulk import job.",
2256
+ "deprecateAliases": true,
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.",
2589
2258
  "examples": [
2590
- "Resume a bulk import job to your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
2591
- "Resume the most recently run bulk import job for an org with alias my-scratch:\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-scratch"
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\""
2592
2263
  ],
2593
2264
  "flags": {
2594
2265
  "json": {
@@ -2606,67 +2277,165 @@
2606
2277
  "multiple": false,
2607
2278
  "type": "option"
2608
2279
  },
2609
- "use-most-recent": {
2610
- "name": "use-most-recent",
2611
- "summary": "Use the job ID of the bulk import job that was most recently run.",
2612
- "allowNo": false,
2613
- "type": "boolean"
2280
+ "target-org": {
2281
+ "aliases": [
2282
+ "targetusername",
2283
+ "u"
2284
+ ],
2285
+ "char": "o",
2286
+ "deprecateAliases": true,
2287
+ "name": "target-org",
2288
+ "noCacheDefault": true,
2289
+ "required": true,
2290
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2291
+ "hasDynamicHelp": true,
2292
+ "multiple": false,
2293
+ "type": "option"
2614
2294
  },
2615
- "job-id": {
2295
+ "api-version": {
2296
+ "aliases": [
2297
+ "apiversion"
2298
+ ],
2299
+ "deprecateAliases": true,
2300
+ "description": "Override the api version used for api requests made by this command",
2301
+ "name": "api-version",
2302
+ "hasDynamicHelp": false,
2303
+ "multiple": false,
2304
+ "type": "option"
2305
+ },
2306
+ "loglevel": {
2307
+ "deprecated": {
2308
+ "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."
2309
+ },
2310
+ "hidden": true,
2311
+ "name": "loglevel",
2312
+ "hasDynamicHelp": false,
2313
+ "multiple": false,
2314
+ "type": "option"
2315
+ },
2316
+ "sobject": {
2317
+ "aliases": [
2318
+ "sobjecttype"
2319
+ ],
2320
+ "char": "s",
2321
+ "deprecateAliases": true,
2322
+ "name": "sobject",
2323
+ "required": true,
2324
+ "summary": "API name of the Salesforce or Tooling API object that contains the record you're updating.",
2325
+ "hasDynamicHelp": false,
2326
+ "multiple": false,
2327
+ "type": "option"
2328
+ },
2329
+ "record-id": {
2330
+ "aliases": [
2331
+ "sobjectid"
2332
+ ],
2616
2333
  "char": "i",
2617
- "name": "job-id",
2618
- "summary": "Job ID of the bulk import.",
2334
+ "deprecateAliases": true,
2335
+ "name": "record-id",
2336
+ "summary": "ID of the record you’re updating.",
2619
2337
  "hasDynamicHelp": false,
2620
2338
  "multiple": false,
2621
2339
  "type": "option"
2622
2340
  },
2623
- "wait": {
2341
+ "where": {
2624
2342
  "char": "w",
2625
- "name": "wait",
2626
- "summary": "Time to wait for the command to finish, in minutes.",
2627
- "default": "5 minutes",
2628
- "hasDynamicHelp": true,
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.",
2354
+ "hasDynamicHelp": false,
2629
2355
  "multiple": false,
2630
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"
2631
2378
  }
2632
2379
  },
2633
2380
  "hasDynamicHelp": true,
2634
2381
  "hiddenAliases": [],
2635
- "id": "data:import:resume",
2382
+ "id": "data:update:record",
2636
2383
  "pluginAlias": "@salesforce/plugin-data",
2637
2384
  "pluginName": "@salesforce/plugin-data",
2638
2385
  "pluginType": "core",
2639
2386
  "strict": true,
2640
- "summary": "Resume a bulk import job that you previously started. Uses Bulk API 2.0.",
2387
+ "summary": "Updates a single record of a Salesforce or Tooling API object.",
2641
2388
  "enableJsonFlag": true,
2642
2389
  "isESM": true,
2643
2390
  "relativePath": [
2644
2391
  "lib",
2645
2392
  "commands",
2646
2393
  "data",
2647
- "import",
2648
- "resume.js"
2394
+ "update",
2395
+ "record.js"
2396
+ ],
2397
+ "aliasPermutations": [
2398
+ "force:data:record:update",
2399
+ "data:force:record:update",
2400
+ "data:record:force:update",
2401
+ "data:record:update:force",
2402
+ "force:record:data:update",
2403
+ "record:force:data:update",
2404
+ "record:data:force:update",
2405
+ "record:data:update:force",
2406
+ "force:record:update:data",
2407
+ "record:force:update:data",
2408
+ "record:update:force:data",
2409
+ "record:update:data:force",
2410
+ "force:data:update:record",
2411
+ "data:force:update:record",
2412
+ "data:update:force:record",
2413
+ "data:update:record:force",
2414
+ "force:update:data:record",
2415
+ "update:force:data:record",
2416
+ "update:data:force:record",
2417
+ "update:data:record:force",
2418
+ "force:update:record:data",
2419
+ "update:force:record:data",
2420
+ "update:record:force:data",
2421
+ "update:record:data:force"
2649
2422
  ],
2650
- "aliasPermutations": [],
2651
2423
  "permutations": [
2652
- "data:import:resume",
2653
- "import:data:resume",
2654
- "import:resume:data",
2655
- "data:resume:import",
2656
- "resume:data:import",
2657
- "resume:import:data"
2424
+ "data:update:record",
2425
+ "update:data:record",
2426
+ "update:record:data",
2427
+ "data:record:update",
2428
+ "record:data:update",
2429
+ "record:update:data"
2658
2430
  ]
2659
2431
  },
2660
- "data:import:tree": {
2661
- "aliases": [
2662
- "force:data:tree:import"
2663
- ],
2432
+ "data:update:resume": {
2433
+ "aliases": [],
2664
2434
  "args": {},
2665
- "deprecateAliases": true,
2666
- "description": "The JSON files that contain the data are in sObject tree format, which is a collection of nested, parent-child records with a single root record. Use the \"<%= config.bin %> data export tree\" command to generate these JSON files.\n\nIf you used the --plan flag when exporting the data to generate a plan definition file, use the --plan flag to reference the file when you import. If you're not using a plan, use the --files flag to list the files. If you specify multiple JSON files that depend on each other in a parent-child relationship, be sure you list them in the correct order.",
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.",
2667
2436
  "examples": [
2668
- "Import the records contained in two JSON files into the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --files Contact.json,Account.json --target-org my-scratch",
2669
- "Import records using a plan definition file into your default org:\n<%= config.bin %> <%= command.id %> --plan Account-Contact-plan.json"
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"
2670
2439
  ],
2671
2440
  "flags": {
2672
2441
  "json": {
@@ -2684,115 +2453,55 @@
2684
2453
  "multiple": false,
2685
2454
  "type": "option"
2686
2455
  },
2687
- "target-org": {
2688
- "aliases": [
2689
- "targetusername",
2690
- "u"
2691
- ],
2692
- "char": "o",
2693
- "deprecateAliases": true,
2694
- "name": "target-org",
2695
- "noCacheDefault": true,
2696
- "required": true,
2697
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2698
- "hasDynamicHelp": true,
2699
- "multiple": false,
2700
- "type": "option"
2701
- },
2702
- "api-version": {
2703
- "aliases": [
2704
- "apiversion"
2705
- ],
2706
- "deprecateAliases": true,
2707
- "description": "Override the api version used for api requests made by this command",
2708
- "name": "api-version",
2709
- "hasDynamicHelp": false,
2710
- "multiple": false,
2711
- "type": "option"
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"
2712
2461
  },
2713
- "loglevel": {
2714
- "deprecated": {
2715
- "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."
2716
- },
2717
- "hidden": true,
2718
- "name": "loglevel",
2462
+ "job-id": {
2463
+ "char": "i",
2464
+ "name": "job-id",
2465
+ "summary": "Job ID of the bulk update.",
2719
2466
  "hasDynamicHelp": false,
2720
2467
  "multiple": false,
2721
2468
  "type": "option"
2722
2469
  },
2723
- "files": {
2724
- "aliases": [
2725
- "sobjecttreefiles"
2726
- ],
2727
- "char": "f",
2728
- "deprecateAliases": true,
2729
- "name": "files",
2730
- "summary": "Comma-separated and in-order JSON files that contain the records, in sObject tree format, that you want to insert.",
2731
- "delimiter": ",",
2732
- "hasDynamicHelp": false,
2733
- "multiple": true,
2734
- "type": "option"
2735
- },
2736
- "plan": {
2737
- "char": "p",
2738
- "description": "Unlike when you use the `--files` flag, the files listed in the plan definition file **can** contain more then 200 records. When the CLI executes the import, it automatically batches the records to comply with the 200 record limit set by the API.\n\nThe order in which you list the files in the plan definition file matters. Specifically, records with lookups to records in another file should be listed AFTER that file. For example, let's say you're loading Account and Contact records, and the contacts have references to those accounts. Be sure you list the Accounts file before the Contacts file.\n\nThe plan definition file has the following schema:\n\n- items(object) - SObject Type: Definition of records to be insert per SObject Type\n - sobject(string) - Name of SObject: Child file references must have SObject roots of this type\n - files(array) - Files: An array of files paths to load",
2739
- "name": "plan",
2740
- "summary": "Plan definition file to insert multiple data files.",
2741
- "hasDynamicHelp": false,
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,
2742
2476
  "multiple": false,
2743
2477
  "type": "option"
2744
2478
  }
2745
2479
  },
2746
2480
  "hasDynamicHelp": true,
2747
2481
  "hiddenAliases": [],
2748
- "id": "data:import:tree",
2482
+ "id": "data:update:resume",
2749
2483
  "pluginAlias": "@salesforce/plugin-data",
2750
2484
  "pluginName": "@salesforce/plugin-data",
2751
2485
  "pluginType": "core",
2752
2486
  "strict": true,
2753
- "summary": "Import data from one or more JSON files into an org.",
2487
+ "summary": "Resume a bulk update job that you previously started. Uses Bulk API 2.0.",
2754
2488
  "enableJsonFlag": true,
2755
2489
  "isESM": true,
2756
2490
  "relativePath": [
2757
2491
  "lib",
2758
2492
  "commands",
2759
2493
  "data",
2760
- "import",
2761
- "tree.js"
2762
- ],
2763
- "aliasPermutations": [
2764
- "force:data:tree:import",
2765
- "data:force:tree:import",
2766
- "data:tree:force:import",
2767
- "data:tree:import:force",
2768
- "force:tree:data:import",
2769
- "tree:force:data:import",
2770
- "tree:data:force:import",
2771
- "tree:data:import:force",
2772
- "force:tree:import:data",
2773
- "tree:force:import:data",
2774
- "tree:import:force:data",
2775
- "tree:import:data:force",
2776
- "force:data:import:tree",
2777
- "data:force:import:tree",
2778
- "data:import:force:tree",
2779
- "data:import:tree:force",
2780
- "force:import:data:tree",
2781
- "import:force:data:tree",
2782
- "import:data:force:tree",
2783
- "import:data:tree:force",
2784
- "force:import:tree:data",
2785
- "import:force:tree:data",
2786
- "import:tree:force:data",
2787
- "import:tree:data:force"
2494
+ "update",
2495
+ "resume.js"
2788
2496
  ],
2497
+ "aliasPermutations": [],
2789
2498
  "permutations": [
2790
- "data:import:tree",
2791
- "import:data:tree",
2792
- "import:tree:data",
2793
- "data:tree:import",
2794
- "tree:data:import",
2795
- "tree:import:data"
2499
+ "data:update:resume",
2500
+ "update:data:resume",
2501
+ "update:resume:data",
2502
+ "data:resume:update",
2503
+ "resume:data:update",
2504
+ "resume:update:data"
2796
2505
  ]
2797
2506
  },
2798
2507
  "data:upsert:bulk": {
@@ -3523,5 +3232,5 @@
3523
3232
  ]
3524
3233
  }
3525
3234
  },
3526
- "version": "4.0.28"
3235
+ "version": "4.0.29"
3527
3236
  }