Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Awesome Lists containing this project

README 

        


    SqlKata Query Builder





    

    

    

    

    Twitter		






Follow and Upvote SqlKata on Product Hunt to encourage the development of this project





SqlKata - Dynamic Sql query builder for dotnet | Product Hunt




![Quick Demo](https://i.imgur.com/jOWD4vk.gif)



SqlKata Query Builder is a powerful Sql Query Builder written in C#.



It's secure and framework agnostic. Inspired by the top Query Builders available, like Laravel Query Builder and Knex.



SqlKata has an expressive API. it follows a clean naming convention, which is very similar to the SQL syntax.



By providing a level of abstraction over the supported database engines, that allows you to work with multiple databases with the same unified API.



SqlKata supports complex queries, such as nested conditions, selection from SubQuery, filtering over SubQueries, Conditional Statements and others. Currently, it has built-in compilers for SqlServer, MySql, PostgreSQL, and Firebird.



The SqlKata.Execution package provides the ability to submit the queries to the database, using [Dapper](https://github.com/StackExchange/Dapper) under the covers.



Checkout the full documentation on [https://sqlkata.com](https://sqlkata.com)



## 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 have a `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



### The database that I want is not supported. Why?

It's impossible to support all available database vendors, this is why we focus on the major ones, and we encourage you to create your own compiler for your database.



### Do you accept new compilers?

Unfortunately, no, the reason is this will 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 in Github, and share it with your friends

- Follow and upvote it on Product Hunt SqlKata - Dynamic Sql query builder for dotnet | Product Hunt

- You can also donate to support the project financially on open collection.