|
1 | 1 | # summary
|
2 | 2 |
|
3 |
| -Migrates data from one org to another |
| 3 | +Migrate data from one org to another. |
4 | 4 |
|
5 | 5 | # description
|
6 | 6 |
|
7 |
| -Migrates selected data based on a configuration file from a source org and into a target org |
| 7 | +This command migrates selected data from a source org and loads it into a target org. The command uses a JSON configuration file that defines the characteristics of the data. For example, the configuration file might specify a number of records from one or more Salesforce objects to migrate, along with the subset of fields to include. You must be authenticated to both the source and target orgs before running this command. |
| 8 | + |
| 9 | +By default, this command runs synchronously and outputs a job ID along with a running status of each execution phase, such as querying the source org or loading into the target. If you prefer, you can run the command asynchronously by specifying the --async flag so that the control of the terminal is immediately returned to you. Then use the job ID to run the "data-seeding migrate report" command to view the status. |
8 | 10 |
|
9 | 11 | # examples
|
10 | 12 |
|
11 |
| -- Migrate data using a specific configuration file and org aliases |
12 |
| - |
13 |
| - $ <%= config.bin %> <%= command.id %> -s sourceOrg -t targetOrg -f "/config/data-seed.json" |
| 13 | +- Migrate data from the org with alias "mySourceOrg" to the org with alias "myTargetOrg"; use the specified configuration file to determine the data to migrate: |
| 14 | + |
| 15 | + <%= config.bin %> <%= command.id %> --source-org mySourceOrg --target-org myTargetOrg --config-file ./config/data-seed.json |
| 16 | + |
| 17 | +- Migrate data by specifying usernames for the source and target orgs, and run the command asynchronously: |
| 18 | + |
| 19 | + <%= config.bin %> <%= command.id %> --source-org source@org.com --target-org target@org.com --config-file=./config/data-seed.json --async |
14 | 20 |
|
15 |
| -- Migrate data using default configuration file and usernames for each org |
16 |
| - |
17 |
| - $ <%= config.bin %> <%= command.id %> --source-org="source@org.com" --target-org="target@org.com" --config-file="/config/data-seed.json" |
| 21 | +- Migrate data using org aliases; if after 5 minutes the command hasn't finished, it completes asynchronously: |
18 | 22 |
|
| 23 | + <%= config.bin %> <%= command.id %> --source-org mySourceOrg --target-org myTargetOrg --config-file ./config/data-seed.json --wait 5 |
19 | 24 |
|
20 | 25 | # flags.target-org.summary
|
21 | 26 |
|
22 |
| -Username or alias of the Target org where data will be migrated to. |
| 27 | +Username or alias of the target org into which the migrated data is loaded. |
23 | 28 |
|
24 | 29 | # flags.source-org.summary
|
25 | 30 |
|
26 |
| -Username or alias of the Source org where data will be migrated from. |
| 31 | +Username or alias of the source org that contains the data to be migrated. |
27 | 32 |
|
28 | 33 | # flags.config-file.summary
|
29 | 34 |
|
30 |
| -Path to data migration JSON configuration file. |
| 35 | +Path to the data migration JSON configuration file. |
31 | 36 |
|
32 | 37 | # flags.async.summary
|
33 | 38 |
|
34 |
| -Run the command asynchronously. |
| 39 | +Run the command asynchronously and immediately return control of the terminal. |
35 | 40 |
|
36 | 41 | # flags.wait.summary
|
37 | 42 |
|
38 |
| -Number of minutes to wait for command to complete. |
| 43 | +Number of minutes to wait for the command to complete; when reached, the command completes asynchronously if necessary. |
39 | 44 |
|
40 | 45 | # report.suggestion
|
41 | 46 |
|
42 |
| - - Check the status with: sf data-seeding migrate report -i %s |
| 47 | +- Run this command to check the status of the data migration: "sf data-seeding migrate report --job-id %s" |
0 commit comments