Skip to content

Commit 2099082

Browse files
iowillhoitiowillhoit
committed
chore: merge main
2 parents 96d22de + 0d5b5dc commit 2099082

File tree

4 files changed

+992
-849
lines changed

4 files changed

+992
-849
lines changed

‎CHANGELOG.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,45 @@
1+
## [1.0.10](https://github.com/salesforcecli/plugin-data-seeding/compare/1.0.9...1.0.10) (2024-10-13)
2+
3+
### Bug Fixes
4+
5+
- **deps:** bump @oclif/core from 4.0.27 to 4.0.28 ([cbd9f1b](https://github.com/salesforcecli/plugin-data-seeding/commit/cbd9f1b739ff252d1323cef14bea52e03378bc50))
6+
7+
## [1.0.9](https://github.com/salesforcecli/plugin-data-seeding/compare/1.0.8...1.0.9) (2024-10-13)
8+
9+
### Bug Fixes
10+
11+
- **deps:** bump @salesforce/sf-plugins-core from 11.3.10 to 11.3.12 ([f170cac](https://github.com/salesforcecli/plugin-data-seeding/commit/f170cacc2f3a15f7b0f915a02e58433cf8e8c48d))
12+
13+
## [1.0.8](https://github.com/salesforcecli/plugin-data-seeding/compare/1.0.7...1.0.8) (2024-09-29)
14+
15+
### Bug Fixes
16+
17+
- **deps:** bump @oclif/core from 4.0.22 to 4.0.23 ([af17aca](https://github.com/salesforcecli/plugin-data-seeding/commit/af17aca873a3be1d811696502ae517d279c2f711))
18+
19+
## [1.0.7](https://github.com/salesforcecli/plugin-data-seeding/compare/1.0.6...1.0.7) (2024-09-15)
20+
21+
### Bug Fixes
22+
23+
- **deps:** bump @oclif/core from 4.0.21 to 4.0.22 ([2ac49b3](https://github.com/salesforcecli/plugin-data-seeding/commit/2ac49b36d19b01f8f8edb2b6915cc3379d5dc3db))
24+
25+
## [1.0.6](https://github.com/salesforcecli/plugin-data-seeding/compare/1.0.5...1.0.6) (2024-09-15)
26+
27+
### Bug Fixes
28+
29+
- **deps:** bump @salesforce/sf-plugins-core from 11.3.7 to 11.3.10 ([6cb60ef](https://github.com/salesforcecli/plugin-data-seeding/commit/6cb60ef5aae236716bd20978590f50296a00e535))
30+
31+
## [1.0.5](https://github.com/salesforcecli/plugin-data-seeding/compare/1.0.4...1.0.5) (2024-09-08)
32+
33+
### Bug Fixes
34+
35+
- **deps:** bump @oclif/core from 4.0.19 to 4.0.21 ([9d0bef5](https://github.com/salesforcecli/plugin-data-seeding/commit/9d0bef51702e55602cf79d776cbf31ef07a43547))
36+
37+
## [1.0.4](https://github.com/salesforcecli/plugin-data-seeding/compare/1.0.3...1.0.4) (2024-09-08)
38+
39+
### Bug Fixes
40+
41+
- **deps:** bump @salesforce/sf-plugins-core from 11.3.6 to 11.3.7 ([0a1cdfd](https://github.com/salesforcecli/plugin-data-seeding/commit/0a1cdfd995e59a9b97f5477348fb36703686eb1c))
42+
143
## [1.0.3](https://github.com/salesforcecli/plugin-data-seeding/compare/1.0.2...1.0.3) (2024-09-02)
244

345
### Bug Fixes

‎README.md

Lines changed: 85 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -114,144 +114,181 @@ sf plugins
114114

115115
## `sf data-seeding generate`
116116

117-
Generate org data using AI
117+
Generate synthetic org data that mimics existing data in a source org, and then load it into a separate target org.
118118

119119
```
120120
USAGE
121121
$ sf data-seeding generate -o <value> -s <value> -f <value> [--json] [--flags-dir <value>] [-w <value> | --async]
122122
123123
FLAGS
124-
-f, --config-file=<value> (required) Path to data seeding JSON configuration file.
125-
-o, --target-org=<value> (required) Username or alias of the Target org where generated data will be loaded to.
126-
-s, --source-org=<value> (required) Username or alias of the Source org containing data to be used as input for AI
127-
to generate similar data.
128-
-w, --wait=<value> [default: 33 minutes] Number of minutes to wait for command to complete.
129-
--async Run the command asynchronously.
124+
-f, --config-file=<value> (required) Path to the data seeding JSON configuration file.
125+
-o, --target-org=<value> (required) Username or alias of the target org into which the generated data will be
126+
loaded.
127+
-s, --source-org=<value> (required) Username or alias of the source org that contains the data that AI will mimic.
128+
-w, --wait=<value> [default: 33 minutes] Number of minutes to wait for the command to complete; when reached,
129+
the command completes asynchronously if necessary.
130+
--async Run the command asynchronously and immediately return control of the terminal.
130131
131132
GLOBAL FLAGS
132133
--flags-dir=<value> Import flag values from a directory.
133134
--json Format output as json.
134135
135136
DESCRIPTION
136-
Generate org data using AI
137+
Generate synthetic org data that mimics existing data in a source org, and then load it into a separate target org.
137138
138-
Generates data using AI that is similar to selected data from a source org, based on a configuration file, and loads
139-
it into a target org
139+
This command uses AI to generate synthetic (or "fake") data that has a similar format to selected data in a source
140+
org. The command uses a JSON configuration file to define the characteristics of the synthetic data. For example, the
141+
configuration file might specify the number of records to generate for one or more Salesforce objects, along with the
142+
subset of fields to include. Once generated, the data is automatically loaded into the specified target org. You must
143+
be authenticated to both the source and target orgs before running this command.
144+
145+
By default, this command runs synchronously and outputs the job ID, along with a running status of each execution
146+
phase, such as querying the source org or generating the data. If you prefer, you can run the command asynchronously
147+
by specifying the --async flag so that the control of the terminal is immediately returned to you. Then use the job ID
148+
to run the "data-seeding generate report" command to view the status.
140149
141150
EXAMPLES
142-
Generate data using org aliases
151+
Generate synthetic data similar to existing data in the org with alias "mySourceOrg" then load it into the org with
152+
alias "myTargetOrg"; use the specified config file to determine the format of the generated data:
153+
154+
$ sf data-seeding generate --source-org mySourceOrg --target-org myTargetOrg --config-file \
155+
./config/seed-config.json
156+
157+
Generate synthetic data using org usernames and run the command asynchronously:
143158
144-
$ sf data-seeding generate -s mySourceOrg -o myTargetOrg -f "./config/seed-config.json"
159+
$ sf data-seeding generate --source-org source@org.com" --target-org target@org.com" --config-file \
160+
./config/seed-config.json --async
145161
146-
Generate data using usernames for each org
162+
Generate synthetic data using org aliases; if after 5 minutes the command hasn't finished, it completes
163+
asynchronously:
147164
148-
$ sf data-seeding generate --source-org="source@org.com" --target-org="target@org.com" --config-file \
149-
"./config/seed-config.json"
165+
$ sf data-seeding generate --source-org source@org.com" --target-org target@org.com" --config-file \
166+
./config/seed-config.json --wait 5
150167
```
151168

152-
_See code: [src/commands/data-seeding/generate/index.ts](https://github.com/salesforcecli/plugin-data-seeding/blob/v1.0.3/src/commands/data-seeding/generate/index.ts)_
169+
_See code: [src/commands/data-seeding/generate/index.ts](https://github.com/salesforcecli/plugin-data-seeding/blob/v1.0.10/src/commands/data-seeding/generate/index.ts)_
153170

154171
## `sf data-seeding generate report`
155172

156-
View the status of a data-seeding generate job
173+
Display the status of a data-seeding generate job.
157174

158175
```
159176
USAGE
160177
$ sf data-seeding generate report [--json] [--flags-dir <value>] [-i <value>] [-r]
161178
162179
FLAGS
163-
-i, --job-id=<value> ID of a specific `data-seeding generate` job.
164-
-r, --use-most-recent View status of most recent `data-seeding generate` job.
180+
-i, --job-id=<value> ID of a specific execution of the "data-seeding generate" command.
181+
-r, --use-most-recent View the status of the most recently run "data-seeding generate" command.
165182
166183
GLOBAL FLAGS
167184
--flags-dir=<value> Import flag values from a directory.
168185
--json Format output as json.
169186
170187
DESCRIPTION
171-
View the status of a data-seeding generate job
188+
Display the status of a data-seeding generate job.
172189
173-
View the status of a data-seeding generate job that has already been initiated or completed
190+
This command displays the status of a previously initiated or completed execution of the "data-seeding generate"
191+
command. Run this command by either passing it the job ID returned by "data-seeding generate", or use the
192+
--use-most-recent flag to view the status of the most recently run "data-seeding generate" command.
174193
175194
EXAMPLES
176-
Display the status of a specific data seeding job
195+
Display the status of a specific execution of the "data-seeding generate" command:
177196
178-
$ sf data-seeding generate report --job-id="[XXXX-YYYY-ZZZZ-AAAA]"
197+
$ sf data-seeding generate report --job-id 1234-5678-AAAA-BBBB
179198
180-
Display the status of a the most recent data seeding job
199+
Display the status of the most recently run "data-seeding generate" command:
181200
182201
$ sf data-seeding generate report --use-most-recent
183202
```
184203

185-
_See code: [src/commands/data-seeding/generate/report.ts](https://github.com/salesforcecli/plugin-data-seeding/blob/v1.0.3/src/commands/data-seeding/generate/report.ts)_
204+
_See code: [src/commands/data-seeding/generate/report.ts](https://github.com/salesforcecli/plugin-data-seeding/blob/v1.0.10/src/commands/data-seeding/generate/report.ts)_
186205

187206
## `sf data-seeding migrate`
188207

189-
Migrates data from one org to another
208+
Migrate data from one org to another.
190209

191210
```
192211
USAGE
193212
$ sf data-seeding migrate -o <value> -s <value> -f <value> [--json] [--flags-dir <value>] [-w <value> | --async]
194213
195214
FLAGS
196-
-f, --config-file=<value> (required) Path to data migration JSON configuration file.
197-
-o, --target-org=<value> (required) Username or alias of the Target org where data will be migrated to.
198-
-s, --source-org=<value> (required) Username or alias of the Source org where data will be migrated from.
199-
-w, --wait=<value> [default: 33 minutes] Number of minutes to wait for command to complete.
200-
--async Run the command asynchronously.
215+
-f, --config-file=<value> (required) Path to the data migration JSON configuration file.
216+
-o, --target-org=<value> (required) Username or alias of the target org into which the migrated data is loaded.
217+
-s, --source-org=<value> (required) Username or alias of the source org that contains the data to be migrated.
218+
-w, --wait=<value> [default: 33 minutes] Number of minutes to wait for the command to complete; when reached,
219+
the command completes asynchronously if necessary.
220+
--async Run the command asynchronously and immediately return control of the terminal.
201221
202222
GLOBAL FLAGS
203223
--flags-dir=<value> Import flag values from a directory.
204224
--json Format output as json.
205225
206226
DESCRIPTION
207-
Migrates data from one org to another
227+
Migrate data from one org to another.
208228
209-
Migrates selected data based on a configuration file from a source org and into a target org
229+
This command migrates selected data from a source org and loads it into a target org. The command uses a JSON
230+
configuration file that defines the characteristics of the data. For example, the configuration file might specify a
231+
number of records from one or more Salesforce objects to migrate, along with the subset of fields to include. You must
232+
be authenticated to both the source and target orgs before running this command.
233+
234+
By default, this command runs synchronously and outputs a job ID along with a running status of each execution phase,
235+
such as querying the source org or loading into the target. If you prefer, you can run the command asynchronously by
236+
specifying the --async flag so that the control of the terminal is immediately returned to you. Then use the job ID to
237+
run the "data-seeding migrate report" command to view the status.
210238
211239
EXAMPLES
212-
Migrate data using a specific configuration file and org aliases
240+
Migrate data from the org with alias "mySourceOrg" to the org with alias "myTargetOrg"; use the specified
241+
configuration file to determine the data to migrate:
242+
243+
$ sf data-seeding migrate --source-org mySourceOrg --target-org myTargetOrg --config-file \
244+
./config/data-seed.json
245+
246+
Migrate data by specifying usernames for the source and target orgs, and run the command asynchronously:
213247
214-
$ sf data-seeding migrate -s sourceOrg -t targetOrg -f "/config/data-seed.json"
248+
$ sf data-seeding migrate --source-org source@org.com --target-org target@org.com \
249+
--config-file=./config/data-seed.json --async
215250
216-
Migrate data using default configuration file and usernames for each org
251+
Migrate data using org aliases; if after 5 minutes the command hasn't finished, it completes asynchronously:
217252
218-
$ sf data-seeding migrate --source-org="source@org.com" --target-org="target@org.com" \
219-
--config-file="/config/data-seed.json"
253+
$ sf data-seeding migrate --source-org mySourceOrg --target-org myTargetOrg --config-file \
254+
./config/data-seed.json --wait 5
220255
```
221256

222-
_See code: [src/commands/data-seeding/migrate/index.ts](https://github.com/salesforcecli/plugin-data-seeding/blob/v1.0.3/src/commands/data-seeding/migrate/index.ts)_
257+
_See code: [src/commands/data-seeding/migrate/index.ts](https://github.com/salesforcecli/plugin-data-seeding/blob/v1.0.10/src/commands/data-seeding/migrate/index.ts)_
223258

224259
## `sf data-seeding migrate report`
225260

226-
View the status of a data-seeding migrate job
261+
Display the status of a data-seeding migrate job.
227262

228263
```
229264
USAGE
230265
$ sf data-seeding migrate report [--json] [--flags-dir <value>] [-i <value>] [-r]
231266
232267
FLAGS
233-
-i, --job-id=<value> ID of a specific `data-seeding migrate` job.
234-
-r, --use-most-recent View status of most recent `data-seeding migrate` job.
268+
-i, --job-id=<value> ID of a specific execution of the "data-seeding migrate" command.
269+
-r, --use-most-recent View the status of the most recently run "data-seeding migrate" command.
235270
236271
GLOBAL FLAGS
237272
--flags-dir=<value> Import flag values from a directory.
238273
--json Format output as json.
239274
240275
DESCRIPTION
241-
View the status of a data-seeding migrate job
276+
Display the status of a data-seeding migrate job.
242277
243-
View the status of a data-seeding migrate job that has already been initiated or completed
278+
This command displays the status of a previously initiated or completed execution of the "data-seeding migrate"
279+
command. Run this command by either passing it the job ID returned by "data-seeding migrate", or use the
280+
--use-most-recent flag to view the status of the most recently run "data-seeding migrate" command.
244281
245282
EXAMPLES
246-
Display the status of a specific data seeding job
283+
Display the status of a specific execution of the "data-seeding migrate" command:
247284
248-
$ sf data-seeding migrate report --job-id="[XXXX-YYYY-ZZZZ-AAAA]"
285+
$ sf data-seeding migrate report --job-id 1234-5678-AAAA-BBBB
249286
250-
Display the status of a the most recent data seeding job
287+
Display the status of the most recently run "data-seeding migrate" command:
251288
252289
$ sf data-seeding migrate report --use-most-recent
253290
```
254291

255-
_See code: [src/commands/data-seeding/migrate/report.ts](https://github.com/salesforcecli/plugin-data-seeding/blob/v1.0.3/src/commands/data-seeding/migrate/report.ts)_
292+
_See code: [src/commands/data-seeding/migrate/report.ts](https://github.com/salesforcecli/plugin-data-seeding/blob/v1.0.10/src/commands/data-seeding/migrate/report.ts)_
256293

257294
<!-- commandsstop -->

‎package.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
{
22
"name": "@salesforce/plugin-data-seeding",
33
"description": "Migrate real data, generate fake data using GenAI, or deploy data files to target orgs.",
4-
"version": "1.0.3",
4+
"version": "1.0.10",
55
"author": "Salesforce",
66
"bugs": "https://github.com/forcedotcom/cli/issues",
77
"dependencies": {
88
"@oclif/core": "^4",
9-
"@oclif/multi-stage-output": "^0.5.0",
9+
"@oclif/multi-stage-output": "^0.7.7",
1010
"@salesforce/core": "^8.5.3",
1111
"@salesforce/kit": "^3.2.2",
12-
"@salesforce/sf-plugins-core": "^11.3.3",
12+
"@salesforce/sf-plugins-core": "^11.3.12",
1313
"form-data": "^4.0.0",
1414
"got": "^14.4.2",
1515
"tough-cookie": "^4.1.4"
1616
},
1717
"devDependencies": {
18-
"@oclif/plugin-command-snapshot": "^5.2.15",
19-
"@salesforce/cli-plugins-testkit": "^5.3.27",
18+
"@oclif/plugin-command-snapshot": "^5.2.18",
19+
"@salesforce/cli-plugins-testkit": "^5.3.34",
2020
"@salesforce/dev-scripts": "^10.2.9",
2121
"@types/tough-cookie": "^4.0.5",
22-
"@salesforce/plugin-command-reference": "^3.1.20",
23-
"eslint-plugin-sf-plugin": "^1.20.5",
24-
"oclif": "^4.14.28",
22+
"@salesforce/plugin-command-reference": "^3.1.27",
23+
"eslint-plugin-sf-plugin": "^1.20.8",
24+
"oclif": "^4.15.6",
2525
"ts-node": "^10.9.2",
2626
"tsx": "^4.19.0",
2727
"typescript": "^5.5.4"

0 commit comments

Comments
 (0)