@salesforce/plugin-data 3.6.9 → 3.7.1

package/lib/commands/data/export/bulk.js

@@ -0,0 +1,213 @@
+/*
+ * Copyright (c) 2023, 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 * as fs from 'node:fs';
+import { platform } from 'node:os';
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages, Org } from '@salesforce/core';
+import { MultiStageOutput } from '@oclif/multi-stage-output';
+import terminalLink from 'terminal-link';
+import { QueryJobV2 } from '@jsforce/jsforce-node/lib/api/bulk2.js';
+import { Duration } from '@salesforce/kit';
+import { BulkExportRequestCache } from '../../../bulkDataRequestCache.js';
+import { exportRecords } from '../../../bulkUtils.js';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-data', 'data.export.bulk');
+export default class DataExportBulk extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        'target-org': Flags.requiredOrg(),
+        'api-version': Flags.orgApiVersion(),
+        wait: Flags.duration({
+            summary: messages.getMessage('flags.wait.summary'),
+            char: 'w',
+            helpValue: '<minutes>',
+            unit: 'minutes',
+            exclusive: ['async'],
+        }),
+        async: Flags.boolean({
+            summary: messages.getMessage('flags.async.summary'),
+            exclusive: ['wait'],
+        }),
+        query: Flags.string({
+            summary: messages.getMessage('flags.query.summary'),
+            char: 'q',
+            exclusive: ['query-file'],
+        }),
+        'query-file': Flags.file({
+            summary: messages.getMessage('flags.query-file.summary'),
+            exists: true,
+            exclusive: ['query'],
+        }),
+        'all-rows': Flags.boolean({
+            summary: messages.getMessage('flags.all-rows.summary'),
+        }),
+        'output-file': Flags.file({
+            summary: messages.getMessage('flags.output-file.summary'),
+            required: true,
+        }),
+        'result-format': Flags.option({
+            required: true,
+            options: ['csv', 'json'],
+            default: 'csv',
+            summary: messages.getMessage('flags.result-format.summary'),
+            char: 'r',
+        })(),
+        'column-delimiter': Flags.option({
+            options: ['BACKQUOTE', 'CARET', 'COMMA', 'PIPE', 'SEMICOLON', 'TAB'],
+            summary: messages.getMessage('flags.column-delimiter.summary'),
+            relationships: [
+                {
+                    type: 'some',
+                    flags: [
+                        {
+                            name: 'result-format',
+                            // eslint-disable-next-line @typescript-eslint/require-await
+                            when: async (flags) => flags['result-format'] === 'csv',
+                        },
+                    ],
+                },
+            ],
+        })(),
+        'line-ending': Flags.option({
+            summary: messages.getMessage('flags.line-ending.summary'),
+            options: ['LF', 'CRLF'],
+            relationships: [
+                {
+                    type: 'some',
+                    flags: [
+                        {
+                            name: 'result-format',
+                            // eslint-disable-next-line @typescript-eslint/require-await
+                            when: async (flags) => flags['result-format'] === 'csv',
+                        },
+                    ],
+                },
+            ],
+        })(),
+    };
+    async run() {
+        const { flags } = await this.parse(DataExportBulk);
+        const conn = flags['target-org'].getConnection(flags['api-version']);
+        const timeout = flags.async ? Duration.minutes(0) : flags.wait ?? Duration.minutes(0);
+        // `flags['query-file']` will be present if `flags.query` isn't. oclif's `exclusive` isn't quite that clever
+        const soqlQuery = flags.query ?? fs.readFileSync(flags['query-file'], 'utf8');
+        const lineEnding = flags['line-ending'] ?? platform() === 'win32' ? 'CRLF' : 'LF';
+        const columnDelimiter = flags['column-delimiter'] ?? 'COMMA';
+        const async = timeout.milliseconds === 0;
+        const baseUrl = flags['target-org'].getField(Org.Fields.INSTANCE_URL).toString();
+        const ms = new MultiStageOutput({
+            jsonEnabled: flags.json ?? false,
+            stages: async
+                ? ['creating query job', 'done']
+                : ['creating query job', 'processing the job', 'exporting records'],
+            title: async ? 'Exporting data (async)' : 'Exporting data',
+            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}`)}`),
+                },
+            ],
+        });
+        // async: create query job in the org but don't poll for its status
+        if (async) {
+            const job = new QueryJobV2(conn, {
+                bodyParams: {
+                    query: soqlQuery,
+                    operation: flags['all-rows'] ? 'queryAll' : 'query',
+                    columnDelimiter,
+                    lineEnding,
+                },
+                pollingOptions: {
+                    pollTimeout: timeout.milliseconds,
+                    pollInterval: 5000,
+                },
+            });
+            job.on('error', (err) => {
+                ms.stop('failed');
+                throw err;
+            });
+            job.on('open', (jobInfo) => {
+                ms.goto('done', { id: jobInfo.id });
+                ms.stop();
+            });
+            ms.goto('creating query job');
+            try {
+                const jobInfo = await job.open();
+                const cache = await BulkExportRequestCache.create();
+                await cache.createCacheEntryForRequest(jobInfo.id, {
+                    filePath: flags['output-file'],
+                    format: flags['result-format'],
+                    columnDelimiter,
+                }, conn.getUsername(), conn.getApiVersion());
+                this.log(messages.getMessage('export.timeout', [jobInfo.id]));
+                return {
+                    jobId: jobInfo.id,
+                    filePath: flags['output-file'],
+                };
+            }
+            catch (err) {
+                ms.stop('failed');
+                throw err;
+            }
+        }
+        const queryJob = new QueryJobV2(conn, {
+            bodyParams: {
+                query: soqlQuery,
+                operation: flags['all-rows'] ? 'queryAll' : 'query',
+                columnDelimiter: flags['column-delimiter'],
+                lineEnding,
+            },
+            pollingOptions: {
+                pollTimeout: timeout.milliseconds,
+                pollInterval: 5000,
+            },
+        });
+        queryJob.on('error', () => {
+            ms.stop('failed');
+        });
+        queryJob.on('open', (jobInfo) => {
+            ms.goto('processing the job', {
+                state: jobInfo.state,
+                id: jobInfo.id,
+            });
+        });
+        ms.goto('creating query job');
+        queryJob.on('jobComplete', (jobInfo) => {
+            ms.goto('exporting records', { state: jobInfo.state });
+        });
+        await queryJob.open();
+        try {
+            const jobInfo = await exportRecords(conn, queryJob, {
+                filePath: flags['output-file'],
+                format: flags['result-format'],
+                columnDelimiter,
+            });
+            ms.stop();
+            this.log(`${jobInfo.numberRecordsProcessed} records written to ${flags['output-file']}`);
+            return {
+                totalSize: jobInfo.numberRecordsProcessed,
+                filePath: flags['output-file'],
+            };
+        }
+        catch (err) {
+            ms.stop('failed');
+            throw err;
+        }
+    }
+}
+//# sourceMappingURL=bulk.js.map

package/lib/commands/data/export/bulk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk.js","sourceRoot":"","sources":["../../../../src/commands/data/export/bulk.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,YAAY,MAAM,eAAe,CAAC;AACzC,OAAO,EAAkB,UAAU,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEtD,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,yBAAyB,EAAE,kBAAkB,CAAC,CAAC;AAQtF,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,SAA+B;IAClE,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;QACpC,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC;YACnB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;YAClD,IAAI,EAAE,GAAG;YACT,SAAS,EAAE,WAAW;YACtB,IAAI,EAAE,SAAS;YACf,SAAS,EAAE,CAAC,OAAO,CAAC;SACrB,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;YACnB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,qBAAqB,CAAC;YACnD,SAAS,EAAE,CAAC,MAAM,CAAC;SACpB,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;YAClB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,qBAAqB,CAAC;YACnD,IAAI,EAAE,GAAG;YACT,SAAS,EAAE,CAAC,YAAY,CAAC;SAC1B,CAAC;QACF,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC;YACvB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC;YACxD,MAAM,EAAE,IAAI;YACZ,SAAS,EAAE,CAAC,OAAO,CAAC;SACrB,CAAC;QACF,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC;YACxB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;SACvD,CAAC;QACF,aAAa,EAAE,KAAK,CAAC,IAAI,CAAC;YACxB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,2BAA2B,CAAC;YACzD,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC;YAC5B,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,CAAU;YACjC,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,6BAA6B,CAAC;YAC3D,IAAI,EAAE,GAAG;SACV,CAAC,EAAE;QACJ,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC;YAC/B,OAAO,EAAE,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,CAAU;YAC7E,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,gCAAgC,CAAC;YAC9D,aAAa,EAAE;gBACb;oBACE,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE;wBACL;4BACE,IAAI,EAAE,eAAe;4BACrB,4DAA4D;4BAC5D,IAAI,EAAE,KAAK,EAAE,KAAK,EAAoB,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,KAAK;yBAC1E;qBACF;iBACF;aACF;SACF,CAAC,EAAE;QACJ,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC;YAC1B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,2BAA2B,CAAC;YACzD,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,CAAU;YAChC,aAAa,EAAE;gBACb;oBACE,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE;wBACL;4BACE,IAAI,EAAE,eAAe;4BACrB,4DAA4D;4BAC5D,IAAI,EAAE,KAAK,EAAE,KAAK,EAAoB,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,KAAK;yBAC1E;qBACF;iBACF;aACF;SACF,CAAC,EAAE;KACL,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAEnD,MAAM,IAAI,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;QAErE,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAEtF,4GAA4G;QAC5G,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,YAAY,CAAW,EAAE,MAAM,CAAC,CAAC;QAExF,MAAM,UAAU,GAAG,KAAK,CAAC,aAAa,CAAC,IAAI,QAAQ,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;QAElF,MAAM,eAAe,GAAG,KAAK,CAAC,kBAAkB,CAAC,IAAI,OAAO,CAAC;QAE7D,MAAM,KAAK,GAAG,OAAO,CAAC,YAAY,KAAK,CAAC,CAAC;QAEzC,MAAM,OAAO,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAS,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;QAEzF,MAAM,EAAE,GAAG,IAAI,gBAAgB,CAAiB;YAC9C,WAAW,EAAE,KAAK,CAAC,IAAI,IAAI,KAAK;YAChC,MAAM,EAAE,KAAK;gBACX,CAAC,CAAC,CAAC,oBAAoB,EAAE,MAAM,CAAC;gBAChC,CAAC,CAAC,CAAC,oBAAoB,EAAE,oBAAoB,EAAE,mBAAmB,CAAC;YACrE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,gBAAgB;YAC1D,eAAe,EAAE;gBACf;oBACE,KAAK,EAAE,QAAQ;oBACf,IAAI,EAAE,mBAAmB;oBACzB,IAAI,EAAE,IAAI;oBACV,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,KAAK;iBAC3B;gBACD;oBACE,KAAK,EAAE,QAAQ;oBACf,IAAI,EAAE,mBAAmB;oBACzB,IAAI,EAAE,IAAI;oBACV,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,CACZ,IAAI,EAAE,EAAE;wBACR,YAAY,CACV,IAAI,CAAC,EAAE,EACP,GAAG,OAAO,mDAAmD,kBAAkB,CAAC,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC,EAAE,CACjG;iBACJ;aACF;SACF,CAAC,CAAC;QAEH,mEAAmE;QACnE,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,IAAI,EAAE;gBAC/B,UAAU,EAAE;oBACV,KAAK,EAAE,SAAS;oBAChB,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO;oBACnD,eAAe;oBACf,UAAU;iBACX;gBACD,cAAc,EAAE;oBACd,WAAW,EAAE,OAAO,CAAC,YAAY;oBACjC,YAAY,EAAE,IAAI;iBACnB;aACF,CAAC,CAAC;YAEH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBACtB,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAClB,MAAM,GAAG,CAAC;YACZ,CAAC,CAAC,CAAC;YAEH,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,OAAuB,EAAE,EAAE;gBACzC,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;gBACpC,EAAE,CAAC,IAAI,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;YAE9B,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;gBAEjC,MAAM,KAAK,GAAG,MAAM,sBAAsB,CAAC,MAAM,EAAE,CAAC;gBACpD,MAAM,KAAK,CAAC,0BAA0B,CACpC,OAAO,CAAC,EAAE,EACV;oBACE,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC;oBAC9B,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC;oBAC9B,eAAe;iBAChB,EACD,IAAI,CAAC,WAAW,EAAE,EAClB,IAAI,CAAC,aAAa,EAAE,CACrB,CAAC;gBAEF,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBAE9D,OAAO;oBACL,KAAK,EAAE,OAAO,CAAC,EAAE;oBACjB,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC;iBAC/B,CAAC;YACJ,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAClB,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,UAAU,CAAC,IAAI,EAAE;YACpC,UAAU,EAAE;gBACV,KAAK,EAAE,SAAS;gBAChB,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO;gBACnD,eAAe,EAAE,KAAK,CAAC,kBAAkB,CAAC;gBAC1C,UAAU;aACX;YACD,cAAc,EAAE;gBACd,WAAW,EAAE,OAAO,CAAC,YAAY;gBACjC,YAAY,EAAE,IAAI;aACnB;SACF,CAAC,CAAC;QAEH,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACxB,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,OAAuB,EAAE,EAAE;YAC9C,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE;gBAC5B,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,EAAE,EAAE,OAAO,CAAC,EAAE;aACf,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAE9B,QAAQ,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,OAAuB,EAAE,EAAE;YACrD,EAAE,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEtB,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,QAAQ,EAAE;gBAClD,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC;gBAC9B,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC;gBAC9B,eAAe;aAChB,CAAC,CAAC;YAEH,EAAE,CAAC,IAAI,EAAE,CAAC;YAEV,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,sBAAsB,uBAAuB,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;YAEzF,OAAO;gBACL,SAAS,EAAE,OAAO,CAAC,sBAAsB;gBACzC,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC;aAC/B,CAAC;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAClB,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC"}

package/lib/commands/data/export/resume.js

@@ -0,0 +1,82 @@
+/*
+ * Copyright (c) 2023, 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 { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+import { QueryJobV2 } from '@jsforce/jsforce-node/lib/api/bulk2.js';
+import { MultiStageOutput } from '@oclif/multi-stage-output';
+import { BulkExportRequestCache } from '../../../bulkDataRequestCache.js';
+import { exportRecords } from '../../../bulkUtils.js';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-data', 'data.export.resume');
+export default class DataExportResume extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        'job-id': Flags.salesforceId({
+            length: 18,
+            char: 'i',
+            startsWith: '750',
+            summary: messages.getMessage('flags.job-id.summary'),
+            exactlyOne: ['job-id', 'use-most-recent'],
+        }),
+        'use-most-recent': Flags.boolean({
+            summary: messages.getMessage('flags.use-most-recent.summary'),
+            exactlyOne: ['job-id', 'use-most-recent'],
+        }),
+        'api-version': Flags.orgApiVersion(),
+    };
+    async run() {
+        const { flags } = await this.parse(DataExportResume);
+        const cache = await BulkExportRequestCache.create();
+        const resumeOpts = await cache.resolveResumeOptionsFromCache(flags['job-id'] ?? flags['use-most-recent'], flags['api-version']);
+        const queryJob = new QueryJobV2(resumeOpts.options.connection, {
+            id: resumeOpts.jobInfo.id,
+            pollingOptions: {
+                // both `pollInterval` and `pollTimeout` values are 0 (set in BulkExportRequestCache.resolveResumeOptionsFromCache).
+                // So we set the interval to 5s and timeout to 30s (otherwise jsforce would throw a timeout err if passed 0ms).
+                pollInterval: Math.max(resumeOpts.options.pollingOptions.pollInterval, 5000),
+                pollTimeout: Math.max(resumeOpts.options.pollingOptions.pollTimeout, 30_000),
+            },
+        });
+        const ms = new MultiStageOutput({
+            title: 'Exporting data',
+            jsonEnabled: flags.json ?? false,
+            stages: ['checking query job status', 'exporting records'],
+            postStagesBlock: [
+                {
+                    label: 'Status',
+                    type: 'dynamic-key-value',
+                    bold: true,
+                    get: (data) => data?.state,
+                },
+            ],
+        });
+        ms.goto('checking query job status');
+        queryJob.on('jobComplete', (jobInfo) => {
+            ms.goto('exporting records', { state: jobInfo.state });
+        });
+        queryJob.on('error', (err) => {
+            ms.stop('failed');
+            throw err;
+        });
+        try {
+            const jobInfo = await exportRecords(resumeOpts.options.connection, queryJob, resumeOpts.outputInfo);
+            ms.stop();
+            this.log(`${jobInfo.numberRecordsProcessed} records written to ${resumeOpts.outputInfo.filePath}`);
+            return {
+                totalSize: jobInfo.numberRecordsProcessed,
+                filePath: resumeOpts.outputInfo.filePath,
+            };
+        }
+        catch (err) {
+            ms.stop('failed');
+            throw err;
+        }
+    }
+}
+//# sourceMappingURL=resume.js.map

package/lib/commands/data/export/resume.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resume.js","sourceRoot":"","sources":["../../../../src/commands/data/export/resume.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAkB,UAAU,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEtD,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,yBAAyB,EAAE,oBAAoB,CAAC,CAAC;AAOxF,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,SAAiC;IACtE,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,QAAQ,EAAE,KAAK,CAAC,YAAY,CAAC;YAC3B,MAAM,EAAE,EAAE;YACV,IAAI,EAAE,GAAG;YACT,UAAU,EAAE,KAAK;YACjB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,sBAAsB,CAAC;YACpD,UAAU,EAAE,CAAC,QAAQ,EAAE,iBAAiB,CAAC;SAC1C,CAAC;QACF,iBAAiB,EAAE,KAAK,CAAC,OAAO,CAAC;YAC/B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,+BAA+B,CAAC;YAC7D,UAAU,EAAE,CAAC,QAAQ,EAAE,iBAAiB,CAAC;SAC1C,CAAC;QACF,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;KACrC,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAErD,MAAM,KAAK,GAAG,MAAM,sBAAsB,CAAC,MAAM,EAAE,CAAC;QAEpD,MAAM,UAAU,GAAG,MAAM,KAAK,CAAC,6BAA6B,CAC1D,KAAK,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,iBAAiB,CAAC,EAC3C,KAAK,CAAC,aAAa,CAAC,CACrB,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,UAAU,EAAE;YAC7D,EAAE,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE;YACzB,cAAc,EAAE;gBACd,oHAAoH;gBACpH,+GAA+G;gBAC/G,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC,YAAY,EAAE,IAAI,CAAC;gBAC5E,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM,CAAC;aAC7E;SACF,CAAC,CAAC;QAEH,MAAM,EAAE,GAAG,IAAI,gBAAgB,CAAiB;YAC9C,KAAK,EAAE,gBAAgB;YACvB,WAAW,EAAE,KAAK,CAAC,IAAI,IAAI,KAAK;YAChC,MAAM,EAAE,CAAC,2BAA2B,EAAE,mBAAmB,CAAC;YAC1D,eAAe,EAAE;gBACf;oBACE,KAAK,EAAE,QAAQ;oBACf,IAAI,EAAE,mBAAmB;oBACzB,IAAI,EAAE,IAAI;oBACV,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,KAAK;iBAC3B;aACF;SACF,CAAC,CAAC;QACH,EAAE,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAErC,QAAQ,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,OAAuB,EAAE,EAAE;YACrD,EAAE,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YAC3B,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAClB,MAAM,GAAG,CAAC;QACZ,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;YAEpG,EAAE,CAAC,IAAI,EAAE,CAAC;YAEV,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,sBAAsB,uBAAuB,UAAU,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;YAEnG,OAAO;gBACL,SAAS,EAAE,OAAO,CAAC,sBAAsB;gBACzC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,QAAQ;aACzC,CAAC;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAClB,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC"}

package/lib/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAcA,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,2CAAK,CAAA;IACL,2DAAa,CAAA;IACb,2DAAa,CAAA;AACf,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB;AA+CD,yEAAyE;AACzE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAI,OAAgB,EAAoC,EAAE,CACxF,KAAK,CAAC,OAAO,CAAE,OAAiC,EAAE,OAAO,CAAC,CAAC;AAE7D,0EAA0E;AAC1E,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAI,OAAgB,EAAoC,EAAE,CAChG,gBAAgB,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;AAE1D,4DAA4D;AAC5D,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAI,KAAmB,EAA4C,EAAE,CACzG,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAErE,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAgB,EAA6C,EAAE,CACjG,CAAC,CAAE,OAA0C,CAAC,WAAW,IAAI,CAAC,CAAE,OAA0C,CAAC,IAAI,CAAC;AAElH,4DAA4D;AAC5D,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,KAAmB,EAA2D,EAAE,CAChH,KAAK,CAAC,CAAC,CAAC,KAAK,YAAY,IAAI,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAeA,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,2CAAK,CAAA;IACL,2DAAa,CAAA;IACb,2DAAa,CAAA;AACf,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB;AA+CD,yEAAyE;AACzE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAI,OAAgB,EAAoC,EAAE,CACxF,KAAK,CAAC,OAAO,CAAE,OAAiC,EAAE,OAAO,CAAC,CAAC;AAE7D,0EAA0E;AAC1E,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAI,OAAgB,EAAoC,EAAE,CAChG,gBAAgB,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;AAE1D,4DAA4D;AAC5D,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAI,KAAmB,EAA4C,EAAE,CACzG,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAErE,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAgB,EAA6C,EAAE,CACjG,CAAC,CAAE,OAA0C,CAAC,WAAW,IAAI,CAAC,CAAE,OAA0C,CAAC,IAAI,CAAC;AAElH,4DAA4D;AAC5D,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,KAAmB,EAA2D,EAAE,CAChH,KAAK,CAAC,CAAC,CAAC,KAAK,YAAY,IAAI,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC"}

package/messages/data.export.bulk.md

@@ -0,0 +1,67 @@
+# summary
+
+Bulk export records from an org into a file using a SOQL query. Uses Bulk API 2.0.
+
+# description
+
+You can use this command to export millions of records from an org, either to migrate data or to back it up.
+
+Use a SOQL query to specify the fields of a standard or custom object that you want to export. Specify the SOQL query either at the command line with the --query flag or read it from a file with the --query-file flag; you can't specify both flags. The --output-file flag is required, which means you can only write the records to a file, in either CSV or JSON format. 
+
+Bulk exports can take a while, depending on how many records are returned by the SOQL query. 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 export resume" and pass the job ID to the --job-id flag.
+
+IMPORTANT: This command uses Bulk API 2.0, which limits the type of SOQL queries you can run. For example, you can't use aggregate functions such as count(). For the complete list of limitations, see the "SOQL Considerations" section in the "Bulk API 2.0 and Bulk API Developer Guide" (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm).
+
+# examples
+
+- Export the Id, Name, and Account.Name fields of the Contact object into a CSV-formatted file; if the export doesn't complete in 10 minutes, the command ends and displays a job ID. Use the org with alias "my-scratch":
+
+  <%= config.bin %> <%= command.id %> --query "SELECT Id, Name, Account.Name FROM Contact" --output-file export-accounts.csv --wait 10 --target-org my-scratch
+
+- Similar to previous example, but use the default org, export the records into a JSON-formatted file, and include records that have been soft deleted:
+
+  <%= config.bin %> <%= command.id %> --query "SELECT Id, Name, Account.Name FROM Contact" --output-file export-accounts.json --result-format json --wait 10 --all-rows
+
+- Export asynchronously; the command immediately returns a job ID that you then pass to the "sf data export resume" command:
+
+  <%= config.bin %> <%= command.id %> --query "SELECT Id, Name, Account.Name FROM Contact" --output-file export-accounts.json --result-format json --async
+
+# flags.wait.summary
+
+Time to wait for the command to finish, in minutes.
+
+# flags.async.summary
+
+Don't wait for the job to complete.
+
+# flags.query.summary
+
+SOQL query to execute.
+
+# flags.all-rows.summary
+
+Include records that have been soft-deleted due to a merge or delete. By default, deleted records are not returned.
+
+# flags.output-file.summary
+
+File where records are written.
+
+# flags.result-format.summary
+
+Format to write the results.
+
+# flags.column-delimiter.summary
+
+Column delimiter to be used when writing CSV output. Default is COMMA.
+
+# flags.line-ending.summary
+
+Line ending to be used when writing CSV output. Default value on Windows is is `CRLF`; on macOS and Linux it's `LR`.
+
+# flags.query-file.summary
+
+File that contains the SOQL query.
+
+# export.timeout
+
+Run "sf data export resume --job-id %s" to get the latest status and results.

package/messages/data.export.resume.md

@@ -0,0 +1,25 @@
+# summary
+
+Resume a bulk export job that you previously started.
+
+# description
+
+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 the --use-most-recent flag to specify the most recent bulk export job.
+
+# flags.job-id.summary
+
+Job ID of the bulk export.
+
+# flags.use-most-recent.summary
+
+Use the job ID of the bulk export job that was most recently run.
+
+# examples
+
+- Resume a bulk export job run on your default org by specifying a job ID:
+
+  sf <%= command.id %> --job-id 750xx000000005sAAA
+
+- Resume the most recently-run bulk export job for an org with alias my-scratch:
+
+  sf data export resume --use-most-recent --target-org my-scratch

package/messages/messages.md

@@ -52,7 +52,11 @@ Format to display the results; the --json flag overrides this flag.
 
 The bulk request id must be supplied when not looking for most recent cache entry.
 
-# cannotFindMostRecentCacheEntry
+# error.bulkRequestIdNotFound
+
+Could not find a cache entry for job ID %s
+
+# error.missingCacheEntryError
 
 Could not load a most recent cache entry for a bulk request. Please rerun your command with a bulk request id.