@salesforce/plugin-data 2.1.21 → 2.1.23

package/messages/record.get.md

@@ -0,0 +1,47 @@
+# summary
+
+Retrieve and display a single record of a Salesforce or Tooling API object.
+
+# description
+
+Specify the record you want to retrieve with either its ID or with a list of field-value pairs that identify the record. If your list of fields identifies more than one record, the command fails; the error displays how many records were found.
+
+When specifying field-value pairs, use the format <fieldName>=<value>. Enclose all field-value pairs in one set of double quotation marks, delimited by spaces. Enclose values that contain spaces in single quotes.
+
+The command displays all the record's fields and their values, one field per terminal line. Fields with no values are displayed as "null".
+
+This command retrieves a record from Salesforce objects by default. Use the --use-tooling-api flag to retrieve from a Tooling API object.
+
+# flags.sobject
+
+API name of the Salesforce or Tooling API object that you're retrieving a record from.
+
+# flags.recordId
+
+ID of the record you’re retrieving.
+
+# flags.where
+
+List of <fieldName>=<value> pairs that identify the record you want to display.
+
+# flags.useToolingApi
+
+Use Tooling API so you can retrieve a record from a Tooling API object.
+
+# examples
+
+- Retrieve and display a record from Account with the specified (truncated) ID:
+
+  <%= config.bin %> <%= command.id %> --sobject Account --record-id 00180XX
+
+- Retrieve a record from Account whose name equals "Acme":
+
+  <%= config.bin %> <%= command.id %> --sobject Account --where "Name=Acme"
+
+- Retrieve a record from Account identified with two field values, one that contains a space; the command uses the org with alias "my-scratch":
+
+  <%= config.bin %> <%= command.id %> --sobject Account --where "Name='Universal Containers' Phone='(123) 456-7890'" --target-org myscratch
+
+- Retrieve a record from the Tooling API object TraceFlag with the specified (truncated) ID:
+
+  <%= config.bin %> <%= command.id %> --use-tooling-api --sobject TraceFlag --record-id 7tf8c

package/messages/record.update.md

@@ -0,0 +1,61 @@
+# summary
+
+Updates a single record of a Salesforce or Tooling API object.
+
+# description
+
+Specify the record you want to update with either its ID or with a list of field-value pairs that identify the record. If your list of fields identifies more than one record, the delete fails; the error displays how many records were found.
+
+When using field-value pairs for both identifying the record and specifiyng the new field values, use the format <fieldName>=<value>. Enclose all field-value pairs in one set of double quotation marks, delimited by spaces. Enclose values that contain spaces in single quotes.
+
+This command updates a record in Salesforce objects by default. Use the --use-tooling-api flag to update a Tooling API object.
+
+# flags.sobject
+
+API name of the Salesforce or Tooling API object that contains the record you're updating.
+
+# flags.recordId
+
+ID of the record you’re updating.
+
+# flags.where
+
+List of <fieldName>=<value> pairs that identify the record you want to update.
+
+# flags.useToolingApi
+
+Use Tooling API so you can update a record in a Tooling API object.
+
+# flags.values
+
+Fields that you're updating, in the format of <fieldName>=<value> pairs.
+
+# examples
+
+- Update the Name field of an Account record with the specified (truncated) ID:
+
+  <%= config.bin %> <%= command.id %> --sobject Account --record-id 001D0 --values "Name=NewAcme"
+
+- Update the Name field of an Account record whose current name is 'Old Acme':
+
+  <%= config.bin %> <%= command.id %> --sobject Account --where "Name='Old Acme'" --values "Name='New Acme'"
+
+- Update the Name and Website fields of an Account record with the specified (truncated) ID:
+
+  <%= config.bin %> <%= command.id %> --sobject Account --record-id 001D0 --values "Name='Acme III' Website=www.example.com"
+
+- Update the ExpirationDate field of a record of the Tooling API object TraceFlag using the specified (truncated) ID:
+
+  <%= config.bin %> <%= command.id %> -t --sobject TraceFlag --record-id 7tf170000009cUBAAY --values "ExpirationDate=2017-12-01T00:58:04.000+0000"
+
+# updateSuccess
+
+Successfully updated record: %s.
+
+# updateFailure
+
+Failed to update record. %s
+
+# updateFailureWithFields
+
+Failed to update record with code %s. Message: %s. Fields: %s.

