EfCoreQueryOptions<T> Class

Definition

Namespace

Savvyio.Extensions.EFCore

Assemblies

Savvyio.Extensions.EFCore.dll

Source

src/Savvyio.Extensions.EFCore/EfCoreQueryOptions.cs

Specifies options that is related to EfCoreDataStore<T>.

public class EfCoreQueryOptions<T> : AsyncOptions, IAsyncOptions, IParameterObject

Type Parameters

T

Inheritance

object

AsyncOptions

EfCoreQueryOptions<T>

Implements

IAsyncOptions

IParameterObject

Inherited Members

AsyncOptions.CancellationToken

AsyncOptions.CancellationTokenProvider

Examples

EfCoreQueryOptions<T> carries the EF Core query predicate and ordering settings used by EfCoreDataStore<T, TContext> read operations. Configure the Predicate, Ordering, and MaxRows properties to control the result set. The example sets up a filtered query for pending orders and verifies the options are applied.

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Microsoft.EntityFrameworkCore;
using Savvyio;
using Savvyio.Extensions.EFCore;

namespace ExampleApp;

public sealed class ProductFiltering
{
    public Task<IEnumerable<Product>> LoadActiveProductsAsync()
    {
        var query = new EfCoreQueryOptions<Product>
        {
            Predicate = product => product.IsActive
        };

        var source = new CatalogDataSource(new EfCoreDataSourceOptions
        {
            ContextConfigurator = builder => builder.EnableDetailedErrors(),
            ModelConstructor = modelBuilder => modelBuilder.Entity<Product>().HasKey(product => product.Id)
        });

        var store = new EfCoreDataStore<Product>(source);
        return store.FindAllAsync(options => options.Predicate = query.Predicate);
    }
}

public sealed class CatalogDataSource : EfCoreDataSource
{
    public CatalogDataSource(EfCoreDataSourceOptions options) : base(options)
    {
    }
}

public sealed class Product : IIdentity<Guid>
{
    public Product(Guid id, string name, bool isActive)
    {
        Id = id;
        Name = name;
        IsActive = isActive;
    }

    public Guid Id { get; }

    public string Name { get; private set; } = string.Empty;

    public bool IsActive { get; private set; }
}

Constructors

Name	Description
EfCoreQueryOptions()	Initializes a new instance of the EfCoreQueryOptions<T> class.

Properties

Name	Description
Predicate	Gets or sets the predicate that matches one or more objects to retrieve in the associated IEfCoreDataSource.

See Also

AsyncOptions