Package com.mongodb

Class GroupCommand

java.lang.Object
com.mongodb.GroupCommand
@Deprecated public class GroupCommand extends Object
Deprecated.
the group command was deprecated in MongoDB 3.4
This class groups the argument for a group operation and can build the underlying command object

  • Constructor Details

    • GroupCommand

      public GroupCommand(DBCollection collection, DBObject keys, DBObject condition, DBObject initial, String reduce, @Nullable String finalize)
      Deprecated.
      Creates a new group command.
      Parameters:
      collection - the collection from which to perform the group by operation.
      keys - the field or fields to group.
      condition - optional - a filter to determine which documents in the collection to process.
      initial - the initial state of the aggregation result document.
      reduce - a JavaScript aggregation function that operates on the documents during the grouping operation.
      finalize - optional - a JavaScript function that runs each item in the result set before group returns the final value.

    • GroupCommand

      public GroupCommand(DBCollection collection, DBObject keys, DBObject condition, DBObject initial, String reduce, @Nullable String finalize, @Nullable Collation collation)
      Deprecated.
      Creates a new group command.
      Parameters:
      collection - the collection from which to perform the group by operation.
      keys - the field or fields to group.
      condition - optional - a filter to determine which documents in the collection to process.
      initial - the initial state of the aggregation result document.
      reduce - a JavaScript aggregation function that operates on the documents during the grouping operation.
      finalize - optional - a JavaScript function that runs each item in the result set before group returns the final value.
      collation - optional - the collation options
      Since:
      3.4

    • GroupCommand

      public GroupCommand(DBCollection collection, String keyf, DBObject condition, DBObject initial, String reduce, String finalize)
      Deprecated.
      Creates a new group command.
      Parameters:
      collection - the collection from which to perform the group by operation.
      keyf - the function that creates a "key object" for use as the grouping key
      condition - optional - a filter to determine which documents in the collection to process.
      initial - the initial state of the aggregation result document.
      reduce - a JavaScript aggregation function that operates on the documents during the grouping operation.
      finalize - optional - a JavaScript function that runs each item in the result set before group returns the final value.
      Since:
      3.1

    • GroupCommand

      public GroupCommand(DBCollection collection, String keyf, DBObject condition, DBObject initial, String reduce, @Nullable String finalize, @Nullable Collation collation)
      Deprecated.
      Creates a new group command.
      Parameters:
      collection - the collection from which to perform the group by operation.
      keyf - the function that creates a "key object" for use as the grouping key
      condition - optional - a filter to determine which documents in the collection to process.
      initial - the initial state of the aggregation result document.
      reduce - a JavaScript aggregation function that operates on the documents during the grouping operation.
      finalize - optional - a JavaScript function that runs each item in the result set before group returns the final value.
      collation - optional - the collation options
      Since:
      3.4

  • Method Details

    • toDBObject

      public DBObject toDBObject()
      Deprecated.
      Turns this group command into the DBObject format of the command.
      Returns:
      a DBObject containing the group command as a MongoDB document