@salesforce/plugin-data 3.7.1 → 3.8.1

package/oclif.manifest.json

@@ -1446,7 +1446,7 @@
           "required": true,
           "summary": "SOQL query, or filepath of a file that contains the query, to retrieve records.",
           "hasDynamicHelp": false,
-          "multiple": false,
+          "multiple": true,
           "type": "option"
         },
         "plan": {
@@ -1726,6 +1726,203 @@
         "record:get:data"
       ]
     },
+    "data:import:bulk": {
+      "aliases": [],
+      "args": {},
+      "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).",
+      "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:\n<%= 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:\n<%= config.bin %> <%= command.id %> --file accounts.csv --sobject Account --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"
+        },
+        "async": {
+          "char": "a",
+          "exclusive": [
+            "wait"
+          ],
+          "name": "async",
+          "summary": "Don't wait for the command to complete.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "file": {
+          "char": "f",
+          "name": "file",
+          "required": true,
+          "summary": "CSV file that contains the Salesforce object records you want to import.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "sobject": {
+          "char": "s",
+          "name": "sobject",
+          "required": true,
+          "summary": "API name of the Salesforce object, either standard or custom, into which you're importing records.",
+          "hasDynamicHelp": false,
+          "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,
+          "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"
+        },
+        "line-ending": {
+          "dependsOn": [
+            "file"
+          ],
+          "name": "line-ending",
+          "summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LR`.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "CRLF",
+            "LF"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "data:import:bulk",
+      "pluginAlias": "@salesforce/plugin-data",
+      "pluginName": "@salesforce/plugin-data",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Bulk import records into a Salesforce object from a CSV file. Uses Bulk API 2.0.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "data",
+        "import",
+        "bulk.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "data:import:bulk",
+        "import:data:bulk",
+        "import:bulk:data",
+        "data:bulk:import",
+        "bulk:data:import",
+        "bulk:import:data"
+      ]
+    },
+    "data:import:resume": {
+      "aliases": [],
+      "args": {},
+      "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:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
+        "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"
+      ],
+      "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"
+        },
+        "use-most-recent": {
+          "name": "use-most-recent",
+          "summary": "Use the job ID of the bulk import job that was most recently run.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "job-id": {
+          "char": "i",
+          "name": "job-id",
+          "summary": "Job ID of the bulk import.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "wait": {
+          "char": "w",
+          "name": "wait",
+          "summary": "Time to wait for the command to finish, in minutes.",
+          "default": "5 minutes",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "data:import:resume",
+      "pluginAlias": "@salesforce/plugin-data",
+      "pluginName": "@salesforce/plugin-data",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Resume a bulk import job that you previously started. Uses Bulk API 2.0.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "data",
+        "import",
+        "resume.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "data:import:resume",
+        "import:data:resume",
+        "import:resume:data",
+        "data:resume:import",
+        "resume:data:import",
+        "resume:import:data"
+      ]
+    },
     "data:import:tree": {
       "aliases": [
         "force:data:tree:import",
@@ -3336,5 +3533,5 @@
       ]
     }
   },
-  "version": "3.7.1"
+  "version": "3.8.1"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/plugin-data",
-    "version": "3.7.1",
+    "version": "3.8.1",
     "description": "Plugin for salesforce data commands",
     "author": "Salesforce",
     "homepage": "https://github.com/salesforcecli/plugin-data",
@@ -60,7 +60,8 @@
                         "description": "Get a single record."
                     },
                     "import": {
-                        "description": "Import data to your org."
+                        "description": "Import data to your org.",
+                        "external": true
                     },
                     "query": {
                         "description": "Query records."
@@ -123,8 +124,8 @@
     },
     "devDependencies": {
         "@oclif/core": "^4.0.19",
-        "@oclif/plugin-command-snapshot": "^5.2.15",
-        "@salesforce/cli-plugins-testkit": "^5.3.33",
+        "@oclif/plugin-command-snapshot": "^5.2.19",
+        "@salesforce/cli-plugins-testkit": "^5.3.34",
         "@salesforce/dev-scripts": "^10.2.10",
         "@salesforce/plugin-command-reference": "^3.1.27",
         "@salesforce/types": "^1.2.0",
@@ -254,7 +255,7 @@
     "exports": "./lib/index.js",
     "type": "module",
     "sfdx": {
-        "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"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.8.1.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.8.1.sig"
     }
 }