mongo::IndexPlugin Class Reference

#include <indexkey.h>

List of all members.

Public Member Functions
virtual BSONObj	adjustIndexSpec (const BSONObj &spec) const
virtual IndexType *	generate (const IndexSpec *spec) const =0
string	getName () const
	IndexPlugin (const string &name)
virtual	~IndexPlugin ()
Static Public Member Functions
static string	findPluginName (const BSONObj &keyPattern)
static IndexPlugin *	get (const string &name)
Private Attributes
string	_name
Static Private Attributes
static map< string, IndexPlugin * > *	_plugins

---

Detailed Description

this represents a plugin a plugin could be something like full text search, sparse index, etc... 1 of these exists per type of index per server 1 IndexType is created per index using this plugin

Definition at line 76 of file indexkey.h.

---

Constructor & Destructor Documentation

mongo::IndexPlugin::IndexPlugin

(

const string &

name

)

virtual mongo::IndexPlugin::~IndexPlugin

(

)

[inline, virtual]

Definition at line 79 of file indexkey.h.

---

Member Function Documentation

virtual BSONObj mongo::IndexPlugin::adjustIndexSpec

(

const BSONObj &

spec

)

const [inline, virtual]

Returns:

new keyPattern if nothing changes, should return keyPattern

Definition at line 89 of file indexkey.h.

static string mongo::IndexPlugin::findPluginName

(

const BSONObj &

keyPattern

)

[static]

Parameters:

keyPattern

{ x : "fts" }

Returns:

"" or the name

virtual IndexType* mongo::IndexPlugin::generate

(

const IndexSpec *

spec

)

const [pure virtual]

static IndexPlugin* mongo::IndexPlugin::get

(

const string &

name

)

[inline, static]

Definition at line 93 of file indexkey.h.

string mongo::IndexPlugin::getName

(

)

const [inline]

Definition at line 83 of file indexkey.h.

---

Member Data Documentation

string mongo::IndexPlugin::_name [private]

Definition at line 109 of file indexkey.h.

map<string,IndexPlugin*>* mongo::IndexPlugin::_plugins [static, private]

Definition at line 110 of file indexkey.h.

---

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

• indexkey.h