@salesforce/plugin-data 2.1.20 → 2.1.22

package/lib/reporters.d.ts

@@ -1,57 +0,0 @@
-import { Logger } from '@salesforce/core';
-import { UX } from '@salesforce/command';
-import { Optional } from '@salesforce/ts-types';
-import { CliUx } from '@oclif/core';
-import { Field, SoqlQueryResult } from './dataSoqlQueryTypes';
-export declare class Reporter {
-    protected ux: UX;
-    protected logger: Logger;
-    constructor(ux: UX, logger: Logger);
-    log(...args: string[]): void;
-}
-export declare class QueryReporter extends Reporter {
-    protected columns: Field[];
-    protected data: SoqlQueryResult;
-    constructor(data: SoqlQueryResult, columns: Field[], ux: UX, logger: Logger);
-}
-type ParsedFields = {
-    attributeNames: Array<Optional<string>>;
-    children: string[];
-    aggregates: Field[];
-};
-export declare class HumanReporter extends QueryReporter {
-    constructor(data: SoqlQueryResult, columns: Field[], ux: UX, logger: Logger);
-    display(): void;
-    parseFields(): ParsedFields;
-    soqlQuery(columns: Array<Optional<string>>, records: unknown[], totalCount: number): void;
-    prepNullValues(records: unknown[]): void;
-    prepColumns(columns: Array<Optional<string>>): CliUx.Table.table.Columns<Record<string, unknown>>;
-    massageRows(queryResults: unknown[], children: string[], aggregates: Field[]): any;
-}
-export declare class CsvReporter extends QueryReporter {
-    constructor(data: SoqlQueryResult, columns: Field[], ux: UX, logger: Logger);
-    /**
-     * Escape a value to be placed in a CSV row. We follow rfc 4180
-     * https://tools.ietf.org/html/rfc4180#section-2 and will not surround the
-     * value in quotes if it doesn't contain the separator, double quote, or EOL.
-     *
-     * @param value The escaped value
-     */
-    escape(value: string): string;
-    display(): void;
-    massageRows(): string[];
-}
-export declare class JsonReporter extends QueryReporter {
-    constructor(data: SoqlQueryResult, columns: Field[], ux: UX, logger: Logger);
-    log(): void;
-    display(): void;
-}
-/**
- * A list of the accepted reporter types
- */
-export declare const FormatTypes: {
-    human: typeof HumanReporter;
-    csv: typeof CsvReporter;
-    json: typeof JsonReporter;
-};
-export {};

package/messages/batcher.json

@@ -1,12 +0,0 @@
-{
-  "BulkBatch": "Batch #%s",
-  "NoBatchFound": "Unable to find batch %s for job %s.",
-  "BulkError": "Upsert errors",
-  "BulkJobStatus": "Job Status",
-  "BatchStatus": "Batch Status",
-  "PollingInfo": "Will poll the batch statuses every %s seconds \nTo fetch the status on your own, press CTRL+C and use the command: \nsfdx force:data:bulk:status -i %s -b [<batchId>]",
-  "ExternalIdRequired": "An External ID is required on %s to perform an upsert.",
-  "TimeOut": "The operation timed out. Check the status with command: \nsfdx force:data:bulk:status -i %s -b %s",
-  "CheckStatusCommand": "Check batch #%s’s status with the command: \nsfdx force:data:bulk:status -i %s -b %s",
-  "BatchQueued": "Batch #%s queued (Batch ID: %s)."
-}

package/messages/bulk.delete.json

@@ -1,12 +0,0 @@
-{
-  "description": "bulk delete records from a csv file\nThe file must be a CSV file with only one column: \"Id\".\nOne job can contain many batches, depending on the length of the CSV file.\nReturns a job ID and a batch ID. Use these IDs to check job status with data:bulk:status.\n\n",
-  "examples": [
-    "$ sfdx force:data:bulk:delete -s Account -f ./path/to/file.csv",
-    "$ sfdx force:data:bulk:delete -s MyObject__c -f ./path/to/file.csv"
-  ],
-  "flags": {
-    "sobjecttype": "the sObject type of the records you’re deleting",
-    "csvfile": "the path to the CSV file containing the ids of the records to delete",
-    "wait": "the number of minutes to wait for the command to complete before displaying the results"
-  }
-}

package/messages/bulk.report.json

@@ -1,7 +0,0 @@
-{
-  "description": "view the status of a bulk query\nRun this command using the job ID returned from the force:data:soql:query --bulk command.",
-  "examples": [
-    "$ sfdx force:data:soql:bulk:report -i 7500x000005BdFzXXX"
-  ],
-  "bulkQueryIdDescription": "the job ID of the bulk query"
-}

package/messages/bulk.status.json

