Skip to content

Commit 3c770f1

Browse files
committed
WIP general about file.
1 parent f5bfed0 commit 3c770f1

1 file changed

Lines changed: 13 additions & 24 deletions

File tree

PSql.Deploy/en-US/about_PSql_Deploy.help.txt

Lines changed: 13 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ a target database. A seed is a SQL script that populates a target database
1515
with data. Together, migrations and seeds provide a mechanism to perform
1616
database deployments in a controlled and repeatable manner.
1717

18-
Source Directory Structure
18+
19+
:: Source Directory Structure ::
1920

2021
PSql.Deploy expects migrations and seeds to have a specific filesystem layout.
2122

@@ -49,32 +50,20 @@ src\ The source directory: a set of migrations and
4950
└─ ... PSql.Deploy does not care about other files or
5051
directories present in the source directory.
5152

52-
See the sections below for more details about migrations and seeds.
53-
54-
TODO: SQLCMD mode support.
55-
GO
56-
Breaks the script into batches.
57-
58-
$(name)
59-
Replaced by the value of the variable 'name' in the migration or seed.
60-
61-
:r <file>
62-
Include the contents of the specified file in the migration. The variable
63-
$(Path) is available in the included file and expands to the path of the
64-
migration or seed file that includes the file.
65-
66-
:setvar <name> <value>
67-
Set a variable for the duration of the migration or seed. The variable
68-
$(name) is available in the included file and expands to the value set by
69-
this directive.
7053

71-
TODO: General magic comments description.
72-
73-
74-
Target Parameter
75-
----------------
54+
:: Target Parameter ::
7655

7756
Most PSql.Deploy cmdlets accept a -Target parameter to specify one or more
7857
target databases on which to operate.
7958

8059
TODO: Expand
60+
61+
62+
:: See Also ::
63+
64+
- about_PSql_Deploy_Migrations
65+
- about_PSql_Deploy_Seeds
66+
- Get-SqlMigrations
67+
- Invoke-SqlMigrations
68+
- Invoke-SqlSeed
69+
- https://github.com/sharpjs/PSql.Deploy

0 commit comments

Comments
 (0)