Share via

SqlSchemaDeploymentOptions Class

  • Article

Contains options that control deployment.

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.Build.SchemaDeploymentOptions
    Microsoft.Data.Schema.Sql.Build.SqlSchemaDeploymentOptions
      Microsoft.Data.Schema.Sql.Build.Sql90SchemaDeploymentOptions

Namespace:  Microsoft.Data.Schema.Sql.Build
Assembly:  Microsoft.Data.Schema.Sql (in Microsoft.Data.Schema.Sql.dll)

Syntax

'Declaration
<DatabaseSchemaProviderCompatibilityAttribute(GetType(SqlDatabaseSchemaProvider))> _
Public MustInherit Class SqlSchemaDeploymentOptions _
    Inherits SchemaDeploymentOptions

[DatabaseSchemaProviderCompatibilityAttribute(typeof(SqlDatabaseSchemaProvider))]
public abstract class SqlSchemaDeploymentOptions : SchemaDeploymentOptions

[DatabaseSchemaProviderCompatibilityAttribute(typeof(SqlDatabaseSchemaProvider))]
public ref class SqlSchemaDeploymentOptions abstract : public SchemaDeploymentOptions

[<AbstractClass>]
[<DatabaseSchemaProviderCompatibilityAttribute(typeof(SqlDatabaseSchemaProvider))>]
type SqlSchemaDeploymentOptions =  
    class
        inherit SchemaDeploymentOptions
    end

public abstract class SqlSchemaDeploymentOptions extends SchemaDeploymentOptions

The SqlSchemaDeploymentOptions type exposes the following members.

Constructors

  Name Description
Protected method SqlSchemaDeploymentOptions Initializes a new instance of the SqlSchemaDeploymentOptions class.

Top

Properties

  Name Description
Public property AbortOnFirstError Gets or sets a value that indicates whether deployment should stop when the first error occurs.
Public property BackupDatabaseBeforeChanges Gets or sets a value that indicates whether the update script should include statements to back up the database before the target is modified.
Public property BlockOnPossibleDataLoss Gets or sets a value that indicates whether the update script should block if data loss might occur.
Public property BuildtimeContributorsMustExist (Inherited from SchemaDeploymentOptions.)
Public property CheckNewConstraints Gets or sets a value that indicates whether new constraints should be checked when deploying changes.
Public property CollationPreference Gets or sets a value that indicates how the collation should be handled when changes are deployed.
Public property CommentOutSetVarDeclarations Gets or sets a value that indicates whether the SETVAR declarations should be commented out in the generated synchronization script.
Public property ComparerConfiguration Gets the comparison filter. (Overrides SchemaDeploymentOptions.ComparerConfiguration.)
Public property CreateNewDatabase Gets or sets a value that indicates whether to create a new target database during deployment. (Inherited from SchemaDeploymentOptions.)
Public property DatabaseSchemaProvider Gets the database schema provider.
Public property DeployDatabaseInSingleUserMode Gets or sets a value that indicates whether update script should set the database to single-user mode.
Public property DropConstraintsNotInSource Gets or sets a value that indicates whether constraints that occur only in the target should be dropped when deploying changes.
Public property DropIndexesNotInSource Gets or sets a value that indicates whether indexes that occur only in the target database should be dropped when deploying changes.
Public property DropObjectsNotInSource Gets or sets a value that indicates whether to drop any objects in the target database that are not in the source database. (Inherited from SchemaDeploymentOptions.)
Public property EnforceMinimalDependencies Gets or sets a value that indicates whether only minimal dependencies should be enforced when schemas are compared.
Public property ExcludedModelElements Gets or sets a list of model elements that the user has chosen to be excluded from the target database. (Inherited from SchemaDeploymentOptions.)
Public property ExcludedObjectTypesForSchemaCompare Gets a read-only copy of the types that are excluded from Schema Compare.
Public property ExtensionHandle Gets or sets the extension handle for this extension. (Inherited from SchemaDeploymentOptions.)
Public property GenerateDatabaseOptions Gets or sets a value that indicates whether the database options should be set in the update script.
Public property GenerateDeployStateChecks Gets or sets a value that indicates whether the update script should check the deployment state.
Public property IgnoreAnsiNulls Gets or sets a value that indicates whether the ANSI NULLS setting should be ignored when schemas are compared.
Public property IgnoreColumnCollation Gets or sets a value that indicates whether column collations should be ignored when schemas are compared.
Public property IgnoreColumnOrder Gets or sets a value that indicates whether the order of columns in tables and views should be ignored when schemas are compared.
Public property IgnoreComments Gets or sets a value that indicates whether the comments should be ignored when schemas are compared.
Public property IgnoreDmlTriggerOrder Gets or sets a value that indicates whether the order of data manipulation language (DML) triggers should be ignored when schemas are compared.
Public property IgnoreDmlTriggerState Gets or sets a value that indicates whether an enabled state of DML triggers should be ignored when schemas are compared.
Public property IgnoreExtendedProperties Gets or sets a value that indicates whether extended properties should be ignored when schemas are compared.
Public property IgnoreFilegroupPlacement Gets or sets a value that indicates whether the placement of objects in filegroups should be ignored when schemas are compared.
Public property IgnoreFillFactor Gets or sets a value that indicates whether the fill factor for indexes should be ignored when schemas are compared.
Public property IgnoreIdentitySeed Gets or sets a value that indicates whether identity seed values should be ignored when schemas are compared.
Public property IgnoreIncrement Gets or sets a value that indicates whether identity increment values should be ignored when schemas are compared.
Public property IgnoreIndexOptions Gets or sets a value that indicates whether index options should be ignored when schemas are compared.
Public property IgnoreIndexPadding Gets or sets a value that indicates whether index padding should be ignored when schemas are compared.
Public property IgnoreKeywordCasing
Public property IgnoreLockHintsOnIndexes Gets or sets a value that indicates whether lock hints on indexes should be ignored when schemas are compared.
Public property IgnoreLoginSids Gets or sets a value that indicates whether the login security identifiers (SIDs) should be ignored when schemas are compared.
Public property IgnoreNotForReplication Gets or sets a value that indicates whether the NOT FOR REPLICATION values should be ignored when schemas are compared.
Public property IgnorePartitionSchemes
Public property IgnorePermissions
Public property IgnoreQuotedIdentifiers Gets or sets a value that indicates whether the quoted identifiers setting should be ignored when schemas are compared.
Public property IgnoreRoleMembership Gets or sets a value that indicates whether role membership should be ignored when schemas are compared.
Public property IgnoreSemicolonBetweenStatements Gets or sets a value that indicates whether semicolons between statements should be ignored when schemas are compared.
Public property IgnoreStatisticsSample Gets or sets a value that indicates whether the statistics sample should be ignored when schemas are compared.
Public property IgnoreTableOptions Gets or sets a value that indicates whether table options should be ignored when schemas are compared.
Public property IgnoreUserSettingsObjects Gets or sets a value that indicates whether the user settings objects should be ignored when schemas are compared.
Public property IgnoreWhitespace Gets or sets a value that indicates whether whitespace should be ignored when schemas are compared.
Public property IgnoreWithNocheckOnCheckConstraints Gets or sets a value that indicates whether a WITH NOCHECK statement on check constraints should be ignored when schemas are compared.
Public property IgnoreWithNocheckOnForeignKeys
Public property IncludeTransactionalScripts Gets or sets a value that indicates whether the update script should be transacted where it is possible.
Public property ScriptDatabaseCollation
Public property SerializationData Gets the options that should be serialized. (Overrides SchemaDeploymentOptions.SerializationData.)
Public property SourceSetVariables Gets the list of variables and their values for the source of the comparison.
Public property TargetConnectionString Gets or sets the connection string for the target database. (Inherited from SchemaDeploymentOptions.)
Public property TargetDatabaseName Gets or sets the name of the target database. (Inherited from SchemaDeploymentOptions.)
Public property TargetSetVariables Gets the list of variables and their values for the target of the comparison.
Public property TreatVerificationErrorsAsWarnings Gets or sets a value that indicates whether to treat all verification errors as warnings. (Inherited from SchemaDeploymentOptions.)
Public property UnmodifiableObjectWarnings Gets or sets a value that indicates whether warnings should be generated for unmodifiable objects when deploying changes.
Public property VerifyDeployment Gets or sets a value that indicates whether to verify the deployment after it is completed. (Inherited from SchemaDeploymentOptions.)

