SqlPackage.exe
SqlPackage.exe is a command line utility that automates the following database development tasks:
Extract: Creates a database snapshot (.dacpac) file from a live SQL Server or Microsoft Azure SQL Database.
Publish: Incrementally updates a database schema to match the schema of a source .dacpac file. If the database does not exist on the server, the publish operation will create it. Otherwise, an existing database will be updated.
Export: Exports a live database - including database schema and user data - from SQL Server or Microsoft Azure SQL Database to a BACPAC package (.bacpac file).
Import: Imports the schema and table data from a BACPAC package into a new user database in an instance of SQL Server or Microsoft Azure SQL Database.
DeployReport: Creates an XML report of the changes that would be made by a publish action.
DriftReport: Creates an XML report of the changes that have been made to a registered database since it was last registered.
Script: Creates a Transact-SQL incremental update script that updates the schema of a target to match the schema of a source.
The SqlPackage.exe command line allows you to specify these actions along with action specific parameters and properties.
Command Line Syntax
SqlPackage.exe initiates the actions specified using the parameters, properties, and SQLCMD variables specified on the command line.
SqlPackage {parameters}{properties}{SQLCMD Variables}
To see solutions to common customer problems with Microsoft Azure SQL Database, SQL Server Data Tools, and SQL Server Management Studio, see Database Lifecycle Management.
Help for the Extract action.
| Parameter | Short Form | Value | Description |
|---|---|---|---|
| /Action: | /a | Extract | Specifies the action to be performed. |
| /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. |
| /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 /?. |
| /Quiet: | /q | {True|False} | Specifies whether detailed feedback is suppressed. Defaults to False. |
| /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. |
| /SourceDatabaseName: | /sdn | {string} | Defines the name of the source database. |
| /SourceEncryptConnection: | /sec | {True|False} | Specifies if SQL encryption should be used for the source database connection. |
| /SourcePassword: | /sp | {string} | For SQL Server auth scenarios, defines the password to use to access the source database. |
| /SourceServerName: | /ssn | {string} | Defines the name of the server hosting the source database. |
| /SourceTimeout: | /st | {int} | Specifies the timeout for establishing a connection to the source database in seconds. |
| /SourceTrustServerCertificate: | /stsc | {True|False} | Specifies whether to use SSL to encrypt the source database connection and bypass walking the certificate chain to validate trust. |
| /SourceUser: | /su | {string} | For SQL Server auth scenarios, defines the SQL Server user to use to access the source database. |
| /TargetFile: | /tf | {string} | Specifies a target file (i.e., a .dacpac files) to be used as the target of action instead of a database. If this parameter is used, no other target parameter shall be valid. This parameter shall be invalid for actions that only support database targets. |
| /TenantId: | /tid | {string} | Represents the Azure AD tenant ID or domain name. This option is required to support guest or imported Azure AD users as well as Microsoft accounts such as outlook.com, hotmail.com or live.com. If this parameter is omitted, the default tenant id for Azure AD will be used, assuming that the authenticated user is a native user for this AD. However, in this case any guest or imported users and/or Microsoft accounts hosted in this Azure AD are not supported and the operation will fail. For more information about Active Directory Universal Authentication, see Universal Authentication with SQL Database and SQL Data Warehouse (SSMS support for MFA). |
| /UniversalAuthentication: | /ua | {True|False} | Specifies if Universal Authentication should be used. When set to True, the interactive authentication protocol is activated supporting MFA. This option can also be used for Azure AD authentication without MFA, using an interactive protocol requiring the user to enter their username and password or integrated authentication (Windows credentials). When /UniversalAuthentication is set to True, no Azure AD authentication can be specified in SourceConnectionString (/scs). When /UniversalAuthentication is set to False, Azure AD authentication must be specified in SourceConnectionString (/scs). For more information about Active Directory Universal Authentication, see Universal Authentication with SQL Database and SQL Data Warehouse (SSMS support for MFA). |
Properties specific to the Extract action:
| Property | Value | Description |
|---|---|---|
| /p: | CommandTimeout=(INT32 '60') | Specifies the command timeout in seconds when executing queries against SQL Server. |
| /p: | DacApplicationDescription=(STRING) | Defines the Application description to be stored in the DACPAC metadata. |
| /p: | DacApplicationName=(STRING) | Defined the Application name to be stored in the DACPAC metadata. The default value is the database name. |
| /p: | DacMajorVersion=(INT32 '1') | Defines the major version to be stored in the DACPAC metadata. |
| /p: | DacMinorVersion=(INT32 '0') | Defines the minor version to be stored in the DACPAC metadata. |
| /p: | ExtractAllTableData=(BOOLEAN) | Indicates whether data from all user tables is extracted. If 'true', data from all user tables is extracted, and you cannot specify individual user tables for extracting data. If 'false', specify one or more user tables to extract data from. |
| /p: | ExtractApplicationScopedObjectsOnly=(BOOLEAN 'True') | If true, only extract application-scoped objects for the specified source. If false, extract all objects for the specified source. |
| /p: | ExtractReferencedServerScopedElements=(BOOLEAN 'True') | If true, extract login, server audit and credential objects referenced by source database objects. |
| /p: | ExtractUsageProperties=(BOOLEAN) | Specifies whether usage properties, such as table row count and index size, will be extracted from the database. |
| /p: | IgnoreExtendedProperties=(BOOLEAN) | Specifies whether extended properties should be ignored. |
| /p: | IgnorePermissions=(BOOLEAN 'True') | Specifies whether permissions should be ignored. |
| /p: | IgnoreUserLoginMappings=(BOOLEAN) | Specifies whether relationships between users and logins will be ignored. |
| /p: | Storage=({File|Memory} 'File') | Specifies the type of backing storage for the schema model used during extraction. |
| /p: | TableData=(STRING) | Indicates the table from which data will be extracted. Specify the table name with or without the brackets surrounding the name parts in the following format: schema_name.table_identifier. |
| /p: | VerifyExtraction=(BOOLEAN) | Specifies whether the extracted dacpac should be verified. |
Publish Parameters, Properties, and SQLCMD Variables
A SqlPackage.exe publish operation incrementally updates the schema of a target database to match the structure of a source database. Publishing a deployment package that contains user data for all or a subset of tables will update the table data in addition to the schema. Note that data deployment will overwrite the schema and data in existing tables of the target database. Data deployment will not change existing schema or data in the target database for tables not included in the deployment package.
Help for Publish action.
| Parameter | Short Form | Value | Description |
|---|---|---|---|
| /Action: | /a | Publish | Specifies the action to be performed. |
| /AzureKeyVaultAuthMethod: | /akv | {Interactive|ClientIdSecret} | Specifies what authentication method will be used for accessing Azure KeyAault |
| /ClientId: | /cid | {string} | Specifies the Client ID to be used in authenticating against Azure KeyVault, when necessary |
| /OverwriteFiles: | /of | {True|False} | Specifies if sqlpackage.exe should overwrite existing files. Specifyingfalse causes sqlpackage.exe to abort action if an existing file isencountered. Default value is True. |
| /Profile: | /pr | {string} | Specifies the file path to a DAC Publish Profile. The profile defines acollection of properties and variables to use when generating outputs. |
| /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 seethat action's property names. Example: sqlpackage.exe /Action:Publish /?. |
| /Quiet: | /q | {True|False} | Specifies whether detailed feedback is suppressed. Defaults to False. |
| /Secret: | /secr | {string} | Specifies the Client Secret to be used in authenticating against Azure KeyVault, when necessary |
| /SourceConnectionString: | /scs | {string} | Specifies a valid SQL Server/Azure connection string to the sourcedatabase. If this parameter is specified it shall be used exclusively ofall other source parameters. |
| /SourceDatabaseName: | /sdn | {string} | Defines the name of the source database. |
| /SourceEncryptConnection: | /sec | {True|False} | Specifies if SQL encryption should be used for the source databaseconnection. |
| /SourceFile: | /sf | {string} | Specifies a source file to be used as the source of action instead of adatabase. If this parameter is used, no other source parameter shall bevalid. |
| /SourcePassword: | /sp | {string} | For SQL Server auth scenarios, defines the password to use to access thesource database. |
| /SourceServerName: | /ssn | {string} | Defines the name of the server hosting the source database. |
| /SourceTimeout: | /st | {int} | Specifies the timeout for establishing a connection to the source databasein seconds. |
| /SourceTrustServerCertificate: | /stsc | {True|False} | Specifies whether to use SSL to encrypt the source database connection andbypass walking the certificate chain to validate trust. |
| /SourceUser: | /su | {string} | For SQL Server auth scenarios, defines the SQL Server user to use toaccess the source database. |
| /TargetConnectionString: | /tcs | {string} | Specifies a valid SQL Server/Azure connection string to the targetdatabase. If this parameter is specified it shall be used exclusively ofall other target parameters. |
| /TargetDatabaseName: | /tdn | {string} | Specifies an override for the name of the database that is the target ofsqlpackage.exe Action. |
| /TargetEncryptConnection: | /tec | {True|False} | Specifies if SQL encryption should be used for the target databaseconnection. |
| /TargetPassword: | /tp | {string} | For SQL Server auth scenarios, defines the password to use to access thetarget database. |
| /TargetServerName: | /tsn | {string} | Defines the name of the server hosting the target database. |
| /TargetTimeout: | /tt | {int} | Specifies the timeout for establishing a connection to the target database in seconds. For Azure AD, it is recommended that this value be greater than or equal to 30 seconds. |
| /TargetTrustServerCertificate: | /ttsc | {True|False} | Specifies whether to use SSL to encrypt the target database connection andbypass walking the certificate chain to validate trust. |
| /TargetUser: | /tu | {string} | For SQL Server auth scenarios, defines the SQL Server user to use toaccess the target database. |
| /TenantId: | /tid | {string} | Represents the Azure AD tenant ID or domain name. This option is required to support guest or imported Azure AD users as well as Microsoft accounts such as outlook.com, hotmail.com or live.com. If this parameter is omitted, the default tenant id for Azure AD will be used, assuming that the authenticated user is a native user for this AD. However, in this case any guest or imported users and/or Microsoft accounts hosted in this Azure AD are not supported and the operation will fail. For more information about Active Directory Universal Authentication, see Universal Authentication with SQL Database and SQL Data Warehouse (SSMS support for MFA). |
| /UniversalAuthentication: | /ua | {True|False} | Specifies if Universal Authentication should be used. When set to True, the interactive authentication protocol is activated supporting MFA. This option can also be used for Azure AD authentication without MFA, using an interactive protocol requiring the user to enter their username and password or integrated authentication (Windows credentials). When /UniversalAuthentication is set to True, no Azure AD authentication can be specified in SourceConnectionString (/scs). When /UniversalAuthentication is set to False, Azure AD authentication must be specified in SourceConnectionString (/scs). For more information about Active Directory Universal Authentication, see Universal Authentication with SQL Database and SQL Data Warehouse (SSMS support for MFA). |
| /Variables: | /v | {PropertyName}={Value} | Specifies a name value pair for an action specific variable;{VariableName}={Value}. The DACPAC file contains the list of valid SQLCMD variables. An error will result if a value is not provided for every variable. |
Properties specific to the Publish action:
| Property | Value | Description |
|---|---|---|
| /p: | AdditionalDeploymentContributorArguments=(STRING) | Specifies additional deployment contributor arguments for the deploymentcontributors. This should be a semi-colon delimited list of values. |
| /p: | AdditionalDeploymentContributors=(STRING) | Specifies additional deployment contributors which should run when thedacpac is deployed. This should be a semi-colon delimited list of fullyqualified build contributor names or IDs. |
| /p: | AllowDropBlockingAssemblies=(BOOLEAN) | This property is used by SqlClr deployment to cause any blockingassemblies to be dropped as part of the deployment plan. By default, anyblocking/referencing assemblies will block an assembly update if thereferencing assembly needs to be dropped. |
| /p: | AllowIncompatiblePlatform=(BOOLEAN) | Specifies whether to attempt the action despite incompatible SQL Serverplatforms. |
| /p: | AllowUnsafeRowLevelSecurityDataMovement=(BOOLEAN) | Do not block data motion on a table which has Row Level Security if thisproperty is set to true. Default is false. |
| /p: | BackupDatabaseBeforeChanges=(BOOLEAN) | Backups the database before deploying any changes. |
| /p: | BlockOnPossibleDataLoss=(BOOLEAN 'True') | Specifies that the publish episode should be terminated if there is apossibility of data loss resulting from the publish.operation. |
| /p: | BlockWhenDriftDetected=(BOOLEAN 'True') | Specifies whether to block updating a database whose schema no longermatches its registration or is unregistered. |
| /p: | CommandTimeout=(INT32 '60') | Specifies the command timeout in seconds when executing queries againstSQL Server. |
| /p: | CommentOutSetVarDeclarations=(BOOLEAN) | Specifies whether the declaration of SETVAR variables should be commentedout in the generated publish script. You might choose to do this if youplan to specify the values on the command line when you publish by using atool such as SQLCMD.EXE. |
| /p: | CompareUsingTargetCollation=(BOOLEAN) | This setting dictates how the database's collation is handled duringdeployment; by default the target database's collation will be updated ifit does not match the collation specified by the source. When this option is set, the target database's (or server's) collation should be used. |
| /p: | CreateNewDatabase=(BOOLEAN) | Specifies whether the target database should be updated or whether itshould be dropped and re-created when you publish to a database. |
| /p: | DatabaseEdition=({Basic|Standard|Premium|Default} 'Default') | Defines the edition of a Microsoft Azure SQL Database. |
| /p: | DatabaseMaximumSize=(INT32) | Defines the maximum size in GB of a Microsoft Azure SQL Database. |
| /p: | DatabaseServiceObjective=(STRING) | Defines the performance level of a Microsoft Azure SQL Database such as"P0" or "S1". |
| /p: | DeployDatabaseInSingleUserMode=(BOOLEAN) | if true, the database is set to Single User Mode before deploying. |
| /p: | DisableAndReenableDdlTriggers=(BOOLEAN 'True') | Specifies whether Data Definition Language (DDL) triggers are disabled atthe beginning of the publish process and re-enabled at the end of thepublish action. |
| /p: | DoNotAlterChangeDataCaptureObjects=(BOOLEAN 'True') | If true, Change Data Capture objects are not altered. |
| /p: | DoNotAlterReplicatedObjects=(BOOLEAN 'True') | Specifies whether objects that are replicated are identified duringverification. |
| /p: | DoNotDropObjectType=(STRING) | An object type that should not be dropped when DropObjectsNotInSource istrue. Valid object type names are Aggregates, ApplicationRoles,Assemblies, AsymmetricKeys, BrokerPriorities, Certificates,ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseRoles,DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources,ExternalFileFormats, ExternalTables, Filegroups, FileTables,FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions,PartitionSchemes, Permissions, Queues, RemoteServiceBindings,RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists,SecurityPolicies, Sequences, Services, Signatures, StoredProcedures,SymmetricKeys, Synonyms, Tables, TableValuedFunctions,UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users,Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders,DatabaseAuditSpecifications, DatabaseScopedCredentials, Endpoints,ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins,LinkedServers, Logins, Routes, ServerAuditSpecifications,ServerRoleMembership, ServerRoles, ServerTriggers. |
| /p: | DoNotDropObjectTypes=(STRING) | A semicolon delimited list of object types that should not be dropped whenDropObjectsNotInSource is true. Valid object type names are Aggregates,ApplicationRoles, Assemblies, AsymmetricKeys, BrokerPriorities,Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts,DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties,ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups,FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes,PartitionFunctions, PartitionSchemes, Permissions, Queues,RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions,SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures,StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions,UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users,Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders,DatabaseAuditSpecifications, DatabaseScopedCredentials, Endpoints,ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins,LinkedServers, Logins, Routes, ServerAuditSpecifications,ServerRoleMembership, ServerRoles, ServerTriggers. |
| /p: | DropConstraintsNotInSource=(BOOLEAN 'True') | Specifies whether constraints that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publishto a database. |
| /p: | DropDmlTriggersNotInSource=(BOOLEAN 'True') | Specifies whether DML triggers that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publishto a database. |
| /p: | DropExtendedPropertiesNotInSource=(BOOLEAN 'True') | Specifies whether extended properties that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when youpublish to a database. |
| /p: | DropIndexesNotInSource=(BOOLEAN 'True') | Specifies whether indexes that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publishto a database. |
| /p: | DropObjectsNotInSource=(BOOLEAN) | Specifies whether objects that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publishto a database. This value takes precedence over DropExtendedProperties. |
| /p: | DropPermissionsNotInSource=(BOOLEAN) | Specifies whether permissions that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publishupdates to a database. |
| /p: | DropRoleMembersNotInSource=(BOOLEAN) | Specifies whether role members that are not defined in the database snapshot (.dacpac) file will be dropped from the target database when youpublish updates to a database. |
| /p: | DropStatisticsNotInSource=(BOOLEAN 'True') | Specifies whether statistics that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publishto a database. |
| /p: | ExcludeObjectType=(STRING) | An object type that should be ignored during deployment. Valid object typenames are Aggregates, ApplicationRoles, Assemblies, AsymmetricKeys,BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys,Contracts, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties,ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups,FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes,PartitionFunctions, PartitionSchemes, Permissions, Queues,RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions,SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures,StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions,UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users,Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders,DatabaseAuditSpecifications, DatabaseScopedCredentials, Endpoints,ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins,LinkedServers, Logins, Routes, ServerAuditSpecifications,ServerRoleMembership, ServerRoles, ServerTriggers. |
| /p: | ExcludeObjectTypes=(STRING) | A semicolon delimited list of object types that should be ignored duringdeployment. Valid object type names are Aggregates, ApplicationRoles,Assemblies, AsymmetricKeys, BrokerPriorities, Certificates,ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseRoles,DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources,ExternalFileFormats, ExternalTables, Filegroups, FileTables,FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions,PartitionSchemes, Permissions, Queues, RemoteServiceBindings,RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists,SecurityPolicies, Sequences, Services, Signatures, StoredProcedures,SymmetricKeys, Synonyms, Tables, TableValuedFunctions,UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users,Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders,DatabaseAuditSpecifications, DatabaseScopedCredentials, Endpoints,ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins,LinkedServers, Logins, Routes, ServerAuditSpecifications,ServerRoleMembership, ServerRoles, ServerTriggers. |
| /p: | GenerateSmartDefaults=(BOOLEAN) | Automatically provides a default value when updating a table that containsdata with a column that does not allow null values. |
| /p: | IgnoreAnsiNulls=(BOOLEAN 'True') | Specifies whether differences in the ANSI NULLS setting should be ignoredor updated when you publish to a database. |
| /p: | IgnoreAuthorizer=(BOOLEAN) | Specifies whether differences in the Authorizer should be ignored or updated when you publish to a database. |
| /p: | IgnoreColumnCollation=(BOOLEAN) | Specifies whether differences in the column collations should be ignoredor updated when you publish to a database. |
| /p: | IgnoreComments=(BOOLEAN) | Specifies whether differences in the comments should be ignored or updatedwhen you publish to a database. |
| /p: | IgnoreCryptographicProviderFilePath=(BOOLEAN 'True') | Specifies whether differences in the file path for the cryptographicprovider should be ignored or updated when you publish to a database. |
| /p: | IgnoreDdlTriggerOrder=(BOOLEAN) | Specifies whether differences in the order of Data Definition Language (DDL) triggers should be ignored or updated when you publish to a databaseor server. |
| /p: | IgnoreDdlTriggerState=(BOOLEAN) | Specifies whether differences in the enabled or disabled state of Data Definition Language (DDL) triggers should be ignored or updated when youpublish to a database. |
| /p: | IgnoreDefaultSchema=(BOOLEAN) | Specifies whether differences in the default schema should be ignored or updated when you publish to a database. |
| /p: | IgnoreDmlTriggerOrder=(BOOLEAN) | Specifies whether differences in the order of Data Manipulation Language (DML) triggers should be ignored or updated when you publish to a database. |
| /p: | IgnoreDmlTriggerState=(BOOLEAN) | Specifies whether differences in the enabled or disabled state of DMLtriggers should be ignored or updated when you publish to a database. |
| /p: | IgnoreExtendedProperties=(BOOLEAN) | Specifies whether differences in the extended properties should be ignoredor updated when you publish to a database. |
| /p: | IgnoreFileAndLogFilePath=(BOOLEAN 'True') | Specifies whether differences in the paths for files and log files shouldbe ignored or updated when you publish to a database. |
| /p: | IgnoreFilegroupPlacement=(BOOLEAN 'True') | Specifies whether differences in the placement of objects in FILEGROUPsshould be ignored or updated when you publish to a database. |
| /p: | IgnoreFileSize=(BOOLEAN 'True') | Specifies whether differences in the file sizes should be ignored orwhether a warning should be issued when you publish to a database. |
| /p: | IgnoreFillFactor=(BOOLEAN 'True') | Specifies whether differences in the fill factor for index storage shouldbe ignored or whether a warning should be issued when you publish to adatabase. |
| /p: | IgnoreFullTextCatalogFilePath=(BOOLEAN 'True') | Specifies whether differences in the file path for the full-text catalogshould be ignored or whether a warning should be issued when you publishto a database. |
| /p: | IgnoreIdentitySeed=(BOOLEAN) | Specifies whether differences in the seed for an identity column should beignored or updated when you publish updates to a database. |
| /p: | IgnoreIncrement=(BOOLEAN) | Specifies whether differences in the increment for an identity columnshould be ignored or updated when you publish to a database. |
| /p: | IgnoreIndexOptions=(BOOLEAN) | Specifies whether differences in the index options should be ignored or updated when you publish to a database. |
| /p: | IgnoreIndexPadding=(BOOLEAN 'True') | Specifies whether differences in the index padding should be ignored or updated when you publish to a database. |
| /p: | IgnoreKeywordCasing=(BOOLEAN 'True') | Specifies whether differences in the casing of keywords should be ignoredor updated when you publish to a database. |
| /p: | IgnoreLockHintsOnIndexes=(BOOLEAN) | Specifies whether differences in the lock hints on indexes should beignored or updated when you publish to a database. |
| /p: | IgnoreLoginSids=(BOOLEAN 'True') | Specifies whether differences in the security identification number (SID)should be ignored or updated when you publish to a database. |
| /p: | IgnoreNotForReplication=(BOOLEAN) | Specifies whether the not for replication settings should be ignored or updated when you publish to a database. |
| /p: | IgnoreObjectPlacementOnPartitionScheme=(BOOLEAN 'True') | Specifies whether an object's placement on a partition scheme should beignored or updated when you publish to a database. |
| /p: | IgnorePartitionSchemes=(BOOLEAN) | Specifies whether differences in partition schemes and functions should beignored or updated when you publish to a database. |
| /p: | IgnorePermissions=(BOOLEAN) | Specifies whether differences in the permissions should be ignored or updated when you publish to a database. |
| /p: | IgnoreQuotedIdentifiers=(BOOLEAN 'True') | Specifies whether differences in the quoted identifiers setting should beignored or updated when you publish to a database. |
| /p: | IgnoreRoleMembership=(BOOLEAN) | Specifies whether differences in the role membership of logins should beignored or updated when you publish to a database. |
| /p: | IgnoreRouteLifetime=(BOOLEAN 'True') | Specifies whether differences in the amount of time that SQL Serverretains the route in the routing table should be ignored or updated whenyou publish to a database. |
| /p: | IgnoreSemicolonBetweenStatements=(BOOLEAN 'True') | Specifies whether differences in the semi-colons between T-SQL statementswill be ignored or updated when you publish to a database. |
| /p: | IgnoreTableOptions=(BOOLEAN) | Specifies whether differences in the table options will be ignored or updated when you publish to a database. |
| /p: | IgnoreUserSettingsObjects=(BOOLEAN) | Specifies whether differences in the user settings objects will be ignoredor updated when you publish to a database. |
| /p: | IgnoreWhitespace=(BOOLEAN 'True') | Specifies whether differences in white space will be ignored or updatedwhen you publish to a database. |
| /p: | IgnoreWithNocheckOnCheckConstraints=(BOOLEAN) | Specifies whether differences in the value of the WITH NOCHECK clause forcheck constraints will be ignored or updated when you publish to adatabase. |
| /p: | IgnoreWithNocheckOnForeignKeys=(BOOLEAN) | Specifies whether differences in the value of the WITH NOCHECK clause forforeign keys will be ignored or updated when you publish to a database. |
| /p: | IncludeCompositeObjects=(BOOLEAN) | Include all composite elements as part of a single publish operation. |
| /p: | IncludeTransactionalScripts=(BOOLEAN) | Specifies whether transactional statements should be used where possiblewhen you publish to a database. |
| /p: | NoAlterStatementsToChangeClrTypes=(BOOLEAN) | Specifies that publish should always drop and re-create an assembly ifthere is a difference instead of issuing an ALTER ASSEMBLY statement. |
| /p: | PopulateFilesOnFileGroups=(BOOLEAN 'True') | Specifies whether a new file is also created when a new FileGroup iscreated in the target database. |
| /p: | RegisterDataTierApplication=(BOOLEAN) | Specifies whether the schema is registered with the database server. |
| /p: | RunDeploymentPlanExecutors=(BOOLEAN) | Specifies whether DeploymentPlanExecutor contributors should be run whenother operations are executed. |
| /p: | ScriptDatabaseCollation=(BOOLEAN) | Specifies whether differences in the database collation should be ignoredor updated when you publish to a database. |
| /p: | ScriptDatabaseCompatibility=(BOOLEAN) | Specifies whether differences in the database compatibility should beignored or updated when you publish to a database. |
| /p: | ScriptDatabaseOptions=(BOOLEAN 'True') | Specifies whether target database properties should be set or updated aspart of the publish action. |
| /p: | ScriptDeployStateChecks=(BOOLEAN) | Specifies whether statements are generated in the publish script to verifythat the database name and server name match the names specified in thedatabase project. |
| /p: | ScriptFileSize=(BOOLEAN) | Controls whether size is specified when adding a file to a filegroup. |
| /p: | ScriptNewConstraintValidation=(BOOLEAN 'True') | At the end of publish all of the constraints will be verified as one set,avoiding data errors caused by a check or foreign key constraint in themiddle of publish. If set to False, your constraints will be publishedwithout checking the corresponding data. |
| /p: | ScriptRefreshModule=(BOOLEAN 'True') | Include refresh statements at the end of the publish script. |
| /p: | Storage=({File|Memory}) | Specifies how elements are stored when building the database model. Forperformance reasons the default is InMemory. For very large databases,File backed storage is required. |
| /p: | TreatVerificationErrorsAsWarnings=(BOOLEAN) | Specifies whether errors encountered during publish verification should betreated as warnings. The check is performed against the generateddeployment plan before the plan is executed against your target database.Plan verification detects problems such as the loss of target-only objects (such as indexes) that must be dropped to make a change. Verification willalso detect situations where dependencies (such as a table or view) existbecause of a reference to a composite project, but do not exist in thetarget database. You might choose to do this to get a complete list of allissues, instead of having the publish action stop on the first error. |
| /p: | VerifyCollationCompatibility=(BOOLEAN 'True') | Specifies whether collation compatibility is verified. |
| /p: | VerifyDeployment=(BOOLEAN 'True') | Specifies whether checks should be performed before publishing that will stop the publish action if issues are present that might block successful publishing. For example, your publish action might stop if you have foreign keys on the target database that do not exist in the database project, and that will cause errors when you publish. |
SQLCMD Variables
The following table describes the format of the option that you can use to override the value of a SQL command (sqlcmd) variable used during a publish action. The values of variable specified on the command line override other values assigned to the variable (for example, in a publish profile).
| Parameter | Default | Description |
|---|---|---|
| /Variables:{PropertyName}={Value} | Specifies a name value pair for an action specific variable; {VariableName}={Value}. The DACPAC file contains the list of valid SQLCMD variables. An error will result if a value is not provided for every variable. |
Export Parameters and Properties
A SqlPackage.exe Export action exports a live database from SQL Server or Microsoft Azure SQL Database to a BACPAC package (.bacpac file). By default, data for all tables will be included in the .bacpac file. Optionally, you can specify only a subset of tables for which to export data. Validation for the Export action ensures Microsoft Azure SQL Database compatibility for the complete targeted database even if a subset of tables is specified for the export.
Help for Export action.
| Parameter | Short Form | Value | Description |
|---|---|---|---|
| /Action: | /a | Export | Specifies the action to be performed. |
| /OverwriteFiles: | /of | {True|False} | Specifies if sqlpackage.exe should overwrite existing files. Specifyingfalse causes sqlpackage.exe to abort action if an existing file isencountered. Default value is True. |
| /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 seethat action's property names. Example: sqlpackage.exe /Action:Publish /?. |
| /Quiet: | /q | {True|False} | Specifies whether detailed feedback is suppressed. Defaults to False. |
| /SourceConnectionString: | /scs | {string} | Specifies a valid SQL Server/Azure connection string to the sourcedatabase. If this parameter is specified it shall be used exclusively ofall other source parameters. |
| /SourceDatabaseName: | /sdn | {string} | Defines the name of the source database. |
| /SourceEncryptConnection: | /sec | {True|False} | Specifies if SQL encryption should be used for the source databaseconnection. |
| /SourcePassword: | /sp | {string} | For SQL Server auth scenarios, defines the password to use to access thesource database. |
| /SourceServerName: | /ssn | {string} | Defines the name of the server hosting the source database. |
| /SourceTimeout: | /st | {int} | Specifies the timeout for establishing a connection to the source databasein seconds. |
| /SourceTrustServerCertificate: | /stsc | {True|False} | Specifies whether to use SSL to encrypt the source database connection andbypass walking the certificate chain to validate trust. |
| /SourceUser: | /su | {string} | For SQL Server auth scenarios, defines the SQL Server user to use toaccess the source database. |
| /TargetFile: | /tf | {string} | Specifies a target file (i.e., a .dacpac files) to be used as the targetof action instead of a database. If this parameter is used, no othertarget parameter shall be valid. This parameter shall be invalid foractions that only support database targets. |
| /TenantId: | /tid | {string} | Represents the Azure AD tenant ID or domain name. This option is required to support guest or imported Azure AD users as well as Microsoft accounts such as outlook.com, hotmail.com or live.com. If this parameter is omitted, the default tenant id for Azure AD will be used, assuming that the authenticated user is a native user for this AD. However, in this case any guest or imported users and/or Microsoft accounts hosted in this Azure AD are not supported and the operation will fail. For more information about Active Directory Universal Authentication, see Universal Authentication with SQL Database and SQL Data Warehouse (SSMS support for MFA). |
| /UniversalAuthentication: | /ua | {True|False} | Specifies if Universal Authentication should be used. When set to True, the interactive authentication protocol is activated supporting MFA. This option can also be used for Azure AD authentication without MFA, using an interactive protocol requiring the user to enter their username and password or integrated authentication (Windows credentials). When /UniversalAuthentication is set to True, no Azure AD authentication can be specified in SourceConnectionString (/scs). When /UniversalAuthentication is set to False, Azure AD authentication must be specified in SourceConnectionString (/scs). For more information about Active Directory Universal Authentication, see Universal Authentication with SQL Database and SQL Data Warehouse (SSMS support for MFA). |
Properties specific to the Export action:
| Property | Value | Description |
|---|---|---|
| /p: | CommandTimeout=(INT32 '60') | Specifies the command timeout in seconds when executing queries againstSQL Server. |
| /p: | Storage=({File|Memory} 'File') | Specifies the type of backing storage for the schema model used duringextraction. |
| /p: | TableData=(STRING) | Indicates the table from which data will be extracted. Specify the tablename with or without the brackets surrounding the name parts in thefollowing format: schema_name.table_identifier. |
| /p: | TargetEngineVersion=({Default|Latest|V11|V12} 'Latest') | Specifies what the target engine version is expected to be. This affectswhether to allow objects supported by Microsoft Azure SQL Database serverswith V12 capabilities, such as memory-optimized tables, in the generated bacpac. |
| /p: | VerifyFullTextDocumentTypesSupported=(BOOLEAN) | Specifies whether the supported full-text document types for MicrosoftAzure SQL Database v12 should be verified. |
Import Parameters and Properties
A SqlPackage.exe Import action imports the schema and table data from a BACPAC package - .bacpac file – into a new or empty database in SQL Server or Microsoft Azure SQL Database. At the time of the import operation to an existing database, the target database cannot contain any user-defined schema objects.
Help for command actions.
| Parameter | Short Form | Value | Description |
|---|---|---|---|
| /Action: | /a | Import | Specifies the action to be performed. |
| /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 seethat action's property names. Example: sqlpackage.exe /Action:Publish /?. |
| /Quiet: | /q | {True|False} | Specifies whether detailed feedback is suppressed. Defaults to False. |
| /SourceFile: | /sf | {string} | Specifies a source file to be used as the source of action instead of adatabase. If this parameter is used, no other source parameter shall bevalid. |
| /TargetConnectionString: | /tcs | {string} | Specifies a valid SQL Server/Azure connection string to the targetdatabase. If this parameter is specified it shall be used exclusively ofall other target parameters. |
| /TargetDatabaseName: | /tdn | {string} | Specifies an override for the name of the database that is the target ofsqlpackage.exe Action. |
| /TargetEncryptConnection: | /tec | {True|False} | Specifies if SQL encryption should be used for the target databaseconnection. |
| /TargetPassword: | /tp | {string} | For SQL Server auth scenarios, defines the password to use to access thetarget database. |
| /TargetServerName: | /tsn | {string} | Defines the name of the server hosting the target database. |
| /TargetTimeout: | /tt | {int} | Specifies the timeout for establishing a connection to the target database in seconds. For Azure AD, it is recommended that this value be greater than or equal to 30 seconds. |
| /TargetTrustServerCertificate: | /ttsc | {True|False} | Specifies whether to use SSL to encrypt the target database connection andbypass walking the certificate chain to validate trust. |
| /TargetUser: | /tu | {string} | For SQL Server auth scenarios, defines the SQL Server user to use toaccess the target database. |
| /TenantId: | /tid | {string} | Represents the Azure AD tenant ID or domain name. This option is required to support guest or imported Azure AD users as well as Microsoft accounts such as outlook.com, hotmail.com or live.com. If this parameter is omitted, the default tenant id for Azure AD will be used, assuming that the authenticated user is a native user for this AD. However, in this case any guest or imported users and/or Microsoft accounts hosted in this Azure AD are not supported and the operation will fail. For more information about Active Directory Universal Authentication, see Universal Authentication with SQL Database and SQL Data Warehouse (SSMS support for MFA). |
| /UniversalAuthentication: | /ua | {True|False} | Specifies if Universal Authentication should be used. When set to True, the interactive authentication protocol is activated supporting MFA. This option can also be used for Azure AD authentication without MFA, using an interactive protocol requiring the user to enter their username and password or integrated authentication (Windows credentials). When /UniversalAuthentication is set to True, no Azure AD authentication can be specified in SourceConnectionString (/scs). When /UniversalAuthentication is set to False, Azure AD authentication must be specified in SourceConnectionString (/scs). For more information about Active Directory Universal Authentication, see Universal Authentication with SQL Database and SQL Data Warehouse (SSMS support for MFA). |
Properties specific to the Import action:
| Property | Value | Description |
|---|---|---|
| /p: | CommandTimeout=(INT32 '60') | Specifies the command timeout in seconds when executing queries againstSQL Server. |
| /p: | DatabaseEdition=({Basic|Standard|Premium|Default} 'Default') | Defines the edition of a Microsoft Azure SQL Database. |
| /p: | DatabaseMaximumSize=(INT32) | Defines the maximum size in GB of a Microsoft Azure SQL Database. |
| /p: | DatabaseServiceObjective=(STRING) | Defines the performance level of a Microsoft Azure SQL Database such as"P0" or "S1". |
| /p: | ImportContributorArguments=(STRING) | Specifies deployment contributor arguments for the deploymentcontributors. This should be a semi-colon delimited list of values. |
| /p: | ImportContributors=(STRING) | Specifies the deployment contributors which should run when the bacpac isimported. This should be a semi-colon delimited list of fully qualifiedbuild contributor names or IDs. |
| /p: | Storage=({File|Memory}) | Specifies how elements are stored when building the database model. Forperformance reasons the default is InMemory. For very large databases,File backed storage is required. |
DeployReport Parameters and Properties
A SqlPackage.exe report action creates an XML report of the changes that would be made by a publish action.
Help for DeployReport action
| Parameter | Short Form | Value | Description |
|---|---|---|---|
| /Action: | /a | DeployReport | Specifies the action to be performed. |
| /OutputPath: | /op | {string} | Specifies the file path where the output files are generated. |
| /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. |
| /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. |
| /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 /?. |
| /Quiet: | /q | {True|False} | Specifies whether detailed feedback is suppressed. Defaults to False. |
| /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. |
| /SourceDatabaseName: | /sdn | {string} | Defines the name of the source database. |
| /SourceEncryptConnection: | /sec | {True|False} | Specifies if SQL encryption should be used for the source database connection. |
| /SourceFile: | /sf | {string} | Specifies a source file to be used as the source of action instead of a database. If this parameter is used, no other source parameter shall be valid. |
| /SourcePassword: | /sp | {string} | For SQL Server auth scenarios, defines the password to use to access the source database. |
| /SourceServerName: | /ssn | {string} | Defines the name of the server hosting the source database. |
| /SourceTimeout: | /st | {int} | Specifies the timeout for establishing a connection to the source database in seconds. |
| /SourceTrustServerCertificate: | /stsc | {True|False} | Specifies whether to use SSL to encrypt the source database connection and bypass walking the certificate chain to validate trust. |
| /SourceUser: | /su | {string} | For SQL Server auth scenarios, defines the SQL Server user to use to access the source database. |
| /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. |
| /TargetDatabaseName: | /tdn | {string} | Specifies an override for the name of the database that is the target of sqlpackage.exe Action. |
| /TargetEncryptConnection: | /tec | {True|False} | Specifies if SQL encryption should be used for the target database connection. |
| /TargetFile: | /tf | {string} | Specifies a target file (i.e., a .dacpac files) to be used as the target of action instead of a database. If this parameter is used, no other target parameter shall be valid. This parameter shall be invalid for actions that only support database targets. |
| /TargetPassword: | /tp | {string} | For SQL Server auth scenarios, defines the password to use to access the target database. |
| /TargetServerName: | /tsn | {string} | Defines the name of the server hosting the target database. |
| /TargetTimeout: | /tt | {int} | Specifies the timeout for establishing a connection to the target database in seconds. For Azure AD, it is recommended that this value be greater than or equal to 30 seconds. |
| /TargetTrustServerCertificate: | /ttsc | {True|False} | Specifies whether to use SSL to encrypt the target database connection and bypass walking the certificate chain to validate trust. |
| /TargetUser: | /tu | {string} | For SQL Server auth scenarios, defines the SQL Server user to use to access the target database. |
| /TenantId: | /tid | {string} | Represents the Azure AD tenant ID or domain name. This option is required to support guest or imported Azure AD users as well as Microsoft accounts such as outlook.com, hotmail.com or live.com. If this parameter is omitted, the default tenant id for Azure AD will be used, assuming that the authenticated user is a native user for this AD. However, in this case any guest or imported users and/or Microsoft accounts hosted in this Azure AD are not supported and the operation will fail. For more information about Active Directory Universal Authentication, see Universal Authentication with SQL Database and SQL Data Warehouse (SSMS support for MFA). |
| /UniversalAuthentication: | /ua | {True|False} | Specifies if Universal Authentication should be used. When set to True, the interactive authentication protocol is activated supporting MFA. This option can also be used for Azure AD authentication without MFA, using an interactive protocol requiring the user to enter their username and password or integrated authentication (Windows credentials). When /UniversalAuthentication is set to True, no Azure AD authentication can be specified in SourceConnectionString (/scs). When /UniversalAuthentication is set to False, Azure AD authentication must be specified in SourceConnectionString (/scs). For more information about Active Directory Universal Authentication, see Universal Authentication with SQL Database and SQL Data Warehouse (SSMS support for MFA). |
| /Variables: | /v | {PropertyName}={Value} | Specifies a name value pair for an action specific variable; {VariableName}={Value}. The DACPAC file contains the list of valid SQLCMD variables. An error will result if a value is not provided for every variable. |
Properties specific to the DeployReport action:
| Property | Value | Description |
|---|---|---|
| /p: | AdditionalDeploymentContributorArguments=(STRING) | Specifies additional deployment contributor arguments for the deployment contributors. This should be a semi-colon delimited list of values. |
| /p: | AdditionalDeploymentContributors=(STRING) | Specifies additional deployment contributors which should run when the dacpac is deployed. This should be a semi-colon delimited list of fully qualified build contributor names or IDs. |
| /p: | AllowDropBlockingAssemblies=(BOOLEAN) | This property is used by SqlClr deployment to cause any blocking assemblies to be dropped as part of the deployment plan. By default, any blocking/referencing assemblies will block an assembly update if the referencing assembly needs to be dropped. |
| /p: | AllowIncompatiblePlatform=(BOOLEAN) | Specifies whether to attempt the action despite incompatible SQL Server platforms. |
| /p: | AllowUnsafeRowLevelSecurityDataMovement=(BOOLEAN) | Do not block data motion on a table which has Row Level Security if this property is set to true. Default is false. |
| /p: | BackupDatabaseBeforeChanges=(BOOLEAN) | Backups the database before deploying any changes. |
| /p: | BlockOnPossibleDataLoss=(BOOLEAN 'True') | Specifies that the publish episode should be terminated if there is a possibility of data loss resulting from the publish.operation. |
| /p: | BlockWhenDriftDetected=(BOOLEAN 'True') | Specifies whether to block updating a database whose schema no longer matches its registration or is unregistered. |
| /p: | CommandTimeout=(INT32 '60') | Specifies the command timeout in seconds when executing queries against SQL Server. |
| /p: | CommentOutSetVarDeclarations=(BOOLEAN) | Specifies whether the declaration of SETVAR variables should be commented out in the generated publish script. You might choose to do this if you plan to specify the values on the command line when you publish by using a tool such as SQLCMD.EXE. |
| /p: | CompareUsingTargetCollation=(BOOLEAN) | This setting dictates how the database's collation is handled during deployment; by default the target database's collation will be updated if it does not match the collation specified by the source. When this option is set, the target database's (or server's) collation should be used. |
| /p: | CreateNewDatabase=(BOOLEAN) | Specifies whether the target database should be updated or whether it should be dropped and re-created when you publish to a database. |
| /p: | DatabaseEdition=({Basic|Standard|Premium|Default} 'Default') | Defines the edition of a Microsoft Azure SQL Database. |
| /p: | DatabaseMaximumSize=(INT32) | Defines the maximum size in GB of a Microsoft Azure SQL Database. |
| /p: | DatabaseServiceObjective=(STRING) | Defines the performance level of a Microsoft Azure SQL Database such as "P0" or "S1". |
| /p: | DeployDatabaseInSingleUserMode=(BOOLEAN) | if true, the database is set to Single User Mode before deploying. |
| /p: | DisableAndReenableDdlTriggers=(BOOLEAN 'True') | Specifies whether Data Definition Language (DDL) triggers are disabled at the beginning of the publish process and re-enabled at the end of the publish action. |
| /p: | DoNotAlterChangeDataCaptureObjects=(BOOLEAN 'True') | If true, Change Data Capture objects are not altered. |
| /p: | DoNotAlterReplicatedObjects=(BOOLEAN 'True') | Specifies whether objects that are replicated are identified during verification. |
| /p: | DoNotDropObjectType=(STRING) | An object type that should not be dropped when DropObjectsNotInSource is true. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers. |
| /p: | DoNotDropObjectTypes=(STRING) | A semicolon delimited list of object types that should not be dropped when DropObjectsNotInSource is true. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers. |
| /p: | DropConstraintsNotInSource=(BOOLEAN 'True') | Specifies whether constraints that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database. |
| /p: | DropDmlTriggersNotInSource=(BOOLEAN 'True') | Specifies whether DML triggers that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database. |
| /p: | DropExtendedPropertiesNotInSource=(BOOLEAN 'True') | Specifies whether extended properties that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database. |
| /p: | DropIndexesNotInSource=(BOOLEAN 'True') | Specifies whether indexes that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database. |
| /p: | DropObjectsNotInSource=(BOOLEAN) | Specifies whether objects that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database. This value takes precedence over DropExtendedProperties. |
| /p: | DropPermissionsNotInSource=(BOOLEAN) | Specifies whether permissions that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish updates to a database. |
| /p: | DropRoleMembersNotInSource=(BOOLEAN) | Specifies whether role members that are not defined in the database snapshot (.dacpac) file will be dropped from the target database when you publish updates to a database. |
| /p: | DropStatisticsNotInSource=(BOOLEAN 'True') | Specifies whether statistics that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database. |
| /p: | ExcludeObjectType=(STRING) | An object type that should be ignored during deployment. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers. |
| /p: | ExcludeObjectTypes=(STRING) | A semicolon delimited list of object types that should be ignored during deployment. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers. |
| /p: | GenerateSmartDefaults=(BOOLEAN) | Automatically provides a default value when updating a table that contains data with a column that does not allow null values. |
| /p: | IgnoreAnsiNulls=(BOOLEAN 'True') | Specifies whether differences in the ANSI NULLS setting should be ignored or updated when you publish to a database. |
| /p: | IgnoreAuthorizer=(BOOLEAN) | Specifies whether differences in the Authorizer should be ignored or updated when you publish to a database. |
| /p: | IgnoreColumnCollation=(BOOLEAN) | Specifies whether differences in the column collations should be ignored or updated when you publish to a database. |
| /p: | IgnoreComments=(BOOLEAN) | Specifies whether differences in the comments should be ignored or updated when you publish to a database. |
| /p: | IgnoreCryptographicProviderFilePath=(BOOLEAN 'True') | Specifies whether differences in the file path for the cryptographic provider should be ignored or updated when you publish to a database. |
| /p: | IgnoreDdlTriggerOrder=(BOOLEAN) | Specifies whether differences in the order of Data Definition Language (DDL) triggers should be ignored or updated when you publish to a database or server. |
| /p: | IgnoreDdlTriggerState=(BOOLEAN) | Specifies whether differences in the enabled or disabled state of Data Definition Language (DDL) triggers should be ignored or updated when you publish to a database. |
| /p: | IgnoreDefaultSchema=(BOOLEAN) | Specifies whether differences in the default schema should be ignored or updated when you publish to a database. |
| /p: | IgnoreDmlTriggerOrder=(BOOLEAN) | Specifies whether differences in the order of Data Manipulation Language (DML) triggers should be ignored or updated when you publish to a database. |
| /p: | IgnoreDmlTriggerState=(BOOLEAN) | Specifies whether differences in the enabled or disabled state of DML triggers should be ignored or updated when you publish to a database. |
| /p: | IgnoreExtendedProperties=(BOOLEAN) | Specifies whether differences in the extended properties should be ignored or updated when you publish to a database. |
| /p: | IgnoreFileAndLogFilePath=(BOOLEAN 'True') | Specifies whether differences in the paths for files and log files should be ignored or updated when you publish to a database. |
| /p: | IgnoreFilegroupPlacement=(BOOLEAN 'True') | Specifies whether differences in the placement of objects in FILEGROUPs should be ignored or updated when you publish to a database. |
| /p: | IgnoreFileSize=(BOOLEAN 'True') | Specifies whether differences in the file sizes should be ignored or whether a warning should be issued when you publish to a database. |
| /p: | IgnoreFillFactor=(BOOLEAN 'True') | Specifies whether differences in the fill factor for index storage should be ignored or whether a warning should be issued when you publish to a database |
| /p: | IgnoreFullTextCatalogFilePath=(BOOLEAN 'True') | Specifies whether differences in the file path for the full-text catalog should be ignored or whether a warning should be issued when you publish to a database. |
| /p: | IgnoreIdentitySeed=(BOOLEAN) | Specifies whether differences in the seed for an identity column should be ignored or updated when you publish updates to a database. |
| /p: | IgnoreIncrement=(BOOLEAN) | Specifies whether differences in the increment for an identity column should be ignored or updated when you publish to a database. |
| /p: | IgnoreIndexOptions=(BOOLEAN) | Specifies whether differences in the index options should be ignored or updated when you publish to a database. |
| /p: | IgnoreIndexPadding=(BOOLEAN 'True') | Specifies whether differences in the index padding should be ignored or updated when you publish to a database. |
| /p: | IgnoreKeywordCasing=(BOOLEAN 'True') | Specifies whether differences in the casing of keywords should be ignored or updated when you publish to a database. |
| /p: | IgnoreLockHintsOnIndexes=(BOOLEAN) | Specifies whether differences in the lock hints on indexes should be ignored or updated when you publish to a database. |
| /p: | IgnoreLoginSids=(BOOLEAN 'True') | Specifies whether differences in the security identification number (SID) should be ignored or updated when you publish to a database. |
| /p: | IgnoreNotForReplication=(BOOLEAN) | Specifies whether the not for replication settings should be ignored or updated when you publish to a database. |
| /p: | IgnoreObjectPlacementOnPartitionScheme=(BOOLEAN 'True') | Specifies whether an object's placement on a partition scheme should be ignored or updated when you publish to a database. |
| /p: | IgnorePartitionSchemes=(BOOLEAN) | Specifies whether differences in partition schemes and functions should be ignored or updated when you publish to a database. |
| /p: | IgnorePermissions=(BOOLEAN) | Specifies whether differences in the permissions should be ignored or updated when you publish to a database. |
| /p: | IgnoreQuotedIdentifiers=(BOOLEAN 'True') | Specifies whether differences in the quoted identifiers setting should be ignored or updated when you publish to a database. |
| /p: | IgnoreRoleMembership=(BOOLEAN) | Specifies whether differences in the role membership of logins should be ignored or updated when you publish to a database. |
| /p: | IgnoreRouteLifetime=(BOOLEAN 'True') | Specifies whether differences in the amount of time that SQL Server retains the route in the routing table should be ignored or updated when you publish to a database |
| /p: | IgnoreSemicolonBetweenStatements=(BOOLEAN 'True') | Specifies whether differences in the semi-colons between T-SQL statements will be ignored or updated when you publish to a database. |
| /p: | IgnoreTableOptions=(BOOLEAN) | Specifies whether differences in the table options will be ignored or updated when you publish to a database. |
| /p: | IgnoreUserSettingsObjects=(BOOLEAN) | Specifies whether differences in the user settings objects will be ignored or updated when you publish to a database. |
| /p: | IgnoreWhitespace=(BOOLEAN 'True') | Specifies whether differences in white space will be ignored or updated when you publish to a database. |
| /p: | IgnoreWithNocheckOnCheckConstraints=(BOOLEAN) | Specifies whether differences in the value of the WITH NOCHECK clause for check constraints will be ignored or updated when you publish to a database. |
| /p: | IgnoreWithNocheckOnForeignKeys=(BOOLEAN) | Specifies whether differences in the value of the WITH NOCHECK clause for foreign keys will be ignored or updated when you publish to a database. |
| /p: | IncludeCompositeObjects=(BOOLEAN) | Include all composite elements as part of a single publish operation. |
| /p: | IncludeTransactionalScripts=(BOOLEAN) | Specifies whether transactional statements should be used where possible when you publish to a database. |
| /p: | NoAlterStatementsToChangeClrTypes=(BOOLEAN) | Specifies that publish should always drop and re-create an assembly if there is a difference instead of issuing an ALTER ASSEMBLY statement. |
| /p: | PopulateFilesOnFileGroups=(BOOLEAN 'True') | Specifies whether a new file is also created when a new FileGroup is created in the target database. |
| /p: | RegisterDataTierApplication=(BOOLEAN) | Specifies whether the schema is registered with the database server. |
| /p: | RunDeploymentPlanExecutors=(BOOLEAN) | Specifies whether DeploymentPlanExecutor contributors should be run when other operations are executed. |
| /p: | ScriptDatabaseCollation=(BOOLEAN) | Specifies whether differences in the database collation should be ignored or updated when you publish to a database. |
| /p: | ScriptDatabaseCompatibility=(BOOLEAN) | Specifies whether differences in the database compatibility should be ignored or updated when you publish to a database. |
| /p: | ScriptDatabaseOptions=(BOOLEAN 'True') | Specifies whether target database properties should be set or updated as part of the publish action. |
| /p: | ScriptDeployStateChecks=(BOOLEAN) | Specifies whether statements are generated in the publish script to verify that the database name and server name match the names specified in the database project. |
| /p: | ScriptFileSize=(BOOLEAN) | Controls whether size is specified when adding a file to a filegroup. |
| /p: | ScriptNewConstraintValidation=(BOOLEAN 'True') | At the end of publish all of the constraints will be verified as one set, avoiding data errors caused by a check or foreign key constraint in the middle of publish. If set to False, your constraints will be published without checking the corresponding data. |
| /p: | ScriptRefreshModule=(BOOLEAN 'True') | Include refresh statements at the end of the publish script. |
| /p: | Storage=({File|Memory}) | Specifies how elements are stored when building the database model. For performance reasons the default is InMemory. For very large databases, File backed storage is required. |
| /p: | TreatVerificationErrorsAsWarnings=(BOOLEAN) | Specifies whether errors encountered during publish verification should be treated as warnings. The check is performed against the generated deployment plan before the plan is executed against your target database. Plan verification detects problems such as the loss of target-only objects (such as indexes) that must be dropped to make a change. Verification will also detect situations where dependencies (such as a table or view) exist because of a reference to a composite project, but do not exist in the target database. You might choose to do this to get a complete list of all issues, instead of having the publish action stop on the first error. |
| /p: | UnmodifiableObjectWarnings=(BOOLEAN 'True') | Specifies whether warnings should be generated when differences are found in objects that cannot be modified, for example, if the file size or file paths were different for a file. |
| /p: | VerifyCollationCompatibility=(BOOLEAN 'True') | Specifies whether collation compatibility is verified. |
| /p: | VerifyDeployment=(BOOLEAN 'True') | Specifies whether checks should be performed before publishing that will stop the publish action if issues are present that might block successful publishing. For example, your publish action might stop if you have foreign keys on the target database that do not exist in the database project, and that will cause errors when you publish. |
DriftReport Parameters
A SqlPackage.exe report action creates an XML report of the changes that have been made to the registered database since it was last registered.
Help for DriftReport action.
| Parameter | Short Form | Value | Description |
|---|---|---|---|
| /Action: | /a | DriftReport | Specifies the action to be performed. |
| /OutputPath: | /op | {string} | Specifies the file path where the output files are generated. |
| /OverwriteFiles: | /of | {True|False} | Specifies if sqlpackage.exe should overwrite existing files. Specifyingfalse causes sqlpackage.exe to abort action if an existing file isencountered. Default value is True. |
| /Quiet: | /q | {True|False} | Specifies whether detailed feedback is suppressed. Defaults to False. |
| /TargetConnectionString: | /tcs | {string} | Specifies a valid SQL Server/Azure connection string to the targetdatabase. If this parameter is specified it shall be used exclusively ofall other target parameters. |
| /TargetDatabaseName: | /tdn | {string} | Specifies an override for the name of the database that is the target ofsqlpackage.exe Action. |
| /TargetEncryptConnection: | /tec | {True|False} | Specifies if SQL encryption should be used for the target databaseconnection. |
| /TargetPassword: | /tp | {string} | For SQL Server auth scenarios, defines the password to use to access thetarget database. |
| /TargetServerName: | /tsn | {string} | Defines the name of the server hosting the target database. |
| /TargetTimeout: | /tt | {int} | Specifies the timeout for establishing a connection to the target database in seconds. For Azure AD, it is recommended that this value be greater than or equal to 30 seconds. |
| /TargetTrustServerCertificate: | /ttsc | {True|False} | Specifies whether to use SSL to encrypt the target database connection andbypass walking the certificate chain to validate trust. |
| /TargetUser: | /tu | {string} | For SQL Server auth scenarios, defines the SQL Server user to use toaccess the target database. |
| /TenantId: | /tid | {string} | Represents the Azure AD tenant ID or domain name. This option is required to support guest or imported Azure AD users as well as Microsoft accounts such as outlook.com, hotmail.com or live.com. If this parameter is omitted, the default tenant id for Azure AD will be used, assuming that the authenticated user is a native user for this AD. However, in this case any guest or imported users and/or Microsoft accounts hosted in this Azure AD are not supported and the operation will fail. For more information about Active Directory Universal Authentication, see Universal Authentication with SQL Database and SQL Data Warehouse (SSMS support for MFA). |
| /UniversalAuthentication: | /ua | {True|False} | Specifies if Universal Authentication should be used. When set to True, the interactive authentication protocol is activated supporting MFA. This option can also be used for Azure AD authentication without MFA, using an interactive protocol requiring the user to enter their username and password or integrated authentication (Windows credentials). When /UniversalAuthentication is set to True, no Azure AD authentication can be specified in SourceConnectionString (/scs). When /UniversalAuthentication is set to False, Azure AD authentication must be specified in SourceConnectionString (/scs). For more information about Active Directory Universal Authentication, see Universal Authentication with SQL Database and SQL Data Warehouse (SSMS support for MFA). |
Script Parameters and Properties
A SqlPackage.exe script action creates a Transact-SQL incremental update script that updates the schema of a target database to match the schema of a source database.
Help for the Script action.
| Parameter | Short Form | Value | Description |
|---|---|---|---|
| /Action: | /a | Script | Specifies the action to be performed. |
| /OutputPath: | /op | {string} | Specifies the file path where the output files are generated. |
| /OverwriteFiles: | /of | {True|False} | Specifies if sqlpackage.exe should overwrite existing files. Specifyingfalse causes sqlpackage.exe to abort action if an existing file isencountered. Default value is True. |
| /Profile: | /pr | {string} | Specifies the file path to a DAC Publish Profile. The profile defines acollection of properties and variables to use when generating outputs. |
| /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 seethat action's property names. Example: sqlpackage.exe /Action:Publish /?. |
| /Quiet: | /q | {True|False} | Specifies whether detailed feedback is suppressed. Defaults to False. |
| /SourceConnectionString: | /scs | {string} | Specifies a valid SQL Server/Azure connection string to the sourcedatabase. If this parameter is specified it shall be used exclusively ofall other source parameters. |
| /SourceDatabaseName: | /sdn | {string} | Defines the name of the source database. |
| /SourceEncryptConnection: | /sec | {True|False} | Specifies if SQL encryption should be used for the source databaseconnection. |
| /SourceFile: | /sf | {string} | Specifies a source file to be used as the source of action instead of adatabase. If this parameter is used, no other source parameter shall bevalid. |
| /SourcePassword: | /sp | {string} | For SQL Server auth scenarios, defines the password to use to access thesource database. |
| /SourceServerName: | /ssn | {string} | Defines the name of the server hosting the source database. |
| /SourceTimeout: | /st | {int} | Specifies the timeout for establishing a connection to the source databasein seconds. |
| /SourceTrustServerCertificate: | /stsc | {True|False} | Specifies whether to use SSL to encrypt the source database connection andbypass walking the certificate chain to validate trust. |
| /SourceUser: | /su | {string} | For SQL Server auth scenarios, defines the SQL Server user to use toaccess the source database. |
| /TargetConnectionString: | /tcs | {string} | Specifies a valid SQL Server/Azure connection string to the targetdatabase. If this parameter is specified it shall be used exclusively ofall other target parameters. |
| /TargetDatabaseName: | /tdn | {string} | Specifies an override for the name of the database that is the target ofsqlpackage.exe Action. |
| /TargetEncryptConnection: | /tec | {True|False} | Specifies if SQL encryption should be used for the target databaseconnection. |
| /TargetFile: | /tf | {string} | Specifies a target file (i.e., a .dacpac files) to be used as the targetof action instead of a database. If this parameter is used, no othertarget parameter shall be valid. This parameter shall be invalid foractions that only support database targets. |
| /TargetPassword: | /tp | {string} | For SQL Server auth scenarios, defines the password to use to access thetarget database. |
| /TargetServerName: | /tsn | {string} | Defines the name of the server hosting the target database. |
| /TargetTimeout: | /tt | {int} | Specifies the timeout for establishing a connection to the target database in seconds. For Azure AD, it is recommended that this value be greater than or equal to 30 seconds. |
| /TargetTrustServerCertificate: | /ttsc | {True|False} | Specifies whether to use SSL to encrypt the target database connection andbypass walking the certificate chain to validate trust. |
| /TargetUser: | /tu | {string} | For SQL Server auth scenarios, defines the SQL Server user to use toaccess the target database. |
| /TenantId: | /tid | {string} | Represents the Azure AD tenant ID or domain name. This option is required to support guest or imported Azure AD users as well as Microsoft accounts such as outlook.com, hotmail.com or live.com. If this parameter is omitted, the default tenant id for Azure AD will be used, assuming that the authenticated user is a native user for this AD. However, in this case any guest or imported users and/or Microsoft accounts hosted in this Azure AD are not supported and the operation will fail. For more information about Active Directory Universal Authentication, see Universal Authentication with SQL Database and SQL Data Warehouse (SSMS support for MFA). |
| /UniversalAuthentication: | /ua | {True|False} | Specifies if Universal Authentication should be used. When set to True, the interactive authentication protocol is activated supporting MFA. This option can also be used for Azure AD authentication without MFA, using an interactive protocol requiring the user to enter their username and password or integrated authentication (Windows credentials). When /UniversalAuthentication is set to True, no Azure AD authentication can be specified in SourceConnectionString (/scs). When /UniversalAuthentication is set to False, Azure AD authentication must be specified in SourceConnectionString (/scs). For more information about Active Directory Universal Authentication, see Universal Authentication with SQL Database and SQL Data Warehouse (SSMS support for MFA). |
| /Variables: | /v | {PropertyName}={Value} | Specifies a name value pair for an action specific variable;{VariableName}={Value}. The DACPAC file contains the list of valid SQLCMD variables. An error will result if a value is not provided for every variable. |
Properties specific to the Script action:
| Property | Value | Description |
|---|---|---|
| /p: | AdditionalDeploymentContributorArguments=(STRING) | Specifies additional deployment contributor arguments for the deploymentcontributors. This should be a semi-colon delimited list of values. |
| /p: | AdditionalDeploymentContributors=(STRING) | Specifies additional deployment contributors which should run when thedacpac is deployed. This should be a semi-colon delimited list of fullyqualified build contributor names or IDs. |
| /p: | AllowDropBlockingAssemblies=(BOOLEAN) | This property is used by SqlClr deployment to cause any blockingassemblies to be dropped as part of the deployment plan. By default, anyblocking/referencing assemblies will block an assembly update if thereferencing assembly needs to be dropped. |
| /p: | AllowIncompatiblePlatform=(BOOLEAN) | Specifies whether to attempt the action despite incompatible SQL Serverplatforms. |
| /p: | AllowUnsafeRowLevelSecurityDataMovement=(BOOLEAN) | Do not block data motion on a table which has Row Level Security if thisproperty is set to true. Default is false. |
| /p: | BackupDatabaseBeforeChanges=(BOOLEAN) | Backups the database before deploying any changes. |
| /p: | BlockOnPossibleDataLoss=(BOOLEAN 'True') | Specifies that the publish episode should be terminated if there is apossibility of data loss resulting from the publish.operation. |
| /p: | BlockWhenDriftDetected=(BOOLEAN 'True') | Specifies whether to block updating a database whose schema no longermatches its registration or is unregistered. |
| /p: | CommandTimeout=(INT32 '60') | Specifies the command timeout in seconds when executing queries againstSQL Server. |
| /p: | CommentOutSetVarDeclarations=(BOOLEAN) | Specifies whether the declaration of SETVAR variables should be commentedout in the generated publish script. You might choose to do this if youplan to specify the values on the command line when you publish by using atool such as SQLCMD.EXE. |
| /p: | CompareUsingTargetCollation=(BOOLEAN) | This setting dictates how the database's collation is handled duringdeployment; by default the target database's collation will be updated ifit does not match the collation specified by the source. When this option is set, the target database's (or server's) collation should be used. |
| /p: | CreateNewDatabase=(BOOLEAN) | Specifies whether the target database should be updated or whether itshould be dropped and re-created when you publish to a database. |
| /p: | DatabaseEdition=({Basic|Standard|Premium|Default} 'Default') | Defines the edition of a Microsoft Azure SQL Database. |
| /p: | DatabaseMaximumSize=(INT32) | Defines the maximum size in GB of a Microsoft Azure SQL Database. |
| /p: | DatabaseServiceObjective=(STRING) | Defines the performance level of a Microsoft Azure SQL Database such as"P0" or "S1". |
| /p: | DeployDatabaseInSingleUserMode=(BOOLEAN) | if true, the database is set to Single User Mode before deploying. |
| /p: | DisableAndReenableDdlTriggers=(BOOLEAN 'True') | Specifies whether Data Definition Language (DDL) triggers are disabled atthe beginning of the publish process and re-enabled at the end of thepublish action. |
| /p: | DoNotAlterChangeDataCaptureObjects=(BOOLEAN 'True') | If true, Change Data Capture objects are not altered. |
| /p: | DoNotAlterReplicatedObjects=(BOOLEAN 'True') | Specifies whether objects that are replicated are identified duringverification. |
| /p: | DoNotDropObjectType=(STRING) | An object type that should not be dropped when DropObjectsNotInSource istrue. Valid object type names are Aggregates, ApplicationRoles,Assemblies, AsymmetricKeys, BrokerPriorities, Certificates,ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseRoles,DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources,ExternalFileFormats, ExternalTables, Filegroups, FileTables,FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions,PartitionSchemes, Permissions, Queues, RemoteServiceBindings,RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists,SecurityPolicies, Sequences, Services, Signatures, StoredProcedures,SymmetricKeys, Synonyms, Tables, TableValuedFunctions,UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users,Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders,DatabaseAuditSpecifications, DatabaseScopedCredentials, Endpoints,ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins,LinkedServers, Logins, Routes, ServerAuditSpecifications,ServerRoleMembership, ServerRoles, ServerTriggers. |
| /p: | DoNotDropObjectTypes=(STRING) | A semicolon delimited list of object types that should not be dropped whenDropObjectsNotInSource is true. Valid object type names are Aggregates,ApplicationRoles, Assemblies, AsymmetricKeys, BrokerPriorities,Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts,DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties,ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups,FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes,PartitionFunctions, PartitionSchemes, Permissions, Queues,RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions,SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures,StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions,UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users,Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders,DatabaseAuditSpecifications, DatabaseScopedCredentials, Endpoints,ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins,LinkedServers, Logins, Routes, ServerAuditSpecifications,ServerRoleMembership, ServerRoles, ServerTriggers. |
| /p: | DropConstraintsNotInSource=(BOOLEAN 'True') | Specifies whether constraints that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publishto a database. |
| /p: | DropDmlTriggersNotInSource=(BOOLEAN 'True') | Specifies whether DML triggers that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publishto a database. |
| /p: | DropExtendedPropertiesNotInSource=(BOOLEAN 'True') | Specifies whether extended properties that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when youpublish to a database. |
| /p: | DropIndexesNotInSource=(BOOLEAN 'True') | Specifies whether indexes that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publishto a database. |
| /p: | DropObjectsNotInSource=(BOOLEAN) | Specifies whether objects that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publishto a database. This value takes precedence over DropExtendedProperties. |
| /p: | DropPermissionsNotInSource=(BOOLEAN) | Specifies whether permissions that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publishupdates to a database. |
| /p: | DropRoleMembersNotInSource=(BOOLEAN) | Specifies whether role members that are not defined in the database snapshot (.dacpac) file will be dropped from the target database when youpublish updates to a database. |
| /p: | DropStatisticsNotInSource=(BOOLEAN 'True') | Specifies whether statistics that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publishto a database. |
| /p: | ExcludeObjectType=(STRING) | An object type that should be ignored during deployment. Valid object typenames are Aggregates, ApplicationRoles, Assemblies, AsymmetricKeys,BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys,Contracts, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties,ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups,FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes,PartitionFunctions, PartitionSchemes, Permissions, Queues,RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions,SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures,StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions,UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users,Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders,DatabaseAuditSpecifications, DatabaseScopedCredentials, Endpoints,ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins,LinkedServers, Logins, Routes, ServerAuditSpecifications,ServerRoleMembership, ServerRoles, ServerTriggers. |
| /p: | ExcludeObjectTypes=(STRING) | A semicolon delimited list of object types that should be ignored duringdeployment. Valid object type names are Aggregates, ApplicationRoles,Assemblies, AsymmetricKeys, BrokerPriorities, Certificates,ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseRoles,DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources,ExternalFileFormats, ExternalTables, Filegroups, FileTables,FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions,PartitionSchemes, Permissions, Queues, RemoteServiceBindings,RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists,SecurityPolicies, Sequences, Services, Signatures, StoredProcedures,SymmetricKeys, Synonyms, Tables, TableValuedFunctions,UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users,Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders,DatabaseAuditSpecifications, DatabaseScopedCredentials, Endpoints,ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins,LinkedServers, Logins, Routes, ServerAuditSpecifications,ServerRoleMembership, ServerRoles, ServerTriggers. |
| /p: | GenerateSmartDefaults=(BOOLEAN) | Automatically provides a default value when updating a table that containsdata with a column that does not allow null values. |
| /p: | IgnoreAnsiNulls=(BOOLEAN 'True') | Specifies whether differences in the ANSI NULLS setting should be ignoredor updated when you publish to a database. |
| /p: | IgnoreAuthorizer=(BOOLEAN) | Specifies whether differences in the Authorizer should be ignored or updated when you publish to a database. |
| /p: | IgnoreColumnCollation=(BOOLEAN) | Specifies whether differences in the column collations should be ignoredor updated when you publish to a database. |
| /p: | IgnoreComments=(BOOLEAN) | Specifies whether differences in the comments should be ignored or updatedwhen you publish to a database. |
| /p: | IgnoreCryptographicProviderFilePath=(BOOLEAN 'True') | Specifies whether differences in the file path for the cryptographicprovider should be ignored or updated when you publish to a database. |
| /p: | IgnoreDdlTriggerOrder=(BOOLEAN) | Specifies whether differences in the order of Data Definition Language (DDL) triggers should be ignored or updated when you publish to a databaseor server. |
| /p: | IgnoreDdlTriggerState=(BOOLEAN) | Specifies whether differences in the enabled or disabled state of Data Definition Language (DDL) triggers should be ignored or updated when youpublish to a database. |
| /p: | IgnoreDefaultSchema=(BOOLEAN) | Specifies whether differences in the default schema should be ignored or updated when you publish to a database. |
| /p: | IgnoreDmlTriggerOrder=(BOOLEAN) | Specifies whether differences in the order of Data Manipulation Language (DML) triggers should be ignored or updated when you publish to a database. |
| /p: | IgnoreDmlTriggerState=(BOOLEAN) | Specifies whether differences in the enabled or disabled state of DMLtriggers should be ignored or updated when you publish to a database. |
| /p: | IgnoreExtendedProperties=(BOOLEAN) | Specifies whether differences in the extended properties should be ignoredor updated when you publish to a database. |
| /p: | IgnoreFileAndLogFilePath=(BOOLEAN 'True') | Specifies whether differences in the paths for files and log files shouldbe ignored or updated when you publish to a database. |
| /p: | IgnoreFilegroupPlacement=(BOOLEAN 'True') | Specifies whether differences in the placement of objects in FILEGROUPsshould be ignored or updated when you publish to a database. |
| /p: | IgnoreFileSize=(BOOLEAN 'True') | Specifies whether differences in the file sizes should be ignored orwhether a warning should be issued when you publish to a database. |
| /p: | IgnoreFillFactor=(BOOLEAN 'True') | Specifies whether differences in the fill factor for index storage shouldbe ignored or whether a warning should be issued when you publish to adatabase. |
| /p: | IgnoreFullTextCatalogFilePath=(BOOLEAN 'True') | Specifies whether differences in the file path for the full-text catalogshould be ignored or whether a warning should be issued when you publishto a database. |
| /p: | IgnoreIdentitySeed=(BOOLEAN) | Specifies whether differences in the seed for an identity column should beignored or updated when you publish updates to a database. |
| /p: | IgnoreIncrement=(BOOLEAN) | Specifies whether differences in the increment for an identity columnshould be ignored or updated when you publish to a database. |
| /p: | IgnoreIndexOptions=(BOOLEAN) | Specifies whether differences in the index options should be ignored or updated when you publish to a database. |
| /p: | IgnoreIndexPadding=(BOOLEAN 'True') | Specifies whether differences in the index padding should be ignored or updated when you publish to a database. |
| /p: | IgnoreKeywordCasing=(BOOLEAN 'True') | Specifies whether differences in the casing of keywords should be ignoredor updated when you publish to a database. |
| /p: | IgnoreLockHintsOnIndexes=(BOOLEAN) | Specifies whether differences in the lock hints on indexes should beignored or updated when you publish to a database. |
| /p: | IgnoreLoginSids=(BOOLEAN 'True') | Specifies whether differences in the security identification number (SID)should be ignored or updated when you publish to a database. |
| /p: | IgnoreNotForReplication=(BOOLEAN) | Specifies whether the not for replication settings should be ignored or updated when you publish to a database. |
| /p: | IgnoreObjectPlacementOnPartitionScheme=(BOOLEAN 'True') | Specifies whether an object's placement on a partition scheme should beignored or updated when you publish to a database. |
| /p: | IgnorePartitionSchemes=(BOOLEAN) | Specifies whether differences in partition schemes and functions should beignored or updated when you publish to a database. |
| /p: | IgnorePermissions=(BOOLEAN) | Specifies whether differences in the permissions should be ignored or updated when you publish to a database. |
| /p: | IgnoreQuotedIdentifiers=(BOOLEAN 'True') | Specifies whether differences in the quoted identifiers setting should beignored or updated when you publish to a database. |
| /p: | IgnoreRoleMembership=(BOOLEAN) | Specifies whether differences in the role membership of logins should beignored or updated when you publish to a database. |
| /p: | IgnoreRouteLifetime=(BOOLEAN 'True') | Specifies whether differences in the amount of time that SQL Serverretains the route in the routing table should be ignored or updated whenyou publish to a database. |
| /p: | IgnoreSemicolonBetweenStatements=(BOOLEAN 'True') | Specifies whether differences in the semi-colons between T-SQL statementswill be ignored or updated when you publish to a database. |
| /p: | IgnoreTableOptions=(BOOLEAN) | Specifies whether differences in the table options will be ignored or updated when you publish to a database. |
| /p: | IgnoreUserSettingsObjects=(BOOLEAN) | Specifies whether differences in the user settings objects will be ignoredor updated when you publish to a database. |
| /p: | IgnoreWhitespace=(BOOLEAN 'True') | Specifies whether differences in white space will be ignored or updatedwhen you publish to a database. |
| /p: | IgnoreWithNocheckOnCheckConstraints=(BOOLEAN) | Specifies whether differences in the value of the WITH NOCHECK clause forcheck constraints will be ignored or updated when you publish to adatabase. |
| /p: | IgnoreWithNocheckOnForeignKeys=(BOOLEAN) | Specifies whether differences in the value of the WITH NOCHECK clause forforeign keys will be ignored or updated when you publish to a database. |
| /p: | IncludeCompositeObjects=(BOOLEAN) | Include all composite elements as part of a single publish operation. |
| /p: | IncludeTransactionalScripts=(BOOLEAN) | Specifies whether transactional statements should be used where possiblewhen you publish to a database. |
| /p: | NoAlterStatementsToChangeClrTypes=(BOOLEAN) | Specifies that publish should always drop and re-create an assembly ifthere is a difference instead of issuing an ALTER ASSEMBLY statement. |
| /p: | PopulateFilesOnFileGroups=(BOOLEAN 'True') | Specifies whether a new file is also created when a new FileGroup iscreated in the target database. |
| /p: | RegisterDataTierApplication=(BOOLEAN) | Specifies whether the schema is registered with the database server. |
| /p: | RunDeploymentPlanExecutors=(BOOLEAN) | Specifies whether DeploymentPlanExecutor contributors should be run whenother operations are executed. |
| /p: | ScriptDatabaseCollation=(BOOLEAN) | Specifies whether differences in the database collation should be ignoredor updated when you publish to a database. |
| /p: | ScriptDatabaseCompatibility=(BOOLEAN) | Specifies whether differences in the database compatibility should beignored or updated when you publish to a database. |
| /p: | ScriptDatabaseOptions=(BOOLEAN 'True') | Specifies whether target database properties should be set or updated aspart of the publish action. |
| /p: | ScriptDeployStateChecks=(BOOLEAN) | Specifies whether statements are generated in the publish script to verifythat the database name and server name match the names specified in thedatabase project. |
| /p: | ScriptFileSize=(BOOLEAN) | Controls whether size is specified when adding a file to a filegroup. |
| /p: | ScriptNewConstraintValidation=(BOOLEAN 'True') | At the end of publish all of the constraints will be verified as one set,avoiding data errors caused by a check or foreign key constraint in themiddle of publish. If set to False, your constraints will be publishedwithout checking the corresponding data. |
| /p: | ScriptRefreshModule=(BOOLEAN 'True') | Include refresh statements at the end of the publish script. |
| /p: | Storage=({File|Memory}) | Specifies how elements are stored when building the database model. Forperformance reasons the default is InMemory. For very large databases,File backed storage is required. |
| /p: | TreatVerificationErrorsAsWarnings=(BOOLEAN) | Specifies whether errors encountered during publish verification should betreated as warnings. The check is performed against the generateddeployment plan before the plan is executed against your target database.Plan verification detects problems such as the loss of target-only objects (such as indexes) that must be dropped to make a change. Verification willalso detect situations where dependencies (such as a table or view) existbecause of a reference to a composite project, but do not exist in thetarget database. You might choose to do this to get a complete list of allissues, instead of having the publish action stop on the first error. |
| /p: | UnmodifiableObjectWarnings=(BOOLEAN 'True') | Specifies whether warnings should be generated when differences are foundin objects that cannot be modified, for example, if the file size or filepaths were different for a file. |
| /p: | VerifyCollationCompatibility=(BOOLEAN 'True') | Specifies whether collation compatibility is verified. |
| /p: | VerifyDeployment=(BOOLEAN 'True') | Specifies whether checks should be performed before publishing that willstop the publish action if issues are present that might block successfulpublishing. For example, your publish action might stop if you haveforeign keys on the target database that do not exist in the databaseproject, and that will cause errors when you publish. |