DeploymentContributorConfigurationStream Class

Represents a streamable version of a configuration file that is used by DacFx in the deployment and build processes. These streams enable deployment extensions to enhance and extend the design and deployment experience. Input configuration files can be defined in a .sqlproj file as part of the MSBuild process. The files are treated as streams, and will be passed to contributors via the EstablishDeploymentConfiguration(DeploymentContributorConfigurationSetup) method, where they can be copied as outputs that are stored in the generated dacpac. These streams will then be made available in the ApplyDeploymentConfiguration(DeploymentContributorContext, ICollectionDeploymentContributorConfigurationStream), where they can be consumed for configuration and data during deployment. At the end of the ApplyDeploymentConfiguration(DeploymentContributorContext, ICollectionDeploymentContributorConfigurationStream) method all streams will be disposed. Contributors that need to obtain data from the streams must read and cache the data during this method - attempts to read from the stream during the OnExecute(DeploymentPlanContributorContext) method will fail. Inside a .sqproj file, Deployment Configuration files are specified as follows:

<ItemGroup> <DeploymentExtensionConfiguration Include="MyContributorName.MyFileName1.sql" /> <DeploymentExtensionConfiguration Include="MyContributorName.MyFileName2.sql" /> </ItemGroup>

Note that configuration streams are accessible to all contributors. Contributors may employ a file naming pattern to identify which input files related to that contributor.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream

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

Syntax

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

public sealed class DeploymentContributorConfigurationStream

public ref class DeploymentContributorConfigurationStream sealed

[<SealedAttribute>]
type DeploymentContributorConfigurationStream =  class end

public final class DeploymentContributorConfigurationStream

The DeploymentContributorConfigurationStream type exposes the following members.

Constructors

	Name	Description
	DeploymentContributorConfigurationStream	Creates an instance of the DeploymentContributorConfigurationStream

Top

Properties

	Name	Description
	Filename	The filename used to represent this stream

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetStream	Gets the Stream
	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