dotnet-dynamic-linq/README.md

92 lines
2.4 KiB
Markdown
Raw Normal View History

2018-02-11 20:52:44 -05:00
# DynamicLinq
Adds extensions to Linq to offer dynamic queryables.
2018-02-11 21:42:05 -05:00
2018-02-13 12:31:06 -05:00
## Roadmap
Check "Projects" section of github to see whats going on.
2018-02-13 12:32:23 -05:00
2018-02-13 12:32:02 -05:00
https://github.com/PoweredSoft/DynamicLinq/projects/1
2018-02-11 21:42:05 -05:00
2018-02-12 22:31:49 -05:00
## Samples
2018-02-11 21:42:05 -05:00
Complex Query
2018-02-11 21:44:19 -05:00
```csharp
2018-02-11 21:42:05 -05:00
query = query.Query(q =>
{
q.Compare("AuthorId", ConditionOperators.Equal, 1);
q.And(sq =>
{
sq.Compare("Content", ConditionOperators.Equal, "World");
sq.Or("Title", ConditionOperators.Contains, 3);
});
});
2018-02-11 21:42:55 -05:00
```
2018-02-12 22:33:01 -05:00
### Simple Query
2018-02-11 21:44:19 -05:00
```csharp
2018-02-11 21:42:55 -05:00
query.Where("FirstName", ConditionOperators.Equal, "David");
2018-02-11 21:44:19 -05:00
```
2018-02-12 04:18:42 -05:00
2018-02-12 22:33:01 -05:00
### Simple Sorting
2018-02-12 05:20:15 -05:00
```csharp
query = query.OrderByDescending("AuthorId");
query = query.ThenBy("Id");
```
2018-02-12 22:33:01 -05:00
### Collection Filtering
2018-02-12 22:31:49 -05:00
You don't have to Worry about it.
2018-02-12 23:23:43 -05:00
The library will do it for you.
2018-02-12 22:28:35 -05:00
```csharp
var query = authors.AsQueryable();
query = query.Query(qb =>
{
qb.NullChecking();
2018-02-12 22:31:49 -05:00
// you can specify here which collection handling you wish to use Any and All is supported for now.
2018-02-12 22:28:35 -05:00
qb.And("Posts.Comments.Email", ConditionOperators.Equal, "john.doe@me.com", collectionHandling: QueryCollectionHandling.Any);
});
```
2018-02-12 22:34:09 -05:00
### Null Checking is automatic (practical for in memory dynamic queries)
2018-02-12 22:31:49 -05:00
```csharp
var query = authors.AsQueryable();
query = query.Query(qb =>
{
qb.NullChecking();
qb.And("Posts.Comments.Email", ConditionOperators.Equal, "john.doe@me.com", collectionHandling: QueryCollectionHandling.Any);
});
```
2018-02-12 22:33:01 -05:00
### Using Query Builder
2018-02-12 04:18:42 -05:00
```csharp
// subject.
var posts = new List<Post>()
{
new Post { Id = 1, AuthorId = 1, Title = "Hello 1", Content = "World" },
new Post { Id = 2, AuthorId = 1, Title = "Hello 2", Content = "World" },
new Post { Id = 3, AuthorId = 2, Title = "Hello 3", Content = "World" },
};
// the query.
var query = posts.AsQueryable();
var queryBuilder = new QueryBuilder<Post>(query);
queryBuilder.Compare("AuthorId", ConditionOperators.Equal, 1);
queryBuilder.And(subQuery =>
{
subQuery.Compare("Content", ConditionOperators.Equal, "World");
subQuery.Or("Title", ConditionOperators.Contains, 3);
});
query = queryBuilder.Build();
2018-02-12 23:23:43 -05:00
```
2018-02-14 00:13:01 -05:00
### Entity Framework
Using PoweredSoft.DynamicLinq.EntityFramework it adds an helper that allows you to do the following.
```csharp
var context = new <YOUR CONTEXT>();
var queryable = context.Query(typeof(Author), q => q.Compare("FirstName", ConditionOperators.Equal, "David"));
var result = queryable.ToListAsync().Result;
var first = result.FirstOrDefault() as Author;
Assert.AreEqual(first?.FirstName, "David");
```