porting-cheat-sheet.md

Cheat sheet for porting from System.Data.SqlClient to Microsoft.Data.SqlClient

This guide is meant to cover all namespace changes needed in client applications when porting SqlClient references to Microsoft.Data.SqlClient:

Namespace Changes needed

Namespace Change	Applicability
using System.Data.SqlClient; using Microsoft.Data.SqlClient;	Applicable to all classes, enums and delegates.
using Microsoft.SqlServer.Server; using Microsoft.Data.SqlClient.Server;	Applicable Classes: InvalidUdtException SqlDataRecord SqlFunctionAttribute SqlMetaData SqlMethodAttribute SqlUserDefinedAggregateAttribute SqlUserDefinedTypeAttribute Applicable Interfaces: IBinarySerialize Applicable Enums: DataAccessKind Format SystemDataAccessKind
using System.Data.SqlTypes; using Microsoft.Data.SqlTypes;	Applicable Classes: SqlFileStream
using System.Data.Sql; using Microsoft.Data.Sql;	Applicable Classes: SqlNotificationRequest
using System.Data; using Microsoft.Data;	Applicable Classes: OperationAbortedException

Configuration

For .NET Framework projects it may be necessary to include the following in your App.config or Web.config file:

<configuration>
    ...
    <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>

Contribute to this Cheat Sheet

We would love the SqlClient community to help enhance this cheat sheet by contributing experiences and challenges faced when porting their applications.