org.litote.kmongo

Class AggregatesKt

org.litote.kmongo.AggregatesKt

public class AggregatesKt

Constructor Detail

AggregatesKt

public AggregatesKt()

Method Detail

addFields

@NotNull
public static org.bson.conversions.Bson addFields(@NotNull
                                                           com.mongodb.client.model.Field... fields)

Creates an $addFields pipeline stage

Parameters:

fields - the fields to add

Returns:

the $addFields pipeline stage

addFields

@NotNull
public static org.bson.conversions.Bson addFields(@NotNull
                                                           java.util.List<? extends com.mongodb.client.model.Field<?>> fields)

Creates an $addFields pipeline stage

Parameters:

fields - the fields to add

Returns:

the $addFields pipeline stage

bucket

@NotNull
public static <TExpression,Boundary> org.bson.conversions.Bson bucket(TExpression groupBy,
                                                                               @NotNull
                                                                               java.util.List<? extends Boundary> boundaries,
                                                                               @NotNull
                                                                               com.mongodb.client.model.BucketOptions options)

Creates a $bucket pipeline stage

Parameters:

groupBy - the criteria to group By

boundaries - the boundaries of the buckets

options - the optional values for the $bucket stage

Returns:

the $bucket pipeline stage

bucketAuto

@NotNull
public static <TExpression> org.bson.conversions.Bson bucketAuto(TExpression groupBy,
                                                                          int buckets,
                                                                          @NotNull
                                                                          com.mongodb.client.model.BucketAutoOptions options)

Creates a $bucketAuto pipeline stage

Parameters:

groupBy - the criteria to group By

buckets - the number of the buckets

options - the optional values for the $bucketAuto stage

Returns:

the $bucketAuto pipeline stage

count

@NotNull
public static <T> org.bson.conversions.Bson count(@NotNull
                                                           kotlin.reflect.KProperty<? extends T> $this$count)

Creates a $count pipeline stage using the named field to store the result

Returns:

the $count pipeline stage

match

@NotNull
public static org.bson.conversions.Bson match(@NotNull
                                                       org.bson.conversions.Bson filter)

Creates a $match pipeline stage for the specified filter

Parameters:

filter - the filter to match

Returns:

the $match pipeline stage

match

@NotNull
public static org.bson.conversions.Bson match(@NotNull
                                                       org.bson.conversions.Bson... filters)

Creates a $match pipeline stage with $and on each filter.

Returns:

the $project pipeline stage

document

@NotNull
public static org.bson.conversions.Bson document(@NotNull
                                                          org.bson.conversions.Bson... elements)

Produce a bson document with the specified elements.

Parameters:

elements - the element of the document (key:value)

Returns:

the document as Bson

document

@NotNull
public static org.bson.conversions.Bson document(@NotNull
                                                          java.util.Collection<? extends org.bson.conversions.Bson> elements)

Produce a bson document with the specified elements.

Parameters:

elements - the element of the document (key:value)

Returns:

the document as Bson

project

@NotNull
public static org.bson.conversions.Bson project(@NotNull
                                                         org.bson.conversions.Bson projection)

Creates a $project pipeline stage for the specified getProjection

Parameters:

projection - the getProjection

Returns:

the $project pipeline stage

project

@NotNull
public static org.bson.conversions.Bson project(@NotNull
                                                         kotlin.reflect.KProperty... properties)

Creates a $project pipeline stage for all specified properties

Parameters:

properties - the properties to project

Returns:

the $project pipeline stage

project

@NotNull
public static org.bson.conversions.Bson project(@NotNull
                                                         kotlin.Pair... properties)

Creates a $project pipeline stage for all specified properties

Parameters:

properties - the properties to project

Returns:

the $project pipeline stage

project

@NotNull
public static org.bson.conversions.Bson project(@NotNull
                                                         org.bson.conversions.Bson... projections)

Creates a $project pipeline stage for all specified properties

Parameters:

projections - the properties to project

Returns:

the $project pipeline stage

project

@NotNull
public static org.bson.conversions.Bson project(@NotNull
                                                         java.util.Map<? extends kotlin.reflect.KProperty<?>,? extends java.lang.Object> properties)

Creates a $project pipeline stage for all specified properties

Parameters:

properties - the properties to project

Returns:

the $project pipeline stage

sort

