Package com.mongodb

Class AggregationOptions

  • public class AggregationOptions
extends
    The options to apply to an aggregate operation.
    Since:
    2.12
    MongoDB documentation
    Since server release

    • Method Detail

      • getAllowDiskUse

        public  getAllowDiskUse()
        If true, this enables external sort capabilities, otherwise $sort produces an error if the operation consumes 10 percent or more of RAM.
        Returns:
        true if aggregation stages can write data to temporary files
        Since server release

      • getBatchSize

        public  getBatchSize()
        The size of batches to use when iterating over results.
        Returns:
        the batch size
        Since server release

      • getOutputMode

        public AggregationOptions.OutputMode getOutputMode()
        Deprecated.
        There is no replacement for this. Applications can assume that the driver will use a cursor for server versions that support it (>= 2.6). The driver will ignore this as of MongoDB 3.6, which does not support inline results for the aggregate command.
        The mode of output for this configuration.
        Returns:
        whether the output will be inline or via a cursor, which defaults to AggregationOptions.OutputMode.CURSOR
        See Also:
        AggregationOptions.OutputMode

      • getMaxTime

        public long getMaxTime​( timeUnit)
        Gets the maximum execution time for the aggregation command.
        Parameters:
        timeUnit - the time unit for the result
        Returns:
        the max time
        Since:
        2.12
        Since server release

      • getBypassDocumentValidation

        public  getBypassDocumentValidation()
        Gets whether to bypass document validation, or null if unspecified. The default is null.
        Returns:
        whether to bypass document validation, or null if unspecified.
        Since:
        2.14
        Since server release

      • getCollation

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

      • toString

        public  toString()
        Overrides:
         in class 

      • builder

        public static AggregationOptions.Builder builder()
        Creates a new Builder for AggregationOptions.
        Returns:
        a new empty builder.