mongo::DBClientBase Class Reference

abstract class that implements the core db operations More...

#include <dbclientinterface.h>

Inheritance diagram for mongo::DBClientBase:

Public Member Functions
long long	getConnectionId () const
WriteConcern	getWriteConcern () const
void	setWriteConcern (WriteConcern w)
virtual auto_ptr< DBClientCursor >	query (const string &ns, Query query, int nToReturn=0, int nToSkip=0, const BSONObj *fieldsToReturn=0, int queryOptions=0, int batchSize=0)
	send a query to the database. More...
virtual unsigned long long	query (boost::function< void(const BSONObj &)> f, const string &ns, Query query, const BSONObj *fieldsToReturn=0, int queryOptions=0)
	Uses QueryOption_Exhaust, when available. More...
virtual unsigned long long	query (boost::function< void(DBClientCursorBatchIterator &)> f, const string &ns, Query query, const BSONObj *fieldsToReturn=0, int queryOptions=0)
virtual auto_ptr< DBClientCursor >	getMore (const string &ns, long long cursorId, int nToReturn=0, int options=0)
	don't use this - called automatically by DBClientCursor for you More...
virtual void	insert (const string &ns, BSONObj obj, int flags=0)
	insert an object into the database
virtual void	insert (const string &ns, const vector< BSONObj > &v, int flags=0)
	insert a vector of objects into the database
virtual void	update (const string &ns, Query query, BSONObj obj, bool upsert=false, bool multi=false)
	updates objects matching query
virtual void	update (const string &ns, Query query, BSONObj obj, int flags)
virtual void	remove (const string &ns, Query q, bool justOne=0)
	remove matching objects from the database More...
virtual void	remove (const string &ns, Query query, int flags)
virtual bool	isFailed () const =0
virtual bool	isStillConnected ()=0
	if not checked recently, checks whether the underlying socket/sockets are still valid
virtual void	killCursor (long long cursorID)=0
virtual bool	callRead (Message &toSend, Message &response)=0
virtual ConnectionString::ConnectionType	type () const =0
virtual double	getSoTimeout () const =0
virtual uint64_t	getSockCreationMicroSec () const
Public Member Functions inherited from mongo::DBClientWithCommands
bool	simpleCommand (const string &dbname, BSONObj *info, const string &command)
	helper function. More...
virtual bool	runCommand (const string &dbname, const BSONObj &cmd, BSONObj &info, int options=0)
	Run a database command. More...
void	auth (const BSONObj &params)
	Authenticate a user. More...
bool	auth (const string &dbname, const string &username, const string &pwd, string &errmsg, bool digestPassword=true)
	Authorize access to a particular database. More...
virtual void	logout (const string &dbname, BSONObj &info)
	Logs out the connection for the given database. More...
virtual unsigned long long	count (const string &ns, const BSONObj &query=BSONObj(), int options=0, int limit=0, int skip=0)
	count number of objects in collection ns that match the query criteria specified throws UserAssertion if database returns an error
string	createPasswordDigest (const string &username, const string &clearTextPassword)
virtual bool	isMaster (bool &isMaster, BSONObj *info=0)
	returns true in isMaster parm if this db is the current master of a replica pair. More...
bool	createCollection (const string &ns, long long size=0, bool capped=false, int max=0, BSONObj *info=0)
	Create a new collection in the database. More...
string	getLastError (const std::string &db, bool fsync=false, bool j=false, int w=0, int wtimeout=0)
	Get error result from the last write operation (insert/update/delete) on this connection. More...
string	getLastError (bool fsync=false, bool j=false, int w=0, int wtimeout=0)
virtual BSONObj	getLastErrorDetailed (const std::string &db, bool fsync=false, bool j=false, int w=0, int wtimeout=0)
	Get error result from the last write operation (insert/update/delete) on this connection. More...
virtual BSONObj	getLastErrorDetailed (bool fsync=false, bool j=false, int w=0, int wtimeout=0)
BSONObj	getPrevError ()
	Return the last error which has occurred, even if not the very last operation. More...
