@salesforce/plugin-data 3.7.1 → 3.8.0

package/lib/ux/bulkImportStages.js

@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) 2024, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { MultiStageOutput } from '@oclif/multi-stage-output';
+import terminalLink from 'terminal-link';
+export class BulkImportStages {
+    mso;
+    resume;
+    constructor({ resume, title, baseUrl, jsonEnabled }) {
+        this.resume = resume;
+        this.mso = new MultiStageOutput({
+            title,
+            jsonEnabled,
+            stages: ['Creating ingest job', 'Processing the job'],
+            stageSpecificBlock: [
+                {
+                    stage: 'Processing the job',
+                    label: 'Processed records',
+                    type: 'dynamic-key-value',
+                    get: (data) => {
+                        if (data?.numberRecordsProcessed) {
+                            return data.numberRecordsProcessed.toString();
+                        }
+                    },
+                },
+                {
+                    stage: 'Processing the job',
+                    label: 'Successful records',
+                    type: 'dynamic-key-value',
+                    get: (data) => {
+                        const numberRecordsFailed = data?.numberRecordsFailed ?? 0;
+                        if (data?.numberRecordsProcessed) {
+                            return (data.numberRecordsProcessed - numberRecordsFailed).toString();
+                        }
+                    },
+                },
+                {
+                    stage: 'Processing the job',
+                    label: 'Failed records',
+                    type: 'dynamic-key-value',
+                    get: (data) => {
+                        const numberRecordsFailed = data?.numberRecordsFailed ?? 0;
+                        if (data?.numberRecordsProcessed) {
+                            return numberRecordsFailed.toString();
+                        }
+                    },
+                },
+            ],
+            postStagesBlock: [
+                {
+                    label: 'Status',
+                    type: 'dynamic-key-value',
+                    bold: true,
+                    get: (data) => data?.state,
+                },
+                {
+                    label: 'Job Id',
+                    type: 'dynamic-key-value',
+                    bold: true,
+                    get: (data) => data?.id &&
+                        terminalLink(data.id, `${baseUrl}/lightning/setup/AsyncApiJobStatus/page?address=${encodeURIComponent(`/${data.id}`)}`, {
+                            fallback: (text, url) => `${text} (${url})`,
+                        }),
+                },
+            ],
+        });
+    }
+    start() {
+        if (this.resume) {
+            this.mso.skipTo('Processing the job');
+        }
+        else {
+            this.mso.goto('Creating ingest job');
+        }
+    }
+    processingJob() {
+        this.mso.goto('Processing the job');
+    }
+    setupJobListeners(job) {
+        job.on('inProgress', (res) => {
+            this.mso.updateData(res);
+        });
+    }
+    update(data) {
+        this.mso.updateData(data);
+    }
+    stop() {
+        this.mso.stop();
+    }
+    error() {
+        this.mso.error();
+    }
+}
+//# sourceMappingURL=bulkImportStages.js.map

package/lib/ux/bulkImportStages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulkImportStages.js","sourceRoot":"","sources":["../../src/ux/bulkImportStages.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAG7D,OAAO,YAAY,MAAM,eAAe,CAAC;AASzC,MAAM,OAAO,gBAAgB;IACnB,GAAG,CAA8B;IACjC,MAAM,CAAU;IAExB,YAAmB,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAW;QACjE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,IAAI,gBAAgB,CAAY;YACzC,KAAK;YACL,WAAW;YACX,MAAM,EAAE,CAAC,qBAAqB,EAAE,oBAAoB,CAAC;YACrD,kBAAkB,EAAE;gBAClB;oBACE,KAAK,EAAE,oBAAoB;oBAC3B,KAAK,EAAE,mBAAmB;oBAC1B,IAAI,EAAE,mBAAmB;oBACzB,GAAG,EAAE,CAAC,IAAI,EAAsB,EAAE;wBAChC,IAAI,IAAI,EAAE,sBAAsB,EAAE,CAAC;4BACjC,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,CAAC;wBAChD,CAAC;oBACH,CAAC;iBACF;gBACD;oBACE,KAAK,EAAE,oBAAoB;oBAC3B,KAAK,EAAE,oBAAoB;oBAC3B,IAAI,EAAE,mBAAmB;oBACzB,GAAG,EAAE,CAAC,IAAI,EAAsB,EAAE;wBAChC,MAAM,mBAAmB,GAAG,IAAI,EAAE,mBAAmB,IAAI,CAAC,CAAC;wBAE3D,IAAI,IAAI,EAAE,sBAAsB,EAAE,CAAC;4BACjC,OAAO,CAAC,IAAI,CAAC,sBAAsB,GAAG,mBAAmB,CAAC,CAAC,QAAQ,EAAE,CAAC;wBACxE,CAAC;oBACH,CAAC;iBACF;gBACD;oBACE,KAAK,EAAE,oBAAoB;oBAC3B,KAAK,EAAE,gBAAgB;oBACvB,IAAI,EAAE,mBAAmB;oBACzB,GAAG,EAAE,CAAC,IAAI,EAAsB,EAAE;wBAChC,MAAM,mBAAmB,GAAG,IAAI,EAAE,mBAAmB,IAAI,CAAC,CAAC;wBAE3D,IAAI,IAAI,EAAE,sBAAsB,EAAE,CAAC;4BACjC,OAAO,mBAAmB,CAAC,QAAQ,EAAE,CAAC;wBACxC,CAAC;oBACH,CAAC;iBACF;aACF;YACD,eAAe,EAAE;gBACf;oBACE,KAAK,EAAE,QAAQ;oBACf,IAAI,EAAE,mBAAmB;oBACzB,IAAI,EAAE,IAAI;oBACV,GAAG,EAAE,CAAC,IAAI,EAAsB,EAAE,CAAC,IAAI,EAAE,KAAK;iBAC/C;gBACD;oBACE,KAAK,EAAE,QAAQ;oBACf,IAAI,EAAE,mBAAmB;oBACzB,IAAI,EAAE,IAAI;oBACV,GAAG,EAAE,CAAC,IAAI,EAAsB,EAAE,CAChC,IAAI,EAAE,EAAE;wBACR,YAAY,CACV,IAAI,CAAC,EAAE,EACP,GAAG,OAAO,mDAAmD,kBAAkB,CAAC,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC,EAAE,EAChG;4BACE,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,KAAK,GAAG,GAAG;yBAC5C,CACF;iBACJ;aACF;SACF,CAAC,CAAC;IACL,CAAC;IAEM,KAAK;QACV,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAEM,aAAa;QAClB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACtC,CAAC;IAEM,iBAAiB,CAAC,GAAwB;QAC/C,GAAG,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,GAAc,EAAE,EAAE;YACtC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,IAAe;QAC3B,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAEM,IAAI;QACT,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IAClB,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;IACnB,CAAC;CACF"}

