DacDeployOptions Class
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines options that affect the behavior of package deployment to a database.
public sealed class DacDeployOptions
type DacDeployOptions = class
Public NotInheritable Class DacDeployOptions
- Inheritance
-
DacDeployOptions
Dac |
Create a new instance of the DacDeployOptions class with default options. |
Additional |
Specifies additional deployment contributor arguments in addition to those already listed in the dacpac. |
Additional |
Specifies paths to load additional deployment contributors. This should be a semi-colon delimited list of values. |
Additional |
Specifies additional deployment contributors which should run - in addition to those specified in the dacpac. |
Allow |
Get or set boolean that specifies whether CLR deployment will cause blocking assemblies to be dropped. |
Allow |
Get or set boolean that specifies whether file paths should be used for external language deployment. |
Allow |
Get or set boolean that specifies whether file paths should be used for external library deployment. |
Allow |
Get or set boolean that specifies whether deployment will block due to platform compatibility. |
Allow |
Get or set boolean that specifies whether to allow the table recreation in publish |
Allow |
Get or set boolean that specifies whether to ignore blocking data motion on RLS enabled tables |
Azure |
[Preview] Azure Shared Access Signature token of Azure Storage Account to import data from Parquet files. Specify a valid SAS token with access to the storage container path to authenticate with using Shared Access Signature identity. |
Azure |
[Preview] Azure storage blob endpoint of Azure Storage Account to import data from Parquet files. |
Azure |
[Preview] Azure storage container name of Azure Storage Account to import data from parquet files. |
Azure |
[Preview] Azure storage key of Azure Storage Account to import data from Parquet files. |
Azure |
[Preview] The storage root path under the container of Azure Storage Account to import data from Parquet files. |
Backup |
Get or set boolean that specifies whether a database backup will be performed before proceeding with the actual deployment actions. |
Block |
Get or set boolean that specifies whether deployment should stop if the operation could cause data loss. |
Block |
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. |
Command |
Specifies the command timeout in seconds when executing queries against SQLServer. |
Comment |
Get or set boolean that specifies whether the declaration of SQLCMD variables are commented out in the script header. |
Compare |
Get or set boolean that specifies whether the target collation will be used for identifier comparison. |
Create |
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. |
Database |
Specifies the database lock timeout in seconds when executing queries against SQLServer. |
Database |
Defines optional parameters specific to a Microsoft Azure SQL Database. |
Data |
Data operation state provider. |
Deploy |
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. |
Disable |
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. |
Disable |
Gets or set a boolean that specifies if indexes should be disabled before importing data into SQL Server. |
Disable |
Gets or set a boolean that specifies if rebuilding indexes should not use parallelism for importing data into SQL Server. |
Do |
Get or set boolean that specifies whether items configured for Change Data Capture (CDC) should be altered during deployment. |
Do |
Get or set boolean that specifies whether items configured for Replication should be altered during deployment. |
Do |
Get or set boolean that specifies whether to drop all database workload groups that do not exist in the source model. |
Do |
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. |
Do |
Get or set boolean that specifies whether to drop all database workload groups that do not exist in the source model. |
Do |
Specified whether SQLCMD variable names should be used when comparing schema or their values |
Drop |
Get or set boolean that specifies whether to drop all constraints that do not exist in the source model. |
Drop |
Get or set boolean that specifies whether to drop all DML triggers that do not exist in the source model. |
Drop |
Get or set boolean that specifies whether to drop all extended properties that do not exist in the source model. |
Drop |
Get or set boolean that specifies whether to drop all indexes that do not exist in the source model. |
Drop |
Get or set boolean that specifies whether objects that exist in the target but not source should be dropped during deployment. |
Drop |
Get or set boolean that specifies whether to drop all permissions that do not exist in the source model. |
Drop |
Get or set boolean that specifies whether to drop all role memberships that do not exist in the source model. |
Drop |
Get or set boolean that specifies whether to drop all role memberships that do not exist in the source model. |
Enclave |
Specifies an attestation protocol to be used with enclave based Always Encrypted. |
Enclave |
Specifies the enclave attestation Url (an attestation service endpoint) to be used with enclave based Always Encrypted. |
Exclude |
Get or set a collection of object types to exclude from consideration when comparing the source and target model. |
Generate |
Get or set boolean that specifies whether default values should be generated to populate NULL columns that are constrained to NOT NULL values. |
Hash |
Get or set boolean that specifies whether to hash object names in logs |
Ignore |
Get or set boolean that specifies whether to exclude the ANSI_NULL option from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude the AUTHORIZATION option from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude the collation specifier from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude from consideration the order of columns in tables when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude comments from consideration when comparing the source and target model. |
Ignore |
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. |
Ignore |
Get or set boolean that specifies whether to exclude Database Workload Groups that do not exist in the source model. |
Ignore |
Get or set boolean that specifies whether to exclude DDL trigger order from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude DDL trigger state from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude the DEFAULT_SCHEMA option from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude DML trigger order from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude DML trigger state from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude all extended properties from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude the FILENAME option of FILE objects from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude the filegroup specifier from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude the SIZE option of FILE objects from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude the FILLFACTOR option from consideration when comparing the source and target model. |
Ignore |
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. |
Ignore |
Get or set boolean that specifies whether to exclude the seed value of IDENTITY columns from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude the increment value of IDENTITY columns from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude differences in index options from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude the PAD_INDEX option from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude difference in the casing of keywords from consideration when comparing the source and target model. |
Ignore |
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. |
Ignore |
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. |
Ignore |
Get or set boolean that specifies whether to exclude the NOT FOR REPLICATION option from consideration when comparing the source and target model. |
Ignore |
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. |
Ignore |
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. |
Ignore |
Get or set boolean that specifies whether to exclude all permission statements from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude the QUOTED_IDENTIFIER option from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude all ROLE MEMBERSHIP objects from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude the LIFETIME option of ROUTE objects from consideration when comparing the source and target model. |
Ignore |
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. |
Ignore |
Get or set boolean that specifies whether to exclude data sensitivity classifications on columns when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether the options on the target table are updated to match the source table. |
Ignore |
Get or set boolean that specifies whether to exclude the RANGE and BOUNDARY VALUES of a table partition option from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude user settings from consideration when comparing the source and target model. |
Ignore |
Get or set boolean that specifies whether to exclude whitespace from consideration when comparing the source and target model. |
Ignore |
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. |
Ignore |
Get or set boolean that specifies whether to exclude the CHECK|NO CHECK option of a FOREIGN KEY |
Ignore |
Get or set boolean that specifies whether to exclude WorkloadClassifiers that do not exist in the source model. |
Include |
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. |
Include |
Get or set boolean that specifies whether to use transations during the deployment operation and commit the transaction after all changes are successfully applied. |
Is |
Set Always Encrypted Parameterization Mode |
Long |
Specifies the long running command timeout in seconds when executing queries against SQLServer. |
No |
Get or set boolean that specifies whether to force a change to CLR assemblies by dropping and recreating them. |
Perform |
Get or set boolean that specifies whether to perform index operations online |
Populate |
Get or set boolean that specifies whether files are supplied for filegroups defined in the deployment source. |
Preserve |
Get or set boolean that specifies whether the last values used for identity columns should be preserved. |
Rebuild |
Gets or set a boolean that specifies if indexes should be rebuilt offline after importing data into SQL Server. |
Register |
Get or set boolean that specifies whether the database will be registered as a Data-Tier Application. |
Restore |
Gets or set a boolean that specifies if sequence value should be enabled or disabled before deploying the script into SQL Server. |
Run |
Specifies whether DeploymentPlanExecutor contributors should be run when other operations are executed. Default is false. |
Script |
Get or set boolean that specifies whether the target database should be altered to match the source model's collation. |
Script |
Get or set boolean that specifies whether the target database should be altered to match the source model's compatibility level. |
Script |
Get or set boolean that specifies whether the database options in the target database should be updated to match the source model. |
Script |
Get or set boolean that specifies whether the target database should be checked to ensure that it exists, is online and can be updated. |
Script |
Get or set boolean that specifies whether a file size is specified when adding files to file groups. |
Script |
Get or set boolean that specifies whether constraints are validated after all changes are applied. |
Script |
Get or set boolean that specifies whether referencing procedures are refreshed when referenced objects are updated. |
Sql |
Get dictionary of SQL command variable values, keyed by variable name. |
Treat |
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. |
Unmodifiable |
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. |
Verify |
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. |
Verify |
Get or set boolean that specifies whether the plan verification phase is executed or not. |
Set |
Override sqlcmd variable with given value |