Skip to content

Commit 20b72e7

Browse files
author
Wes Shaddix
authored
Updated formatting
1 parent f6afd9f commit 20b72e7

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,16 @@ A typical `config.json` file looks like the following:
4444
}
4545
```
4646
**scriptTable** - The name of the table that should be used to store the scripts that have been ran. Defaults to "ScriptTable"
47+
4748
**version** - The version of the release to associate with the current script deployment. Defaults to "1.0.0"
48-
**resetScriptsFolder** - The name of the folder that holds the scripts to reset (drop/create) the database. Defaults to "ResetScripts". This should be a relative path from the directory where SqlCi.exe is ran from.
49+
50+
**resetScriptsFolder** - The name of the folder that holds the scripts to reset (drop/create) the database. Defaults to
51+
"ResetScripts". This should be a relative path from the directory where SqlCi.exe is ran from.
52+
4953
**scriptsFolder** - The name of the folder that holds the schema and data population scripts that should be ran against the database specified in the "Database" connection string setting. This should be a relative path from the directory where SqlCi.exe is ran from.
54+
5055
**environments** - SqlCi supports an unlimited number of target environments that you can deploy to. Each environment contains the following properties:
56+
5157
- **name** - The name of the environment (local, dev, qa, staging, production, etc)
5258
- **resetConnectionString** - The connection string to use when running scripts from the ResetScriptsFolder. This is typically different from your application's database.
5359
- **connectionString** - The connection string to use when running scripts
@@ -199,4 +205,4 @@ Every script must be named with a sequence number followed by an underscore foll
199205

200206
SqlCi will take the file name and strip the first N characters before the first underscore and use that as the sequence to sort by when running the scripts. Technically you can use any naming convention where the characters before the first underscore sorts sequentially.
201207

202-
Next it will take every file that has "_all_" following the sequence number as well as scripts that have "_environment_" following the sequence number and run those scripts. The environment value is based on the name of the environment in your `config.json` file. The parameter value must match the naming convention for the script name. In the example file names above all of the files with "_all_" in the name will be ran in every environment and the file with "_dev_" in the name will only be ran when there is an environment named _dev_ in your `config.json` file.
208+
Next it will take every file that has "_all_" following the sequence number as well as scripts that have "_environment_" following the sequence number and run those scripts. The environment value is based on the name of the environment in your `config.json` file. The parameter value must match the naming convention for the script name. In the example file names above all of the files with "_all_" in the name will be ran in every environment and the file with "_dev_" in the name will only be ran when there is an environment named _dev_ in your `config.json` file.

0 commit comments

Comments
 (0)