@salesforce/cli 2.64.0 → 2.64.2

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 CHANGED
@@ -24,7 +24,7 @@ $ npm install -g @salesforce/cli
24
24
  $ sf COMMAND
25
25
  running command...
26
26
  $ sf (--version|-v)
27
- @salesforce/cli/2.64.0 linux-x64 node-v20.17.0
27
+ @salesforce/cli/2.64.2 linux-x64 node-v20.18.0
28
28
  $ sf --help [COMMAND]
29
29
  USAGE
30
30
  $ sf COMMAND
@@ -70,6 +70,8 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
70
70
  - [`sf data export resume`](#sf-data-export-resume)
71
71
  - [`sf data export tree`](#sf-data-export-tree)
72
72
  - [`sf data get record`](#sf-data-get-record)
73
+ - [`sf data import bulk`](#sf-data-import-bulk)
74
+ - [`sf data import resume`](#sf-data-import-resume)
73
75
  - [`sf data import tree`](#sf-data-import-tree)
74
76
  - [`sf data query`](#sf-data-query)
75
77
  - [`sf data query resume`](#sf-data-query-resume)
@@ -1331,7 +1333,7 @@ EXAMPLES
1331
1333
  $ sf data create file --file path/to/astro.png --parent-id a03fakeLoJWPIA3
1332
1334
  ```
1333
1335
 
1334
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/create/file.ts)_
1336
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/create/file.ts)_
1335
1337
 
1336
1338
  ## `sf data create record`
1337
1339
 
@@ -1387,7 +1389,7 @@ EXAMPLES
1387
1389
  TracedEntityId=01p17000000R6bLAAS"
1388
1390
  ```
1389
1391
 
1390
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/create/record.ts)_
1392
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/create/record.ts)_
1391
1393
 
1392
1394
  ## `sf data delete bulk`
1393
1395
 
@@ -1445,7 +1447,7 @@ FLAG DESCRIPTIONS
1445
1447
  and can be enabled only by a system administrator.
1446
1448
  ```
1447
1449
 
1448
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/delete/bulk.ts)_
1450
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/delete/bulk.ts)_
1449
1451
 
1450
1452
  ## `sf data delete record`
1451
1453
 
@@ -1506,7 +1508,7 @@ EXAMPLES
1506
1508
  $ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
1507
1509
  ```
1508
1510
 
1509
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/delete/record.ts)_
1511
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/delete/record.ts)_
1510
1512
 
1511
1513
  ## `sf data delete resume`
1512
1514
 
@@ -1545,7 +1547,7 @@ EXAMPLES
1545
1547
  $ sf data delete resume --use-most-recent --target-org my-scratch
1546
1548
  ```
1547
1549
 
1548
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/delete/resume.ts)_
1550
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/delete/resume.ts)_
1549
1551
 
1550
1552
  ## `sf data export bulk`
1551
1553
 
@@ -1619,7 +1621,7 @@ EXAMPLES
1619
1621
  --result-format json --async
1620
1622
  ```
1621
1623
 
1622
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/export/bulk.ts)_
1624
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/export/bulk.ts)_
1623
1625
 
1624
1626
  ## `sf data export resume`
1625
1627
 
@@ -1655,7 +1657,7 @@ EXAMPLES
1655
1657
  $ sf data export resume --use-most-recent --target-org my-scratch
1656
1658
  ```
1657
1659
 
1658
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/export/resume.ts)_
1660
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/export/resume.ts)_
1659
1661
 
1660
1662
  ## `sf data export tree`
1661
1663
 
@@ -1716,7 +1718,7 @@ EXAMPLES
1716
1718
  my-scratch
1717
1719
  ```
1718
1720
 
1719
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/export/tree.ts)_
1721
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/export/tree.ts)_
1720
1722
 
1721
1723
  ## `sf data get record`
1722
1724
 
@@ -1780,7 +1782,99 @@ EXAMPLES
1780
1782
  $ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
