https://github.com/sqlkata/querybuilder
SQL query builder, written in c#, helps you build complex queries easily, supports SqlServer, MySql, PostgreSql, Oracle, Sqlite and Firebird
https://github.com/sqlkata/querybuilder
activerecord c-sharp csharp data-access-layer database mysql postgresql query-builder sql sql-query sql-query-builder sql-server
Last synced: 5 days ago
JSON representation
SQL query builder, written in c#, helps you build complex queries easily, supports SqlServer, MySql, PostgreSql, Oracle, Sqlite and Firebird
- Host: GitHub
- URL: https://github.com/sqlkata/querybuilder
- Owner: sqlkata
- License: mit
- Created: 2017-05-08T09:11:27.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2025-02-02T21:16:03.000Z (2 months ago)
- Last Synced: 2025-04-09T17:16:12.062Z (5 days ago)
- Topics: activerecord, c-sharp, csharp, data-access-layer, database, mysql, postgresql, query-builder, sql, sql-query, sql-query-builder, sql-server
- Language: C#
- Homepage: https://sqlkata.com
- Size: 823 KB
- Stars: 3,214
- Watchers: 123
- Forks: 512
- Open Issues: 148
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome - sqlkata/querybuilder - SQL query builder, written in c#, helps you build complex queries easily, supports SqlServer, MySql, PostgreSql, Oracle, Sqlite and Firebird (C\#)
- awesome-starred-test - sqlkata/querybuilder - SQL query builder, written in c#, helps you build complex queries easily, supports SqlServer, MySql, PostgreSql, Oracle, Sqlite and Firebird (C# #)
- Awesome-Nuget-Packages - **SqlKata**
- fucking-awesome-dotnet-core - SqlKata - Elegant Sql Query Builder, that supports complex queries, joins, sub queries, nested where conditions, vendor engine targets and more (Frameworks, Libraries and Tools / Query Builders)
- awesome-dotnet-core - SqlKata - Elegant Sql Query Builder, that supports complex queries, joins, sub queries, nested where conditions, vendor engine targets and more (Frameworks, Libraries and Tools / Query Builders)
- awesome-dotnet-core - SqlKata - Elegant Sql Query Builder, that supports complex queries, joins, sub queries, nested where conditions, vendor engine targets and more (Frameworks, Libraries and Tools / Query Builders)
- awesome-dotnet-core - SqlKata - 优雅的Sql查询生成器，支持复杂查询，连接，子查询，嵌套条件，供应商引擎目标等等 (框架, 库和工具 / sql生成器)
README
SqlKata Query Builder
Follow and Upvote SqlKata on Product Hunt to encourage the development of this project
https://private-user-images.githubusercontent.com/2517523/408899411-1f9ff89b-ed17-4d02-ae2f-afc1c66a5932.mp4
## 🚀 Introduction
SqlKata Query Builder is a powerful SQL query builder written in C#. It is secure, framework-agnostic, and inspired by top query builders like Laravel Query Builder and Knex.
### ✨ Key Features
- **Expressive API**: Clean and intuitive syntax similar to SQL.
- **Database Agnostic**: Work with multiple databases using a unified API.
- **Complex Queries**: Supports nested conditions, subqueries, conditional statements, and more.
- **Execution Support**: Use the SqlKata.Execution package to execute queries with Dapper.
## Installation
```sh
$ dotnet add package SqlKata
$ dotnet add package SqlKata.Execution # (optional) If you want the execution support
```
## Quick Examples
### Setup Connection
```cs
var connection = new SqlConnection("...");
var compiler = new SqlCompiler();
var db = new QueryFactory(connection, compiler);
```
> `QueryFactory` is provided by the SqlKata.Execution package.
### Retrieve all records
```cs
var books = db.Query("Books").Get();
```
### Retrieve published books only
```cs
var books = db.Query("Books").WhereTrue("IsPublished").Get();
```
### Retrieve one book
```cs
var introToSql = db.Query("Books").Where("Id", 145).Where("Lang", "en").First();
```
### Retrieve recent books: last 10
```cs
var recent = db.Query("Books").OrderByDesc("PublishedAt").Limit(10).Get();
```
### Include Author information
```cs
var books = db.Query("Books")
.Include(db.Query("Authors")) // Assumes that the Books table has an `AuthorId` column
.Get();
```
This will include the property "Author" on each "Book":
```jsonc
[{
"Id": 1,
"PublishedAt": "2019-01-01",
"AuthorId": 2,
"Author": { // <-- included property
"Id": 2,
"...": ""
}
}]
```
### Join with authors table
```cs
var books = db.Query("Books")
.Join("Authors", "Authors.Id", "Books.AuthorId")
.Select("Books.*", "Authors.Name as AuthorName")
.Get();
foreach(var book in books)
{
Console.WriteLine($"{book.Title}: {book.AuthorName}");
}
```
### Conditional queries
```cs
var isFriday = DateTime.Today.DayOfWeek == DayOfWeek.Friday;
var books = db.Query("Books")
.When(isFriday, q => q.WhereIn("Category", new [] {"OpenSource", "MachineLearning"}))
.Get();
```
### Pagination
```cs
var page1 = db.Query("Books").Paginate(10);
foreach(var book in page1.List)
{
Console.WriteLine(book.Name);
}
...
var page2 = page1.Next();
```
### Insert
```cs
int affected = db.Query("Users").Insert(new {
Name = "Jane",
CountryId = 1
});
```
### Update
```cs
int affected = db.Query("Users").Where("Id", 1).Update(new {
Name = "Jane",
CountryId = 1
});
```
### Delete
```cs
int affected = db.Query("Users").Where("Id", 1).Delete();
```
## FAQ
### How to know when a new release or a feature is available?
I announce updates on my [Twitter Account](https://twitter.com/ahmadmuzavi), and you can subscribe to our newsletters from the website [https://sqlkata.com](https://sqlkata.com).
### The database that I want is not supported. Why?
It's impossible to support all available database vendors, which is why we focus on the major ones. We encourage you to create your own compiler for your database.
### Do you accept new compilers?
Unfortunately, no. The reason is that this would add overhead for the project contributors. We prefer to improve the quality of the existing compilers instead.
### How can I support the project?
- ⭐ Star the project here on GitHub, and share it with your friends.
- 🐱💻 Follow and upvote it on Product Hunt:
- 💰 You can also donate to support the project financially on open collection.