A RecordStore that stores all data on the heap. More...

#include <heap_record_store_btree.h>

Inheritance diagram for mongo::HeapRecordStoreBtree:

Detailed Description

A RecordStore that stores all data on the heap.

This implementation contains only the functionality necessary to test btree.

Classes
struct	MmapV1RecordHeader

Public Member Functions
	HeapRecordStoreBtree (StringData ns)

virtual RecordData	dataFor (OperationContext *opCtx, const RecordId &loc) const
	Get the RecordData at loc, which must exist. More...

virtual bool	findRecord (OperationContext opCtx, const RecordId &loc, RecordData out) const

virtual void	deleteRecord (OperationContext *opCtx, const RecordId &dl)

virtual StatusWith< RecordId >	insertRecord (OperationContext opCtx, const char data, int len, Timestamp, bool enforceQuota)

virtual Status	insertRecordsWithDocWriter (OperationContext opCtx, const DocWriter const docs, const Timestamp , size_t nDocs, RecordId *idsOut)
	Inserts nDocs documents into this RecordStore using the DocWriter interface. More...

virtual long long	numRecords (OperationContext *opCtx) const
	Total number of record in the RecordStore. More...

virtual Status	touch (OperationContext opCtx, BSONObjBuilder output) const
	Load all data into cache. More...

virtual Status	updateRecord (OperationContext opCtx, const RecordId &oldLocation, const char data, int len, bool enforceQuota, UpdateNotifier *notifier)

virtual bool	updateWithDamagesSupported () const

virtual StatusWith< RecordData >	updateWithDamages (OperationContext opCtx, const RecordId &loc, const RecordData &oldRec, const char damageSource, const mutablebson::DamageVector &damages)
	Updates the record positioned at 'loc' in-place using the deltas described by 'damages'. More...

std::unique_ptr< SeekableRecordCursor >	getCursor (OperationContext *opCtx, bool forward) const final
	Returns a new cursor over this record store. More...

virtual Status	truncate (OperationContext *opCtx)
	removes all Records More...

virtual void	cappedTruncateAfter (OperationContext *opCtx, RecordId end, bool inclusive)
	Truncate documents newer than the document at 'end' from the capped collection. More...

virtual bool	compactSupported () const
	does this RecordStore support the compact operation? More...

virtual Status	validate (OperationContext opCtx, ValidateCmdLevel level, ValidateAdaptor adaptor, ValidateResults results, BSONObjBuilder output)

virtual void	appendCustomStats (OperationContext opCtx, BSONObjBuilder result, double scale) const

virtual void	increaseStorageSize (OperationContext *opCtx, int size, bool enforceQuota)

virtual int64_t	storageSize (OperationContext opCtx, BSONObjBuilder extraInfo=NULL, int infoLevel=0) const

virtual long long	dataSize (OperationContext *opCtx) const
	The dataSize is an approximation of the sum of the sizes (in bytes) of the documents or entries in the recordStore. More...

virtual MmapV1RecordHeader *	recordFor (const RecordId &loc) const

virtual bool	isCapped () const

virtual const char *	name () const

void	waitForAllEarlierOplogWritesToBeVisible (OperationContext *opCtx) const override
	Waits for all writes that completed before this call to be visible to forward scans. More...

virtual void	updateStatsAfterRepair (OperationContext *opCtx, long long numRecords, long long dataSize)
	Called after a repair operation is run with the recomputed numRecords and dataSize. More...

Public Member Functions inherited from mongo::RecordStore
	RecordStore (StringData ns)

virtual	~RecordStore ()

virtual const std::string &	ns () const

virtual void	setCappedCallback (CappedCallback *)

virtual Status	insertRecords (OperationContext opCtx, std::vector< Record > records, std::vector< Timestamp > *timestamps, bool enforceQuota)

StatusWith< RecordId >	insertRecordWithDocWriter (OperationContext opCtx, const DocWriter doc, Timestamp timestamp)
	A thin wrapper around insertRecordsWithDocWriter() to simplify handling of single DocWriters. More...

virtual std::unique_ptr< RecordCursor >	getCursorForRepair (OperationContext *opCtx) const
	Constructs a cursor over a potentially corrupted store, which can be used to salvage damaged records. More...

