BuildContributorContext Class

Provides the context for the build process that is used by BuildContributor objects during project build. See documentation for the Arguments and ExtensionFiles properties for information on how to specify these inside a project file.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dac.Deployment.BuildContributorContext

Namespace:  Microsoft.SqlServer.Dac.Deployment
Assembly:  Microsoft.SqlServer.Dac.Extensions (in Microsoft.SqlServer.Dac.Extensions.dll)

Syntax

'Declaration
Public NotInheritable Class BuildContributorContext
'Usage
Dim instance As BuildContributorContext

public sealed class BuildContributorContext

public ref class BuildContributorContext sealed

[<SealedAttribute>]
type BuildContributorContext =  class end

public final class BuildContributorContext

The BuildContributorContext type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Arguments	Gets a dictionary of command-line arguments and their values. When building in SSDT, arguments are available when found in a .sqlproj file or a referenced .targets file. For instance to add a "RunMyContributor" argument with a value of "true", the following would be added: <PropertyGroup> <ContributorArguments Condition="'$(Configuration)' == 'Debug''"> $(ContributorArguments);RunMyContributor=True; </ContributorArguments> </PropertyGroup>In this case the argument is only added for Debug configuration. Using the above configuration it is possible to collect information from the MSBuild environment and pass it to the contributor.
	BuildProperties	Gets a dictionary of named properties and their values
	ExtensionFiles	Gets an array of ITaskItem representing Files from the project system which influence the build contributors. Input configuration files can be defined in a .sqlproj file as part of the MSBuild process. Inside a .sqproj file, Build Configuration files are specified as follows: <ItemGroup> <BuildExtensionConfiguration Include="MyContributorName.MyFileName1.sql" /> <BuildExtensionConfiguration Include="MyContributorName.MyFileName2.sql" /> </ItemGroup.>Note that configuration files are accessible to all contributors. Contributors may employ a file naming pattern to identify which input files related to that contributor.
	Model	Gets the TSqlModel of the project

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	ToString	(Inherited from Object.)

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.SqlServer.Dac.Deployment Namespace