ErikEJ.EntityFramework.SqlServer 6.6.11

Prefix Reserved
Suggested Alternatives

Microsoft.EntityFramework.SqlServer

Requires NuGet 5.0 or higher.

dotnet add package ErikEJ.EntityFramework.SqlServer --version 6.6.11                
NuGet\Install-Package ErikEJ.EntityFramework.SqlServer -Version 6.6.11                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ErikEJ.EntityFramework.SqlServer" Version="6.6.11" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ErikEJ.EntityFramework.SqlServer --version 6.6.11                
#r "nuget: ErikEJ.EntityFramework.SqlServer, 6.6.11"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ErikEJ.EntityFramework.SqlServer as a Cake Addin
#addin nuget:?package=ErikEJ.EntityFramework.SqlServer&version=6.6.11

// Install ErikEJ.EntityFramework.SqlServer as a Cake Tool
#tool nuget:?package=ErikEJ.EntityFramework.SqlServer&version=6.6.11                

ErikEJ.EntityFramework.SqlServer

latest version downloads

This Entity Framework 6 provider is a runtime replacement provider for the built-in SQL Server provider.

This provider depends on the modern Microsoft.Data.SqlClient ADO.NET provider, see my blog post here for why that can be desirable. One of the main reasons is the additional Azure Active Directory authentication methods that are now available.

The latest build of this package is available from NuGet

UPDATE An official Microsoft package based on this package has been published.

Configuration

There are various ways to configure Entity Framework to use this provider.

You can register the provider in code using an attribute:

    [DbConfigurationType(typeof(MicrosoftSqlDbConfiguration))]
    public class SchoolContext : DbContext
    {
        public SchoolContext() : base()
        {
        }

        public DbSet<Student> Students { get; set; }
    }

If you have multiple classes inheriting from DbContext in your solution, add the DbConfigurationType attribute to all of them.

Or you can use the SetConfiguration method before any data access calls:

 DbConfiguration.SetConfiguration(new MicrosoftSqlDbConfiguration());

Or you can add the following lines to your existing DbConfiguration class:

SetProviderFactory(MicrosoftSqlProviderServices.ProviderInvariantName, Microsoft.Data.SqlClient.SqlClientFactory.Instance);
SetProviderServices(MicrosoftSqlProviderServices.ProviderInvariantName, MicrosoftSqlProviderServices.Instance);
// Optional
SetExecutionStrategy(MicrosoftSqlProviderServices.ProviderInvariantName, () => new MicrosoftSqlAzureExecutionStrategy());

You can also use XML/App.Config based configuration:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <configSections>
        <section name="entityFramework" type="System.Data.Entity.Internal.ConfigFile.EntityFrameworkSection, EntityFramework, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />    
    </configSections>
    <entityFramework>
        <providers>		
            <provider invariantName="Microsoft.Data.SqlClient" type="System.Data.Entity.SqlServer.MicrosoftSqlProviderServices, ErikEJ.EntityFramework.SqlServer" />
        </providers>
    </entityFramework>
    <system.data>
        <DbProviderFactories>
           <add name="SqlClient Data Provider"
             invariant="Microsoft.Data.SqlClient"
             description=".NET Framework Data Provider for SqlServer"
             type="Microsoft.Data.SqlClient.SqlClientFactory, Microsoft.Data.SqlClient" />
        </DbProviderFactories>
    </system.data>
</configuration>

If you use App.Config with a .NET Core / .NET 5 or later app, you must remove the <system.data> section above and register the DbProviderFactory in code once:

DbProviderFactories.RegisterFactory(MicrosoftSqlProviderServices.ProviderInvariantName, Microsoft.Data.SqlClient.SqlClientFactory.Instance);

EDMX usage

If you use an EDMX file, update the Provider name in the EDMX file:

<edmx:Edmx Version="3.0" xmlns:edmx="http://schemas.microsoft.com/ado/2009/11/edmx">
  <edmx:Runtime>
    <edmx:StorageModels>
      <Schema Namespace="ChinookModel.Store" Provider="Microsoft.Data.SqlClient" >

Also update the provider name inside the EntityConnection connection string - sample of working App.Config file:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    
    <section name="entityFramework" type="System.Data.Entity.Internal.ConfigFile.EntityFrameworkSection, EntityFramework, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
  </configSections>
  <entityFramework>
    <providers>
      <provider invariantName="Microsoft.Data.SqlClient" type="System.Data.Entity.SqlServer.MicrosoftSqlProviderServices, ErikEJ.EntityFramework.SqlServer" />
    </providers>
  </entityFramework>
  <system.data>
    <DbProviderFactories>
      <add name="SqlClient Data Provider" invariant="Microsoft.Data.SqlClient" description=".NET Framework Data Provider for SqlServer" type="Microsoft.Data.SqlClient.SqlClientFactory, Microsoft.Data.SqlClient" />
    </DbProviderFactories>
  </system.data>
  <connectionStrings>
    <add name="ChinookEntities" connectionString="metadata=res://*/Model1.csdl|res://*/Model1.ssdl|res://*/Model1.msl;provider=Microsoft.Data.SqlClient;provider connection string=&quot;data source=.\SQLEXPRESS;initial catalog=Chinook;integrated security=True;App=EntityFramework&quot;" providerName="System.Data.EntityClient" />
  </connectionStrings>
