Class Aggregate<ResultType>

constructor

• new Aggregate<ResultType>(): Aggregate<ResultType>

• Type Parameters

  • ResultType

  Returns Aggregate<ResultType>

[toStringTag]

catch

finally

options

then

[asyncIterator]

• [asyncIterator](): AsyncIterableIterator<Unpacked<ResultType>>

• Returns an asyncIterator for use with for/await/of loops You do not need to call this function explicitly, the JavaScript runtime will call it for you.

  Returns AsyncIterableIterator<Unpacked<ResultType>>

addCursorFlag

• addCursorFlag(flag, value): Aggregate<ResultType>

• Sets an option on this aggregation. This function will be deprecated in a future release.

  Parameters

  • flag: mongoose.CursorFlag

  • value: boolean

  Returns Aggregate<ResultType>

  Deprecated

addFields

• addFields(arg): Aggregate<ResultType>

• Appends a new $addFields operator to this aggregate pipeline. Requires MongoDB v3.4+ to work

  Parameters

  • arg: Record<string, any>

  Returns Aggregate<ResultType>

allowDiskUse

• allowDiskUse(value): Aggregate<ResultType>

• Sets the allowDiskUse option for the aggregation query

  Parameters

  • value: boolean

  Returns Aggregate<ResultType>

append

• append(...args): Aggregate<ResultType>

• Appends new operators to this aggregate pipeline

  Parameters

  • Rest ...args: PipelineStage[]

    Rest

  Returns Aggregate<ResultType>

collation

• collation(options): Aggregate<ResultType>

• Set the collation.

  Parameters

  • options: CollationOptions

  Returns Aggregate<ResultType>

count

• count(fieldName): Aggregate<ResultType>

• Appends a new $count operator to this aggregate pipeline.

  Parameters

  • fieldName: string

  Returns Aggregate<ResultType>

cursor

• cursor<DocType>(options?): Cursor<DocType, never>

• Sets the cursor option for the aggregation query

  Type Parameters

  • DocType = any

  Parameters

  • Optional options: Record<string, unknown>

    Optional

  Returns Cursor<DocType, never>

densify

• densify(arg): Aggregate<ResultType>

• Appends a new $densify operator to this aggregate pipeline

  Parameters

  • arg: {
        field: string;
        partitionByFields?: string[];
        range: {
            bounds: number[] | "partition" | Date[] | "full";
            step: number;
            unit?: "second" | "millisecond" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year";
        };
    }

    • field: string

    • Optional partitionByFields?: string[]

    • range: {
          bounds: number[] | "partition" | Date[] | "full";
          step: number;
          unit?: "second" | "millisecond" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year";
      }

      • bounds: number[] | "partition" | Date[] | "full"

      • step: number

      • Optional unit?: "second" | "millisecond" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year"

  Returns Aggregate<ResultType>

exec

• exec(): Promise<ResultType>

• Executes the aggregate pipeline on the currently bound Model.

  Returns Promise<ResultType>

explain

• explain(verbosity): Promise<AnyObject>

• Execute the aggregation with explain

  Parameters

  • verbosity: ExplainVerbosityLike

  Returns Promise<AnyObject>
• explain(): Promise<AnyObject>

• Returns Promise<AnyObject>

facet

• facet(options): Aggregate<ResultType>

• Combines multiple aggregation pipelines.

  Parameters

  • options: Record<string, FacetPipelineStage[]>

  Returns Aggregate<ResultType>

fill

• fill(arg): Aggregate<ResultType>

• Appends a new $fill operator to this aggregate pipeline

  Parameters

  • arg: {
        output: Record<string, {
            value: any;
        } | {
            method: "linear" | "locf";
        }>;
        partitionBy?: any;
        partitionByFields?: string[];
        sortBy?: Record<string, 1 | -1>;
    }

    • output: Record<string, {
          value: any;
      } | {
          method: "linear" | "locf";
      }>

    • Optional partitionBy?: any

    • Optional partitionByFields?: string[]

    • Optional sortBy?: Record<string, 1 | -1>

  Returns Aggregate<ResultType>

graphLookup

• graphLookup(options): Aggregate<ResultType>

• Appends new custom $graphLookup operator(s) to this aggregate pipeline, performing a recursive search on a collection.

  Parameters

  • options: {
        as: string;
        connectFromField: string;
        connectToField: string;
        depthField?: string;
        from: string;
        maxDepth?: number;
        restrictSearchWithMatch?: AnyObject;
        startWith: any;
    }

    • as: string

    • connectFromField: string

    • connectToField: string

    • Optional depthField?: string

    • from: string

    • Optional maxDepth?: number

    • Optional restrictSearchWithMatch?: AnyObject

    • startWith: any

  Returns Aggregate<ResultType>

