@salesforce/plugin-data 4.0.14 → 4.0.15
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 +534 -534
- package/package.json +6 -6
package/oclif.manifest.json
CHANGED
|
@@ -1639,6 +1639,179 @@
|
|
|
1639
1639
|
"tree:export:data"
|
|
1640
1640
|
]
|
|
1641
1641
|
},
|
|
1642
|
+
"data:get:record": {
|
|
1643
|
+
"aliases": [
|
|
1644
|
+
"force:data:record:get"
|
|
1645
|
+
],
|
|
1646
|
+
"args": {},
|
|
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.",
|
|
1649
|
+
"examples": [
|
|
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"
|
|
1654
|
+
],
|
|
1655
|
+
"flags": {
|
|
1656
|
+
"json": {
|
|
1657
|
+
"description": "Format output as json.",
|
|
1658
|
+
"helpGroup": "GLOBAL",
|
|
1659
|
+
"name": "json",
|
|
1660
|
+
"allowNo": false,
|
|
1661
|
+
"type": "boolean"
|
|
1662
|
+
},
|
|
1663
|
+
"flags-dir": {
|
|
1664
|
+
"helpGroup": "GLOBAL",
|
|
1665
|
+
"name": "flags-dir",
|
|
1666
|
+
"summary": "Import flag values from a directory.",
|
|
1667
|
+
"hasDynamicHelp": false,
|
|
1668
|
+
"multiple": false,
|
|
1669
|
+
"type": "option"
|
|
1670
|
+
},
|
|
1671
|
+
"target-org": {
|
|
1672
|
+
"aliases": [
|
|
1673
|
+
"targetusername",
|
|
1674
|
+
"u"
|
|
1675
|
+
],
|
|
1676
|
+
"char": "o",
|
|
1677
|
+
"deprecateAliases": true,
|
|
1678
|
+
"name": "target-org",
|
|
1679
|
+
"noCacheDefault": true,
|
|
1680
|
+
"required": true,
|
|
1681
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1682
|
+
"hasDynamicHelp": true,
|
|
1683
|
+
"multiple": false,
|
|
1684
|
+
"type": "option"
|
|
1685
|
+
},
|
|
1686
|
+
"api-version": {
|
|
1687
|
+
"aliases": [
|
|
1688
|
+
"apiversion"
|
|
1689
|
+
],
|
|
1690
|
+
"deprecateAliases": true,
|
|
1691
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1692
|
+
"name": "api-version",
|
|
1693
|
+
"hasDynamicHelp": false,
|
|
1694
|
+
"multiple": false,
|
|
1695
|
+
"type": "option"
|
|
1696
|
+
},
|
|
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,
|
|
1704
|
+
"multiple": false,
|
|
1705
|
+
"type": "option"
|
|
1706
|
+
},
|
|
1707
|
+
"sobject": {
|
|
1708
|
+
"aliases": [
|
|
1709
|
+
"sobjecttype"
|
|
1710
|
+
],
|
|
1711
|
+
"char": "s",
|
|
1712
|
+
"deprecateAliases": true,
|
|
1713
|
+
"name": "sobject",
|
|
1714
|
+
"required": true,
|
|
1715
|
+
"summary": "API name of the Salesforce or Tooling API object that you're retrieving a record from.",
|
|
1716
|
+
"hasDynamicHelp": false,
|
|
1717
|
+
"multiple": false,
|
|
1718
|
+
"type": "option"
|
|
1719
|
+
},
|
|
1720
|
+
"record-id": {
|
|
1721
|
+
"aliases": [
|
|
1722
|
+
"sobjectid"
|
|
1723
|
+
],
|
|
1724
|
+
"char": "i",
|
|
1725
|
+
"deprecateAliases": true,
|
|
1726
|
+
"name": "record-id",
|
|
1727
|
+
"summary": "ID of the record you’re retrieving.",
|
|
1728
|
+
"hasDynamicHelp": false,
|
|
1729
|
+
"multiple": false,
|
|
1730
|
+
"type": "option"
|
|
1731
|
+
},
|
|
1732
|
+
"where": {
|
|
1733
|
+
"char": "w",
|
|
1734
|
+
"name": "where",
|
|
1735
|
+
"summary": "List of <fieldName>=<value> pairs that identify the record you want to display.",
|
|
1736
|
+
"hasDynamicHelp": false,
|
|
1737
|
+
"multiple": false,
|
|
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"
|
|
1761
|
+
}
|
|
1762
|
+
},
|
|
1763
|
+
"hasDynamicHelp": true,
|
|
1764
|
+
"hiddenAliases": [],
|
|
1765
|
+
"id": "data:get:record",
|
|
1766
|
+
"pluginAlias": "@salesforce/plugin-data",
|
|
1767
|
+
"pluginName": "@salesforce/plugin-data",
|
|
1768
|
+
"pluginType": "core",
|
|
1769
|
+
"strict": true,
|
|
1770
|
+
"summary": "Retrieve and display a single record of a Salesforce or Tooling API object.",
|
|
1771
|
+
"enableJsonFlag": true,
|
|
1772
|
+
"isESM": true,
|
|
1773
|
+
"relativePath": [
|
|
1774
|
+
"lib",
|
|
1775
|
+
"commands",
|
|
1776
|
+
"data",
|
|
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"
|
|
1805
|
+
],
|
|
1806
|
+
"permutations": [
|
|
1807
|
+
"data:get:record",
|
|
1808
|
+
"get:data:record",
|
|
1809
|
+
"get:record:data",
|
|
1810
|
+
"data:record:get",
|
|
1811
|
+
"record:data:get",
|
|
1812
|
+
"record:get:data"
|
|
1813
|
+
]
|
|
1814
|
+
},
|
|
1642
1815
|
"data:import:bulk": {
|
|
1643
1816
|
"aliases": [],
|
|
1644
1817
|
"args": {},
|
|
@@ -1989,18 +2162,18 @@
|
|
|
1989
2162
|
"tree:import:data"
|
|
1990
2163
|
]
|
|
1991
2164
|
},
|
|
1992
|
-
"data:
|
|
2165
|
+
"data:query:resume": {
|
|
1993
2166
|
"aliases": [
|
|
1994
|
-
"force:data:
|
|
2167
|
+
"force:data:soql:bulk:report"
|
|
1995
2168
|
],
|
|
1996
2169
|
"args": {},
|
|
1997
2170
|
"deprecateAliases": true,
|
|
1998
|
-
"
|
|
2171
|
+
"deprecationOptions": {
|
|
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.",
|
|
1999
2175
|
"examples": [
|
|
2000
|
-
"
|
|
2001
|
-
"Retrieve a record from Account whose name equals \"Acme\":\n<%= config.bin %> <%= command.id %> --sobject Account --where \"Name=Acme\"",
|
|
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"
|
|
2176
|
+
"View the status of a bulk query with the specified ID:\n<%= config.bin %> <%= command.id %> --bulk-query-id 7500x000005BdFzXXX"
|
|
2004
2177
|
],
|
|
2005
2178
|
"flags": {
|
|
2006
2179
|
"json": {
|
|
@@ -2027,8 +2200,7 @@
|
|
|
2027
2200
|
"deprecateAliases": true,
|
|
2028
2201
|
"name": "target-org",
|
|
2029
2202
|
"noCacheDefault": true,
|
|
2030
|
-
"
|
|
2031
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2203
|
+
"summary": "Username or alias of the target org.",
|
|
2032
2204
|
"hasDynamicHelp": true,
|
|
2033
2205
|
"multiple": false,
|
|
2034
2206
|
"type": "option"
|
|
@@ -2054,232 +2226,60 @@
|
|
|
2054
2226
|
"multiple": false,
|
|
2055
2227
|
"type": "option"
|
|
2056
2228
|
},
|
|
2057
|
-
"
|
|
2229
|
+
"result-format": {
|
|
2058
2230
|
"aliases": [
|
|
2059
|
-
"
|
|
2231
|
+
"resultformat"
|
|
2060
2232
|
],
|
|
2061
|
-
"char": "
|
|
2233
|
+
"char": "r",
|
|
2062
2234
|
"deprecateAliases": true,
|
|
2063
|
-
"name": "
|
|
2064
|
-
"
|
|
2065
|
-
"
|
|
2235
|
+
"name": "result-format",
|
|
2236
|
+
"summary": "Format to display the results; the --json flag overrides this flag.",
|
|
2237
|
+
"default": "human",
|
|
2066
2238
|
"hasDynamicHelp": false,
|
|
2067
2239
|
"multiple": false,
|
|
2240
|
+
"options": [
|
|
2241
|
+
"human",
|
|
2242
|
+
"csv",
|
|
2243
|
+
"json"
|
|
2244
|
+
],
|
|
2068
2245
|
"type": "option"
|
|
2069
2246
|
},
|
|
2070
|
-
"
|
|
2247
|
+
"bulk-query-id": {
|
|
2071
2248
|
"aliases": [
|
|
2072
|
-
"
|
|
2249
|
+
"bulkqueryid"
|
|
2073
2250
|
],
|
|
2074
2251
|
"char": "i",
|
|
2075
2252
|
"deprecateAliases": true,
|
|
2076
|
-
"name": "
|
|
2077
|
-
"summary": "ID of the
|
|
2078
|
-
"hasDynamicHelp": false,
|
|
2079
|
-
"multiple": false,
|
|
2080
|
-
"type": "option"
|
|
2081
|
-
},
|
|
2082
|
-
"where": {
|
|
2083
|
-
"char": "w",
|
|
2084
|
-
"name": "where",
|
|
2085
|
-
"summary": "List of <fieldName>=<value> pairs that identify the record you want to display.",
|
|
2253
|
+
"name": "bulk-query-id",
|
|
2254
|
+
"summary": "Job ID of the bulk query.",
|
|
2086
2255
|
"hasDynamicHelp": false,
|
|
2087
2256
|
"multiple": false,
|
|
2088
2257
|
"type": "option"
|
|
2089
2258
|
},
|
|
2090
|
-
"use-
|
|
2091
|
-
"
|
|
2092
|
-
|
|
2093
|
-
],
|
|
2094
|
-
"char": "t",
|
|
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.",
|
|
2259
|
+
"use-most-recent": {
|
|
2260
|
+
"name": "use-most-recent",
|
|
2261
|
+
"summary": "Use the most recent bulk query ID from cache.",
|
|
2109
2262
|
"allowNo": false,
|
|
2110
2263
|
"type": "boolean"
|
|
2111
2264
|
}
|
|
2112
2265
|
},
|
|
2113
2266
|
"hasDynamicHelp": true,
|
|
2114
2267
|
"hiddenAliases": [],
|
|
2115
|
-
"id": "data:
|
|
2268
|
+
"id": "data:query:resume",
|
|
2116
2269
|
"pluginAlias": "@salesforce/plugin-data",
|
|
2117
2270
|
"pluginName": "@salesforce/plugin-data",
|
|
2118
2271
|
"pluginType": "core",
|
|
2272
|
+
"state": "deprecated",
|
|
2119
2273
|
"strict": true,
|
|
2120
|
-
"summary": "
|
|
2274
|
+
"summary": "View the status of a bulk query.",
|
|
2121
2275
|
"enableJsonFlag": true,
|
|
2122
2276
|
"isESM": true,
|
|
2123
2277
|
"relativePath": [
|
|
2124
2278
|
"lib",
|
|
2125
2279
|
"commands",
|
|
2126
2280
|
"data",
|
|
2127
|
-
"
|
|
2128
|
-
"
|
|
2129
|
-
],
|
|
2130
|
-
"aliasPermutations": [
|
|
2131
|
-
"force:data:record:get",
|
|
2132
|
-
"data:force:record:get",
|
|
2133
|
-
"data:record:force:get",
|
|
2134
|
-
"data:record:get:force",
|
|
2135
|
-
"force:record:data:get",
|
|
2136
|
-
"record:force:data:get",
|
|
2137
|
-
"record:data:force:get",
|
|
2138
|
-
"record:data:get:force",
|
|
2139
|
-
"force:record:get:data",
|
|
2140
|
-
"record:force:get:data",
|
|
2141
|
-
"record:get:force:data",
|
|
2142
|
-
"record:get:data:force",
|
|
2143
|
-
"force:data:get:record",
|
|
2144
|
-
"data:force:get:record",
|
|
2145
|
-
"data:get:force:record",
|
|
2146
|
-
"data:get:record:force",
|
|
2147
|
-
"force:get:data:record",
|
|
2148
|
-
"get:force:data:record",
|
|
2149
|
-
"get:data:force:record",
|
|
2150
|
-
"get:data:record:force",
|
|
2151
|
-
"force:get:record:data",
|
|
2152
|
-
"get:force:record:data",
|
|
2153
|
-
"get:record:force:data",
|
|
2154
|
-
"get:record:data:force"
|
|
2155
|
-
],
|
|
2156
|
-
"permutations": [
|
|
2157
|
-
"data:get:record",
|
|
2158
|
-
"get:data:record",
|
|
2159
|
-
"get:record:data",
|
|
2160
|
-
"data:record:get",
|
|
2161
|
-
"record:data:get",
|
|
2162
|
-
"record:get:data"
|
|
2163
|
-
]
|
|
2164
|
-
},
|
|
2165
|
-
"data:query:resume": {
|
|
2166
|
-
"aliases": [
|
|
2167
|
-
"force:data:soql:bulk:report"
|
|
2168
|
-
],
|
|
2169
|
-
"args": {},
|
|
2170
|
-
"deprecateAliases": true,
|
|
2171
|
-
"deprecationOptions": {
|
|
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.",
|
|
2175
|
-
"examples": [
|
|
2176
|
-
"View the status of a bulk query with the specified ID:\n<%= config.bin %> <%= command.id %> --bulk-query-id 7500x000005BdFzXXX"
|
|
2177
|
-
],
|
|
2178
|
-
"flags": {
|
|
2179
|
-
"json": {
|
|
2180
|
-
"description": "Format output as json.",
|
|
2181
|
-
"helpGroup": "GLOBAL",
|
|
2182
|
-
"name": "json",
|
|
2183
|
-
"allowNo": false,
|
|
2184
|
-
"type": "boolean"
|
|
2185
|
-
},
|
|
2186
|
-
"flags-dir": {
|
|
2187
|
-
"helpGroup": "GLOBAL",
|
|
2188
|
-
"name": "flags-dir",
|
|
2189
|
-
"summary": "Import flag values from a directory.",
|
|
2190
|
-
"hasDynamicHelp": false,
|
|
2191
|
-
"multiple": false,
|
|
2192
|
-
"type": "option"
|
|
2193
|
-
},
|
|
2194
|
-
"target-org": {
|
|
2195
|
-
"aliases": [
|
|
2196
|
-
"targetusername",
|
|
2197
|
-
"u"
|
|
2198
|
-
],
|
|
2199
|
-
"char": "o",
|
|
2200
|
-
"deprecateAliases": true,
|
|
2201
|
-
"name": "target-org",
|
|
2202
|
-
"noCacheDefault": true,
|
|
2203
|
-
"summary": "Username or alias of the target org.",
|
|
2204
|
-
"hasDynamicHelp": true,
|
|
2205
|
-
"multiple": false,
|
|
2206
|
-
"type": "option"
|
|
2207
|
-
},
|
|
2208
|
-
"api-version": {
|
|
2209
|
-
"aliases": [
|
|
2210
|
-
"apiversion"
|
|
2211
|
-
],
|
|
2212
|
-
"deprecateAliases": true,
|
|
2213
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2214
|
-
"name": "api-version",
|
|
2215
|
-
"hasDynamicHelp": false,
|
|
2216
|
-
"multiple": false,
|
|
2217
|
-
"type": "option"
|
|
2218
|
-
},
|
|
2219
|
-
"loglevel": {
|
|
2220
|
-
"deprecated": {
|
|
2221
|
-
"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."
|
|
2222
|
-
},
|
|
2223
|
-
"hidden": true,
|
|
2224
|
-
"name": "loglevel",
|
|
2225
|
-
"hasDynamicHelp": false,
|
|
2226
|
-
"multiple": false,
|
|
2227
|
-
"type": "option"
|
|
2228
|
-
},
|
|
2229
|
-
"result-format": {
|
|
2230
|
-
"aliases": [
|
|
2231
|
-
"resultformat"
|
|
2232
|
-
],
|
|
2233
|
-
"char": "r",
|
|
2234
|
-
"deprecateAliases": true,
|
|
2235
|
-
"name": "result-format",
|
|
2236
|
-
"summary": "Format to display the results; the --json flag overrides this flag.",
|
|
2237
|
-
"default": "human",
|
|
2238
|
-
"hasDynamicHelp": false,
|
|
2239
|
-
"multiple": false,
|
|
2240
|
-
"options": [
|
|
2241
|
-
"human",
|
|
2242
|
-
"csv",
|
|
2243
|
-
"json"
|
|
2244
|
-
],
|
|
2245
|
-
"type": "option"
|
|
2246
|
-
},
|
|
2247
|
-
"bulk-query-id": {
|
|
2248
|
-
"aliases": [
|
|
2249
|
-
"bulkqueryid"
|
|
2250
|
-
],
|
|
2251
|
-
"char": "i",
|
|
2252
|
-
"deprecateAliases": true,
|
|
2253
|
-
"name": "bulk-query-id",
|
|
2254
|
-
"summary": "Job ID of the bulk query.",
|
|
2255
|
-
"hasDynamicHelp": false,
|
|
2256
|
-
"multiple": false,
|
|
2257
|
-
"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
|
-
}
|
|
2265
|
-
},
|
|
2266
|
-
"hasDynamicHelp": true,
|
|
2267
|
-
"hiddenAliases": [],
|
|
2268
|
-
"id": "data:query:resume",
|
|
2269
|
-
"pluginAlias": "@salesforce/plugin-data",
|
|
2270
|
-
"pluginName": "@salesforce/plugin-data",
|
|
2271
|
-
"pluginType": "core",
|
|
2272
|
-
"state": "deprecated",
|
|
2273
|
-
"strict": true,
|
|
2274
|
-
"summary": "View the status of a bulk query.",
|
|
2275
|
-
"enableJsonFlag": true,
|
|
2276
|
-
"isESM": true,
|
|
2277
|
-
"relativePath": [
|
|
2278
|
-
"lib",
|
|
2279
|
-
"commands",
|
|
2280
|
-
"data",
|
|
2281
|
-
"query",
|
|
2282
|
-
"resume.js"
|
|
2281
|
+
"query",
|
|
2282
|
+
"resume.js"
|
|
2283
2283
|
],
|
|
2284
2284
|
"aliasPermutations": [
|
|
2285
2285
|
"force:data:soql:bulk:report",
|
|
@@ -2412,13 +2412,13 @@
|
|
|
2412
2412
|
"resume:query:data"
|
|
2413
2413
|
]
|
|
2414
2414
|
},
|
|
2415
|
-
"data:
|
|
2415
|
+
"data:update:bulk": {
|
|
2416
2416
|
"aliases": [],
|
|
2417
2417
|
"args": {},
|
|
2418
|
-
"description": "
|
|
2418
|
+
"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).",
|
|
2419
2419
|
"examples": [
|
|
2420
|
-
"
|
|
2421
|
-
"
|
|
2420
|
+
"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",
|
|
2421
|
+
"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"
|
|
2422
2422
|
],
|
|
2423
2423
|
"flags": {
|
|
2424
2424
|
"json": {
|
|
@@ -2436,354 +2436,55 @@
|
|
|
2436
2436
|
"multiple": false,
|
|
2437
2437
|
"type": "option"
|
|
2438
2438
|
},
|
|
2439
|
-
"
|
|
2440
|
-
"
|
|
2441
|
-
|
|
2442
|
-
|
|
2443
|
-
|
|
2444
|
-
"
|
|
2445
|
-
"deprecateAliases": true,
|
|
2446
|
-
"name": "target-org",
|
|
2447
|
-
"noCacheDefault": true,
|
|
2448
|
-
"required": true,
|
|
2449
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2450
|
-
"hasDynamicHelp": true,
|
|
2451
|
-
"multiple": false,
|
|
2452
|
-
"type": "option"
|
|
2453
|
-
},
|
|
2454
|
-
"api-version": {
|
|
2455
|
-
"aliases": [
|
|
2456
|
-
"apiversion"
|
|
2457
|
-
],
|
|
2458
|
-
"deprecateAliases": true,
|
|
2459
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2460
|
-
"name": "api-version",
|
|
2461
|
-
"hasDynamicHelp": false,
|
|
2462
|
-
"multiple": false,
|
|
2463
|
-
"type": "option"
|
|
2439
|
+
"async": {
|
|
2440
|
+
"char": "a",
|
|
2441
|
+
"name": "async",
|
|
2442
|
+
"summary": "Don't wait for the command to complete.",
|
|
2443
|
+
"allowNo": false,
|
|
2444
|
+
"type": "boolean"
|
|
2464
2445
|
},
|
|
2465
|
-
"
|
|
2466
|
-
"
|
|
2467
|
-
|
|
2468
|
-
|
|
2469
|
-
"
|
|
2470
|
-
"name": "loglevel",
|
|
2471
|
-
"hasDynamicHelp": false,
|
|
2446
|
+
"wait": {
|
|
2447
|
+
"char": "w",
|
|
2448
|
+
"name": "wait",
|
|
2449
|
+
"summary": "Time to wait for the command to finish, in minutes.",
|
|
2450
|
+
"hasDynamicHelp": true,
|
|
2472
2451
|
"multiple": false,
|
|
2473
2452
|
"type": "option"
|
|
2474
2453
|
},
|
|
2475
2454
|
"file": {
|
|
2476
|
-
"aliases": [
|
|
2477
|
-
"csvfile"
|
|
2478
|
-
],
|
|
2479
2455
|
"char": "f",
|
|
2480
|
-
"deprecateAliases": true,
|
|
2481
2456
|
"name": "file",
|
|
2482
2457
|
"required": true,
|
|
2483
|
-
"summary": "CSV file that contains the
|
|
2458
|
+
"summary": "CSV file that contains the Salesforce object records you want to update.",
|
|
2484
2459
|
"hasDynamicHelp": false,
|
|
2485
2460
|
"multiple": false,
|
|
2486
2461
|
"type": "option"
|
|
2487
2462
|
},
|
|
2488
2463
|
"sobject": {
|
|
2489
|
-
"aliases": [
|
|
2490
|
-
"sobjecttype"
|
|
2491
|
-
],
|
|
2492
2464
|
"char": "s",
|
|
2493
|
-
"deprecateAliases": true,
|
|
2494
2465
|
"name": "sobject",
|
|
2495
2466
|
"required": true,
|
|
2496
|
-
"summary": "API name of the Salesforce object, either standard or custom,
|
|
2467
|
+
"summary": "API name of the Salesforce object, either standard or custom, which you are updating.",
|
|
2497
2468
|
"hasDynamicHelp": false,
|
|
2498
2469
|
"multiple": false,
|
|
2499
2470
|
"type": "option"
|
|
2500
2471
|
},
|
|
2501
|
-
"
|
|
2502
|
-
"
|
|
2503
|
-
"
|
|
2504
|
-
|
|
2505
|
-
],
|
|
2506
|
-
"name": "wait",
|
|
2507
|
-
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
2508
|
-
"default": "0 minutes",
|
|
2509
|
-
"hasDynamicHelp": true,
|
|
2472
|
+
"api-version": {
|
|
2473
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2474
|
+
"name": "api-version",
|
|
2475
|
+
"hasDynamicHelp": false,
|
|
2510
2476
|
"multiple": false,
|
|
2511
2477
|
"type": "option"
|
|
2512
2478
|
},
|
|
2513
|
-
"
|
|
2514
|
-
"char": "
|
|
2515
|
-
"
|
|
2516
|
-
|
|
2517
|
-
|
|
2518
|
-
"
|
|
2519
|
-
"
|
|
2520
|
-
"
|
|
2521
|
-
"type": "
|
|
2522
|
-
},
|
|
2523
|
-
"verbose": {
|
|
2524
|
-
"deprecated": {
|
|
2525
|
-
"message": "The --verbose flag is deprecated and will be removed after March 2025, use \"sf data bulk results\" to get job results instead."
|
|
2526
|
-
},
|
|
2527
|
-
"name": "verbose",
|
|
2528
|
-
"summary": "Print verbose output of failed records if result is available.",
|
|
2529
|
-
"allowNo": false,
|
|
2530
|
-
"type": "boolean"
|
|
2531
|
-
},
|
|
2532
|
-
"line-ending": {
|
|
2533
|
-
"dependsOn": [
|
|
2534
|
-
"file"
|
|
2535
|
-
],
|
|
2536
|
-
"name": "line-ending",
|
|
2537
|
-
"summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LF`.",
|
|
2538
|
-
"hasDynamicHelp": false,
|
|
2539
|
-
"multiple": false,
|
|
2540
|
-
"options": [
|
|
2541
|
-
"CRLF",
|
|
2542
|
-
"LF"
|
|
2543
|
-
],
|
|
2544
|
-
"type": "option"
|
|
2545
|
-
},
|
|
2546
|
-
"column-delimiter": {
|
|
2547
|
-
"name": "column-delimiter",
|
|
2548
|
-
"summary": "Column delimiter used in the CSV file.",
|
|
2549
|
-
"hasDynamicHelp": false,
|
|
2550
|
-
"multiple": false,
|
|
2551
|
-
"options": [
|
|
2552
|
-
"BACKQUOTE",
|
|
2553
|
-
"CARET",
|
|
2554
|
-
"COMMA",
|
|
2555
|
-
"PIPE",
|
|
2556
|
-
"SEMICOLON",
|
|
2557
|
-
"TAB"
|
|
2558
|
-
],
|
|
2559
|
-
"type": "option"
|
|
2560
|
-
},
|
|
2561
|
-
"external-id": {
|
|
2562
|
-
"aliases": [
|
|
2563
|
-
"externalid"
|
|
2564
|
-
],
|
|
2565
|
-
"char": "i",
|
|
2566
|
-
"deprecateAliases": true,
|
|
2567
|
-
"name": "external-id",
|
|
2568
|
-
"required": true,
|
|
2569
|
-
"summary": "Name of the external ID field, or the Id field.",
|
|
2570
|
-
"hasDynamicHelp": false,
|
|
2571
|
-
"multiple": false,
|
|
2572
|
-
"type": "option"
|
|
2573
|
-
}
|
|
2574
|
-
},
|
|
2575
|
-
"hasDynamicHelp": true,
|
|
2576
|
-
"hiddenAliases": [],
|
|
2577
|
-
"id": "data:upsert:bulk",
|
|
2578
|
-
"pluginAlias": "@salesforce/plugin-data",
|
|
2579
|
-
"pluginName": "@salesforce/plugin-data",
|
|
2580
|
-
"pluginType": "core",
|
|
2581
|
-
"strict": true,
|
|
2582
|
-
"summary": "Bulk upsert records to an org from a CSV file. Uses Bulk API 2.0.",
|
|
2583
|
-
"enableJsonFlag": true,
|
|
2584
|
-
"isESM": true,
|
|
2585
|
-
"relativePath": [
|
|
2586
|
-
"lib",
|
|
2587
|
-
"commands",
|
|
2588
|
-
"data",
|
|
2589
|
-
"upsert",
|
|
2590
|
-
"bulk.js"
|
|
2591
|
-
],
|
|
2592
|
-
"aliasPermutations": [],
|
|
2593
|
-
"permutations": [
|
|
2594
|
-
"data:upsert:bulk",
|
|
2595
|
-
"upsert:data:bulk",
|
|
2596
|
-
"upsert:bulk:data",
|
|
2597
|
-
"data:bulk:upsert",
|
|
2598
|
-
"bulk:data:upsert",
|
|
2599
|
-
"bulk:upsert:data"
|
|
2600
|
-
]
|
|
2601
|
-
},
|
|
2602
|
-
"data:upsert:resume": {
|
|
2603
|
-
"aliases": [],
|
|
2604
|
-
"args": {},
|
|
2605
|
-
"description": "The command uses the job ID returned from the \"<%= config.bin %> data upsert bulk\" command or the most recently-run bulk upsert job.",
|
|
2606
|
-
"examples": [
|
|
2607
|
-
"Resume a bulk upsert job from your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
|
|
2608
|
-
"Resume the most recently run bulk upsert job for an org with alias my-scratch:\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-scratch"
|
|
2609
|
-
],
|
|
2610
|
-
"flags": {
|
|
2611
|
-
"json": {
|
|
2612
|
-
"description": "Format output as json.",
|
|
2613
|
-
"helpGroup": "GLOBAL",
|
|
2614
|
-
"name": "json",
|
|
2615
|
-
"allowNo": false,
|
|
2616
|
-
"type": "boolean"
|
|
2617
|
-
},
|
|
2618
|
-
"flags-dir": {
|
|
2619
|
-
"helpGroup": "GLOBAL",
|
|
2620
|
-
"name": "flags-dir",
|
|
2621
|
-
"summary": "Import flag values from a directory.",
|
|
2622
|
-
"hasDynamicHelp": false,
|
|
2623
|
-
"multiple": false,
|
|
2624
|
-
"type": "option"
|
|
2625
|
-
},
|
|
2626
|
-
"target-org": {
|
|
2627
|
-
"aliases": [
|
|
2628
|
-
"targetusername",
|
|
2629
|
-
"u"
|
|
2630
|
-
],
|
|
2631
|
-
"char": "o",
|
|
2632
|
-
"deprecateAliases": true,
|
|
2633
|
-
"name": "target-org",
|
|
2634
|
-
"noCacheDefault": true,
|
|
2635
|
-
"summary": "Username or alias of the target org. Not required if the \"target-org\" configuration variable is already set.",
|
|
2636
|
-
"hasDynamicHelp": true,
|
|
2637
|
-
"multiple": false,
|
|
2638
|
-
"type": "option"
|
|
2639
|
-
},
|
|
2640
|
-
"job-id": {
|
|
2641
|
-
"aliases": [
|
|
2642
|
-
"jobid"
|
|
2643
|
-
],
|
|
2644
|
-
"char": "i",
|
|
2645
|
-
"deprecateAliases": true,
|
|
2646
|
-
"name": "job-id",
|
|
2647
|
-
"summary": "ID of the job you want to resume.",
|
|
2648
|
-
"hasDynamicHelp": false,
|
|
2649
|
-
"multiple": false,
|
|
2650
|
-
"type": "option"
|
|
2651
|
-
},
|
|
2652
|
-
"use-most-recent": {
|
|
2653
|
-
"exclusive": [
|
|
2654
|
-
"job-id"
|
|
2655
|
-
],
|
|
2656
|
-
"name": "use-most-recent",
|
|
2657
|
-
"summary": "Use the ID of the most recently-run bulk job.",
|
|
2658
|
-
"allowNo": false,
|
|
2659
|
-
"type": "boolean"
|
|
2660
|
-
},
|
|
2661
|
-
"wait": {
|
|
2662
|
-
"name": "wait",
|
|
2663
|
-
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
2664
|
-
"default": "5 minutes",
|
|
2665
|
-
"hasDynamicHelp": true,
|
|
2666
|
-
"multiple": false,
|
|
2667
|
-
"type": "option"
|
|
2668
|
-
},
|
|
2669
|
-
"api-version": {
|
|
2670
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2671
|
-
"name": "api-version",
|
|
2672
|
-
"hasDynamicHelp": false,
|
|
2673
|
-
"multiple": false,
|
|
2674
|
-
"type": "option"
|
|
2675
|
-
},
|
|
2676
|
-
"loglevel": {
|
|
2677
|
-
"deprecated": {
|
|
2678
|
-
"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."
|
|
2679
|
-
},
|
|
2680
|
-
"hidden": true,
|
|
2681
|
-
"name": "loglevel",
|
|
2682
|
-
"hasDynamicHelp": false,
|
|
2683
|
-
"multiple": false,
|
|
2684
|
-
"type": "option"
|
|
2685
|
-
}
|
|
2686
|
-
},
|
|
2687
|
-
"hasDynamicHelp": true,
|
|
2688
|
-
"hiddenAliases": [],
|
|
2689
|
-
"id": "data:upsert:resume",
|
|
2690
|
-
"pluginAlias": "@salesforce/plugin-data",
|
|
2691
|
-
"pluginName": "@salesforce/plugin-data",
|
|
2692
|
-
"pluginType": "core",
|
|
2693
|
-
"strict": true,
|
|
2694
|
-
"summary": "Resume a bulk upsert job that you previously started. Uses Bulk API 2.0.",
|
|
2695
|
-
"enableJsonFlag": true,
|
|
2696
|
-
"isESM": true,
|
|
2697
|
-
"relativePath": [
|
|
2698
|
-
"lib",
|
|
2699
|
-
"commands",
|
|
2700
|
-
"data",
|
|
2701
|
-
"upsert",
|
|
2702
|
-
"resume.js"
|
|
2703
|
-
],
|
|
2704
|
-
"aliasPermutations": [],
|
|
2705
|
-
"permutations": [
|
|
2706
|
-
"data:upsert:resume",
|
|
2707
|
-
"upsert:data:resume",
|
|
2708
|
-
"upsert:resume:data",
|
|
2709
|
-
"data:resume:upsert",
|
|
2710
|
-
"resume:data:upsert",
|
|
2711
|
-
"resume:upsert:data"
|
|
2712
|
-
]
|
|
2713
|
-
},
|
|
2714
|
-
"data:update:bulk": {
|
|
2715
|
-
"aliases": [],
|
|
2716
|
-
"args": {},
|
|
2717
|
-
"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).",
|
|
2718
|
-
"examples": [
|
|
2719
|
-
"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",
|
|
2720
|
-
"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"
|
|
2721
|
-
],
|
|
2722
|
-
"flags": {
|
|
2723
|
-
"json": {
|
|
2724
|
-
"description": "Format output as json.",
|
|
2725
|
-
"helpGroup": "GLOBAL",
|
|
2726
|
-
"name": "json",
|
|
2727
|
-
"allowNo": false,
|
|
2728
|
-
"type": "boolean"
|
|
2729
|
-
},
|
|
2730
|
-
"flags-dir": {
|
|
2731
|
-
"helpGroup": "GLOBAL",
|
|
2732
|
-
"name": "flags-dir",
|
|
2733
|
-
"summary": "Import flag values from a directory.",
|
|
2734
|
-
"hasDynamicHelp": false,
|
|
2735
|
-
"multiple": false,
|
|
2736
|
-
"type": "option"
|
|
2737
|
-
},
|
|
2738
|
-
"async": {
|
|
2739
|
-
"char": "a",
|
|
2740
|
-
"name": "async",
|
|
2741
|
-
"summary": "Don't wait for the command to complete.",
|
|
2742
|
-
"allowNo": false,
|
|
2743
|
-
"type": "boolean"
|
|
2744
|
-
},
|
|
2745
|
-
"wait": {
|
|
2746
|
-
"char": "w",
|
|
2747
|
-
"name": "wait",
|
|
2748
|
-
"summary": "Time to wait for the command to finish, in minutes.",
|
|
2749
|
-
"hasDynamicHelp": true,
|
|
2750
|
-
"multiple": false,
|
|
2751
|
-
"type": "option"
|
|
2752
|
-
},
|
|
2753
|
-
"file": {
|
|
2754
|
-
"char": "f",
|
|
2755
|
-
"name": "file",
|
|
2756
|
-
"required": true,
|
|
2757
|
-
"summary": "CSV file that contains the Salesforce object records you want to update.",
|
|
2758
|
-
"hasDynamicHelp": false,
|
|
2759
|
-
"multiple": false,
|
|
2760
|
-
"type": "option"
|
|
2761
|
-
},
|
|
2762
|
-
"sobject": {
|
|
2763
|
-
"char": "s",
|
|
2764
|
-
"name": "sobject",
|
|
2765
|
-
"required": true,
|
|
2766
|
-
"summary": "API name of the Salesforce object, either standard or custom, which you are updating.",
|
|
2767
|
-
"hasDynamicHelp": false,
|
|
2768
|
-
"multiple": false,
|
|
2769
|
-
"type": "option"
|
|
2770
|
-
},
|
|
2771
|
-
"api-version": {
|
|
2772
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2773
|
-
"name": "api-version",
|
|
2774
|
-
"hasDynamicHelp": false,
|
|
2775
|
-
"multiple": false,
|
|
2776
|
-
"type": "option"
|
|
2777
|
-
},
|
|
2778
|
-
"target-org": {
|
|
2779
|
-
"char": "o",
|
|
2780
|
-
"name": "target-org",
|
|
2781
|
-
"noCacheDefault": true,
|
|
2782
|
-
"required": true,
|
|
2783
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2784
|
-
"hasDynamicHelp": true,
|
|
2785
|
-
"multiple": false,
|
|
2786
|
-
"type": "option"
|
|
2479
|
+
"target-org": {
|
|
2480
|
+
"char": "o",
|
|
2481
|
+
"name": "target-org",
|
|
2482
|
+
"noCacheDefault": true,
|
|
2483
|
+
"required": true,
|
|
2484
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2485
|
+
"hasDynamicHelp": true,
|
|
2486
|
+
"multiple": false,
|
|
2487
|
+
"type": "option"
|
|
2787
2488
|
},
|
|
2788
2489
|
"line-ending": {
|
|
2789
2490
|
"dependsOn": [
|
|
@@ -3098,6 +2799,305 @@
|
|
|
3098
2799
|
"resume:update:data"
|
|
3099
2800
|
]
|
|
3100
2801
|
},
|
|
2802
|
+
"data:upsert:bulk": {
|
|
2803
|
+
"aliases": [],
|
|
2804
|
+
"args": {},
|
|
2805
|
+
"description": "An upsert refers to inserting a record into a Salesforce object if the record doesn't already exist, or updating it if it does exist.\n\nWhen you execute this command, it starts a job, displays the ID, and then immediately returns control of the terminal to you by default. If you prefer to wait, set the --wait flag to the number of minutes; if it times out, the command outputs the IDs. Use the job and batch IDs to check the status of the job with the \"<%= config.bin %> data upsert resume\" command.\n\nSee \"Prepare CSV Files\" in the Bulk API Developer Guide for details on formatting your CSV file. (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_prepare_csv.htm)",
|
|
2806
|
+
"examples": [
|
|
2807
|
+
"Bulk upsert records to the Contact object in your default org:\n<%= config.bin %> <%= command.id %> --sobject Contact --file files/contacts.csv --external-id Id",
|
|
2808
|
+
"Bulk upsert records to a custom object in an org with alias my-scratch and wait 5 minutes for the command to complete:\n<%= config.bin %> <%= command.id %> --sobject MyObject__c --file files/file.csv --external-id MyField__c --wait 5 --target-org my-scratch"
|
|
2809
|
+
],
|
|
2810
|
+
"flags": {
|
|
2811
|
+
"json": {
|
|
2812
|
+
"description": "Format output as json.",
|
|
2813
|
+
"helpGroup": "GLOBAL",
|
|
2814
|
+
"name": "json",
|
|
2815
|
+
"allowNo": false,
|
|
2816
|
+
"type": "boolean"
|
|
2817
|
+
},
|
|
2818
|
+
"flags-dir": {
|
|
2819
|
+
"helpGroup": "GLOBAL",
|
|
2820
|
+
"name": "flags-dir",
|
|
2821
|
+
"summary": "Import flag values from a directory.",
|
|
2822
|
+
"hasDynamicHelp": false,
|
|
2823
|
+
"multiple": false,
|
|
2824
|
+
"type": "option"
|
|
2825
|
+
},
|
|
2826
|
+
"target-org": {
|
|
2827
|
+
"aliases": [
|
|
2828
|
+
"targetusername",
|
|
2829
|
+
"u"
|
|
2830
|
+
],
|
|
2831
|
+
"char": "o",
|
|
2832
|
+
"deprecateAliases": true,
|
|
2833
|
+
"name": "target-org",
|
|
2834
|
+
"noCacheDefault": true,
|
|
2835
|
+
"required": true,
|
|
2836
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2837
|
+
"hasDynamicHelp": true,
|
|
2838
|
+
"multiple": false,
|
|
2839
|
+
"type": "option"
|
|
2840
|
+
},
|
|
2841
|
+
"api-version": {
|
|
2842
|
+
"aliases": [
|
|
2843
|
+
"apiversion"
|
|
2844
|
+
],
|
|
2845
|
+
"deprecateAliases": true,
|
|
2846
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2847
|
+
"name": "api-version",
|
|
2848
|
+
"hasDynamicHelp": false,
|
|
2849
|
+
"multiple": false,
|
|
2850
|
+
"type": "option"
|
|
2851
|
+
},
|
|
2852
|
+
"loglevel": {
|
|
2853
|
+
"deprecated": {
|
|
2854
|
+
"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."
|
|
2855
|
+
},
|
|
2856
|
+
"hidden": true,
|
|
2857
|
+
"name": "loglevel",
|
|
2858
|
+
"hasDynamicHelp": false,
|
|
2859
|
+
"multiple": false,
|
|
2860
|
+
"type": "option"
|
|
2861
|
+
},
|
|
2862
|
+
"file": {
|
|
2863
|
+
"aliases": [
|
|
2864
|
+
"csvfile"
|
|
2865
|
+
],
|
|
2866
|
+
"char": "f",
|
|
2867
|
+
"deprecateAliases": true,
|
|
2868
|
+
"name": "file",
|
|
2869
|
+
"required": true,
|
|
2870
|
+
"summary": "CSV file that contains the IDs of the records to update or delete.",
|
|
2871
|
+
"hasDynamicHelp": false,
|
|
2872
|
+
"multiple": false,
|
|
2873
|
+
"type": "option"
|
|
2874
|
+
},
|
|
2875
|
+
"sobject": {
|
|
2876
|
+
"aliases": [
|
|
2877
|
+
"sobjecttype"
|
|
2878
|
+
],
|
|
2879
|
+
"char": "s",
|
|
2880
|
+
"deprecateAliases": true,
|
|
2881
|
+
"name": "sobject",
|
|
2882
|
+
"required": true,
|
|
2883
|
+
"summary": "API name of the Salesforce object, either standard or custom, that you want to update or delete records from.",
|
|
2884
|
+
"hasDynamicHelp": false,
|
|
2885
|
+
"multiple": false,
|
|
2886
|
+
"type": "option"
|
|
2887
|
+
},
|
|
2888
|
+
"wait": {
|
|
2889
|
+
"char": "w",
|
|
2890
|
+
"exclusive": [
|
|
2891
|
+
"async"
|
|
2892
|
+
],
|
|
2893
|
+
"name": "wait",
|
|
2894
|
+
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
2895
|
+
"default": "0 minutes",
|
|
2896
|
+
"hasDynamicHelp": true,
|
|
2897
|
+
"multiple": false,
|
|
2898
|
+
"type": "option"
|
|
2899
|
+
},
|
|
2900
|
+
"async": {
|
|
2901
|
+
"char": "a",
|
|
2902
|
+
"exclusive": [
|
|
2903
|
+
"wait"
|
|
2904
|
+
],
|
|
2905
|
+
"name": "async",
|
|
2906
|
+
"summary": "Run the command asynchronously.",
|
|
2907
|
+
"allowNo": false,
|
|
2908
|
+
"type": "boolean"
|
|
2909
|
+
},
|
|
2910
|
+
"verbose": {
|
|
2911
|
+
"deprecated": {
|
|
2912
|
+
"message": "The --verbose flag is deprecated and will be removed after March 2025, use \"sf data bulk results\" to get job results instead."
|
|
2913
|
+
},
|
|
2914
|
+
"name": "verbose",
|
|
2915
|
+
"summary": "Print verbose output of failed records if result is available.",
|
|
2916
|
+
"allowNo": false,
|
|
2917
|
+
"type": "boolean"
|
|
2918
|
+
},
|
|
2919
|
+
"line-ending": {
|
|
2920
|
+
"dependsOn": [
|
|
2921
|
+
"file"
|
|
2922
|
+
],
|
|
2923
|
+
"name": "line-ending",
|
|
2924
|
+
"summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LF`.",
|
|
2925
|
+
"hasDynamicHelp": false,
|
|
2926
|
+
"multiple": false,
|
|
2927
|
+
"options": [
|
|
2928
|
+
"CRLF",
|
|
2929
|
+
"LF"
|
|
2930
|
+
],
|
|
2931
|
+
"type": "option"
|
|
2932
|
+
},
|
|
2933
|
+
"column-delimiter": {
|
|
2934
|
+
"name": "column-delimiter",
|
|
2935
|
+
"summary": "Column delimiter used in the CSV file.",
|
|
2936
|
+
"hasDynamicHelp": false,
|
|
2937
|
+
"multiple": false,
|
|
2938
|
+
"options": [
|
|
2939
|
+
"BACKQUOTE",
|
|
2940
|
+
"CARET",
|
|
2941
|
+
"COMMA",
|
|
2942
|
+
"PIPE",
|
|
2943
|
+
"SEMICOLON",
|
|
2944
|
+
"TAB"
|
|
2945
|
+
],
|
|
2946
|
+
"type": "option"
|
|
2947
|
+
},
|
|
2948
|
+
"external-id": {
|
|
2949
|
+
"aliases": [
|
|
2950
|
+
"externalid"
|
|
2951
|
+
],
|
|
2952
|
+
"char": "i",
|
|
2953
|
+
"deprecateAliases": true,
|
|
2954
|
+
"name": "external-id",
|
|
2955
|
+
"required": true,
|
|
2956
|
+
"summary": "Name of the external ID field, or the Id field.",
|
|
2957
|
+
"hasDynamicHelp": false,
|
|
2958
|
+
"multiple": false,
|
|
2959
|
+
"type": "option"
|
|
2960
|
+
}
|
|
2961
|
+
},
|
|
2962
|
+
"hasDynamicHelp": true,
|
|
2963
|
+
"hiddenAliases": [],
|
|
2964
|
+
"id": "data:upsert:bulk",
|
|
2965
|
+
"pluginAlias": "@salesforce/plugin-data",
|
|
2966
|
+
"pluginName": "@salesforce/plugin-data",
|
|
2967
|
+
"pluginType": "core",
|
|
2968
|
+
"strict": true,
|
|
2969
|
+
"summary": "Bulk upsert records to an org from a CSV file. Uses Bulk API 2.0.",
|
|
2970
|
+
"enableJsonFlag": true,
|
|
2971
|
+
"isESM": true,
|
|
2972
|
+
"relativePath": [
|
|
2973
|
+
"lib",
|
|
2974
|
+
"commands",
|
|
2975
|
+
"data",
|
|
2976
|
+
"upsert",
|
|
2977
|
+
"bulk.js"
|
|
2978
|
+
],
|
|
2979
|
+
"aliasPermutations": [],
|
|
2980
|
+
"permutations": [
|
|
2981
|
+
"data:upsert:bulk",
|
|
2982
|
+
"upsert:data:bulk",
|
|
2983
|
+
"upsert:bulk:data",
|
|
2984
|
+
"data:bulk:upsert",
|
|
2985
|
+
"bulk:data:upsert",
|
|
2986
|
+
"bulk:upsert:data"
|
|
2987
|
+
]
|
|
2988
|
+
},
|
|
2989
|
+
"data:upsert:resume": {
|
|
2990
|
+
"aliases": [],
|
|
2991
|
+
"args": {},
|
|
2992
|
+
"description": "The command uses the job ID returned from the \"<%= config.bin %> data upsert bulk\" command or the most recently-run bulk upsert job.",
|
|
2993
|
+
"examples": [
|
|
2994
|
+
"Resume a bulk upsert job from your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
|
|
2995
|
+
"Resume the most recently run bulk upsert job for an org with alias my-scratch:\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-scratch"
|
|
2996
|
+
],
|
|
2997
|
+
"flags": {
|
|
2998
|
+
"json": {
|
|
2999
|
+
"description": "Format output as json.",
|
|
3000
|
+
"helpGroup": "GLOBAL",
|
|
3001
|
+
"name": "json",
|
|
3002
|
+
"allowNo": false,
|
|
3003
|
+
"type": "boolean"
|
|
3004
|
+
},
|
|
3005
|
+
"flags-dir": {
|
|
3006
|
+
"helpGroup": "GLOBAL",
|
|
3007
|
+
"name": "flags-dir",
|
|
3008
|
+
"summary": "Import flag values from a directory.",
|
|
3009
|
+
"hasDynamicHelp": false,
|
|
3010
|
+
"multiple": false,
|
|
3011
|
+
"type": "option"
|
|
3012
|
+
},
|
|
3013
|
+
"target-org": {
|
|
3014
|
+
"aliases": [
|
|
3015
|
+
"targetusername",
|
|
3016
|
+
"u"
|
|
3017
|
+
],
|
|
3018
|
+
"char": "o",
|
|
3019
|
+
"deprecateAliases": true,
|
|
3020
|
+
"name": "target-org",
|
|
3021
|
+
"noCacheDefault": true,
|
|
3022
|
+
"summary": "Username or alias of the target org. Not required if the \"target-org\" configuration variable is already set.",
|
|
3023
|
+
"hasDynamicHelp": true,
|
|
3024
|
+
"multiple": false,
|
|
3025
|
+
"type": "option"
|
|
3026
|
+
},
|
|
3027
|
+
"job-id": {
|
|
3028
|
+
"aliases": [
|
|
3029
|
+
"jobid"
|
|
3030
|
+
],
|
|
3031
|
+
"char": "i",
|
|
3032
|
+
"deprecateAliases": true,
|
|
3033
|
+
"name": "job-id",
|
|
3034
|
+
"summary": "ID of the job you want to resume.",
|
|
3035
|
+
"hasDynamicHelp": false,
|
|
3036
|
+
"multiple": false,
|
|
3037
|
+
"type": "option"
|
|
3038
|
+
},
|
|
3039
|
+
"use-most-recent": {
|
|
3040
|
+
"exclusive": [
|
|
3041
|
+
"job-id"
|
|
3042
|
+
],
|
|
3043
|
+
"name": "use-most-recent",
|
|
3044
|
+
"summary": "Use the ID of the most recently-run bulk job.",
|
|
3045
|
+
"allowNo": false,
|
|
3046
|
+
"type": "boolean"
|
|
3047
|
+
},
|
|
3048
|
+
"wait": {
|
|
3049
|
+
"name": "wait",
|
|
3050
|
+
"summary": "Number of minutes to wait for the command to complete before displaying the results.",
|
|
3051
|
+
"default": "5 minutes",
|
|
3052
|
+
"hasDynamicHelp": true,
|
|
3053
|
+
"multiple": false,
|
|
3054
|
+
"type": "option"
|
|
3055
|
+
},
|
|
3056
|
+
"api-version": {
|
|
3057
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3058
|
+
"name": "api-version",
|
|
3059
|
+
"hasDynamicHelp": false,
|
|
3060
|
+
"multiple": false,
|
|
3061
|
+
"type": "option"
|
|
3062
|
+
},
|
|
3063
|
+
"loglevel": {
|
|
3064
|
+
"deprecated": {
|
|
3065
|
+
"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."
|
|
3066
|
+
},
|
|
3067
|
+
"hidden": true,
|
|
3068
|
+
"name": "loglevel",
|
|
3069
|
+
"hasDynamicHelp": false,
|
|
3070
|
+
"multiple": false,
|
|
3071
|
+
"type": "option"
|
|
3072
|
+
}
|
|
3073
|
+
},
|
|
3074
|
+
"hasDynamicHelp": true,
|
|
3075
|
+
"hiddenAliases": [],
|
|
3076
|
+
"id": "data:upsert:resume",
|
|
3077
|
+
"pluginAlias": "@salesforce/plugin-data",
|
|
3078
|
+
"pluginName": "@salesforce/plugin-data",
|
|
3079
|
+
"pluginType": "core",
|
|
3080
|
+
"strict": true,
|
|
3081
|
+
"summary": "Resume a bulk upsert job that you previously started. Uses Bulk API 2.0.",
|
|
3082
|
+
"enableJsonFlag": true,
|
|
3083
|
+
"isESM": true,
|
|
3084
|
+
"relativePath": [
|
|
3085
|
+
"lib",
|
|
3086
|
+
"commands",
|
|
3087
|
+
"data",
|
|
3088
|
+
"upsert",
|
|
3089
|
+
"resume.js"
|
|
3090
|
+
],
|
|
3091
|
+
"aliasPermutations": [],
|
|
3092
|
+
"permutations": [
|
|
3093
|
+
"data:upsert:resume",
|
|
3094
|
+
"upsert:data:resume",
|
|
3095
|
+
"upsert:resume:data",
|
|
3096
|
+
"data:resume:upsert",
|
|
3097
|
+
"resume:data:upsert",
|
|
3098
|
+
"resume:upsert:data"
|
|
3099
|
+
]
|
|
3100
|
+
},
|
|
3101
3101
|
"force:data:bulk:delete": {
|
|
3102
3102
|
"aliases": [],
|
|
3103
3103
|
"args": {},
|
|
@@ -3535,5 +3535,5 @@
|
|
|
3535
3535
|
]
|
|
3536
3536
|
}
|
|
3537
3537
|
},
|
|
3538
|
-
"version": "4.0.
|
|
3538
|
+
"version": "4.0.15"
|
|
3539
3539
|
}
|