A RecoveryUnit for HeapRecordStoreBtree, this is for testing btree only. More...

#include <heap_record_store_btree.h>

Inheritance diagram for mongo::HeapRecordStoreBtreeRecoveryUnit:

Detailed Description

A RecoveryUnit for HeapRecordStoreBtree, this is for testing btree only.

Classes
struct	InsertEntry

struct	ModEntry

Public Member Functions
void	beginUnitOfWork (OperationContext *opCtx) final
	Marks the beginning of a unit of work. More...

void	commitUnitOfWork () final
	Marks the end of a unit of work and commits all changes registered by calls to onCommit or registerChange, in order. More...

void	abortUnitOfWork () final
	Marks the end of a unit of work and rolls back all changes registered by calls to onRollback or registerChange, in reverse order. More...

virtual bool	waitUntilDurable ()
	Waits until all commits that happened before this call are durable in the journal. More...

virtual void	abandonSnapshot ()
	If there is an open transaction, it is closed. More...

virtual void	registerChange (Change *change)
	The RecoveryUnit takes ownership of the change. More...

virtual void *	writingPtr (void *data, size_t len)
	Declare that the data at [x, x + len) is being written. More...

virtual void	setRollbackWritesDisabled ()
	Sets a flag that declares this RecoveryUnit will skip rolling back writes, for the duration of the current outermost WriteUnitOfWork. More...

virtual SnapshotId	getSnapshotId () const
	Gets the local SnapshotId. More...

virtual void	setOrderedCommit (bool orderedCommit)

void	notifyInsert (HeapRecordStoreBtree *rs, const RecordId &loc)

Public Member Functions inherited from mongo::RecoveryUnit
virtual	~RecoveryUnit ()

virtual void	prepareUnitOfWork ()
	Transitions the active unit of work to the "prepared" state. More...

virtual void	setIgnorePrepared (bool ignore)
	Sets whether or not to ignore prepared transactions if supported by this storage engine. More...

virtual bool	waitUntilUnjournaledWritesDurable ()
	Unlike `waitUntilDurable`, this method takes a stable checkpoint, making durable any writes on unjournaled tables that are behind the current stable timestamp. More...

virtual void	preallocateSnapshot ()
	Informs the RecoveryUnit that a snapshot will be needed soon, if one was not already established. More...

virtual Status	obtainMajorityCommittedSnapshot ()
	Obtains a majority committed snapshot. More...

virtual boost::optional< Timestamp >	getPointInTimeReadTimestamp () const
	Returns the Timestamp being used by this recovery unit or boost::none if not reading from a point in time. More...

virtual Status	setTimestamp (Timestamp timestamp)
	Sets a timestamp to assign to future writes in a transaction. More...

virtual void	setCommitTimestamp (Timestamp timestamp)
	Sets a timestamp that will be assigned to all future writes on this RecoveryUnit until clearCommitTimestamp() is called. More...

virtual void	clearCommitTimestamp ()

virtual Timestamp	getCommitTimestamp ()

virtual void	setPrepareTimestamp (Timestamp timestamp)
	Sets a prepare timestamp for the current transaction. More...

virtual void	setTimestampReadSource (ReadSource source, boost::optional< Timestamp > provided=boost::none)
	Sets which timestamp to use for read transactions. More...

virtual ReadSource	getTimestampReadSource () const

template<typename Callback >
void	onRollback (Callback callback)
	Registers a callback to be called if the current WriteUnitOfWork rolls back. More...

template<typename Callback >
void	onCommit (Callback callback)
	Registers a callback to be called if the current WriteUnitOfWork commits. More...

int &	writingInt (int &d)
	Declare write intent for an int. More...

template<typename T >
T *	writing (T *x)
	A templated helper for writingPtr. More...

Static Public Member Functions
static void	notifyInsert (OperationContext ctx, HeapRecordStoreBtree rs, const RecordId &loc)

Private Attributes
std::vector< InsertEntry >	_insertions

std::vector< ModEntry >	_mods

Additional Inherited Members
Public Types inherited from mongo::RecoveryUnit
enum	ReadSource { kNone, kMajorityCommitted, kLastApplied, kLastAppliedSnapshot, kProvided }
	The ReadSource indicates which exteral or provided timestamp to read from for future transactions. More...

Protected Member Functions inherited from mongo::RecoveryUnit
	RecoveryUnit ()

Member Function Documentation

◆ abandonSnapshot()

virtual void mongo::HeapRecordStoreBtreeRecoveryUnit::abandonSnapshot ( )

inlinevirtual

If there is an open transaction, it is closed.

On return no transaction is active. This cannot be called inside of a WriteUnitOfWork, and should fail if it is.

Implements mongo::RecoveryUnit.

◆ abortUnitOfWork()

void mongo::HeapRecordStoreBtreeRecoveryUnit::abortUnitOfWork ( )

finalvirtual

Marks the end of a unit of work and rolls back all changes registered by calls to onRollback or registerChange, in reverse order.

