SchemaDeploymentOptions Class

Represents settings that are available to configure how a deployment plan is generated.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<DatabaseSchemaProviderCompatibilityAttribute(GetType(DatabaseSchemaProvider))> _
Public MustInherit Class SchemaDeploymentOptions _
    Implements IExtensionInformation, IExtension

[DatabaseSchemaProviderCompatibilityAttribute(typeof(DatabaseSchemaProvider))]
public abstract class SchemaDeploymentOptions : IExtensionInformation, 
    IExtension

[DatabaseSchemaProviderCompatibilityAttribute(typeof(DatabaseSchemaProvider))]
public ref class SchemaDeploymentOptions abstract : IExtensionInformation, 
    IExtension

[<AbstractClass>]
[<DatabaseSchemaProviderCompatibilityAttribute(typeof(DatabaseSchemaProvider))>]
type SchemaDeploymentOptions =  
    class
        interface IExtensionInformation
        interface IExtension
    end

public abstract class SchemaDeploymentOptions implements IExtensionInformation, IExtension

The SchemaDeploymentOptions type exposes the following members.

Constructors

	Name	Description
	SchemaDeploymentOptions	Initializes a new instance of the SchemaDeploymentOptions class.

Top

Properties

	Name	Description
	BuildtimeContributorsMustExist
	ComparerConfiguration	Gets the selected comparer configuration.
	CreateNewDatabase	Gets or sets a value that indicates whether to create a new target database during deployment.
	DropObjectsNotInSource	Gets or sets a value that indicates whether to drop any objects in the target database that are not in the source database.
	ExcludedModelElements	Gets or sets a list of model elements that the user has chosen to be excluded from the target database.
	ExtensionHandle	Gets or sets the extension handle for this extension.
	SerializationData	Gets or sets the XML serialized data for this object.
	TargetConnectionString	Gets or sets the connection string for the target database.
	TargetDatabaseName	Gets or sets the name of the target database.
	TreatVerificationErrorsAsWarnings	Gets or sets a value that indicates whether to treat all verification errors as warnings.
	VerifyDeployment	Gets or sets a value that indicates whether to verify the deployment after it is completed.

Top

Methods

	Name	Description
	CreateCopy	Returns a copy of these option settings.
	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.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnExtensionHandle	Called when the SetExtensionHandle method is invoked.
	OnInitialize	Called by the deployment settings window (such as Database.sqldeployment) in Visual Studio when this class is initialized.
	SetExtensionHandle	Sets the value of the ExtensionHandle property and calls the OnExtensionHandle method.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

A database schema provider will provide a customized subclass of this class that provides additional database-specific options. An instance of the appropriate options for the database schema provider is available from a property on the SchemaDeployment instance after it has been constructed.

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.Build Namespace

Other Resources

Extending the Database Features of Visual Studio