@salesforce/plugin-data 4.0.30 → 4.0.31

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 (3) hide show
  1. package/README.md +24 -24
  2. package/oclif.manifest.json +345 -345
  3. package/package.json +6 -6
package/README.md CHANGED
@@ -144,7 +144,7 @@ EXAMPLES
144
144
  $ sf data bulk results --job-id 7507i000fake341G --target-org my-scratch
145
145
  ```
146
146
 
147
- _See code: [src/commands/data/bulk/results.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/bulk/results.ts)_
147
+ _See code: [src/commands/data/bulk/results.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/bulk/results.ts)_
148
148
 
149
149
  ## `sf data create file`
150
150
 
@@ -193,7 +193,7 @@ EXAMPLES
193
193
  $ sf data create file --file path/to/astro.png --parent-id a03fakeLoJWPIA3
194
194
  ```
195
195
 
196
- _See code: [src/commands/data/create/file.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/create/file.ts)_
196
+ _See code: [src/commands/data/create/file.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/create/file.ts)_
197
197
 
198
198
  ## `sf data create record`
199
199
 
@@ -249,7 +249,7 @@ EXAMPLES
249
249
  TracedEntityId=01p17000000R6bLAAS"
250
250
  ```
251
251
 
252
- _See code: [src/commands/data/create/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/create/record.ts)_
252
+ _See code: [src/commands/data/create/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/create/record.ts)_
253
253
 
254
254
  ## `sf data delete bulk`
255
255
 
@@ -309,7 +309,7 @@ FLAG DESCRIPTIONS
309
309
  and can be enabled only by a system administrator.
310
310
  ```
311
311
 
312
- _See code: [src/commands/data/delete/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/delete/bulk.ts)_
312
+ _See code: [src/commands/data/delete/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/delete/bulk.ts)_
313
313
 
314
314
  ## `sf data delete record`
315
315
 
@@ -370,7 +370,7 @@ EXAMPLES
370
370
  $ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
371
371
  ```
372
372
 
373
- _See code: [src/commands/data/delete/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/delete/record.ts)_
373
+ _See code: [src/commands/data/delete/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/delete/record.ts)_
374
374
 
375
375
  ## `sf data delete resume`
376
376
 
@@ -409,7 +409,7 @@ EXAMPLES
409
409
  $ sf data delete resume --use-most-recent --target-org my-scratch
410
410
  ```
411
411
 
412
- _See code: [src/commands/data/delete/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/delete/resume.ts)_
412
+ _See code: [src/commands/data/delete/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/delete/resume.ts)_
413
413
 
414
414
  ## `sf data export bulk`
415
415
 
@@ -483,7 +483,7 @@ EXAMPLES
483
483
  --result-format json --async
484
484
  ```
485
485
 
486
- _See code: [src/commands/data/export/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/export/bulk.ts)_
486
+ _See code: [src/commands/data/export/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/export/bulk.ts)_
487
487
 
488
488
  ## `sf data export resume`
489
489
 
@@ -519,7 +519,7 @@ EXAMPLES
519
519
  $ sf data export resume --use-most-recent --target-org my-scratch
520
520
  ```
521
521
 
522
- _See code: [src/commands/data/export/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/export/resume.ts)_
522
+ _See code: [src/commands/data/export/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/export/resume.ts)_
523
523
 
524
524
  ## `sf data export tree`
525
525
 
@@ -579,7 +579,7 @@ EXAMPLES
579
579
  my-scratch
580
580
  ```
581
581
 
582
- _See code: [src/commands/data/export/tree.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/export/tree.ts)_
582
+ _See code: [src/commands/data/export/tree.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/export/tree.ts)_
583
583
 
584
584
  ## `sf data get record`
585
585
 
@@ -643,7 +643,7 @@ EXAMPLES
643
643
  $ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
644
644
  ```
645
645
 
646
- _See code: [src/commands/data/get/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/get/record.ts)_
646
+ _See code: [src/commands/data/get/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/get/record.ts)_
647
647
 
648
648
  ## `sf data import bulk`
649
649
 
@@ -701,7 +701,7 @@ EXAMPLES
701
701
  $ sf data import bulk --file accounts.csv --sobject Account --async
702
702
  ```
703
703
 
704
- _See code: [src/commands/data/import/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/import/bulk.ts)_
704
+ _See code: [src/commands/data/import/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/import/bulk.ts)_
705
705
 
706
706
  ## `sf data import resume`
707
707
 
@@ -737,7 +737,7 @@ EXAMPLES
737
737
  $ sf data import resume --use-most-recent --target-org my-scratch
738
738
  ```
739
739
 
740
- _See code: [src/commands/data/import/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/import/resume.ts)_
740
+ _See code: [src/commands/data/import/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/import/resume.ts)_
741
741
 
742
742
  ## `sf data import tree`
743
743
 
@@ -801,7 +801,7 @@ FLAG DESCRIPTIONS
801
801
  - files(array) - Files: An array of files paths to load
