This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.SqlServer.

Summary

Settings for extract dacpac from database

Assembly

Cake.SqlServer.dll

Namespace

Cake.SqlServer

Base Types

Object

graph BT Type-->Base0["Object"] Type["PublishDacpacSettings"] class Type type-node

Syntax

public class PublishDacpacSettings

Constructors

Name	Summary
PublishDacpacSettings()	Configures options for what will be reported when performing certain operations from `Microsoft.SqlServer.Dac.DacServices`, in particular whether a DeployReport and/or DeployScript will be generated

Properties

Name	Value	Summary
AdditionalDeploymentContributorArguments	string	Specifies additional deployment contributor arguments in addition to those already listed in the dacpac.
AdditionalDeploymentContributors	string	Specifies additional deployment contributors which should run - in addition to those specified in the dacpac.
AllowDropBlockingAssemblies	bool	Get or set boolean that specifies whether CLR deployment will cause blocking assemblies to be dropped.
AllowIncompatiblePlatform	bool	Get or set boolean that specifies whether deployment will block due to platform compatibility.
AllowUnsafeRowLevelSecurityDataMovement	bool	Get or set boolean that specifies whether to ignore blocking data motion on RLS enabled tables
BackupDatabaseBeforeChanges	bool	Get or set boolean that specifies whether a database backup will be performed before proceeding with the actual deployment actions.
BlockOnPossibleDataLoss	bool	Get or set boolean that specifies whether deployment should stop if the operation could cause data loss.
BlockWhenDriftDetected	bool	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 `Microsoft.SqlServer.Dac.DacDeployOptions.RegisterDataTierApplication` option enabled.
CommandTimeout	int	Specifies the command timeout in seconds when executing queries against SQLServer.
CommentOutSetVarDeclarations	bool	Get or set boolean that specifies whether the declaration of SQLCMD variables are commented out in the script header.
CompareUsingTargetCollation	bool	Get or set boolean that specifies whether the target collation will be used for identifier comparison.
CreateNewDatabase	bool	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.
DatabaseScriptPath	string	Optional path to write the DB-level deployment script, if `Microsoft.SqlServer.Dac.PublishOptions.GenerateDeploymentScript` is true. This script contains all operations that must be done against the database during deployment.
DeployDatabaseInSingleUserMode	bool	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	bool	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	bool	Get or set boolean that specifies whether items configured for Change Data Capture (CDC) should be altered during deployment.
DoNotAlterReplicatedObjects	bool	Get or set boolean that specifies whether items configured for Replication should be altered during deployment.
DropConstraintsNotInSource	bool	Get or set boolean that specifies whether to drop all constraints that do not exist in the source model.
DropDmlTriggersNotInSource	bool	Get or set boolean that specifies whether to drop all DML triggers that do not exist in the source model.
DropExtendedPropertiesNotInSource	bool	Get or set boolean that specifies whether to drop all extended properties that do not exist in the source model.
DropIndexesNotInSource	bool	Get or set boolean that specifies whether to drop all indexes that do not exist in the source model.
DropObjectsNotInSource	bool	Get or set boolean that specifies whether objects that exist in the target but not source should be dropped during deployment.
DropPermissionsNotInSource	bool	Get or set boolean that specifies whether to drop all permissions that do not exist in the source model.
DropRoleMembersNotInSource	bool	Get or set boolean that specifies whether to drop all role memberships that do not exist in the source model.
DropStatisticsNotInSource	bool	Get or set boolean that specifies whether to drop all role memberships that do not exist in the source model.
GenerateDeploymentReport	bool	Sets whether a Deployment Report should be generated during deploy. This report is a high-level summary of actions being performed during deployment.
GenerateDeploymentScript	bool	Sets whether Deployment Script(s) should be generated during deploy. If true, a script to update the database will be generated, and a script to update Master may also be generated if the target is an Azure SQL DB and this database has not yet been created.
GenerateSmartDefaults	bool	Get or set boolean that specifies whether default values should be generated to populate NULL columns that are constrained to NOT NULL values.
IgnoreAnsiNulls	bool	Get or set boolean that specifies whether to exclude the ANSI_NULL option from consideration when comparing the source and target model.
IgnoreAuthorizer	bool	Get or set boolean that specifies whether to exclude the AUTHORIZATION option from consideration when comparing the source and target model.
IgnoreColumnCollation	bool	Get or set boolean that specifies whether to exclude the collation specifier from consideration when comparing the source and target model.
IgnoreComments	bool	Get or set boolean that specifies whether to exclude comments from consideration when comparing the source and target model.
IgnoreCryptographicProviderFilePath	bool	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	bool	Get or set boolean that specifies whether to exclude DDL trigger order from consideration when comparing the source and target model.
IgnoreDdlTriggerState	bool	Get or set boolean that specifies whether to exclude DDL trigger state from consideration when comparing the source and target model.
IgnoreDefaultSchema	bool	Get or set boolean that specifies whether to exclude the DEFAULT_SCHEMA option from consideration when comparing the source and target model.
IgnoreDmlTriggerOrder	bool	Get or set boolean that specifies whether to exclude DML trigger order from consideration when comparing the source and target model.
IgnoreDmlTriggerState	bool	Get or set boolean that specifies whether to exclude DML trigger state from consideration when comparing the source and target model.
IgnoreExtendedProperties	bool	Get or set boolean that specifies whether to exclude all extended properties from consideration when comparing the source and target model.
IgnoreFileAndLogFilePath	bool	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	bool	Get or set boolean that specifies whether to exclude the filegroup specifier from consideration when comparing the source and target model.
IgnoreFileSize	bool	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	bool	Get or set boolean that specifies whether to exclude the FILLFACTOR option from consideration when comparing the source and target model.
IgnoreFullTextCatalogFilePath	bool	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	bool	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	bool	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	bool	Get or set boolean that specifies whether to exclude differences in index options from consideration when comparing the source and target model.
IgnoreIndexPadding	bool	Get or set boolean that specifies whether to exclude the PAD_INDEX option from consideration when comparing the source and target model.
IgnoreKeywordCasing	bool	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	bool	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	bool	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	bool	Get or set boolean that specifies whether to exclude the NOT FOR REPLICATION option from consideration when comparing the source and target model.
IgnoreObjectPlacementOnPartitionScheme	bool	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	bool	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	bool	Get or set boolean that specifies whether to exclude all permission statements from consideration when comparing the source and target model.
IgnoreQuotedIdentifiers	bool	Get or set boolean that specifies whether to exclude the QUOTED_IDENTIFIER option from consideration when comparing the source and target model.
IgnoreRoleMembership	bool	Get or set boolean that specifies whether to exclude all ROLE MEMBERSHIP objects from consideration when comparing the source and target model.
IgnoreRouteLifetime	bool	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	bool	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	bool	Get or set boolean that specifies whether the options on the target table are updated to match the source table.
IgnoreUserSettingsObjects	bool	Get or set boolean that specifies whether to exclude user settings from consideration when comparing the source and target model.
IgnoreWhitespace	bool	Get or set boolean that specifies whether to exclude whitespace from consideration when comparing the source and target model.
IgnoreWithNocheckOnCheckConstraints	bool	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	bool	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	bool	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	bool	Get or set boolean that specifies whether to use transations during the deployment operation and commit the transaction after all changes are successfully applied.
MasterDbScriptPath	string	Optional path to write the master database-level deployment script, if `Microsoft.SqlServer.Dac.PublishOptions.GenerateDeploymentScript` is true. This script is only created if Azure SQL DB is the target as USE statements are not supported on that platform. It contains all operations that must be done against the master database, for instance Create Database statements
NoAlterStatementsToChangeClrTypes	bool	Get or set boolean that specifies whether to force a change to CLR assemblies by dropping and recreating them.
PopulateFilesOnFileGroups	bool	Get or set boolean that specifies whether files are supplied for filegroups defined in the deployment source.
RegisterDataTierApplication	bool	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	bool	Specifies whether DeploymentPlanExecutor contributors should be run when other operations are executed. Default is false.
ScriptDatabaseCollation	bool	Get or set boolean that specifies whether the target database should be altered to match the source model's collation.
ScriptDatabaseCompatibility	bool	Get or set boolean that specifies whether the target database should be altered to match the source model's compatibility level.
ScriptDatabaseOptions	bool	Get or set boolean that specifies whether the database options in the target database should be updated to match the source model.
ScriptDeployStateChecks	bool	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	bool	Get or set boolean that specifies whether a file size is specified when adding files to file groups.
ScriptNewConstraintValidation	bool	Get or set boolean that specifies whether constraints are validated after all changes are applied.
ScriptRefreshModule	bool	Get or set boolean that specifies whether referencing procedures are refreshed when referenced objects are updated.
SqlCommandVariableValues	Dictionary<string, string>	Get dictionary of SQL command variable values, keyed by variable name.
TreatVerificationErrorsAsWarnings	bool	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	bool	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	bool	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	bool	Get or set boolean that specifies whether the plan verification phase is executed or not.

Extension Methods

Name	Value	Summary
Dump<PublishDacpacSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<PublishDacpacSettings>(PublishDacpacSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<PublishDacpacSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<PublishDacpacSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<PublishDacpacSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<PublishDacpacSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin

PublishDacpacSettings Class

Summary

Syntax

Constructors

Properties

Extension Methods