com.mongodb.casbah.map_reduce.MapReduceCommand

Case class for invoking MongoDB mapReduces.

This wrapper class is used in it's place, and passed directly to a db.runCommand call.

input: the collection name to run the map reduce on
map: the map function (JSFunction is just a type alias for String)
reduce: the reduce function (JSFunction is just a type alias for String)
output: (optional) the location of the result of the map-reduce operation, defaults to inline. You can output to a collection, output to a collection with an action, or output inline.
query: (optional) the selection criteria for the documents input to the map function.
sort: (optional) the input documents, useful for optimization.
limit: (optional) the maximum number of documents to return from the collection before map reduce
finalizeFunction: (optional) the finalize function (JSFunction is just a type alias for String)
jsScope: (optional) global variables that are accessible in the map, reduce and finalize functions
verbose: (optional) include the timing information in the result information
maxTime: (optional) the maximum duration that the server will allow this operation to execute before killing it

Source: MapReduceCommand.scala
See also: The MongoDB Map/Reduce Documentation

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new MapReduceCommand(input: String = "", map: JSFunction = "", reduce: JSFunction = "", output: MapReduceOutputTarget = MapReduceInlineOutput, query: Option[DBObject] = scala.None, sort: Option[DBObject] = scala.None, limit: Option[Int] = scala.None, finalizeFunction: Option[JSFunction] = scala.None, jsScope: Option[DBObject] = scala.None, verbose: Boolean = false, maxTime: Option[Duration] = scala.None)

input
the collection name to run the map reduce on
map
the map function (JSFunction is just a type alias for String)
reduce
the reduce function (JSFunction is just a type alias for String)
output
(optional) the location of the result of the map-reduce operation, defaults to inline. You can output to a collection, output to a collection with an action, or output inline.
query
(optional) the selection criteria for the documents input to the map function.
sort
(optional) the input documents, useful for optimization.
limit
(optional) the maximum number of documents to return from the collection before map reduce
finalizeFunction
(optional) the finalize function (JSFunction is just a type alias for String)
jsScope
(optional) global variables that are accessible in the map, reduce and finalize functions
verbose
(optional) include the timing information in the result information
maxTime
(optional) the maximum duration that the server will allow this operation to execute before killing it

Attributes
protected[mongodb]

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def canEqual(arg0: Any): Boolean

Definition Classes
MapReduceCommand → Equals
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
MapReduceCommand → Equals → AnyRef → Any
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
val finalizeFunction: Option[JSFunction]

(optional) the finalize function (JSFunction is just a type alias for String)
final def getClass(): java.lang.Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
MapReduceCommand → AnyRef → Any
val input: String

the collection name to run the map reduce on
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val jsScope: Option[DBObject]

(optional) global variables that are accessible in the map, reduce and finalize functions
val limit: Option[Int]

(optional) the maximum number of documents to return from the collection before map reduce
val map: JSFunction

the map function (JSFunction is just a type alias for String)
val maxTime: Option[Duration]

(optional) the maximum duration that the server will allow this operation to execute before killing it
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val output: MapReduceOutputTarget

(optional) the location of the result of the map-reduce operation, defaults to inline.
(optional) the location of the result of the map-reduce operation, defaults to inline. You can output to a collection, output to a collection with an action, or output inline.
def productArity: Int

Definition Classes
MapReduceCommand → Product
def productElement(arg0: Int): Any

Definition Classes
MapReduceCommand → Product
def productIterator: Iterator[Any]

Definition Classes
Product
def productPrefix: String

Definition Classes
MapReduceCommand → Product
val query: Option[DBObject]

(optional) the selection criteria for the documents input to the map function.
val reduce: JSFunction

the reduce function (JSFunction is just a type alias for String)
val sort: Option[DBObject]

(optional) the input documents, useful for optimization.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toDBObject: DBObject
def toString(): String

Definition Classes
MapReduceCommand → AnyRef → Any
val verbose: Boolean

(optional) include the timing information in the result information
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws()

Deprecated Value Members

def productElements: Iterator[Any]

Definition Classes
Product
Annotations
@deprecated
Deprecated
(Since version 2.8.0) use productIterator instead

MapReduceCommand

Instance Constructors

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def canEqual(arg0: Any): Boolean

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

val finalizeFunction: Option[JSFunction]

final def getClass(): java.lang.Class[_]

def hashCode(): Int

val input: String

final def isInstanceOf[T0]: Boolean

val jsScope: Option[DBObject]

val limit: Option[Int]

val map: JSFunction

val maxTime: Option[Duration]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val output: MapReduceOutputTarget

def productArity: Int

def productElement(arg0: Int): Any

def productIterator: Iterator[Any]

def productPrefix: String

val query: Option[DBObject]

val reduce: JSFunction

val sort: Option[DBObject]

final def synchronized[T0](arg0: ⇒ T0): T0

def toDBObject: DBObject

def toString(): String

val verbose: Boolean

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Deprecated Value Members

def productElements: Iterator[Any]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any