CoreEx/src/CoreEx.EntityFrameworkCore/EfDbExtensions.cs at main · Avanade/CoreEx · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
namespace CoreEx.EntityFrameworkCore;

/// <summary>
/// Provides <see href="https://learn.microsoft.com/en-us/ef/core/">Entity Framework Core</see> extensions.
/// </summary>
public static partial class EfDbExtensions
{
    /// <summary>
    /// Creates a <typeparamref name="TColl"/> from a <typeparamref name="TSource"/> <see cref="IQueryable{TSource}"/> using the specified <paramref name="mapper"/>.
    /// </summary>
    /// <typeparam name="TSource">The source <see cref="Type"/>.</typeparam>
    /// <typeparam name="TColl">The item collection <see cref="Type"/>.</typeparam>
    /// <typeparam name="TItem">The item <see cref="Type"/>.</typeparam>
    /// <param name="query">The <see cref="IQueryable{TSource}"/>.</param>
    /// <param name="mapper">The mapping <see cref="Func{TSource, TItem}"/>.</param>
    /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
    public static async Task<TColl> ToMappedItemsAsync<TSource, TColl, TItem>(this IQueryable<TSource> query, Func<TSource, TItem> mapper, CancellationToken cancellationToken = default) where TColl : ICollection<TItem>, new()
    {
        mapper.ThrowIfNull();

        var q = query.ThrowIfNull();
        var items = new TColl();

        await foreach (var source in q.AsAsyncEnumerable().WithCancellation(cancellationToken).ConfigureAwait(false))
        {
            items.Add(mapper(source));
        }

        return items;
    }

    /// <summary>
    /// Creates a <typeparamref name="TColl"/> from a <typeparamref name="TSource"/> <see cref="IQueryable{TSource}"/> using the specified <paramref name="mapper"/>.
    /// </summary>
    /// <typeparam name="TSource">The source <see cref="Type"/>.</typeparam>
    /// <typeparam name="TColl">The item collection <see cref="Type"/>.</typeparam>
    /// <typeparam name="TItem">The item <see cref="Type"/>.</typeparam>
    /// <param name="query">The <see cref="IQueryable{TSource}"/>.</param>
    /// <param name="mapper">The mapping <see cref="IMapper{TSource, TItem}"/>.</param>
    /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
    public static async Task<TColl> ToMappedItemsAsync<TSource, TColl, TItem>(this IQueryable<TSource> query, IMapper<TSource, TItem> mapper, CancellationToken cancellationToken = default) where TSource : class where TColl : ICollection<TItem>, new() where TItem : class
    {
        mapper.ThrowIfNull();
        return await ToMappedItemsAsync<TSource, TColl, TItem>(query, source => mapper.Map(source)!, cancellationToken).ConfigureAwait(false);
    }

    /// <summary>
    /// Creates a <see cref="List{TItem}"/> from a <typeparamref name="TSource"/> <see cref="IQueryable{TSource}"/> using the specified <paramref name="mapper"/>.
    /// </summary>
    /// <typeparam name="TSource">The source <see cref="Type"/>.</typeparam>
    /// <typeparam name="TItem">The item <see cref="Type"/>.</typeparam>
    /// <param name="query">The <see cref="IQueryable{TSource}"/>.</param>
    /// <param name="mapper">The mapping <see cref="Func{TSource, TItem}"/>.</param>
    /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
    public static async Task<List<TItem>> ToMappedItemsAsync<TSource, TItem>(this IQueryable<TSource> query, Func<TSource, TItem> mapper, CancellationToken cancellationToken = default)
    {
        mapper.ThrowIfNull();

        var q = query.ThrowIfNull();
        var items = new List<TItem>();

        await foreach (var source in q.AsAsyncEnumerable().WithCancellation(cancellationToken).ConfigureAwait(false))
        {
            items.Add(mapper(source));
        }

        return items;
    }

    /// <summary>
    /// Creates a <see cref="List{TItem}"/> from a <typeparamref name="TSource"/> <see cref="IQueryable{TSource}"/> using the specified <paramref name="mapper"/>.
    /// </summary>
    /// <typeparam name="TSource">The source <see cref="Type"/>.</typeparam>
    /// <typeparam name="TItem">The item <see cref="Type"/>.</typeparam>
    /// <param name="query">The <see cref="IQueryable{TSource}"/>.</param>
    /// <param name="mapper">The mapping <see cref="IMapper{TSource, TItem}"/>.</param>
    /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
    public static async Task<List<TItem>> ToMappedItemsAsync<TSource, TItem>(this IQueryable<TSource> query, IMapper<TSource, TItem> mapper, CancellationToken cancellationToken = default) where TSource : class where TItem : class
    {
        mapper.ThrowIfNull();
        return await ToMappedItemsAsync(query, source => mapper.Map(source)!, cancellationToken).ConfigureAwait(false);
    }

