Skip to content

Commit

Permalink
chore(release): 3.5.3 [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
@mshanemc
mshanemc committed Jul 2, 2024
1 parent cb49efc commit ed14e5b
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 128 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
## [3.5.3](https://github.com/salesforcecli/plugin-data/compare/3.5.2...3.5.3) (2024-07-02)

## [3.5.2](https://github.com/salesforcecli/plugin-data/compare/3.5.1...3.5.2) (2024-06-20)

### Bug Fixes
Expand Down
166 changes: 39 additions & 127 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,8 @@ sf plugins
- [`sf data delete bulk`](#sf-data-delete-bulk)
- [`sf data delete record`](#sf-data-delete-record)
- [`sf data delete resume`](#sf-data-delete-resume)
- [`sf data export beta tree`](#sf-data-export-beta-tree)
- [`sf data export tree`](#sf-data-export-tree)
- [`sf data get record`](#sf-data-get-record)
- [`sf data import beta tree`](#sf-data-import-beta-tree)
- [`sf data import tree`](#sf-data-import-tree)
- [`sf data query`](#sf-data-query)
- [`sf data query resume`](#sf-data-query-resume)
Expand Down Expand Up @@ -143,7 +141,7 @@ EXAMPLES
$ sf data create file --file path/to/astro.png --parent-id a03fakeLoJWPIA3
```

_See code: [src/commands/data/create/file.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/data/create/file.ts)_
_See code: [src/commands/data/create/file.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/data/create/file.ts)_

## `sf data create record`

Expand Down Expand Up @@ -199,7 +197,7 @@ EXAMPLES
TracedEntityId=01p17000000R6bLAAS"
```

_See code: [src/commands/data/create/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/data/create/record.ts)_
_See code: [src/commands/data/create/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/data/create/record.ts)_

## `sf data delete bulk`

Expand Down Expand Up @@ -257,7 +255,7 @@ FLAG DESCRIPTIONS
and can be enabled only by a system administrator.
```

_See code: [src/commands/data/delete/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/data/delete/bulk.ts)_
_See code: [src/commands/data/delete/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/data/delete/bulk.ts)_

## `sf data delete record`

Expand Down Expand Up @@ -318,7 +316,7 @@ EXAMPLES
$ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
```

_See code: [src/commands/data/delete/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/data/delete/record.ts)_
_See code: [src/commands/data/delete/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/data/delete/record.ts)_

## `sf data delete resume`

Expand Down Expand Up @@ -357,65 +355,7 @@ EXAMPLES
$ sf data delete resume --use-most-recent --target-org my-scratch
```

_See code: [src/commands/data/delete/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/data/delete/resume.ts)_

## `sf data export beta tree`

Export data from an org into one or more JSON files.

```
USAGE
$ sf data export beta tree -o <value> -q <value> [--json] [--flags-dir <value>] [--api-version <value>] [-p] [-x <value>]
[-d <value>]
FLAGS
-d, --output-dir=<value> Directory in which to generate the JSON files; default is current directory.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-p, --plan Generate multiple sObject tree files and a plan definition file for aggregated import.
-q, --query=<value> (required) SOQL query, or filepath of a file that contains the query, to retrieve records.
-x, --prefix=<value> Prefix of generated files.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Export data from an org into one or more JSON files.
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 "sf 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).
EXAMPLES
Export records retrieved with the specified SOQL query into a single JSON file in the current directory; the command
uses your default org:
$ sf data export beta tree --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:
$ sf data export beta tree --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":
$ sf data export beta tree --query query.txt --plan --prefix export-demo --output-dir export-out --target-org \
my-scratch
```

_See code: [src/commands/data/export/beta/tree.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/data/export/beta/tree.ts)_
_See code: [src/commands/data/delete/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/data/delete/resume.ts)_

## `sf data export tree`

Expand Down Expand Up @@ -456,12 +396,13 @@ DESCRIPTION
ALIASES
$ sf force data tree export
$ sf data export beta tree
EXAMPLES
Export records retrieved with the specified SOQL query into a single JSON file in the current directory; the command
uses your default org:
$ sf data export tree --query "SELECT Id, Name, (SELECT Name, Address__c FROM Properties__r) FROM Broker__c"
$ sf data export tree --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:
Expand All @@ -475,7 +416,7 @@ EXAMPLES
my-scratch
```

_See code: [src/commands/data/export/tree.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/data/export/tree.ts)_
_See code: [src/commands/data/export/tree.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/data/export/tree.ts)_

## `sf data get record`

Expand Down Expand Up @@ -539,59 +480,15 @@ EXAMPLES
$ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
```

_See code: [src/commands/data/get/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/data/get/record.ts)_

## `sf data import beta tree`

Import data from one or more JSON files into an org.

```
USAGE
$ sf data import beta tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>...] [-p
<value>]
FLAGS
-f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
that you want to insert.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-p, --plan=<value> Plan definition file to insert multiple data files.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Import data from one or more JSON files into an org.
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 "sf 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.
EXAMPLES
Import the records contained in two JSON files into the org with alias "my-scratch":
$ sf data import beta tree --files Contact.json,Account.json --target-org my-scratch
Import records using a plan definition file into your default org:
$ sf data import beta tree --plan Account-Contact-plan.json
```

_See code: [src/commands/data/import/beta/tree.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/data/import/beta/tree.ts)_
_See code: [src/commands/data/get/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/data/get/record.ts)_

## `sf data import tree`

Import data from one or more JSON files into an org.

```
USAGE
$ sf data import tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>... | -p <value>]
$ sf data import tree -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>...] [-p <value>]
FLAGS
-f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
Expand All @@ -616,12 +513,9 @@ DESCRIPTION
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)
ALIASES
$ sf force data tree import
$ sf data import beta tree
EXAMPLES
Import the records contained in two JSON files into the org with alias "my-scratch":
Expand All @@ -631,9 +525,27 @@ EXAMPLES
Import records using a plan definition file into your default org:
$ sf data import tree --plan Account-Contact-plan.json
FLAG DESCRIPTIONS
-p, --plan=<value> Plan definition file to insert multiple data files.
Unlike when you use the `--files` flag, the files listed in the plan definition file **can** contain more then 200
records. When the CLI executes the import, it automatically batches the records to comply with the 200 record limit
set by the API.
The order in which you list the files in the plan definition file matters. Specifically, records with lookups to
records in another file should be listed AFTER that file. For example, let's say you're loading Account and Contact
records, and the contacts have references to those accounts. Be sure you list the Accounts file before the Contacts
file.
The plan definition file has the following schema:
- items(object) - SObject Type: Definition of records to be insert per SObject Type
- sobject(string) - Name of SObject: Child file references must have SObject roots of this type
- files(array) - Files: An array of files paths to load
```

_See code: [src/commands/data/import/tree.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/data/import/tree.ts)_
_See code: [src/commands/data/import/tree.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/data/import/tree.ts)_

## `sf data query`

Expand Down Expand Up @@ -697,7 +609,7 @@ EXAMPLES
$ sf data query --query "SELECT Id FROM Contact" --bulk --wait 0
```

_See code: [src/commands/data/query.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/data/query.ts)_
_See code: [src/commands/data/query.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/data/query.ts)_

## `sf data query resume`

Expand Down Expand Up @@ -735,7 +647,7 @@ EXAMPLES
$ sf data query resume --bulk-query-id 7500x000005BdFzXXX
```

_See code: [src/commands/data/query/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/data/query/resume.ts)_
_See code: [src/commands/data/query/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/data/query/resume.ts)_

## `sf data resume`

Expand Down Expand Up @@ -772,7 +684,7 @@ EXAMPLES
$ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
```

_See code: [src/commands/data/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/data/resume.ts)_
_See code: [src/commands/data/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/data/resume.ts)_

## `sf data update record`

Expand Down Expand Up @@ -834,7 +746,7 @@ EXAMPLES
"ExpirationDate=2017-12-01T00:58:04.000+0000"
```

_See code: [src/commands/data/update/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/data/update/record.ts)_
_See code: [src/commands/data/update/record.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/data/update/record.ts)_

## `sf data upsert bulk`

Expand Down Expand Up @@ -887,7 +799,7 @@ EXAMPLES
my-scratch
```

_See code: [src/commands/data/upsert/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/data/upsert/bulk.ts)_
_See code: [src/commands/data/upsert/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/data/upsert/bulk.ts)_

## `sf data upsert resume`

Expand Down Expand Up @@ -926,7 +838,7 @@ EXAMPLES
$ sf data upsert resume --use-most-recent --target-org my-scratch
```

_See code: [src/commands/data/upsert/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/data/upsert/resume.ts)_
_See code: [src/commands/data/upsert/resume.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/data/upsert/resume.ts)_

## `sf force data bulk delete`

Expand Down Expand Up @@ -973,7 +885,7 @@ EXAMPLES
$ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
```

_See code: [src/commands/force/data/bulk/delete.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/force/data/bulk/delete.ts)_
_See code: [src/commands/force/data/bulk/delete.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/force/data/bulk/delete.ts)_

## `sf force data bulk status`

Expand Down Expand Up @@ -1010,7 +922,7 @@ EXAMPLES
$ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
```

_See code: [src/commands/force/data/bulk/status.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/force/data/bulk/status.ts)_
_See code: [src/commands/force/data/bulk/status.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/force/data/bulk/status.ts)_

## `sf force data bulk upsert`

Expand Down Expand Up @@ -1068,6 +980,6 @@ EXAMPLES
--target-org my-scratch
```

_See code: [src/commands/force/data/bulk/upsert.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.2/src/commands/force/data/bulk/upsert.ts)_
_See code: [src/commands/force/data/bulk/upsert.ts](https://github.com/salesforcecli/plugin-data/blob/3.5.3/src/commands/force/data/bulk/upsert.ts)_

<!-- commandsstop -->
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@salesforce/plugin-data",
"version": "3.5.2",
"version": "3.5.3",
"description": "Plugin for salesforce data commands",
"author": "Salesforce",
"homepage": "https://github.com/salesforcecli/plugin-data",
Expand Down

0 comments on commit ed14e5b

Please sign in to comment.