@NotNull
public static org.bson.conversions.Bson sort(@NotNull
                                                      org.bson.conversions.Bson sort)

Creates a $sort pipeline stage for the specified sort specification

Parameters:

sort - the sort specification

Returns:

the $sort pipeline stage

sortByCount

@NotNull
public static <TExpression> org.bson.conversions.Bson sortByCount(TExpression filter)

Creates a $sortByCount pipeline stage for the specified filter

Parameters:

filter - the filter specification

Returns:

the $sortByCount pipeline stage

skip

@NotNull
public static org.bson.conversions.Bson skip(int skip)

Creates a $skip pipeline stage

Parameters:

skip - the number of documents to skip

Returns:

the $skip pipeline stage

limit

@NotNull
public static org.bson.conversions.Bson limit(int limit)

Creates a $limit pipeline stage for the specified filter

Parameters:

limit - the limit

Returns:

the $limit pipeline stage

lookup

@NotNull
public static org.bson.conversions.Bson lookup(@NotNull
                                                        java.lang.String from,
                                                        @NotNull
                                                        java.lang.String localField,
                                                        @NotNull
                                                        java.lang.String foreignField,
                                                        @NotNull
                                                        java.lang.String newAs)

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.

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

Returns:

the $lookup pipeline stage

facet

@NotNull
public static org.bson.conversions.Bson facet(@NotNull
                                                       java.util.List<? extends com.mongodb.client.model.Facet> facets)

Creates a facet pipeline stage

Parameters:

facets - the facets to use

Returns:

the new pipeline stage

facet

@NotNull
public static org.bson.conversions.Bson facet(@NotNull
                                                       com.mongodb.client.model.Facet... facets)

Creates a facet pipeline stage

Parameters:

facets - the facets to use

Returns:

the new pipeline stage

graphLookup

@NotNull
public static <TExpression> org.bson.conversions.Bson graphLookup(@NotNull
                                                                           java.lang.String from,
                                                                           TExpression startWith,
                                                                           @NotNull
                                                                           java.lang.String connectFromField,
                                                                           @NotNull
                                                                           java.lang.String connectToField,
                                                                           @NotNull
                                                                           java.lang.String fieldAs,
                                                                           @NotNull
                                                                           com.mongodb.client.model.GraphLookupOptions options)

Creates a graphLookup pipeline stage for the specified filter

Parameters:

from - the collection to query

startWith - the expression to start the graph lookup with

connectFromField - the from field

connectToField - the to field

fieldAs - name of field in output document

options - optional values for the graphLookup

Returns:

the $graphLookup pipeline stage

group

@NotNull
public static <TExpression> org.bson.conversions.Bson group(TExpression id,
                                                                     @NotNull
                                                                     com.mongodb.client.model.BsonField... fieldAccumulators)

Creates a $group pipeline stage for the specified filter

Parameters:

id - the id expression for the group

fieldAccumulators - zero or more field accumulator pairs

Returns:

the $group pipeline stage

group

@NotNull
public static <TExpression> org.bson.conversions.Bson group(TExpression id,
                                                                     @NotNull
                                                                     java.util.List<com.mongodb.client.model.BsonField> fieldAccumulators)

Creates a $group pipeline stage for the specified filter

Parameters:

id - the id expression for the group

fieldAccumulators - zero or more field accumulator pairs

Returns:

the $group pipeline stage

unwind

