Class RedisAggregationSet<T>

A collection that you can use to run aggregations in redis.

Inheritance
System.Object
RedisAggregationSet<T>
GroupedAggregationSet<T>
Implements
System.Linq.IQueryable<AggregationResult<T>>
System.Collections.Generic.IEnumerable<AggregationResult<T>>
System.Linq.IQueryable
System.Collections.IEnumerable
System.Collections.Generic.IAsyncEnumerable<AggregationResult<T>>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Redis.OM.Aggregation
Assembly: Redis.OM.dll
Syntax
public class RedisAggregationSet<T> : IQueryable<AggregationResult<T>>, IEnumerable<AggregationResult<T>>, IQueryable, IEnumerable, IAsyncEnumerable<AggregationResult<T>>
Type Parameters
Name Description
T

The type of the record shell in the aggregation result.

Constructors

| Improve this Doc View Source

RedisAggregationSet(IRedisConnection, Boolean, Int32)

Initializes a new instance of the RedisAggregationSet<T> class.

Declaration
public RedisAggregationSet(IRedisConnection connection, bool useCursor = false, int chunkSize = 1000)
Parameters
Type Name Description
IRedisConnection connection

the connection to use.
System.Boolean useCursor

whether or not to use a cursor.
System.Int32 chunkSize

Size of the chunks to use during pagination, larger chunks return larger payloads but with fewer round trips.

Properties

| Improve this Doc View Source

ElementType

Declaration
public Type ElementType { get; }
Property Value
Type Description
System.Type
| Improve this Doc View Source

Expression

Declaration
public Expression Expression { get; }
Property Value
Type Description
System.Linq.Expressions.Expression
| Improve this Doc View Source

Provider

Declaration
public IQueryProvider Provider { get; }
Property Value
Type Description
System.Linq.IQueryProvider

Methods

| Improve this Doc View Source

GetAsyncEnumerator(CancellationToken)

Declaration
public IAsyncEnumerator<AggregationResult<T>> GetAsyncEnumerator(CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Collections.Generic.IAsyncEnumerator<AggregationResult<T>>
| Improve this Doc View Source

GetEnumerator()

Declaration
public IEnumerator<AggregationResult<T>> GetEnumerator()
Returns
Type Description
System.Collections.Generic.IEnumerator<AggregationResult<T>>
| Improve this Doc View Source

ToArrayAsync()

Materializes the set as an array asynchronously.

Declaration
public async ValueTask<AggregationResult<T>[]> ToArrayAsync()
Returns
Type Description
System.Threading.Tasks.ValueTask<AggregationResult<T>[]>

a task that will resolve when the array is enumerated.
| Improve this Doc View Source

ToListAsync()

Materializes the set as a list asynchronously.

Declaration
public async ValueTask<List<AggregationResult<T>>> ToListAsync()
Returns
Type Description
System.Threading.Tasks.ValueTask<System.Collections.Generic.List<AggregationResult<T>>>

a task that will resolve when the list is enumerated.

Explicit Interface Implementations

| Improve this Doc View Source

IEnumerable.GetEnumerator()

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator

Implements

System.Linq.IQueryable<T>
System.Collections.Generic.IEnumerable<T>
System.Linq.IQueryable
System.Collections.IEnumerable
System.Collections.Generic.IAsyncEnumerable<T>

Extension Methods