virtual std::unique_ptr< RecordCursor >	getRandomCursor (OperationContext *opCtx) const
	Constructs a cursor over a record store that returns documents in a randomized order, and allows storage engines to provide a more efficient way of random sampling of a record store than MongoDB's default sampling methods, which is used when this method returns {}. More...

virtual std::vector< std::unique_ptr< RecordCursor > >	getManyCursors (OperationContext *opCtx) const
	Returns many RecordCursors that partition the RecordStore into many disjoint sets. More...

virtual bool	compactsInPlace () const
	Does compact() leave RecordIds alone or can they change. More...

virtual Status	compact (OperationContext opCtx, RecordStoreCompactAdaptor adaptor, const CompactOptions options, CompactStats stats)
	Attempt to reduce the storage space used by this RecordStore. More...

virtual bool	isInRecordIdOrder () const
	Does the RecordStore cursor retrieve its document in RecordId Order? More...

virtual boost::optional< RecordId >	oplogStartHack (OperationContext *opCtx, const RecordId &startingPosition) const
	Return the RecordId of an oplog entry as close to startingPosition as possible without being higher. More...

virtual Status	oplogDiskLocRegister (OperationContext *opCtx, const Timestamp &opTime, bool orderedCommit)
	When we write to an oplog, we call this so that if the storage engine supports doc locking, it can manage the visibility of oplog entries to ensure they are ordered. More...

virtual Status	updateCappedSize (OperationContext *opCtx, long long cappedSize)
	used to support online change oplog size. More...

Private Types
typedef std::map< RecordId, HeapRecordStoreBtree::MmapV1RecordHeader >	Records

Private Member Functions
RecordId	allocateLoc ()

Private Attributes
Records	_records

int64_t	_nextId

Additional Inherited Members
Protected Attributes inherited from mongo::RecordStore
std::string	_ns

Member Typedef Documentation

◆ Records

typedef std::map<RecordId, HeapRecordStoreBtree::MmapV1RecordHeader> mongo::HeapRecordStoreBtree::Records

private

Constructor & Destructor Documentation

◆ HeapRecordStoreBtree()

mongo::HeapRecordStoreBtree::HeapRecordStoreBtree ( StringData ns )

inlineexplicit

Member Function Documentation

◆ allocateLoc()

RecordId mongo::HeapRecordStoreBtree::allocateLoc ( )

private

◆ appendCustomStats()

virtual void mongo::HeapRecordStoreBtree::appendCustomStats	(	OperationContext *	opCtx,
		BSONObjBuilder *	result,
		double	scale
	)		const

inlinevirtual

Parameters

scaleSize - amount by which to scale size metrics appends any custom stats from the RecordStore or other unique stats

Implements mongo::RecordStore.

◆ cappedTruncateAfter()

virtual void mongo::HeapRecordStoreBtree::cappedTruncateAfter	(	OperationContext *	opCtx,
		RecordId	end,
		bool	inclusive
	)

inlinevirtual

Truncate documents newer than the document at 'end' from the capped collection.

The collection cannot be completely emptied using this function. An assertion will be thrown if that is attempted.

Parameters

inclusive - Truncate 'end' as well iff true

Implements mongo::RecordStore.

◆ compactSupported()

virtual bool mongo::HeapRecordStoreBtree::compactSupported ( ) const

inlinevirtual

does this RecordStore support the compact operation?

If you return true, you must provide implementations of all compact methods.

Reimplemented from mongo::RecordStore.

◆ dataFor()

RecordData mongo::HeapRecordStoreBtree::dataFor	(	OperationContext *	opCtx,
		const RecordId &	loc
	)		const

virtual

Get the RecordData at loc, which must exist.

If unowned data is returned, it is valid until the next modification of this Record or the lock on this collection is released.

In general, prefer findRecord or RecordCursor::seekExact since they can tell you if a record has been removed.

Reimplemented from mongo::RecordStore.

◆ dataSize()

virtual long long mongo::HeapRecordStoreBtree::dataSize ( OperationContext * opCtx ) const

inlinevirtual

The dataSize is an approximation of the sum of the sizes (in bytes) of the documents or entries in the recordStore.

Implements mongo::RecordStore.

◆ deleteRecord()

void mongo::HeapRecordStoreBtree::deleteRecord	(	OperationContext *	opCtx,
		const RecordId &	dl
	)

virtual

Implements mongo::RecordStore.

◆ findRecord()

