chore(release): 3.10.0 [skip ci]

salesforcecli · Oct 30, 2024 · a662658 · a662658
1 parent 5ef1b55
commit a662658
Show file tree

Hide file tree

Showing 3 changed files with 144 additions and 37 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+# [3.10.0](https://github.com/salesforcecli/plugin-data/compare/3.9.0...3.10.0) (2024-10-30)
+
+### Features
+
+- add `data update bulk/resume` commands ([#1098](https://github.com/salesforcecli/plugin-data/issues/1098)) ([5ef1b55](https://github.com/salesforcecli/plugin-data/commit/5ef1b550d5971f6eb7c5dc028ad6994e81b3feff)), closes [#1099](https://github.com/salesforcecli/plugin-data/issues/1099) [#1106](https://github.com/salesforcecli/plugin-data/issues/1106)
+
 # [3.9.0](https://github.com/salesforcecli/plugin-data/compare/3.8.2...3.9.0) (2024-10-29)
 
 ### Features

diff --git a/README.md b/README.md
@@ -92,7 +92,9 @@ sf plugins
 - [`sf data query resume`](#sf-data-query-resume)
 - [`sf data resume`](#sf-data-resume)
 - [`sf data search`](#sf-data-search)
+- [`sf data update bulk`](#sf-data-update-bulk)
 - [`sf data update record`](#sf-data-update-record)
+- [`sf data update resume`](#sf-data-update-resume)
 - [`sf data upsert bulk`](#sf-data-upsert-bulk)
 - [`sf data upsert resume`](#sf-data-upsert-resume)
 - [`sf force data bulk delete`](#sf-force-data-bulk-delete)
@@ -146,7 +148,7 @@ EXAMPLES
     $ sf data create file --file path/to/astro.png --parent-id a03fakeLoJWPIA3
 ```
 
-_See code: [src/commands/data/create/file.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/create/file.ts)_
+_See code: [src/commands/data/create/file.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/create/file.ts)_
 
 ## `sf data create record`
 
@@ -202,7 +204,7 @@ EXAMPLES
       TracedEntityId=01p17000000R6bLAAS"
 ```
 
-_See code: [src/commands/data/create/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/create/record.ts)_
+_See code: [src/commands/data/create/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/create/record.ts)_
 
 ## `sf data delete bulk`
 
@@ -260,7 +262,7 @@ FLAG DESCRIPTIONS
     and can be enabled only by a system administrator.
 ```
 
-_See code: [src/commands/data/delete/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/delete/bulk.ts)_
+_See code: [src/commands/data/delete/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/delete/bulk.ts)_
 
 ## `sf data delete record`
 
@@ -321,7 +323,7 @@ EXAMPLES
     $ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
 ```
 
-_See code: [src/commands/data/delete/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/delete/record.ts)_
+_See code: [src/commands/data/delete/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/delete/record.ts)_
 
 ## `sf data delete resume`
 
@@ -360,7 +362,7 @@ EXAMPLES
     $ sf data delete resume --use-most-recent --target-org my-scratch
 ```
 
-_See code: [src/commands/data/delete/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/delete/resume.ts)_
+_See code: [src/commands/data/delete/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/delete/resume.ts)_
 
 ## `sf data export bulk`
 
@@ -434,11 +436,11 @@ EXAMPLES
       --result-format json --async
 ```
 
-_See code: [src/commands/data/export/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/export/bulk.ts)_
+_See code: [src/commands/data/export/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/export/bulk.ts)_
 
 ## `sf data export resume`
 
-Resume a bulk export job that you previously started.
+Resume a bulk export job that you previously started. Uses Bulk API 2.0.
 
 ```
 USAGE
@@ -454,7 +456,7 @@ GLOBAL FLAGS
   --json               Format output as json.
 
 DESCRIPTION
-  Resume a bulk export job that you previously started.
+  Resume a bulk export job that you previously started. Uses Bulk API 2.0.
 
   When the original "data export 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 export, run this command by either passing it the job ID or using
@@ -470,7 +472,7 @@ EXAMPLES
     $ sf data export resume --use-most-recent --target-org my-scratch
 ```
 
-_See code: [src/commands/data/export/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/export/resume.ts)_
+_See code: [src/commands/data/export/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/export/resume.ts)_
 
 ## `sf data export tree`
 
@@ -531,7 +533,7 @@ EXAMPLES
       my-scratch
 ```
 
-_See code: [src/commands/data/export/tree.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/export/tree.ts)_
+_See code: [src/commands/data/export/tree.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/export/tree.ts)_
 
 ## `sf data get record`
 
@@ -595,7 +597,7 @@ EXAMPLES
     $ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
 ```
 
-_See code: [src/commands/data/get/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/get/record.ts)_
+_See code: [src/commands/data/get/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/get/record.ts)_
 
 ## `sf data import bulk`
 
@@ -604,20 +606,22 @@ Bulk import records into a Salesforce object from a CSV file. Uses Bulk API 2.0.
 ```
 USAGE
   $ sf data import bulk -s <value> -o <value> [--json] [--flags-dir <value>] [-a | -w <value>] [--api-version <value>]
-    (--line-ending CRLF|LF -f <value>)
+    (--line-ending CRLF|LF -f <value>) [--column-delimiter BACKQUOTE|CARET|COMMA|PIPE|SEMICOLON|TAB]
 
 FLAGS
-  -a, --async                 Don't wait for the command to complete.
-  -f, --file=<value>          (required) CSV file that contains the Salesforce object records you want to import.
-  -o, --target-org=<value>    (required) Username or alias of the target org. Not required if the `target-org`
-                              configuration variable is already set.
-  -s, --sobject=<value>       (required) API name of the Salesforce object, either standard or custom, into which you're
-                              importing records.
-  -w, --wait=<value>          Time to wait for the command to finish, in minutes.
-      --api-version=<value>   Override the api version used for api requests made by this command
-      --line-ending=<option>  Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux
-                              it's `LR`.
-                              <options: CRLF|LF>
+  -a, --async                      Don't wait for the command to complete.
+  -f, --file=<value>               (required) CSV file that contains the Salesforce object records you want to import.
+  -o, --target-org=<value>         (required) Username or alias of the target org. Not required if the `target-org`
+                                   configuration variable is already set.
+  -s, --sobject=<value>            (required) API name of the Salesforce object, either standard or custom, into which
+                                   you're importing records.
+  -w, --wait=<value>               Time to wait for the command to finish, in minutes.
+      --api-version=<value>        Override the api version used for api requests made by this command
+      --column-delimiter=<option>  Column delimiter used in the CSV file. Default is COMMA.
+                                   <options: BACKQUOTE|CARET|COMMA|PIPE|SEMICOLON|TAB>
+      --line-ending=<option>       Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and
+                                   Linux it's `LF`.
+                                   <options: CRLF|LF>
 
 GLOBAL FLAGS
   --flags-dir=<value>  Import flag values from a directory.
@@ -651,7 +655,7 @@ EXAMPLES
     $ sf data import bulk --file accounts.csv --sobject Account --async
 ```
 
-_See code: [src/commands/data/import/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/import/bulk.ts)_
+_See code: [src/commands/data/import/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/import/bulk.ts)_
 
 ## `sf data import resume`
 
@@ -687,7 +691,7 @@ EXAMPLES
     $ sf data import resume --use-most-recent --target-org my-scratch
 ```
 
-_See code: [src/commands/data/import/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/import/resume.ts)_
+_See code: [src/commands/data/import/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/import/resume.ts)_
 
 ## `sf data import tree`
 
@@ -752,7 +756,7 @@ FLAG DESCRIPTIONS
     - files(array) - Files: An array of files paths to load
 ```
 
-_See code: [src/commands/data/import/tree.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/import/tree.ts)_
+_See code: [src/commands/data/import/tree.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/import/tree.ts)_
 
 ## `sf data query`
 
@@ -816,7 +820,7 @@ EXAMPLES
     $ sf data query --query "SELECT Id FROM Contact" --bulk --wait 0
 ```
 
-_See code: [src/commands/data/query.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/query.ts)_
+_See code: [src/commands/data/query.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/query.ts)_
 
 ## `sf data query resume`
 
@@ -854,7 +858,7 @@ EXAMPLES
     $ sf data query resume --bulk-query-id 7500x000005BdFzXXX
 ```
 
-_See code: [src/commands/data/query/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/query/resume.ts)_
+_See code: [src/commands/data/query/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/query/resume.ts)_
 
 ## `sf data resume`
 
@@ -891,7 +895,7 @@ EXAMPLES
     $ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
 ```
 
-_See code: [src/commands/data/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/resume.ts)_
+_See code: [src/commands/data/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/resume.ts)_
 
 ## `sf data search`
 
@@ -941,7 +945,68 @@ EXAMPLES
     $ sf data search --file query.txt --target-org my-scratch --result-format csv
 ```
 
-_See code: [src/commands/data/search.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/search.ts)_
+_See code: [src/commands/data/search.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/search.ts)_
+
+## `sf data update bulk`
+
+Bulk update records to an org from a CSV file. Uses Bulk API 2.0.
+
+```
+USAGE
+  $ sf data update bulk -s <value> -o <value> [--json] [--flags-dir <value>] [-a] [-w <value>] [--api-version <value>]
+    (--line-ending CRLF|LF -f <value>) [--column-delimiter BACKQUOTE|CARET|COMMA|PIPE|SEMICOLON|TAB]
+
+FLAGS
+  -a, --async                      Don't wait for the command to complete.
+  -f, --file=<value>               (required) CSV file that contains the Salesforce object records you want to update.
+  -o, --target-org=<value>         (required) Username or alias of the target org. Not required if the `target-org`
+                                   configuration variable is already set.
+  -s, --sobject=<value>            (required) API name of the Salesforce object, either standard or custom, which you
+                                   are updating.
+  -w, --wait=<value>               Time to wait for the command to finish, in minutes.
+      --api-version=<value>        Override the api version used for api requests made by this command
+      --column-delimiter=<option>  Column delimiter used in the CSV file. Default is COMMA.
+                                   <options: BACKQUOTE|CARET|COMMA|PIPE|SEMICOLON|TAB>
+      --line-ending=<option>       Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and
+                                   Linux it's `LF`.
+                                   <options: CRLF|LF>
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Bulk update records to an org from a CSV file. Uses Bulk API 2.0.
+
+  You can use this command to update millions of Salesforce object records based on a file in comma-separated values
+  (CSV) format.
+
+  All 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.
+
+  Bulk 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.
+
+  For 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).
+
+EXAMPLES
+  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:
+
+    $ sf data update bulk --file accounts.csv --sobject Account --wait 10 --target-org my-scratch
+
+  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:
+
+    $ sf data update bulk --file accounts.csv --sobject Account --async
+```
+
+_See code: [src/commands/data/update/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/update/bulk.ts)_
 
 ## `sf data update record`
 
@@ -1003,7 +1068,43 @@ EXAMPLES
       "ExpirationDate=2017-12-01T00:58:04.000+0000"
 ```
 
-_See code: [src/commands/data/update/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/update/record.ts)_
+_See code: [src/commands/data/update/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/update/record.ts)_
+
+## `sf data update resume`
+
+Resume a bulk update job that you previously started. Uses Bulk API 2.0.
+
+```
+USAGE
+  $ sf data update resume [--json] [--flags-dir <value>] [--use-most-recent] [-i <value>] [-w <value>]
+
+FLAGS
+  -i, --job-id=<value>   Job ID of the bulk update.
+  -w, --wait=<value>     [default: 5 minutes] Time to wait for the command to finish, in minutes.
+      --use-most-recent  Use the job ID of the bulk update job that was most recently run.
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Resume a bulk update job that you previously started. Uses Bulk API 2.0.
+
+  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.
+
+EXAMPLES
+  Resume a bulk update job of your default org using a job ID:
+
+    $ sf data update resume --job-id 750xx000000005sAAA
+
+  Resume the most recently run bulk update job for an org with alias "my-scratch":
+
+    $ sf data update resume --use-most-recent --target-org my-scratch
+```
+
+_See code: [src/commands/data/update/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/update/resume.ts)_
 
 ## `sf data upsert bulk`
 
@@ -1056,7 +1157,7 @@ EXAMPLES
       my-scratch
 ```
 
-_See code: [src/commands/data/upsert/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/upsert/bulk.ts)_
+_See code: [src/commands/data/upsert/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/upsert/bulk.ts)_
 
 ## `sf data upsert resume`
 
@@ -1095,7 +1196,7 @@ EXAMPLES
     $ sf data upsert resume --use-most-recent --target-org my-scratch
 ```
 
-_See code: [src/commands/data/upsert/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/data/upsert/resume.ts)_
+_See code: [src/commands/data/upsert/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/data/upsert/resume.ts)_
 
 ## `sf force data bulk delete`
 
@@ -1142,7 +1243,7 @@ EXAMPLES
     $ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
 ```
 
-_See code: [src/commands/force/data/bulk/delete.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/force/data/bulk/delete.ts)_
+_See code: [src/commands/force/data/bulk/delete.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/force/data/bulk/delete.ts)_
 
 ## `sf force data bulk status`
 
@@ -1179,7 +1280,7 @@ EXAMPLES
     $ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
 ```
 
-_See code: [src/commands/force/data/bulk/status.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/force/data/bulk/status.ts)_
+_See code: [src/commands/force/data/bulk/status.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/force/data/bulk/status.ts)_
 
 ## `sf force data bulk upsert`
 
@@ -1237,6 +1338,6 @@ EXAMPLES
       --target-org my-scratch
 ```
 
-_See code: [src/commands/force/data/bulk/upsert.ts](https://github.com/salesforcecli/plugin-data/blob/3.9.0/src/commands/force/data/bulk/upsert.ts)_
+_See code: [src/commands/force/data/bulk/upsert.ts](https://github.com/salesforcecli/plugin-data/blob/3.10.0/src/commands/force/data/bulk/upsert.ts)_
 
 <!-- commandsstop -->
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/plugin-data",
-  "version": "3.9.0",
+  "version": "3.10.0",
   "description": "Plugin for salesforce data commands",
   "author": "Salesforce",
   "homepage": "https://github.com/salesforcecli/plugin-data",