Class OutOperation

java.lang.Object

org.springframework.data.mongodb.core.aggregation.OutOperation

All Implemented Interfaces:

AggregationOperation

public class OutOperation
extends Object
implements AggregationOperation

Encapsulates the $out-operation.

We recommend to use the static factory method Aggregation.out(String) instead of creating instances of this class directly.

Author:

Nikolay Bogdanov, Christoph Strobl, Hyunsang Han

See Also:

• MongoDB Aggregation Framework: $out

Constructor Summary

Constructors

Constructor	Description
OutOperation(String outCollectionName)

Method Summary

Modifier and Type	Method	Description
String	getOperator()	Return the MongoDB operator that is used for this AggregationOperation.
OutOperation	in(@Nullable String database)	Optionally specify the database of the target collection.
OutOperation	timeSeries(String timeField)	Set the time series options for creating a time series collection with only the time field.
OutOperation	timeSeries(String timeField, @Nullable String metaField, @Nullable Granularity granularity)	Set the time series options for creating a time series collection with time field, meta field, and granularity.
OutOperation	timeSeries(CollectionOptions.TimeSeriesOptions timeSeriesOptions)	Set the time series options for creating a time series collection.
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

Methods inherited from class Object

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

Methods inherited from interface AggregationOperation

toPipelineStages

Constructor Details

OutOperation

public OutOperation(String outCollectionName)

Parameters:

outCollectionName - Collection name to export the results. Must not be null.

Method Details

in

@Contract("_ -> new")
public OutOperation in(@Nullable String database)

Optionally specify the database of the target collection.
NOTE: Requires MongoDB 4.2 or later.

Parameters:

database - can be null. Defaulted to aggregation target database.

Returns:

new instance of OutOperation.

Since:

2.2

timeSeries

@Contract("_ -> new")
public OutOperation timeSeries(CollectionOptions.TimeSeriesOptions timeSeriesOptions)

Set the time series options for creating a time series collection.

Parameters:

timeSeriesOptions - must not be null.

Returns:

new instance of OutOperation.

Since:

5.0

timeSeries

@Contract("_ -> new")
public OutOperation timeSeries(String timeField)

Set the time series options for creating a time series collection with only the time field.

Parameters:

timeField - must not be null or empty.

Returns:

new instance of OutOperation.

Since:

5.0

timeSeries

@Contract("_, _, _ -> new")
public OutOperation timeSeries(String timeField,
 @Nullable String metaField,
 @Nullable Granularity granularity)

Set the time series options for creating a time series collection with time field, meta field, and granularity.

Parameters:

timeField - must not be null or empty.

metaField - can be null.

granularity - defaults to Granularity.DEFAULT if null.

Returns:

new instance of OutOperation.

Since:

5.0

toDocument

public org.bson.Document toDocument(AggregationOperationContext context)

Description copied from interface: AggregationOperation

Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

Specified by:

toDocument in interface AggregationOperation

Parameters:

context - the AggregationOperationContext to operate within. Must not be null.

Returns:

the Document

getOperator

public String getOperator()

Description copied from interface: AggregationOperation

Return the MongoDB operator that is used for this AggregationOperation. Aggregation operations should implement this method to avoid document rendering.

Specified by:

getOperator in interface AggregationOperation

Returns:

the operator used for this AggregationOperation.