@salesforce/plugin-data 3.0.22 → 3.1.0

package/oclif.manifest.json

@@ -883,7 +883,7 @@
       "deprecateAliases": true,
       "description": "Specify a SOQL query, either directly at the command line or read from a file, to retrieve the data you want to export. The exported data is written to JSON files in sObject tree format, which is a collection of nested, parent-child records with a single root record. Use these JSON files to import data into an org with the \"<%= config.bin %> data import tree\" command.\n\nIf your SOQL query references multiple objects, the command generates a single JSON file by default. You can specify the --plan flag to generate separate JSON files for each object and a plan definition file that aggregates them. You then specify just this plan definition file when you import the data into an org.\n\nThe SOQL query can return a maximum of 2,000 records. For more information, see the REST API Developer Guide. (https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm).",
       "examples": [
-        "Export records retrieved with the specified SOQL query into a single JSON file in the current directory; the command uses your default org:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id, Name, (SELECT Name, Address__c FROM Properties__r) FROM Broker__c\"",
+        "Export records retrieved with the specified SOQL query into a single JSON file in the current directory; the command uses your default org:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id, Name, (SELECT Name, Address\\_\\_c FROM Properties\\_\\_r) FROM Broker\\_\\_c\"",
         "Export data using a SOQL query in the \"query.txt\" file and generate JSON files for each object and a plan that aggregates them:\n<%= config.bin %> <%= command.id %> --query query.txt --plan",
         "Prepend \"export-demo\" before each generated file and generate the files in the \"export-out\" directory; run the command on the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --query query.txt --plan --prefix export-demo --output-dir export-out --target-org my-scratch"
       ],
@@ -1270,6 +1270,9 @@
           ],
           "char": "c",
           "deprecateAliases": true,
+          "deprecated": {
+            "message": "The `config-type` flag is deprecated and will be moved to a `legacy` command after July 10, 2024. It will be completely removed after Nov 10, 2024. Use the new `data tree beta import` command."
+          },
           "hidden": true,
           "name": "content-type",
           "summary": "Content type of import files if their extention is not .json.",
@@ -1282,6 +1285,10 @@
             "confighelp"
           ],
           "deprecateAliases": true,
+          "deprecated": {
+            "message": "The `config-help` flag is deprecated and will be moved to a `legacy` command after July 10, 2024. It will be completely removed after Nov 10, 2024. Use the new `data tree beta import` command."
+          },
+          "hidden": true,
           "name": "config-help",
           "summary": "Display schema information for the --plan configuration file to stdout; if you specify this flag, all other flags except --json are ignored.",
           "allowNo": false,
@@ -2011,6 +2018,264 @@
         "resume:upsert:data"
       ]
     },
