@salesforce/plugin-data 3.6.9 → 3.7.1

package/oclif.manifest.json

@@ -1116,6 +1116,265 @@
         "resume:delete:data"
       ]
     },
+    "data:export:bulk": {
+      "aliases": [],
+      "args": {},
+      "description": "You can use this command to export millions of records from an org, either to migrate data or to back it up.\n\nUse 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. \n\nBulk 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.\n\nIMPORTANT: 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\":\n<%= 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:\n<%= 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:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id, Name, Account.Name FROM Contact\" --output-file export-accounts.json --result-format json --async"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-version": {
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "wait": {
+          "char": "w",
+          "exclusive": [
+            "async"
+          ],
+          "name": "wait",
+          "summary": "Time to wait for the command to finish, in minutes.",
+          "hasDynamicHelp": true,
+          "helpValue": "<minutes>",
+          "multiple": false,
+          "type": "option"
+        },
+        "async": {
+          "exclusive": [
+            "wait"
+          ],
+          "name": "async",
+          "summary": "Don't wait for the job to complete.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "query": {
+          "char": "q",
+          "exclusive": [
+            "query-file"
+          ],
+          "name": "query",
+          "summary": "SOQL query to execute.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "query-file": {
+          "exclusive": [
+            "query"
+          ],
+          "name": "query-file",
+          "summary": "File that contains the SOQL query.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "all-rows": {
+          "name": "all-rows",
+          "summary": "Include records that have been soft-deleted due to a merge or delete. By default, deleted records are not returned.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "output-file": {
+          "name": "output-file",
+          "required": true,
+          "summary": "File where records are written.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "result-format": {
+          "char": "r",
+          "name": "result-format",
+          "required": true,
+          "summary": "Format to write the results.",
+          "default": "csv",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "csv",
+            "json"
+          ],
+          "type": "option"
+        },
+        "column-delimiter": {
+          "name": "column-delimiter",
+          "relationships": [
+            {
+              "type": "some",
+              "flags": [
+                {
+                  "name": "result-format"
+                }
+              ]
+            }
+          ],
+          "summary": "Column delimiter to be used when writing CSV output. Default is COMMA.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "BACKQUOTE",
+            "CARET",
+            "COMMA",
+            "PIPE",
+            "SEMICOLON",
+            "TAB"
+          ],
+          "type": "option"
+        },
+        "line-ending": {
+          "name": "line-ending",
+          "relationships": [
+            {
+              "type": "some",
+              "flags": [
+                {
+                  "name": "result-format"
+                }
+              ]
+            }
+          ],
+          "summary": "Line ending to be used when writing CSV output. Default value on Windows is is `CRLF`; on macOS and Linux it's `LR`.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "LF",
+            "CRLF"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "data:export:bulk",
+      "pluginAlias": "@salesforce/plugin-data",
+      "pluginName": "@salesforce/plugin-data",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Bulk export records from an org into a file using a SOQL query. Uses Bulk API 2.0.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "data",
+        "export",
+        "bulk.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "data:export:bulk",
+        "export:data:bulk",
+        "export:bulk:data",
+        "data:bulk:export",
+        "bulk:data:export",
+        "bulk:export:data"
+      ]
+    },
+    "data:export:resume": {
+      "aliases": [],
+      "args": {},
+      "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.",
+      "examples": [
+        "Resume a bulk export job run on your default org by specifying a job ID:\nsf <%= command.id %> --job-id 750xx000000005sAAA",
+        "Resume the most recently-run bulk export job for an org with alias my-scratch:\nsf data export resume --use-most-recent --target-org my-scratch"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "job-id": {
+          "char": "i",
+          "name": "job-id",
+          "summary": "Job ID of the bulk export.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "use-most-recent": {
+          "name": "use-most-recent",
+          "summary": "Use the job ID of the bulk export job that was most recently run.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "api-version": {
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "data:export:resume",
+      "pluginAlias": "@salesforce/plugin-data",
+      "pluginName": "@salesforce/plugin-data",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Resume a bulk export job that you previously started.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "data",
+        "export",
+        "resume.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "data:export:resume",
+        "export:data:resume",
+        "export:resume:data",
+        "data:resume:export",
+        "resume:data:export",
+        "resume:export:data"
+      ]
+    },
     "data:export:tree": {
       "aliases": [
         "force:data:tree:export",
@@ -3077,5 +3336,5 @@
       ]
     }
   },
-  "version": "3.6.9"
+  "version": "3.7.1"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/plugin-data",
-    "version": "3.6.9",
+    "version": "3.7.1",
     "description": "Plugin for salesforce data commands",
     "author": "Salesforce",
     "homepage": "https://github.com/salesforcecli/plugin-data",
@@ -53,7 +53,8 @@
                         "description": "Delete a single record or multiple records in bulk."
                     },
                     "export": {
-                        "description": "Export data from your org."
+                        "description": "Export data from your org.",
+                        "external": true
                     },
                     "get": {
                         "description": "Get a single record."
@@ -108,6 +109,7 @@
     },
     "dependencies": {
         "@jsforce/jsforce-node": "^3.5.1",
+        "@oclif/multi-stage-output": "^0.7.5",
         "@salesforce/core": "^8.6.1",
         "@salesforce/kit": "^3.2.2",
         "@salesforce/sf-plugins-core": "^11.3.10",
@@ -116,16 +118,17 @@
         "change-case": "^5.4.4",
         "csv-parse": "^5.5.6",
         "csv-stringify": "^6.5.1",
-        "form-data": "^4.0.0"
+        "form-data": "^4.0.0",
+        "terminal-link": "^3.0.0"
     },
     "devDependencies": {
         "@oclif/core": "^4.0.19",
         "@oclif/plugin-command-snapshot": "^5.2.15",
-        "@salesforce/cli-plugins-testkit": "^5.3.32",
+        "@salesforce/cli-plugins-testkit": "^5.3.33",
         "@salesforce/dev-scripts": "^10.2.10",
-        "@salesforce/plugin-command-reference": "^3.1.26",
+        "@salesforce/plugin-command-reference": "^3.1.27",
         "@salesforce/types": "^1.2.0",
-        "eslint-plugin-sf-plugin": "^1.20.7",
+        "eslint-plugin-sf-plugin": "^1.20.8",
         "oclif": "^4.14.36",
         "ts-node": "^10.9.2",
         "typescript": "^5.6.2"
@@ -251,7 +254,7 @@
     "exports": "./lib/index.js",
     "type": "module",
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.6.9.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.6.9.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.7.1.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.7.1.sig"
     }
 }