https://github.com/oceania2018/entityframeworkcore.bootkit
EntityFrameworkCore Start Kit
https://github.com/oceania2018/entityframeworkcore.bootkit
aurora database entityframework postgres redshift
Last synced: 12 months ago
JSON representation
EntityFrameworkCore Start Kit
- Host: GitHub
- URL: https://github.com/oceania2018/entityframeworkcore.bootkit
- Owner: Oceania2018
- License: mit
- Created: 2017-12-11T00:59:17.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-07T17:35:17.000Z (about 1 year ago)
- Last Synced: 2025-04-02T00:16:58.789Z (12 months ago)
- Topics: aurora, database, entityframework, postgres, redshift
- Language: C#
- Size: 107 KB
- Stars: 37
- Watchers: 2
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EntityFrameworkCore.BootKit
n']
[](https://gitter.im/sci-sharp/community) [](https://tensorflownet.readthedocs.io/en/latest/?badge=latest) [](https://www.nuget.org/packages/EntityFrameworkCore.BootKit)
EntityFrameworkCore Boot Kit (EFBK) is a quick start database connect library for using .NET EntityFrameworkCore.
### Features:
* Inherits from EntityFrameworkCore Triggers to enable entries update notfication.
* Support mulitple databases like MySql, SQL Server, Sqlite, PostgreSql, MongoDB, Amazon Redshift, AWS Aurora and InMemory.
* Support dynamic linq to query and update database.
* Support read/write seperated mode. Randomly choose multiple slaves.
* Multiple database with distributed transaction supported, and MySQL multiple databases/tables sharding supported.
* Tracking entry change history.
* Built-in DbFactory with access control list (ACL) hook.
### Get started
How to install
```sh
PM> Install-Package EntityFrameworkCore.BootKit
```
How to use
1. Define entity
```cs
public class PizzaOrder : DbRecord, IDbRecord
{
[MaxLength(32)]
public String OrderNumber { get; set; }
[MaxLength(64)]
public String CustomerName { get; set; }
[Required]
public DateTime CreatedTime { get; set; }
[ForeignKey("OrderId")]
public List PizzaTypes { get; set; }
}
```
2. Init data context
```cs
var db = new Database();
AppDomain.CurrentDomain.SetData("Assemblies", new string[] { "EntityFrameworkCore.BootKit.UnitTest" });
// bind as much data context as you can
db.BindDbContext(new DatabaseBind
{
MasterConnection = new SqliteConnection($"Data Source={Directory.GetCurrentDirectory()}\\..\\..\\..\\..\\bootkit.db"),
CreateDbIfNotExist = true
});
db.BindDbContext(new DatabaseBind
{
MasterConnection = new NpgsqlConnection("Server=; Port=5439;User ID=;Password=;Database=;SSL Mode=Require;Trust Server Certificate=True;Use SSL Stream=True"),
});
```
3. Retrieve record
```cs
var order = db.Table().Include(x => x.PizzaTypes).FirstOrDefault();
```
4. Retrieve record by table name
```cs
var table = db.Table("PizzaOrder");
var pizzaOrder = table.First() as PizzaOrder;
```
5. Update record in transaction
```cs
int row = db.DbTran(() =>
{
var po = db.Table().Find(PIZZA_ORDER_ID);
po.CreatedTime = DateTime.UtcNow
});
```
6. Update record in Patch function
```cs
int row = db.DbTran(() =>
{
var patch = new DbPatchModel
{
Table = "PizzaOrder",
Id = PIZZA_ORDER_ID
};
patch.Values.Add("CreatedTime", dt);
db.Patch(patch);
});
```
7. Implement IRequireDbPermission to interupt update
8. View raw sql
```cs
string sql = table.ToSql();
```
9. Added MongoDb support
```cs
db.BindDbContext(new DatabaseBind
{
MasterConnection = new MongoDbConnection("mongodb://user:password@localhost:27017/db"),
});
var collection = db.Collection().FirstOrDefault();
// Add new record
db.Collection().InsertOne(new MongoDbCollection
{
Id = Guid.NewGuid().ToString(),
Name = "Pizza"
});
// Update record
db.Collection().UpdateOne(x => x.Name == "Pizza", x => x.Name, "Pizza 2");
```
10. Support Amazon Redshift
```cs
db.BindDbContext(new DatabaseBind
{
string connString = "Server=*.us-east-1.redshift.amazonaws.com; Port=5439;User ID=;Password=;Database=;Server Compatibility Mode=Redshift;SSL Mode=Require;Trust Server Certificate=True;Use SSL Stream=True";
MasterConnection = new NpgsqlConnection(connString),
});
```
### Documentation
https://entityframeworkcorebootkit.readthedocs.io