Skip to content

Commit da0e8dc

Browse files
yv989cyv989c
committed
docs: some tlc
1 parent 88b7068 commit da0e8dc

File tree

2 files changed

+35
-25
lines changed

2 files changed

+35
-25
lines changed

‎README.md‎

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,20 @@
1010

1111
> 🤔💭 TLDR; By using QueryableValues, you can incorporate in-memory collections into your EF queries with outstanding performance and flexibility.
1212
13-
This library allows you to efficiently compose an [IEnumerable<T>] in your [Entity Framework Core] queries when using the [SQL Server Database Provider]. This is accomplished by using the `AsQueryableValues` extension method available on the [DbContext] class. Everything is evaluated on the server with a single round trip, in a way that preserves the query's [execution plan], even when the values behind the [IEnumerable<T>] are changed on subsequent executions.
13+
This library allows you to efficiently compose an [IEnumerable<T>] in your [Entity Framework Core] queries when using the [SQL Server Database Provider]. You can accomplish this by using the `AsQueryableValues` extension method that's available on the [DbContext] class. The query is processed in a single round trip to the server, in a way that preserves its [execution plan], even when the values within the [IEnumerable<T>] are changed on subsequent executions.
1414

15-
The supported types for `T` are:
16-
- Simple Type: [Byte], [Int16], [Int32], [Int64], [Decimal], [Single], [Double], [DateTime], [DateTimeOffset], [Guid], [Char], and [String].
17-
- Complex Type:
18-
- Can be an anonymous type.
19-
- Can be a user-defined class or struct with read/write properties and a public constructor.
20-
- Must have one or more simple type properties, including [Boolean].
15+
**Highlights**
16+
- ✨ Enables the composition of in-memory data within your queries, utilizing both simple and complex types.
17+
- 👌 Works with all versions of SQL Server supported by [Entity Framework Core].
18+
- ⚡ Automatically uses the most efficient strategy compatible with your SQL Server instance and database configuration.
19+
- ✅ Boasts over 140 tests for reliability and compatibility, giving you added confidence.
2120

2221
For a detailed explanation of the problem solved by QueryableValues, please continue reading [here][readme-background].
2322

