SQLProvider


SQL Provider Static Parameters

Global parameters

These are the "common" parameters used by all SqlProviders.

All static parameters must be known at compile time, for strings this can be achieved by adding the [<Literal>] attribute if you are not passing it inline.

ConnectionString

This is the connection string commonly used to connect to a database server instance. See the documentation on your desired database type to find out more.

1: 
2: 
3: 
[<Literal>]
let sqliteConnectionString =
    "Data Source=" + __SOURCE_DIRECTORY__ + @"\northwindEF.db;Version=3"

ConnectionStringName

Instead of storing the connection string in the source code / fsx script, you can store values in the App.config file:

1: 
2: 
3: 
4: 
5: 
<connectionStrings>  
  <add name="MyConnectionString"   
   providerName="System.Data.ProviderName"   
   connectionString="Valid Connection String;" />  
</connectionStrings>

Another, usually easier option is to give a runtime connection string as parameter for .GetDataContext(...) method.

In your source file:

1: 
let connexStringName = "MyConnectionString"

DatabaseVendor

Select enumeration from Common.DatabaseProviderTypes to specify which database type the provider will be connecting to.

1: 
2: 
[<Literal>]
let dbVendor = Common.DatabaseProviderTypes.SQLITE

ResolutionPath

When using database vendors other than SQL Server, Access and ODBC, a third party driver is required. This parameter should point to an absolute or relative directory where the relevant assemblies are located. See the database vendor specific page for more details.

1: 
2: 
3: 
[<Literal>]
let resolutionPath =
    __SOURCE_DIRECTORY__ + @"..\..\..\files\sqlite"

Note on .NET 5 PublishSingleFile and ResolutionPath

If you are publishing your app using .NET 5's PublishSingleFile mode, the driver will be loaded from the bundle itself rather than from a separate file on the drive. As such, the ResolutionPath parameter will not work for the published app, nor will the automatic assembly resolution implemented within SQLProvider.

SQLProvider attempts to load the assembly from the AppDomain in such case. This means that your driver's assembly must be loaded by your application for SQLProvider to find it. To do so, simply use the types of your driver before calling the .GetDataContext(...) method, such as in this example, using MySqlConnector. The specific type you refer to does not matter.

1: 
2: 
typeof<MySqlConnector.Logging.MySqlConnectorLogLevel>.Assembly |> ignore
let ctx = sqlType.GetDataContext()

IndividualsAmount

Number of instances to retrieve when using the individuals feature. Default is 1000.

1: 
let indivAmt = 500

UseOptionTypes

If set to true, all nullable fields will be represented by F# option types. If false, nullable fields will be represented by the default value of the column type - this is important because the provider will return 0 instead of null, which might cause problems in some scenarios.

1: 
2: 
[<Literal>]
let useOptionTypes = true

ContextSchemaPath

Defining ContextSchemaPath and placing a file with schema information according to the definition enables offline mode that can be useful when the database is unavailable or slow to connect or access. Schema information file can be generated by calling design-time method SaveContextSchema under Design Time Commands:

1: 
ctx.``Design Time Commands``.SaveContextSchema

This method doesn't affect runtime execution. Note that since SQLProvider loads schema information lazily, calling SaveContextSchema only saves the portion of the database schema that is sufficient to compile queries referenced in the scope of the current solution or script. Therefore it is recommended to execute it after the successful build of the whole solution. Type the method name with parentheses, if you then type a dot (.), you should see a tooltip with information when the schema was last saved. Once the schema is saved, the outcome of the method execution is stored in memory, so the file will not be overwritten. In case the database schema changes and the schema file must be updated, remove the outdated file, reload the solution and retype or uncomment a call to SaveContextSchema to regenerate the schema file.

There is a tool method FSharp.Data.Sql.Common.OfflineTools.mergeCacheFiles to merge multiple files together.

1: 
2: 
3: 
[<Literal>]
let contextSchemaPath =
    __SOURCE_DIRECTORY__ + @".\sqlite.schema"

Platform Considerations

MSSQL

TableNames to filter amount of tables.

Oracle

TableNames to filter amount of tables, and Owner.

Owner (Used by Oracle, MySQL and PostgreSQL)

This has different meanings when running queries against different database vendors

For PostgreSQL, this sets the schema name where the target tables belong to. Can be also a list separated by spaces, newlines, commas or semicolons.

