com.mongodb.client.model

Class Aggregates

java.lang.Object

com.mongodb.client.model.Aggregates

public final class Aggregates
extends Object

Builders for aggregation pipeline stages.

Since:

3.1

MongoDB documentation

Aggregation pipeline

Since server release

2.2

Method Summary

Modifier and Type	Method and Description
static <TExpression> Bson	group(TExpression id, BsonField... fieldAccumulators) Creates a $group pipeline stage for the specified filter
static <TExpression> Bson	group(TExpression id, List<BsonField> fieldAccumulators) Creates a $group pipeline stage for the specified filter
static Bson	limit(int limit) Creates a $limit pipeline stage for the specified filter
static Bson	lookup(String from, String localField, String foreignField, String as) Creates a $lookup pipeline stage for the specified filter
static Bson	match(Bson filter) Creates a $match pipeline stage for the specified filter
static Bson	out(String collectionName) Creates a $out pipeline stage for the specified filter
static Bson	project(Bson projection) Creates a $project pipeline stage for the specified projection
static Bson	sample(int size) Creates a $sample pipeline stage with the specified sample size
static Bson	skip(int skip) Creates a $skip pipeline stage
static Bson	sort(Bson sort) Creates a $sort pipeline stage for the specified sort specification
static Bson	unwind(String fieldName) Creates a $unwind pipeline stage for the specified field name, which must be prefixed by a '$' sign.
static Bson	unwind(String fieldName, UnwindOptions unwindOptions) Creates a $unwind pipeline stage for the specified field name, which must be prefixed by a '$' sign.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

match

public static Bson match(Bson filter)

Creates a $match pipeline stage for the specified filter

Parameters:

filter - the filter to match

Returns:

the $match pipeline stage

See Also:

Filters

MongoDB documentation

$match

project

public static Bson project(Bson projection)

Creates a $project pipeline stage for the specified projection

Parameters:

projection - the projection

Returns:

the $project pipeline stage

See Also:

Projections

MongoDB documentation

$project

sort

public static Bson sort(Bson sort)

Creates a $sort pipeline stage for the specified sort specification

Parameters:

sort - the sort specification

Returns:

the $sort pipeline stage

See Also:

Sorts

MongoDB documentation

$sort

skip

public static Bson skip(int skip)

Creates a $skip pipeline stage

Parameters:

skip - the number of documents to skip

Returns:

the $skip pipeline stage

MongoDB documentation

$skip

limit

public static Bson limit(int limit)

Creates a $limit pipeline stage for the specified filter

Parameters:

limit - the limit

Returns:

the $limit pipeline stage

MongoDB documentation

$limit

lookup

public static Bson lookup(String from,
                          String localField,
                          String foreignField,
                          String as)

Creates a $lookup pipeline stage for the specified filter

Parameters:

from - the name of the collection in the same database to perform the join with.

localField - specifies the field from the local collection to match values against.

foreignField - specifies the field in the from collection to match values against.

as - the name of the new array field to add to the input documents.

Returns:

the $lookup pipeline stage

Since:

3.2

MongoDB documentation

$lookup

Since server release

3.2

group

public static <TExpression> Bson group(TExpression id,
                                       BsonField... fieldAccumulators)

Creates a $group pipeline stage for the specified filter

Type Parameters:

TExpression - the expression type

Parameters:

id - the id expression for the group

fieldAccumulators - zero or more field accumulator pairs

Returns:

the $group pipeline stage

MongoDB documentation

$group

Expressions

group

public static <TExpression> Bson group(TExpression id,
                                       List<BsonField> fieldAccumulators)

Creates a $group pipeline stage for the specified filter

Type Parameters:

TExpression - the expression type

Parameters:

id - the id expression for the group

fieldAccumulators - zero or more field accumulator pairs

Returns:

the $group pipeline stage

MongoDB documentation

$group

Expressions

unwind

public static Bson unwind(String fieldName)

Creates a $unwind pipeline stage for the specified field name, which must be prefixed by a '$' sign.

Parameters:

fieldName - the field name, prefixed by a '$' sign

Returns:

the $unwind pipeline stage

MongoDB documentation

$unwind

unwind

public static Bson unwind(String fieldName,
                          UnwindOptions unwindOptions)

Creates a $unwind pipeline stage for the specified field name, which must be prefixed by a '$' sign.

Parameters:

fieldName - the field name, prefixed by a '$' sign

unwindOptions - options for the unwind pipeline stage

Returns:

the $unwind pipeline stage

Since:

3.2

MongoDB documentation

$unwind

Since server release

3.2

out

public static Bson out(String collectionName)

Creates a $out pipeline stage for the specified filter

Parameters:

collectionName - the collection name

Returns:

the $out pipeline stage

MongoDB documentation

$out

Since server release

2.6

sample

public static Bson sample(int size)

Creates a $sample pipeline stage with the specified sample size

Parameters:

size - the sample size

Returns:

the $sample pipeline stage

Since:

3.2

MongoDB documentation

$sample

Since server release

3.2