diff --git a/README.md b/README.md new file mode 100644 index 00000000..97c891ac --- /dev/null +++ b/README.md @@ -0,0 +1,221 @@ +

🦄 FreeSql

+ +FreeSql is a powerful O/RM component, supports .NET Core 2.1+, .NET Framework 4.0+, and Xamarin. + +[![Member project of .NET Core Community](https://img.shields.io/badge/member%20project%20of-NCC-9e20c9.svg)](https://github.com/dotnetcore) +[![nuget](https://img.shields.io/nuget/v/FreeSql.svg?style=flat-square)](https://www.nuget.org/packages/FreeSql) +[![stats](https://img.shields.io/nuget/dt/FreeSql.svg?style=flat-square)](https://www.nuget.org/stats/packages/FreeSql?groupby=Version) +[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/2881099/FreeSql/master/LICENSE.txt) + +

+ English | + 中文 +

+ +
+ +- 🛠 Support CodeFirst mode, support data migration even when using Access database. +- 💻 Support DbFirst mode, support import entity class from database, or use [Entity Class Generation Tool](https://github.com/2881099/FreeSql/wiki/DbFirst) to generate entity class. +- ⛳ Support advanced type mapping, such as PostgreSQL array type, etc. +- ✒ Support large number of expression functions, and highly customizable analysis. +- 🏁 Support Support one-to-many and many-to-many greedy loading of navigation properties, and lazy loading. +- 📃 Support Read/Write separation, Splitting Table/Database, Filters, Optimistic Locking and pessimistic locking. +- 🌳 Support MySql/SqlServer/PostgreSQL/Oracle/Sqlite/Firebird/达梦/人大金仓/神舟通用/翰高/Access, etc. + +QQ Groups:4336577(full)、**8578575(available)**、**52508226(available)** + +## 📚 Documentation + +| | | +| - | - | +| |  [Introduction](https://www.cnblogs.com/FreeSql/p/11531300.html)  \|  [Select](https://github.com/2881099/FreeSql/wiki/%e6%9f%a5%e8%af%a2)  \|  [Update](https://github.com/2881099/FreeSql/wiki/%e4%bf%ae%e6%94%b9)  \|  [Insert](https://github.com/2881099/FreeSql/wiki/%e6%b7%bb%e5%8a%a0)  \|  [Delete](https://github.com/2881099/FreeSql/wiki/%e5%88%a0%e9%99%a4)  | +| |  [Expression Functions](https://github.com/2881099/FreeSql/wiki/%e8%a1%a8%e8%be%be%e5%bc%8f%e5%87%bd%e6%95%b0)  \|  [CodeFirst](https://github.com/2881099/FreeSql/wiki/CodeFirst)  \|  [DbFirst](https://github.com/2881099/FreeSql/wiki/DbFirst)  \|  [Filters](https://github.com/2881099/FreeSql/wiki/%e8%bf%87%e6%bb%a4%e5%99%a8)  | +| |  [Repository](https://github.com/2881099/FreeSql/wiki/Repository)  \|  [UnitOfWork](https://github.com/2881099/FreeSql/wiki/%e5%b7%a5%e4%bd%9c%e5%8d%95%e5%85%83)  \|  [AOP](https://github.com/2881099/FreeSql/wiki/AOP)  \|  [DbContext](https://github.com/2881099/FreeSql/wiki/DbContext)  | +| |  [Read/Write Separation](https://github.com/2881099/FreeSql/wiki/%e8%af%bb%e5%86%99%e5%88%86%e7%a6%bb)  \|  [Splitting Table/Database](https://github.com/2881099/FreeSql/wiki/%e5%88%86%e8%a1%a8%e5%88%86%e5%ba%93)  \|  [Mysterious Technology](https://github.com/2881099/FreeSql/wiki/%E9%AA%9A%E6%93%8D%E4%BD%9C)  \|  [FAQ](https://github.com/dotnetcore/FreeSql/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98)  \|  [*Update Notes*](https://github.com/2881099/FreeSql/wiki/%e6%9b%b4%e6%96%b0%e6%97%a5%e5%bf%97)  | + +> FreeSql provides a variety of usage habits, and there is always one that suits you: + +- Use FreeSql, keep the original usage. +- Use [FreeSql.Repository](https://github.com/2881099/FreeSql/wiki/Repository), for those who are accustomed to storage models and work units. +- Use [FreeSql.DbContext](https://github.com/2881099/FreeSql/wiki/DbContext), a bit like how efcore is used. +- Or use [FreeSql.BaseEntity](https://github.com/2881099/FreeSql/tree/master/Examples/base_entity), which is extremely simple. + +> Some open source projects that use FreeSql: + +- [Zhontai.net Admin, Management System](https://github.com/zhontai/Admin.Core) +- [A simple and practical CMS implemented by .NET Core](https://github.com/luoyunchong/lin-cms-dotnetcore) +- [iusaas.com SaaS, Enterprise Application Management System](https://github.com/alonsoalon/TenantSite.Server) +- [EasyCms, CMS management system used by enterprises and institutions](https://github.com/jasonyush/EasyCMS) +- [Content management system](https://github.com/hejiyong/fscms) + +

+ +

+ +## 🚀 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.AsSelect().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.AsSelect().Any(t => t.Parent.Id == t.UserId)) + .Count(out var total) + .Page(page, size) + .OrderByDescending(a => a.Id) + .ToList() +``` +[More..](https://github.com/2881099/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(); +``` +[More..](https://github.com/2881099/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.EnableAddOrUpdateNavigateList = 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/2881099/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), 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元、炽焰 6.6元、Nothing 100元、兰州天擎赵 500元、哈利路亚 300元、 +无名 100元、蛰伏 99.99元、TCYM 66.66元、MOTA 5元、LDZXG 30元、Near 30元、建爽 66元、无名 200元、LambertWu 100元、无名 18.88元、乌龙 50元 + +> 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) diff --git a/readme.md b/README.zh-CN.md similarity index 64% rename from readme.md rename to README.zh-CN.md index 4125cb4c..bd36ca3d 100644 --- a/readme.md +++ b/README.zh-CN.md @@ -1,18 +1,30 @@ -## 🦄  FreeSql +

🦄 FreeSql

-[![nuget](https://img.shields.io/nuget/v/FreeSql.svg?style=flat-square)](https://www.nuget.org/packages/FreeSql) [![stats](https://img.shields.io/nuget/dt/FreeSql.svg?style=flat-square)](https://www.nuget.org/stats/packages/FreeSql?groupby=Version) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/2881099/FreeSql/master/LICENSE.txt) +FreeSql 是一款功能强大的对象关系映射(O/RM)组件,支持 .NET Core 2.1+、.NET Framework 4.0+ 以及 Xamarin。 -FreeSql 是功能强大的对象关系映射技术(O/RM),支持 .NETCore 2.1+ 或 .NETFramework 4.0+ 或 Xamarin。 +[![Member project of .NET Core Community](https://img.shields.io/badge/member%20project%20of-NCC-9e20c9.svg)](https://github.com/dotnetcore) +[![nuget](https://img.shields.io/nuget/v/FreeSql.svg?style=flat-square)](https://www.nuget.org/packages/FreeSql) +[![stats](https://img.shields.io/nuget/dt/FreeSql.svg?style=flat-square)](https://www.nuget.org/stats/packages/FreeSql?groupby=Version) +[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/2881099/FreeSql/master/LICENSE.txt) -- [x] 支持 CodeFirst 迁移,哪怕使用 Access 数据库也支持; -- [x] 支持 DbFirst 从数据库导入实体类,[安装实体类生成工具](https://github.com/2881099/FreeSql/wiki/DbFirst); -- [x] 支持 深入的类型映射,比如pgsql的数组类型; -- [x] 支持 丰富的表达式函数,以及灵活的自定义解析; -- [x] 支持 导航属性一对多、多对多贪婪加载,以及延时加载; -- [x] 支持 读写分离、分表分库、过滤器、乐观锁、悲观锁; -- [x] 支持 MySql/SqlServer/PostgreSQL/Oracle/Sqlite/Firebird/达梦/人大金仓/神舟通用/翰高/Access; +

+ English | + 中文 +

-## 📚  Documentation +
+ +- 🛠 支持 CodeFirst 模式,即便使用 Access 数据库也支持数据迁移; +- 💻 支持 DbFirst 模式,支持从数据库导入实体类,或使用[实体类生成工具](https://github.com/2881099/FreeSql/wiki/DbFirst)生成实体类; +- ⛳ 支持 深入的类型映射,比如 PgSql 的数组类型等; +- ✒ 支持 丰富的表达式函数,以及灵活的自定义解析; +- 🏁 支持 导航属性一对多、多对多贪婪加载,以及延时加载; +- 📃 支持 读写分离、分表分库、过滤器、乐观锁、悲观锁; +- 🌳 支持 MySql/SqlServer/PostgreSQL/Oracle/Sqlite/Firebird/达梦/人大金仓/神舟通用/翰高/Access 等数据库; + +QQ群:4336577(已满)、8578575(在线)、52508226(在线) + +## 📚 文档 | | | | - | - | @@ -23,10 +35,10 @@ FreeSql 是功能强大的对象关系映射技术(O/RM),支持 .NETCore 2.1+ > FreeSql 提供多种使用习惯,请根据实际情况选择团队合适的一种: -- 要么FreeSql,原始用法; -- 要么[FreeSql.Repository](https://github.com/2881099/FreeSql/wiki/Repository),仓储+工作单元习惯; -- 要么[FreeSql.DbContext](https://github.com/2881099/FreeSql/wiki/DbContext),有点像efcore的使用习惯; -- 要么[FreeSql.BaseEntity](https://github.com/2881099/FreeSql/tree/master/Examples/base_entity),求简单使用这个; +- 要么 FreeSql,原始用法; +- 要么 [FreeSql.Repository](https://github.com/2881099/FreeSql/wiki/Repository),仓储+工作单元习惯; +- 要么 [FreeSql.DbContext](https://github.com/2881099/FreeSql/wiki/DbContext),有点像 EFCore 的使用习惯; +- 要么 [FreeSql.BaseEntity](https://github.com/2881099/FreeSql/tree/master/Examples/base_entity),求简单使用这个; > 示范项目 @@ -40,7 +52,7 @@ FreeSql 是功能强大的对象关系映射技术(O/RM),支持 .NETCore 2.1+

-## 🚀  Quick start +## 🚀 快速入门 > dotnet add package FreeSql.Provider.Sqlite @@ -79,22 +91,22 @@ class Tag { } ``` -## 🔎  Query +### 🔎 Query (查询) ```csharp //OneToOne、ManyToOne fsql.Select().Where(a => a.Parent.Parent.Name == "粤语").ToList(); //OneToMany -fsql.Select().IncludeMany(a => a.Tags, then => then.Where(sub => sub.Name == "xxx")).ToList(); +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 == "xxx")) + .IncludeMany(a => a.Tags, then => then.Where(sub => sub.Name == "foo")) .Where(s => s.Tags.AsSelect().Any(t => t.Name == "国语")) .ToList(); //Other -fsql.Select() +fsql.Select() .Where(a => a.IsDelete == 0) .WhereIf(keyword != null, a => a.UserName.Contains(keyword)) .WhereIf(role_id > 0, a => a.RoleId == role_id) @@ -104,7 +116,7 @@ fsql.Select() .OrderByDescending(a => a.Id) .ToList() ``` -[More..](https://github.com/2881099/FreeSql/wiki/%e6%9f%a5%e8%af%a2) +[更多信息](https://github.com/2881099/FreeSql/wiki/%e6%9f%a5%e8%af%a2) ```csharp fsql.Select().Where(a => new[] { 1, 2, 3 }.Contains(a.Id)).ToList(); @@ -113,9 +125,9 @@ fsql.Select().Where(a => a.CreateTime.Date == DateTime.Today).ToList(); fsql.Select().OrderBy(a => Guid.NewGuid()).Limit(10).ToList(); ``` -[More..](https://github.com/2881099/FreeSql/wiki/%e8%a1%a8%e8%be%be%e5%bc%8f%e5%87%bd%e6%95%b0) +[更多信息](https://github.com/2881099/FreeSql/wiki/%e8%a1%a8%e8%be%be%e5%bc%8f%e5%87%bd%e6%95%b0) -## 🚁  Repository +### 🚁 Repository (仓储) > dotnet add package FreeSql.Repository @@ -136,11 +148,12 @@ public void Add() { } ``` -参考:[在 asp.net core 中使用 TransactionalAttribute + UnitOfWorkManager 实现多种事务传播](https://github.com/dotnetcore/FreeSql/issues/289) +参考:[在 ASP.NET Core 中使用 `TransactionalAttribute` + `UnitOfWorkManager` 实现多种事务传播](https://github.com/dotnetcore/FreeSql/issues/289) -## 💪  Performance +## 💪 Performance (性能) + +FreeSql Query 与 Dapper Query 的对比: -FreeSql Query & Dapper Query ```shell Elapsed: 00:00:00.6733199; Query Entity Counts: 131072; ORM: Dapper @@ -157,43 +170,53 @@ 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 +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/2881099/FreeSql/wiki/%e6%80%a7%e8%83%bd) +[更多信息](https://github.com/2881099/FreeSql/wiki/%e6%80%a7%e8%83%bd) -## 👯  Contributors +## 👯 Contributors (贡献者) -[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) + + + -QQ群:4336577(已满)、8578575(在线)、52508226(在线) +以及其他为本项目提出重要建议的朋友们,他们包括: -## 💕  Donation +[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) 等。 + + +## 💕 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元、炽焰 6.6元、Nothing 100元、兰州天擎赵 500元、哈利路亚 300元、 无名 100元、蛰伏 99.99元、TCYM 66.66元、MOTA 5元、LDZXG 30元、Near 30元、建爽 66元、无名 200元、LambertWu 100元、无名 18.88元、乌龙 50元 -> 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) \ No newline at end of file