Top

Methods

  Name Description
Public method AddExcludedObjectTypeForSchemaCompare Adds a new type to the list of types that are excluded from Schema Compare.
Public method CreateCopy Creates and returns a new copy of the SqlSchemaDeploymentOptions by using the settings in this. (Overrides SchemaDeploymentOptions.CreateCopy().)
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FlushExcludedObjectTypeForSchemaCompare Clears the list of types that are excluded from Schema Compare, and adds ISqlDynamicColumnSource to that list.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetPropertyClassesToExcludeFromComparison Gets a list of model property classes that should not be included in Schema Compare.
Protected method GetRelationshipClassesToExcludeFromComparison Gets a list of model relationship classes that will not be included in Schema Compare.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsObjectTypeExcludedForSchemaCompare Checks whether the given type is included in the list of objectTypes that are excluded from Schema Compare.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnExtensionHandle Returns the TSqlParser. (Overrides SchemaDeploymentOptions.OnExtensionHandle().)
Protected method OnInitialize Retrieves server paths and sets up the source and target variables for database name, data path, and log file path. (Overrides SchemaDeploymentOptions.OnInitialize().)
Public method SetExtensionHandle Sets the value of the ExtensionHandle property and calls the OnExtensionHandle method. (Inherited from SchemaDeploymentOptions.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method TryLoadSourceSqlCmdVariables Loads the SourceSqlCmdVariables from the specified variables file.
Public method TryLoadTargetSqlCmdVariables Loads the TargetSqlCmdVariables from the specified variables file.

Top

Fields

  Name Description
Protected fieldStatic member CurrentVersion The version number for the current release.
Protected fieldStatic member ExcludedTypeValueName The option name to exclude the type ("ExcludedType").
Protected fieldStatic member PlanGenerationType The option name for the plan generation type ("PlanGenerationType").
Protected fieldStatic member RosarioVersion The version number for the Visual Studio 2010 release.
Protected fieldStatic member VersionElementName The name of the version option ("Version").

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Data.Schema.Sql.Build Namespace