MSSQL Provider

Parameters

DatabaseVendor

From the FSharp.Data.Sql.Common.DatabaseProviderTypes enumeration. For MSSQL, use Common.DatabaseProviderTypes.MSSQLSERVER.

let [<Literal>] dbVendor = Common.DatabaseProviderTypes.MSSQLSERVER

ConnectionString

Basic connection string used to connect to MSSQL instance; typical connection strings for the driver apply here. See MSSQL Connecting Strings Documentation for a complete list of connection string options.

let [<Literal>] connString = "Server=localhost;Database=test;User Id=test;Password=test"

ConnectionStringName

Instead of storing the connection string in the source code / fsx script, you can store values in the App.config file. This is the name of the connectionString key/value pair stored in App.config.

// found in App.config
let [<Literal>] connexStringName = "DefaultConnectionString"

IndividualsAmount

Sets the count to load for each individual. See individuals for further info.

let [<Literal>] indivAmount = 1000

UseOptionTypes

If true, F# option types will be used in place of nullable database columns. If false, you will receive the default value of the column's type if the value is null in the database. The default is FSharp.Data.Sql.Common.NullableColumnType.NO_OPTION.

let [<Literal>] useOptTypes  = FSharp.Data.Sql.Common.NullableColumnType.OPTION

type sql =
    SqlDataProvider<
        dbVendor,
        connString,
        IndividualsAmount = indivAmount,
        UseOptionTypes = useOptTypes>

Because MSSQL databases can be huge, there is an optional constructor parameter TableNames that can be used as a filter.

Using Microsoft.Data.SqlClient.dll instead of build-in System.Data.SqlClient.dll

To use another driver, Microsoft.Data.SqlClient.dll, you have to set your provider to Common.DatabaseProviderTypes.MSSQLSERVER_DYNAMIC and copy the reference files from the NuGet package to local resolutionPath (e.g. Microsoft.Data.SqlClient.dll, Microsoft.Data.SqlClient.SNI.dll and Microsoft.Data.SqlClient.SNI.x86.dll).

Using SQLProvider with SSDT

You can user SQLProvider with SSDT.