SqlServerBuilderExtensions Methods

AddDatabase(IResourceBuilder<SqlServerServerResource>, string, string?)extensionIResourceBuilder<SqlServerDatabaseResource>

Adds a SQL Server database to the application model. This is a child resource of a SqlServerServerResource.

public static class SqlServerBuilderExtensions
{
    public static IResourceBuilder<SqlServerDatabaseResource> AddDatabase(
        this IResourceBuilder<SqlServerServerResource> builder,
        string name,
        string? databaseName = null)
    {
        // ...
    }
}

SqlServerBuilderExtensions.cs#L121-L147

Parameters

builderIResourceBuilder<SqlServerServerResource>The SQL Server resource builders.

namestringThe name of the resource. This name will be used as the connection string name when referenced in a dependency.

databaseNamestring?optionalThe name of the database. If not provided, this defaults to the same value as name.

Returns

IResourceBuilder<SqlServerDatabaseResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

When adding a SqlServerDatabaseResource to your application model the resource can then be referenced by other resources using the resource name. When the dependent resource is using the extension method ResourceBuilderExtensions.WaitFor then the dependent resource will wait until the SQL Server database is available.

Note that calling SqlServerBuilderExtensions.AddDatabase will result in the database being created on the SQL Server when the server becomes ready. The database creation happens automatically as part of the resource lifecycle.

AddSqlServer(IDistributedApplicationBuilder, string, IResourceBuilder<ParameterResource>, int?)extensionIResourceBuilder<SqlServerServerResource>

Adds a SQL Server resource to the application model. A container is used for local development.

public static class SqlServerBuilderExtensions
{
    public static IResourceBuilder<SqlServerServerResource> AddSqlServer(
        this IDistributedApplicationBuilder builder,
        string name,
        IResourceBuilder<ParameterResource>? password = null,
        int? port = null)
    {
        // ...
    }
}

SqlServerBuilderExtensions.cs#L40-L92

Parameters

builderIDistributedApplicationBuilderThe Hosting.IDistributedApplicationBuilder.

namestringThe name of the resource. This name will be used as the connection string name when referenced in a dependency.

passwordIResourceBuilder<ParameterResource>optionalThe parameter used to provide the administrator password for the SQL Server resource. If null a random password will be generated.

portint?optionalThe host port for the SQL Server.

Returns

IResourceBuilder<SqlServerServerResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This version of the package defaults to the tag of the / container image.

WithCreationScript(IResourceBuilder<SqlServerDatabaseResource>, string)extensionIResourceBuilder<SqlServerDatabaseResource>

Defines the SQL script used to create the database.

public static class SqlServerBuilderExtensions
{
    public static IResourceBuilder<SqlServerDatabaseResource> WithCreationScript(
        this IResourceBuilder<SqlServerDatabaseResource> builder,
        string script)
    {
        // ...
    }
}

SqlServerBuilderExtensions.cs#L218-L223

Parameters

builderIResourceBuilder<SqlServerDatabaseResource>The builder for the SqlServerDatabaseResource.

scriptstringThe SQL script used to create the database.

Returns

IResourceBuilder<SqlServerDatabaseResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

Default script is

IF (
    NOT EXISTS (
        SELECT 1 FROM sys.databases WHERE name = @DatabaseName ) ) CREATE DATABASE [<QUOTED_DATABASE_NAME%gt;];

WithDataBindMount(IResourceBuilder<SqlServerServerResource>, string, bool)extensionIResourceBuilder<SqlServerServerResource>

Adds a bind mount for the data folder to a SQL Server resource.

public static class SqlServerBuilderExtensions
{
    public static IResourceBuilder<SqlServerServerResource> WithDataBindMount(
        this IResourceBuilder<SqlServerServerResource> builder,
        string source,
        bool isReadOnly = false)
    {
        // ...
    }
}

SqlServerBuilderExtensions.cs#L181-L201

Parameters

builderIResourceBuilder<SqlServerServerResource>The resource builder.

sourcestringThe source directory on the host to mount into the container.

isReadOnlybooloptionalA flag that indicates if this is a read-only mount.

Returns

IResourceBuilder<SqlServerServerResource>The ApplicationModel.IResourceBuilder`1.

Remarks

The container starts up as non-root and the source directory must be readable by the user that the container runs as. https://learn.microsoft.com/sql/linux/sql-server-linux-docker-container-configure?view=sql-server-ver16&pivots=cs1-bash#mount-a-host-directory-as-data-volume

WithDataVolume(IResourceBuilder<SqlServerServerResource>, string?, bool)extensionIResourceBuilder<SqlServerServerResource>

Adds a named volume for the data folder to a SQL Server resource.

public static class SqlServerBuilderExtensions
{
    public static IResourceBuilder<SqlServerServerResource> WithDataVolume(
        this IResourceBuilder<SqlServerServerResource> builder,
        string? name = null,
        bool isReadOnly = false)
    {
        // ...
    }
}

SqlServerBuilderExtensions.cs#L161-L163

Parameters

builderIResourceBuilder<SqlServerServerResource>The resource builder.

namestring?optionalThe name of the volume. Defaults to an auto-generated name based on the application and resource names.

isReadOnlybooloptionalA flag that indicates if this is a read-only volume.

Returns

IResourceBuilder<SqlServerServerResource>The ApplicationModel.IResourceBuilder`1.

WithHostPort(IResourceBuilder<SqlServerServerResource>, int?)extensionIResourceBuilder<SqlServerServerResource>

Configures the host port that the SqlServer resource is exposed on instead of using randomly assigned port.

public static class SqlServerBuilderExtensions
{
    public static IResourceBuilder<SqlServerServerResource> WithHostPort(
        this IResourceBuilder<SqlServerServerResource> builder,
        int? port)
    {
        // ...
    }
}

SqlServerBuilderExtensions.cs#L253-L257

Parameters

builderIResourceBuilder<SqlServerServerResource>The resource builder.

portint?The port to bind on the host. If null is used random port will be assigned.

Returns

IResourceBuilder<SqlServerServerResource>The ApplicationModel.IResourceBuilder`1.

WithPassword(IResourceBuilder<SqlServerServerResource>, IResourceBuilder<ParameterResource>)extensionIResourceBuilder<SqlServerServerResource>

Configures the password that the SqlServer resource is used.

public static class SqlServerBuilderExtensions
{
    public static IResourceBuilder<SqlServerServerResource> WithPassword(
        this IResourceBuilder<SqlServerServerResource> builder,
        IResourceBuilder<ParameterResource> password)
    {
        // ...
    }
}

SqlServerBuilderExtensions.cs#L236-L240

Parameters

builderIResourceBuilder<SqlServerServerResource>The resource builder.

passwordIResourceBuilder<ParameterResource>The parameter used to provide the password for the SqlServer resource.

Returns

IResourceBuilder<SqlServerServerResource>The ApplicationModel.IResourceBuilder`1.