DbDacFxProvider Class

Summary

Deploy SQL database using DACFx API
graph BT Type-->Base0["MsDeployProvider"] click Base0 "/api/Cake.MsDeploy.Providers/MsDeployProvider" Base0-->Base1["Object"] Type-.->Interface0["IMsDeployProvider"] click Interface0 "/api/Cake.MsDeploy.Providers/IMsDeployProvider" Type-.->Interface1["IMsDeployArgument"] click Interface1 "/api/Cake.MsDeploy/IMsDeployArgument" Type["DbDacFxProvider"] class Type type-node

Syntax

public class DbDacFxProvider : MsDeployProvider, IMsDeployProvider, IMsDeployArgument

Constructors

Name Summary
DbDacFxProvider()

Properties

Name Value Summary
AllowDropBlockingAssemblies Nullable<bool>
A true or false value for the 'AllowDropBlockingAssemblies' setting.
AllowIncompatiblePlatform Nullable<bool>
A true or false value for the 'AllowIncompatiblePlatform' setting.
AppendQuotesToPath bool
Determines if the Path is surrounded in "quotes"
Inherited from MsDeployProvider
AuthenticationType Nullable<AuthenticationScheme>
Authentication scheme to use. NTLM is the default setting. If the wmsvc option is specified, then Basic is the default setting.
Inherited from MsDeployProvider
BackupDatabaseBeforeChanges Nullable<bool>
A true or false value for the 'BackupDatabaseBeforeChanges' setting.
BlockOnPossibleDataLoss Nullable<bool>
A true or false value for the 'BlockOnPossibleDataLoss' setting.
BlockWhenDriftDetected Nullable<bool>
A true or false value for the 'BlockWhenDriftDetected' setting.
CommandTimeout Nullable<int>
An integer value for the 'commandTimeout' setting.
CommentOutSetVarDeclarations Nullable<bool>
A true or false value for the 'CommentOutSetVarDeclarations' setting.
CompareUsingTargetCollation Nullable<bool>
A true or false value for the 'CompareUsingTargetCollation' setting.
ComputerName string
Name of remote computer or proxy-URL
Inherited from MsDeployProvider
CreateNewDatabase Nullable<bool>
A true or false value for the 'CreateNewDatabase' setting.
DacpacAction DacpacAction
A value that is one of 'Deploy, Script, Report'.
DeployDatabaseInSingleUserMode Nullable<bool>
A true or false value for the 'DeployDatabaseInSingleUserMode' setting.
Direction Direction
Determines if the Provider is a source or destination
Inherited from MsDeployProvider
DisableAndReenableDdlTriggers Nullable<bool>
A true or false value for the 'DisableAndReenableDdlTriggers' setting.
DoNotAlterChangeDataCaptureObjects Nullable<bool>
A true or false value for the 'DoNotAlterChangeDataCaptureObjects' setting.
DoNotAlterReplicatedObjects Nullable<bool>
A true or false value for the 'DoNotAlterReplicatedObjects' setting.
DropConstraintsNotInSource Nullable<bool>
A true or false value for the 'DropConstraintsNotInSource' setting.
DropDestinationDatabase Nullable<bool>
A true or false value for the 'dropDestinationDatabase' setting.
DropDmlTriggersNotInSource Nullable<bool>
A true or false value for the 'DropDmlTriggersNotInSource' setting.
DropExtendedPropertiesNotInSource Nullable<bool>
A true or false value for the 'DropExtendedPropertiesNotInSource' setting.
DropIndexesNotInSource Nullable<bool>
A true or false value for the 'DropIndexesNotInSource' setting.
DropObjectsNotInSource Nullable<bool>
A true or false value for the 'DropObjectsNotInSource' setting.
DropPermissionsNotInSource Nullable<bool>
A true or false value for the 'DropPermissionsNotInSource' setting.
DropRoleMembersNotInSource Nullable<bool>
A true or false value for the 'DropRoleMembersNotInSource' setting.
DropStatisticsNotInSource Nullable<bool>
A true or false value for the 'DropStatisticsNotInSource' setting.
GenerateSmartDefaults Nullable<bool>
A true or false value for the 'GenerateSmartDefaults' setting.
IgnoreAnsiNulls Nullable<bool>
A true or false value for the 'IgnoreAnsiNulls' setting.
IgnoreAuthorizer Nullable<bool>
A true or false value for the 'IgnoreAuthorizer' setting.
IgnoreColumnCollation Nullable<bool>
A true or false value for the 'IgnoreColumnCollation' setting.
IgnoreComments Nullable<bool>
A true or false value for the 'IgnoreComments' setting.
IgnoreCryptographicProviderFilePath Nullable<bool>
A true or false value for the 'IgnoreCryptographicProviderFilePath' setting.
IgnoreDdlTriggerOrder Nullable<bool>
A true or false value for the 'IgnoreDdlTriggerOrder' setting.
IgnoreDdlTriggerState Nullable<bool>
A true or false value for the 'IgnoreDdlTriggerState' setting.
IgnoreDefaultSchema Nullable<bool>
A true or false value for the 'IgnoreDefaultSchema' setting.
IgnoreDmlTriggerOrder Nullable<bool>
A true or false value for the 'IgnoreDmlTriggerOrder' setting.
IgnoreDmlTriggerState Nullable<bool>
A true or false value for the 'IgnoreDmlTriggerState' setting.
IgnoreExtendedProperties Nullable<bool>
A true or false value for the 'IgnoreExtendedProperties' setting.
IgnoreFileAndLogFilePath Nullable<bool>
A true or false value for the 'IgnoreFileAndLogFilePath' setting.
IgnoreFilegroupPlacement Nullable<bool>
A true or false value for the 'IgnoreFilegroupPlacement' setting.
IgnoreFileSize Nullable<bool>
A true or false value for the 'IgnoreFileSize' setting.
IgnoreFillFactor Nullable<bool>
A true or false value for the 'IgnoreFillFactor' setting.
IgnoreFullTextCatalogFilePath Nullable<bool>
A true or false value for the 'IgnoreFullTextCatalogFilePath' setting.
IgnoreIdentitySeed Nullable<bool>
A true or false value for the 'IgnoreIdentitySeed' setting.
IgnoreIncrement Nullable<bool>
A true or false value for the 'IgnoreIncrement' setting.
IgnoreIndexOptions Nullable<bool>
A true or false value for the 'IgnoreIndexOptions' setting.
IgnoreIndexPadding Nullable<bool>
A true or false value for the 'IgnoreIndexPadding' setting.
IgnoreKeywordCasing Nullable<bool>
A true or false value for the 'IgnoreKeywordCasing' setting.
IgnoreLockHintsOnIndexes Nullable<bool>
A true or false value for the 'IgnoreLockHintsOnIndexes' setting.
IgnoreLoginSids Nullable<bool>
A true or false value for the 'IgnoreLoginSids' setting.
IgnoreNotForReplication Nullable<bool>
A true or false value for the 'IgnoreNotForReplication' setting.
IgnoreObjectPlacementOnPartitionScheme Nullable<bool>
A true or false value for the 'IgnoreObjectPlacementOnPartitionScheme' setting.
IgnorePartitionSchemes Nullable<bool>
A true or false value for the 'IgnorePartitionSchemes' setting.
IgnorePermissions Nullable<bool>
A true or false value for the 'IgnorePermissions' setting.
IgnoreQuotedIdentifiers Nullable<bool>
A true or false value for the 'IgnoreQuotedIdentifiers' setting.
IgnoreRoleMembership Nullable<bool>
A true or false value for the 'IgnoreRoleMembership' setting.
IgnoreRouteLifetime Nullable<bool>
A true or false value for the 'IgnoreRouteLifetime' setting.
IgnoreSemicolonBetweenStatements Nullable<bool>
A true or false value for the 'IgnoreSemicolonBetweenStatements' setting.
IgnoreTableOptions Nullable<bool>
A true or false value for the 'IgnoreTableOptions' setting.
IgnoreUserSettingsObjects Nullable<bool>
A true or false value for the 'IgnoreUserSettingsObjects' setting.
IgnoreWhitespace Nullable<bool>
A true or false value for the 'IgnoreWhitespace' setting.
IgnoreWithNocheckOnCheckConstraints Nullable<bool>
A true or false value for the 'IgnoreWithNocheckOnCheckConstraints' setting.
IgnoreWithNocheckOnForeignKeys Nullable<bool>
A true or false value for the 'IgnoreWithNocheckOnForeignKeys' setting.
IncludeAcls Nullable<bool>
If true, include ACLs in the operation (applies to the file system, registry, and metabase).
Inherited from MsDeployProvider
IncludeCompositeObjects Nullable<bool>
A true or false value for the 'IncludeCompositeObjects' setting.
IncludeData Nullable<bool>
A true or false value for the 'includeData' setting.
IncludeTransactionalScripts Nullable<bool>
A true or false value for the 'IncludeTransactionalScripts' setting.
NoAlterStatementsToChangeClrTypes Nullable<bool>
A true or false value for the 'NoAlterStatementsToChangeClrTypes' setting.
Password string
Password of the user for remote connections (required if using Basic authentication).
Inherited from MsDeployProvider
Path string
Path of the provider type
Inherited from MsDeployProvider
PopulateFilesOnFileGroups Nullable<bool>
A true or false value for the 'PopulateFilesOnFileGroups' setting.
PublishSettings string
Inherited from MsDeployProvider
RegisterDataTierApplication Nullable<bool>
A true or false value for the 'RegisterDataTierApplication' setting.
RequirePath bool
Determines if the Path argument is required for the MsDeployProvider
Inherited from MsDeployProvider
RunDeploymentPlanExecutors Nullable<bool>
A true or false value for the 'RunDeploymentPlanExecutors' setting.
ScriptDatabaseCollation Nullable<bool>
A true or false value for the 'ScriptDatabaseCollation' setting.
ScriptDatabaseCompatibility Nullable<bool>
A true or false value for the 'ScriptDatabaseCompatibility' setting.
ScriptDatabaseOptions Nullable<bool>
A true or false value for the 'ScriptDatabaseOptions' setting.
ScriptDeployStateChecks Nullable<bool>
A true or false value for the 'ScriptDeployStateChecks' setting.
ScriptFileSize Nullable<bool>
A true or false value for the 'ScriptFileSize' setting.
ScriptNewConstraintValidation Nullable<bool>
A true or false value for the 'ScriptNewConstraintValidation' setting.
ScriptRefreshModule Nullable<bool>
A true or false value for the 'ScriptRefreshModule' setting.
TempAgent Nullable<bool>
Inherited from MsDeployProvider
TreatVerificationErrorsAsWarnings Nullable<bool>
A true or false value for the 'TreatVerificationErrorsAsWarnings' setting.
Type string
UnmodifiableObjectWarnings Nullable<bool>
A true or false value for the 'UnmodifiableObjectWarnings' setting.
Username string
User name to authenticate for remote connections (required if using Basic authentication).
Inherited from MsDeployProvider
VerifyCollationCompatibility Nullable<bool>
A true or false value for the 'VerifyCollationCompatibility' setting.
VerifyDeployment Nullable<bool>
A true or false value for the 'VerifyDeployment' setting.
WebManagementService string
Name of remote computer or proxy-URL for the Web Management Service (WMSvc). Assumes that the service is listening on port 8172.
Inherited from MsDeployProvider

Methods

Name Value Summary
AdditionalSettings(StringBuilder) void
AppendCommandLineArgument(StringBuilder) void
Converts the object into its MSDeploy command line equivalent and Appends it to the stringbuilder
Inherited from MsDeployProvider
ToCommandLineArgument() string
Converts the MSDeploy Provider into its commmand line argument
Inherited from MsDeployProvider

Extension Methods

Name Value Summary
Dump<DbDacFxProvider>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DbDacFxProvider>(DbDacFxProvider[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DbDacFxProvider>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<DbDacFxProvider>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<DbDacFxProvider>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<DbDacFxProvider>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin