Show / Hide Table of Contents

Class RedisAggregation

An aggregation pipeline.

Inheritance
System.Object
RedisAggregation
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 RedisAggregation

Constructors

| Improve this Doc View Source

RedisAggregation(String)

Initializes a new instance of the RedisAggregation class.

Declaration
public RedisAggregation(string indexName)
Parameters
Type Name Description
System.String indexName

The index being queried.

Properties

| Improve this Doc View Source

IndexName

Gets the index to run the aggregation on.

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

Limit

Gets or sets the limit.

Declaration
public LimitPredicate Limit { get; set; }
Property Value
Type Description
LimitPredicate
| Improve this Doc View Source

Predicates

Gets the predicates to use for the aggregation.

Declaration
public Stack<IAggregationPredicate> Predicates { get; }
Property Value
Type Description
System.Collections.Generic.Stack<IAggregationPredicate>
| Improve this Doc View Source

Query

Gets or sets the query predicate.

Declaration
public QueryPredicate Query { get; set; }
Property Value
Type Description
QueryPredicate

Methods

| Improve this Doc View Source

Serialize()

serializes the aggregation into an array of arguments for redis.

Declaration
public string[] Serialize()
Returns
Type Description
System.String[]

The serialized arguments.

  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX