SqlSchemaDeploymentOptions Class

Article
11/05/2012

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
	SqlSchemaDeploymentOptions	Initializes a new instance of the SqlSchemaDeploymentOptions class.

Top

Properties

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

Top

Methods

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

Top

Fields

	Name	Description
	CurrentVersion	The version number for the current release.
	ExcludedTypeValueName	The option name to exclude the type ("ExcludedType").
	PlanGenerationType	The option name for the plan generation type ("PlanGenerationType").
	RosarioVersion	The version number for the Visual Studio 2010 release.
	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.

Share via