https://github.com/dotnetcore/freesql
.NET aot orm, VB.NET/C# orm, Mysql/PostgreSQL/SqlServer/Oracle orm, Sqlite/Firebird/Clickhouse/DuckDB orm, 达梦/金仓/虚谷/翰高/高斯 orm, 神通 orm, 南大通用 orm, 国产 orm, TDengine orm, QuestDB orm, MsAccess orm.
https://github.com/dotnetcore/freesql
access clickhouse codefirst dameng duckdb firebird gbase hacktoberfest highgo kingbase mysql odbc oracle orm postgresql questdb shentongdata sqlite sqlserver xugu
Last synced: 4 days ago
JSON representation
.NET aot orm, VB.NET/C# orm, Mysql/PostgreSQL/SqlServer/Oracle orm, Sqlite/Firebird/Clickhouse/DuckDB orm, 达梦/金仓/虚谷/翰高/高斯 orm, 神通 orm, 南大通用 orm, 国产 orm, TDengine orm, QuestDB orm, MsAccess orm.
- Host: GitHub
- URL: https://github.com/dotnetcore/freesql
- Owner: dotnetcore
- License: mit
- Created: 2018-12-18T03:02:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-30T13:48:59.000Z (10 days ago)
- Last Synced: 2025-04-30T14:13:19.923Z (10 days ago)
- Topics: access, clickhouse, codefirst, dameng, duckdb, firebird, gbase, hacktoberfest, highgo, kingbase, mysql, odbc, oracle, orm, postgresql, questdb, shentongdata, sqlite, sqlserver, xugu
- Language: C#
- Homepage: https://freesql.net
- Size: 21.2 MB
- Stars: 4,216
- Watchers: 148
- Forks: 872
- Open Issues: 61
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🦄 FreeSql, The First AOT ORM!
FreeSql is a powerful O/RM component, supports .NET Core 2.1+, .NET Framework 4.0+, Xamarin, And AOT.
[](https://github.com/dotnetcore)
[](https://www.nuget.org/packages/FreeSql)
[](https://www.nuget.org/stats/packages/FreeSql?groupby=Version)
[](https://raw.githubusercontent.com/dotnetcore/FreeSql/master/LICENSE.txt)
English |
中文
- 🛠 Support CodeFirst data migration.
- 💻 Support DbFirst import entity class from database, or use [Generation Tool](https://github.com/dotnetcore/FreeSql/wiki/DbFirst).
- ⛳ Support advanced type mapping, such as PostgreSQL array type, etc.
- 🌲 Support expression functions, and customizable analysis.
- 🏁 Support one-to-many and many-to-many navigation properties, include and lazy loading.
- 📃 Support Read/Write separation, Splitting Table/Database, Global filters, Optimistic and pessimistic locker.
- 🌳 Support MySql/SqlServer/PostgreSQL/Oracle/Sqlite/Firebird/达梦/人大金仓/南大通用/虚谷/神舟通用/翰高/ClickHouse/DuckDB/TDengine/QuestDB/MsAccess, etc.
QQ Groups：**561616019(available)**、4336577(full)、8578575(full)、52508226(full)
## 📚 Documentation
| |
| - |
| [Get started](https://github.com/dotnetcore/FreeSql/wiki/Getting-Started) \| [Select](https://github.com/dotnetcore/FreeSql/wiki/Query-Data) \| [Update](https://github.com/dotnetcore/FreeSql/wiki/Update-Data) \| [Insert](https://github.com/dotnetcore/FreeSql/wiki/Insert-Data) \| [Delete](https://github.com/dotnetcore/FreeSql/wiki/Delete-Data) \| [FAQ](https://github.com/dotnetcore/FreeSql/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98) |
| [Expression](https://github.com/dotnetcore/FreeSql/wiki/%e8%a1%a8%e8%be%be%e5%bc%8f%e5%87%bd%e6%95%b0) \| [CodeFirst](https://github.com/dotnetcore/FreeSql/wiki/CodeFirst) \| [DbFirst](https://github.com/2881099/FreeSql/wiki/DbFirst) \| [Filters](https://github.com/dotnetcore/FreeSql/wiki/%e8%bf%87%e6%bb%a4%e5%99%a8) \| [AOP](https://github.com/2881099/FreeSql/wiki/AOP) |
| [Repository](https://github.com/dotnetcore/FreeSql/wiki/Repository-layer) \| [UnitOfWork](https://github.com/dotnetcore/FreeSql/wiki/Unit-of-Work) \| [Dynamic Operations](https://github.com/dotnetcore/FreeSql/wiki/%E5%8A%A8%E6%80%81%E6%93%8D%E4%BD%9C) \| [ADO](https://github.com/2881099/FreeSql/wiki/ADO) |
| [Read/Write](https://github.com/dotnetcore/FreeSql/wiki/%e8%af%bb%e5%86%99%e5%88%86%e7%a6%bb) \| [Splitting Table](https://github.com/dotnetcore/FreeSql/wiki/%e5%88%86%e8%a1%a8%e5%88%86%e5%ba%93) \| [Hide tech](https://github.com/dotnetcore/FreeSql/wiki/%E9%AA%9A%E6%93%8D%E4%BD%9C) \| [*Update Notes*](https://github.com/dotnetcore/FreeSql/wiki/%e6%9b%b4%e6%96%b0%e6%97%a5%e5%bf%97) |
> Please select a development mode:
- Use FreeSql, keep the original usage.
- Use [FreeSql.DbContext](https://github.com/dotnetcore/FreeSql/wiki/Repository), Repository + UnitOfWork.
- Use [FreeSql.BaseEntity](https://github.com/dotnetcore/FreeSql/tree/master/Examples/base_entity), Simple mode.
> Some open source projects that use FreeSql:
- [Zhontai.net Management System](https://github.com/zhontai/Admin.Core)
- [A simple CMS implemented by .NET8](https://github.com/luoyunchong/lin-cms-dotnetcore)
- [AIBPM workflow](https://github.com/leooneone/aibpm.plus)
- [NetAdmin A rapid development framework based on C#12/.NET9 and FreeSql](https://github.com/nsnail/NetAdmin)
## 🚀 Quick start
> dotnet add package FreeSql.Provider.Sqlite
```csharp
static IFreeSql fsql = new FreeSql.FreeSqlBuilder()
.UseConnectionString(FreeSql.DataType.Sqlite, @"Data Source=document.db")
.UseAutoSyncStructure(true) //automatically synchronize the entity structure to the database
.Build(); //be sure to define as singleton mode
class Song {
[Column(IsIdentity = true)]
public int Id { get; set; }
public string Title { get; set; }
public string Url { get; set; }
public DateTime CreateTime { get; set; }
public ICollection Tags { get; set; }
}
class Song_tag {
public int Song_id { get; set; }
public Song Song { get; set; }
public int Tag_id { get; set; }
public Tag Tag { get; set; }
}
class Tag {
[Column(IsIdentity = true)]
public int Id { get; set; }
public string Name { get; set; }
public int? Parent_id { get; set; }
public Tag Parent { get; set; }
public ICollection Songs { get; set; }
public ICollection Tags { get; set; }
}
```
### 🔎 Query
```csharp
//OneToOne、ManyToOne
fsql.Select().Where(a => a.Parent.Parent.Name == "English").ToList();
//OneToMany
fsql.Select().IncludeMany(a => a.Tags, then => then.Where(sub => sub.Name == "foo")).ToList();
//ManyToMany
fsql.Select()
.IncludeMany(a => a.Tags, then => then.Where(sub => sub.Name == "foo"))
.Where(s => s.Tags.Any(t => t.Name == "Chinese"))
.ToList();
//Other
fsql.Select()
.Where(a => a.IsDelete == 0)
.WhereIf(keyword != null, a => a.UserName.Contains(keyword))
.WhereIf(role_id > 0, a => a.RoleId == role_id)
.Where(a => a.Nodes.Any(t => t.Parent.Id == t.UserId))
.Count(out var total)
.Page(page, size)
.OrderByDescending(a => a.Id)
.ToList()
```
[More..](https://github.com/dotnetcore/FreeSql/wiki/%e6%9f%a5%e8%af%a2)
```csharp
fsql.Select().Where(a => new[] { 1, 2, 3 }.Contains(a.Id)).ToList();
fsql.Select().Where(a => a.CreateTime.Date == DateTime.Today).ToList();
fsql.Select().OrderBy(a => Guid.NewGuid()).Limit(10).ToList();
fsql.Select().ToList(a => new
{
a.Id,
Tags = fsql.Select().ToList(),
SongTags = fsql.Select().Where(b => b.TopicId == a.Id).ToList()
});
```
[More..](https://github.com/dotnetcore/FreeSql/wiki/%e8%a1%a8%e8%be%be%e5%bc%8f%e5%87%bd%e6%95%b0)
### 🚁 Repository
> dotnet add package FreeSql.Repository
```csharp
[Transactional]
public void Add() {
var repo = ioc.GetService>();
repo.DbContextOptions.EnableCascadeSave = true;
var item = new Tag {
Name = "testaddsublist",
Tags = new[] {
new Tag { Name = "sub1" },
new Tag { Name = "sub2" }
}
};
repo.Insert(item);
}
```
Reference: [Use `TransactionalAttribute` and `UnitOfWorkManager` in ASP.NET Core to Achieve the *Multiple Transaction Propagation*](https://github.com/dotnetcore/FreeSql/issues/289).
## 💪 Performance
FreeSql Query & Dapper Query
```shell
Elapsed: 00:00:00.6733199; Query Entity Counts: 131072; ORM: Dapper
Elapsed: 00:00:00.4554230; Query Tuple Counts: 131072; ORM: Dapper
Elapsed: 00:00:00.6846146; Query Dynamic Counts: 131072; ORM: Dapper
Elapsed: 00:00:00.6818111; Query Entity Counts: 131072; ORM: FreeSql*
Elapsed: 00:00:00.6060042; Query Tuple Counts: 131072; ORM: FreeSql*
Elapsed: 00:00:00.4211323; Query ToList Counts: 131072; ORM: FreeSql*
Elapsed: 00:00:01.0236285; Query Dynamic Counts: 131072; ORM: FreeSql*
```
FreeSql ToList & Dapper Query
```shell
Elapsed: 00:00:00.6707125; ToList Entity Counts: 131072; ORM: FreeSql*
Elapsed: 00:00:00.6495301; Query Entity Counts: 131072; ORM: Dapper
```
[More..](https://github.com/dotnetcore/FreeSql/wiki/%e6%80%a7%e8%83%bd)
## 👯 Contributors
And other friends who made important suggestions for this project, they include:
[systemhejiyong](https://github.com/systemhejiyong),
[LambertW](https://github.com/LambertW),
[mypeng1985](https://github.com/mypeng1985),
[stulzq](https://github.com/stulzq),
[movingsam](https://github.com/movingsam),
[ALer-R](https://github.com/ALer-R),
[zouql](https://github.com/zouql),
深圳|凉茶,
[densen2014](https://github.com/densen2014),
[LiaoLiaoWuJu](https://github.com/LiaoLiaoWuJu),
[hd2y](https://github.com/hd2y),
[tky753](https://github.com/tky753),
[feijie999](https://github.com/feijie999),
constantine,
[JohnZhou2020](https://github.com/JohnZhou2020),
[mafeng8](https://github.com/mafeng8),
[VicBilibily](https://github.com/VicBilibily),
[Soar](https://github.com/sgf),
[quzhen91](https://github.com/quzhen91),
homejun,
[d4ilys](https://github.com/d4ilys) etc.
## 💕 Donation
L*y 58元、花花 88元、麦兜很乖 50元、网络来者 2000元、John 99.99元、alex 666元、bacongao 36元、无名 100元、Eternity 188元、无名 10元、⌒.Helper~..oO 66元、习惯与被习惯 100元、无名 100元、蔡易喋 88.88元、中讯科技 1000元、Good Good Work 24元、Nothing 100元、兰州天擎赵 500元、哈利路亚 300元、
无名 100元、蛰伏 99.99元、TCYM 66.66元、MOTA 5元、LDZXG 30元、Near 30元、建爽 66元、无名 200元、LambertWu 100元、无名 18.88元、乌龙 50元、无名 100元、陳怼怼 66.66元、陳怼怼 66.66元、丁淮 100元、李伟坚-Excel催化剂 100元、白狐 6.66元、她微笑的脸y 30元、Eternity²º²¹ 588元、夜归柴门 88元、蔡易喋 666.66元、
*礼 10元、litrpa 88元、Alax CHOW 200元、Daily 66元、k\*t 66元、蓝 100元、*菜 10元、生命如歌 1000元、山鸡 88元、平凡 100元、大树 1000元、软软的毛毛虫 66.66元、问卷星 2000元、与你无关 5000元
> Thank you for your donation
- [Alipay](https://www.cnblogs.com/FreeSql/gallery/image/338860.html)
- [WeChat](https://www.cnblogs.com/FreeSql/gallery/image/338859.html)
## 🗄 License
[MIT](LICENSE)