802
802
  ```
803
803
 
804
- _See code: [src/commands/data/import/tree.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/import/tree.ts)_
804
+ _See code: [src/commands/data/import/tree.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/import/tree.ts)_
805
805
 
806
806
  ## `sf data query`
807
807
 
@@ -854,7 +854,7 @@ EXAMPLES
854
854
  $ sf data query --query "SELECT Name FROM ApexTrigger" --use-tooling-api
855
855
  ```
856
856
 
857
- _See code: [src/commands/data/query.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/query.ts)_
857
+ _See code: [src/commands/data/query.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/query.ts)_
858
858
 
859
859
  ## `sf data resume`
860
860
 
@@ -891,7 +891,7 @@ EXAMPLES
891
891
  $ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
892
892
  ```
893
893
 
894
- _See code: [src/commands/data/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/resume.ts)_
894
+ _See code: [src/commands/data/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/resume.ts)_
895
895
 
896
896
  ## `sf data search`
897
897
 
@@ -941,7 +941,7 @@ EXAMPLES
941
941
  $ sf data search --file query.txt --target-org my-scratch --result-format csv
942
942
  ```
943
943
 
944
- _See code: [src/commands/data/search.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/search.ts)_
944
+ _See code: [src/commands/data/search.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/search.ts)_
945
945
 
946
946
  ## `sf data update bulk`
947
947
 
@@ -1002,7 +1002,7 @@ EXAMPLES
1002
1002
  $ sf data update bulk --file accounts.csv --sobject Account --async
1003
1003
  ```
1004
1004
 
1005
- _See code: [src/commands/data/update/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/update/bulk.ts)_
1005
+ _See code: [src/commands/data/update/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/update/bulk.ts)_
1006
1006
 
1007
1007
  ## `sf data update record`
1008
1008
 
@@ -1064,7 +1064,7 @@ EXAMPLES
1064
1064
  "ExpirationDate=2017-12-01T00:58:04.000+0000"
1065
1065
  ```
1066
1066
 
1067
- _See code: [src/commands/data/update/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/update/record.ts)_
1067
+ _See code: [src/commands/data/update/record.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/update/record.ts)_
1068
1068
 
1069
1069
  ## `sf data update resume`
1070
1070
 
@@ -1100,7 +1100,7 @@ EXAMPLES
1100
1100
  $ sf data update resume --use-most-recent --target-org my-scratch
1101
1101
  ```
1102
1102
 
1103
- _See code: [src/commands/data/update/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/update/resume.ts)_
1103
+ _See code: [src/commands/data/update/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/update/resume.ts)_
1104
1104
 
1105
1105
  ## `sf data upsert bulk`
1106
1106
 
@@ -1157,7 +1157,7 @@ EXAMPLES
1157
1157
  my-scratch
1158
1158
  ```
1159
1159
 
1160
- _See code: [src/commands/data/upsert/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/upsert/bulk.ts)_
1160
+ _See code: [src/commands/data/upsert/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/upsert/bulk.ts)_
1161
1161
 
1162
1162
  ## `sf data upsert resume`
1163
1163
 
@@ -1196,7 +1196,7 @@ EXAMPLES
1196
1196
  $ sf data upsert resume --use-most-recent --target-org my-scratch
1197
1197
  ```
1198
1198
 
1199
- _See code: [src/commands/data/upsert/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/data/upsert/resume.ts)_
1199
+ _See code: [src/commands/data/upsert/resume.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/data/upsert/resume.ts)_
1200
1200
 
1201
1201
  ## `sf force data bulk delete`
1202
1202
 
@@ -1243,7 +1243,7 @@ EXAMPLES
1243
1243
  $ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
1244
1244
  ```
1245
1245
 
1246
- _See code: [src/commands/force/data/bulk/delete.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/force/data/bulk/delete.ts)_
1246
+ _See code: [src/commands/force/data/bulk/delete.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/force/data/bulk/delete.ts)_
1247
1247
 
1248
1248
  ## `sf force data bulk status`
1249
1249
 
@@ -1280,7 +1280,7 @@ EXAMPLES
1280
1280
  $ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
1281
1281
  ```
1282
1282
 
1283
- _See code: [src/commands/force/data/bulk/status.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/force/data/bulk/status.ts)_
1283
+ _See code: [src/commands/force/data/bulk/status.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/force/data/bulk/status.ts)_
1284
1284
 
1285
1285
  ## `sf force data bulk upsert`
1286
1286
 
@@ -1338,6 +1338,6 @@ EXAMPLES
1338
1338
  --target-org my-scratch
1339
1339
  ```
1340
1340
 
1341
- _See code: [src/commands/force/data/bulk/upsert.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.30/src/commands/force/data/bulk/upsert.ts)_
1341
+ _See code: [src/commands/force/data/bulk/upsert.ts](https://github.com/salesforcecli/plugin-data/blob/4.0.31/src/commands/force/data/bulk/upsert.ts)_
1342
1342
 
1343
1343
  <!-- commandsstop -->
@@ -1765,13 +1765,13 @@
1765
1765
  "record:get:data"
1766
1766
  ]