@@ -1,12 +0,0 @@
-{
-  "description": "view the status of a bulk data load job or batch\nRun this command using the job ID or batch ID returned from the force:data:bulk:delete or force:data:bulk:upsert commands.",
-  "examples": [
-    "$ sfdx force:data:bulk:status -i 750xx000000005sAAA",
-    "$ sfdx force:data:bulk:status -i 750xx000000005sAAA -b 751xx000000005nAAA"
-  ],
-  "flags": {
-    "jobid": "the ID of the job you want to view or of the job whose batch you want to view",
-    "batchid": "the ID of the batch whose status you want to view"
-  },
-  "NoBatchFound": "Unable to find batch %s for job %s."
-}

package/messages/bulk.upsert.json

@@ -1,14 +0,0 @@
-{
-  "description": "bulk upsert records from a CSV file\nInserts or updates records from a CSV file.\n\nOne job can contain many batches, depending on the length of the CSV file.\nReturns a job ID and a batch ID. Use these IDs to check job status with data:bulk:status.\n\nFor information about formatting your CSV file, see \"Prepare CSV Files\" in the Bulk API Developer Guide. \n\nBy default, the job runs the batches in parallel. Specify --serial to run them serially.",
-  "examples": [
-    "$ sfdx force:data:bulk:upsert -s MyObject__c -f ./path/to/file.csv -i MyField__c",
-    "$ sfdx force:data:bulk:upsert -s MyObject__c -f ./path/to/file.csv -i Id -w 2"
-  ],
-  "flags": {
-    "sobjecttype": "the sObject type of the records you want to upsert",
-    "csvfile": "the path to the CSV file that defines the records to upsert",
-    "externalid": "the column name of the external ID",
-    "wait": "the number of minutes to wait for the command to complete before displaying the results",
-    "serial": "run batches in serial mode"
-  }
-}

package/messages/exportApi.json

@@ -1,8 +0,0 @@
-{
-  "queryNotProvided": "Provide a SOQL query statement or file containing a SOQL statement.",
-  "soqlInvalid": "Invalid SOQL query: %s",
-  "soqlMalformed": "The provided SOQL is malformed: %s",
-  "soqlMalformedAction": "Check the SOQL syntax and try again.",
-  "dataExportRecordCount": "Processed %s records from query: %s",
-  "dataExportRecordCountWarning": "Query returned more than 200 records. Please run the command using the plan option instead.\n Record Count: %s \nQuery: %s"
-}

package/messages/importApi.json

@@ -1,16 +0,0 @@
-{
-  "dataFileNotProvided": "Provide a data plan or file(s).",
-  "dataFileNotFound": "Cannot find data file. Indicate a valid path: %s.",
-  "unknownContentType": "Unable to determine content type for file: %s.",
-  "dataFileUnsupported": "Content type: %s not supported.",
-  "dataFileEmpty": "Data file is empty: %s.",
-  "dataFileInvalidJson": "data file is invalid JSON: %s",
-  "dataFileNoRefId": "Found references in file, but no reference-id content found (%s). Was parent SObjects saved first?",
-  "tooManyFiles": "Specify either sobjecttreefiles or a plan, but not both.",
-  "dataImportFailed": "Import failed from file: %s. Results: %s.",
-  "dataPlanValidationError": "Data plan file %s did not validate against the schema.",
-  "dataPlanValidationErrorAction1": "Did you run the force:data:tree:export command with the --plan flag?",
-  "dataPlanValidationErrorAction2": "Make sure you are importing a plan file.",
-  "dataPlanValidationErrorAction3": "You can get help with the import plan schema by running $ sfdx force:data:tree:import --confighelp\n%s",
-  "FlsError": "We couldn't process your request because you don't have access to %s on %s. To learn more about field-level security, visit Tips and Hints for Page Layouts and Field-Level Security in our Developer Documentation."
-}

package/messages/messages.json

@@ -1,11 +0,0 @@
-{
-  "perfLogLevelOption": "get API performance data",
-  "perfLogLevelOptionLong": "Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json",
-  "NeitherSobjectidNorWhereError": "Either --where or --sobjectid flags must be specified",
-  "NeitherSobjectidNorWhereErrorActions": "Provide values for either --where or --sobjectid flags",
-  "BothSobjectidAndWhereError": "Both --where and --sobjectid flags are specified",
-  "DataRecordGetNoRecord": "No matching record found",
-  "DataRecordGetMultipleRecords": "%s is not a unique qualifier for %s; %s records were retrieved.\nRetrieve only one record.",
-  "TextUtilMalformedKeyValuePair": "Malformed key=value pair for value: %s",
-  "PathDoesNotExist": "The specified path [%s] does not exist"
-}

package/messages/record.create.json

