mongo::IndexSpec Class Reference

#include <indexkey.h>

List of all members.

Public Member Functions
const IndexDetails *	getDetails () const
void	getKeys (const BSONObj &obj, BSONObjSetDefaultOrder &keys) const
IndexType *	getType () const
string	getTypeName () const
	IndexSpec (const DiskLoc &loc)
	IndexSpec (const BSONObj &k, const BSONObj &m=BSONObj())
	IndexSpec ()
BSONElement	missingField () const
void	reset (const IndexDetails *details)
void	reset (const DiskLoc &loc)
IndexSuitability	suitability (const BSONObj &query, const BSONObj &order) const
Public Attributes
bool	_finishedInit
BSONObj	info
BSONObj	keyPattern
Protected Member Functions
void	_getKeys (vector< const char * > fieldNames, vector< BSONElement > fixed, const BSONObj &obj, BSONObjSetDefaultOrder &keys) const
void	_init ()
IndexSuitability	_suitability (const BSONObj &query, const BSONObj &order) const
Protected Attributes
const IndexDetails *	_details
vector< const char * >	_fieldNames
vector< BSONElement >	_fixed
shared_ptr< IndexType >	_indexType
int	_nFields
BSONElement	_nullElt
BSONObj	_nullKey
BSONObj	_nullObj
BSONSizeTracker	_sizeTracker
bool	_sparse
Friends
class	IndexType

---

Detailed Description

Definition at line 116 of file indexkey.h.

---

Constructor & Destructor Documentation

mongo::IndexSpec::IndexSpec

(

)

[inline]

Definition at line 121 of file indexkey.h.

mongo::IndexSpec::IndexSpec	(	const BSONObj &	k,
		const BSONObj &	m = BSONObj()
	)			[inline]

Definition at line 125 of file indexkey.h.

mongo::IndexSpec::IndexSpec

(

const DiskLoc &

loc

)

[inline]

this is a DiscLoc of an IndexDetails info should have a key field

Definition at line 134 of file indexkey.h.

---

Member Function Documentation

void mongo::IndexSpec::_getKeys	(	vector< const char * >	fieldNames,
		vector< BSONElement >	fixed,
		const BSONObj &	obj,
		BSONObjSetDefaultOrder &	keys
	)			const [protected]

void mongo::IndexSpec::_init

(

)

[protected]

IndexSuitability mongo::IndexSpec::_suitability	(	const BSONObj &	query,
		const BSONObj &	order
	)			const [protected]

const IndexDetails* mongo::IndexSpec::getDetails

(

)

const [inline]

Definition at line 155 of file indexkey.h.

void mongo::IndexSpec::getKeys	(	const BSONObj &	obj,
		BSONObjSetDefaultOrder &	keys
	)			const

IndexType* mongo::IndexSpec::getType

(

)

const [inline]

Definition at line 151 of file indexkey.h.

string mongo::IndexSpec::getTypeName

(

)

const [inline]

Definition at line 145 of file indexkey.h.

BSONElement mongo::IndexSpec::missingField

(

)

const [inline]

Definition at line 143 of file indexkey.h.

void mongo::IndexSpec::reset

(

const IndexDetails *

details

)

void mongo::IndexSpec::reset

(

const DiskLoc &

loc

)

IndexSuitability mongo::IndexSpec::suitability	(	const BSONObj &	query,
		const BSONObj &	order
	)			const

---

Friends And Related Function Documentation

friend class IndexType [friend]

Definition at line 189 of file indexkey.h.

---

Member Data Documentation

const IndexDetails* mongo::IndexSpec::_details [protected]

Definition at line 182 of file indexkey.h.

vector<const char*> mongo::IndexSpec::_fieldNames [protected]

Definition at line 169 of file indexkey.h.

bool mongo::IndexSpec::_finishedInit

Definition at line 187 of file indexkey.h.

vector<BSONElement> mongo::IndexSpec::_fixed [protected]

Definition at line 170 of file indexkey.h.

shared_ptr<IndexType> mongo::IndexSpec::_indexType [protected]

Definition at line 180 of file indexkey.h.

int mongo::IndexSpec::_nFields [protected]

Definition at line 177 of file indexkey.h.

BSONElement mongo::IndexSpec::_nullElt [protected]

Definition at line 175 of file indexkey.h.

BSONObj mongo::IndexSpec::_nullKey [protected]

Definition at line 172 of file indexkey.h.

BSONObj mongo::IndexSpec::_nullObj [protected]

Definition at line 174 of file indexkey.h.

BSONSizeTracker mongo::IndexSpec::_sizeTracker [protected]

Definition at line 167 of file indexkey.h.

bool mongo::IndexSpec::_sparse [protected]

Definition at line 178 of file indexkey.h.

BSONObj mongo::IndexSpec::info

Definition at line 119 of file indexkey.h.

BSONObj mongo::IndexSpec::keyPattern

Definition at line 118 of file indexkey.h.

---

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

• indexkey.h