@NotNull
public static org.bson.conversions.Bson unwind(@NotNull
                                                        java.lang.String fieldName,
                                                        @NotNull
                                                        com.mongodb.client.model.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

unwind

@NotNull
public static <T> org.bson.conversions.Bson unwind(@NotNull
                                                            kotlin.reflect.KProperty<? extends T> $this$unwind,
                                                            @NotNull
                                                            com.mongodb.client.model.UnwindOptions unwindOptions)

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

Parameters:

unwindOptions - options for the unwind pipeline stage

Returns:

the $unwind pipeline stage

out

@NotNull
public static org.bson.conversions.Bson out(@NotNull
                                                     java.lang.String collectionName)

Creates a $out pipeline stage for the specified filter

Parameters:

collectionName - the collection name

Returns:

the $out pipeline stage

replaceRoot

@NotNull
public static <TExpression> org.bson.conversions.Bson replaceRoot(TExpression value)

Creates a $replaceRoot pipeline stage

Parameters:

value - the new root value

Returns:

the $replaceRoot pipeline stage

sample

@NotNull
public static org.bson.conversions.Bson sample(int size)

Creates a $sample pipeline stage with the specified sample size

Parameters:

size - the sample size

Returns:

the $sample pipeline stage

cond

@NotNull
public static <BooleanExpression,ThenExpression,ElseExpression> org.bson.conversions.Bson cond(@NotNull
                                                                                                        BooleanExpression booleanExpression,
                                                                                                        @NotNull
                                                                                                        ThenExpression thenExpression,
                                                                                                        @NotNull
                                                                                                        ElseExpression elseExpression)

Returns a $cond expression.

Parameters:

booleanExpression - the boolean expression

thenExpression - the then expression

elseExpression - the else expression

dayOfYear

@NotNull
public static org.bson.conversions.Bson dayOfYear(@NotNull
                                                           kotlin.reflect.KProperty<? extends java.time.temporal.TemporalAccessor> property)

Builds $dayOfYear expression for this property .

dayOfMonth

@NotNull
public static org.bson.conversions.Bson dayOfMonth(@NotNull
                                                            kotlin.reflect.KProperty<? extends java.time.temporal.TemporalAccessor> property)

Builds $dayOfMonth expression for this property .

dayOfWeek

@NotNull
public static org.bson.conversions.Bson dayOfWeek(@NotNull
                                                           kotlin.reflect.KProperty<? extends java.time.temporal.TemporalAccessor> property)

Builds $dayOfWeek expression for this property .

year

@NotNull
public static org.bson.conversions.Bson year(@NotNull
                                                      kotlin.reflect.KProperty<? extends java.time.temporal.TemporalAccessor> property)

Builds $year expression for this property .

hour

@NotNull
public static org.bson.conversions.Bson hour(@NotNull
                                                      kotlin.reflect.KProperty<? extends java.time.temporal.TemporalAccessor> property)

Builds $hour expression for this property .

millisecond

@NotNull
public static org.bson.conversions.Bson millisecond(@NotNull
                                                             kotlin.reflect.KProperty<? extends java.time.temporal.TemporalAccessor> property)

Builds $millisecond expression for this property .

minute

@NotNull
public static org.bson.conversions.Bson minute(@NotNull
                                                        kotlin.reflect.KProperty<? extends java.time.temporal.TemporalAccessor> property)

Builds $minute expression for this property .

month

@NotNull
public static org.bson.conversions.Bson month(@NotNull
                                                       kotlin.reflect.KProperty<? extends java.time.temporal.TemporalAccessor> property)

Builds $month expression for this property .

second

@NotNull
public static org.bson.conversions.Bson second(@NotNull
                                                        kotlin.reflect.KProperty<? extends java.time.temporal.TemporalAccessor> property)

Builds $second expression for this property .

week

@NotNull
public static org.bson.conversions.Bson week(@NotNull
                                                      kotlin.reflect.KProperty<? extends java.time.temporal.TemporalAccessor> property)

Builds $week expression for this property .

lookup

@NotNull
public static org.bson.conversions.Bson lookup(@NotNull
                                                        java.lang.String from,
                                                        @Nullable
                                                        java.util.List<? extends com.mongodb.client.model.Variable<? extends java.lang.Object>> let,
                                                        @NotNull
                                                        kotlin.reflect.KProperty<? extends java.lang.Object> resultProperty,
                                                        @NotNull
                                                        org.bson.conversions.Bson... pipeline)

Creates a $lookup pipeline stage, joining the current collection with the one specified in from using the given pipeline

Parameters:

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

let - the variables to use in the pipeline field stages.

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

pipeline - the pipeline to run on the joined collection.

Returns:

the $lookup pipeline stage

variableDefinition

@NotNull
public static com.mongodb.client.model.Variable<java.lang.String> variableDefinition(@NotNull
                                                                                              kotlin.reflect.KProperty<?> $this$variableDefinition,
                                                                                              @NotNull
                                                                                              java.lang.String name)

Defines a Variable for the lookup operator.

getVariable

@NotNull
public static java.lang.String getVariable(@NotNull
                                                    kotlin.reflect.KProperty<?> $this$variable)

Defines a Variable projection (ie $$name)