DeploymentContributorConfigurationStream Class
TOC
Collapse the table of content
Expand the table of content

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 OnEstablishDeploymentConfiguration method, where they can be copied as outputs that are stored in the generated dacpac. These streams will then be made available in the OnApplyDeploymentConfiguration, where they can be consumed for configuration and data during deployment. At the end of the OnApplyDeploymentConfiguration 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 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.

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

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

[<Sealed>]
type DeploymentContributorConfigurationStream = class end

NameDescription
System_CAPS_pubmethodDeploymentContributorConfigurationStream(String)

Creates an instance of the DeploymentContributorConfigurationStream

NameDescription
System_CAPS_pubpropertyFilename

The filename used to represent this stream

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetStream()

Gets the Stream

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top

Community Additions

ADD
Show:
© 2016 Microsoft