SqlDeploymentOptions Class
Definition
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.
Contains deployment options values used for deployment
public class SqlDeploymentOptionstype SqlDeploymentOptions = classPublic Class SqlDeploymentOptions- Inheritance
-
SqlDeploymentOptions
Properties
| AllowDropBlockingAssemblies |
Get boolean that specifies whether CLR deployment will cause blocking assemblies to be dropped. |
| AllowIncompatiblePlatform |
Get boolean that specifies whether deployment will block due to platform compatibility. |
| AllowTableRecreation |
Get boolean that specifies whether to allow table recreation in Publish |
| BackupDatabaseBeforeChanges |
Get boolean that specifies whether a database backup will be performed before proceeding with the actual deployment actions. |
| BlockOnPossibleDataLoss |
Get boolean that specifies whether deployment should stop if the operation could cause data loss. |
| BlockWhenDriftDetected |
Get 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. |
| CommentOutSetVarDeclarations |
Get boolean that specifies whether the declaration of SQLCMD variables are commented out in the script header. |
| CompareUsingTargetCollation |
Get boolean that specifies whether the source collation will be used for identifier comparison. |
| CreateNewDatabase |
Get 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. |
| DeployDatabaseInSingleUserMode |
Get boolean that specifies whether the system will acquire single-user mode on the target database during the duration of the deployment operation. |
| DisableAndReenableDdlTriggers |
Get 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 |
Get boolean that specifies whether items configured for Change Data Capture (CDC) should be altered during deployment. |
| DoNotAlterReplicatedObjects |
Get boolean that specifies whether items configured for Replication should be altered during deployment. |
| DoNotEvaluateSqlCmdVariables |
Specified whether SQLCMD variable names should be used when comparing schema or their values |
| DropConstraintsNotInSource |
Get boolean that specifies whether to drop all constraints that do not exist in the source model. |
| DropDmlTriggersNotInSource |
Get boolean that specifies whether to drop all DML triggers that do not exist in the source model. |
| DropExtendedPropertiesNotInSource |
Get boolean that specifies whether to drop all extended properties that do not exist in the source model. |
| DropIndexesNotInSource |
Get boolean that specifies whether to drop all indexes that do not exist in the source model. |
| DropObjectsNotInSource |
Get boolean that specifies whether objects that exist in the target but not source should be dropped during deployment. |
| DropPermissionsNotInSource |
Get boolean that specifies whether to drop all permissions that do not exist in the source model. |
| DropRoleMembersNotInSource |
Get boolean that specifies whether to drop all role memberships that do not exist in the source model. |
| DropStatisticsNotInSource |
Get boolean that specifies whether to drop all statistics that do not exist in the source model. |
| GenerateSmartDefaults |
Get boolean that specifies whether default values should be generated to populate NULL columns that are constrained to NOT NULL values. |
| HashObjectNamesInLogs |
Get boolean that specifies whether to replace all object names in logs with a random hash value |
| IgnoreAnsiNulls |
Get boolean that specifies whether to exclude the ANSI_NULL option from consideration when comparing the source and target model. |
| IgnoreAuthorizer |
Get boolean that specifies whether to exclude the AUTHORIZATION option from consideration when comparing the source and target model. |
| IgnoreColumnCollation |
Get boolean that specifies whether to exclude the collation specifier from consideration when comparing the source and target model. |
| IgnoreColumnOrder |
Get boolean that specifies whether to exclude from consideration the order of columns in tables when comparing the source and target model. |
| IgnoreComments |
Get boolean that specifies whether to exclude comments from consideration when comparing the source and target model. |
| IgnoreCryptographicProviderFilePath |
Get boolean that specifies whether to exclude the file specification of a cryptographic provider from consideration when comparing the source and target model. |
| IgnoreDatabaseWorkloadGroups |
Get or set boolean that specifies whether to exclude the Database Workload Groups from consideration when comparing the source and target model. |
| IgnoreDdlTriggerOrder |
Get boolean that specifies whether to exclude DDL trigger order from consideration when comparing the source and target model. |
| IgnoreDdlTriggerState |
Get boolean that specifies whether to exclude DDL trigger state from consideration when comparing the source and target model. |
| IgnoreDefaultSchema |
Get boolean that specifies whether to exclude the DEFAULT_SCHEMA option from consideration when comparing the source and target model. |
| IgnoreDmlTriggerOrder |
Get boolean that specifies whether to exclude DML trigger order from consideration when comparing the source and target model. |
| IgnoreDmlTriggerState |
Get boolean that specifies whether to exclude DML trigger state from consideration when comparing the source and target model. |
| IgnoreExtendedProperties |
Get boolean that specifies whether to exclude all extended properties from consideration when comparing the source and target model. |
| IgnoreFileAndLogFilePath |
Get boolean that specifies whether to exclude the FILENAME option of FILE objects from consideration when comparing the source and target model. |
| IgnoreFilegroupPlacement |
Get boolean that specifies whether to exclude the filegroup specifier from consideration when comparing the source and target model. |
| IgnoreFileSize |
Get boolean that specifies whether to exclude the SIZE option of FILE objects from consideration when comparing the source and target model. |
| IgnoreFillFactor |
Get boolean that specifies whether to exclude the FILLFACTOR option from consideration when comparing the source and target model. |
| IgnoreFullTextCatalogFilePath |
Get boolean that specifies whether to exclude the path specification of FULLTEXT CATALOG objects from consideration when comparing the source and target model. |
| IgnoreIdentitySeed |
Get boolean that specifies whether to exclude the seed value of IDENTITY columns from consideration when comparing the source and target model. |
| IgnoreIncrement |
Get boolean that specifies whether to exclude the increment value of IDENTITY columns from consideration when comparing the source and target model. |
| IgnoreIndexesStatisticsOnEnclaveEnabledColumns |
Get boolean that specifies whether to drop Indexes and Statistics before exporting DB Export New Option |
| IgnoreIndexOptions |
Get boolean that specifies whether to exclude differences in index options from consideration when comparing the source and target model. |
| IgnoreIndexPadding |
Get boolean that specifies whether to exclude the PAD_INDEX option from consideration when comparing the source and target model. |
| IgnoreKeywordCasing |
Get boolean that specifies whether to exclude difference in the casing of keywords from consideration when comparing the source and target model. |
| IgnoreLockHintsOnIndexes |
Get 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 |
Get boolean that specifies whether to exclude the SID option of the LOGIN object from consideration when comparing the source and target model. |
| IgnoreNotForReplication |
Get boolean that specifies whether to exclude the NOT FOR REPLICATION option from consideration when comparing the source and target model. |
| IgnoreObjectPlacementOnPartitionScheme |
Get 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 |
Get boolean that specifies whether to exclude the parameter type and Get 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 |
Get boolean that specifies whether to exclude all permission statements from consideration when comparing the source and target model. |
| IgnoreQuotedIdentifiers |
Get boolean that specifies whether to exclude the QUOTED_IDENTIFIER option from consideration when comparing the source and target model. |
| IgnoreRoleMembership |
Get boolean that specifies whether to exclude all ROLE MEMBERSHIP objects from consideration when comparing the source and target model. |
| IgnoreRouteLifetime |
Get boolean that specifies whether to exclude the LIFETIME option of ROUTE objects from consideration when comparing the source and target model. |
| IgnoreSemicolonBetweenStatements |
Get boolean that specifies whether to exclude the existence or absence of semi-colons from consideration when comparing the source and target model. |
| IgnoreSensitivityClassifications |
Get boolean that specifies whether to exclude data sensitivity classifications of columns from consideration when comparing the source and target model. |
| IgnoreTableOptions |
Get boolean that specifies whether the options on the target table are updated to match the source table. |
| IgnoreTablePartitionOptions |
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. |
| IgnoreUserSettingsObjects |
Get boolean that specifies whether to exclude user settings from consideration when comparing the source and target model. |
| IgnoreWhitespace |
Get boolean that specifies whether to exclude whitespace from consideration when comparing the source and target model. |
| IgnoreWithNocheckOnCheckConstraints |
Get 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 |
Get boolean that specifies whether to exclude the CHECK|NO CHECK option of a FOREIGN KEY |
| IgnoreWorkloadClassifiers |
Get or set boolean that specifies whether to exclude the Workload Classifiers from consideration when comparing the source and target model. |
| IncludeCompositeObjects |
Get 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 |
Get boolean that specifies whether to use transations during the deployment operation and commit the transaction after all changes are successfully applied. |
| IsAlwaysEncryptedParameterizationEnabled | |
| NoAlterStatementsToChangeClrTypes |
Get boolean that specifies whether to force a change to CLR assemblies by dropping and recreating them. |
| PerformIndexOperationsOnline |
Get boolean that specifies whether to perform index operations online |
| PopulateFilesOnFileGroups |
Get boolean that specifies whether files are supplied for filegroups defined in the deployment source. |
| PreserveIdentityLastValues |
Get or set boolean that specifies whether the last values used for identity columns should be preserved. |
| RegisterDataTierApplication |
Get boolean that specifies whether the database will be registered as a Data-Tier Application. |
| RestoreSequenceCurrentValue |
Get boolean that specifies whether the target database should update the sequence current value |
| ScriptDatabaseCollation |
Get boolean that specifies whether the target database should be altered to match the source model's collation. |
| ScriptDatabaseCompatibility |
Get boolean that specifies whether the target database should be altered to match the source model's compatibility level. |
| ScriptDatabaseOptions |
Get boolean that specifies whether the database options in the target database should be updated to match the source model. |
| ScriptDeployStateChecks |
Get boolean that specifies whether the target database should be checked to ensure that it exists, is online and can be updated. |
| ScriptFileSize |
Get boolean that specifies whether a file size is specified when adding files to file groups. |
| ScriptNewConstraintValidation |
Get boolean that specifies whether constraints are validated after all changes are applied. |
| ScriptRefreshModule |
Get boolean that specifies whether referencing procedures are refreshed when referenced objects are updated. |
| SqlCommandVariableValues |
Get dictionary of SQL command variable values, keyed by variable name. |
| TargetConnectionString |
Get string that specifies the target connection string |
| TargetDatabaseExists |
Gets boolean that if set specifies whether the target database exists |
| TargetDatabaseName |
Gets string that specifies the target database name |
| TargetingServerless |
Get boolean that specifies whether the target server is LocalDB |
| TreatVerificationErrorsAsWarnings |
Get 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 |
Get 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 |
Get 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 |
Get boolean that specifies whether the plan verification phase is executed or not. |