@@ -1,15 +0,0 @@
-{
-  "description": "creates and inserts a record\nThe format of a field-value pair is <fieldName>=<value>.\nEnclose all field-value pairs in one set of double quotation marks, delimited by spaces.\nEnclose values that contain spaces in single quotes.\n\nTo get data on API performance metrics, specify both --perflog and --json.",
-  "sObjectType": "the type of the record you’re creating",
-  "values": "the <fieldName>=<value> pairs you’re creating",
-  "useToolingApi": "create the record with tooling api",
-  "examples": [
-    "$ sfdx force:data:record:create -s Account -v \"Name=Acme\"",
-    "$ sfdx force:data:record:create -s Account -v \"Name='Universal Containers'\"",
-    "$ sfdx force:data:record:create -s Account -v \"Name='Universal Containers' Website=www.example.com\"",
-    "$ sfdx force:data:record:create -t -s TraceFlag -v \"DebugLevelId=7dl170000008U36AAE StartDate=2017-12-01T00:26:04.000+0000 ExpirationDate=2017-12-01T00:56:04.000+0000 LogType=CLASS_TRACING TracedEntityId=01p17000000R6bLAAS\"",
-    "$ sfdx force:data:record:create -s Account -v \"Name=Acme\" --perflog --json"
-  ],
-  "createSuccess": "Successfully created record: %s.",
-  "createFailure": "Failed to create record. %s"
-}

package/messages/record.delete.json

@@ -1,16 +0,0 @@
-{
-  "description": "deletes a single record\nSpecify an sObject type and either an ID or a list of <fieldName>=<value> pairs.\nThe format of a field-value pair is <fieldName>=<value>.\nEnclose all field-value pairs in one set of double quotation marks, delimited by spaces.\nEnclose values that contain spaces in single quotes.\n\nTo get data on API performance metrics, specify both --perflog and --json.",
-  "sObjectType": "the type of the record you’re deleting",
-  "sObjectId": "the ID of the record you’re deleting",
-  "where": "a list of <fieldName>=<value> pairs to search for",
-  "useToolingApi": "delete the record with Tooling API",
-  "examples": [
-    "$ sfdx force:data:record:delete -s Account -i 001D000000Kv3dl",
-    "$ sfdx force:data:record:delete -s Account -w \"Name=Acme\"",
-    "$ sfdx force:data:record:delete -s Account -w \"Name='Universal Containers'\"",
-    "$ sfdx force:data:record:delete -s Account -w \"Name='Universal Containers' Phone='(123) 456-7890'\"",
-    "$ sfdx force:data:record:delete -t -s TraceFlag -i 7tf170000009cU6AAI --perflog --json"
-  ],
-  "deleteSuccess": "Successfully deleted record: %s.",
-  "deleteFailure": "Failed to delete record. %s"
-}

package/messages/record.get.json

@@ -1,14 +0,0 @@
-{
-  "description": "displays a single record\nSpecify an sObject type and either an ID or a list of <fieldName>=<value> pairs.\nThe format of a field-value pair is <fieldName>=<value>.\nEnclose all field-value pairs in one set of double quotation marks, delimited by spaces.\nEnclose values that contain spaces in single quotes.\n\nTo get data on API performance metrics, specify both --perflog and --json.",
-  "sObjectType": "the type of the record you’re retrieving",
-  "sObjectId": "the ID of the record you’re retrieving",
-  "where": "a list of <fieldName>=<value> pairs to search for",
-  "useToolingApi": "retrieve the record with Tooling API",
-  "examples": [
-    "$ sfdx force:data:record:get -s Account -i 001D000000Kv3dl",
-    "$ sfdx force:data:record:get -s Account -w \"Name=Acme\"",
-    "$ sfdx force:data:record:get -s Account -w \"Name='Universal Containers'\"",
-    "$ sfdx force:data:record:get -s Account -w \"Name='Universal Containers' Phone='(123) 456-7890'\"",
-    "$ sfdx force:data:record:get -t -s TraceFlag -i 7tf170000009cUBAAY --perflog --json"
-  ]
-}

package/messages/record.update.json