1767
1767
  },
1768
- "data:update:bulk": {
1768
+ "data:import:bulk": {
1769
1769
  "aliases": [],
1770
1770
  "args": {},
1771
- "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).",
1772
1772
  "examples": [
1773
- "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",
1774
- "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"
1775
1775
  ],
1776
1776
  "flags": {
1777
1777
  "json": {
@@ -1792,24 +1792,19 @@
1792
1792
  "async": {
1793
1793
  "char": "a",
1794
1794
  "deprecated": true,
1795
+ "exclusive": [
1796
+ "wait"
1797
+ ],
1795
1798
  "name": "async",
1796
1799
  "summary": "Don't wait for the command to complete.",
1797
1800
  "allowNo": false,
1798
1801
  "type": "boolean"
1799
1802
  },
1800
- "wait": {
1801
- "char": "w",
1802
- "name": "wait",
1803
- "summary": "Time to wait for the command to finish, in minutes.",
1804
- "hasDynamicHelp": true,
1805
- "multiple": false,
1806
- "type": "option"
1807
- },
1808
1803
  "file": {
1809
1804
  "char": "f",
1810
1805
  "name": "file",
1811
1806
  "required": true,
1812
- "summary": "CSV file that contains the Salesforce object records you want to update.",
1807
+ "summary": "CSV file that contains the Salesforce object records you want to import.",
1813
1808
  "hasDynamicHelp": false,
1814
1809
  "multiple": false,
1815
1810
  "type": "option"
@@ -1818,7 +1813,7 @@
1818
1813
  "char": "s",
1819
1814
  "name": "sobject",
1820
1815
  "required": true,
1821
- "summary": "API name of the Salesforce object, either standard or custom, which you are updating.",
1816
+ "summary": "API name of the Salesforce object, either standard or custom, into which you're importing records.",
1822
1817
  "hasDynamicHelp": false,
1823
1818
  "multiple": false,
1824
1819
  "type": "option"
@@ -1830,6 +1825,17 @@
1830
1825
  "multiple": false,
1831
1826
  "type": "option"
1832
1827
  },
1828
+ "wait": {
1829
+ "char": "w",
1830
+ "exclusive": [
1831
+ "async"
1832
+ ],
1833
+ "name": "wait",
1834
+ "summary": "Time to wait for the command to finish, in minutes.",
1835
+ "hasDynamicHelp": true,
1836
+ "multiple": false,
1837
+ "type": "option"
1838
+ },
1833
1839
  "target-org": {
1834
1840
  "char": "o",
1835
1841
  "name": "target-org",
@@ -1872,43 +1878,116 @@
1872
1878
  },
1873
1879
  "hasDynamicHelp": true,
1874
1880
  "hiddenAliases": [],
1875
- "id": "data:update:bulk",
1881
+ "id": "data:import:bulk",
1876
1882
  "pluginAlias": "@salesforce/plugin-data",
1877
1883
  "pluginName": "@salesforce/plugin-data",
1878
1884
  "pluginType": "core",
1879
1885
  "strict": true,
1880
- "summary": "Bulk 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.",
1881
1887
  "enableJsonFlag": true,
1882
1888
  "isESM": true,
1883
1889
  "relativePath": [
1884
1890
  "lib",
1885
1891
  "commands",
1886
1892
  "data",
1887
- "update",
1893
+ "import",
1888
1894
  "bulk.js"
1889
1895
  ],
1890
1896
  "aliasPermutations": [],
1891
1897
  "permutations": [
1892
- "data:update:bulk",
1893
- "update:data:bulk",
1894
- "update:bulk:data",
1895
- "data:bulk:update",
1896
- "bulk:data:update",
1897
- "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"
1898
1904
  ]
1899
1905
  },
1900
- "data:update:record": {
1906
+ "data:import:resume": {
1907
+ "aliases": [],
1908
+ "args": {},
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.",
1910
+ "examples": [
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"
1913
+ ],
1914
+ "flags": {
1915
+ "json": {
1916
+ "description": "Format output as json.",
1917
+ "helpGroup": "GLOBAL",
1918
+ "name": "json",
1919
+ "allowNo": false,
1920
+ "type": "boolean"
1921
+ },
1922
+ "flags-dir": {
1923
+ "helpGroup": "GLOBAL",
1924
+ "name": "flags-dir",
1925
+ "summary": "Import flag values from a directory.",
1926
+ "hasDynamicHelp": false,
1927
+ "multiple": false,
1928
+ "type": "option"
1929
+ },
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"
1935
+ },
1936
+ "job-id": {
1937
+ "char": "i",
1938
+ "name": "job-id",
1939
+ "summary": "Job ID of the bulk import.",
1940
+ "hasDynamicHelp": false,
1941
+ "multiple": false,
1942
+ "type": "option"
1943
+ },
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,
1950
+ "multiple": false,
1951
+ "type": "option"
1952
+ }
1953
+ },
1954
+ "hasDynamicHelp": true,
1955
+ "hiddenAliases": [],
1956
+ "id": "data:import:resume",
1957
+ "pluginAlias": "@salesforce/plugin-data",
1958
+ "pluginName": "@salesforce/plugin-data",
1959
+ "pluginType": "core",
1960
+ "strict": true,
1961
+ "summary": "Resume a bulk import job that you previously started. Uses Bulk API 2.0.",
1962
+ "enableJsonFlag": true,
1963
+ "isESM": true,
1964
+ "relativePath": [
1965
+ "lib",
1966
+ "commands",
1967
+ "data",
1968
+ "import",
1969
+ "resume.js"
1970
+ ],
1971
+ "aliasPermutations": [],
1972
+ "permutations": [
1973
+ "data:import:resume",
1974
+ "import:data:resume",
1975
+ "import:resume:data",
1976
+ "data:resume:import",
1977
+ "resume:data:import",
1978
+ "resume:import:data"
1979
+ ]
1980
+ },
1981
+ "data:import:tree": {
1901
1982
  "aliases": [
1902
- "force:data:record:update"
1983
+ "force:data:tree:import"
1903
1984
  ],
1904
1985
  "args": {},
1905
1986
  "deprecateAliases": true,
1906
- "description": "Specify the record you want to update with either its ID or with a list of field-value pairs that identify the record. If your list of fields identifies more than one record, the update fails; the error displays how many records were found.\n\nWhen using field-value pairs for both identifying the record and specifiyng the new field values, use the format <fieldName>=<value>. Enclose all field-value pairs in one set of double quotation marks, delimited by spaces. Enclose values that contain spaces in single quotes.\n\nThis command updates a record in Salesforce objects by default. Use the --use-tooling-api flag to update a Tooling API object.",
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.",
1907
1988
  "examples": [
1908
- "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\"",
1909
- "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'\"",
1910
- "Update the Name and Website fields of an Account record with the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> --sobject Account --record-id 001D0 --values \"Name='Acme III' Website=www.example.com\"",
1911
- "Update the ExpirationDate field of a record of the Tooling API object TraceFlag using the specified (truncated) ID:\n<%= config.bin %> <%= command.id %> -t --sobject TraceFlag --record-id 7tf170000009cUBAAY --values \"ExpirationDate=2017-12-01T00:58:04.000+0000\""
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"
1912
1991
  ],
1913
1992
  "flags": {
1914
1993
  "json": {
@@ -1962,204 +2041,88 @@
1962
2041
  "multiple": false,
1963
2042
  "type": "option"
1964
2043
  },
1965
- "sobject": {
1966
- "aliases": [
1967
- "sobjecttype"
1968
- ],
1969
- "char": "s",
1970
- "deprecateAliases": true,
1971
- "name": "sobject",
1972
- "required": true,
1973
- "summary": "API name of the Salesforce or Tooling API object that contains the record you're updating.",
1974
- "hasDynamicHelp": false,
1975
- "multiple": false,
1976
- "type": "option"
1977
- },
1978
- "record-id": {
2044
+ "files": {
1979
2045
  "aliases": [
1980
- "sobjectid"
2046
+ "sobjecttreefiles"
1981
2047
  ],
1982
- "char": "i",
2048
+ "char": "f",
1983
2049
  "deprecateAliases": true,
1984
- "name": "record-id",
1985
- "summary": "ID of the record you’re updating.",
1986
- "hasDynamicHelp": false,
1987
- "multiple": false,
1988
- "type": "option"
1989
- },
1990
- "where": {
1991
- "char": "w",
1992
- "name": "where",
1993
- "summary": "List of <fieldName>=<value> pairs that identify the record you want to update.",
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": ",",
1994
2053
  "hasDynamicHelp": false,
1995
- "multiple": false,
2054
+ "multiple": true,
1996
2055
  "type": "option"
1997
2056
  },
1998
- "values": {
1999
- "char": "v",
2000
- "name": "values",
2001
- "required": true,
2002
- "summary": "Fields that you're updating, in the format of <fieldName>=<value> pairs.",
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.",
2003
2062
  "hasDynamicHelp": false,
2004
2063
  "multiple": false,
2005
2064
  "type": "option"
2006
- },
2007
- "use-tooling-api": {
2008
- "aliases": [
2009
- "usetoolingapi"
2010
- ],
2011
- "char": "t",
2012
- "deprecateAliases": true,
2013
- "name": "use-tooling-api",
2014
- "summary": "Use Tooling API so you can update a record in a Tooling API object.",
2015
- "allowNo": false,
2016
- "type": "boolean"
2017
- },
2018
- "perflog": {
2019
- "deprecated": {
2020
- "version": "57"
2021
- },
2022
- "hidden": true,
2023
- "name": "perflog",
2024
- "summary": "Get API performance data.",
2025
- "allowNo": false,
2026
- "type": "boolean"
2027
2065
  }
2028
2066
  },
2029
2067
  "hasDynamicHelp": true,
2030
2068
  "hiddenAliases": [],
2031
- "id": "data:update:record",
2069
+ "id": "data:import:tree",
2032
2070
  "pluginAlias": "@salesforce/plugin-data",
2033
2071
  "pluginName": "@salesforce/plugin-data",
2034
2072
  "pluginType": "core",
2035
2073
  "strict": true,
2036
- "summary": "Updates a single record of a Salesforce or Tooling API object.",
2074
+ "summary": "Import data from one or more JSON files into an org.",
2037
2075
  "enableJsonFlag": true,
2038
2076
  "isESM": true,
2039
2077
  "relativePath": [
2040
2078
  "lib",
2041
2079
  "commands",
2042
2080
  "data",
2043
- "update",
2044
- "record.js"
2081
+ "import",
2082
+ "tree.js"
2045
2083
  ],
2046
2084
  "aliasPermutations": [
2047
- "force:data:record:update",
2048
- "data:force:record:update",
2049
- "data:record:force:update",
2050
- "data:record:update:force",
2051
- "force:record:data:update",
2052
- "record:force:data:update",
2053
- "record:data:force:update",
2054
- "record:data:update:force",
2055
- "force:record:update:data",
2056
- "record:force:update:data",
2057
- "record:update:force:data",
2058
- "record:update:data:force",
2059
- "force:data:update:record",
2060
- "data:force:update:record",
2061
- "data:update:force:record",
2062
- "data:update:record:force",
2063
- "force:update:data:record",
2064
- "update:force:data:record",
2065
- "update:data:force:record",
2066
- "update:data:record:force",
2067
- "force:update:record:data",
2068
- "update:force:record:data",
2069
- "update:record:force:data",
2070
- "update:record:data:force"
2071
- ],
2072
- "permutations": [
2073
- "data:update:record",
2074
- "update:data:record",
2075
- "update:record:data",
2076
- "data:record:update",
2077
- "record:data:update",
2078
- "record:update:data"
2079
- ]
2080
- },
2081
- "data:update:resume": {
2082
- "aliases": [],
2083
- "args": {},
2084
- "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.",
2085
- "examples": [
2086
- "Resume a bulk update job of your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
2087
- "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"
2088
- ],
2089
- "flags": {
2090
- "json": {
2091
- "description": "Format output as json.",
2092
- "helpGroup": "GLOBAL",
2093
- "name": "json",
2094
- "allowNo": false,
2095
- "type": "boolean"
2096
- },
2097
- "flags-dir": {
2098
- "helpGroup": "GLOBAL",
2099
- "name": "flags-dir",
2100
- "summary": "Import flag values from a directory.",
2101
- "hasDynamicHelp": false,
2102
- "multiple": false,
2103
- "type": "option"
2104
- },
2105
- "use-most-recent": {
2106
- "name": "use-most-recent",
2107
- "summary": "Use the job ID of the bulk update job that was most recently run.",
2108
- "allowNo": false,
2109
- "type": "boolean"
2110
- },
2111
- "job-id": {
2112
- "char": "i",
2113
- "name": "job-id",
2114
- "summary": "Job ID of the bulk update.",
2115
- "hasDynamicHelp": false,
2116
- "multiple": false,
2117
- "type": "option"
2118
- },
2119
- "wait": {
2120
- "char": "w",
2121
- "name": "wait",
2122
- "summary": "Time to wait for the command to finish, in minutes.",
2123
- "default": "5 minutes",
2124
- "hasDynamicHelp": true,
2125
- "multiple": false,
2126
- "type": "option"
2127
- }
2128
- },
2129
- "hasDynamicHelp": true,
2130
- "hiddenAliases": [],
2131
- "id": "data:update:resume",
2132
- "pluginAlias": "@salesforce/plugin-data",
2133
- "pluginName": "@salesforce/plugin-data",
2134
- "pluginType": "core",
2135
- "strict": true,
2136
- "summary": "Resume a bulk update job that you previously started. Uses Bulk API 2.0.",
2137
- "enableJsonFlag": true,
2138
- "isESM": true,
2139
- "relativePath": [
2140
- "lib",
2141
- "commands",
2142
- "data",
2143
- "update",
2144
- "resume.js"
2085
+ "force:data:tree:import",
2086
+ "data:force:tree:import",
2087
+ "data:tree:force:import",
2088
+ "data:tree:import:force",
2089
+ "force:tree:data:import",
2090
+ "tree:force:data:import",
2091
+ "tree:data:force:import",
2092
+ "tree:data:import:force",
2093
+ "force:tree:import:data",
2094
+ "tree:force:import:data",
2095
+ "tree:import:force:data",
2096
+ "tree:import:data:force",
2097
+ "force:data:import:tree",
2098
+ "data:force:import:tree",
2099
+ "data:import:force:tree",
2100
+ "data:import:tree:force",
2101
+ "force:import:data:tree",
2102
+ "import:force:data:tree",
2103
+ "import:data:force:tree",
2104
+ "import:data:tree:force",
2105
+ "force:import:tree:data",
2106
+ "import:force:tree:data",
2107
+ "import:tree:force:data",
2108
+ "import:tree:data:force"
2145
2109
  ],
2146
- "aliasPermutations": [],
2147
2110
  "permutations": [
2148
- "data:update:resume",
2149
- "update:data:resume",
2150
- "update:resume:data",
2151
- "data:resume:update",
2152
- "resume:data:update",
2153
- "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"
2154
2117
  ]
2155
2118
  },
2156
- "data:import:bulk": {
2119
+ "data:update:bulk": {
2157
2120
  "aliases": [],
2158
2121
  "args": {},
2159
- "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).",
2160
2123
  "examples": [
2161
- "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",
2162
- "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"
2163
2126
  ],
2164
2127
  "flags": {
2165
2128
  "json": {
@@ -2180,19 +2143,24 @@
2180
2143
  "async": {
2181
2144
  "char": "a",
2182
2145
  "deprecated": true,
2183
- "exclusive": [
2184
- "wait"
2185
- ],
2186
2146
  "name": "async",
2187
2147
  "summary": "Don't wait for the command to complete.",
2188
2148
  "allowNo": false,
2189
2149
  "type": "boolean"
2190
2150
  },
2151
+ "wait": {
2152
+ "char": "w",
2153
+ "name": "wait",
2154
+ "summary": "Time to wait for the command to finish, in minutes.",
2155
+ "hasDynamicHelp": true,
2156
+ "multiple": false,
2157
+ "type": "option"
2158
+ },
2191
2159
  "file": {
2192
2160
  "char": "f",
2193
2161
  "name": "file",
2194
2162
  "required": true,
2195
- "summary": "CSV file that contains the Salesforce object records you want to import.",
2163
+ "summary": "CSV file that contains the Salesforce object records you want to update.",
2196
2164
  "hasDynamicHelp": false,
2197
2165
  "multiple": false,
2198
2166
  "type": "option"
@@ -2201,7 +2169,7 @@
2201
2169
  "char": "s",
2202
2170
  "name": "sobject",
2203
2171
  "required": true,
2204
- "summary": "API name of the Salesforce object, either standard or custom, into which you're importing records.",
2172
+ "summary": "API name of the Salesforce object, either standard or custom, which you are updating.",
2205
2173
  "hasDynamicHelp": false,
2206
2174
  "multiple": false,
2207
2175
  "type": "option"
@@ -2213,17 +2181,6 @@
2213
2181
  "multiple": false,
2214
2182
  "type": "option"
2215
2183
  },
2216
- "wait": {
2217
- "char": "w",
2218
- "exclusive": [
2219
- "async"
2220
- ],
2221
- "name": "wait",
2222
- "summary": "Time to wait for the command to finish, in minutes.",
2223
- "hasDynamicHelp": true,
2224
- "multiple": false,
2225
- "type": "option"
2226
- },
2227
2184
  "target-org": {
2228
2185
  "char": "o",
2229
2186
  "name": "target-org",
@@ -2266,38 +2223,43 @@
2266
2223
  },
2267
2224
  "hasDynamicHelp": true,
2268
2225
  "hiddenAliases": [],
2269
- "id": "data:import:bulk",
2226
+ "id": "data:update:bulk",
2270
2227
  "pluginAlias": "@salesforce/plugin-data",
2271
2228
  "pluginName": "@salesforce/plugin-data",
2272
2229
  "pluginType": "core",
2273
2230
  "strict": true,
2274
- "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.",
2275
2232
  "enableJsonFlag": true,
2276
2233
  "isESM": true,
2277
2234
  "relativePath": [
2278
2235
  "lib",
2279
2236
  "commands",
2280
2237
  "data",
2281
- "import",
2238
+ "update",
2282
2239
  "bulk.js"
2283
2240
  ],
2284
2241
  "aliasPermutations": [],
2285
2242
  "permutations": [
2286
- "data:import:bulk",
2287
- "import:data:bulk",
2288
- "import:bulk:data",
2289
- "data:bulk:import",
2290
- "bulk:data:import",
2291
- "bulk:import:data"
2243
+ "data:update:bulk",
2244
+ "update:data:bulk",
2245
+ "update:bulk:data",
2246
+ "data:bulk:update",
2247
+ "bulk:data:update",
2248
+ "bulk:update:data"
2292
2249
  ]
2293
2250
  },
2294
- "data:import:resume": {
2295
- "aliases": [],
2251
+ "data:update:record": {
2252
+ "aliases": [
2253
+ "force:data:record:update"
2254
+ ],
2296
2255
  "args": {},
2297
- "description": "When the original \"sf data import bulk\" command either times out or is run with the --async flag, it displays a job ID. To see the status and get the results of the bulk import, run this command by either passing it the job ID or using the --use-most-recent flag to specify the most recent bulk import job.",
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.",
2298
2258
  "examples": [
2299
- "Resume a bulk import job to your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
2300
- "Resume the most recently run bulk import job for an org with alias my-scratch:\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-scratch"
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\""
2301
2263
  ],
2302
2264
  "flags": {
2303
2265
  "json": {
@@ -2315,67 +2277,165 @@
2315
2277
  "multiple": false,
2316
2278
  "type": "option"
2317
2279
  },
2318
- "use-most-recent": {
2319
- "name": "use-most-recent",
2320
- "summary": "Use the job ID of the bulk import job that was most recently run.",
2321
- "allowNo": false,
2322
- "type": "boolean"
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"
2323
2294
  },
2324
- "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
+ ],
2325
2333
  "char": "i",
2326
- "name": "job-id",
2327
- "summary": "Job ID of the bulk import.",
2334
+ "deprecateAliases": true,
2335
+ "name": "record-id",
2336
+ "summary": "ID of the record you’re updating.",
2328
2337
  "hasDynamicHelp": false,
2329
2338
  "multiple": false,
2330
2339
  "type": "option"
2331
2340
  },
2332
- "wait": {
2341
+ "where": {
2333
2342
  "char": "w",
2334
- "name": "wait",
2335
- "summary": "Time to wait for the command to finish, in minutes.",
2336
- "default": "5 minutes",
2337
- "hasDynamicHelp": true,
2343
+ "name": "where",
2344
+ "summary": "List of <fieldName>=<value> pairs that identify the record you want to update.",
2345
+ "hasDynamicHelp": false,
2338
2346
  "multiple": false,
2339
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,
2355
+ "multiple": false,
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"
2340
2378
  }
2341
2379
  },
2342
2380
  "hasDynamicHelp": true,
2343
2381
  "hiddenAliases": [],
2344
- "id": "data:import:resume",
2382
+ "id": "data:update:record",
2345
2383
  "pluginAlias": "@salesforce/plugin-data",
2346
2384
  "pluginName": "@salesforce/plugin-data",
2347
2385
  "pluginType": "core",
2348
2386
  "strict": true,
2349
- "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.",
2350
2388
  "enableJsonFlag": true,
2351
2389
  "isESM": true,
2352
2390
  "relativePath": [
2353
2391
  "lib",
2354
2392
  "commands",
2355
2393
  "data",
2356
- "import",
2357
- "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"
2358
2422
  ],
2359
- "aliasPermutations": [],
2360
2423
  "permutations": [
2361
- "data:import:resume",
2362
- "import:data:resume",
2363
- "import:resume:data",
2364
- "data:resume:import",
2365
- "resume:data:import",
2366
- "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"
2367
2430
  ]
2368
2431
  },
2369
- "data:import:tree": {
2370
- "aliases": [
2371
- "force:data:tree:import"
2372
- ],
2432
+ "data:update:resume": {
2433
+ "aliases": [],
2373
2434
  "args": {},
2374
- "deprecateAliases": true,
2375
- "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.",
2376
2436
  "examples": [
2377
- "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",
2378
- "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"
2379
2439
  ],
2380
2440
  "flags": {
2381
2441
  "json": {
@@ -2393,115 +2453,55 @@
2393
2453
  "multiple": false,
2394
2454
  "type": "option"
2395
2455
  },
2396
- "target-org": {
2397
- "aliases": [
2398
- "targetusername",
2399
- "u"
2400
- ],
2401
- "char": "o",
2402
- "deprecateAliases": true,
2403
- "name": "target-org",
2404
- "noCacheDefault": true,
2405
- "required": true,
2406
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2407
- "hasDynamicHelp": true,
2408
- "multiple": false,
2409
- "type": "option"
2410
- },
2411
- "api-version": {
2412
- "aliases": [
2413
- "apiversion"
2414
- ],
2415
- "deprecateAliases": true,
2416
- "description": "Override the api version used for api requests made by this command",
2417
- "name": "api-version",
2418
- "hasDynamicHelp": false,
2419
- "multiple": false,
2420
- "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"
2421
2461
  },
2422
- "loglevel": {
2423
- "deprecated": {
2424
- "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."
2425
- },
2426
- "hidden": true,
2427
- "name": "loglevel",
2462
+ "job-id": {
2463
+ "char": "i",
2464
+ "name": "job-id",
2465
+ "summary": "Job ID of the bulk update.",
2428
2466
  "hasDynamicHelp": false,
2429
2467
  "multiple": false,
2430
2468
  "type": "option"
2431
2469
  },
2432
- "files": {
2433
- "aliases": [
2434
- "sobjecttreefiles"
2435
- ],
2436
- "char": "f",
2437
- "deprecateAliases": true,
2438
- "name": "files",
2439
- "summary": "Comma-separated and in-order JSON files that contain the records, in sObject tree format, that you want to insert.",
2440
- "delimiter": ",",
2441
- "hasDynamicHelp": false,
2442
- "multiple": true,
2443
- "type": "option"
2444
- },
2445
- "plan": {
2446
- "char": "p",
2447
- "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",
2448
- "name": "plan",
2449
- "summary": "Plan definition file to insert multiple data files.",
2450
- "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,
2451
2476
  "multiple": false,
2452
2477
  "type": "option"
2453
2478
  }
2454
2479
  },
2455
2480
  "hasDynamicHelp": true,
2456
2481
  "hiddenAliases": [],
2457
- "id": "data:import:tree",
2482
+ "id": "data:update:resume",
2458
2483
  "pluginAlias": "@salesforce/plugin-data",
2459
2484
  "pluginName": "@salesforce/plugin-data",
2460
2485
  "pluginType": "core",
2461
2486
  "strict": true,
2462
- "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.",
2463
2488
  "enableJsonFlag": true,
2464
2489
  "isESM": true,
2465
2490
  "relativePath": [
2466
2491
  "lib",
2467
2492
  "commands",
2468
2493
  "data",
2469
- "import",
2470
- "tree.js"
2471
- ],
2472
- "aliasPermutations": [
2473
- "force:data:tree:import",
2474
- "data:force:tree:import",
2475
- "data:tree:force:import",
2476
- "data:tree:import:force",
2477
- "force:tree:data:import",
2478
- "tree:force:data:import",
2479
- "tree:data:force:import",
2480
- "tree:data:import:force",
2481
- "force:tree:import:data",
2482
- "tree:force:import:data",
2483
- "tree:import:force:data",
2484
- "tree:import:data:force",
2485
- "force:data:import:tree",
2486
- "data:force:import:tree",
2487
- "data:import:force:tree",
2488
- "data:import:tree:force",
2489
- "force:import:data:tree",
2490
- "import:force:data:tree",
2491
- "import:data:force:tree",
2492
- "import:data:tree:force",
2493
- "force:import:tree:data",
2494
- "import:force:tree:data",
2495
- "import:tree:force:data",
2496
- "import:tree:data:force"
2494
+ "update",
2495
+ "resume.js"
2497
2496
  ],
2497
+ "aliasPermutations": [],
2498
2498
  "permutations": [
2499
- "data:import:tree",
2500
- "import:data:tree",
2501
- "import:tree:data",
2502
- "data:tree:import",
2503
- "tree:data:import",
2504
- "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"
2505
2505
  ]
2506
2506
  },
2507
2507
  "data:upsert:bulk": {
@@ -3232,5 +3232,5 @@
3232
3232
  ]
3233
3233
  }
3234
3234
  },
3235
- "version": "4.0.30"
3235
+ "version": "4.0.31"
3236
3236
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-data",
3
- "version": "4.0.30",
3
+ "version": "4.0.31",
4
4
  "description": "Plugin for salesforce data commands",
5
5
  "author": "Salesforce",
6
6
  "homepage": "https://github.com/salesforcecli/plugin-data",
@@ -121,7 +121,7 @@
121
121
  },
122
122
  "dependencies": {
123
123
  "@jsforce/jsforce-node": "^3.6.6",
124
- "@oclif/multi-stage-output": "^0.8.12",
124
+ "@oclif/multi-stage-output": "^0.8.13",
125
125
  "@salesforce/core": "^8.10.2",
126
126
  "@salesforce/kit": "^3.2.2",
127
127
  "@salesforce/sf-plugins-core": "^12.2.1",
@@ -135,11 +135,11 @@
135
135
  },
136
136
  "devDependencies": {
137
137
  "@oclif/core": "^4.3.0",
138
- "@oclif/plugin-command-snapshot": "^5.2.38",
138
+ "@oclif/plugin-command-snapshot": "^5.2.39",
139
139
  "@oclif/test": "^4.1.12",
140
140
  "@salesforce/cli-plugins-testkit": "^5.3.39",
141
141
  "@salesforce/dev-scripts": "^11.0.2",
142
- "@salesforce/plugin-command-reference": "^3.1.50",
142
+ "@salesforce/plugin-command-reference": "^3.1.52",
143
143
  "@salesforce/types": "^1.3.0",
144
144
  "eslint-plugin-sf-plugin": "^1.20.22",
145
145
  "oclif": "^4.17.46",
@@ -267,7 +267,7 @@
267
267
  "exports": "./lib/index.js",
268
268
  "type": "module",
269
269
  "sfdx": {
270
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/4.0.30.crt",
271
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/4.0.30.sig"
270
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/4.0.31.crt",
271
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/4.0.31.sig"
272
272
  }
273
273
  }