DacDeployOptions DacDeployOptions DacDeployOptions Class

Definition

Defines options that affect the behavior of package deployment to a database.

public sealed class DacDeployOptions
type DacDeployOptions = class
Public NotInheritable Class DacDeployOptions
Inheritance
DacDeployOptionsDacDeployOptionsDacDeployOptions

Constructors

DacDeployOptions() DacDeployOptions() DacDeployOptions()

Create a new instance of the DacDeployOptions class with default options.

Properties

AdditionalDeploymentContributorArguments AdditionalDeploymentContributorArguments AdditionalDeploymentContributorArguments

Specifies additional deployment contributor arguments in addition to those already listed in the dacpac.

AdditionalDeploymentContributors AdditionalDeploymentContributors AdditionalDeploymentContributors

Specifies additional deployment contributors which should run - in addition to those specified in the dacpac.

AllowDropBlockingAssemblies AllowDropBlockingAssemblies AllowDropBlockingAssemblies

Get or set boolean that specifies whether CLR deployment will cause blocking assemblies to be dropped.

AllowIncompatiblePlatform AllowIncompatiblePlatform AllowIncompatiblePlatform

Get or set boolean that specifies whether deployment will block due to platform compatibility.

AllowUnsafeRowLevelSecurityDataMovement AllowUnsafeRowLevelSecurityDataMovement AllowUnsafeRowLevelSecurityDataMovement

Get or set boolean that specifies whether to ignore blocking data motion on RLS enabled tables

BackupDatabaseBeforeChanges BackupDatabaseBeforeChanges BackupDatabaseBeforeChanges

Get or set boolean that specifies whether a database backup will be performed before proceeding with the actual deployment actions.

BlockOnPossibleDataLoss BlockOnPossibleDataLoss BlockOnPossibleDataLoss

Get or set boolean that specifies whether deployment should stop if the operation could cause data loss.

BlockWhenDriftDetected BlockWhenDriftDetected BlockWhenDriftDetected

Get or set boolean that specifies whether the system will check for differences between the present state of the database and the registered state of the database and block deployment if changes are detected. Even if this option is set to true, drift detection will only occur on a database if it was previously deployed with the RegisterDataTierApplication option enabled.

CommandTimeout CommandTimeout CommandTimeout

Specifies the command timeout in seconds when executing queries against SQLServer.

CommentOutSetVarDeclarations CommentOutSetVarDeclarations CommentOutSetVarDeclarations

Get or set boolean that specifies whether the declaration of SQLCMD variables are commented out in the script header.

CompareUsingTargetCollation CompareUsingTargetCollation CompareUsingTargetCollation

Get or set boolean that specifies whether the target collation will be used for identifier comparison.

CreateNewDatabase CreateNewDatabase CreateNewDatabase

Get or set boolean that specifies whether the existing database will be dropped and a new database created before proceeding with the actual deployment actions. Acquires single-user mode before dropping the existing database.

DatabaseSpecification DatabaseSpecification DatabaseSpecification

Defines optional parameters specific to a Microsoft Azure SQL Database.

DeployDatabaseInSingleUserMode DeployDatabaseInSingleUserMode DeployDatabaseInSingleUserMode

Get or set boolean that specifies whether the system will acquire single-user mode on the target database during the duration of the deployment operation.

DisableAndReenableDdlTriggers DisableAndReenableDdlTriggers DisableAndReenableDdlTriggers

Get or set boolean that specifies if all DDL triggers will be disabled for the duration of the deployment operation and then re-enabled after all changes are applied.

DoNotAlterChangeDataCaptureObjects DoNotAlterChangeDataCaptureObjects DoNotAlterChangeDataCaptureObjects

Get or set boolean that specifies whether items configured for Change Data Capture (CDC) should be altered during deployment.

DoNotAlterReplicatedObjects DoNotAlterReplicatedObjects DoNotAlterReplicatedObjects

Get or set boolean that specifies whether items configured for Replication should be altered during deployment.

DoNotDropObjectTypes DoNotDropObjectTypes DoNotDropObjectTypes

Get or set a collection of object types that will not be dropped from the target when no corresponding object exists in the source. Note that dropping and recreating objects of the specified type may still be necessary due to dependencies from other objects.

DropConstraintsNotInSource DropConstraintsNotInSource DropConstraintsNotInSource

Get or set boolean that specifies whether to drop all constraints that do not exist in the source model.