bool mongo::HeapRecordStoreBtree::findRecord	(	OperationContext *	opCtx,
		const RecordId &	loc,
		RecordData *	out
	)		const

virtual

Parameters

out	- If the record exists, the contents of this are set.

Returns: true iff there is a Record for loc

If unowned data is returned, it is valid until the next modification of this Record or the lock on this collection is released.

In general prefer RecordCursor::seekExact since it can avoid copying data in more storageEngines.

Warning: MMAPv1 cannot detect if RecordIds are valid. Therefore callers should only pass potentially deleted RecordIds to seek methods if they know that MMAPv1 is not the current storage engine. All new storage engines must support detecting the existence of Records.

Reimplemented from mongo::RecordStore.

◆ getCursor()

std::unique_ptr<SeekableRecordCursor> mongo::HeapRecordStoreBtree::getCursor	(	OperationContext *	opCtx,
		bool	forward
	)		const

inlinefinalvirtual

Returns a new cursor over this record store.

The cursor is logically positioned before the first (or last if !forward) Record in the collection so that Record will be returned on the first call to next(). Implementations are allowed to lazily seek to the first Record when next() is called rather than doing it on construction.

Implements mongo::RecordStore.

◆ increaseStorageSize()

virtual void mongo::HeapRecordStoreBtree::increaseStorageSize	(	OperationContext *	opCtx,
		int	size,
		bool	enforceQuota
	)

inlinevirtual

◆ insertRecord()

StatusWith< RecordId > mongo::HeapRecordStoreBtree::insertRecord	(	OperationContext *	opCtx,
		const char *	data,
		int	len,
		Timestamp	,
		bool	enforceQuota
	)

virtual

Implements mongo::RecordStore.

◆ insertRecordsWithDocWriter()

Status mongo::HeapRecordStoreBtree::insertRecordsWithDocWriter	(	OperationContext *	opCtx,
		const DocWriter const	docs,
		const Timestamp *	timestamps,
		size_t	nDocs,
		RecordId *	idsOut
	)

virtual

Inserts nDocs documents into this RecordStore using the DocWriter interface.

This allows the storage engine to reserve space for a record and have it built in-place rather than building the record then copying it into its destination.

On success, if idsOut is non-null the RecordIds of the inserted records will be written into it. It must have space for nDocs RecordIds.

Implements mongo::RecordStore.

◆ isCapped()

virtual bool mongo::HeapRecordStoreBtree::isCapped ( ) const

inlinevirtual

Implements mongo::RecordStore.

◆ name()

virtual const char* mongo::HeapRecordStoreBtree::name ( ) const

inlinevirtual

Implements mongo::RecordStore.

◆ numRecords()

virtual long long mongo::HeapRecordStoreBtree::numRecords ( OperationContext * opCtx ) const

inlinevirtual

Total number of record in the RecordStore.

You may need to cache it, so this call takes constant time, as it is called often.

Implements mongo::RecordStore.

◆ recordFor()

virtual MmapV1RecordHeader* mongo::HeapRecordStoreBtree::recordFor ( const RecordId & loc ) const

inlinevirtual

◆ storageSize()

virtual int64_t mongo::HeapRecordStoreBtree::storageSize	(	OperationContext *	opCtx,
		BSONObjBuilder *	extraInfo = `NULL`,
		int	infoLevel = `0`
	)		const

inlinevirtual

Parameters

extraInfo	- optional more debug info
level	- optional, level of debug info to put in (higher is more)

Returns: total estimate size (in bytes) on stable storage

Implements mongo::RecordStore.

◆ touch()

Status mongo::HeapRecordStoreBtree::touch	(	OperationContext *	opCtx,
		BSONObjBuilder *	output
	)		const

virtual

Load all data into cache.

What cache depends on implementation.

If the underlying storage engine does not support the operation, returns ErrorCodes::CommandNotSupported

Parameters

output (optional) - where to put detailed stats

Reimplemented from mongo::RecordStore.

◆ truncate()

virtual Status mongo::HeapRecordStoreBtree::truncate ( OperationContext * opCtx )

inlinevirtual

removes all Records

Implements mongo::RecordStore.

◆ updateRecord()

virtual Status mongo::HeapRecordStoreBtree::updateRecord	(	OperationContext *	opCtx,
		const RecordId &	oldLocation,
		const char *	data,
		int	len,
		bool	enforceQuota,
		UpdateNotifier *	notifier
	)

