Share via

ContributorArgumentConfiguration Class

  • Reference

Definition

Namespace:
Microsoft.SqlServer.Dac.Deployment
Assembly:
Microsoft.SqlServer.Dac.Extensions.dll
Package:
Microsoft.SqlServer.DacFx.x64 v140.3881.1
Package:
Microsoft.SqlServer.DacFx v150.5282.3
Package:
Microsoft.SqlServer.DacFx v160.6161.0
Package:
Microsoft.SqlServer.DacFx v162.2.111
Package:
Microsoft.Data.Tools.Msbuild v10.0.61804.210

Instances of this class are created by Build and Deployment contributors during design-time to initialize arguments that are passed to them at runtime.

In SSDT, these arguments must be specified using a ContributorArguments property 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.

It is also possible to specify these when creating a package by using BuildPackage(String, TSqlModel, PackageMetadata, PackageOptions) and specifying PackageOptions.

public sealed class ContributorArgumentConfiguration
type ContributorArgumentConfiguration = class
Public NotInheritable Class ContributorArgumentConfiguration
Inheritance
Object
ContributorArgumentConfiguration

Constructors

ContributorArgumentConfiguration()

Initializes a new instance of the ContributorArgumentConfiguration class.
ContributorArgumentConfiguration(String, String)

Initializes a new instance of the ContributorArgumentConfiguration class.

Properties

Name

Gets or sets the name of the argument.
Value

Gets or sets the value of the argument expressed as a string.

Applies to