+    "data:export:beta:tree": {
+      "aliases": [],
+      "args": {},
+      "description": "Specify a SOQL query, either directly at the command line or read from a file, to retrieve the data you want to export. The exported data is written to JSON files in sObject tree format, which is a collection of nested, parent-child records with a single root record. Use these JSON files to import data into an org with the \"<%= config.bin %> data import tree\" command.\n\nIf your SOQL query references multiple objects, the command generates a single JSON file by default. You can specify the --plan flag to generate separate JSON files for each object and a plan definition file that aggregates them. You then specify just this plan definition file when you import the data into an org.\n\nThe SOQL query can return a maximum of 2,000 records. For more information, see the REST API Developer Guide. (https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm).",
+      "examples": [
+        "Export records retrieved with the specified SOQL query into a single JSON file in the current directory; the command uses your default org:\n<%= config.bin %> <%= command.id %> --query \"SELECT Id, Name, (SELECT Name, Address\\_\\_c FROM Properties\\_\\_r) FROM Broker\\_\\_c\"",
+        "Export data using a SOQL query in the \"query.txt\" file and generate JSON files for each object and a plan that aggregates them:\n<%= config.bin %> <%= command.id %> --query query.txt --plan",
+        "Prepend \"export-demo\" before each generated file and generate the files in the \"export-out\" directory; run the command on the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --query query.txt --plan --prefix export-demo --output-dir export-out --target-org my-scratch"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "target-org": {
+          "aliases": [
+            "targetusername",
+            "u"
+          ],
+          "char": "o",
+          "deprecateAliases": true,
+          "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": {
+          "aliases": [
+            "apiversion"
+          ],
+          "deprecateAliases": true,
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "loglevel": {
+          "deprecated": {
+            "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
+          },
+          "hidden": true,
+          "name": "loglevel",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "query": {
+          "char": "q",
+          "name": "query",
+          "required": true,
+          "summary": "SOQL query, or filepath of a file that contains the query, to retrieve records.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "plan": {
+          "char": "p",
+          "name": "plan",
+          "summary": "Generate multiple sObject tree files and a plan definition file for aggregated import.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "prefix": {
+          "char": "x",
+          "name": "prefix",
+          "summary": "Prefix of generated files.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "output-dir": {
+          "aliases": [
+            "outputdir"
+          ],
+          "char": "d",
+          "deprecateAliases": true,
+          "name": "output-dir",
+          "summary": "Directory in which to generate the JSON files; default is current directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "data:export:beta:tree",
+      "pluginAlias": "@salesforce/plugin-data",
+      "pluginName": "@salesforce/plugin-data",
+      "pluginType": "core",
+      "state": "beta",
+      "strict": true,
+      "summary": "Export data from an org into one or more JSON files.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "data",
+        "export",
+        "beta",
+        "tree.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "data:export:beta:tree",
+        "export:data:beta:tree",
+        "export:beta:data:tree",
+        "export:beta:tree:data",
+        "data:beta:export:tree",
+        "beta:data:export:tree",
+        "beta:export:data:tree",
+        "beta:export:tree:data",
+        "data:beta:tree:export",
+        "beta:data:tree:export",
+        "beta:tree:data:export",
+        "beta:tree:export:data",
+        "data:export:tree:beta",
+        "export:data:tree:beta",
+        "export:tree:data:beta",
+        "export:tree:beta:data",
+        "data:tree:export:beta",
+        "tree:data:export:beta",
+        "tree:export:data:beta",
+        "tree:export:beta:data",
+        "data:tree:beta:export",
+        "tree:data:beta:export",
+        "tree:beta:data:export",
+        "tree:beta:export:data"
+      ]
+    },
+    "data:import:beta:tree": {
+      "aliases": [],
+      "args": {},
+      "description": "The JSON files that contain the data are in sObject tree format, which is a collection of nested, parent-child records with a single root record. Use the \"<%= config.bin %> data export tree\" command to generate these JSON files.\n\nIf you used the --plan flag when exporting the data to generate a plan definition file, use the --plan flag to reference the file when you import. If you're not using a plan, use the --files flag to list the files. If you specify multiple JSON files that depend on each other in a parent-child relationship, be sure you list them in the correct order.",
+      "examples": [
+        "Import the records contained in two JSON files into the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --files Contact.json,Account.json --target-org my-scratch",
+        "Import records using a plan definition file into your default org:\n<%= config.bin %> <%= command.id %> --plan Account-Contact-plan.json"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "target-org": {
+          "aliases": [
+            "targetusername",
+            "u"
+          ],
+          "char": "o",
+          "deprecateAliases": true,
+          "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": {
+          "aliases": [
+            "apiversion"
+          ],
+          "deprecateAliases": true,
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "loglevel": {
+          "deprecated": {
+            "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
+          },
+          "hidden": true,
+          "name": "loglevel",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "files": {
+          "aliases": [
+            "sobjecttreefiles"
+          ],
+          "char": "f",
+          "deprecateAliases": true,
+          "name": "files",
+          "summary": "Comma-separated and in-order JSON files that contain the records, in sObject tree format, that you want to insert.",
+          "delimiter": ",",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "plan": {
+          "char": "p",
+          "name": "plan",
+          "summary": "Plan definition file to insert multiple data files.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "data:import:beta:tree",
+      "pluginAlias": "@salesforce/plugin-data",
+      "pluginName": "@salesforce/plugin-data",
+      "pluginType": "core",
+      "state": "beta",
+      "strict": true,
+      "summary": "Import data from one or more JSON files into an org.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "data",
+        "import",
+        "beta",
+        "tree.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "data:import:beta:tree",
+        "import:data:beta:tree",
+        "import:beta:data:tree",
+        "import:beta:tree:data",
+        "data:beta:import:tree",
+        "beta:data:import:tree",
+        "beta:import:data:tree",
+        "beta:import:tree:data",
+        "data:beta:tree:import",
+        "beta:data:tree:import",
+        "beta:tree:data:import",
+        "beta:tree:import:data",
+        "data:import:tree:beta",
+        "import:data:tree:beta",
+        "import:tree:data:beta",
+        "import:tree:beta:data",
+        "data:tree:import:beta",
+        "tree:data:import:beta",
+        "tree:import:data:beta",
+        "tree:import:beta:data",
+        "data:tree:beta:import",
+        "tree:data:beta:import",
+        "tree:beta:data:import",
+        "tree:beta:import:data"
+      ]
+    },
     "force:data:bulk:delete": {
       "aliases": [],
       "args": {},
@@ -2430,5 +2695,5 @@
       ]
     }
   },
-  "version": "3.0.22"
+  "version": "3.1.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/plugin-data",
-    "version": "3.0.22",
+    "version": "3.1.0",
     "description": "Plugin for salesforce data commands",
     "author": "Salesforce",
     "homepage": "https://github.com/salesforcecli/plugin-data",
@@ -111,7 +111,7 @@
         "@oclif/core": "^3.19.1",
         "@salesforce/core": "^6.5.3",
         "@salesforce/kit": "^3.0.15",
-        "@salesforce/sf-plugins-core": "^7.1.4",
+        "@salesforce/sf-plugins-core": "^7.1.9",
         "@salesforce/ts-types": "^2.0.9",
         "chalk": "^5.3.0",
         "change-case": "^5.4.3",
@@ -120,14 +120,14 @@
         "jsforce": "^2.0.0-beta.29"
     },
     "devDependencies": {
-        "@oclif/plugin-command-snapshot": "^5.0.7",
+        "@oclif/plugin-command-snapshot": "^5.0.9",
         "@salesforce/cli-plugins-testkit": "^5.1.9",
         "@salesforce/dev-scripts": "^8.3.0",
-        "@salesforce/plugin-command-reference": "^3.0.65",
+        "@salesforce/plugin-command-reference": "^3.0.67",
         "@types/chai-as-promised": "^7.1.8",
         "chai-as-promised": "^7.1.1",
         "eslint-plugin-sf-plugin": "^1.17.3",
-        "oclif": "^4.4.8",
+        "oclif": "^4.4.14",
         "shx": "^0.3.3",
         "ts-node": "^10.9.2",
         "typescript": "^5.2.2"
@@ -250,7 +250,7 @@
     "exports": "./lib/index.js",
     "type": "module",
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.0.22.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.0.22.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.1.0.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/3.1.0.sig"
     }
 }