mongo::BSONCollectionCatalogEntry Class Reference

This is a helper class for any storage engine that wants to store catalog information as BSON. More...

#include <bson_collection_catalog_entry.h>

Inheritance diagram for mongo::BSONCollectionCatalogEntry:

Detailed Description

This is a helper class for any storage engine that wants to store catalog information as BSON.

It is totally optional to use this.

Classes
struct	IndexMetaData
struct	MetaData

Public Member Functions
	BSONCollectionCatalogEntry (StringData ns)
virtual	~BSONCollectionCatalogEntry ()
virtual CollectionOptions	getCollectionOptions (OperationContext *opCtx) const
virtual int	getTotalIndexCount (OperationContext *opCtx) const
virtual int	getCompletedIndexCount (OperationContext *opCtx) const
virtual BSONObj	getIndexSpec (OperationContext *opCtx, StringData idxName) const
virtual void	getAllIndexes (OperationContext *opCtx, std::vector< std::string > *names) const
virtual void	getReadyIndexes (OperationContext *opCtx, std::vector< std::string > *names) const
virtual void	getAllUniqueIndexes (OperationContext *opCtx, std::vector< std::string > *names) const
virtual bool	isIndexMultikey (OperationContext *opCtx, StringData indexName, MultikeyPaths *multikeyPaths) const
	Returns true if the index identified by 'indexName' is multikey, and returns false otherwise. More...
virtual RecordId	getIndexHead (OperationContext *opCtx, StringData indexName) const
virtual bool	isIndexReady (OperationContext *opCtx, StringData indexName) const
virtual KVPrefix	getIndexPrefix (OperationContext *opCtx, StringData indexName) const
Public Member Functions inherited from mongo::CollectionCatalogEntry
	CollectionCatalogEntry (StringData ns)
virtual	~CollectionCatalogEntry ()
const NamespaceString &	ns () const
virtual int	getMaxAllowedIndexes () const =0
virtual bool	setIndexIsMultikey (OperationContext *opCtx, StringData indexName, const MultikeyPaths &multikeyPaths)=0
	Sets the index identified by 'indexName' to be multikey. More...
virtual void	setIndexHead (OperationContext *opCtx, StringData indexName, const RecordId &newHead)=0
virtual Status	removeIndex (OperationContext *opCtx, StringData indexName)=0
virtual Status	prepareForIndexBuild (OperationContext *opCtx, const IndexDescriptor *spec, bool isBackgroundSecondaryBuild)=0
virtual void	indexBuildSuccess (OperationContext *opCtx, StringData indexName)=0
virtual void	updateTTLSetting (OperationContext *opCtx, StringData idxName, long long newExpireSeconds)=0
virtual void	updateIndexMetadata (OperationContext *opCtx, const IndexDescriptor *desc)
virtual void	updateFlags (OperationContext *opCtx, int newValue)=0
	Sets the flags field of CollectionOptions to newValue. More...
virtual void	updateValidator (OperationContext *opCtx, const BSONObj &validator, StringData validationLevel, StringData validationAction)=0
	Updates the validator for this collection. More...
virtual void	setIsTemp (OperationContext *opCtx, bool isTemp)=0
	Updates the 'temp' setting for this collection. More...
virtual void	addUUID (OperationContext *opCtx, CollectionUUID uuid, Collection *coll)=0
	Assigns a new UUID to this collection. More...
virtual bool	isEqualToMetadataUUID (OperationContext *opCtx, OptionalCollectionUUID uuid)=0
	Compare the UUID argument to the UUID obtained from the metadata. More...
virtual void	updateCappedSize (OperationContext *opCtx, long long size)=0
	Updates size of a capped Collection. More...

Protected Member Functions
virtual MetaData	_getMetaData (OperationContext *opCtx) const =0

Constructor & Destructor Documentation

BSONCollectionCatalogEntry()

mongo::BSONCollectionCatalogEntry::BSONCollectionCatalogEntry

(

StringData

ns

)

~BSONCollectionCatalogEntry()

virtual mongo::BSONCollectionCatalogEntry::~BSONCollectionCatalogEntry ( )

inlinevirtual

Member Function Documentation

_getMetaData()

virtual MetaData mongo::BSONCollectionCatalogEntry::_getMetaData ( OperationContext *  opCtx ) const

protectedpure virtual

Implemented in mongo::KVCollectionCatalogEntry.

getAllIndexes()

void mongo::BSONCollectionCatalogEntry::getAllIndexes ( OperationContext *  opCtx, std::vector< std::string > *  names  ) const

virtual

Implements mongo::CollectionCatalogEntry.

getAllUniqueIndexes()

void mongo::BSONCollectionCatalogEntry::getAllUniqueIndexes ( OperationContext *  opCtx, std::vector< std::string > *  names  ) const

virtual

Reimplemented from mongo::CollectionCatalogEntry.

getCollectionOptions()

CollectionOptions mongo::BSONCollectionCatalogEntry::getCollectionOptions ( OperationContext *  opCtx ) const

virtual

Implements mongo::CollectionCatalogEntry.

getCompletedIndexCount()

int mongo::BSONCollectionCatalogEntry::getCompletedIndexCount ( OperationContext *  opCtx ) const

virtual

Implements mongo::CollectionCatalogEntry.

getIndexHead()

RecordId mongo::BSONCollectionCatalogEntry::getIndexHead ( OperationContext *  opCtx, StringData  indexName  ) const

virtual

Implements mongo::CollectionCatalogEntry.

getIndexPrefix()

KVPrefix mongo::BSONCollectionCatalogEntry::getIndexPrefix ( OperationContext *  opCtx, StringData  indexName  ) const

virtual

Implements mongo::CollectionCatalogEntry.

getIndexSpec()

BSONObj mongo::BSONCollectionCatalogEntry::getIndexSpec ( OperationContext *  opCtx, StringData  idxName  ) const

virtual

Implements mongo::CollectionCatalogEntry.

getReadyIndexes()

void mongo::BSONCollectionCatalogEntry::getReadyIndexes ( OperationContext *  opCtx, std::vector< std::string > *  names  ) const

virtual

Implements mongo::CollectionCatalogEntry.

getTotalIndexCount()

int mongo::BSONCollectionCatalogEntry::getTotalIndexCount ( OperationContext *  opCtx ) const

virtual

Implements mongo::CollectionCatalogEntry.

isIndexMultikey()

bool mongo::BSONCollectionCatalogEntry::isIndexMultikey ( OperationContext *  opCtx, StringData  indexName, MultikeyPaths *  multikeyPaths  ) const

virtual

Returns true if the index identified by 'indexName' is multikey, and returns false otherwise.

If the 'multikeyPaths' pointer is non-null, then it must point to an empty vector. If this index supports tracking path-level multikey information, then this function sets 'multikeyPaths' as the path components that cause this index to be multikey.

In particular, if this function returns false and the index supports tracking path-level multikey information, then 'multikeyPaths' is initialized as a vector with size equal to the number of elements in the index key pattern of empty sets.

Implements mongo::CollectionCatalogEntry.

isIndexReady()

bool mongo::BSONCollectionCatalogEntry::isIndexReady ( OperationContext *  opCtx, StringData  indexName  ) const

virtual

Implements mongo::CollectionCatalogEntry.

---

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

• /home/louis/git/mongodbsource.github.io/src/src/mongo/db/storage/bson_collection_catalog_entry.h
• /home/louis/git/mongodbsource.github.io/src/src/mongo/db/storage/bson_collection_catalog_entry.cpp