com.mongodb.casbah.MongoDB

Instance Constructors

new MongoDB(underlying: DB)

Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
def addOption(option: Int): Unit

Manipulate Network Options
Manipulate Network Options

See also
com.mongodb.Bytes
,
com.mongodb.Mongo
def apply(collection: String): MongoCollection

Apply method to proxy getCollection, to allow invocation of dbInstance("collectionName") instead of getCollection
Apply method to proxy getCollection, to allow invocation of dbInstance("collectionName") instead of getCollection
collection
a string for the collection name
returns
MongoCollection A wrapped instance of a Mongo DBCollection Class returning generic DBObjects
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def collectionExists(collectionName: String): Boolean

Checks to see if a collection by name %lt;name> exists.
Checks to see if a collection by name %lt;name> exists.
collectionName
The collection to test for existence
returns
false if no collection by that name exists, true if a match to an existing collection was found
def collectionNames(): Set[String]

Returns a set of the names of collections in this database.
Returns a set of the names of collections in this database.
returns
the names of collections in this database
def command(cmd: DBObject, readPreference: ReadPreference): CommandResult

Execute a database command directly.
Execute a database command directly.
returns
the result of the command from the database

See also
List of Commands
def command(cmd: String): CommandResult

Execute a database command directly.
Execute a database command directly.
returns
the result of the command from the database

See also
List of Commands
def command(cmd: DBObject): CommandResult

Execute a database command directly.
Execute a database command directly.
returns
the result of the command from the database

See also
List of Commands
def createCollection(name: String, o: DBObject): DBCollection

Creates a collection with a given name and options.
Creates a collection with a given name and options. If the collection does not exist, a new collection is created. Possible options: <dl> <dt>capped</dt>
boolean: if the collection is capped
<dt>size</dt>
int: collection size
<dt>max</dt>
int: max number of documents
</dl>
name
the name of the collection to return
o
options
returns
the collection
def doEval(code: String, args: AnyRef*): CommandResult
def dropDatabase(): Unit

Drops this database.
Drops this database. Removes all data on disk. Use with caution.
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def eval(code: String, args: AnyRef*): AnyRef
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
final def getClass(): java.lang.Class[_]

Definition Classes
AnyRef → Any
def getCollection(name: String): DBCollection

Gets a collection with a given name.
Gets a collection with a given name. If the collection does not exist, a new collection is created.
name
(String) the name of the collection to return
returns
the collection
def getCollectionFromString(s: String): DBCollection

Returns a collection matching a given string.
Returns a collection matching a given string.
s
the name of the collection
returns
the collection
def getCollectionNames(): Set[String]

Returns a set of the names of collections in this database.
Returns a set of the names of collections in this database.
returns
the names of collections in this database
def getName: String
def getOptions: Int

Manipulate Network Options
Manipulate Network Options

See also
com.mognodb.Bytes
,
com.mongodb.Mongo
def getReadPreference: ReadPreference

Gets the read preference for this database.
Gets the read preference for this database. Will be used as default for reads from any collection in this database. See the documentation for com.mongodb.ReadPreference for more information.
def getSisterDB(name: String): MongoDB
def getStats(): CommandResult
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.

See also
WriteConcern
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def mapReduce(cmd: MapReduceCommand): MapReduceResult

The Java Driver is a bit outdated and is missing the finalize option.
The Java Driver is a bit outdated and is missing the finalize option. Additionally, it returns ZERO information about the actual results of the mapreduce, just a cursor to the result collection. This is less than ideal. So I've wrapped it in something more useful.
cmd
An instance of MapReduceCommand representing the required MapReduce
returns
MapReduceResult a wrapped result object. This contains the returns success, counts etc, but implements iterator and can be iterated directly
def name: String
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def options: Int

Manipulate Network Options
Manipulate Network Options

See also
com.mognodb.Bytes
,
com.mongodb.Mongo
def readPreference: ReadPreference

Gets the read preference for this database.
Gets the read preference for this database. Will be used as default for reads from any collection in this database. See the documentation for com.mongodb.ReadPreference for more information.
def readPreference_=(pref: ReadPreference): Unit
def resetOptions(): Unit

Manipulate Network Options
Manipulate Network Options

See also
com.mongodb.Bytes
,
com.mongodb.Mongo
def setReadPreference(pref: ReadPreference): Unit

Sets the read preference for this database.
Sets the read preference for this database. Will be used as default for reads from any collection in this database. See the documentation for com.mongodb.ReadPreference for more information.
pref
Read Preference to use
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

See also
http://www.thebuzzmedia.com/mongodb-single-server-data-durability-guide/
,
WriteConcern
def stats(): CommandResult
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
MongoDB → AnyRef → Any
val underlying: DB
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 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.

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

See also
http://www.thebuzzmedia.com/mongodb-single-server-data-durability-guide/
,
WriteConcern

Deprecated Value Members

def addUser(username: String, passwd: String): WriteResult

Adds or updates a user for this database
Adds or updates a user for this database
username
the user name
passwd
the password
returns
the result of executing this operation

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
Exceptions thrown
MongoException
def authenticate(username: String, passwd: String): Boolean

Authenticates connection/db with given name and password
Authenticates connection/db with given name and password
username
name of user for this database
passwd
password of user for this database
returns
true if authenticated, false otherwise

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.7) Please use MongoClient to create a client, which will authenticate all connections to server.
def checkedWrite(op: (MongoDB) ⇒ WriteResult): Unit

Checked write block
Checked write block

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
Exceptions thrown
MongoException
if error
def command(cmd: DBObject, options: Int, pref: ReadPreference): CommandResult

Execute a database command directly.
Execute a database command directly.
returns
the result of the command from the database

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
See also
List of Commands
def command(cmd: DBObject, options: Int): CommandResult

