casbah

Type Members

1. case class AggregationOutput(underlying: mongodb.AggregationOutput) extends Product with Serializable

   

   Wrapper object for AggregationOutput

   Wrapper object for AggregationOutput

   Since

   2.5

2. trait BaseImports extends AnyRef

   

   Annotations

   @SuppressWarnings()

3. case class BulkWriteException(message: String, cause: Throwable, underlying: mongodb.BulkWriteException) extends Exception with Product with Serializable

   

4. case class BulkWriteOperation(underlying: mongodb.BulkWriteOperation) extends Product with Serializable

   

   A builder for a bulk write operation.

   A builder for a bulk write operation.

   Since

   2.7

5. case class BulkWriteResult(underlying: mongodb.BulkWriteResult) extends Product with Serializable

   

6. case class Cursor(underlying: mongodb.Cursor) extends Iterator[casbah.Imports.DBObject] with Product with Serializable

   

   A wrapper for the new com.mongodb.Cursor - which is used when returning a cursor from the aggregation framework.

   A wrapper for the new com.mongodb.Cursor - which is used when returning a cursor from the aggregation framework.

   underlying

   (com.mongodb.Cursor)

   Version

   2.7

7. sealed class CursorExplanation extends casbah.Imports.MongoDBObject

   
   Version

   1.0, 12/15/10

   Since

   2.0

   See also

   http://dochub.mongodb.org/core/explain

8. trait Implicits extends AnyRef

   

   Implicits object to expose implicit conversions to implementing classes which facilitate more Scala-like functionality in Mongo.

   Implicits object to expose implicit conversions to implementing classes which facilitate more Scala-like functionality in Mongo.

   For classes of Mongo (The connection class), DB, DBCollection, and DBCursor, extension methods of asScala are added which will, when invoked, return a Scala-ified wrapper class to replace the Java-driver class it was called on.

   These scala-ified wrappers do conversions to/from Java datatypes where necessary and will always return Scala types.

   Additionally, Collection and Cursors can be called with asScalaTyped and a type (either an implicit or explicitly passed Manifest object is used to determine type) to return a Type optimized version of themselves. The type must be a subclass of DBObject, and it is up to YOU the programmer to determine that your underlying collection can be deserialized to objects of type A.

   Type oriented Collections and Cursors will ALWAYS try to deserialize DBObjects to their type where appropriate (exceptions are things like group and mapReduce which return non-standard data and will be DBObjects)

9. trait Imports extends BaseImports with TypeImports with Implicits

   

10. class MongoClient extends AnyRef

    

    Wrapper class for the MongoClient object.

11. case class MongoClientURI(underlying: mongodb.MongoClientURI) extends Product with Serializable

    

    Create a new MongoURI with a URI String e.g.:

    Create a new MongoURI with a URI String e.g.:

    • mongodb://localhost
    • mongodb://fred:foobar@localhost/
    • mongodb://server1,server2,server3

    See http://docs.mongodb.org/manual/reference/connection-string/

    Since

    2.5

12. class MongoCollection extends MongoCollectionBase with Iterable[casbah.commons.TypeImports.DBObject]

    

    Concrete collection implementation expecting standard DBObject operation This is the version of MongoCollectionBase you should expect to use in most cases.

    Concrete collection implementation expecting standard DBObject operation This is the version of MongoCollectionBase you should expect to use in most cases.

    Version

    2.0, 12/23/10

    Since

    1.0

13. trait MongoCollectionBase extends Logging

    

    Scala wrapper for Mongo DBCollections, including ones which return custom DBObject subclasses via setObjectClass and the like.

    Scala wrapper for Mongo DBCollections, including ones which return custom DBObject subclasses via setObjectClass and the like. Provides any non-parameterized methods and the basic structure. Requires an underlying object of a DBCollection.

    This is a rewrite of the Casbah 1.0 approach which was rather naive and unecessarily complex.... formerly was MongoCollectionWrapper

    Version

    2.0, 12/23/10

    Since

    1.0

14. class MongoCursor extends MongoCursorBase with Iterator[casbah.Imports.DBObject]

    

    Concrete cursor implementation expecting standard DBObject operation This is the version of MongoCursorBase you should expect to use in most cases.

    Concrete cursor implementation expecting standard DBObject operation This is the version of MongoCursorBase you should expect to use in most cases.

    Version

    2.0, 12/23/10

    Since

    1.0

15. trait MongoCursorBase extends Logging

    

    Scala wrapper for Mongo DBCursors, including ones which return custom DBObject subclasses.

    Scala wrapper for Mongo DBCursors, including ones which return custom DBObject subclasses.

    This is a rewrite of the Casbah 1.0 approach which was rather naive and unnecessarily complex.... formerly was MongoCursorWrapper

    Version

    2.0, 12/23/10

    Since

    2.0

16. class MongoDB extends AnyRef

    

    Wrapper for the Mongo DB object providing scala-friendly functionality.

    Wrapper for the Mongo DB object providing scala-friendly functionality.

    Since

    1.0

    See also

    com.mongodb.DB

17. class MongoGenericTypedCollection[A <: casbah.commons.TypeImports.DBObject] extends MongoTypedCollection

    

18. class MongoGenericTypedCursor[A <: casbah.Imports.DBObject] extends MongoCursorBase

    

    Concrete cursor implementation for typed Cursor operations via Collection.setObjectClass This is a special case cursor for typed operations.

    Concrete cursor implementation for typed Cursor operations via Collection.setObjectClass This is a special case cursor for typed operations.

    A

    A Subclass of DBObject

    Version

    2.0, 12/23/10

    Since

    1.0

19. trait MongoTypedCollection extends MongoCollectionBase

    

    Concrete collection implementation for typed Cursor operations via Collection.setObjectClass et al This is a special case collection for typed operations

    Concrete collection implementation for typed Cursor operations via Collection.setObjectClass et al This is a special case collection for typed operations

    Version

    2.0, 12/23/10

    Since

    1.0

20. case class ParallelScanOptions(numCursors: Int, batchSize: Int, readPreference: Option[Imports.ReadPreference] = None) extends Product with Serializable

    

    The options to use for a parallel collection scan.

    The options to use for a parallel collection scan.

    numCursors

    The number of cursors to return, must be greater than 0

    batchSize

    The cursor batch size, must be greater than 0 and less than 10001

    readPreference

    The optional read preference.

    Since

    2.7

    See also

    com.monogdb.ParallelScanOptions

21. trait TypeImports extends AnyRef

    

22. class MongoConnection extends AnyRef

    

    Wrapper class for the Mongo Connection object.

    Wrapper class for the Mongo Connection object.

    Annotations

    @deprecated

    Deprecated

    (Since version 2.7) Please use MongoClient

23. class MongoURI extends AnyRef

    

    Create a new MongoURI with a URI String e.g.:

    Create a new MongoURI with a URI String e.g.:

    • mongodb://localhost
    • mongodb://fred:foobar@localhost/
    • mongodb://server1,server2,server3

    See http://www.mongodb.org/display/DOCS/Connections

    Annotations

    @deprecated @SuppressWarnings()

    Deprecated

    (Since version 2.8) Please use MongoClient and MongoClientURI

    Since

    2.0