group

• group(arg): Aggregate<ResultType>

• Appends new custom $group operator to this aggregate pipeline.

  Parameters

  • arg: {
        _id: any;
    } | {
        [key: string]: AccumulatorOperator;
    }

  Returns Aggregate<ResultType>

hint

• hint(value): Aggregate<ResultType>

• Sets the hint option for the aggregation query

  Parameters

  • value: string | Record<string, unknown>

  Returns Aggregate<ResultType>

limit

• limit(num): Aggregate<ResultType>

• Appends a new $limit operator to this aggregate pipeline.

  Parameters

  • num: number

    maximum number of records to pass to the next stage

  Returns Aggregate<ResultType>

lookup

• lookup(options): Aggregate<ResultType>

• Appends new custom $lookup operator to this aggregate pipeline.

  Parameters

  • options: {
        as: string;
        foreignField?: string;
        from: string;
        let?: Record<string, any>;
        localField?: string;
        pipeline?: (AddFields | Bucket | BucketAuto | mongoose.PipelineStage.CollStats | mongoose.PipelineStage.Count | Densify | Facet | Fill | GeoNear | GraphLookup | Group | IndexStats | Limit | ListSessions | Lookup | Match | PlanCacheStats | mongoose.PipelineStage.Project | Redact | ReplaceRoot | ReplaceWith | Sample | Search | SearchMeta | Set | SetWindowFields | Skip | mongoose.PipelineStage.Sort | SortByCount | UnionWith | Unset | Unwind)[];
    }

    • as: string

    • Optional foreignField?: string

    • from: string

    • Optional let?: Record<string, any>

    • Optional localField?: string

    • Optional pipeline?: (AddFields | Bucket | BucketAuto | mongoose.PipelineStage.CollStats | mongoose.PipelineStage.Count | Densify | Facet | Fill | GeoNear | GraphLookup | Group | IndexStats | Limit | ListSessions | Lookup | Match | PlanCacheStats | mongoose.PipelineStage.Project | Redact | ReplaceRoot | ReplaceWith | Sample | Search | SearchMeta | Set | SetWindowFields | Skip | mongoose.PipelineStage.Sort | SortByCount | UnionWith | Unset | Unwind)[]

  Returns Aggregate<ResultType>

match

• match(arg): Aggregate<ResultType>

• Appends a new custom $match operator to this aggregate pipeline.

  Parameters

  • arg: FilterQuery<any>

    $match operator contents

  Returns Aggregate<ResultType>

model

• model(model): Aggregate<ResultType>

• Binds this aggregate to a model.

  Parameters

  • model: mongoose.Model<any, {}, {}, {}, any, any>

    the model to which the aggregate is to be bound

  Returns Aggregate<ResultType>
• model(): mongoose.Model<any, {}, {}, {}, any, any>

• Returns the current model bound to this aggregate object

  Returns mongoose.Model<any, {}, {}, {}, any, any>

near

• near(arg): Aggregate<ResultType>

• Appends a new $geoNear operator to this aggregate pipeline.

  Parameters

  • arg: {
        distanceField: string;
        distanceMultiplier?: number;
        includeLocs?: string;
        key?: string;
        maxDistance?: number;
        minDistance?: number;
        near: [number, number] | {
            coordinates: [number, number];
            type: "Point";
        };
        num?: number;
        query?: AnyObject;
        spherical?: boolean;
    }

    • distanceField: string

    • Optional distanceMultiplier?: number

    • Optional includeLocs?: string

    • Optional key?: string

    • Optional maxDistance?: number

    • Optional minDistance?: number

    • near: [number, number] | {
          coordinates: [number, number];
          type: "Point";
      }

    • Optional num?: number

      Deprecated. Use only with MondoDB below 4.2 (removed in 4.2)

      Deprecated

    • Optional query?: AnyObject

    • Optional spherical?: boolean

  Returns Aggregate<ResultType>

option

• option(value): Aggregate<ResultType>

• Lets you set arbitrary options, for middlewares or plugins.

  Parameters

  • value: mongoose.AggregateOptions

  Returns Aggregate<ResultType>

pipeline

• pipeline(): PipelineStage[]

• Returns the current pipeline

  Returns PipelineStage[]