DropDmlTriggersNotInSource DropDmlTriggersNotInSource DropDmlTriggersNotInSource

Get or set boolean that specifies whether to drop all DML triggers that do not exist in the source model.

DropExtendedPropertiesNotInSource DropExtendedPropertiesNotInSource DropExtendedPropertiesNotInSource

Get or set boolean that specifies whether to drop all extended properties that do not exist in the source model.

DropIndexesNotInSource DropIndexesNotInSource DropIndexesNotInSource

Get or set boolean that specifies whether to drop all indexes that do not exist in the source model.

DropObjectsNotInSource DropObjectsNotInSource DropObjectsNotInSource

Get or set boolean that specifies whether objects that exist in the target but not source should be dropped during deployment.

DropPermissionsNotInSource DropPermissionsNotInSource DropPermissionsNotInSource

Get or set boolean that specifies whether to drop all permissions that do not exist in the source model.

DropRoleMembersNotInSource DropRoleMembersNotInSource DropRoleMembersNotInSource

Get or set boolean that specifies whether to drop all role memberships that do not exist in the source model.

DropStatisticsNotInSource DropStatisticsNotInSource DropStatisticsNotInSource

Get or set boolean that specifies whether to drop all role memberships that do not exist in the source model.

ExcludeObjectTypes ExcludeObjectTypes ExcludeObjectTypes

Get or set a collection of object types to exclude from consideration when comparing the source and target model.

GenerateSmartDefaults GenerateSmartDefaults GenerateSmartDefaults

Get or set boolean that specifies whether default values should be generated to populate NULL columns that are constrained to NOT NULL values.

IgnoreAnsiNulls IgnoreAnsiNulls IgnoreAnsiNulls

Get or set boolean that specifies whether to exclude the ANSI_NULL option from consideration when comparing the source and target model.

IgnoreAuthorizer IgnoreAuthorizer IgnoreAuthorizer

Get or set boolean that specifies whether to exclude the AUTHORIZATION option from consideration when comparing the source and target model.

IgnoreColumnCollation IgnoreColumnCollation IgnoreColumnCollation

Get or set boolean that specifies whether to exclude the collation specifier from consideration when comparing the source and target model.

IgnoreColumnOrder IgnoreColumnOrder IgnoreColumnOrder

Get or set boolean that specifies whether to exclude from consideration the order of columns in tables when comparing the source and target model.

IgnoreComments IgnoreComments IgnoreComments

Get or set boolean that specifies whether to exclude comments from consideration when comparing the source and target model.

IgnoreCryptographicProviderFilePath IgnoreCryptographicProviderFilePath IgnoreCryptographicProviderFilePath

Get or set boolean that specifies whether to exclude the file specification of a cryptographic provider from consideration when comparing the source and target model.

IgnoreDdlTriggerOrder IgnoreDdlTriggerOrder IgnoreDdlTriggerOrder

Get or set boolean that specifies whether to exclude DDL trigger order from consideration when comparing the source and target model.

IgnoreDdlTriggerState IgnoreDdlTriggerState IgnoreDdlTriggerState

Get or set boolean that specifies whether to exclude DDL trigger state from consideration when comparing the source and target model.

IgnoreDefaultSchema IgnoreDefaultSchema IgnoreDefaultSchema

Get or set boolean that specifies whether to exclude the DEFAULT_SCHEMA option from consideration when comparing the source and target model.

IgnoreDmlTriggerOrder IgnoreDmlTriggerOrder IgnoreDmlTriggerOrder

Get or set boolean that specifies whether to exclude DML trigger order from consideration when comparing the source and target model.

IgnoreDmlTriggerState IgnoreDmlTriggerState IgnoreDmlTriggerState

Get or set boolean that specifies whether to exclude DML trigger state from consideration when comparing the source and target model.

IgnoreExtendedProperties IgnoreExtendedProperties IgnoreExtendedProperties

Get or set boolean that specifies whether to exclude all extended properties from consideration when comparing the source and target model.

IgnoreFileAndLogFilePath IgnoreFileAndLogFilePath IgnoreFileAndLogFilePath

Get or set boolean that specifies whether to exclude the FILENAME option of FILE objects from consideration when comparing the source and target model.

IgnoreFilegroupPlacement IgnoreFilegroupPlacement IgnoreFilegroupPlacement

Get or set boolean that specifies whether to exclude the filegroup specifier from consideration when comparing the source and target model.

