Skip to content
Aspire
Docs Try Aspire
Docs Try

Install Aspire CLI

macOS

curl -sSL https://aspire.dev/install.sh | bash

Linux

curl -sSL https://aspire.dev/install.sh | bash

Windows

irm https://aspire.dev/install.ps1 | iex
More installation options

SqlProjectBuilderExtensions Methods

Class Methods 15 members
Provides extension methods for adding SQL Server Database Projects to the application.
AddSqlPackage(IDistributedApplicationBuilder, string) Section titled AddSqlPackage(IDistributedApplicationBuilder, string) extension IResourceBuilder<SqlPackageResource<TPackage>>
Adds a SQL Server Database Project resource to the application based on a referenced NuGet package. 
public static class SqlProjectBuilderExtensions
{
    public static IResourceBuilder<SqlPackageResource<TPackage>> AddSqlPackage<TPackage>(
        this IDistributedApplicationBuilder builder,
        string name)
    {
        // ...
    }
}
SqlProjectBuilderExtensions.cs#L72-L84
Parameters
builder IDistributedApplicationBuilder An Hosting.IDistributedApplicationBuilder instance to add the SQL Server Database project to.
name string Name of the resource.
Returns
IResourceBuilder<SqlPackageResource<TPackage>> Am ApplicationModel.IResourceBuilder`1 that can be used to further customize the resource.
AddSqlProject(IDistributedApplicationBuilder, string) Section titled AddSqlProject(IDistributedApplicationBuilder, string) extension IResourceBuilder<SqlProjectResource>
Adds a SQL Server Database Project resource to the application based on a referenced MSBuild.Sdk.SqlProj project. 
public static class SqlProjectBuilderExtensions
{
    public static IResourceBuilder<SqlProjectResource> AddSqlProject<TProject>(
        this IDistributedApplicationBuilder builder,
        string name)
    {
        // ...
    }
}
SqlProjectBuilderExtensions.cs
Parameters
builder IDistributedApplicationBuilder An Hosting.IDistributedApplicationBuilder instance to add the SQL Server Database project to.
name string Name of the resource.
Returns
IResourceBuilder<SqlProjectResource> An ApplicationModel.IResourceBuilder`1 that can be used to further customize the resource.
AddSqlProject(IDistributedApplicationBuilder, string) Section titled AddSqlProject(IDistributedApplicationBuilder, string) extension IResourceBuilder<SqlProjectResource>
Adds a SQL Server Database Project resource to the application. 
public static class SqlProjectBuilderExtensions
{
    public static IResourceBuilder<SqlProjectResource> AddSqlProject(
        this IDistributedApplicationBuilder builder,
        string name)
    {
        // ...
    }
}
SqlProjectBuilderExtensions.cs
Parameters
builder IDistributedApplicationBuilder An Hosting.IDistributedApplicationBuilder instance to add the SQL Server Database project to.
name string Name of the resource.
Returns
IResourceBuilder<SqlProjectResource> An ApplicationModel.IResourceBuilder`1 that can be used to further customize the resource.
WithConfigureDacDeployOptions(IResourceBuilder<SqlProjectResource>, Action<DacDeployOptions>) Section titled WithConfigureDacDeployOptions(IResourceBuilder<SqlProjectResource>, Action<DacDeployOptions>) extension IResourceBuilder<SqlProjectResource>
Adds a delegate annotation for configuring dacpac deployment options to the SqlProjectResource. 
public static class SqlProjectBuilderExtensions
{
    public static IResourceBuilder<SqlProjectResource> WithConfigureDacDeployOptions(
        this IResourceBuilder<SqlProjectResource> builder,
        Action<DacDeployOptions> configureDeploymentOptions)
    {
        // ...
    }
}
SqlProjectBuilderExtensions.cs
Parameters
builder IResourceBuilder<SqlProjectResource> An ApplicationModel.IResourceBuilder`1 representing the SQL Server Database project.
configureDeploymentOptions Action<DacDeployOptions> The delegate for configuring dacpac deployment options
Returns
IResourceBuilder<SqlProjectResource> An ApplicationModel.IResourceBuilder`1 that can be used to further customize the resource.
WithConfigureDacDeployOptions(IResourceBuilder<SqlPackageResource<TPackage>>, Action<DacDeployOptions>) Section titled WithConfigureDacDeployOptions(IResourceBuilder<SqlPackageResource<TPackage>>, Action<DacDeployOptions>) extension IResourceBuilder<SqlPackageResource<TPackage>>
Adds a delegate annotation for configuring dacpac deployment options to the SqlProjectResource. 
public static class SqlProjectBuilderExtensions
{
    public static IResourceBuilder<SqlPackageResource<TPackage>> WithConfigureDacDeployOptions<TPackage>(
        this IResourceBuilder<SqlPackageResource<TPackage>> builder,
        Action<DacDeployOptions> configureDeploymentOptions)
    {
        // ...
    }
}
SqlProjectBuilderExtensions.cs
Parameters
builder IResourceBuilder<SqlPackageResource<TPackage>> An ApplicationModel.IResourceBuilder`1 representing the SQL Server Database project.
configureDeploymentOptions Action<DacDeployOptions> The delegate for configuring dacpac deployment options
Returns
IResourceBuilder<SqlPackageResource<TPackage>> An ApplicationModel.IResourceBuilder`1 that can be used to further customize the resource.
WithDacDeployOptions(IResourceBuilder<SqlProjectResource>, string) Section titled WithDacDeployOptions(IResourceBuilder<SqlProjectResource>, string) extension IResourceBuilder<SqlProjectResource>
Adds a path to a publish profile for configuring dacpac deployment options to the SqlProjectResource. 
public static class SqlProjectBuilderExtensions
{
    public static IResourceBuilder<SqlProjectResource> WithDacDeployOptions(
        this IResourceBuilder<SqlProjectResource> builder,
        string optionsPath)
    {
        // ...
    }
}
SqlProjectBuilderExtensions.cs
Parameters
builder IResourceBuilder<SqlProjectResource> An ApplicationModel.IResourceBuilder`1 representing the SQL Server Database project.
optionsPath string Path to the publish profile xml file
Returns
IResourceBuilder<SqlProjectResource> An ApplicationModel.IResourceBuilder`1 that can be used to further customize the resource.
WithDacDeployOptions(IResourceBuilder<SqlPackageResource<TPackage>>, string) Section titled WithDacDeployOptions(IResourceBuilder<SqlPackageResource<TPackage>>, string) extension IResourceBuilder<SqlPackageResource<TPackage>>
Adds a path to a publish profile for configuring dacpac deployment options to the SqlProjectResource. 
public static class SqlProjectBuilderExtensions
{
    public static IResourceBuilder<SqlPackageResource<TPackage>> WithDacDeployOptions<TPackage>(
        this IResourceBuilder<SqlPackageResource<TPackage>> builder,
        string optionsPath)
    {
        // ...
    }
}
SqlProjectBuilderExtensions.cs
Parameters
builder IResourceBuilder<SqlPackageResource<TPackage>> An ApplicationModel.IResourceBuilder`1 representing the SQL Server Database project.
optionsPath string Path to the publish profile xml file
Returns
IResourceBuilder<SqlPackageResource<TPackage>> An ApplicationModel.IResourceBuilder`1 that can be used to further customize the resource.
WithDacpac(IResourceBuilder<SqlProjectResource>, string) Section titled WithDacpac(IResourceBuilder<SqlProjectResource>, string) extension IResourceBuilder<SqlProjectResource>
Specifies the path to the .dacpac file. 
public static class SqlProjectBuilderExtensions
{
    public static IResourceBuilder<SqlProjectResource> WithDacpac(
        this IResourceBuilder<SqlProjectResource> builder,
        string dacpacPath)
    {
        // ...
    }
}
SqlProjectBuilderExtensions.cs
Parameters
builder IResourceBuilder<SqlProjectResource> An ApplicationModel.IResourceBuilder`1 representing the SQL Server Database project.
dacpacPath string Path to the .dacpac file.
Returns
IResourceBuilder<SqlProjectResource> An ApplicationModel.IResourceBuilder`1 that can be used to further customize the resource.
WithDacpac(IResourceBuilder<SqlPackageResource<TPackage>>, string) Section titled WithDacpac(IResourceBuilder<SqlPackageResource<TPackage>>, string) extension IResourceBuilder<SqlPackageResource<TPackage>>
Specifies the path to the .dacpac file. 
public static class SqlProjectBuilderExtensions
{
    public static IResourceBuilder<SqlPackageResource<TPackage>> WithDacpac<TPackage>(
        this IResourceBuilder<SqlPackageResource<TPackage>> builder,
        string dacpacPath)
    {
        // ...
    }
}
SqlProjectBuilderExtensions.cs
Parameters
builder IResourceBuilder<SqlPackageResource<TPackage>> An ApplicationModel.IResourceBuilder`1 representing the SQL Server Database project.
dacpacPath string Path to the .dacpac file.
Returns
IResourceBuilder<SqlPackageResource<TPackage>> An ApplicationModel.IResourceBuilder`1 that can be used to further customize the resource.
WithReference(IResourceBuilder<SqlProjectResource>, IResourceBuilder<SqlServerDatabaseResource>) Section titled WithReference(IResourceBuilder<SqlProjectResource>, IResourceBuilder<SqlServerDatabaseResource>) extension IResourceBuilder<SqlProjectResource>
Publishes the SQL Server Database project to the target ApplicationModel.SqlServerDatabaseResource. 
public static class SqlProjectBuilderExtensions
{
    public static IResourceBuilder<SqlProjectResource> WithReference(
        this IResourceBuilder<SqlProjectResource> builder,
        IResourceBuilder<SqlServerDatabaseResource> target)
    {
        // ...
    }
}
SqlProjectBuilderExtensions.cs
Parameters
builder IResourceBuilder<SqlProjectResource> An ApplicationModel.IResourceBuilder`1 representing the SQL Server Database project to publish.
target IResourceBuilder<SqlServerDatabaseResource> An ApplicationModel.IResourceBuilder`1 representing the target ApplicationModel.SqlServerDatabaseResource to publish the SQL Server Database project to.
Returns
IResourceBuilder<SqlProjectResource> An ApplicationModel.IResourceBuilder`1 that can be used to further customize the resource.
WithReference(IResourceBuilder<SqlProjectResource>, IResourceBuilder<IResourceWithConnectionString>) Section titled WithReference(IResourceBuilder<SqlProjectResource>, IResourceBuilder<IResourceWithConnectionString>) extension IResourceBuilder<SqlProjectResource>
Publishes the SQL Server Database project to the target ApplicationModel.IResourceWithConnectionString. 
public static class SqlProjectBuilderExtensions
{
    public static IResourceBuilder<SqlProjectResource> WithReference(
        this IResourceBuilder<SqlProjectResource> builder,
        IResourceBuilder<IResourceWithConnectionString> target)
    {
        // ...
    }
}
SqlProjectBuilderExtensions.cs
Parameters
builder IResourceBuilder<SqlProjectResource> An ApplicationModel.IResourceBuilder`1 representing the SQL Server Database project to publish.
target IResourceBuilder<IResourceWithConnectionString> An ApplicationModel.IResourceBuilder`1 representing the target ApplicationModel.IResourceWithConnectionString to publish the SQL Server Database project to.
Returns
IResourceBuilder<SqlProjectResource> An ApplicationModel.IResourceBuilder`1 that can be used to further customize the resource.
WithReference(IResourceBuilder<SqlPackageResource<TPackage>>, IResourceBuilder<SqlServerDatabaseResource>) Section titled WithReference(IResourceBuilder<SqlPackageResource<TPackage>>, IResourceBuilder<SqlServerDatabaseResource>) extension IResourceBuilder<SqlPackageResource<TPackage>>
Publishes the SQL Server Database project to the target ApplicationModel.SqlServerDatabaseResource. 
public static class SqlProjectBuilderExtensions
{
    public static IResourceBuilder<SqlPackageResource<TPackage>> WithReference<TPackage>(
        this IResourceBuilder<SqlPackageResource<TPackage>> builder,
        IResourceBuilder<SqlServerDatabaseResource> target)
    {
        // ...
    }
}
SqlProjectBuilderExtensions.cs
Parameters
builder IResourceBuilder<SqlPackageResource<TPackage>> An ApplicationModel.IResourceBuilder`1 representing the SQL Server Database project to publish.
target IResourceBuilder<SqlServerDatabaseResource> An ApplicationModel.IResourceBuilder`1 representing the target ApplicationModel.SqlServerDatabaseResource to publish the SQL Server Database project to.
Returns
IResourceBuilder<SqlPackageResource<TPackage>> An ApplicationModel.IResourceBuilder`1 that can be used to further customize the resource.
WithReference(IResourceBuilder<SqlPackageResource<TPackage>>, IResourceBuilder<IResourceWithConnectionString>) Section titled WithReference(IResourceBuilder<SqlPackageResource<TPackage>>, IResourceBuilder<IResourceWithConnectionString>) extension IResourceBuilder<SqlPackageResource<TPackage>>
Publishes the SQL Server Database project to the target ApplicationModel.IResourceWithConnectionString. 
public static class SqlProjectBuilderExtensions
{
    public static IResourceBuilder<SqlPackageResource<TPackage>> WithReference<TPackage>(
        this IResourceBuilder<SqlPackageResource<TPackage>> builder,
        IResourceBuilder<IResourceWithConnectionString> target)
    {
        // ...
    }
}
SqlProjectBuilderExtensions.cs
Parameters
builder IResourceBuilder<SqlPackageResource<TPackage>> An ApplicationModel.IResourceBuilder`1 representing the SQL Server Database project to publish.
target IResourceBuilder<IResourceWithConnectionString> An ApplicationModel.IResourceBuilder`1 representing the target ApplicationModel.IResourceWithConnectionString to publish the SQL Server Database project to.
Returns
IResourceBuilder<SqlPackageResource<TPackage>> An ApplicationModel.IResourceBuilder`1 that can be used to further customize the resource.
WithSkipWhenDeployed(IResourceBuilder<SqlProjectResource>) Section titled WithSkipWhenDeployed(IResourceBuilder<SqlProjectResource>) extension IResourceBuilder<SqlProjectResource>
Specifies that .dacpac deployment should be skipped if metadata in the target database indicates that the .dacpac has already been deployed in its current state. 
public static class SqlProjectBuilderExtensions
{
    public static IResourceBuilder<SqlProjectResource> WithSkipWhenDeployed(
        this IResourceBuilder<SqlProjectResource> builder)
    {
        // ...
    }
}
SqlProjectBuilderExtensions.cs
Parameters
builder IResourceBuilder<SqlProjectResource> An ApplicationModel.IResourceBuilder`1 representing the SQL Server Database project.
Returns
IResourceBuilder<SqlProjectResource> An ApplicationModel.IResourceBuilder`1 that can be used to further customize the resource.
WithSkipWhenDeployed(IResourceBuilder<SqlPackageResource<TPackage>>) Section titled WithSkipWhenDeployed(IResourceBuilder<SqlPackageResource<TPackage>>) extension IResourceBuilder<SqlPackageResource<TPackage>>
Specifies that .dacpac deployment should be skipped if metadata in the target database indicates that the .dacpac has already been deployed in its current state. 
public static class SqlProjectBuilderExtensions
{
    public static IResourceBuilder<SqlPackageResource<TPackage>> WithSkipWhenDeployed<TPackage>(
        this IResourceBuilder<SqlPackageResource<TPackage>> builder)
    {
        // ...
    }
}
SqlProjectBuilderExtensions.cs
Parameters
builder IResourceBuilder<SqlPackageResource<TPackage>> An ApplicationModel.IResourceBuilder`1 representing the SQL Server Database project.
Returns
IResourceBuilder<SqlPackageResource<TPackage>> An ApplicationModel.IResourceBuilder`1 that can be used to further customize the resource.
Connect with us

Community

SHA — 037d613 © Microsoft