Execute a database command directly.
Execute a database command directly.
returns
the result of the command from the database

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
See also
List of Commands
def forceError(): Unit

For testing purposes only - this method forces an error to help test error handling
For testing purposes only - this method forces an error to help test error handling

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
def getLastError(w: Int, wTimeout: Int, fsync: Boolean): CommandResult

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
def getLastError(writeConcern: WriteConcern): CommandResult

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
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

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
def getPreviousError(): CommandResult

Returns the last error that occurred since start of database or a call to resetError()
Returns the last error that occurred since start of database or a call to resetError()
The return object will look like
```
{ err : errorMessage, nPrev : countOpsBack, ok : 1 }
```
The value for errormMessage will be null of no error has ocurred, or the message. The value of countOpsBack will be the number of operations since the error occurred.
Care must be taken to ensure that calls to getPreviousError 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

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.7) This will be removed in a future release
def isAuthenticated: Boolean

Returns true if this DB is authenticated
Returns true if this DB is authenticated
returns
true if authenticated, false otherwise

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.7) Use MongoClient to create an authenticated connection.
def lastError(w: Int, wTimeout: Int, fsync: Boolean): CommandResult

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
def lastError(writeConcern: WriteConcern): CommandResult

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
def lastError(): CommandResult

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
def readOnly_=(b: Boolean): Unit

Makes this database read-only
Makes this database read-only
b
if the database should be read-only

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.7) Avoid making database read-only via this method. Use a read-only user with MongoClient instead.
def request(writeConcern: WriteConcern)(op: (MongoDB) ⇒ 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

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
Exceptions thrown
MongoException
if error
def request(w: Int, wTimeout: Int = 0, fsync: Boolean = false)(op: (MongoDB) ⇒ 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

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
Exceptions thrown
MongoException
if error
def request(op: (MongoDB) ⇒ 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.

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
Exceptions thrown
MongoException
if error
def requestDone(): Unit

Ends the current 'consistent request'.
Ends the current 'consistent request'.

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
def requestEnsureConnection(): Unit

Ensure that a connection is assigned to the current "consistent request" (from primary pool, if connected to a replica set).
Ensure that a connection is assigned to the current "consistent request" (from primary pool, if connected to a replica set).

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
def requestStart(): Unit

Starts a new 'consistent request'.
Starts a new 'consistent request'.
Following this call and until requestDone() is called, all db operations will use the same underlying connection.

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.8) This will be removed in a future release
def resetError(): Unit

Resets the error memory for this database.
Resets the error memory for this database. Used to clear all errors such that getPreviousError() will return no error.

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.7) This will be removed in a future release
def setReadOnly(b: Boolean): Unit

Makes this database read-only
Makes this database read-only
b
if the database should be read-only

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.7) Avoid making database read-only via this method. Use a read-only user with MongoClient instead.
def slaveOk(): Unit

Sets queries to be OK to run on slave nodes.
Sets queries to be OK to run on slave nodes.

Annotations
@deprecated @SuppressWarnings()
Deprecated
(Since version 2.3.0) Replaced with ReadPreference.SECONDARY.

MongoDB

class MongoDB extends AnyRef

Instance Constructors

new MongoDB(underlying: DB)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def addOption(option: Int): Unit

def apply(collection: String): MongoCollection

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def collectionExists(collectionName: String): Boolean

def collectionNames(): Set[String]

def command(cmd: DBObject, readPreference: ReadPreference): CommandResult

def command(cmd: String): CommandResult

def command(cmd: DBObject): CommandResult

def createCollection(name: String, o: DBObject): DBCollection

def doEval(code: String, args: AnyRef*): CommandResult

def dropDatabase(): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def eval(code: String, args: AnyRef*): AnyRef

def finalize(): Unit

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

def getCollection(name: String): DBCollection

def getCollectionFromString(s: String): DBCollection

def getCollectionNames(): Set[String]

def getName: String

def getOptions: Int

def getReadPreference: ReadPreference

def getSisterDB(name: String): MongoDB

def getStats(): CommandResult

def getWriteConcern: WriteConcern

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def mapReduce(cmd: MapReduceCommand): MapReduceResult

def name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def options: Int

def readPreference: ReadPreference

def readPreference_=(pref: ReadPreference): Unit

def resetOptions(): Unit

def setReadPreference(pref: ReadPreference): Unit

def setWriteConcern(concern: WriteConcern): Unit

def stats(): CommandResult

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

def toString(): String

val underlying: DB

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def writeConcern: WriteConcern

def writeConcern_=(concern: WriteConcern): Unit

Deprecated Value Members

def addUser(username: String, passwd: String): WriteResult

def authenticate(username: String, passwd: String): Boolean

def checkedWrite(op: (MongoDB) ⇒ WriteResult): Unit

def command(cmd: DBObject, options: Int, pref: ReadPreference): CommandResult

def command(cmd: DBObject, options: Int): CommandResult

def forceError(): Unit

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

def getLastError(writeConcern: WriteConcern): CommandResult

def getLastError(): CommandResult

def getPreviousError(): CommandResult

def isAuthenticated: Boolean

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

def lastError(writeConcern: WriteConcern): CommandResult

def lastError(): CommandResult

def readOnly_=(b: Boolean): Unit

def request(writeConcern: WriteConcern)(op: (MongoDB) ⇒ WriteResult): Unit

def request(w: Int, wTimeout: Int = 0, fsync: Boolean = false)(op: (MongoDB) ⇒ WriteResult): Unit

def request(op: (MongoDB) ⇒ WriteResult): Unit

def requestDone(): Unit

def requestEnsureConnection(): Unit

def requestStart(): Unit