StoredProcedureEFCore 0.3.0

Entity Framework Core extension to execute a stored procedure and map the result

There is a newer version of this package available.
See the version list below for details.
Install-Package StoredProcedureEFCore -Version 0.3.0
dotnet add package StoredProcedureEFCore --version 0.3.0
<PackageReference Include="StoredProcedureEFCore" Version="0.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add StoredProcedureEFCore --version 0.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: StoredProcedureEFCore, 0.3.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. 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.0

// Install StoredProcedureEFCore as a Cake Tool
#tool nuget:?package=StoredProcedureEFCore&version=0.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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>(string columnName = null)
Task<List<T>>                        ColumnAsync<T>(string columnName = null)
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:

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>(string columnName = null)
Task<List<T>>                        ColumnAsync<T>(string columnName = null)
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:

NuGet packages (1)

Showing the top 1 NuGet packages that depend on StoredProcedureEFCore:

Package Downloads
DevDiamond.AspNetCore.JqueryDataTable
Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.0.5 15,006 11/15/2020
1.0.4 34,358 6/16/2020
1.0.3 208 6/15/2020
1.0.2 8,212 4/10/2020
1.0.1 9,316 2/13/2020
1.0.0 2,656 1/14/2020
0.3.15 8,047 10/30/2019
0.3.14 776 10/22/2019
0.3.13 358 10/17/2019
0.3.12 432 8/9/2019
0.3.11 11,862 6/1/2019
0.3.10 14,957 11/15/2018
0.3.9 7,141 5/4/2018
0.3.8 960 4/21/2018
0.3.7 827 4/3/2018
0.3.6 835 3/16/2018
0.3.5 620 3/16/2018
0.3.4 849 3/2/2018
0.3.3 905 2/1/2018
0.3.2 713 1/19/2018
0.3.1 643 1/8/2018
0.3.0 630 1/8/2018
0.2.0 717 12/29/2017
0.1.1 678 12/28/2017
0.1.0 574 12/26/2017
Show less