package/messages/data.import.bulk.md

@@ -0,0 +1,79 @@
+# summary
+
+Bulk import records into a Salesforce object from a CSV file. Uses Bulk API 2.0.
+
+# description
+
+You can use this command to import millions of records into the object from 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.
+
+Bulk 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.
+
+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
+
+- 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:
+
+  <%= config.bin %> <%= command.id %> --file accounts.csv --sobject Account --wait 10 --target-org my-scratch
+
+- 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:
+
+  <%= config.bin %> <%= command.id %> --file accounts.csv --sobject Account --async
+
+# flags.async.summary
+
+Don't wait for the command to complete.
+
+# flags.file.summary
+
+CSV file that contains the Salesforce object records you want to import.
+
+# flags.sobject.summary
+
+API name of the Salesforce object, either standard or custom, into which you're importing records.
+
+# flags.wait.summary
+
+Time to wait for the command to finish, in minutes.
+
+# flags.line-ending.summary
+
+Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LR`.
+
+# export.resume
+
+Run "sf data import resume --job-id %s" to resume the operation.
+
+# error.timeout
+
+The operation timed out after %s minutes.
+
+Run "sf data import resume --job-id %s" to resume it.
+
+# error.failedRecordDetails
+
+Job finished being processed but failed to import %s records.
+
+To review the details of this job, run this command:
+
+sf org open --target-org %s --path "/lightning/setup/AsyncApiJobStatus/page?address=%2F%s"
+
+# error.jobFailed
+
+Job failed to be processed due to:
+
+%s
+
+To review the details of this job, run this command:
+
+sf org open --target-org %s --path "/lightning/setup/AsyncApiJobStatus/page?address=%2F%s"
+
+# error.jobAborted
+
+Job has been aborted.
+
+To review the details of this job, run this command:
+
+sf org open --target-org %s --path "/lightning/setup/AsyncApiJobStatus/page?address=%2F%s"

package/messages/data.import.resume.md

@@ -0,0 +1,61 @@
+# summary
+
+Resume a bulk import job that you previously started. Uses Bulk API 2.0.
+
+# 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.
+
+# examples
+
+- Resume a bulk import job to your default org using an ID:
+
+  <%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA
+
+- Resume the most recently run bulk import job for an org with alias my-scratch:
+
+  <%= config.bin %> <%= command.id %> --use-most-recent --target-org my-scratch
+
+# flags.use-most-recent.summary
+
+Use the job ID of the bulk import job that was most recently run.
+
+# flags.job-id.summary
+
+Job ID of the bulk import.
+
+# flags.wait.summary
+
+Time to wait for the command to finish, in minutes.
+
+# error.failedRecordDetails
+
+Job finished being processed but failed to import %s records.
+
+To review the details of this job, run this command:
+
+sf org open --target-org %s --path "/lightning/setup/AsyncApiJobStatus/page?address=%2F%s"
+
+# error.timeout
+
+The operation timed out after %s minutes.
+
+Try re-running "sf data import resume --job-id %s" with a bigger wait time.
+
+# error.jobFailed
+
+Job failed to be processed due to:
+
+%s
+
+To review the details of this job, run this command:
+
+sf org open --target-org %s --path "/lightning/setup/AsyncApiJobStatus/page?address=%2F%s"
+
+# error.jobAborted
+
+Job has been aborted.
+
+To review the details of this job, run this command:
+
+sf org open --target-org %s --path "/lightning/setup/AsyncApiJobStatus/page?address=%2F%s"

package/messages/messages.md

@@ -54,7 +54,7 @@ The bulk request id must be supplied when not looking for most recent cache entr
 
 # error.bulkRequestIdNotFound
 
-Could not find a cache entry for job ID %s
+Could not find a cache entry for job ID %s.
 
 # error.missingCacheEntryError