com.mongodb.casbah

MongoGenericTypedCollection

class MongoGenericTypedCollection[A <: DBObject] extends MongoTypedCollection

Source
MongoCollection.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. MongoGenericTypedCollection
  2. MongoTypedCollection
  3. MongoCollectionBase
  4. Logging
  5. AnyRef
  6. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MongoGenericTypedCollection(underlying: DBCollection)

Type Members

  1. type CursorType = MongoGenericTypedCursor[A]

  2. type T = A

Value Members

  1. final def !=(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +=[A](x: A)(implicit arg0: (A) ⇒ DBObject): WriteResult

    Save an object to the Collection

    Save an object to the Collection

    x

    object to save to the collection

    Definition Classes
    MongoCollectionBase
  5. def -=[A](x: A)(implicit arg0: (A) ⇒ DBObject): WriteResult

    Remove a matching object from the collection

    Remove a matching object from the collection

    x

    object to remove from the collection

    Definition Classes
    MongoCollectionBase
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. def _newCursor(cursor: DBCursor): MongoGenericTypedCursor[T]

    _newCursor

    _newCursor

    Utility method which concrete subclasses are expected to implement for creating a new instance of the correct cursor implementation from a Java cursor. Good with cursor calls that return a new cursor. Should figure out the right type to return based on typing setup.

    cursor

    (DBCursor)

    returns

    (MongoCollectionBase)

    Definition Classes
    MongoGenericTypedCollectionMongoCollectionBase
  9. def _newInstance(collection: DBCollection): MongoGenericTypedCollection[T]

    _newInstance

    _newInstance

    Utility method which concrete subclasses are expected to implement for creating a new instance of THIS concrete implementation from a Java collection. Good with calls that return a new collection.

    collection

    (DBCollection)

    returns

    (this.type)

    Definition Classes
    MongoGenericTypedCollectionMongoCollectionBase
  10. def _typedValue(dbObj: DBObject): Option[T]

    Attributes
    protected
    Definition Classes
    MongoCollectionBase
  11. def addOption(option: Int): Unit

    Manipulate Network Options

    Manipulate Network Options

    Definition Classes
    MongoCollectionBase
    See also

    com.mongodb.Bytes

    ,

    com.mongodb.Mongo

  12. def aggregate[A](pipeline: Iterable[A], options: AggregationOptions, readPreference: ReadPreference)(implicit arg0: (A) ⇒ DBObject): Cursor

    performs an aggregation operation

    performs an aggregation operation

    pipeline

    the aggregation pipeline

    options

    the aggregation options

    readPreference

    The readPreference for the aggregation

    returns

    The aggregation operation's result set

    Definition Classes
    MongoCollectionBase
  13. def aggregate[A](pipeline: Iterable[A], readPreference: ReadPreference)(implicit arg0: (A) ⇒ DBObject): AggregationOutput

    performs an aggregation operation

    performs an aggregation operation

    pipeline

    the aggregation pipeline

    readPreference

    The readPreference for the aggregation

    returns

    The aggregation operation's result set

    Definition Classes
    MongoCollectionBase
  14. def aggregate[A](pipeline: Iterable[A], options: AggregationOptions)(implicit arg0: (A) ⇒ DBObject): Cursor

    performs an aggregation operation

    performs an aggregation operation

    pipeline

    the aggregation pipeline

    options

    the aggregation options

    returns

    The aggregation operation's result set

    Definition Classes
    MongoCollectionBase
  15. def aggregate[A](pipeline: Iterable[A])(implicit arg0: (A) ⇒ DBObject): AggregationOutput

    performs an aggregation operation

    performs an aggregation operation

    pipeline

    the aggregation pipeline

    returns

    The aggregation operation's result set

    Definition Classes
    MongoCollectionBase
  16. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  17. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  18. def collection(n: String): MongoCollection

    Find a collection that is prefixed with this collection's name.

    Find a collection that is prefixed with this collection's name. A typical use of this might be

    DBCollection users = mongo.getCollection( "wiki" ).getCollection( "users" );
    
    Which is equilalent to
    DBCollection users = mongo.getCollection( "wiki.users" );

    n

    the name of the collection to find

    returns

    the matching collection

    TODO - Make this support type construction

    Definition Classes
    MongoCollectionBase
  19. def count[A, B](query: A, fields: B, limit: Long, skip: Long, readPrefs: ReadPreference, maxTime: Duration)(implicit arg0: (A) ⇒ DBObject, arg1: (B) ⇒ DBObject): Int

    Definition Classes
    MongoCollectionBase
  20. def createIndex[A, B](keys: A, options: B)(implicit arg0: (A) ⇒ DBObject, arg1: (B) ⇒ DBObject): Unit

    Definition Classes
    MongoCollectionBase
  21. def createIndex[A](keys: A)(implicit arg0: (A) ⇒ DBObject): Unit

    Forces creation of an index on a set of fields, if one does not already exist.

    Forces creation of an index on a set of fields, if one does not already exist.

    keys

    an object with a key set of the fields desired for the index

    Definition Classes
    MongoCollectionBase
  22. def customDecoderFactory: Option[DBDecoderFactory]

    Definition Classes
    MongoCollectionBase
  23. def customEncoderFactory: Option[DBEncoderFactory]

    Definition Classes
    MongoCollectionBase
  24. implicit val db: MongoDB

    Returns the database this collection is a member of.

    Returns the database this collection is a member of.

    returns

    this collection's database

    Definition Classes
    MongoCollectionBase
  25. def distinct[A](key: String, query: A, readPrefs: ReadPreference)(implicit arg0: (A) ⇒ DBObject): scala.collection.mutable.Buffer[_]

    Find distinct values for a key

    Find distinct values for a key

    A

    The DBObject type @return

    key

    the key to find the distinct values for

    query

    the query (optional)

    readPrefs

    the com.mongodb.ReadPreference for the operation.

    Definition Classes
    MongoCollectionBase
  26. def drop(): Unit

    Drops (deletes) this collection

    Drops (deletes) this collection

    Definition Classes
    MongoCollectionBase
  27. def dropCollection(): Unit

    Drops (deletes) this collection

    Drops (deletes) this collection

    Definition Classes
    MongoCollectionBase
  28. def dropIndex(name: String): Unit

    Definition Classes
    MongoCollectionBase
  29. def dropIndex[A](keys: A)(implicit arg0: (A) ⇒ DBObject): Unit

    Definition Classes
    MongoCollectionBase
  30. def dropIndexes(name: String): Unit

    Definition Classes
    MongoCollectionBase
  31. def dropIndexes(): Unit

    Drops all indices from this collection

    Drops all indices from this collection

    Definition Classes
    MongoCollectionBase
  32. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  33. def equals(obj: Any): Boolean

    Checks if this collection is equal to another object.

    Checks if this collection is equal to another object.

    obj

    object with which to compare this collection

    returns

    if the two collections are the same object

    Definition Classes
    MongoCollectionBase → AnyRef → Any
  34. def explainAggregate[A](pipeline: Iterable[A], options: AggregationOptions)(implicit arg0: (A) ⇒ DBObject): Map[String, AnyRef]

    Return the explain plan for the aggregation pipeline.

    Return the explain plan for the aggregation pipeline.

    pipeline

    the aggregation pipeline to explain

    options

    the options to apply to the aggregation

    returns

    the command result. The explain output may change from release to release, so best to simply log this.

    Definition Classes
    MongoCollectionBase
  35. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  36. def find[A, B](ref: A, keys: B)(implicit arg0: (A) ⇒ DBObject, arg1: (B) ⇒ DBObject): CursorType

    Queries for an object in this collection.

    Queries for an object in this collection.

    An empty DBObject will match every document in the collection. Regardless of fields specified, the _id fields are always returned.

    An example that returns the "x" and "_id" fields for every document in the collection that has an "x" field:

    BasicDBObject keys = new BasicDBObject();
    keys.put("x", 1);
    
    DBCursor cursor = collection.find(new BasicDBObject(), keys);
    

    ref

    object for which to search

    keys

    fields to return

    returns

    a cursor to iterate over results

    Definition Classes
    MongoCollectionBase
  37. def find[A](ref: A)(implicit arg0: (A) ⇒ DBObject): CursorType

    Queries for an object in this collection.

    Queries for an object in this collection.

    ref

    object for which to search

    returns

    an iterator over the results

    Definition Classes
    MongoCollectionBase
  38. def find(): CursorType

    Queries for all objects in this collection.

    Queries for all objects in this collection.

    returns

    a cursor which will iterate over every object

    Definition Classes
    MongoCollectionBase
  39. def findAndModify[A, B, C, D](query: A, fields: B, sort: C, remove: Boolean, update: D, returnNew: Boolean, upsert: Boolean, maxTime: Duration)(implicit arg0: (A) ⇒ DBObject, arg1: (B) ⇒ DBObject, arg2: (C) ⇒ DBObject, arg3: (D) ⇒ DBObject): Option[T]

    Finds the first document in the query and updates it.

    Finds the first document in the query and updates it.

    query

    query to match

    fields

    fields to be returned

    sort

    sort to apply before picking first document

    remove

    if true, document found will be removed

    update

    update to apply

    returnNew

    if true, the updated document is returned, otherwise the old document is returned (or it would be lost forever)

    upsert

    do upsert (insert if document not present)

    maxTime

    the maximum duration that the server will allow this operation to execute before killing it

    returns

    the old document

    Definition Classes
    MongoCollectionBase
  40. def findAndModify[A, B, C, D](query: A, fields: B, sort: C, remove: Boolean, update: D, returnNew: Boolean, upsert: Boolean)(implicit arg0: (A) ⇒ DBObject, arg1: (B) ⇒ DBObject, arg2: (C) ⇒ DBObject, arg3: (D) ⇒ DBObject): Option[T]

    Finds the first document in the query and updates it.

    Finds the first document in the query and updates it.

    query

    query to match

    fields

    fields to be returned

    sort

    sort to apply before picking first document

    remove

    if true, document found will be removed

    update

    update to apply

    returnNew

    if true, the updated document is returned, otherwise the old document is returned (or it would be lost forever)

    upsert

    do upsert (insert if document not present)

    returns

    the old document

    Definition Classes
    MongoCollectionBase
  41. def findAndModify[A, B, C](query: A, sort: B, update: C)(implicit arg0: (A) ⇒ DBObject, arg1: (B) ⇒ DBObject, arg2: (C) ⇒ DBObject): Option[T]

    Finds the first document in the query (sorted) and updates it.

    Finds the first document in the query (sorted) and updates it.

    query

    query to match

    sort

    sort to apply before picking first document

    update

    update to apply

    returns

    the old document

    Definition Classes
    MongoCollectionBase
  42. def findAndModify[A, B](query: A, update: B)(implicit arg0: (A) ⇒ DBObject, arg1: (B) ⇒ DBObject): Option[T]

    Finds the first document in the query (sorted) and updates it.

    Finds the first document in the query (sorted) and updates it. If remove is specified it will be removed. If new is specified then the updated document will be returned, otherwise the old document is returned (or it would be lost forever). You can also specify the fields to return in the document, optionally.

    query

    query to match

    update

    update to apply

    returns

    (Option[T]) of the the found document (before, or after the update)

    Definition Classes
    MongoCollectionBase
  43. def findAndRemove[A](query: A)(implicit arg0: (A) ⇒ DBObject): Option[T]

    Finds the first document in the query and removes it.

    Finds the first document in the query and removes it.

    returns

    the removed document

    Definition Classes
    MongoCollectionBase
  44. def findOne[A, B, C](o: A, fields: B, orderBy: C, readPrefs: ReadPreference, maxTime: Duration)(implicit arg0: (A) ⇒ DBObject, arg1: (B) ⇒ DBObject, arg2: (C) ⇒ DBObject): Option[T]

    Returns a single object from this collection matching the query.

    Returns a single object from this collection matching the query.

    o

    the query object

    fields

    (optional) fields to return

    orderBy

    (optional) a document whose fields specify the attributes on which to sort the result set.

    readPrefs

    (optional)

    maxTime

    (optional) the maximum duration that the server will allow this operation to execute before killing it

    returns

    (Option[T]) Some() of the object found, or None if no such object exists

    Definition Classes
    MongoCollectionBase
  45. def findOne(): Option[T]

    Returns a single object from this collection.

    Returns a single object from this collection.

    returns

    (Option[T]) Some() of the object found, or None if this collection is empty

    Definition Classes
    MongoCollectionBase
  46. def findOneByID[B](id: AnyRef, fields: B)(implicit arg0: (B) ⇒ DBObject): Option[T]

    Find an object by its ID.

    Find an object by its ID. Finds an object by its id. This compares the passed in value to the _id field of the document.

    Returns a single object from this collection matching the query.

    id

    the id to match

    fields

    fields to return

    returns

    (Option[T]) Some() of the object found, or None if no such object exists

    Definition Classes
    MongoCollectionBase
  47. def findOneByID(id: AnyRef): Option[T]

    Find an object by its ID.

    Find an object by its ID. Finds an object by its id. This compares the passed in value to the _id field of the document.

    Returns a single object from this collection matching the query.

    id

    the id to match

    returns

    (Option[T]) Some() of the object found, or None if no such object exists

    Definition Classes
    MongoCollectionBase
  48. def fullName: String

    Returns the full name of this collection, with the database name as a prefix.

    Returns the full name of this collection, with the database name as a prefix.

    returns

    the name of this collection

    Definition Classes
    MongoCollectionBase
  49. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any
  50. def getCollection(n: String): MongoCollection

    Find a collection that is prefixed with this collection's name.

    Find a collection that is prefixed with this collection's name. A typical use of this might be

    DBCollection users = mongo.getCollection( "wiki" ).getCollection( "users" );
    
    Which is equilalent to
    DBCollection users = mongo.getCollection( "wiki.users" );

    n

    the name of the collection to find

    returns

    the matching collection

    TODO - Make this support type construction

    Definition Classes
    MongoCollectionBase
  51. def getCount[A, B](query: A, fields: B, limit: Long, skip: Long, readPrefs: ReadPreference, maxTime: Duration)(implicit arg0: (A) ⇒ DBObject, arg1: (B) ⇒ DBObject): Int

    Returns the number of documents in the collection that match the specified query

    Returns the number of documents in the collection that match the specified query

    query

    specifies the selection criteria

    fields

    this is ignored

    limit

    limit the count to this value

    skip

    number of documents to skip

    readPrefs

    The [ReadPreference] to be used for this operation

    maxTime

    the maximum duration that the server will allow this operation to execute before killing it

    returns

    the number of documents that matches selection criteria

    Definition Classes
    MongoCollectionBase
  52. def getDB: MongoDB

    Returns the database this collection is a member of.

    Returns the database this collection is a member of.

    returns

    this collection's database

    Definition Classes
    MongoCollectionBase
  53. def getFullName: String

    Returns the full name of this collection, with the database name as a prefix.

    Returns the full name of this collection, with the database name as a prefix.

    returns

    the name of this collection

    Definition Classes
    MongoCollectionBase
  54. def getIndexInfo: Buffer[DBObject]

    Return a list of the indexes for this collection.

    Return a list of the indexes for this collection. Each object in the list is the "info document" from MongoDB

    returns

    list of index documents

    Definition Classes
    MongoCollectionBase
  55. def getName: String

    Definition Classes
    MongoCollectionBase
  56. def getObjectClass: Class[_]

    Gets the default class for objects in the collection

    Gets the default class for objects in the collection

    returns

    the class

    Definition Classes
    MongoCollectionBase
  57. def getOptions: Int

    Manipulate Network Options

    Manipulate Network Options

    Definition Classes
    MongoCollectionBase
    See also

    com.mongodb.Bytes

    ,

    com.mongodb.Mongo

  58. def getReadPreference: ReadPreference

    Gets the read preference for this collection.

    Gets the read preference for this collection. Will be used as default for reads from any collection in this collection. See the documentation for com.mongodb.casbah.ReadPreference for more information.

    Definition Classes
    MongoCollectionBase
  59. def getStats: CommandResult

    Definition Classes
    MongoCollectionBase
  60. def getWriteConcern: WriteConcern

    get the write concern for this database, which is used for writes to any collection in this database.

    get the write concern for this database, which is used for writes to any collection in this database. See the documentation for com.mongodb.WriteConcern for more info.

    Definition Classes
    MongoCollectionBase
    See also

    http://www.thebuzzmedia.com/mongodb-single-server-data-durability-guide/

    ,

    WriteConcern

  61. def group[A, B, C](key: A, cond: B, initial: C, reduce: String, finalize: String, readPrefs: ReadPreference)(implicit arg0: (A) ⇒ DBObject, arg1: (B) ⇒ DBObject, arg2: (C) ⇒ DBObject): Iterable[T]

    Applies a group operation

    Applies a group operation

    key

    the key to group { a : true }

    cond

    optional condition on query

    initial

    initial value for first match on a key

    reduce

    javascript reduce function

    finalize

    An optional function that can operate on the result(s) of the reduce function.

    readPrefs

    ReadPreferences for this command

    returns

    The results of the group

    Definition Classes
    MongoCollectionBase
  62. def hashCode(): Int

    Definition Classes
    MongoCollectionBase → AnyRef → Any
  63. def hintFields_=[A](docs: List[A])(implicit arg0: (A) ⇒ DBObject): Unit

    Set hint fields for this collection.

    Set hint fields for this collection.

    docs

    a list of DBObjects to be used as hints

    Definition Classes
    MongoCollectionBase
  64. def indexInfo: Buffer[DBObject]

    Return a list of the indexes for this collection.

    Return a list of the indexes for this collection. Each object in the list is the "info document" from MongoDB

    returns

    list of index documents

    Definition Classes
    MongoCollectionBase
  65. def initializeOrderedBulkOperation: BulkWriteOperation

    Creates a builder for an ordered bulk operation.

    Creates a builder for an ordered bulk operation. Write requests included in the bulk operations will be executed in order, and will halt on the first failure.

    returns

    the builder

    Definition Classes
    MongoCollectionBase
    Since

    2.7

  66. def initializeUnorderedBulkOperation: BulkWriteOperation

    Creates a builder for an unordered bulk operation.

    Creates a builder for an unordered bulk operation. Write requests included in the bulk operation will be executed in an undefined order, and all requests will be executed even if some fail.

    returns

    the builder

    Definition Classes
    MongoCollectionBase
    Since

    2.7

  67. def insert[A](docs: A*)(implicit dbObjView: (A) ⇒ DBObject, concern: WriteConcern, encoder: DBEncoder): WriteResult

    Saves document(s) to the database.

    Saves document(s) to the database. if doc doesn't have an _id, one will be added you can get the _id that was added from doc after the insert

    docs

    array of documents (<% DBObject) to save TODO - Wrapper for WriteResult?

    Definition Classes
    MongoCollectionBase
  68. def insert[A](doc: A, concern: WriteConcern)(implicit dbObjView: (A) ⇒ DBObject): WriteResult

    Saves document(s) to the database.

    Saves document(s) to the database. if doc doesn't have an _id, one will be added you can get the _id that was added from doc after the insert

    doc

    array of documents (<% DBObject) to save

    concern

    the WriteConcern for the insert

    Definition Classes
    MongoCollectionBase
  69. def internalClass_=(path: String, c: Class[_]): Unit

    Definition Classes
    MongoCollectionBase
  70. def isCapped: Boolean

    Definition Classes
    MongoCollectionBase
  71. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  72. def iterator: CursorType

    Definition Classes
    MongoCollectionBase
  73. var log: Logger

    Attributes
    protected[casbah]
    Definition Classes
    Logging
  74. def mapReduce(cmd: MapReduceCommand): MapReduceResult

    mapReduce execute a mapReduce against this collection.

    mapReduce execute a mapReduce against this collection.

    Throws a MongoExecutionTimeoutException if exceeds max duration limit otherwise returns a MapReduceResult

    cmd

    the MapReduceCommand

    Definition Classes
    MongoCollectionBase
  75. def mapReduce(mapFunction: JSFunction, reduceFunction: JSFunction, output: MapReduceOutputTarget, query: Option[DBObject] = None, sort: Option[DBObject] = None, limit: Option[Int] = None, finalizeFunction: Option[JSFunction] = None, jsScope: Option[DBObject] = None, verbose: Boolean = false, maxTime: Option[Duration] = None): MapReduceResult

    mapReduce execute a mapReduce against this collection.

    mapReduce execute a mapReduce against this collection.

    mapFunction

    the map function (JSFunction is just a type alias for String)

    reduceFunction

    the reduce function (JSFunction is just a type alias for String)

    output

    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

    Definition Classes
    MongoCollectionBase
  76. def name: String

    Definition Classes
    MongoCollectionBase
  77. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  78. final def notify(): Unit

    Definition Classes
    AnyRef
  79. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  80. def objectClass: Class[_]

    Gets the default class for objects in the collection

    Gets the default class for objects in the collection

    returns

    the class

    Definition Classes
    MongoCollectionBase
  81. def objectClass_=[A <: DBObject](c: Class[A])(implicit arg0: Manifest[A]): MongoGenericTypedCollection[A]

    setObjectClass

    setObjectClass

    Set a subtype of DBObject which will be used to deserialize documents returned from MongoDB.

    This method will return a new MongoTypedCollection[A] which you should capture if you want explicit casting. Else, this collection will instantiate instances of A but cast them to the current T (DBObject if you have a generic collection)

    A

    A Subtype of DBObject

    c

    (Class[A])

    Definition Classes
    MongoCollectionBase
  82. def options: Int

    Manipulate Network Options

    Manipulate Network Options

    Definition Classes
    MongoCollectionBase
    See also

    com.mongodb.Bytes

    ,

    com.mongodb.Mongo

  83. def parallelScan(options: ParallelScanOptions): Buffer[Cursor]

    Return a list of cursors over the collection that can be used to scan it in parallel.

    Return a list of cursors over the collection that can be used to scan it in parallel.

    Note: As of MongoDB 2.6, this method will work against a mongod, but not a mongos.

    options

    the parallel scan options

    returns

    a list of cursors, whose size may be less than the number requested

    Definition Classes
    MongoCollectionBase
    Since

    2.7

  84. def readPreference: ReadPreference

    Gets the read preference for this collection.

    Gets the read preference for this collection. Will be used as default for reads from any collection in this collection. See the documentation for com.mongodb.casbah.ReadPreference for more information.

    Definition Classes
    MongoCollectionBase
  85. def readPreference_=(pref: ReadPreference): Unit

    Sets the read preference for this collection.

    Sets the read preference for this collection. Will be used as default for reads from any collection in this collection. See the documentation for com.mongodb.casbah.ReadPreference for more information.

    pref

    Read Preference to use

    Definition Classes
    MongoCollectionBase
  86. def remove[A](o: A, concern: WriteConcern)(implicit dbObjView: (A) ⇒ DBObject, encoder: DBEncoder): WriteResult

    Removes objects from the database collection.

    Removes objects from the database collection.

    o

    the object that documents to be removed must match

    concern

    WriteConcern for this operation TODO - Wrapper for WriteResult?

    Definition Classes
    MongoCollectionBase
  87. def rename(newName: String, dropTarget: Boolean): MongoCollection

    does a rename of this collection to newName As per the Java API this returns a *NEW* Collection, and the old collection is probably no good anymore.

    does a rename of this collection to newName As per the Java API this returns a *NEW* Collection, and the old collection is probably no good anymore.

    This collection *WILL NOT* mutate --- the instance will still point at a now nonexistant collection with the old name ... You must capture the return value for the new instance.

    newName

    new collection name (not a full namespace)

    dropTarget

    if a collection with the new name exists, whether or not to drop it

    returns

    the new collection

    Definition Classes
    MongoCollectionBase
  88. def rename(newName: String): MongoCollection

    does a rename of this collection to newName As per the Java API this returns a *NEW* Collection, and the old collection is probably no good anymore.

    does a rename of this collection to newName As per the Java API this returns a *NEW* Collection, and the old collection is probably no good anymore.

    This collection *WILL NOT* mutate --- the instance will still point at a now nonexistant collection with the old name ... You must capture the return value for the new instance.

    newName

    new collection name (not a full namespace)

    returns

    the new collection

    Definition Classes
    MongoCollectionBase
  89. def resetOptions(): Unit

    Manipulate Network Options

    Manipulate Network Options

    Definition Classes
    MongoCollectionBase
    See also

    com.mongodb.Bytes

    ,

    com.mongodb.Mongo

  90. def save[A](o: A, concern: WriteConcern)(implicit dbObjView: (A) ⇒ DBObject): WriteResult

    Saves an object to this collection.

    Saves an object to this collection.

    o

    the DBObject to save will add _id field to o if needed TODO - Wrapper for WriteResult?

    Definition Classes
    MongoCollectionBase
  91. def setHintFields[A](docs: List[A])(implicit arg0: (A) ⇒ DBObject): Unit

    Set hint fields for this collection.

    Set hint fields for this collection.

    docs

    a list of DBObjects to be used as hints

    Definition Classes
    MongoCollectionBase
  92. def setInternalClass(path: String, c: Class[_]): Unit

    Definition Classes
    MongoCollectionBase
  93. def setObjectClass[A <: DBObject](c: Class[A])(implicit arg0: Manifest[A]): MongoGenericTypedCollection[A]

    setObjectClass

    setObjectClass

    Set a subtype of DBObject which will be used to deserialize documents returned from MongoDB.

    This method will return a new MongoTypedCollection[A] which you should capture if you want explicit casting. Else, this collection will instantiate instances of A but cast them to the current T (DBObject if you have a generic collection)

    A

    A Subtype of DBObject

    TODO - Ensure proper subtype return

    c

    (Class[A])

    Definition Classes
    MongoCollectionBase
  94. def setReadPreference(pref: ReadPreference): Unit

    Sets the read preference for this collection.

    Sets the read preference for this collection. Will be used as default for reads from any collection in this collection. See the documentation for com.mongodb.casbah.ReadPreference for more information.

    pref

    Read Preference to use

    Definition Classes
    MongoCollectionBase
  95. def setWriteConcern(concern: WriteConcern): Unit

    Set the write concern for this database.

    Set the write concern for this database. Will be used for writes to any collection in this database. See the documentation for com.mongodb.WriteConcern for more info.

    concern

    (WriteConcern) The write concern to use

    Definition Classes
    MongoCollectionBase
    See also

    http://www.thebuzzmedia.com/mongodb-single-server-data-durability-guide/

    ,

    WriteConcern

  96. def stats: CommandResult

    Definition Classes
    MongoCollectionBase
  97. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  98. def toString(): String

    Definition Classes
    MongoCollectionBase → AnyRef → Any
  99. val underlying: DBCollection

    The underlying Java Mongo Driver Collection object we proxy.

    The underlying Java Mongo Driver Collection object we proxy.

    Definition Classes
    MongoGenericTypedCollectionMongoCollectionBase
  100. def update[A, B](q: A, o: B, upsert: Boolean, multi: Boolean, concern: WriteConcern)(implicit queryView: (A) ⇒ DBObject, objView: (B) ⇒ DBObject, encoder: DBEncoder): WriteResult

    Performs an update operation.

    Performs an update operation.

    q

    search query for old object to update

    o

    object with which to update q

    Definition Classes
    MongoCollectionBase
  101. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  104. def writeConcern: WriteConcern

    get the write concern for this database, which is used for writes to any collection in this database.

    get the write concern for this database, which is used for writes to any collection in this database. See the documentation for com.mongodb.WriteConcern for more info.

    Definition Classes
    MongoCollectionBase
    See also

    http://www.thebuzzmedia.com/mongodb-single-server-data-durability-guide/

    ,

    WriteConcern

  105. def writeConcern_=(concern: WriteConcern): Unit

    Set the write concern for this database.

    Set the write concern for this database. Will be used for writes to any collection in this database. See the documentation for com.mongodb.WriteConcern for more info.

    concern

    (WriteConcern) The write concern to use

    Definition Classes
    MongoCollectionBase
    See also

    http://www.thebuzzmedia.com/mongodb-single-server-data-durability-guide/

    ,

    WriteConcern

Deprecated Value Members

  1. def aggregate(pipeline: DBObject*): AggregationOutput

    performs an aggregation operation

    performs an aggregation operation

    pipeline

    the aggregation pipeline

    returns

    The aggregation operation's result set

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7) Use aggregate(List(DBObject) instead

  2. def apply[A](jo: A, ensureID: Boolean)(implicit arg0: (A) ⇒ DBObject): AnyRef

    Adds the "private" fields _id to an object.

    Adds the "private" fields _id to an object.

    jo

    object to which to add fields

    ensureID

    whether to add an _id field or not

    returns

    the modified object o

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) This will be removed in a future release

  3. def apply[A](o: A)(implicit arg0: (A) ⇒ DBObject): AnyRef

    Adds the "private" fields _id to an object.

    Adds the "private" fields _id to an object.

    o

    DBObject to which to add fields

    returns

    the modified parameter object

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) This will be removed in a future release

  4. def ensureIndex(fieldName: String): Unit

    Ensures an index on this collection (that is, the index will be created if it does not exist).

    Ensures an index on this collection (that is, the index will be created if it does not exist). ensureIndex is optimized and is inexpensive if the index already exists. This creates an ascending index on a particular field.

    fieldName

    an identifier for the index

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) Use createIndex instead

  5. def ensureIndex[A](keys: A, name: String, unique: Boolean)(implicit arg0: (A) ⇒ DBObject): Unit

    Ensures an optionally unique index on this collection.

    Ensures an optionally unique index on this collection.

    keys

    fields to use for index

    name

    an identifier for the index

    unique

    if the index should be unique

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) Use createIndex instead

  6. def ensureIndex[A](keys: A, name: String)(implicit arg0: (A) ⇒ DBObject): Unit

    Ensures an index on this collection (that is, the index will be created if it does not exist).

    Ensures an index on this collection (that is, the index will be created if it does not exist). ensureIndex is optimized and is inexpensive if the index already exists.

    keys

    fields to use for index

    name

    an identifier for the index

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) Use createIndex instead

  7. def ensureIndex[A, B](keys: A, options: B)(implicit arg0: (A) ⇒ DBObject, arg1: (B) ⇒ DBObject): Unit

    Ensures an index on this collection (that is, the index will be created if it does not exist).

    Ensures an index on this collection (that is, the index will be created if it does not exist). ensureIndex is optimized and is inexpensive if the index already exists.

    keys

    fields to use for index

    options

    options for the index (name, unique, etc)

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) Use createIndex instead

  8. def ensureIndex[A](keys: A)(implicit arg0: (A) ⇒ DBObject): Unit

    Creates an index on a set of fields, if one does not already exist.

    Creates an index on a set of fields, if one does not already exist.

    keys

    an object with a key set of the fields desired for the index

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) Use createIndex instead

  9. def find[A, B](ref: A, fields: B, numToSkip: Int, batchSize: Int)(implicit arg0: (A) ⇒ DBObject, arg1: (B) ⇒ DBObject): CursorType

    Finds an object.

    Finds an object.

    ref

    query used to search

    fields

    the fields of matching objects to return

    numToSkip

    will not return the first numToSkip matches

    batchSize

    if positive, is the # of objects per batch sent back from the db. All objects that match will be returned. if batchSize < 0, its a hard limit, and only 1 batch will either batchSize or the # that fit in a batch

    returns

    the objects, if found

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7) Use find().skip().batchSize().

  10. def getLastError(w: Int, wTimeout: Int, fsync: Boolean): CommandResult

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) This will be removed in a future release

  11. def getLastError(concern: WriteConcern): CommandResult

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) This will be removed in a future release

  12. def getLastError(): CommandResult

    Gets the the error (if there is one) from the previous operation.

    Gets the the error (if there is one) from the previous operation. The result of this command will look like

    { "err" :  errorMessage  , "ok" : 1.0 }
    

    The value for errorMessage will be null if no error occurred, or a description otherwise.

    Care must be taken to ensure that calls to getLastError go to the same connection as that of the previous operation. See com.mongodb.Mongo.requestStart for more information.

    returns

    DBObject with error and status information

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) This will be removed in a future release

  13. def lastError(w: Int, wTimeout: Int, fsync: Boolean): CommandResult

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) This will be removed in a future release

  14. def lastError(concern: WriteConcern): CommandResult

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) This will be removed in a future release

  15. def lastError(): CommandResult

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) This will be removed in a future release

  16. def request(writeConcern: WriteConcern)(op: (MongoGenericTypedCollection.this.type) ⇒ WriteResult): Unit

    write concern aware write op block.

    write concern aware write op block.

    Checks getLastError after the last write. If you run multiple ops you'll only get the final error.

    Your op function gets a copy of this MongoDB instance.

    This is for write ops only - you cannot return data from it.

    Your function must return WriteResult, which is the return type of any mongo write operation like insert/save/update/remove

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) This will be removed in a future release

    Exceptions thrown
    MongoException()
  17. def request(w: Int, wTimeout: Int = 0, fsync: Boolean = false)(op: (MongoGenericTypedCollection.this.type) ⇒ WriteResult): Unit

    write concern aware write op block.

    write concern aware write op block.

    Checks getLastError after the last write. If you run multiple ops you'll only get the final error.

    Your op function gets a copy of this MongoDB instance.

    This is for write ops only - you cannot return data from it.

    Your function must return WriteResult, which is the return type of any mongo write operation like insert/save/update/remove

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) This will be removed in a future release

    Exceptions thrown
    MongoException()
  18. def request(op: (MongoGenericTypedCollection.this.type) ⇒ WriteResult): Unit

    write concern aware write op block.

    write concern aware write op block.

    Checks getLastError after the last write. If you run multiple ops you'll only get the final error.

    Your op function gets a copy of this MongoDB instance.

    This is for write ops only - you cannot return data from it.

    Your function must return WriteResult, which is the return type of any mongo write operation like insert/save/update/remove

    If you have set a connection or DB level WriteConcern, it will be inherited.

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) This will be removed in a future release

    Exceptions thrown
    MongoException()
  19. def resetIndexCache(): Unit

    Clears all indices that have not yet been applied to this collection.

    Clears all indices that have not yet been applied to this collection.

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.8) This will be removed in a future release

  20. def slaveOk(): Unit

    Sets queries to be OK to run on slave nodes.

    Sets queries to be OK to run on slave nodes.

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated @SuppressWarnings()
    Deprecated

    (Since version 2.3.0) Replaced with ReadPreference.SECONDARY

  21. def updateMulti[A, B](q: A, o: B)(implicit arg0: (A) ⇒ DBObject, arg1: (B) ⇒ DBObject): WriteResult

    Perform a multi update

    Perform a multi update

    q

    search query for old object to update

    o

    object with which to update q

    Definition Classes
    MongoCollectionBase
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.0) In the face of default arguments this is a bit silly. Please use update(multi=True).

Inherited from MongoTypedCollection

Inherited from MongoCollectionBase

Inherited from Logging

Inherited from AnyRef

Inherited from Any