1781
1783
  ```
1782
1784
 
1783
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/get/record.ts)_
1785
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/get/record.ts)_
1786
+
1787
+ ## `sf data import bulk`
1788
+
1789
+ Bulk import records into a Salesforce object from a CSV file. Uses Bulk API 2.0.
1790
+
1791
+ ```
1792
+ USAGE
1793
+ $ sf data import bulk -s <value> -o <value> [--json] [--flags-dir <value>] [-a | -w <value>] [--api-version <value>]
1794
+ (--line-ending CRLF|LF -f <value>)
1795
+
1796
+ FLAGS
1797
+ -a, --async Don't wait for the command to complete.
1798
+ -f, --file=<value> (required) CSV file that contains the Salesforce object records you want to import.
1799
+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
1800
+ configuration variable is already set.
1801
+ -s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, into which you're
1802
+ importing records.
1803
+ -w, --wait=<value> Time to wait for the command to finish, in minutes.
1804
+ --api-version=<value> Override the api version used for api requests made by this command
1805
+ --line-ending=<option> Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux
1806
+ it's `LR`.
1807
+ <options: CRLF|LF>
1808
+
1809
+ GLOBAL FLAGS
1810
+ --flags-dir=<value> Import flag values from a directory.
1811
+ --json Format output as json.
1812
+
1813
+ DESCRIPTION
1814
+ Bulk import records into a Salesforce object from a CSV file. Uses Bulk API 2.0.
1815
+
1816
+ You can use this command to import millions of records into the object from a file in comma-separated values (CSV)
1817
+ format.
1818
+
1819
+ All the records in the CSV file must be for the same Salesforce object. Specify the object with the `--sobject` flag.
1820
+
1821
+ Bulk imports can take a while, depending on how many records are in the CSV file. If the command times out, or you
1822
+ specified the --async flag, the command displays the job ID. To see the status and get the results of the job, run "sf
1823
+ data import resume" and pass the job ID to the --job-id flag.
1824
+
1825
+ For information and examples about how to prepare your CSV files, see "Prepare Data to Ingest" in the "Bulk API 2.0
1826
+ and Bulk API Developer Guide"
1827
+ (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_prepare_data.htm).
1828
+
1829
+ EXAMPLES
1830
+ Import Account records from a CSV-formatted file into an org with alias "my-scratch"; if the import doesn't complete
1831
+ in 10 minutes, the command ends and displays a job ID:
1832
+
1833
+ $ sf data import bulk --file accounts.csv --sobject Account --wait 10 --target-org my-scratch
1834
+
1835
+ Import asynchronously and use the default org; the command immediately returns a job ID that you then pass to the
1836
+ "sf data import resume" command:
1837
+
1838
+ $ sf data import bulk --file accounts.csv --sobject Account --async
1839
+ ```
1840
+
1841
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/import/bulk.ts)_
1842
+
1843
+ ## `sf data import resume`
1844
+
1845
+ Resume a bulk import job that you previously started. Uses Bulk API 2.0.
1846
+
1847
+ ```
1848
+ USAGE
1849
+ $ sf data import resume [--json] [--flags-dir <value>] [--use-most-recent] [-i <value>] [-w <value>]
1850
+
1851
+ FLAGS
1852
+ -i, --job-id=<value> Job ID of the bulk import.
1853
+ -w, --wait=<value> [default: 5 minutes] Time to wait for the command to finish, in minutes.
1854
+ --use-most-recent Use the job ID of the bulk import job that was most recently run.
1855
+
1856
+ GLOBAL FLAGS
1857
+ --flags-dir=<value> Import flag values from a directory.
1858
+ --json Format output as json.
1859
+
1860
+ DESCRIPTION
1861
+ Resume a bulk import job that you previously started. Uses Bulk API 2.0.
1862
+
1863
+ When the original "sf data import bulk" command either times out or is run with the --async flag, it displays a job
1864
+ ID. To see the status and get the results of the bulk import, run this command by either passing it the job ID or
1865
+ using the --use-most-recent flag to specify the most recent bulk import job.
1866
+
1867
+ EXAMPLES
1868
+ Resume a bulk import job to your default org using an ID:
1869
+
1870
+ $ sf data import resume --job-id 750xx000000005sAAA
1871
+
1872
+ Resume the most recently run bulk import job for an org with alias my-scratch:
1873
+
1874
+ $ sf data import resume --use-most-recent --target-org my-scratch
1875
+ ```
1876
+
1877
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/import/resume.ts)_
1784
1878
 
1785
1879
  ## `sf data import tree`
1786
1880
 
@@ -1845,7 +1939,7 @@ FLAG DESCRIPTIONS
1845
1939
  - files(array) - Files: An array of files paths to load
1846
1940
  ```
1847
1941
 
1848
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/import/tree.ts)_
1942
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/import/tree.ts)_
1849
1943
 