bool	resetError ()
	Reset the previous error state for this connection (accessed via getLastError and getPrevError). More...
virtual bool	dropCollection (const string &ns, BSONObj *info=NULL)
	Delete the specified collection. More...
bool	repairDatabase (const string &dbname, BSONObj *info=0)
	Perform a repair and compaction of the specified database. More...
bool	copyDatabase (const string &fromdb, const string &todb, const string &fromhost="", BSONObj *info=0)
	Copy database from one server or name to another server or name. More...
bool	setDbProfilingLevel (const string &dbname, ProfilingLevel level, BSONObj *info=0)
bool	getDbProfilingLevel (const string &dbname, ProfilingLevel &level, BSONObj *info=0)
BSONObj	mapreduce (const string &ns, const string &jsmapf, const string &jsreducef, BSONObj query=BSONObj(), MROutput output=MRInline)
	Run a map/reduce job on the server. More...
bool	eval (const string &dbname, const string &jscode, BSONObj &info, BSONElement &retValue, BSONObj *args=0)
	Run javascript code on the database server. More...
bool	validate (const string &ns, bool scandata=true)
	validate a collection, checking for errors and reporting back statistics. More...
bool	eval (const string &dbname, const string &jscode)
template<class T >
bool	eval (const string &dbname, const string &jscode, T parm1)
template<class T , class NumType >
bool	eval (const string &dbname, const string &jscode, T parm1, NumType &ret)
	eval invocation with one parm to server and one numeric field (either int or double) returned
list< string >	getDatabaseNames ()
	get a list of all the current databases uses the { listDatabases : 1 } command. More...
list< string >	getCollectionNames (const string &db)
	get a list of all the current collections in db
bool	exists (const string &ns)
virtual bool	ensureIndex (const string &ns, BSONObj keys, bool unique=false, const string &name="", bool cache=true, bool background=false, int v=-1, int ttl=0)
	Create an index if it does not already exist. More...
virtual void	resetIndexCache ()
	clears the index cache, so the subsequent call to ensureIndex for any index will go to the server
virtual auto_ptr< DBClientCursor >	getIndexes (const string &ns)
virtual void	dropIndex (const string &ns, BSONObj keys)
virtual void	dropIndex (const string &ns, const string &indexName)
virtual void	dropIndexes (const string &ns)
	drops all indexes for the collection
virtual void	reIndex (const string &ns)
string	genIndexName (const BSONObj &keys)
virtual bool	dropDatabase (const string &dbname, BSONObj *info=0)
	Erase / drop an entire database.
virtual string	toString ()=0
Public Member Functions inherited from mongo::DBClientInterface
virtual BSONObj	findOne (const string &ns, const Query &query, const BSONObj *fieldsToReturn=0, int queryOptions=0)
void	findN (vector< BSONObj > &out, const string &ns, Query query, int nToReturn, int nToSkip=0, const BSONObj *fieldsToReturn=0, int queryOptions=0)
	query N objects from the database into an array. More...
virtual string	getServerAddress () const =0
Public Member Functions inherited from mongo::DBConnector
virtual bool	call (Message &toSend, Message &response, bool assertOk=true, string *actualServer=0)=0
	actualServer is set to the actual server where they call went if there was a choice (SlaveOk)
virtual void	say (Message &toSend, bool isRetry=false, string *actualServer=0)=0
virtual void	sayPiggyBack (Message &toSend)=0
virtual bool	recv (Message &m)
virtual void	checkResponse (const char *data, int nReturned, bool *retry=NULL, string *targetHost=NULL)
virtual bool	lazySupported () const =0

Static Public Attributes
static const uint64_t	INVALID_SOCK_CREATION_TIME
Static Public Attributes inherited from mongo::DBClientWithCommands
static MROutput	MRInline

Protected Attributes
long long	_connectionId
WriteConcern	_writeConcern

Static Protected Attributes
static AtomicInt64	ConnectionIdSequence

