Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Comment:
removing invalid sidebar
The SDG is a command-line application that must be run from either the Windows Command Prompt or Windows PowerShell.
Full Command Line Arguments
Below is a list of currently available command line arguments for the SDG. You can get a list of arguments available to the application by running with the /? switch.
| Code Block | ||||
|---|---|---|---|---|
| ||||
EdFi.SDG.vXX.exe /? |
| Argument | Description | Required | Default |
|---|---|---|---|
| -c / -configXmlPath | Provides the path to the XML configuration file for this run. | Yes | (none) |
| -d / -dataFilePath | Provides the path to the input CSV data files. | No | .\DataFiles\ |
| -m / -outputMode | One of {"Standard", "Seed"}. See further documentation about Seed Data. | No | Standard |
| -o / -outputPath | Path where output files should be saved. Note: this folder must already exist. | No | .\ (i.e. Current Directory) |
| -s / -seedFilePath | Path to an input or output seed file. Used for running in seed output mode. See further documentation about Seed Data. | No | (none) |
| -w / -allowOverwrite | If provided, files in the outputPath can be overwritten with newly generated data. | No | false |
For example, a typical run of the SDG looks like this:
| Code Block | ||
|---|---|---|
| ||
EdFi.SDG.vXX.exe -c C:\Ed-Fi\Samples\vXX\SampleDataGenerator\SampleConfig.xml -d C:\Ed-Fi\Samples\vXX\SampleDataGenerator\DataFiles\ -o C:\Temp\SDG\Output\ |
Outputting seed data:
| Code Block | ||
|---|---|---|
| ||
EdFi.SDG.vXX.exe -c C:\Ed-Fi\Samples\vXX\SampleDataGenerator\SampleConfig.xml -d C:\Ed-Fi\Samples\vXX\SampleDataGenerator\DataFiles\ -o C:\Temp\SDG\Output\ -m Seed -s C:\Temp\SDG\SeedRecords.txt |
Using seed data as input:
| Code Block | ||
|---|---|---|
| ||
EdFi.SDG.vXX.exe -c C:\Ed-Fi\Samples\vXX\SampleDataGenerator\SampleConfig.xml -d C:\Ed-Fi\Samples\vXX\SampleDataGenerator\DataFiles\ -o C:\Temp\SDG\Output\ -s C:\Temp\SDG\SeedRecords.txt |
Allowing output files to be overwritten (use with caution!):
| Code Block |
|---|
EdFi.SDG.vXX.exe -c C:\Ed-Fi\Samples\vXX\SampleDataGenerator\SampleConfig.xml -d C:\Ed-Fi\Samples\vXX\SampleDataGenerator\DataFiles\ -o C:\Temp\SDG\Output\ -AllowOverwrite |
Running EdFi.SampleDataGenerator.Console.exe
Please see instructions on Running the SDG.