StoredProcedureEFCore 0.3.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package StoredProcedureEFCore --version 0.3.1
NuGet\Install-Package StoredProcedureEFCore -Version 0.3.1
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="StoredProcedureEFCore" Version="0.3.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add StoredProcedureEFCore --version 0.3.1
#r "nuget: StoredProcedureEFCore, 0.3.1"
#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 StoredProcedureEFCore as a Cake Addin
#addin nuget:?package=StoredProcedureEFCore&version=0.3.1

// Install StoredProcedureEFCore as a Cake Tool
#tool nuget:?package=StoredProcedureEFCore&version=0.3.1

Execute stored procedures with Entity Framework Core

DbContext extension with LoadStoredProc method which creates an IStoredProcBuilder to build a stored procedure with a custom mapping strategy using the provided DbDataReader extension.

The method handles :

  • Extra column in result set
  • Extra property in model
  • Null values in result set
  • Underscores in result set column names ("column_name" is mapped to ColumnName property)
  • Int (db) to enumeration (result model) mapping

Example

List<Model> rows = null;

ctx.LoadStoredProc("dbo.ListAll")
   .AddParam("limit", 300L)
   .AddParam("limitOut", out IOutParam<long> limitOut)
   .Exec(r => rows = r.ToList<Model>());

long limitOutValue = limitOut.Value;

ctx.LoadStoredProc("dbo.ReturnBoolean")
   .AddParam("boolean_to_return", true)
   .ReturnValue(out IOutParam<bool> retParam)
   .ExecNonQuery();

bool b = retParam.Value;

ctx.LoadStoredProc("dbo.ListAll")
   .AddParam("limit", 1L)
   .ExecScalar(out long l);

API

DbContext

IStoredProcBuilder             LoadStoredProc(string name)

DbDataReader

List<T>                              ToList<T>()
Task<List<T>>                        ToListAsync<T>()
Dictionary<TKey, TValue>             ToDictionary<TKey, TValue>()
Task<Dictionary<TKey, TValue>>       ToDictionaryAsync<TKey, TValue>()
Dictionary<TKey, List<TValue>>       ToLookup<TKey, TValue>()
Task<Dictionary<TKey, List<TValue>>> ToLookupAsync<TKey, TValue>()
HashSet<T>                           ToSet<T>()
Task<HashSet<T>>                     ToSetAsync<T>()
List<T>                              Column<T>()
List<T>                              Column<T>(string columnName)
Task<List<T>>                        ColumnAsync<T>()
Task<List<T>>                        ColumnAsync<T>(string columnName)
T                                    First<T>()
Task<T>                              FirstAsync<T>()
T                                    FirstOrDefault<T>()
Task<T>                              FirstOrDefaultAsync<T>()
T                                    Single<T>()
Task<T>                              SingleAsync<T>()
T                                    SingleOrDefault<T>()
Task<T>                              SingleOrDefaultAsync<T>()

IStoredProcBuilder

IStoredProcBuilder                   AddParam<T>(string name, T val)                             // Input parameter
IStoredProcBuilder                   AddParam<T>(string name, T val, out OutParam<T> outParam)   // Input/Ouput parameter
IStoredProcBuilder                   AddParam<T>(string name, out IOutParam<T> outParam)         // Ouput parameter
IStoredProcBuilder                   ReturnValue<T>(out IOutParam<T> retParam)
void                                 Exec(Action<DbDataReader> action)
Task                                 ExecAsync(Func<DbDataReader, Task> action)
void                                 ExecNonQuery()
Task                                 ExecNonQueryAsync()
void                                 ExecScalar<T>(out T val)
Task                                 ExecScalarAsync<T>(Action<T> action)

Installation

Install-Package StoredProcedureEFCore

Why ?

Stored procedure execution is not supported in entity framework core:

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 netcoreapp1.1 is compatible.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (7)

Showing the top 5 NuGet packages that depend on StoredProcedureEFCore:

Package Downloads
BinaryBlox.SDK

Package Description

BinaryBlox.SDK.Account

Package Description

BinaryBlox.SDK.Configuration

Package Description

BinaryBlox.SDK.Permission

Package Description

DevDiamond.AspNetCore.JqueryDataTable

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.5 342,885 11/15/2020
1.0.4 74,910 6/16/2020
1.0.3 981 6/15/2020
1.0.2 10,903 4/10/2020
1.0.1 14,212 2/13/2020
1.0.0 6,023 1/14/2020
0.3.15 17,182 10/30/2019
0.3.14 5,020 10/22/2019
0.3.13 1,096 10/17/2019
0.3.12 1,433 8/9/2019
0.3.11 15,623 6/1/2019
0.3.10 21,251 11/15/2018
0.3.9 9,549 5/4/2018
0.3.8 2,001 4/21/2018
0.3.7 1,749 4/3/2018
0.3.6 1,814 3/16/2018
0.3.5 1,589 3/16/2018
0.3.4 1,837 3/2/2018
0.3.3 1,879 2/1/2018
0.3.2 1,716 1/19/2018
0.3.1 1,721 1/8/2018
0.3.0 1,732 1/8/2018
0.2.0 1,852 12/29/2017
0.1.1 1,799 12/28/2017
0.1.0 1,677 12/26/2017