</configuration>

In order to use the EDMX file with the Visual Studio designer, use Visual Studio 17.6 or later. Your project must be a "classic" .NET Framework project. Make sure to restore packages and build before opening the designer. You may need to restart Visual Studio after building for the first time. For designer issues, report here. An interesting hack for some designer issues is described here.

Code changes

In order to use the provider in an existing solution, a few code changes are required (as needed).

using System.Data.SqlClient;using Microsoft.Data.SqlClient;

using Microsoft.SqlServer.Server;using Microsoft.Data.SqlClient.Server;

The following classes have been renamed to avoid conflicts with classes in the existing SQL Server provider:

SqlAzureExecutionStrategyMicrosoftSqlAzureExecutionStrategy

SqlConnectionFactoryMicrosoftSqlConnectionFactory

SqlDbConfigurationMicrosoftSqlDbConfiguration

SqlProviderServicesMicrosoftSqlProviderServices

SqlServerMigrationSqlGeneratorMicrosoftSqlServerMigrationSqlGenerator

SqlSpatialServicesMicrosoftSqlSpatialServices

Known issues

Azure App Service with .NET Framework and connection strings configuration

If you use Azure App Service with .NET Framework and the connection strings configuration feature, you can encounter runtime issues, as the ProviderName connection string setting in this scenario is hardcoded to System.Data.SqlClient.

Solution is to use a derived MicrosoftSqlDbConfiguration class like this:

public class AppServiceConfiguration : MicrosoftSqlDbConfiguration
{
    public AppServiceConfiguration()
    {
        SetProviderFactory("System.Data.SqlClient", Microsoft.Data.SqlClient.SqlClientFactory.Instance);
        SetProviderServices("System.Data.SqlClient", MicrosoftSqlProviderServices.Instance);
        SetExecutionStrategy("System.Data.SqlClient", () => new MicrosoftSqlAzureExecutionStrategy());
    }
}

Then use this derived class in the code-based configuration described above.

EntityFramework.dll installed in GAC

If an older version of EntityFramework.dll is installed in the .NET Framework GAC (Global Assembly Cache), you might get this runtime error:

The 'PrimitiveTypeKind' attribute is invalid - The value 'HierarchyId' is invalid according to its datatype

Solution is to remove the .dll from the GAC, see this for more info

Feedback

Please report any issues, questions and suggestions here

Release notes

6.6.11

6.6.10

6.6.9

  • Uses Microsoft.Data.SqlClient 5.1.5

6.6.7

  • Uses Microsoft.Data.SqlClient 5.1.4

6.6.6

  • Fix for .NET resource load bug

6.6.5

  • Uses Microsoft.Data.SqlClient 5.1.1

6.6.4

  • Fix wrong resource reference (to legacy provider assembly)

6.6.3

  • Uses Microsoft.Data.SqlClient 5.1.0

6.6.2

  • Uses Microsoft.SqlServer.Types 160.1000.6
  • Requires .NET Framework 4.6.2

6.6.1

  • Uses Microsoft.Data.SqlClient 5.0.1

6.6.0

  • Uses Microsoft.Data.SqlClient 5.0.0
  • Added support for spatial on .NET (Core) with new Microsoft.SqlServer.Types package

6.5.0

  • Uses Microsoft.Data.SqlClient 4.0.1
  • Removed duplicate spatial and Sql functions classes

6.4.x

  • Uses Microsoft.Data.SqlClient 2.1.4
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
.NET Framework net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on ErikEJ.EntityFramework.SqlServer:

Package Downloads
SonicGD.EntityFramework.BulkExtensions

Bulk operations extension library for Entity Framework.

CloudNimble.LinqPad.Drivers.EF6Core

A LINQPad 6+ driver for EF6 DbContexts using Microsoft.Data.SqlClient.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
6.6.11 3,357 6/1/2024
6.6.10 1,660 5/22/2024
6.6.9 77,045 1/30/2024
6.6.8 2,760 1/19/2024
6.6.7 4,486 1/10/2024
6.6.6 60,190 8/6/2023
6.6.6-preview2 224 8/3/2023
6.6.6-preview1 833 8/3/2023
6.6.5 124,631 4/4/2023
6.6.4 40,398 2/9/2023
6.6.3 26,732 1/20/2023
6.6.2 72,260 11/24/2022
6.6.0 35,974 9/8/2022
6.6.0-rc1 199 9/5/2022
6.5.0 5,712 9/4/2022
6.5.0-rc1 376 8/9/2022
6.4.3 99,890 3/24/2022
6.4.2 864 3/12/2022
6.4.1 109,798 12/12/2021
6.4.1-preview1 241 11/27/2021
6.4.0 98,457 8/24/2021
1.0.0-rc5 710 8/19/2021

Update to M.D.S. 5.2.1