Must be matched by exactly one preceding call to beginUnitOfWork.

Should be called through WriteUnitOfWork rather than directly.

Implements mongo::RecoveryUnit.

◆ beginUnitOfWork()

void mongo::HeapRecordStoreBtreeRecoveryUnit::beginUnitOfWork ( OperationContext * opCtx )

inlinefinalvirtual

Marks the beginning of a unit of work.

Each call must be matched with exactly one call to either commitUnitOfWork or abortUnitOfWork.

Should be called through WriteUnitOfWork rather than directly.

Implements mongo::RecoveryUnit.

◆ commitUnitOfWork()

void mongo::HeapRecordStoreBtreeRecoveryUnit::commitUnitOfWork ( )

finalvirtual

Marks the end of a unit of work and commits all changes registered by calls to onCommit or registerChange, in order.

Must be matched by exactly one preceding call to beginUnitOfWork.

Should be called through WriteUnitOfWork rather than directly.

Implements mongo::RecoveryUnit.

◆ getSnapshotId()

virtual SnapshotId mongo::HeapRecordStoreBtreeRecoveryUnit::getSnapshotId ( ) const

inlinevirtual

Gets the local SnapshotId.

It is only valid to compare SnapshotIds generated by a single RecoveryUnit.

This is unrelated to Timestamp which must be globally comparable.

Implements mongo::RecoveryUnit.

◆ notifyInsert() [1/2]

void mongo::HeapRecordStoreBtreeRecoveryUnit::notifyInsert	(	HeapRecordStoreBtree *	rs,
		const RecordId &	loc
	)

◆ notifyInsert() [2/2]

void mongo::HeapRecordStoreBtreeRecoveryUnit::notifyInsert	(	OperationContext *	ctx,
		HeapRecordStoreBtree *	rs,
		const RecordId &	loc
	)

static

◆ registerChange()

virtual void mongo::HeapRecordStoreBtreeRecoveryUnit::registerChange ( Change * change )

inlinevirtual

The RecoveryUnit takes ownership of the change.

The commitUnitOfWork() method calls the commit() method of each registered change in order of registration. The endUnitOfWork() method calls the rollback() method of each registered Change in reverse order of registration. Either will unregister and delete the changes.

The registerChange() method may only be called when a WriteUnitOfWork is active, and may not be called during commit or rollback.

Implements mongo::RecoveryUnit.

◆ setOrderedCommit()

virtual void mongo::HeapRecordStoreBtreeRecoveryUnit::setOrderedCommit ( bool orderedCommit )

inlinevirtual

Implements mongo::RecoveryUnit.

◆ setRollbackWritesDisabled()

virtual void mongo::HeapRecordStoreBtreeRecoveryUnit::setRollbackWritesDisabled ( )

inlinevirtual

Sets a flag that declares this RecoveryUnit will skip rolling back writes, for the duration of the current outermost WriteUnitOfWork.

This function can only be called between a pair of unnested beginUnitOfWork() / endUnitOfWork() calls. The flag is cleared when endUnitOfWork() is called. While the flag is set, rollback will skip rolling back writes, but custom rollback change functions are still called. Clearly, this functionality should only be used when writing to temporary collections that can be cleaned up externally. For example, foreground index builds write to a temporary collection; if something goes wrong that normally requires a rollback, we can instead clean up the index by dropping the entire index. Setting the flag may permit increased performance.

Implements mongo::RecoveryUnit.

◆ waitUntilDurable()

virtual bool mongo::HeapRecordStoreBtreeRecoveryUnit::waitUntilDurable ( )

inlinevirtual

Waits until all commits that happened before this call are durable in the journal.

Returns true, unless the storage engine cannot guarantee durability, which should never happen when isDurable() returned true. This cannot be called from inside a unit of work, and should fail if it is.

Returns: Whether or not the storage engine can guarantee durability.

Implements mongo::RecoveryUnit.

◆ writingPtr()

void * mongo::HeapRecordStoreBtreeRecoveryUnit::writingPtr	(	void *	data,
		size_t	len
	)

virtual

Declare that the data at [x, x + len) is being written.

Implements mongo::RecoveryUnit.

Member Data Documentation

◆ _insertions

std::vector<InsertEntry> mongo::HeapRecordStoreBtreeRecoveryUnit::_insertions

private

◆ _mods

std::vector<ModEntry> mongo::HeapRecordStoreBtreeRecoveryUnit::_mods

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

Static Public Member Functions

Private Attributes

Additional Inherited Members

Member Function Documentation

◆ abandonSnapshot()

◆ abortUnitOfWork()

◆ beginUnitOfWork()

◆ commitUnitOfWork()

◆ getSnapshotId()

◆ notifyInsert() [1/2]

◆ notifyInsert() [2/2]

◆ registerChange()

◆ setOrderedCommit()

◆ setRollbackWritesDisabled()

◆ waitUntilDurable()

◆ writingPtr()

Member Data Documentation

◆ _insertions

◆ _mods