Additional Inherited Members
Public Types inherited from mongo::DBClientWithCommands
enum	ProfilingLevel { ProfileOff = 0, ProfileSlow = 1, ProfileAll = 2 }
	The Mongo database provides built-in performance profiling capabilities. More...
Static Public Member Functions inherited from mongo::DBClientWithCommands
static string	getLastErrorString (const BSONObj &res)
	Can be called with the returned value from getLastErrorDetailed to extract an error string. More...
Public Attributes inherited from mongo::DBClientWithCommands
int	_logLevel
	controls how chatty the client is about network errors & such. More...
Protected Member Functions inherited from mongo::DBClientWithCommands
bool	isOk (const BSONObj &)
	if the result of a command is ok
bool	isNotMasterErrorString (const BSONElement &e)
	if the element contains a not master error
BSONObj	_countCmd (const string &ns, const BSONObj &query, int options, int limit, int skip)
QueryOptions	availableOptions ()
	Look up the options available on this client. More...
virtual QueryOptions	_lookupAvailableOptions ()
virtual void	_auth (const BSONObj &params)
bool	_authMongoCR (const string &dbname, const string &username, const string &pwd, string &errmsg, bool digestPassword)
	Use the MONGODB-CR protocol to authenticate as "username" against the database "dbname", with the given password. More...

Detailed Description

abstract class that implements the core db operations

Member Function Documentation

auto_ptr< DBClientCursor > mongo::DBClientBase::getMore ( const string &  ns, long long  cursorId, int  nToReturn = 0, int  options = 0  )

virtual

don't use this - called automatically by DBClientCursor for you

Parameters

cursorId

id of cursor to retrieve

Returns

an handle to a previously allocated cursor

Exceptions

AssertionException

Implements mongo::DBClientInterface.

Reimplemented in mongo::SyncClusterConnection.

auto_ptr< DBClientCursor > mongo::DBClientBase::query ( const string &  ns, Query  query, int  nToReturn = 0, int  nToSkip = 0, const BSONObj *  fieldsToReturn = 0, int  queryOptions = 0, int  batchSize = 0  )

virtual

send a query to the database.

Parameters

ns	namespace to query, format is <dbname>.<collectname>[.<collectname>]*
query	query to perform on the collection. this is a BSONObj (binary JSON) You may format as { query: { ... }, orderby: { ... } } to specify a sort order.
nToReturn	n to return (i.e., limit). 0 = unlimited
nToSkip	start with the nth item
fieldsToReturn	optional template of which fields to select. if unspecified, returns all fields
queryOptions	see options enum at top of this file

Returns

cursor. 0 if error (connection failure)

Exceptions

AssertionException

Implements mongo::DBClientInterface.

Reimplemented in mongo::DBClientConnection, mongo::DBClientReplicaSet, and mongo::SyncClusterConnection.

unsigned long long mongo::DBClientBase::query ( boost::function< void(const BSONObj &)>  f, const string &  ns, Query  query, const BSONObj *  fieldsToReturn = 0, int  queryOptions = 0  )

virtual

Uses QueryOption_Exhaust, when available.

Exhaust mode sends back all data queries as fast as possible, with no back-and-forth for OP_GETMORE. If you are certain you will exhaust the query, it could be useful.

Use the DBClientCursorBatchIterator version, below, if you want to do items in large blocks, perhaps to avoid granular locking and such.

void mongo::DBClientBase::remove ( const string &  ns, Query  q, bool  justOne = 0  )

virtual

remove matching objects from the database

Parameters

justOne

if this true, then once a single match is found will stop

Implements mongo::DBClientInterface.

Member Data Documentation

const uint64_t mongo::DBClientBase::INVALID_SOCK_CREATION_TIME

static

Initial value:

=
            static_cast<uint64_t>(0xFFFFFFFFFFFFFFFFULL)

---

The documentation for this class was generated from the following files:

• dbclientinterface.h
• dbclient.cpp