package/messages/soql.query.md

@@ -0,0 +1,72 @@
+# summary
+
+Execute a SOQL query.
+
+# description
+
+Specify the SOQL query at the command line with the --query flag or read the query from a file with the --file flag.
+
+If your query returns more than 10,000 records, specify the --bulk flag. The command then runs the query using Bulk API 2.0, which has higher limits than the default API used by the command.
+
+When using --bulk, the command waits 3 minutes by default for the query to complete. Use the --wait parameter to specify a different number of minutes to wait, or set --wait to 0 to immediately return control to the terminal. If you set --wait to 0, or you use the --async flag, or the command simply times out, the command displays an ID. Pass this ID to the the "data query resume" command using the --bulk-query-id flag to get the results; pass the ID to the "data resume" command to get the job status.
+
+# examples
+
+- Specify a SOQL query at the command line; the command uses your default org:
+
+  <%= config.bin %> <%= command.id %> --query "SELECT Id, Name, Account.Name FROM Contact"
+
+- Read the SOQL query from a file called "query.txt"; the command uses the org with alias "my-scratch":
+
+  <%= config.bin %> <%= command.id %> --file query.txt --target-org my-scratch
+
+- Use Tooling API to run a query on the ApexTrigger Tooling API object:
+
+  <%= config.bin %> <%= command.id %> --query "SELECT Name FROM ApexTrigger" --use-tooling-api
+
+- Use Bulk API 2.0 to run a query that returns many rows, and return control to the terminal immediately:
+
+  <%= config.bin %> <%= command.id %> --query "SELECT Id FROM Contact" --bulk --wait 0
+
+# flags.queryToExecute
+
+SOQL query to execute.
+
+# flags.useToolingApi
+
+Use Tooling API so you can run queries on Tooling API objects.
+
+# flags.file
+
+File that contains the SOQL query.
+
+# flags.bulk
+
+Use Bulk API 2.0 to run the query.
+
+# flags.async
+
+Use Bulk API 2.0, but don't wait for the job to complete.
+
+# flags.wait
+
+Time to wait for the command to finish, in minutes.
+
+# flags.resultFormat
+
+Format to display the results; the --json flag overrides this flag.
+
+# displayQueryRecordsRetrieved
+
+Total number of records retrieved: %s.
+
+# queryRunningMessage
+
+Querying Data
+
+# bulkQueryTimeout
+
+Query ID: %s
+Query is in progress.
+
+Run "data query resume -i %s -o %s" to get the latest status and results.

package/messages/tree.export.md

@@ -0,0 +1,41 @@
+# summary
+
+Export data from an org into one or more JSON files.
+
+# 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.
+
+If 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.
+
+The 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).
+
+# flags.query
+
+SOQL query, or filepath of a file that contains the query, to retrieve records.
+
+# flags.plan
+
+Generate multiple sObject tree files and a plan definition file for aggregated import.
+
+# flags.prefix
+
+Prefix of generated files.
+
+# flags.outputdir
+
+Directory in which to generate the JSON files; default is current directory.
+
+# examples
+
+- Export records retrieved with the specified SOQL query into a single JSON file in the current directory; the command uses your default org:
+
+  <%= 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:
+
+  <%= 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":
+
+  <%= config.bin %> <%= command.id %> --query query.txt --plan --prefix export-demo --output-dir export-out --target-org my-scratch

package/messages/tree.import.md

@@ -0,0 +1,37 @@
+# summary
+
+Import data from one or more JSON files into an org.
+
+# 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.
+
+If 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.
+
+The sObject Tree API supports requests that contain up to 200 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)
+
+# flags.files
+
+Comma-separated and in-order JSON files that contain the records, in sObject tree format, that you want to insert.
+
+# flags.plan
+
+Plan definition file to insert multiple data files.
+
+# flags.contenttype
+
+Content type of import files if their extention is not .json.
+
+# flags.confighelp
+
+Display schema information for the --plan configuration file to stdout; if you specify this flag, all other flags except --json are ignored.
+
+# examples
+
+- Import the records contained in two JSON files into the org with alias "my-scratch":
+
+  <%= config.bin %> <%= command.id %> --files Contact.json,Account.json --target-org my-scratch
+
+- Import records using a plan definition file into your default org:
+
+  <%= config.bin %> <%= command.id %> --plan Account-Contact-plan.json