inlinevirtual

Parameters

notifier - Only used by record stores which do not support doc-locking. Called only in the case of an in-place update. Called just before the in-place write occurs.

Returns

Status - If a document move is required (MMAPv1 only) then a status of ErrorCodes::NeedsDocumentMove will be returned. On receipt of this status no update will be performed. It is the caller's responsibility to:

Remove the existing document and associated index keys.
Insert a new document and index keys.

For capped record stores, the record size will never change.

Implements mongo::RecordStore.

◆ updateStatsAfterRepair()

virtual void mongo::HeapRecordStoreBtree::updateStatsAfterRepair	(	OperationContext *	opCtx,
		long long	numRecords,
		long long	dataSize
	)

inlinevirtual

Called after a repair operation is run with the recomputed numRecords and dataSize.

Implements mongo::RecordStore.

◆ updateWithDamages()

virtual StatusWith<RecordData> mongo::HeapRecordStoreBtree::updateWithDamages	(	OperationContext *	opCtx,
		const RecordId &	loc,
		const RecordData &	oldRec,
		const char *	damageSource,
		const mutablebson::DamageVector &	damages
	)

inlinevirtual

Updates the record positioned at 'loc' in-place using the deltas described by 'damages'.

The 'damages' vector describes contiguous ranges of 'damageSource' from which to copy and apply byte-level changes to the data.

Returns: the updated version of the record. If unowned data is returned, then it is valid until the next modification of this Record or the lock on the collection has been released.

Implements mongo::RecordStore.

◆ updateWithDamagesSupported()

virtual bool mongo::HeapRecordStoreBtree::updateWithDamagesSupported ( ) const

inlinevirtual

Returns: Returns 'false' if this record store does not implement 'updatewithDamages'. If this method returns false, 'updateWithDamages' must not be called, and all updates must be routed through 'updateRecord' above. This allows the update framework to avoid doing the work of damage tracking if the underlying record store cannot utilize that information.

Implements mongo::RecordStore.

◆ validate()

virtual Status mongo::HeapRecordStoreBtree::validate	(	OperationContext *	opCtx,
		ValidateCmdLevel	level,
		ValidateAdaptor *	adaptor,
		ValidateResults *	results,
		BSONObjBuilder *	output
	)

inlinevirtual

Returns: OK if the validate run successfully OK will be returned even if corruption is found deatils will be in result

Implements mongo::RecordStore.

◆ waitForAllEarlierOplogWritesToBeVisible()

void mongo::HeapRecordStoreBtree::waitForAllEarlierOplogWritesToBeVisible ( OperationContext * opCtx ) const

inlineoverridevirtual

Waits for all writes that completed before this call to be visible to forward scans.

See the comment on RecordCursor for more details about the visibility rules.

It is only legal to call this on an oplog. It is illegal to call this inside a WriteUnitOfWork.

Implements mongo::RecordStore.

Member Data Documentation

◆ _nextId

int64_t mongo::HeapRecordStoreBtree::_nextId

private

◆ _records

Records mongo::HeapRecordStoreBtree::_records

private

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

/home/louis/git/mongodbsource.github.io/src/src/mongo/db/storage/mmap_v1/heap_record_store_btree.h
/home/louis/git/mongodbsource.github.io/src/src/mongo/db/storage/mmap_v1/heap_record_store_btree.cpp

Detailed Description

Classes

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ Records

Constructor & Destructor Documentation

◆ HeapRecordStoreBtree()

Member Function Documentation

◆ allocateLoc()

◆ appendCustomStats()

◆ cappedTruncateAfter()

◆ compactSupported()

◆ dataFor()

◆ dataSize()

◆ deleteRecord()

◆ findRecord()

◆ getCursor()

◆ increaseStorageSize()

◆ insertRecord()

◆ insertRecordsWithDocWriter()

◆ isCapped()

◆ name()

◆ numRecords()

◆ recordFor()

◆ storageSize()

◆ touch()

◆ truncate()

◆ updateRecord()

◆ updateStatsAfterRepair()

◆ updateWithDamages()

◆ updateWithDamagesSupported()

◆ validate()

◆ waitForAllEarlierOplogWritesToBeVisible()

Member Data Documentation

◆ _nextId

◆ _records