|
33 | 33 | The Get-SqlMigrations cmdlet retrieves a list of database schema migrations from either a filesystem location or a target database. |
34 | 34 | </maml:para> |
35 | 35 | <maml:para> |
36 | | - When used with no parameters or with the -Path parameter, the cmdlet lists the migrations defined in a filesystem location. The -Path parameter specifies the location; otherwise, the cmdlet uses the current directory as the location. The location must conform to the expected PSql.Deploy source directory structure, with migrations in the Migrations subdirectory. See about_PSql_Deploy for more details about the expected directory structure. |
| 36 | + When used with no parameters or with the -Path parameter, the cmdlet lists the migrations defined in a filesystem location. The -Path parameter specifies the location; without it, the cmdlet uses the current directory as the location. The location must conform to the expected PSql.Deploy source directory structure, with migrations in a Migrations subdirectory. See about_PSql_Deploy_Migrations for more details about the expected directory structure. |
37 | 37 | </maml:para> |
38 | 38 | <maml:para> |
39 | | - When used with the -Target parameter, the cmdlet lists the migrations already applied to the target database. The optional -MinimumName parameter excludes applied migrations with names lesser/earlier than the specified name. |
| 39 | + When used with the -Target parameter, the cmdlet lists the migrations already applied to the specified target database. The optional -MinimumName parameter excludes applied migrations with names lesser/earlier than the specified name. |
40 | 40 | </maml:para> |
41 | 41 | <maml:para> |
42 | 42 | The -InputObject parameter accepts pipeline input or a positional argument. The cmdlet automatically determines whether to interpret the value as a -Path or -Target argument. |
|
95 | 95 | Value for the -Path or -Target parameter. The cmdlet determines which parameter to use. |
96 | 96 | </maml:para> |
97 | 97 | <maml:para> |
98 | | - If the object is a string, the cmdlet assumes the string is a SqlClient connection string for -Target if the string contains a semicolon. Otherwise, the cmdlet assumes the string is a filesystem path -Path. |
| 98 | + If the object is a string, the cmdlet assumes the string is a SqlClient connection string for -Target if the string contains a semicolon. Otherwise, the cmdlet assumes the string is a filesystem path for -Path. |
99 | 99 | </maml:para> |
100 | 100 | <maml:para> |
101 | 101 | If the object is not a string, the cmdlet assumes it is a value for the -Target parameter. |
|
113 | 113 | <maml:name>Path</maml:name> |
114 | 114 | <maml:description> |
115 | 115 | <maml:para> |
116 | | - Path to a directory containing database source code in the layout expected by PSql.Deploy. |
| 116 | + Path to a source directory in the layout expected by PSql.Deploy. See about_PSql_Deploy_Migrations for more details about the expected directory structure. |
117 | 117 | </maml:para> |
118 | 118 | </maml:description> |
119 | 119 | <command:parameterValue required="true">string</command:parameterValue> |
|
144 | 144 | </maml:listItem> |
145 | 145 | <maml:listItem> |
146 | 146 | <maml:para> |
147 | | - PSql.Deploy.SqlTargetDatabase obtained by casting or construction |
| 147 | + PSql.Deploy.SqlTargetDatabase see INPUTS section for details |
148 | 148 | </maml:para> |
149 | 149 | </maml:listItem> |
150 | 150 | </maml:list> |
|
161 | 161 | <maml:name>MinimumName</maml:name> |
162 | 162 | <maml:description> |
163 | 163 | <maml:para> |
164 | | - Minimum name of migration to return, or $null to to return all migrations registered on the target database. The default is $null. |
| 164 | + Minimum name of migration to return, or $null to to return all known migrations. The default is $null. |
| 165 | + </maml:para> |
| 166 | + <maml:para> |
| 167 | + This parameter is valid only when listing migrations applied to a target database. When listing migrations in a filesystem location, the cmdlet always lists all migrations. |
165 | 168 | </maml:para> |
166 | 169 | </maml:description> |
167 | 170 | <command:parameterValue required="true">string</command:parameterValue> |
|
255 | 258 | <command:noun>SqlMigrations</command:noun> |
256 | 259 | <maml:description> |
257 | 260 | <maml:para> |
258 | | - Invokes database schema migrations against target databases. |
| 261 | + Applies database schema migrations to target databases. |
259 | 262 | </maml:para> |
260 | 263 | </maml:description> |
261 | 264 | </command:details> |
|
0 commit comments