Home
Softono
FreeSql

FreeSql

Open source MIT C#
4.4K
Stars
905
Forks
153
Issues
146
Watchers
1 month
Last Commit

About FreeSql

FreeSql is a powerful object-relational mapping component for .NET, supporting .NET Core 2.1+, .NET Framework 4.0+, Xamarin, and AOT. It works with both C and VB.NET. It supports a wide range of databases including MySQL, PostgreSQL, SQL Server, Oracle, SQLite, Firebird, ClickHouse, DuckDB, TDengine, QuestDB, MsAccess, and Chinese databases like 达梦, 人大金仓, 神舟通用, 南大通用, 虚谷, 翰高, and 华为高斯. Key features include CodeFirst data migration, DbFirst entity generation from existing databases, advanced type mapping such as PostgreSQL array types, customizable expression functions, one-to-many and many-to-many navigation properties with eager and lazy loading, read-write separation, table and database splitting, global filters, and both optimistic and pessimistic locking. FreeSql offers flexible development modes including direct usage, Repository pattern with UnitOfWork, and a simple BaseEntity mode. It is suitable for building data-driven .NET applications across desktop, web, and mobile platforms r ...

Platforms

Web Self-hosted Windows

Languages

C#

🦄 FreeSql, The First AOT ORM!

FreeSql is a powerful O/RM component, supports .NET Core 2.1+, .NET Framework 4.0+, Xamarin, And AOT.

Member project of .NET Core Community nuget stats GitHub license

English | 中文

  • 🛠 Support CodeFirst data migration.
  • 💻 Support DbFirst import entity class from database, or use Generation Tool.
  • ⛳ 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  |  Select  |  Update  |  Insert  |  Delete  |  FAQ  
Expression  |  CodeFirst  |  DbFirst  |  Filters  |  AOP  
Repository  |  UnitOfWork  |  Dynamic Operations  |  ADO  
Read/Write  |  Splitting Table  |  Hide tech  |  Update Notes  

Please select a development mode:

Some open source projects that use FreeSql:

🚀 Quick start

dotnet add package FreeSql.Provider.Sqlite

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<Tag> 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<Song> Songs { get; set; }
  public ICollection<Tag> Tags { get; set; }
}

🔎 Query

//OneToOne、ManyToOne
fsql.Select<Tag>().Where(a => a.Parent.Parent.Name == "English").ToList();

//OneToMany
fsql.Select<Tag>().IncludeMany(a => a.Tags, then => then.Where(sub => sub.Name == "foo")).ToList();

//ManyToMany
fsql.Select<Song>()
  .IncludeMany(a => a.Tags, then => then.Where(sub => sub.Name == "foo"))
  .Where(s => s.Tags.Any(t => t.Name == "Chinese"))
  .ToList();

//Other
fsql.Select<YourType>()
  .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..

fsql.Select<Song>().Where(a => new[] { 1, 2, 3 }.Contains(a.Id)).ToList();

fsql.Select<Song>().Where(a => a.CreateTime.Date == DateTime.Today).ToList();

fsql.Select<Song>().OrderBy(a => Guid.NewGuid()).Limit(10).ToList();

fsql.Select<Song>().ToList(a => new
{
    a.Id,
    Tags = fsql.Select<Tag>().ToList(),
    SongTags = fsql.Select<SongTag>().Where(b => b.TopicId == a.Id).ToList()
});

More..

🚁 Repository

dotnet add package FreeSql.Repository

[Transactional]
public void Add() {
  var repo = ioc.GetService<BaseRepository<Tag>>();
  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.

💪 Performance

FreeSql Query & Dapper Query

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<Tuple> Counts: 131072; ORM: FreeSql*

Elapsed: 00:00:01.0236285; Query Dynamic Counts: 131072; ORM: FreeSql*

FreeSql ToList & Dapper Query

Elapsed: 00:00:00.6707125; ToList Entity Counts: 131072; ORM: FreeSql*

Elapsed: 00:00:00.6495301; Query Entity Counts: 131072; ORM: Dapper

More..

👯 Contributors

And other friends who made important suggestions for this project, they include:

systemhejiyong, LambertW, mypeng1985, stulzq, movingsam, ALer-R, zouql, 深圳|凉茶, densen2014, LiaoLiaoWuJu, hd2y, tky753, feijie999, constantine, JohnZhou2020, mafeng8, VicBilibily, Soar, quzhen91, homejun, d4ilys etc.

💕 Donation

Ly 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

🗄 License

MIT