Microsoft SQL Server

This connector simplifies accessing Microsoft SQL Server databases. It supports the following .NET drivers:

• Microsoft.Data.SqlClient, which provides an ADO.NET DbConnection.
• System.Data.SqlClient, which provides an ADO.NET DbConnection.
• Microsoft.EntityFrameworkCore.SqlServer, which provides Entity Framework Core support.

The remainder of this page assumes you're familiar with the basic concepts of Steeltoe Connectors.

Usage

To use this connector:

1. Create a SQL Server instance or use SQL Server Express LocalDB.
2. Add NuGet references to your project.
3. Configure your connection string in appsettings.json.
4. Initialize the Steeltoe Connector at startup.
5. Use the driver-specific connection/client instance.

Add NuGet References

To use this connector, add a NuGet reference to Steeltoe.Connectors. If you're using Entity Framework Core, add a NuGet reference to Steeltoe.Connectors.EntityFrameworkCore instead.

Also add a NuGet reference to one of the .NET drivers listed above, as you would if you were not using Steeltoe.

Configure connection string

The available connection string parameters for SQL Server are documented here.

The following example appsettings.json uses SQL Server Express LocalDB:

{
  "Steeltoe": {
    "Client": {
      "SqlServer": {
        "Default": {
          "ConnectionString": "Server=(localdb)\\mssqllocaldb;Database=SampleDB"
        }
      }
    }
  }
}

Initialize Steeltoe Connector

Update your Program.cs as below to initialize the Connector:

using Steeltoe.Connectors.SqlServer;

var builder = WebApplication.CreateBuilder(args);
builder.AddSqlServer();

Use SqlConnection

To obtain a SqlConnection instance in your application, inject the Steeltoe factory in a controller or view:

using Microsoft.AspNetCore.Mvc;
using Microsoft.Data.SqlClient;
using Steeltoe.Connectors;
using Steeltoe.Connectors.SqlServer;

public class HomeController : Controller
{
    public async Task<IActionResult> Index(
        [FromServices] ConnectorFactory<SqlServerOptions, SqlConnection> connectorFactory)
    {
        var connector = connectorFactory.Get();
        await using SqlConnection connection = connector.GetConnection();
        await connection.OpenAsync();

        SqlCommand command = connection.CreateCommand();
        command.CommandText = "SELECT 1";
        object? result = await command.ExecuteScalarAsync();

        ViewData["Result"] = result;
        return View();
    }
}

Use Entity Framework Core

Start by defining your DbContext class:

public class AppDbContext : DbContext
{
    public DbSet<SampleEntity> SampleEntities => Set<SampleEntity>();

    public AppDbContext(DbContextOptions<AppDbContext> options)
        : base(options)
    {
    }
}

public class SampleEntity
{
    public long Id { get; set; }
    public string? Text { get; set; }
}

Next, call the UseSqlServer() Steeltoe extension method from Program.cs to initialize Entity Framework Core:

using Steeltoe.Connectors.EntityFrameworkCore.SqlServer;
using Steeltoe.Connectors.SqlServer;

var builder = WebApplication.CreateBuilder(args);
builder.AddSqlServer();

builder.Services.AddDbContext<AppDbContext>(
    (serviceProvider, options) => options.UseSqlServer(serviceProvider));

Once you have configured and added your DbContext to the service container, you can inject it and use it in a controller or view:

using Microsoft.AspNetCore.Mvc;
using Microsoft.EntityFrameworkCore;

public class HomeController : Controller
{
    public async Task<IActionResult> Index([FromServices] AppDbContext appDbContext)
    {
        List<SampleEntity> entities = await appDbContext.SampleEntities.ToListAsync();
        return View(entities);
    }
}

A complete sample app that uses Entity Framework Core with SQL Server is provided at https://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/SqlServerEFCore.

Cloud Foundry

This Connector supports the following service brokers:

• VMware Tanzu Cloud Service Broker for Azure

You can create and bind an instance to your application by using the Cloud Foundry CLI:

# Create SQL Server service
cf create-service csb-azure-mssql small-v2 mySqlServerService

# Bind service to your app
cf bind-service myApp mySqlServerService

# Restage the app to pick up change
cf restage myApp