For MySQL, this sets the database name (Or schema name, for MySQL, it's the same thing). Can be also a list separated by spaces, newlines, commas or semicolons.

For Oracle, this sets the owner of the scheme.

SQLite

The additional SQLiteLibrary parameter can be used to specify which SQLite library to load.

PostgreSQL

No extra parameters.

MySQL

No extra parameters.

ODBC

No extra parameters.

Example

It is recommended to use named static parameters in your type provider definition like so

1: 
2: 
3: 
4: 
5: 
6: 
type sql = SqlDataProvider<
            ConnectionString = sqliteConnectionString,
            DatabaseVendor = dbVendor,
            ResolutionPath = resolutionPath,
            UseOptionTypes = useOptionTypes
          >

SQL Provider Data Context Parameters

Besides the static parameters the .GetDataContext(...) method has optional parameters:

  • connectionString - The database connection string on runtime.
  • resolutionPath - The location to look for dynamically loaded assemblies containing database vendor specific connections and custom types
  • transactionOptions - TransactionOptions for the transaction created on SubmitChanges.
  • commandTimeout - SQL command timeout. Maximum time for single SQL-command in seconds.
  • selectOperations - Execute select-clause operations in SQL database rahter than .NET-side.
Multiple items
namespace FSharp

--------------------
namespace Microsoft.FSharp
Multiple items
namespace FSharp.Data

--------------------
namespace Microsoft.FSharp.Data
namespace FSharp.Data.Sql
Multiple items
type LiteralAttribute =
  inherit Attribute
  new : unit -> LiteralAttribute

--------------------
new : unit -> LiteralAttribute
val connectionString : string
val resolutionPath : string
type sqlType = obj
type SqlDataProvider


<summary>Typed representation of a database</summary>
                    <param name='ConnectionString'>The connection string for the SQL database</param>
                    <param name='ConnectionStringName'>The connection string name to select from a configuration file</param>
                    <param name='DatabaseVendor'> The target database vendor</param>
                    <param name='IndividualsAmount'>The amount of sample entities to project into the type system for each SQL entity type. Default 1000.</param>
                    <param name='UseOptionTypes'>If true, F# option types will be used in place of nullable database columns. If false, you will always receive the default value of the column's type even if it is null in the database.</param>
                    <param name='ResolutionPath'>The location to look for dynamically loaded assemblies containing database vendor specific connections and custom types.</param>
                    <param name='Owner'>Oracle: The owner of the schema for this provider to resolve. PostgreSQL: A list of schemas to resolve, separated by spaces, newlines, commas, or semicolons.</param>
                    <param name='CaseSensitivityChange'>Should we do ToUpper or ToLower when generating table names?</param>
                    <param name='TableNames'>Comma separated table names list to limit a number of tables in big instances. The names can have '%' sign to handle it as in the 'LIKE' query (Oracle and MSSQL Only)</param>
                    <param name='ContextSchemaPath'>The location of the context schema previously saved with SaveContextSchema. When not empty, will be used to populate the database schema instead of retrieving it from then database.</param>
                    <param name='OdbcQuote'>Odbc quote characters: Quote characters for the table and column names: `alias`, [alias]</param>
                    <param name='SQLiteLibrary'>Use System.Data.SQLite or Mono.Data.SQLite or select automatically (SQLite only)</param>
                    
namespace FSharp.Data.Sql.Common
type DatabaseProviderTypes =
  | MSSQLSERVER = 0
  | SQLITE = 1
  | POSTGRESQL = 2
  | MYSQL = 3
  | ORACLE = 4
  | MSACCESS = 5
  | ODBC = 6
  | FIREBIRD = 7
  | MSSQLSERVER_DYNAMIC = 8
Common.DatabaseProviderTypes.SQLITE: Common.DatabaseProviderTypes = 1
val sqliteConnectionString : string
val connexStringName : string
val dbVendor : Common.DatabaseProviderTypes
val typeof<'T> : System.Type
namespace MySqlConnector
namespace MySqlConnector.Logging
type MySqlConnectorLogLevel =
  | Trace = 1
  | Debug = 2
  | Info = 3
  | Warn = 4
  | Error = 5
  | Fatal = 6
val ignore : value:'T -> unit
val ctx : obj
val indivAmt : int
val useOptionTypes : bool
val contextSchemaPath : string
type sql = obj
Fork me on GitHub