Microsoft.Data.Schema.Build Namespace

  • Article

The Microsoft.Data.Schema.Build namespace provides interfaces and classes to support the Build feature.

Classes

  Class Description
Public class AgnosticProjectProperties This class and its members are reserved for internal use and are not intended to be used in your code. Provides static properties of projects in Visual Studio that are not dependent on any specific DatabaseSchemaProvider.
Public class AgnosticProjectProperties.Project This class and its members are reserved for internal use and are not intended to be used in your code. Provides the static project properties that are used by the user interface of Visual Studio, that are part of the AgnosticProjectProperties class. These properties are not dependent on any specific DatabaseSchemaProvider.
Public class AgnosticProjectProperties.Project.Sandbox This class and its members are reserved for internal use and are not intended to be used in your code. Provides the static project sandbox properties that are used by the user interface of Visual Studio and that are part of the AgnosticProjectProperties class. These properties are not dependent on any specific DatabaseSchemaProvider.
Public class AgnosticProjectProperties.PropertyTypeValue This class and its members are reserved for internal use and are not intended to be used in your code. Provides the static type value properties that are used by the user interface of Visual Studio that are part of the AgnosticProjectProperties class. These properties are not dependent on any specific DatabaseSchemaProvider.
Public class AgnosticProjectProperties.Versions This class and its members are reserved for internal use and are not intended to be used in your code. Provides the static version properties that are used by the user interface of Visual Studio that are part of the AgnosticProjectProperties class. These properties are not dependent on any specific DatabaseSchemaProvider.
Public class AlterElementStep Represents a step in a deployment plan that alters an element.
Public class BeginPostDeploymentScriptStep Marks the beginning of the post-deployment script steps.
Public class BeginPreDeploymentScriptStep Represents a marker step that separates the script steps that precede deployment from the deployment script steps.
Public class BuildContributor Derivatives of the BuildContributor extension are executed during a project build after the project's model has been constructed and verified.
Public class BuildContributorContext Provides the context for the build process that is used by BuildContributor objects in Visual Studio.
Public class CatalogOrServerPropertyItem This class and its members are reserved for internal use and are not intended to be used in your code. Used to set and save property files in batch mode.
Public class ContributorArgumentConfiguration Created by BuildContributor and DeploymentContributor objects at design time to initialize arguments that were created at design time and stored in the project file.
Public class CreateElementStep Represents a step in a deployment plan that creates an element.
Public class DatabaseTaskHost This class and its members are reserved for internal use and are not intended to be used in your code. Represents the database task host.
Public class DatabaseTaskHost.AsyncModelBuildingBlocker This class and its members are reserved for internal use and are not intended to be used in your code. Used to stop the background model building process until the Dispose method of this object is called.
Public class DatabaseTaskHostConstructor This class and its members are reserved for internal use and are not intended to be used in your code. Used to construct the DatabaseTaskHost and to specify how it should behave.
Public class DatabaseTaskItem Infrastructure. Represents a single item in a Visual Studio database build project.
Public class DeploymentContributor The base class for deployment contributors.
Public class DeploymentContributorConfigurationFile Represents a configuration file that is used by Visual Studio in the deployment and build processes. These files enable deployment extensions to enhance and extend the design and deployment experience by enabling contributors to copy project files to the output directory during a build and then consume those files for configuration and data during deployment.
Public class DeploymentContributorConfigurationSetup Represents the current setup for DeploymentContributor objects. The setup object can be used by deployment contributors during build operations to cause files to be copied to the output directory or to create new files in the output directory.
Public class DeploymentContributorContext Provides a context for DeploymentContributor objects in Visual Studio.
Public class DeploymentContributorEventArgs Represents the event arguments for deployment contributor events.
Public class DeploymentFailedException Represents the deployment failed exception.
Public class DeploymentPlan Represents the plan that is generated by the DeploymentPlanGenerator.
Public class DeploymentPlanArtifact An implementation detail specific to a custom DatabaseSchemaProvider.
Public class DeploymentPlanContributor Represents a contributor to the deployment process in Visual Studio Application Lifecycle Management (ALM).
Public class DeploymentPlanContributorContext Provides a context for DeploymentPlanContributor objects.
Public class DeploymentPlanExecutor Infrastructure.
Public class DeploymentPlanGenerator When implemented in a derived class by a database schema provider (DSP) vendor, generates a deployment plan that is based on a model.
Public class DeploymentPlanHandle Infrastructure. Used by Visual Studio to identify the plan.
Public class DeploymentPlanModifier Represents a contributor that modifies a deployment plan.
Public class DeploymentPlanProblem Represents a problem that was discovered when the deployment plan was verified.
Public class DeploymentProjectBuilder 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.
Public class DeploymentScriptDomStep Represents a deployment step that consists of an Abstract Syntax Tree (AST) and reference to a script Domain Object Model (DOM) generator.
Public class DeploymentScriptGenerator Represents the base implementation of a deployment script generator. By default, this implementation is used during deployment to generate a deployment script from a deployment plan.
Public class DeploymentScriptStep Represents a step in the deployment plan that contains script as a string (instead of an Abstract Syntax Tree (AST)).
Public class DeploymentStep Represents a step in a deployment plan.
Public class DropElementStep Represents a step in a deployment plan that drops an element.
Public class EndPostDeploymentScriptStep Represents an empty step that marks the end of the post-deployment scripts.
Public class EndPreDeploymentScriptStep Represents an empty step that marks the end of the pre-deployment scripts.
Public class ModelBuildingCompletedEventArgs This class and its members are reserved for internal use and are not intended to be used in your code. Represents errors that come from model building.
Public class PropertyValidatorBool This class and its members are reserved for internal use and are not intended to be used in your code. Validates a Boolean value.
Public class PropertyValidatorFloat This class and its members are reserved for internal use and are not intended to be used in your code. Validates a floating point value.
Public class PropertyValidatorInt This class and its members are reserved for internal use and are not intended to be used in your code. Validates an integer value.
Public class PropertyValidatorList This class and its members are reserved for internal use and are not intended to be used in your code. Validates whether a value is equal to a value in a provided list.
Public class SchemaDeployment Represents the database schema deployment engine.
Public class SchemaDeploymentConstructor Used by Visual Studio to create a SchemaDeployment object.
Public class SchemaDeploymentOptions Represents settings that are available to configure how a deployment plan is generated.
Public class TargetModelModifier This class and its members are reserved for internal use and are not intended to be used in your code. Represents a target model modifier.
Public class TargetModelOperation This class and its members are reserved for internal use and are not intended to be used in your code. Represents a target model operation.
Public class TaskHostSerializationContext This class and its members are reserved for internal use and are not intended to be used in your code. Represents a task host serialization context.
Public class VSDBCmdServices This class and its members are reserved for internal use and are not intended to be used in your code. Represents VSDBCmd services.

Interfaces

  Interface Description
Public interface IPropertyValidator This class and its members are reserved for internal use and are not intended to be used in your code. Classes implement this interface to indicate that they can validate project properties.
Public interface ISchemaDeploymentController Provides functionality to run the deployment engine multiple times to generate and execute scripts for each of any number of deployment configurations.

Enumerations

  Enumeration Description
Public enumeration DatabaseTaskHost.LoggingBehavior This class and its members are reserved for internal use and are not intended to be used in your code. Specifies the logging behavior.
Public enumeration DatabaseTaskHost.ModelOptimization This class and its members are reserved for internal use and are not intended to be used in your code. Specifies model optimization.
Public enumeration DatabaseTaskHost.PropertySource This class and its members are reserved for internal use and are not intended to be used in your code. Specifies the property source.
Public enumeration DeploymentPlanProblem.ProblemCategory Represents the possible categories for a DeploymentPlanProblem.