Skip to content

Commit 2805c39

Browse files
dzsquareddzsquared
committed
adding docs links and clarifying help param
1 parent 509b803 commit 2805c39

7 files changed

Lines changed: 28 additions & 15 deletions

File tree

‎docs/tools/sqlpackage/sqlpackage-deploy-drift-report.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.assetid: 198198e2-7cf4-4a21-bda4-51b36cb4284b
99
author: "dzsquared"
1010
ms.author: "drskwier"
1111
ms.reviewer: "maghan; sstein"
12-
ms.date: 12/11/2020
12+
ms.date: 7/2/2021
1313
---
1414

1515
# SqlPackage deploy report and drift report
@@ -36,7 +36,7 @@ SqlPackage {parameters}{properties}{SQLCMD Variables}
3636
|**/OutputPath:**|**/op**|{string}|Specifies the file path where the output files are generated. |
3737
|**/OverwriteFiles:**|**/of**|{True|False}|Specifies if sqlpackage.exe should overwrite existing files. Specifying false causes sqlpackage.exe to abort action if an existing file is encountered. Default value is True. |
3838
|**/Profile:**|**/pr**|{string}|Specifies the file path to a DAC Publish Profile. The profile defines a collection of properties and variables to use when generating outputs. |
39-
|**/Properties:**|**/p**|{PropertyName}={Value}|Specifies a name value pair for an action-specific property; {PropertyName}={Value}. Refer to the help for a specific action to see that action's property names. Example: sqlpackage.exe /Action:DeployReport /?. |
39+
|**/Properties:**|**/p**|{PropertyName}={Value}|Specifies a name value pair for an [action-specific property](#DeployReport-action-properties); {PropertyName}={Value}. |
4040
|**/Quiet:**|**/q**|{True|False}|Specifies whether detailed feedback is suppressed. Defaults to False. |
4141
|**/SourceConnectionString:**|**/scs**|{string}|Specifies a valid SQL Server/Azure connection string to the source database. If this parameter is specified, it shall be used exclusively of all other source parameters. |
4242
|**/SourceDatabaseName:**|**/sdn**|{string}|Defines the name of the source database. |

‎docs/tools/sqlpackage/sqlpackage-export.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.assetid: 198198e2-7cf4-4a21-bda4-51b36cb4284b
99
author: "dzsquared"
1010
ms.author: "drskwier"
1111
ms.reviewer: "maghan; sstein"
12-
ms.date: 12/11/2020
12+
ms.date: 7/2/2021
1313
---
1414

1515
# SqlPackage Export parameters and properties
@@ -33,7 +33,7 @@ SqlPackage {parameters}{properties}{SQLCMD Variables}
3333
|**/DiagnosticsFile:**|**/df**|{string}|Specifies a file to store diagnostic logs. |
3434
|**/MaxParallelism:**|**/mp**|{int}| Specifies the degree of parallelism for concurrent operations running against a database. The default value is 8. |
3535
|**/OverwriteFiles:**|**/of**|{True|False}|Specifies if sqlpackage.exe should overwrite existing files. Specifying false causes sqlpackage.exe to abort action if an existing file is encountered. Default value is True. |
36-
|**/Properties:**|**/p**|{PropertyName}={Value}|Specifies a name value pair for an action-specific property;{PropertyName}={Value}. Refer to the help for a specific action to see that action's property names. Example: sqlpackage.exe /Action:Export /?.|
36+
|**/Properties:**|**/p**|{PropertyName}={Value}|Specifies a name value pair for an [action-specific property]((#properties-specific-to-the-export-action));{PropertyName}={Value}. |
3737
|**/Quiet:**|**/q**|{True|False}|Specifies whether detailed feedback is suppressed. Defaults to False.|
3838
|**/SourceConnectionString:**|**/scs**|{string}|Specifies a valid SQL Server/Azure connection string to the source database. If this parameter is specified, it shall be used exclusively of all other source parameters. |
3939
|**/SourceDatabaseName:**|**/sdn**|{string}|Defines the name of the source database. |

‎docs/tools/sqlpackage/sqlpackage-extract.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.assetid: 198198e2-7cf4-4a21-bda4-51b36cb4284b
99
author: "dzsquared"
1010
ms.author: "drskwier"
1111
ms.reviewer: "maghan; sstein"
12-
ms.date: 3/10/2021
12+
ms.date: 7/2/2021
1313
---
1414

1515
# SqlPackage Extract parameters and properties
@@ -36,7 +36,7 @@ SqlPackage {parameters}{properties}{SQLCMD Variables}
3636
|**/DiagnosticsFile:**|**/df**|{string}|Specifies a file to store diagnostic logs. |
3737
|**/MaxParallelism:**|**/mp**|{int}| Specifies the degree of parallelism for concurrent operations running against a database. The default value is 8. |
3838
|**/OverwriteFiles:**|**/of**|{True|False}|Specifies if sqlpackage.exe should overwrite existing files. Specifying false causes sqlpackage.exe to abort action if an existing file is encountered. Default value is True. |
39-
|**/Properties:**|**/p**|{PropertyName}={Value}|Specifies a name value pair for an action-specific property; {PropertyName}={Value}. Refer to the help for a specific action to see that action's property names. Example: sqlpackage.exe /Action:Extract /?. |
39+
|**/Properties:**|**/p**|{PropertyName}={Value}|Specifies a name value pair for an [action-specific property]((#properties-specific-to-the-extract-action)); {PropertyName}={Value}. |
4040
|**/Quiet:**|**/q**|{True|False}|Specifies whether detailed feedback is suppressed. Defaults to False. |
4141
|**/SourceConnectionString:**|**/scs**|{string}|Specifies a valid SQL Server/Azure connection string to the source database. If this parameter is specified, it shall be used exclusively of all other source parameters. |
4242
|**/SourceDatabaseName:**|**/sdn**|{string}|Defines the name of the source database. |

‎docs/tools/sqlpackage/sqlpackage-import.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.assetid: 198198e2-7cf4-4a21-bda4-51b36cb4284b
99
author: "dzsquared"
1010
ms.author: "drskwier"
1111
ms.reviewer: "maghan; sstein"
12-
ms.date: 6/10/2021
12+
ms.date: 7/2/2021
1313
---
1414

1515
# SqlPackage Import parameters and properties
@@ -32,7 +32,7 @@ SqlPackage {parameters}{properties}{SQLCMD Variables}
3232
|**/Diagnostics:**|**/d**|{True|False}|Specifies whether diagnostic logging is output to the console. Defaults to False. |
3333
|**/DiagnosticsFile:**|**/df**|{string}|Specifies a file to store diagnostic logs. |
3434
|**/MaxParallelism:**|**/mp**|{int}| Specifies the degree of parallelism for concurrent operations running against a database. The default value is 8. |
35-
|**/Properties:**|**/p**|{PropertyName}={Value}|Specifies a name value pair for an action-specific property;{PropertyName}={Value}. Refer to the help for a specific action to see that action's property names. Example: sqlpackage.exe /Action:Import /?.|
35+
|**/Properties:**|**/p**|{PropertyName}={Value}|Specifies a name value pair for an [action-specific property]((#properties-specific-to-the-import-action)); {PropertyName}={Value}. |
3636
|**/Quiet:**|**/q**|{True|False}|Specifies whether detailed feedback is suppressed. Defaults to False.|
3737
|**/SourceFile:**|**/sf**|{string}|Specifies a source file to be used as the source of action. If this parameter is used, no other source parameter shall be valid. |
3838
|**/TargetConnectionString:**|**/tcs**|{string}|Specifies a valid SQL Server/Azure connection string to the target database. If this parameter is specified, it shall be used exclusively of all other target parameters. |

‎docs/tools/sqlpackage/sqlpackage-publish.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.assetid: 198198e2-7cf4-4a21-bda4-51b36cb4284b
99
author: "dzsquared"
1010
ms.author: "drskwier"
1111
ms.reviewer: "maghan; sstein"
12-
ms.date: 6/10/2021
12+
ms.date: 7/2/2021
1313
---
1414

1515
# SqlPackage Publish parameters, properties, and SQLCMD variables
@@ -42,7 +42,7 @@ SqlPackage {parameters}{properties}{SQLCMD Variables}
4242
|**/MaxParallelism:**|**/mp**|{int}| Specifies the degree of parallelism for concurrent operations running against a database. The default value is 8. |
4343
|**/OverwriteFiles:**|**/of**|{True|False}|Specifies if sqlpackage.exe should overwrite existing files. Specifying false causes sqlpackage.exe to abort action if an existing file is encountered. Default value is True. |
4444
|**/Profile:**|**/pr**|{string}|Specifies the file path to a DAC Publish Profile. The profile defines a collection of properties and variables to use when generating outputs.|
45-
|**/Properties:**|**/p**|{PropertyName}={Value}|Specifies a name value pair for an action-specific property;{PropertyName}={Value}. Refer to the help for a specific action to see that action's property names. Example: sqlpackage.exe /Action:Publish /?.|
45+
|**/Properties:**|**/p**|{PropertyName}={Value}|Specifies a name value pair for an [action-specific property](#properties-specific-to-the-publish-action);{PropertyName}={Value}. |
4646
|**/Quiet:**|**/q**|{True|False}|Specifies whether detailed feedback is suppressed. Defaults to False.|
4747
|**/Secret:**|**/secr**|{string}|Specifies the Client Secret to be used in authenticating against Azure KeyVault, when necessary |
4848
|**/SourceConnectionString:**|**/scs**|{string}|Specifies a valid SQL Server/Azure connection string to the source database. If this parameter is specified, it shall be used exclusively of all other source parameters. |

‎docs/tools/sqlpackage/sqlpackage-script.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.assetid: 198198e2-7cf4-4a21-bda4-51b36cb4284b
99
author: "dzsquared"
1010
ms.author: "drskwier"
1111
ms.reviewer: "maghan; sstein"
12-
ms.date: 12/4/2020
12+
ms.date: 7/2/2021
1313
---
1414

1515
# SqlPackage Script parameters and properties
@@ -37,7 +37,7 @@ SqlPackage {parameters}{properties}{SQLCMD Variables}
3737
|**/OutputPath:**|**/op**|{string}|Specifies the file path where the output files are generated. |
3838
|**/OverwriteFiles:**|**/of**|{True|False}|Specifies if sqlpackage.exe should overwrite existing files. Specifying false causes sqlpackage.exe to abort action if an existing file is encountered. Default value is True. |
3939
|**/Profile:**|**/pr**|{string}|Specifies the file path to a DAC Publish Profile. The profile defines a collection of properties and variables to use when generating outputs.|
40-
|**/Properties:**|**/p**|{PropertyName}={Value}|Specifies a name value pair for an action-specific property;{PropertyName}={Value}. Refer to the help for a specific action to see that action's property names. Example: sqlpackage.exe /Action:Script /?.|
40+
|**/Properties:**|**/p**|{PropertyName}={Value}|Specifies a name value pair for an [action-specific property](#properties-specific-to-the-script-action); {PropertyName}={Value}. |
4141
|**/Quiet:**|**/q**|{True|False}|Specifies whether detailed feedback is suppressed. Defaults to False.|
4242
|**/SourceConnectionString:**|**/scs**|{string}|Specifies a valid SQL Server/Azure connection string to the source database. If this parameter is specified, it shall be used exclusively of all other source parameters. |
4343
|**/SourceDatabaseName:**|**/sdn**|{string}|Defines the name of the source database. |

‎docs/tools/sqlpackage/sqlpackage.md‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.assetid: 198198e2-7cf4-4a21-bda4-51b36cb4284b
99
author: "dzsquared"
1010
ms.author: "drskwier"
1111
ms.reviewer: "maghan; sstein"
12-
ms.date: 3/10/2021
12+
ms.date: 7/2/2021
1313
---
1414

1515
# SqlPackage.exe
@@ -64,16 +64,29 @@ Create a SQL script that generates the differences of two .dacpac files:
6464

6565
```
6666
sqlpackage.exe /Action:Script /SourceFile:"C:\sqlpackageoutput\output_current_version.dacpac" /TargetFile:"C:\sqlpackageoutput\output_target.dacpac" /TargetDatabaseName:"Contoso.Database" /OutputPath:"C:\sqlpackageoutput\output.sql"
67-
```
67+
```
6868

69-
## Version
69+
## Version
7070

7171
Displays the sqlpackage version as a build number. Can be used in interactive prompts as well as in [automated pipelines](sqlpackage-pipelines.md).
7272

7373
```
7474
sqlpackage.exe /Version
7575
```
7676

77+
## Help
78+
79+
You can display sqlpackage usage information by using `/?` or `/help:True`.
80+
81+
```
82+
sqlpackage.exe /?
83+
```
84+
85+
For parameter and property information specific to a particular action, use the help parameter in addition to that action's parameter.
86+
87+
```
88+
sqlpackage.exe /Action:Publish /?
89+
```
7790

7891
## Exit codes
7992

0 commit comments

Comments
 (0)