DeploymentContributorConfigurationStream Class

Definition

Namespace:

Microsoft.SqlServer.Dac.Deployment

Assembly:

Microsoft.SqlServer.Dac.Extensions.dll

Package:

Microsoft.SqlServer.DacFx v162.2.111

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 Microsoft.SqlServer.Dac.Deployment.DeploymentContributor.EstablishDeploymentConfiguration(Microsoft.SqlServer.Dac.Deployment.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 Microsoft.SqlServer.Dac.Deployment.DeploymentContributor.ApplyDeploymentConfiguration(Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext,System.Collections.Generic.ICollection{Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream}), where they can be consumed for configuration and data during deployment. At the end of the Microsoft.SqlServer.Dac.Deployment.DeploymentContributor.ApplyDeploymentConfiguration(Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext,System.Collections.Generic.ICollection{Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream}) 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.

public sealed class DeploymentContributorConfigurationStream

type DeploymentContributorConfigurationStream = class

Public NotInheritable Class DeploymentContributorConfigurationStream

Inheritance

Object

DeploymentContributorConfigurationStream

Constructors

DeploymentContributorConfigurationStream(String)

Creates an instance of the DeploymentContributorConfigurationStream

Properties

Filename

The filename used to represent this stream

Methods

GetStream()

Gets the Stream