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.
- Version
2.0, 12/23/10
- Since
1.0
- Alphabetic
- By Inheritance
- MongoCollection
- Iterable
- IterableLike
- Equals
- GenIterable
- GenIterableLike
- Traversable
- GenTraversable
- GenericTraversableTemplate
- TraversableLike
- GenTraversableLike
- Parallelizable
- TraversableOnce
- GenTraversableOnce
- FilterMonadic
- HasNewBuilder
- MongoCollectionBase
- Logging
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new MongoCollection(underlying: DBCollection)
Type Members
-
type
CursorType = MongoCursor
- Definition Classes
- MongoCollection → MongoCollectionBase
-
type
Self = Iterable[commons.TypeImports.DBObject]
- Attributes
- protected[this]
- Definition Classes
- TraversableLike
-
type
T = DBObject
- Definition Classes
- MongoCollection → MongoCollectionBase
-
class
WithFilter extends FilterMonadic[A, Repr]
- Definition Classes
- TraversableLike
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
++[B >: commons.TypeImports.DBObject, That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[Iterable[commons.TypeImports.DBObject], B, That]): That
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
++:[B >: commons.TypeImports.DBObject, That](that: Traversable[B])(implicit bf: CanBuildFrom[Iterable[commons.TypeImports.DBObject], B, That]): That
- Definition Classes
- TraversableLike
-
def
++:[B >: commons.TypeImports.DBObject, That](that: TraversableOnce[B])(implicit bf: CanBuildFrom[Iterable[commons.TypeImports.DBObject], B, That]): That
- Definition Classes
- TraversableLike
-
def
+=[A](x: A)(implicit arg0: (A) ⇒ commons.TypeImports.DBObject): TypeImports.WriteResult
Save an object to the Collection
Save an object to the Collection
- x
object to save to the collection
- Definition Classes
- MongoCollectionBase
-
def
-=[A](x: A)(implicit arg0: (A) ⇒ commons.TypeImports.DBObject): TypeImports.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
-
def
/:[B](z: B)(op: (B, commons.TypeImports.DBObject) ⇒ B): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
:\[B](z: B)(op: (commons.TypeImports.DBObject, B) ⇒ B): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
_newCursor(cursor: DBCursor): MongoCursor
_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
(MongoCursorBase)
- Definition Classes
- MongoCollection → MongoCollectionBase
-
def
_newInstance(collection: DBCollection): MongoCollection
_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
- MongoCollection → MongoCollectionBase
-
def
_typedValue(dbObj: commons.TypeImports.DBObject): Option[commons.TypeImports.DBObject]
- Attributes
- protected
- Definition Classes
- MongoCollection → MongoCollectionBase
-
def
addOption(option: Int): Unit
Manipulate Network Options
Manipulate Network Options
- Definition Classes
- MongoCollectionBase
- See also
com.mongodb.Bytes
com.mongodb.Mongo
-
def
addString(b: StringBuilder): StringBuilder
- Definition Classes
- TraversableOnce
-
def
addString(b: StringBuilder, sep: String): StringBuilder
- Definition Classes
- TraversableOnce
-
def
addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder
- Definition Classes
- TraversableOnce
-
def
aggregate[B](z: ⇒ B)(seqop: (B, commons.TypeImports.DBObject) ⇒ B, combop: (B, B) ⇒ B): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
aggregate[A](pipeline: Iterable[A], options: AggregationOptions, readPreference: ReadPreference)(implicit arg0: (A) ⇒ commons.TypeImports.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
-
def
aggregate[A](pipeline: Iterable[A], readPreference: ReadPreference)(implicit arg0: (A) ⇒ commons.TypeImports.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
-
def
aggregate[A](pipeline: Iterable[A], options: AggregationOptions)(implicit arg0: (A) ⇒ commons.TypeImports.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
-
def
aggregate[A](pipeline: Iterable[A])(implicit arg0: (A) ⇒ commons.TypeImports.DBObject): AggregationOutput
performs an aggregation operation
performs an aggregation operation
- pipeline
the aggregation pipeline
- returns
The aggregation operation's result set
- Definition Classes
- MongoCollectionBase
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
canEqual(that: Any): Boolean
- Definition Classes
- IterableLike → Equals
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
collect[B, That](pf: PartialFunction[commons.TypeImports.DBObject, B])(implicit bf: CanBuildFrom[Iterable[commons.TypeImports.DBObject], B, That]): That
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
collectFirst[B](pf: PartialFunction[commons.TypeImports.DBObject, B]): Option[B]
- Definition Classes
- TraversableOnce
-
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" );
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
-
def
companion: GenericCompanion[Iterable]
- Definition Classes
- Iterable → GenIterable → Traversable → GenTraversable → GenericTraversableTemplate
-
def
copyToArray[B >: commons.TypeImports.DBObject](xs: Array[B], start: Int, len: Int): Unit
- Definition Classes
- IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
-
def
copyToArray[B >: commons.TypeImports.DBObject](xs: Array[B]): Unit
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
copyToArray[B >: commons.TypeImports.DBObject](xs: Array[B], start: Int): Unit
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
copyToBuffer[B >: commons.TypeImports.DBObject](dest: Buffer[B]): Unit
- Definition Classes
- TraversableOnce
-
def
count(p: (commons.TypeImports.DBObject) ⇒ Boolean): Int
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
count[A, B](query: A = MongoDBObject.empty, fields: B = MongoDBObject.empty, limit: Long = 0, skip: Long = 0, readPrefs: ReadPreference = getReadPreference, maxTime: Duration = Duration(0, MILLISECONDS))(implicit arg0: (A) ⇒ commons.TypeImports.DBObject, arg1: (B) ⇒ commons.TypeImports.DBObject): Int
- Definition Classes
- MongoCollectionBase
-
def
createIndex[A](keys: A, name: String, unique: Boolean)(implicit arg0: (A) ⇒ commons.TypeImports.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
a document that contains pairs with the name of the field or fields to index and order of the index
- name
an identifier for the index. If null or empty, the default name will be used.
- unique
if the index should be unique
- Definition Classes
- MongoCollectionBase
- Exceptions thrown
MongoException
if the operation failed
-
def
createIndex[A](keys: A, name: String)(implicit arg0: (A) ⇒ commons.TypeImports.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
a document that contains pairs with the name of the field or fields to index and order of the index
- name
an identifier for the index. If null or empty, the default name will be used.
- Definition Classes
- MongoCollectionBase
- Exceptions thrown
MongoException
if the operation failed
-
def
createIndex(name: String): Unit
Forces creation of an ascending index on a field with the default options.
Forces creation of an ascending index on a field with the default options.
- name
name of field to index on
- Definition Classes
- MongoCollectionBase
- Exceptions thrown
MongoException
if the operation failed
-
def
createIndex[A, B](keys: A, options: B)(implicit arg0: (A) ⇒ commons.TypeImports.DBObject, arg1: (B) ⇒ commons.TypeImports.DBObject): Unit
Creates an index on the field specified, if that index does not already exist.
Creates an index on the field specified, if that index does not already exist.
- keys
a document that contains pairs with the name of the field or fields to index and order of the index
- options
a document that controls the creation of the index.
- Definition Classes
- MongoCollectionBase
-
def
createIndex[A](keys: A)(implicit arg0: (A) ⇒ commons.TypeImports.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
-
def
customDecoderFactory: Option[DBDecoderFactory]
- Definition Classes
- MongoCollectionBase
-
def
customEncoderFactory: Option[DBEncoderFactory]
- Definition Classes
- MongoCollectionBase
-
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
-
def
distinct[A](key: String, query: A = MongoDBObject.empty, readPrefs: ReadPreference = getReadPreference)(implicit arg0: (A) ⇒ commons.TypeImports.DBObject): Buffer[_]
Find distinct values for a key
Find distinct values for a key
- A
The DBObject type
- key
the key to find the distinct values for
- query
the query (optional)
- readPrefs
the com.mongodb.ReadPreference for the operation.
- Definition Classes
- MongoCollectionBase
-
def
drop(n: Int): Iterable[commons.TypeImports.DBObject]
- Definition Classes
- IterableLike → TraversableLike → GenTraversableLike
-
def
drop(): Unit
Drops (deletes) this collection
Drops (deletes) this collection
- Definition Classes
- MongoCollectionBase
-
def
dropCollection(): Unit
Drops (deletes) this collection
Drops (deletes) this collection
- Definition Classes
- MongoCollectionBase
-
def
dropIndex(name: String): Unit
- Definition Classes
- MongoCollectionBase
-
def
dropIndex[A](keys: A)(implicit arg0: (A) ⇒ commons.TypeImports.DBObject): Unit
- Definition Classes
- MongoCollectionBase
-
def
dropIndexes(name: String): Unit
- Definition Classes
- MongoCollectionBase
-
def
dropIndexes(): Unit
Drops all indices from this collection
Drops all indices from this collection
- Definition Classes
- MongoCollectionBase
-
def
dropRight(n: Int): Iterable[commons.TypeImports.DBObject]
- Definition Classes
- IterableLike
-
def
dropWhile(p: (commons.TypeImports.DBObject) ⇒ Boolean): Iterable[commons.TypeImports.DBObject]
- Definition Classes
- TraversableLike → GenTraversableLike
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
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
-
def
exists(p: (commons.TypeImports.DBObject) ⇒ Boolean): Boolean
- Definition Classes
- IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
-
def
explainAggregate[A](pipeline: Iterable[A], options: AggregationOptions)(implicit arg0: (A) ⇒ commons.TypeImports.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
-
def
filter(p: (commons.TypeImports.DBObject) ⇒ Boolean): Iterable[commons.TypeImports.DBObject]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
filterNot(p: (commons.TypeImports.DBObject) ⇒ Boolean): Iterable[commons.TypeImports.DBObject]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
find(p: (commons.TypeImports.DBObject) ⇒ Boolean): Option[commons.TypeImports.DBObject]
- Definition Classes
- IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
-
def
find[A, B](ref: A, keys: B)(implicit arg0: (A) ⇒ commons.TypeImports.DBObject, arg1: (B) ⇒ commons.TypeImports.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
-
def
find[A](ref: A)(implicit arg0: (A) ⇒ commons.TypeImports.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
-
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
-
def
findAndModify[A, B, C, D](query: A, fields: B, sort: C, remove: Boolean, update: D, returnNew: Boolean, upsert: Boolean, bypassDocumentValidation: Boolean, maxTime: Duration, writeConcern: WriteConcern)(implicit arg0: (A) ⇒ commons.TypeImports.DBObject, arg1: (B) ⇒ commons.TypeImports.DBObject, arg2: (C) ⇒ commons.TypeImports.DBObject, arg3: (D) ⇒ commons.TypeImports.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)
- bypassDocumentValidation
whether to bypass document validation.
- maxTime
the maximum duration that the server will allow this operation to execute before killing it
- writeConcern
the write concern to apply to this operation
- Definition Classes
- MongoCollectionBase
- Since
3.1.0
- Exceptions thrown
MongoException
if the operation failed for some other reasonWriteConcernException
if the write failed due some other failure specific to the update command
-
def
findAndModify[A, B, C, D](query: A, fields: B, sort: C, remove: Boolean, update: D, returnNew: Boolean, upsert: Boolean, bypassDocumentValidation: Boolean, maxTime: Duration)(implicit arg0: (A) ⇒ commons.TypeImports.DBObject, arg1: (B) ⇒ commons.TypeImports.DBObject, arg2: (C) ⇒ commons.TypeImports.DBObject, arg3: (D) ⇒ commons.TypeImports.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)
- bypassDocumentValidation
whether to bypass document validation.
- maxTime
the maximum duration that the server will allow this operation to execute before killing it
- Definition Classes
- MongoCollectionBase
- Since
3.1.0
- Exceptions thrown
MongoException
if the operation failed for some other reasonWriteConcernException
if the write failed due some other failure specific to the update command- Note
bypassDocumentValidation requires MongoDB 3.2 or greater
-
def
findAndModify[A, B, C, D](query: A, fields: B, sort: C, remove: Boolean, update: D, returnNew: Boolean, upsert: Boolean, maxTime: Duration, writeConcern: WriteConcern)(implicit arg0: (A) ⇒ commons.TypeImports.DBObject, arg1: (B) ⇒ commons.TypeImports.DBObject, arg2: (C) ⇒ commons.TypeImports.DBObject, arg3: (D) ⇒ commons.TypeImports.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
- writeConcern
the write concern to apply to this operation
- Definition Classes
- MongoCollectionBase
- Since
3.1.0
- Exceptions thrown
MongoException
if the operation failed for some other reasonWriteConcernException
if the write failed due some other failure specific to the update command
-
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) ⇒ commons.TypeImports.DBObject, arg1: (B) ⇒ commons.TypeImports.DBObject, arg2: (C) ⇒ commons.TypeImports.DBObject, arg3: (D) ⇒ commons.TypeImports.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 document as it was before the modifications, unless
returnNew
is true, in which case it returns the document after the changes were made
- Definition Classes
- MongoCollectionBase
-
def
findAndModify[A, B, C, D](query: A, fields: B, sort: C, remove: Boolean, update: D, returnNew: Boolean, upsert: Boolean, writeConcern: WriteConcern)(implicit arg0: (A) ⇒ commons.TypeImports.DBObject, arg1: (B) ⇒ commons.TypeImports.DBObject, arg2: (C) ⇒ commons.TypeImports.DBObject, arg3: (D) ⇒ commons.TypeImports.DBObject): Option[T]
Atomically modify and return a single document.
Atomically modify and return a single document. By default, the returned document does not include the modifications made on the update.
- query
specifies the selection criteria for the modification
- fields
a subset of fields to return
- sort
determines which document the operation will modify if the query selects multiple documents
- remove
when true, removes the selected document
- update
the modifications to apply
- returnNew
when true, returns the modified document rather than the original
- upsert
when true, operation creates a new document if the query returns no documents
- writeConcern
the write concern to apply to this operation
- returns
the document as it was before the modifications, unless
returnNew
is true, in which case it returns the document after the changes were made
- Definition Classes
- MongoCollectionBase
- Since
3.1.0
- Exceptions thrown
MongoException
if the operation failed for some other reasonWriteConcernException
if the write failed due some other failure specific to the update command
-
def
findAndModify[A, B, C, D](query: A, fields: B, sort: C, remove: Boolean, update: D, returnNew: Boolean, upsert: Boolean)(implicit arg0: (A) ⇒ commons.TypeImports.DBObject, arg1: (B) ⇒ commons.TypeImports.DBObject, arg2: (C) ⇒ commons.TypeImports.DBObject, arg3: (D) ⇒ commons.TypeImports.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 document as it was before the modifications, unless
returnNew
is true, in which case it returns the document after the changes were made
- Definition Classes
- MongoCollectionBase
-
def
findAndModify[A, B, C](query: A, sort: B, update: C)(implicit arg0: (A) ⇒ commons.TypeImports.DBObject, arg1: (B) ⇒ commons.TypeImports.DBObject, arg2: (C) ⇒ commons.TypeImports.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
-
def
findAndModify[A, B](query: A, update: B)(implicit arg0: (A) ⇒ commons.TypeImports.DBObject, arg1: (B) ⇒ commons.TypeImports.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
-
def
findAndRemove[A](query: A)(implicit arg0: (A) ⇒ commons.TypeImports.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
-
def
findOne[A, B, C](o: A = MongoDBObject.empty, fields: B = MongoDBObject.empty, orderBy: C = MongoDBObject.empty, readPrefs: ReadPreference = getReadPreference, maxTime: Duration = Duration(0, MILLISECONDS))(implicit arg0: (A) ⇒ commons.TypeImports.DBObject, arg1: (B) ⇒ commons.TypeImports.DBObject, arg2: (C) ⇒ commons.TypeImports.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
-
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
-
def
findOneByID[B](id: AnyRef, fields: B)(implicit arg0: (B) ⇒ commons.TypeImports.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
-
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
-
def
flatMap[B, That](f: (commons.TypeImports.DBObject) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[Iterable[commons.TypeImports.DBObject], B, That]): That
- Definition Classes
- TraversableLike → GenTraversableLike → FilterMonadic
-
def
flatten[B](implicit asTraversable: (commons.TypeImports.DBObject) ⇒ GenTraversableOnce[B]): Iterable[B]
- Definition Classes
- GenericTraversableTemplate
-
def
fold[A1 >: commons.TypeImports.DBObject](z: A1)(op: (A1, A1) ⇒ A1): A1
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
foldLeft[B](z: B)(op: (B, commons.TypeImports.DBObject) ⇒ B): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
foldRight[B](z: B)(op: (commons.TypeImports.DBObject, B) ⇒ B): B
- Definition Classes
- IterableLike → TraversableOnce → GenTraversableOnce
-
def
forall(p: (commons.TypeImports.DBObject) ⇒ Boolean): Boolean
- Definition Classes
- IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
-
def
foreach[U](f: (commons.TypeImports.DBObject) ⇒ U): Unit
- Definition Classes
- IterableLike → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic
-
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
-
def
genericBuilder[B]: Builder[B, Iterable[B]]
- Definition Classes
- GenericTraversableTemplate
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
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" );
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
-
def
getCount[A, B](query: A = MongoDBObject.empty, fields: B = MongoDBObject.empty, limit: Long = 0, skip: Long = 0, readPrefs: ReadPreference = getReadPreference, maxTime: Duration = Duration(0, MILLISECONDS))(implicit arg0: (A) ⇒ commons.TypeImports.DBObject, arg1: (B) ⇒ commons.TypeImports.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
-
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
-
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
-
def
getIndexInfo: Buffer[commons.TypeImports.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
-
def
getName: String
- Definition Classes
- MongoCollectionBase
-
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
-
def
getOptions: Int
Manipulate Network Options
Manipulate Network Options
- Definition Classes
- MongoCollectionBase
- See also
com.mongodb.Bytes
com.mongodb.Mongo
-
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
-
def
getStats: CommandResult
- Definition Classes
- MongoCollectionBase
-
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
-
def
group[A, B, C](key: A, cond: B, initial: C, reduce: String, finalize: String = null, readPrefs: ReadPreference = getReadPreference)(implicit arg0: (A) ⇒ commons.TypeImports.DBObject, arg1: (B) ⇒ commons.TypeImports.DBObject, arg2: (C) ⇒ commons.TypeImports.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
-
def
groupBy[K](f: (commons.TypeImports.DBObject) ⇒ K): Map[K, Iterable[commons.TypeImports.DBObject]]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
grouped(size: Int): Iterator[Iterable[commons.TypeImports.DBObject]]
- Definition Classes
- IterableLike
-
def
hasDefiniteSize: Boolean
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
-
def
hashCode(): Int
- Definition Classes
- MongoCollectionBase → AnyRef → Any
-
def
head: T
- Definition Classes
- MongoCollection → IterableLike → GenericTraversableTemplate → TraversableLike → GenTraversableLike
-
def
headOption: Option[T]
- Definition Classes
- MongoCollection → TraversableLike → GenTraversableLike
-
def
hintFields_=[A](docs: List[A])(implicit arg0: (A) ⇒ commons.TypeImports.DBObject): Unit
Set hint fields for this collection.
Set hint fields for this collection.
- docs
a list of
DBObject
s to be used as hints
- Definition Classes
- MongoCollectionBase
-
def
indexInfo: Buffer[commons.TypeImports.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
-
def
init: Iterable[commons.TypeImports.DBObject]
- Definition Classes
- TraversableLike → GenTraversableLike
-
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
-
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
-
def
inits: Iterator[Iterable[commons.TypeImports.DBObject]]
- Definition Classes
- TraversableLike
-
def
insert[A](insertOptions: InsertOptions, docs: A*)(implicit dbObjView: (A) ⇒ commons.TypeImports.DBObject): TypeImports.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
- insertOptions
the insertOptions
- docs
array of documents (<% DBObject) to save
- Definition Classes
- MongoCollectionBase
-
def
insert[A](docs: A*)(implicit dbObjView: (A) ⇒ commons.TypeImports.DBObject, concern: WriteConcern = writeConcern, encoder: TypeImports.DBEncoder = ...): TypeImports.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
-
def
insert[A](doc: A, concern: WriteConcern)(implicit dbObjView: (A) ⇒ commons.TypeImports.DBObject): TypeImports.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
-
def
internalClass_=[A <: commons.TypeImports.DBObject](path: String, c: Class[A]): Unit
- Definition Classes
- MongoCollectionBase
-
def
isCapped: Boolean
- Definition Classes
- MongoCollectionBase
-
def
isEmpty: Boolean
- Definition Classes
- IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
isTraversableAgain: Boolean
- Definition Classes
- TraversableLike → GenTraversableLike → GenTraversableOnce
-
def
iterator: CursorType
- Definition Classes
- MongoCollection → IterableLike → GenIterableLike → MongoCollectionBase
-
def
last: commons.TypeImports.DBObject
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
lastOption: Option[commons.TypeImports.DBObject]
- Definition Classes
- TraversableLike → GenTraversableLike
-
val
log: Logger
- Attributes
- protected[com.mongodb.casbah]
- Definition Classes
- Logging
- Annotations
- @transient() @volatile()
-
def
map[B, That](f: (commons.TypeImports.DBObject) ⇒ B)(implicit bf: CanBuildFrom[Iterable[commons.TypeImports.DBObject], B, That]): That
- Definition Classes
- TraversableLike → GenTraversableLike → FilterMonadic
-
def
mapReduce(cmd: map_reduce.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
-
def
mapReduce(mapFunction: Imports.JSFunction, reduceFunction: Imports.JSFunction, output: Imports.MapReduceOutputTarget, query: Option[commons.TypeImports.DBObject] = None, sort: Option[commons.TypeImports.DBObject] = None, limit: Option[Int] = None, finalizeFunction: Option[Imports.JSFunction] = None, jsScope: Option[commons.TypeImports.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
-
def
max[B >: commons.TypeImports.DBObject](implicit cmp: Ordering[B]): commons.TypeImports.DBObject
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
maxBy[B](f: (commons.TypeImports.DBObject) ⇒ B)(implicit cmp: Ordering[B]): commons.TypeImports.DBObject
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
min[B >: commons.TypeImports.DBObject](implicit cmp: Ordering[B]): commons.TypeImports.DBObject
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
minBy[B](f: (commons.TypeImports.DBObject) ⇒ B)(implicit cmp: Ordering[B]): commons.TypeImports.DBObject
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
mkString: String
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
mkString(sep: String): String
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
mkString(start: String, sep: String, end: String): String
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
name: String
- Definition Classes
- MongoCollectionBase
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
newBuilder: Builder[commons.TypeImports.DBObject, Iterable[commons.TypeImports.DBObject]]
- Attributes
- protected[this]
- Definition Classes
- GenericTraversableTemplate → HasNewBuilder
-
def
nonEmpty: Boolean
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
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
-
def
objectClass_=[A <: commons.TypeImports.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 currentT
(DBObject if you have a generic collection)- A
A Subtype of DBObject
- c
(Class[A])
- Definition Classes
- MongoCollectionBase
-
def
options: Int
Manipulate Network Options
Manipulate Network Options
- Definition Classes
- MongoCollectionBase
- See also
com.mongodb.Bytes
com.mongodb.Mongo
-
def
par: ParIterable[commons.TypeImports.DBObject]
- Definition Classes
- Parallelizable
-
def
parCombiner: Combiner[commons.TypeImports.DBObject, ParIterable[commons.TypeImports.DBObject]]
- Attributes
- protected[this]
- Definition Classes
- TraversableLike → Parallelizable
-
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
-
def
partition(p: (commons.TypeImports.DBObject) ⇒ Boolean): (Iterable[commons.TypeImports.DBObject], Iterable[commons.TypeImports.DBObject])
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
product[B >: commons.TypeImports.DBObject](implicit num: Numeric[B]): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
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
-
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
-
def
reduce[A1 >: commons.TypeImports.DBObject](op: (A1, A1) ⇒ A1): A1
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduceLeft[B >: commons.TypeImports.DBObject](op: (B, commons.TypeImports.DBObject) ⇒ B): B
- Definition Classes
- TraversableOnce
-
def
reduceLeftOption[B >: commons.TypeImports.DBObject](op: (B, commons.TypeImports.DBObject) ⇒ B): Option[B]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduceOption[A1 >: commons.TypeImports.DBObject](op: (A1, A1) ⇒ A1): Option[A1]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduceRight[B >: commons.TypeImports.DBObject](op: (commons.TypeImports.DBObject, B) ⇒ B): B
- Definition Classes
- IterableLike → TraversableOnce → GenTraversableOnce
-
def
reduceRightOption[B >: commons.TypeImports.DBObject](op: (commons.TypeImports.DBObject, B) ⇒ B): Option[B]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
remove[A](o: A, concern: WriteConcern = getWriteConcern)(implicit dbObjView: (A) ⇒ commons.TypeImports.DBObject, encoder: TypeImports.DBEncoder = ...): TypeImports.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
-
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
-
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
-
def
repr: Iterable[commons.TypeImports.DBObject]
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
resetOptions(): Unit
Manipulate Network Options
Manipulate Network Options
- Definition Classes
- MongoCollectionBase
- See also
com.mongodb.Bytes
com.mongodb.Mongo
-
def
reversed: List[commons.TypeImports.DBObject]
- Attributes
- protected[this]
- Definition Classes
- TraversableOnce
-
def
sameElements[B >: commons.TypeImports.DBObject](that: GenIterable[B]): Boolean
- Definition Classes
- IterableLike → GenIterableLike
-
def
save[A](o: A, concern: WriteConcern = getWriteConcern)(implicit dbObjView: (A) ⇒ commons.TypeImports.DBObject): TypeImports.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
-
def
scan[B >: commons.TypeImports.DBObject, That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[Iterable[commons.TypeImports.DBObject], B, That]): That
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
scanLeft[B, That](z: B)(op: (B, commons.TypeImports.DBObject) ⇒ B)(implicit bf: CanBuildFrom[Iterable[commons.TypeImports.DBObject], B, That]): That
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
scanRight[B, That](z: B)(op: (commons.TypeImports.DBObject, B) ⇒ B)(implicit bf: CanBuildFrom[Iterable[commons.TypeImports.DBObject], B, That]): That
- Definition Classes
- TraversableLike → GenTraversableLike
- Annotations
- @migration
- Migration
(Changed in version 2.9.0) The behavior of
scanRight
has changed. The previous behavior can be reproduced with scanRight.reverse.
-
def
seq: Iterable[commons.TypeImports.DBObject]
- Definition Classes
- Iterable → GenIterable → Traversable → GenTraversable → Parallelizable → TraversableOnce → GenTraversableOnce
-
def
setHintFields[A](docs: List[A])(implicit arg0: (A) ⇒ commons.TypeImports.DBObject): Unit
Set hint fields for this collection.
Set hint fields for this collection.
- docs
a list of
DBObject
s to be used as hints
- Definition Classes
- MongoCollectionBase
-
def
setInternalClass[A <: commons.TypeImports.DBObject](path: String, c: Class[A]): Unit
- Definition Classes
- MongoCollectionBase
-
def
setObjectClass[A <: commons.TypeImports.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 currentT
(DBObject if you have a generic collection)- A
A Subtype of DBObject TODO - Ensure proper subtype return
- c
(Class[A])
- Definition Classes
- MongoCollectionBase
-
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
-
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
-
def
size: Int
- Definition Classes
- MongoCollection → GenTraversableLike → TraversableOnce → GenTraversableOnce
-
def
sizeHintIfCheap: Int
- Attributes
- protected[scala.collection]
- Definition Classes
- GenTraversableOnce
-
def
slice(from: Int, until: Int): Iterable[commons.TypeImports.DBObject]
- Definition Classes
- IterableLike → TraversableLike → GenTraversableLike
-
def
sliding(size: Int, step: Int): Iterator[Iterable[commons.TypeImports.DBObject]]
- Definition Classes
- IterableLike
-
def
sliding(size: Int): Iterator[Iterable[commons.TypeImports.DBObject]]
- Definition Classes
- IterableLike
-
def
span(p: (commons.TypeImports.DBObject) ⇒ Boolean): (Iterable[commons.TypeImports.DBObject], Iterable[commons.TypeImports.DBObject])
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
splitAt(n: Int): (Iterable[commons.TypeImports.DBObject], Iterable[commons.TypeImports.DBObject])
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
stats: CommandResult
- Definition Classes
- MongoCollectionBase
-
def
stringPrefix: String
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
sum[B >: commons.TypeImports.DBObject](implicit num: Numeric[B]): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
tail: Iterable[commons.TypeImports.DBObject]
- Definition Classes
- MongoCollection → TraversableLike → GenTraversableLike
-
def
tails: Iterator[Iterable[commons.TypeImports.DBObject]]
- Definition Classes
- TraversableLike
-
def
take(n: Int): Iterable[commons.TypeImports.DBObject]
- Definition Classes
- IterableLike → TraversableLike → GenTraversableLike
-
def
takeRight(n: Int): Iterable[commons.TypeImports.DBObject]
- Definition Classes
- IterableLike
-
def
takeWhile(p: (commons.TypeImports.DBObject) ⇒ Boolean): Iterable[commons.TypeImports.DBObject]
- Definition Classes
- IterableLike → TraversableLike → GenTraversableLike
-
def
thisCollection: Iterable[commons.TypeImports.DBObject]
- Attributes
- protected[this]
- Definition Classes
- IterableLike → TraversableLike
-
def
to[Col[_]](implicit cbf: CanBuildFrom[Nothing, commons.TypeImports.DBObject, Col[commons.TypeImports.DBObject]]): Col[commons.TypeImports.DBObject]
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
-
def
toArray[B >: commons.TypeImports.DBObject](implicit arg0: ClassTag[B]): Array[B]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toBuffer[B >: commons.TypeImports.DBObject]: Buffer[B]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toCollection(repr: Iterable[commons.TypeImports.DBObject]): Iterable[commons.TypeImports.DBObject]
- Attributes
- protected[this]
- Definition Classes
- IterableLike → TraversableLike
-
def
toIndexedSeq: IndexedSeq[commons.TypeImports.DBObject]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toIterable: Iterable[commons.TypeImports.DBObject]
- Definition Classes
- IterableLike → TraversableOnce → GenTraversableOnce
-
def
toIterator: Iterator[commons.TypeImports.DBObject]
- Definition Classes
- IterableLike → TraversableLike → GenTraversableOnce
- Annotations
- @deprecatedOverriding( ... , "2.11.0" )
-
def
toList: List[commons.TypeImports.DBObject]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toMap[T, U](implicit ev: <:<[commons.TypeImports.DBObject, (T, U)]): Map[T, U]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toSeq: Seq[commons.TypeImports.DBObject]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toSet[B >: commons.TypeImports.DBObject]: Set[B]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toStream: Stream[commons.TypeImports.DBObject]
- Definition Classes
- IterableLike → TraversableLike → GenTraversableOnce
-
def
toString(): String
- Definition Classes
- MongoCollection → TraversableLike → MongoCollectionBase → AnyRef → Any
-
def
toTraversable: Traversable[commons.TypeImports.DBObject]
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
- Annotations
- @deprecatedOverriding( ... , "2.11.0" )
-
def
toVector: Vector[commons.TypeImports.DBObject]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
transpose[B](implicit asTraversable: (commons.TypeImports.DBObject) ⇒ GenTraversableOnce[B]): Iterable[Iterable[B]]
- Definition Classes
- GenericTraversableTemplate
- Annotations
- @migration
- Migration
(Changed in version 2.9.0)
transpose
throws anIllegalArgumentException
if collections are not uniformly sized.
-
val
underlying: DBCollection
- Definition Classes
- MongoCollection → MongoCollectionBase
-
def
unzip[A1, A2](implicit asPair: (commons.TypeImports.DBObject) ⇒ (A1, A2)): (Iterable[A1], Iterable[A2])
- Definition Classes
- GenericTraversableTemplate
-
def
unzip3[A1, A2, A3](implicit asTriple: (commons.TypeImports.DBObject) ⇒ (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])
- Definition Classes
- GenericTraversableTemplate
-
def
update[A, B](q: A, o: B, upsert: Boolean = false, multi: Boolean = false, concern: WriteConcern = this.writeConcern, bypassDocumentValidation: Option[Boolean] = None)(implicit queryView: (A) ⇒ commons.TypeImports.DBObject, objView: (B) ⇒ commons.TypeImports.DBObject, encoder: TypeImports.DBEncoder = ...): TypeImports.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
-
def
view(from: Int, until: Int): IterableView[commons.TypeImports.DBObject, Iterable[commons.TypeImports.DBObject]]
- Definition Classes
- IterableLike → TraversableLike
-
def
view: IterableView[commons.TypeImports.DBObject, Iterable[commons.TypeImports.DBObject]]
- Definition Classes
- IterableLike → TraversableLike
-
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( ... )
-
def
withFilter(p: (commons.TypeImports.DBObject) ⇒ Boolean): FilterMonadic[commons.TypeImports.DBObject, Iterable[commons.TypeImports.DBObject]]
- Definition Classes
- TraversableLike → FilterMonadic
-
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
-
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
-
def
zip[A1 >: commons.TypeImports.DBObject, B, That](that: GenIterable[B])(implicit bf: CanBuildFrom[Iterable[commons.TypeImports.DBObject], (A1, B), That]): That
- Definition Classes
- IterableLike → GenIterableLike
-
def
zipAll[B, A1 >: commons.TypeImports.DBObject, That](that: GenIterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[Iterable[commons.TypeImports.DBObject], (A1, B), That]): That
- Definition Classes
- IterableLike → GenIterableLike
-
def
zipWithIndex[A1 >: commons.TypeImports.DBObject, That](implicit bf: CanBuildFrom[Iterable[commons.TypeImports.DBObject], (A1, Int), That]): That
- Definition Classes
- IterableLike → GenIterableLike
Deprecated Value Members
-
def
aggregate(pipeline: commons.TypeImports.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
-
def
find[A, B](ref: A, fields: B, numToSkip: Int, batchSize: Int)(implicit arg0: (A) ⇒ commons.TypeImports.DBObject, arg1: (B) ⇒ commons.TypeImports.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()
.
-
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
-
def
updateMulti[A, B](q: A, o: B)(implicit arg0: (A) ⇒ commons.TypeImports.DBObject, arg1: (B) ⇒ commons.TypeImports.DBObject): TypeImports.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)
.