BlazarTech.QueryableValues.SqlServer 3.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package BlazarTech.QueryableValues.SqlServer --version 3.1.0                
NuGet\Install-Package BlazarTech.QueryableValues.SqlServer -Version 3.1.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="BlazarTech.QueryableValues.SqlServer" Version="3.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add BlazarTech.QueryableValues.SqlServer --version 3.1.0                
#r "nuget: BlazarTech.QueryableValues.SqlServer, 3.1.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install BlazarTech.QueryableValues.SqlServer as a Cake Addin
#addin nuget:?package=BlazarTech.QueryableValues.SqlServer&version=3.1.0

// Install BlazarTech.QueryableValues.SqlServer as a Cake Tool
#tool nuget:?package=BlazarTech.QueryableValues.SqlServer&version=3.1.0                

QueryableValues CI/CD Workflow

This library improves the efficiency of some types of queries in Entity Framework Core when using the SQL Server Database Provider.

The provided AsQueryableValues extension method on the DbContext class allows us to efficiently compose an IEnumerable<T> in our queries when it consist of non-constant values. It returns an IQueryable<T> that in the context of a query can be treated as any other entity in our DbContext. Everything is evaluated on the server.

The supported types for T are: Int32, Int64, Decimal, Double, DateTime, DateTimeOffset, Guid, and String.

For a detailed explanation, please continue reading here.

When Should I Use It?

The AsQueryableValues extension method is intended for queries that are dependent on a non-constant sequence of external values. In this case, the underline SQL query will be efficient on subsequent executions.

Getting Started

Installation

QueryableValues is distributed as a NuGet Package. The major version number of this library is aligned with the version of Entity Framework Core that's supported by it; for example, if you are using EF Core 5, then you must use version 5 of QueryableValues.

Please choose the appropriate command below to install it using the NuGet Package Manager Console window in Visual Studio:

EF Core Command
3.x Install-Package BlazarTech.QueryableValues.SqlServer -Version 3.1.0
5.x Install-Package BlazarTech.QueryableValues.SqlServer -Version 5.1.0
6.x Install-Package BlazarTech.QueryableValues.SqlServer -Version 6.1.0

Configuration

Look for the place in your code where you are setting up your DbContext and calling the UseSqlServer extension method, then use a lambda expression to access the SqlServerDbContextOptionsBuilder provided by it. It is on this builder that you must call the UseQueryableValues extension method, as shown in the following simplified examples:

When using the OnConfiguring method inside your DbContext:

using BlazarTech.QueryableValues;

public class MyDbContext : DbContext
{
    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseSqlServer(
            "MyConnectionString",
            sqlServerOptionsBuilder =>
            {
                sqlServerOptionsBuilder.UseQueryableValues();
            }
        );
    }
}

When setting up the DbContext at registration time using dependency injection:

using BlazarTech.QueryableValues;

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddDbContext<MyDbContext>(optionsBuilder => {
            optionsBuilder.UseSqlServer(
                "MyConnectionString",
                sqlServerOptionsBuilder =>
                {
                    sqlServerOptionsBuilder.UseQueryableValues();
                }
            );
        });
    }
}

How Do I Use It?

The AsQueryableValues extension method is provided by the BlazarTech.QueryableValues namespace, therefore, you must add the following using directive to your source code file in order for it to appear as a method of your DbContext instance.

using BlazarTech.QueryableValues;

Below are two patterns that you can use to retrieve data from an entity based on values provided by an IEnumerable<T>.

Using the Contains LINQ method

// Sample values.
IEnumerable<int> values = Enumerable.Range(1, 10);

// Example #1 (LINQ method syntax)
var myQuery1 = dbContext.MyEntities
    .Where(i => dbContext
        .AsQueryableValues(values)
        .Contains(i.MyEntityID)
    )
    .Select(i => new
    {
        i.MyEntityID,
        i.PropA
    });

// Example #2 (LINQ query syntax)
var myQuery2 = 
    from i in dbContext.MyEntities
    where dbContext
        .AsQueryableValues(values)
        .Contains(i.MyEntityID)
    select new
    {
        i.MyEntityID,
        i.PropA
    });

Using the Join LINQ method

// Sample values.
IEnumerable<int> values = Enumerable.Range(1, 10);

// Example #1 (LINQ method syntax)
var myQuery1 = dbContext.MyEntities
    .Join(
        dbContext.AsQueryableValues(values),
        i => i.MyEntityID,
        v => v,
        (i, v) => new
        {
            i.MyEntityID,
            i.PropA
        }
    );

// Example #2 (LINQ query syntax)
var myQuery2 = 
    from i in dbContext.MyEntities
    join v in dbContext.AsQueryableValues(values) on i.MyEntityID equals v 
    select new
    {
        i.MyEntityID,
        i.PropA
    });

Do You Want to Know More? 📚

Please take a look at the repository here.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
8.1.1 58,869 2/8/2024
8.1.0 9,763 12/7/2023
8.0.0 1,828 11/26/2023
7.4.3 98,050 2/8/2024
7.4.2 2,189 12/7/2023
7.4.1 6,218 11/26/2023
7.4.0 58,570 6/25/2023
7.3.0 3,973 5/20/2023
7.2.0 3,737 3/27/2023
7.1.0 2,313 3/14/2023
7.0.0 16,142 11/13/2022
7.0.0-preview.2 181 9/3/2022
7.0.0-preview.1 146 8/7/2022
6.9.3 2,427 2/8/2024
6.9.2 14,573 12/7/2023
6.9.1 161 11/26/2023
6.9.0 13,015 6/25/2023
6.8.0 101,200 5/20/2023
6.7.0 3,611 3/27/2023
6.6.0 595 3/14/2023
6.5.0 95,336 9/3/2022
6.4.0 7,344 7/14/2022
6.3.0 11,575 1/4/2022
6.2.0 375 12/27/2021
6.1.0 353 12/9/2021
6.0.0 1,055 12/6/2021
5.9.3 158 2/8/2024
5.9.2 162 12/7/2023
5.9.1 144 11/26/2023
5.9.0 188 6/25/2023
5.8.0 185 5/20/2023
5.7.0 250 3/27/2023
5.6.0 328 3/14/2023
5.5.0 1,845 9/3/2022
5.4.0 1,098 7/14/2022
5.3.0 31,822 1/4/2022
5.2.0 353 12/27/2021
5.1.0 358 12/9/2021
5.0.0 351 12/6/2021
3.9.3 130 2/8/2024
3.9.2 148 12/7/2023
3.9.1 154 11/26/2023
3.9.0 270 6/25/2023
3.8.0 190 5/20/2023
3.7.0 265 3/27/2023
3.6.0 271 3/14/2023
3.5.0 465 9/3/2022
3.4.0 494 7/14/2022
3.3.0 1,454 1/4/2022
3.2.0 303 12/27/2021
3.1.0 340 12/9/2021
3.0.0 436 12/6/2021