@@ -1,18 +0,0 @@
-{
-  "description": "updates a single record\nThe format of a field-value pair is <fieldName>=<value>.\nEnclose all field-value pairs in one set of double quotation marks, delimited by spaces.\nEnclose values that contain spaces in single quotes.\n\nTo get data on API performance metrics, specify both --perflog and --json.",
-  "sObjectType": "the sObject type of the record you’re updating",
-  "sObjectId": "the ID of the record you’re updating",
-  "where": "a list of <fieldName>=<value> pairs to search for",
-  "useToolingApi": "update the record with Tooling API",
-  "values": "the <fieldName>=<value> pairs you’re updating",
-  "examples": [
-    "$ sfdx force:data:record:update -s Account -i 001D000000Kv3dl -v \"Name=NewAcme\"",
-    "$ sfdx force:data:record:update -s Account -w \"Name='Old Acme'\" -v \"Name='New Acme'\"",
-    "$ sfdx force:data:record:update -s Account -i 001D000000Kv3dl -v \"Name='Acme III' Website=www.example.com\"",
-    "$ sfdx force:data:record:update -t -s TraceFlag -i 7tf170000009cUBAAY -v \"ExpirationDate=2017-12-01T00:58:04.000+0000\"",
-    "$sfdx force:data:record:update -s Account -i 001D000000Kv3dl -v \"Name=NewAcme\" --perflog --json"
-  ],
-  "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.json

@@ -1,26 +0,0 @@
-{
-  "description": "execute a SOQL query\nWhen you execute this command in a project, it executes the query against the data in your default scratch org.\n\nTo get data on API performance metrics, specify both --perflog and --json.\n\n",
-  "noResults": "Your query returned no results.",
-  "queryToExecute": "SOQL query to execute",
-  "queryLongDescription": "SOQL query to execute.",
-  "queryToolingDescription": "execute query with Tooling API",
-  "queryInvalidReporter": "Unknown result format type. Must be one of the following values: %s",
-  "resultFormatDescription": "result format emitted to stdout; --json flag overrides this parameter",
-  "resultFormatLongDescription": "Format to use when displaying results. If you also specify the --json flag, --json overrides this parameter.",
-  "displayQueryRecordsRetrieved": "Total number of records retrieved: %s.",
-  "queryNoResults": "Your query returned no results.",
-  "queryRunningMessage": "Querying Data",
-  "queryMoreUpdateMessage": "Result size is %d, current count is %d",
-  "bulkDescription": "use the bulk 2.0 API to query data",
-  "waitDescription": "wait time for command to finish in minutes",
-  "bulkQueryTimeout": "Query ID: %s\nQuery is in progress. \n\nRun sfdx force:data:soql:bulk:report -i %s -u %s to get the latest status/results",
-  "soqlqueryfile": "A SOQL query stored in a file",
-  "examples": [
-    "$ sfdx force:data:soql:query -q \"SELECT Id, Name, Account.Name FROM Contact\"",
-    "$ sfdx force:data:soql:query -q \"SELECT Id, Name FROM Account WHERE ShippingState IN ('CA', 'NY')\"",
-    "$ sfdx force:data:soql:query -q \"SELECT Id, Name FROM Account WHERE ShippingState IN ('CA', 'NY')\" --perflog --json",
-    "$ sfdx force:data:soql:query -q \"SELECT Name FROM ApexTrigger\" -t",
-    "$ sfdx force:data:soql:query --soqlqueryfile query.txt",
-    "$ sfdx force:data:soql:query --soqlqueryfile query.txt -t"
-  ]
-}

package/messages/tree.export.json

@@ -1,11 +0,0 @@
-{
-  "description": "export data from an org\nExports data from an org into sObject tree format for use with the force:data:tree:import command.\nThe query for export 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",
-  "query": "soql query, or filepath of file containing a soql query, to retrieve records",
-  "plan": "generate mulitple sobject tree files and a plan definition file for aggregated import",
-  "prefix": "prefix of generated files",
-  "outputdir": "directory to store files'",
-  "examples": [
-    "$ sfdx force:data:tree:export -q \"SELECT Id, Name, (SELECT Name, Address__c FROM Properties__r) FROM Broker__c\"",
-    "$ sfdx force:data:tree:export -q <path to file containing soql query> -x export-demo -d /tmp/sfdx-out -p"
-  ]
-}

package/messages/tree.import.json

@@ -1,13 +0,0 @@
-{
-  "description": "import data into an org\nIMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.\n\nImports data into an org using the SObject Tree Save API.  This data can include master-detail relationships.\nTo generate JSON files for use with force:data:tree:import, run \"sfdx force:data:tree:export\".\nThe 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",
-  "sobjecttreefiles": "comma-delimited, ordered paths of json files containing collection of record trees to insert",
-  "plan": "path to plan to insert multiple data files that have master-detail relationships",
-  "contenttype": "if data file extension is not .json, provide content type (applies to all files)",
-  "confighelp": "display schema information for the --plan configuration file to stdout; if you use this option, all other options except --json are ignored",
-  "examples": [
-    "$ sfdx force:data:tree:import -f Contact.json,Account.json -u me@my.org",
-    "$ sfdx force:data:tree:import -p Account-Contact-plan.json -u me@my.org"
-  ],
-  "importFailure": "Data plan file %s did not validate against the schema.",
-  "importFailureActions": "Did you run the force:data:tree:export command with the --plan flag?\nMake sure you are importing a plan file.\nYou can get help with the import plan schema by running $ sfdx force:data:tree:import --confighelp"
-}