Share via


DeploymentProjectBuilder Class

This class is loaded at build time to create the artifacts that are needed at deployment time. This includes the stub MSBuild project that is used to execute the deploy task and the deployment configuration file.

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.Build.DeploymentProjectBuilder

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

Syntax

'Declaration
Public Class DeploymentProjectBuilder
public class DeploymentProjectBuilder
public ref class DeploymentProjectBuilder
type DeploymentProjectBuilder =  class end
public class DeploymentProjectBuilder

The DeploymentProjectBuilder type exposes the following members.

Constructors

  Name Description
Public method DeploymentProjectBuilder Initializes a new instance of the DeploymentProjectBuilder class.

Top

Properties

  Name Description
Protected property ConnectionString Gets or sets the connection string.
Protected property DatabaseName Gets or sets the database name.
Protected property DeployManifestName Gets or sets the deployment manifest name.
Protected property DeploymentScriptFile Gets or sets the deployment script file.
Protected property DeployToDatabase Gets or sets a value indicating whether to deploy to the target database.
Protected property DeployToScript Gets or sets a value indicating whether to deploy to a script file.
Protected property Extensions Gets or sets the extension manager for this deployment.
Protected property FilesOutput Gets a list of output files.
Public property InputContributorFiles Gets a list of input contributor files.
Protected property OutputDirectory Gets or sets the output directory for the deployment.
Protected property OverwriteExistingFiles Gets or sets a value indicating whether deployment should overwrite existing files in the output directory.
Protected property Properties Gets or sets the list of properties associated with this deployment project.
Public property PropertiesFiles Gets a list of properties files.
Protected property References Gets or sets the list of references associated with this deployment project.
Protected property Renames Gets or sets the list of file renames that occur during deployment.
Protected property SelectedDeploymentConfigFile Gets or sets the deployment configuration file to use for this deployment project.
Protected property SourceModelFilePath Gets or sets the file path for the source model.

Top

Methods

  Name Description
Protected methodStatic member AddProperty Adds the specified property.
Protected methodStatic member CopyFile Copies the specified file to the target name and directory.
Protected method CopyFileToOutput Copies a file to output.
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 GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method GetUniqueFile Generates a unique filename in the output directory.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnCreateDeploymentProject Called when the deployment project is created.
Protected method OnLoadTargetModelModifiers Override this method if your database schema provider implementation needs to perform additional modifications to the target model.
Protected method OnVerifyConfiguration Returns null.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

  Name Description
Protected fieldStatic member DeploymentConfigurationFileProperty The property that contains the deployment configuration file.
Protected fieldStatic member DeployScriptFileProperty The property that contains the deployment script file name.
Protected fieldStatic member DeployToDatabaseProperty The property that indicates whether deployment will deploy to the target database.
Protected fieldStatic member DeployToScriptProperty The property that indicates whether the deployment action will only generate a deployment script but not deploy to a target database.
Protected fieldStatic member ExtensionConfigurationItemName Used to provide extension configuration files to the MSBuild project.
Protected fieldStatic member ReferenceItemName Used to add references to the MSBuild project.
Protected fieldStatic member SourceModelProperty Used to add the source model filename to the MSBuild project.
Protected fieldStatic member TargetConnectionStringProperty Used to add the target connection string to the MSBuild project.
Protected fieldStatic member TargetDatabaseNameProperty Used to add the target database name to the MSBuild project.

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