project

• project(arg): Aggregate<ResultType>

• Appends a new $project operator to this aggregate pipeline.

  Parameters

  • arg: {
        [field: string]: AnyExpression | Expression | mongoose.PipelineStage.Project["$project"];
    }

    • [field: string]: AnyExpression | Expression | mongoose.PipelineStage.Project["$project"]

  Returns Aggregate<ResultType>

read

• read(pref): Aggregate<ResultType>

• Sets the readPreference option for the aggregation query.

  Parameters

  • pref: ReadPreferenceLike

  Returns Aggregate<ResultType>

readConcern

• readConcern(level): Aggregate<ResultType>

• Sets the readConcern level for the aggregation query.

  Parameters

  • level: string

  Returns Aggregate<ResultType>

redact

• redact(expression, thenExpr, elseExpr): Aggregate<ResultType>

• Appends a new $redact operator to this aggregate pipeline.

  Parameters

  • expression: any

  • thenExpr: AnyObject | "$$DESCEND" | "$$PRUNE" | "$$KEEP"

  • elseExpr: AnyObject | "$$DESCEND" | "$$PRUNE" | "$$KEEP"

  Returns Aggregate<ResultType>

replaceRoot

• replaceRoot(newRoot): Aggregate<ResultType>

• Appends a new $replaceRoot operator to this aggregate pipeline.

  Parameters

  • newRoot: any

  Returns Aggregate<ResultType>

sample

• sample(arg): Aggregate<ResultType>

• Appends new custom $sample operator to this aggregate pipeline.

  Parameters

  • arg: number

  Returns Aggregate<ResultType>

search

• search(options): Aggregate<ResultType>

• Helper for Atlas Text Search's $search stage.

  Parameters

  • options: {
        highlight?: {
            maxCharsToExamine?: number;
            maxNumPassages?: number;
            path: string | string[] | {
                multi: string;
                value: string;
            };
        };
        index?: string;
        [operator: string]: any;
    }

    • [operator: string]: any

    • Optional highlight?: {
          maxCharsToExamine?: number;
          maxNumPassages?: number;
          path: string | string[] | {
              multi: string;
              value: string;
          };
      }

      • Optional maxCharsToExamine?: number

      • Optional maxNumPassages?: number

      • path: string | string[] | {
            multi: string;
            value: string;
        }

        highlightPath reference

    • Optional index?: string

  Returns Aggregate<ResultType>

session

• session(session): Aggregate<ResultType>

• Sets the session for this aggregation. Useful for transactions.

  Parameters

  • session: mongoose.mongo.ClientSession

  Returns Aggregate<ResultType>

skip

• skip(num): Aggregate<ResultType>

• Appends a new $skip operator to this aggregate pipeline.

  Parameters

  • num: number

    number of records to skip before next stage

  Returns Aggregate<ResultType>

sort

• sort(arg): Aggregate<ResultType>

• Appends a new $sort operator to this aggregate pipeline.

  Parameters

  • arg: string | Record<string, SortOrder> | Record<string, 1 | -1 | Meta>

  Returns Aggregate<ResultType>

sortByCount

• sortByCount(arg): Aggregate<ResultType>

• Appends a new $sortByCount operator to this aggregate pipeline. Accepts either a string field name or a pipeline object.

  Parameters

  • arg: any

  Returns Aggregate<ResultType>

unionWith

• unionWith(options): Aggregate<ResultType>

• Appends new $unionWith operator to this aggregate pipeline.

  Parameters

  • options: string | {
        coll: string;
        pipeline?: (AddFields | Bucket | BucketAuto | mongoose.PipelineStage.CollStats | mongoose.PipelineStage.Count | Densify | Facet | Fill | GeoNear | GraphLookup | Group | IndexStats | Limit | ListSessions | Lookup | Match | PlanCacheStats | mongoose.PipelineStage.Project | Redact | ReplaceRoot | ReplaceWith | Sample | Search | SearchMeta | Set | SetWindowFields | Skip | mongoose.PipelineStage.Sort | SortByCount | UnionWith | Unset | Unwind)[];
    }

  Returns Aggregate<ResultType>

unwind

• unwind(...args): Aggregate<ResultType>

• Appends new custom $unwind operator(s) to this aggregate pipeline.

  Parameters

  • Rest ...args: (string | {
        includeArrayIndex?: string;
        path: string;
        preserveNullAndEmptyArrays?: boolean;
    })[]

    Rest

  Returns Aggregate<ResultType>