    /// <summary>
    /// Creates a <see cref="ItemsResult{TItem}"/> from an <see cref="IQueryable{TItem}"/> applying <paramref name="paging"/> (including with <see cref="PagingResult.TotalCount"/> where requested).
    /// </summary>
    /// <typeparam name="TItem">The item <see cref="Type"/>.</typeparam>
    /// <param name="query">The <see cref="IQueryable{TItem}"/>.</param>
    /// <param name="paging">The <see cref="PagingArgs"/>.</param>
    /// <param name="autoCount">Indicates whether to perform the <see cref="PagingResult.TotalCount"/> query automatically.</param>
    /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
    /// <returns>The resulting <see cref="ItemsResult{TItem}"/>.</returns>
    /// <remarks>The <paramref name="autoCount"/> indicates whether the <see cref="PagingResult.TotalCount"/> query should be automatically executed using the <paramref name="query"/> before the <paramref name="paging"/>
    /// is applied and <see cref="PagingArgs.IsCountRequested"/>. This is opt-in as not all LINQ implementations support the reuse of the query, or allow counthing where ordering has previously been applied.</remarks>
    public static async Task<ItemsResult<TItem>> ToItemsResultAsync<TItem>(this IQueryable<TItem> query, PagingArgs? paging = null, bool autoCount = true, CancellationToken cancellationToken = default)
    {
        var q = query.ThrowIfNull();
        var ir = new ItemsResult<TItem>(paging)
        {
            Items = await q.WithPaging(paging).ToArrayAsync(cancellationToken).ConfigureAwait(false)
        };

        // When auto-counting and requested to do so, then execute a count.
        if (autoCount)
            await ir.WithTotalCountAsync(async cancellationToken => await query.LongCountAsync(cancellationToken).ConfigureAwait(false), cancellationToken).ConfigureAwait(false);

        return ir;
    }

    /// <summary>
    /// Creates a <see cref="ItemsResult{TItem}"/> from a <typeparamref name="TSource"/> <see cref="IQueryable{TSource}"/> applying <paramref name="paging"/> (including with <see cref="PagingResult.TotalCount"/> where requested).
    /// </summary>
    /// <typeparam name="TSource">The source <see cref="Type"/>.</typeparam>
    /// <typeparam name="TItem">The item <see cref="Type"/>.</typeparam>
    /// <param name="query">The <see cref="IQueryable{TSource}"/>.</param>
    /// <param name="mapper">The mapping <see cref="Func{TSource, TItem}"/>.</param>
    /// <param name="paging">The <see cref="PagingArgs"/>.</param>
    /// <param name="autoCount">Indicates whether to perform the <see cref="PagingResult.TotalCount"/> query automatically.</param>
    /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
    /// <returns>The resulting <see cref="ItemsResult{TItem}"/>.</returns>
    /// <remarks>The <paramref name="autoCount"/> indicates whether the <see cref="PagingResult.TotalCount"/> query should be automatically executed using the <paramref name="query"/> before the <paramref name="paging"/>
    /// is applied and <see cref="PagingArgs.IsCountRequested"/>. This is opt-in as not all LINQ implementations support the reuse of the query, or allow counthing where ordering has previously been applied.</remarks>
    public static async Task<ItemsResult<TItem>> ToMappedItemsResultAsync<TSource, TItem>(this IQueryable<TSource> query, Func<TSource, TItem> mapper, PagingArgs? paging = null, bool autoCount = true, CancellationToken cancellationToken = default)
    {
        var q = query.ThrowIfNull();
        var ir = new ItemsResult<TItem>(paging)
        {
            Items = await ToMappedItemsAsync(q.WithPaging(paging), mapper, cancellationToken).ConfigureAwait(false)
        };

        // When auto-counting and requested to do so, then execute a count.
        if (autoCount)
            await ir.WithTotalCountAsync(async cancellationToken => await query.LongCountAsync(cancellationToken).ConfigureAwait(false), cancellationToken).ConfigureAwait(false);

        return ir;
    }

    /// <summary>
    /// Creates a <see cref="ItemsResult{TItem}"/> from a <typeparamref name="TSource"/> <see cref="IQueryable{TSource}"/> applying <paramref name="paging"/> (including with <see cref="PagingResult.TotalCount"/> where requested).
    /// </summary>
    /// <typeparam name="TSource">The source <see cref="Type"/>.</typeparam>
    /// <typeparam name="TItem">The item <see cref="Type"/>.</typeparam>
    /// <param name="query">The <see cref="IQueryable{TSource}"/>.</param>
    /// <param name="mapper">The mapping <see cref="IMapper{TSource, TItem}"/>.</param>
    /// <param name="paging">The <see cref="PagingArgs"/>.</param>
    /// <param name="autoCount">Indicates whether to perform the <see cref="PagingResult.TotalCount"/> query automatically.</param>
    /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
    /// <returns>The resulting <see cref="ItemsResult{TItem}"/>.</returns>
    /// <remarks>The <paramref name="autoCount"/> indicates whether the <see cref="PagingResult.TotalCount"/> query should be automatically executed using the <paramref name="query"/> before the <paramref name="paging"/>
    /// is applied and <see cref="PagingArgs.IsCountRequested"/>. This is opt-in as not all LINQ implementations support the reuse of the query, or allow counthing where ordering has previously been applied.</remarks>
    public static async Task<ItemsResult<TItem>> ToMappedItemsResultAsync<TSource, TItem>(this IQueryable<TSource> query, IMapper<TSource, TItem> mapper, PagingArgs? paging = null, bool autoCount = true, CancellationToken cancellationToken = default) where TSource : class where TItem : class
    {
        mapper.ThrowIfNull();
        return await query.ToMappedItemsResultAsync(source => mapper.Map(source)!, paging, autoCount, cancellationToken).ConfigureAwait(false);
    }
}