IgnoreFileSize IgnoreFileSize IgnoreFileSize

Get or set boolean that specifies whether to exclude the SIZE option of FILE objects from consideration when comparing the source and target model.

IgnoreFillFactor IgnoreFillFactor IgnoreFillFactor

Get or set boolean that specifies whether to exclude the FILLFACTOR option from consideration when comparing the source and target model.

IgnoreFullTextCatalogFilePath IgnoreFullTextCatalogFilePath IgnoreFullTextCatalogFilePath

Get or set boolean that specifies whether to exclude the path specification of FULLTEXT CATALOG objects from consideration when comparing the source and target model.

IgnoreIdentitySeed IgnoreIdentitySeed IgnoreIdentitySeed

Get or set boolean that specifies whether to exclude the seed value of IDENTITY columns from consideration when comparing the source and target model.

IgnoreIncrement IgnoreIncrement IgnoreIncrement

Get or set boolean that specifies whether to exclude the increment value of IDENTITY columns from consideration when comparing the source and target model.

IgnoreIndexOptions IgnoreIndexOptions IgnoreIndexOptions

Get or set boolean that specifies whether to exclude differences in index options from consideration when comparing the source and target model.

IgnoreIndexPadding IgnoreIndexPadding IgnoreIndexPadding

Get or set boolean that specifies whether to exclude the PAD_INDEX option from consideration when comparing the source and target model.

IgnoreKeywordCasing IgnoreKeywordCasing IgnoreKeywordCasing

Get or set boolean that specifies whether to exclude difference in the casing of keywords from consideration when comparing the source and target model.

IgnoreLockHintsOnIndexes IgnoreLockHintsOnIndexes IgnoreLockHintsOnIndexes

Get or set boolean that specifies whether to exclude the ALLOW_ROW_LOCKS and ALLOW_PAGE_LOGKS options from consideration when comparing the source and target model.

IgnoreLoginSids IgnoreLoginSids IgnoreLoginSids

Get or set boolean that specifies whether to exclude the SID option of the LOGIN object from consideration when comparing the source and target model.

IgnoreNotForReplication IgnoreNotForReplication IgnoreNotForReplication

Get or set boolean that specifies whether to exclude the NOT FOR REPLICATION option from consideration when comparing the source and target model.

IgnoreObjectPlacementOnPartitionScheme IgnoreObjectPlacementOnPartitionScheme IgnoreObjectPlacementOnPartitionScheme

Get or set boolean that specifies whether to exclude the partition scheme object from consideration when comparing the source and target model for the following objects: Table, Index, Unique Key, Primary Key, and Queue.

IgnorePartitionSchemes IgnorePartitionSchemes IgnorePartitionSchemes

Get or set boolean that specifies whether to exclude the parameter type and boundary VALUES of a PARTITION FUNCTION from consideration when comparing the source and target model. Also excludes FILEGROUP and partition function of a PARTITION SCHEMA from consideration when comparing the source and target model.

IgnorePermissions IgnorePermissions IgnorePermissions

Get or set boolean that specifies whether to exclude all permission statements from consideration when comparing the source and target model.

IgnoreQuotedIdentifiers IgnoreQuotedIdentifiers IgnoreQuotedIdentifiers

Get or set boolean that specifies whether to exclude the QUOTED_IDENTIFIER option from consideration when comparing the source and target model.

IgnoreRoleMembership IgnoreRoleMembership IgnoreRoleMembership

Get or set boolean that specifies whether to exclude all ROLE MEMBERSHIP objects from consideration when comparing the source and target model.

IgnoreRouteLifetime IgnoreRouteLifetime IgnoreRouteLifetime

Get or set boolean that specifies whether to exclude the LIFETIME option of ROUTE objects from consideration when comparing the source and target model.

IgnoreSemicolonBetweenStatements IgnoreSemicolonBetweenStatements IgnoreSemicolonBetweenStatements

Get or set boolean that specifies whether to exclude the existence or absence of semi-colons from consideration when comparing the source and target model.

IgnoreTableOptions IgnoreTableOptions IgnoreTableOptions

Get or set boolean that specifies whether the options on the target table are updated to match the source table.

IgnoreUserSettingsObjects IgnoreUserSettingsObjects IgnoreUserSettingsObjects

Get or set boolean that specifies whether to exclude user settings from consideration when comparing the source and target model.

IgnoreWhitespace IgnoreWhitespace IgnoreWhitespace

