Package com.mongodb.operation

Class AggregateToCollectionOperation

  • All Implemented Interfaces:
    >, >
    public class AggregateToCollectionOperation
extends 
implements >, >
    Deprecated.
    An operation that executes an aggregation that writes its results to a collection (which is what makes this a write operation rather than a read operation).
    Since:
    3.0
    MongoDB documentation
    Since server release

    • Constructor Detail

      • AggregateToCollectionOperation

        public AggregateToCollectionOperation​(MongoNamespace namespace,
                                      <BsonDocument> pipeline,
                                      WriteConcern writeConcern)
        Deprecated.
        Construct a new instance.
        Parameters:
        namespace - the database and collection namespace for the operation.
        pipeline - the aggregation pipeline.
        writeConcern - the write concern to apply
        Since:
        3.4

      • AggregateToCollectionOperation

        public AggregateToCollectionOperation​(MongoNamespace namespace,
                                      <BsonDocument> pipeline,
                                      ReadConcern readConcern)
        Deprecated.
        Construct a new instance.
        Parameters:
        namespace - the database and collection namespace for the operation.
        pipeline - the aggregation pipeline.
        readConcern - the read concern to apply
        Since:
        3.11

      • AggregateToCollectionOperation

        public AggregateToCollectionOperation​(MongoNamespace namespace,
                                      <BsonDocument> pipeline,
                                      ReadConcern readConcern,
                                      WriteConcern writeConcern)
        Deprecated.
        Construct a new instance.
        Parameters:
        namespace - the database and collection namespace for the operation.
        pipeline - the aggregation pipeline.
        writeConcern - the write concern to apply
        readConcern - the read concern to apply
        Since:
        3.11

      • AggregateToCollectionOperation

        public AggregateToCollectionOperation​(MongoNamespace namespace,
                                      <BsonDocument> pipeline,
                                      WriteConcern writeConcern,
                                      AggregationLevel aggregationLevel)
        Deprecated.
        Construct a new instance.
        Parameters:
        namespace - the database and collection namespace for the operation.
        pipeline - the aggregation pipeline.
        writeConcern - the write concern to apply
        aggregationLevel - the aggregation level
        Since:
        3.10

      • AggregateToCollectionOperation

        public AggregateToCollectionOperation​(MongoNamespace namespace,
                                      <BsonDocument> pipeline,
                                      ReadConcern readConcern,
                                      WriteConcern writeConcern,
                                      AggregationLevel aggregationLevel)
        Deprecated.
        Construct a new instance.
        Parameters:
        namespace - the database and collection namespace for the operation.
        pipeline - the aggregation pipeline.
        readConcern - the read concern to apply
        writeConcern - the write concern to apply
        aggregationLevel - the aggregation level
        Since:
        3.11

    • Method Detail

      • getPipeline

        public <BsonDocument> getPipeline()
        Deprecated.
        Gets the aggregation pipeline.
        Returns:
        the pipeline
        MongoDB documentation

      • getReadConcern

        public ReadConcern getReadConcern()
        Deprecated.
        Gets the read concern.
        Returns:
        the read concern, which may be null
        Since:
        3.11

      • getWriteConcern

        public WriteConcern getWriteConcern()
        Deprecated.
        Gets the write concern.
        Returns:
        the write concern, which may be null
        Since:
        3.4

      • getAllowDiskUse

        public  getAllowDiskUse()
        Deprecated.
        Whether writing to temporary files is enabled. A null value indicates that it's unspecified.
        Returns:
        true if writing to temporary files is enabled
        MongoDB documentation
        Since server release

      • allowDiskUse

        public  allowDiskUse)
        Deprecated.
        Enables writing to temporary files. A null value indicates that it's unspecified.
        Parameters:
        allowDiskUse - true if writing to temporary files is enabled
        Returns:
        this
        MongoDB documentation
        Since server release

      • getMaxTime

        public long getMaxTime​( timeUnit)
        Deprecated.
        Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.
        Parameters:
        timeUnit - the time unit to return the result in
        Returns:
        the maximum execution time in the given time unit
        MongoDB documentation

      • maxTime

        public AggregateToCollectionOperation maxTime​(long maxTime,
                                               timeUnit)
        Deprecated.
        Sets the maximum execution time on the server for this operation.
        Parameters:
        maxTime - the max time
        timeUnit - the time unit, which may not be null
        Returns:
        this
        MongoDB documentation

      • getBypassDocumentValidation

        public  getBypassDocumentValidation()
        Deprecated.
        Gets the bypass document level validation flag
        Returns:
        the bypass document level validation flag
        Since:
        3.2

      • bypassDocumentValidation

        public  bypassDocumentValidation)
        Deprecated.
        Sets the bypass document level validation flag.

        Note: This only applies when an $out or $merge stage is specified

        .
        Parameters:
        bypassDocumentValidation - If true, allows the write to opt-out of document level validation.
        Returns:
        this
        Since:
        3.2
        Since server release

      • getCollation

        public Collation getCollation()
        Deprecated.
        Returns the collation options
        Returns:
        the collation options
        Since:
        3.4
        Since server release

      • collation

        public AggregateToCollectionOperation collation​(Collation collation)
        Deprecated.
        Sets the collation options

        A null value represents the server default.

        Parameters:
        collation - the collation options to use
        Returns:
        this
        Since:
        3.4
        Since server release

      • getComment

        public  getComment()
        Deprecated.
        Returns the comment to send with the aggregate. The default is not to include a comment with the aggregation.
        Returns:
        the comment
        Since:
        3.6
        Since server release

      • comment

        public  comment)
        Deprecated.
        Sets the comment to the aggregation. A null value means no comment is set.
        Parameters:
        comment - the comment
        Returns:
        this
        Since:
        3.6
        Since server release

      • getHint

        public BsonDocument getHint()
        Deprecated.
        Returns the hint for which index to use. The default is not to set a hint.
        Returns:
        the hint
        Since:
        3.6
        Since server release

      • hint

        public AggregateToCollectionOperation hint​(BsonDocument hint)
        Deprecated.
        Sets the hint for which index to use. A null value means no hint is set.
        Parameters:
        hint - the hint
        Returns:
        this
        Since:
        3.6
        Since server release

      • asExplainableOperation

        public ReadOperation<BsonDocument> asExplainableOperation​(ExplainVerbosity explainVerbosity)
        Deprecated.
        Gets an operation whose execution explains this operation.
        Parameters:
        explainVerbosity - the explain verbosity
        Returns:
        a read operation that when executed will explain this operation

      • execute

        public  execute​(WriteBinding binding)
        Deprecated.
        Description copied from interface: WriteOperation
        General execute which can return anything of type T
        Specified by:
        >
        Parameters:
        binding - the binding to execute in the context of
        Returns:
        T, the result of the execution

      • executeAsync

        public void executeAsync​(AsyncWriteBinding binding,
                         > callback)
        Deprecated.
        Description copied from interface: AsyncWriteOperation
        General execute which can return anything of type T
        Specified by:
        >
        Parameters:
        binding - the binding to execute in the context of
        callback - the callback to be called when the operation has been executed