24-
> ✅ QueryableValues boasts over 120 integration tests that are executed on every supported version of EF. These tests ensure reliability and compatibility, giving you added confidence.
25-
2623
> 💡 Still on Entity Framework 6 (non-core)? Then [QueryableValues `EF6 Edition`](https://github.com/yv989c/BlazarTech.QueryableValues.EF6) is what you need.
2724
2825
## When Should You Use It?
29-
The `AsQueryableValues` extension method is intended for queries that are dependent upon a *non-constant* sequence of external values. In such cases, the underlying SQL query will be efficient on subsequent executions.
30-
31-
It provides a solution to the following long standing [EF Core issue](https://github.com/dotnet/efcore/issues/13617) and enables other currently unsupported scenarios; like the ability to efficiently create joins with in-memory data.
26+
The `AsQueryableValues` extension method is intended for queries that are dependent upon a *non-constant* sequence of external values. It provides a solution to the following [EF Core issue](https://github.com/dotnet/efcore/issues/13617) and enables other currently unsupported scenarios; like the ability to efficiently create joins with in-memory data.
3227

3328
## Your Support is Appreciated!
3429
If you feel that this solution has provided you some value, please consider [buying me a ☕][BuyMeACoffee].
@@ -96,6 +91,10 @@ using BlazarTech.QueryableValues;
9691
Below are a few examples composing a query using the values provided by an [IEnumerable<T>].
9792

9893
### Simple Type Examples
94+
95+
> 💡 Supported types:
96+
> [Byte], [Int16], [Int32], [Int64], [Decimal], [Single], [Double], [DateTime], [DateTimeOffset], [Guid], [Char], and [String].
97+
9998
Using the [Contains][ContainsQueryable] LINQ method:
10099

101100
```c#
@@ -155,6 +154,12 @@ var myQuery2 =
155154
};
156155
```
157156
### Complex Type Example
157+
158+
> 💡 Requirements:
159+
> - Can be an anonymous type.
160+
> - Can be a user-defined class or struct with read/write properties and a public constructor.
161+
> - Must have one or more simple type properties, including [Boolean].
162+
158163
```c#
159164
// Performance Tip:
160165
// If your IEnumerable<T> item type (T) has many properties, project only
@@ -404,7 +409,7 @@ Now, focus your attention to the first query of the green section. Here you can
404409

405410
## What Makes This Work? 🤓
406411

407-
> 🎉 QueryableValues now supports JSON serialization, which improves its performance compared to using XML. By default, QueryableValues will attempt to use JSON if it is supported.
412+
> 🎉 QueryableValues now supports JSON serialization, which improves its performance compared to using XML. By default, QueryableValues will attempt to use JSON if it is supported by your SQL Server instance and database configuration.
408413
409414
QueryableValues makes use of the XML parsing capabilities in SQL Server, which are available in all the supported versions of SQL Server to date. The provided sequence of values are serialized as XML and embedded in the underlying SQL query using a native XML parameter, then it uses SQL Server's XML type methods to project the query in a way that can be mapped by [Entity Framework Core].
410415

‎docs/README.md‎

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,20 @@
66

77
> 🤔💭 TLDR; By using QueryableValues, you can incorporate in-memory collections into your EF queries with outstanding performance and flexibility.
88
9-
This library allows you to efficiently compose an [IEnumerable&lt;T&gt;] in your [Entity Framework Core] queries when using the [SQL Server Database Provider]. This is accomplished by using the `AsQueryableValues` extension method available on the [DbContext] class. Everything is evaluated on the server with a single round trip, in a way that preserves the query's [execution plan], even when the values behind the [IEnumerable&lt;T&gt;] are changed on subsequent executions.
9+
This library allows you to efficiently compose an [IEnumerable&lt;T&gt;] in your [Entity Framework Core] queries when using the [SQL Server Database Provider]. You can accomplish this by using the `AsQueryableValues` extension method that's available on the [DbContext] class. The query is processed in a single round trip to the server, in a way that preserves its [execution plan], even when the values within the [IEnumerable&lt;T&gt;] are changed on subsequent executions.
1010

11-
The supported types for `T` are:
12-
- Simple Type: [Byte], [Int16], [Int32], [Int64], [Decimal], [Single], [Double], [DateTime], [DateTimeOffset], [Guid], [Char], and [String].
13-
- Complex Type:
14-
- Can be an anonymous type.
15-
- Can be a user-defined class or struct with read/write properties and a public constructor.
16-
- Must have one or more simple type properties, including [Boolean].
11+
**Highlights**
12+
- ✨ Enables the composition of in-memory data within your queries, utilizing both simple and complex types.
13+
- 👌 Works with all versions of SQL Server supported by [Entity Framework Core].
14+
- ⚡ Automatically uses the most efficient strategy compatible with your SQL Server instance and database configuration.
15+
- ✅ Boasts over 140 tests for reliability and compatibility, giving you added confidence.
1716

1817
For a detailed explanation of the problem solved by QueryableValues, please continue reading [here][readme-background].
1918

20-
> ✅ QueryableValues boasts over 120 integration tests that are executed on every supported version of EF. These tests ensure reliability and compatibility, giving you added confidence.
21-
2219
> 💡 Still on Entity Framework 6 (non-core)? Then [QueryableValues `EF6 Edition`](https://github.com/yv989c/BlazarTech.QueryableValues.EF6) is what you need.
2320
2421
## When Should You Use It?
25-
The `AsQueryableValues` extension method is intended for queries that are dependent upon a *non-constant* sequence of external values. In such cases, the underlying SQL query will be efficient on subsequent executions.
26-
27-
It provides a solution to the following long standing [EF Core issue](https://github.com/dotnet/efcore/issues/13617) and enables other currently unsupported scenarios; like the ability to efficiently create joins with in-memory data.
22+
The `AsQueryableValues` extension method is intended for queries that are dependent upon a *non-constant* sequence of external values. It provides a solution to the following [EF Core issue](https://github.com/dotnet/efcore/issues/13617) and enables other currently unsupported scenarios; like the ability to efficiently create joins with in-memory data.
2823

2924
## Your Support is Appreciated!
3025
If you feel that this solution has provided you some value, please consider [buying me a ☕][BuyMeACoffee].
@@ -92,6 +87,10 @@ using BlazarTech.QueryableValues;
9287
Below are a few examples composing a query using the values provided by an [IEnumerable&lt;T&gt;].
9388

9489
### Simple Type Examples
90+
91+
> 💡 Supported types:
92+
> [Byte], [Int16], [Int32], [Int64], [Decimal], [Single], [Double], [DateTime], [DateTimeOffset], [Guid], [Char], and [String].
93+
9594
Using the [Contains][ContainsQueryable] LINQ method:
9695

9796
```c#
@@ -151,6 +150,12 @@ var myQuery2 =
151150
};
152151
```
153152
### Complex Type Example
153+
154+
> 💡 Requirements:
155+
> - Can be an anonymous type.
156+
> - Can be a user-defined class or struct with read/write properties and a public constructor.
157+
> - Must have one or more simple type properties, including [Boolean].
158+
154159
```c#
155160
// Performance Tip:
156161
// If your IEnumerable<T> item type (T) has many properties, project only

0 commit comments

Comments
 (0)