Get or set boolean that specifies whether to exclude whitespace from consideration when comparing the source and target model.

IgnoreWithNocheckOnCheckConstraints IgnoreWithNocheckOnCheckConstraints IgnoreWithNocheckOnCheckConstraints

Get or set boolean that specifies whether to exclude the CHECK|NO CHECK option of a CHECK constraint object from consideration when comparing the source and target model.

IgnoreWithNocheckOnForeignKeys IgnoreWithNocheckOnForeignKeys IgnoreWithNocheckOnForeignKeys

Get or set boolean that specifies whether to exclude the CHECK|NO CHECK option of a FOREIGN KEY
constraint object from consideration when comparing the source and target model.

IncludeCompositeObjects IncludeCompositeObjects IncludeCompositeObjects

Get or set boolean that specifies whether to include referenced, external elements that also compose the source model and then update the target database in a single deployment operation.

IncludeTransactionalScripts IncludeTransactionalScripts IncludeTransactionalScripts

Get or set boolean that specifies whether to use transations during the deployment operation and commit the transaction after all changes are successfully applied.

NoAlterStatementsToChangeClrTypes NoAlterStatementsToChangeClrTypes NoAlterStatementsToChangeClrTypes

Get or set boolean that specifies whether to force a change to CLR assemblies by dropping and recreating them.

PopulateFilesOnFileGroups PopulateFilesOnFileGroups PopulateFilesOnFileGroups

Get or set boolean that specifies whether files are supplied for filegroups defined in the deployment source.

RegisterDataTierApplication RegisterDataTierApplication RegisterDataTierApplication

Get or set boolean that specifies whether the database will be registered as a Data-Tier Application.
If the target database is already a registered Data-Tier Application, then the registration will be updated.

RunDeploymentPlanExecutors RunDeploymentPlanExecutors RunDeploymentPlanExecutors

Specifies whether DeploymentPlanExecutor contributors should be run when other operations are executed. Default is false.

ScriptDatabaseCollation ScriptDatabaseCollation ScriptDatabaseCollation

Get or set boolean that specifies whether the target database should be altered to match the source model's collation.

ScriptDatabaseCompatibility ScriptDatabaseCompatibility ScriptDatabaseCompatibility

Get or set boolean that specifies whether the target database should be altered to match the source model's compatibility level.

ScriptDatabaseOptions ScriptDatabaseOptions ScriptDatabaseOptions

Get or set boolean that specifies whether the database options in the target database should be updated to match the source model.

ScriptDeployStateChecks ScriptDeployStateChecks ScriptDeployStateChecks

Get or set boolean that specifies whether the target database should be checked to ensure that it exists, is online and can be updated.

ScriptFileSize ScriptFileSize ScriptFileSize

Get or set boolean that specifies whether a file size is specified when adding files to file groups.

ScriptNewConstraintValidation ScriptNewConstraintValidation ScriptNewConstraintValidation

Get or set boolean that specifies whether constraints are validated after all changes are applied.

ScriptRefreshModule ScriptRefreshModule ScriptRefreshModule

Get or set boolean that specifies whether referencing procedures are refreshed when referenced objects are updated.

SqlCommandVariableValues SqlCommandVariableValues SqlCommandVariableValues

Get dictionary of SQL command variable values, keyed by variable name.

TreatVerificationErrorsAsWarnings TreatVerificationErrorsAsWarnings TreatVerificationErrorsAsWarnings

Get or set boolean that specifies whether to treat errors that occur during publish verification as warnings. The check is performed against the generated deployment plan before the plan is executed against the target database. Plan verification detects problems, such as the loss of target-only objects (for example, indexes), that must be dropped to make a change. Verification also detects situations where dependencies (such as tables or views) exist because of a reference to a composite project, but do not exist in the target database. You might choose to treat verification errors as warnings to get a complete list of issues instead of allowing the publish action to stop when the first error occurs.

UnmodifiableObjectWarnings UnmodifiableObjectWarnings UnmodifiableObjectWarnings

Get or set boolean that 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.

VerifyCollationCompatibility VerifyCollationCompatibility VerifyCollationCompatibility

Get or set boolean that specifies whether deployment will verify that the collation specified in the source model is compatible with the collation specified in the target model.

VerifyDeployment VerifyDeployment VerifyDeployment

Get or set boolean that specifies whether the plan verification phase is executed or not.

Applies to