mongo::IndexDetails Class Reference

#include <index.h>

List of all members.

Public Member Functions

bool dropDups () const
BSONObj getKeyFromQuery (const BSONObj &query) const
void getKeysFromObject (const BSONObj &obj, BSONObjSetDefaultOrder &keys) const
const IndexSpecgetSpec () const
bool hasKey (const BSONObj &key)
string indexName () const
string indexNamespace () const
bool inKeyPattern (const string &key) const
bool isIdIndex () const
BSONObj keyPattern () const
int keyPatternOffset (const string &key) const
void kill_idx ()
string parentNS () const
string toString () const
bool unique () const
bool wouldCreateDup (const BSONObj &key, DiskLoc self)

Static Public Member Functions

static bool isIdIndexPattern (const BSONObj &pattern)

Public Attributes

DiskLoc head
DiskLoc info

Detailed Description

Definition at line 34 of file index.h.


Member Function Documentation

bool mongo::IndexDetails::dropDups (  )  const [inline]

Definition at line 137 of file index.h.

BSONObj mongo::IndexDetails::getKeyFromQuery ( const BSONObj query  )  const [inline]

Definition at line 60 of file index.h.

void mongo::IndexDetails::getKeysFromObject ( const BSONObj obj,
BSONObjSetDefaultOrder keys 
) const
const IndexSpec& mongo::IndexDetails::getSpec (  )  const
bool mongo::IndexDetails::hasKey ( const BSONObj key  )  [inline]

Definition at line 576 of file btree.h.

string mongo::IndexDetails::indexName (  )  const [inline]

Definition at line 104 of file index.h.

string mongo::IndexDetails::indexNamespace (  )  const [inline]

Definition at line 93 of file index.h.

bool mongo::IndexDetails::inKeyPattern ( const string &  key  )  const [inline]

Definition at line 85 of file index.h.

bool mongo::IndexDetails::isIdIndex (  )  const [inline]

Definition at line 117 of file index.h.

static bool mongo::IndexDetails::isIdIndexPattern ( const BSONObj pattern  )  [inline, static]

Definition at line 109 of file index.h.

BSONObj mongo::IndexDetails::keyPattern (  )  const [inline]

Definition at line 76 of file index.h.

int mongo::IndexDetails::keyPatternOffset ( const string &  key  )  const
Returns:
offset into keyPattern for key -1 if doesn't exist
void mongo::IndexDetails::kill_idx (  ) 
string mongo::IndexDetails::parentNS (  )  const [inline]

Definition at line 124 of file index.h.

string mongo::IndexDetails::toString (  )  const [inline]

Definition at line 148 of file index.h.

bool mongo::IndexDetails::unique (  )  const [inline]

Definition at line 129 of file index.h.

bool mongo::IndexDetails::wouldCreateDup ( const BSONObj key,
DiskLoc  self 
) [inline]

Definition at line 579 of file btree.h.


Member Data Documentation

btree head disk location TODO We should make this variable private, since btree operations may change its value and we don't want clients to rely on an old value. If we create a btree class, we can provide a btree object to clients instead of 'head'.

Definition at line 43 of file index.h.

Definition at line 54 of file index.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


mongodb
Author(s): Nate Koenig
autogenerated on Fri Jan 11 12:15:55 2013