Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zzzprojects/EntityFrameworkExtras
EntityFrameworkExtras provides some useful additions to EntityFramework such as executing Stored Procedures with User-Defined Table Types and Output Parameters.
https://github.com/zzzprojects/EntityFrameworkExtras
c-sharp efcore entity-framework entity-framework-core entityframework entityframeworkcore
Last synced: 3 days ago
JSON representation
EntityFrameworkExtras provides some useful additions to EntityFramework such as executing Stored Procedures with User-Defined Table Types and Output Parameters.
- Host: GitHub
- URL: https://github.com/zzzprojects/EntityFrameworkExtras
- Owner: zzzprojects
- License: mit
- Created: 2012-11-24T18:04:01.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T07:31:32.000Z (4 months ago)
- Last Synced: 2024-07-10T09:28:15.057Z (4 months ago)
- Topics: c-sharp, efcore, entity-framework, entity-framework-core, entityframework, entityframeworkcore
- Language: C#
- Homepage: https://entityframework-extras.net/
- Size: 12 MB
- Stars: 78
- Watchers: 13
- Forks: 40
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- awesome-entity-framework-core - EntityFrameworkExtras - EntityFrameworkExtras provides some useful additions to EntityFramework such as executing Stored Procedures with User-Defined Table Types and Output Parameters. (Supported Packages / Contents)
README
### Library Powered By
This library is powered by [Entity Framework Extensions](https://entityframework-extensions.net/?z=github&y=entityframeworkextras-plus)
---
What's EntityFrameworkExtras?
=====================
EntityFrameworkExtras provides some useful additions to EntityFramework, such as executing Stored Procedures with User-Defined Table Types and Output Parameters.
### Executing a Stored Procedure with a User Defined Table Type
* Define a stored procedure class
~~~ csharp
[StoredProcedure("storedproc_AddMemberWithAddresses")]
public class AddMemberStoredWithAddressesProcedure
{
[StoredProcedureParameter(SqlDbType.NVarChar, ParameterName = "ForeName")]
public string FirstName { get; set; }
[StoredProcedureParameter(SqlDbType.NVarChar,ParameterName = "SurName")]
public string LastName { get; set; }
[StoredProcedureParameter(SqlDbType.Int)]
public int Age { get; set; }
[StoredProcedureParameter(SqlDbType.Udt)]
public List
Addresses { get; set; }
}
~~~
* A User Defined Table Type parameter is declared as a List<> (List
). The UDT will also require some attributes:
~~~ csharp
[UserDefinedTableType("udt_Address")]
public class Address
{
[UserDefinedTableTypeColumn(1)]
public string Line1 { get; set; }
[UserDefinedTableTypeColumn(2)]
public string Line2 { get; set; }
[UserDefinedTableTypeColumn(3)]
public string Postcode { get; set; }
}
~~~
* Execute the Stored Procedure with either a DbContext or an ObjectContext
~~~ csharp
DbContext context = new DbContext("ConnectionString");
var proc = new AddMemberStoredWithAddressesProcedure()
{
FirstName = "Michael",
LastName = "Bovis",
Age = 26,
Addresses = new List
()
{
new Address() {Line1 = "16", Line2 = "The Lane", Postcode = "MA24WE"}
}
};
context.Database.ExecuteStoredProcedure(proc);
~~~
### Executing a Stored Procedure with an Output parameter
* To add an Output parameter, you need to set the Direction parameter to ParameterDirection.Output.
~~~ csharp
[StoredProcedure("storedProc_GetOldestAge")]
public class GetOldestAgeStoredProcedure
{
[StoredProcedureParameter(SqlDbType.Int, Direction = ParameterDirection.Output)]
public int Age { get; set; }
}
~~~
* Execute the Stored Procedure, and the parameter will be set to the output parameter value
~~~ csharp
var proc = new GetOldestAgeStoredProcedure();
context.Database.ExecuteStoredProcedure(proc);
int age = proc.Age; //Is now the oldest age
~~~
## Useful links
- [Website](https://entityframework-extras.net/overview)
- [Download](https://entityframework-extras.net/download)
- [NuGet Entity Framework Core](https://www.nuget.org/packages/EntityFrameworkExtras.EFCore/)
- [Nuget Entity Framework 6](https://www.nuget.org/packages/EntityFrameworkExtras.EF6/)
- [Nuget Entity Framework 5](https://www.nuget.org/packages/EntityFrameworkExtras.EF5/)
- [Nuget Entity Framework 4](https://www.nuget.org/packages/EntityFrameworkExtras/)
## Contribute
The best way to contribute is by **spreading the word** about the library:
- Blog it
- Comment it
- Star it
- Share it
A **HUGE THANKS** for your help.
## More Projects
- Projects:
- [EntityFramework Extensions](https://entityframework-extensions.net/)
- [Dapper Plus](https://dapper-plus.net/)
- [C# Eval Expression](https://eval-expression.net/)
- Learn Websites
- [Learn EF Core](https://www.learnentityframeworkcore.com/)
- [Learn Dapper](https://www.learndapper.com/)
- Online Tools:
- [.NET Fiddle](https://dotnetfiddle.net/)
- [SQL Fiddle](https://sqlfiddle.com/)
- [ZZZ Code AI](https://zzzcode.ai/)
- and much more!
To view all our free and paid projects, visit our website [ZZZ Projects](https://zzzprojects.com/).