1850
1944
  ## `sf data query`
1851
1945
 
@@ -1909,7 +2003,7 @@ EXAMPLES
1909
2003
  $ sf data query --query "SELECT Id FROM Contact" --bulk --wait 0
1910
2004
  ```
1911
2005
 
1912
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/query.ts)_
2006
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/query.ts)_
1913
2007
 
1914
2008
  ## `sf data query resume`
1915
2009
 
@@ -1947,7 +2041,7 @@ EXAMPLES
1947
2041
  $ sf data query resume --bulk-query-id 7500x000005BdFzXXX
1948
2042
  ```
1949
2043
 
1950
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/query/resume.ts)_
2044
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/query/resume.ts)_
1951
2045
 
1952
2046
  ## `sf data resume`
1953
2047
 
@@ -1984,7 +2078,7 @@ EXAMPLES
1984
2078
  $ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
1985
2079
  ```
1986
2080
 
1987
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/resume.ts)_
2081
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/resume.ts)_
1988
2082
 
1989
2083
  ## `sf data search`
1990
2084
 
@@ -2034,7 +2128,7 @@ EXAMPLES
2034
2128
  $ sf data search --file query.txt --target-org my-scratch --result-format csv
2035
2129
  ```
2036
2130
 
2037
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/search.ts)_
2131
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/search.ts)_
2038
2132
 
2039
2133
  ## `sf data update record`
2040
2134
 
@@ -2096,7 +2190,7 @@ EXAMPLES
2096
2190
  "ExpirationDate=2017-12-01T00:58:04.000+0000"
2097
2191
  ```
2098
2192
 
2099
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/update/record.ts)_
2193
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/update/record.ts)_
2100
2194
 
2101
2195
  ## `sf data upsert bulk`
2102
2196
 
@@ -2149,7 +2243,7 @@ EXAMPLES
2149
2243
  my-scratch
2150
2244
  ```
2151
2245
 
2152
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/upsert/bulk.ts)_
2246
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/upsert/bulk.ts)_
2153
2247
 
2154
2248
  ## `sf data upsert resume`
2155
2249
 
@@ -2188,7 +2282,7 @@ EXAMPLES
2188
2282
  $ sf data upsert resume --use-most-recent --target-org my-scratch
2189
2283
  ```
2190
2284
 
2191
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/data/upsert/resume.ts)_
2285
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/data/upsert/resume.ts)_
2192
2286
 
2193
2287
  ## `sf doctor`
2194
2288
 
@@ -2283,7 +2377,7 @@ EXAMPLES
2283
2377
  $ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
2284
2378
  ```
2285
2379
 
2286
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/force/data/bulk/delete.ts)_
2380
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/force/data/bulk/delete.ts)_
2287
2381
 
2288
2382
  ## `sf force data bulk status`
2289
2383
 
@@ -2320,7 +2414,7 @@ EXAMPLES
2320
2414
  $ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
2321
2415
  ```
2322
2416
 
2323
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/force/data/bulk/status.ts)_
2417
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/force/data/bulk/status.ts)_
2324
2418
 
2325
2419
  ## `sf force data bulk upsert`
2326
2420
 
@@ -2378,7 +2472,7 @@ EXAMPLES
2378
2472
  --target-org my-scratch
2379
2473
  ```
2380
2474
 
2381
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.1/src/commands/force/data/bulk/upsert.ts)_
2475
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.8.0/src/commands/force/data/bulk/upsert.ts)_
2382
2476
 
2383
2477
  ## `sf help [COMMAND]`
2384
2478
 
@@ -3630,7 +3724,7 @@ EXAMPLES
3630
3724
  $ sf org list limits --target-org my-scratch-org
3631
3725
  ```
3632
3726
 
3633
- _See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.33/src/commands/org/list/limits.ts)_
3727
+ _See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.35/src/commands/org/list/limits.ts)_
3634
3728
 
3635
3729
  ## `sf org list metadata`
3636
3730
 
@@ -3798,7 +3892,7 @@ EXAMPLES
3798
3892
  $ sf org list sobject record-counts --sobject Account --sobject Lead --target-org my-scratch-org
3799
3893
  ```
3800
3894
 
3801
- _See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.33/src/commands/org/list/sobject/record-counts.ts)_
3895
+ _See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.35/src/commands/org/list/sobject/record-counts.ts)_
3802
3896
 
3803
3897
  ## `sf org list users`
3804
3898