#include <StorageSvc/DbContainerImp.h>

Inheritance diagram for pool::DbContainerImp:

Collaboration diagram for pool::DbContainerImp:

Classes
struct	DbAction
	List of actions to execute at commit. More...

Public Member Functions
	DbContainerImp ()

virtual void	release () override
	Release instance (Abstract interfaces do not expose destructor!) More...

virtual uint64_t	size () override
	Size of the container. More...

virtual std::string	name () const override
	Get container name. More...

virtual uint64_t	nextRecordId () override
	Number of next record in the container (=size if no delete is allowed) More...

virtual void	useNextRecordId (uint64_t) override
	Suggest next Record ID for tbe next object written - used only with synced indexes. More...

virtual DbStatus	close () override
	Close the container and deallocate resources. More...

virtual DbStatus	getOption (DbOption &opt) override
	Access options. More...

virtual DbStatus	setOption (const DbOption &opt) override
	Set options. More...

virtual DbStatus	transAct (Transaction::Action) override
	Execute Transaction Action. More...

virtual void *	allocate (unsigned long siz, DbContainer &cntH, ShapeH shape) override
	In place allocation of raw memory for the transient object. More...

virtual DbStatus	allocate (DbContainer &cntH, const void *object, ShapeH shape, Token::OID_t &oid) override
	In place allocation of object location. More...

virtual DbStatus	free (void *ptr, DbContainer &cntH) override
	In place deletion of raw memory. More...

virtual DbStatus	update (DbSelect &) override
	Perform UPDATE statement. More...

virtual DbStatus	destroy (DbSelect &) override
	Perform DELETE statement. More...

virtual DbStatus	fetch (DbSelect &sel) override
	Fetch next object address of the selection to set token. More...

virtual DbStatus	destroy (const Token::OID_t &lnkH) override
	Add the specified object to the delete stack. More...

virtual DbStatus	update (DbContainer &cntH, const void *object, ShapeH shape, const Token::OID_t &linkH) override
	Update existing object in the container. More...

virtual DbStatus	update (DbContainer &cntH, const void *object, ShapeH shape, const DbObjectHandle< DbObject > &objH) override
	Update existing object in the container. More...

virtual DbStatus	save (DbObjectHandle< DbObject > &objH) override
	Add single entry to container. More...

virtual DbStatus	save (DbContainer &cntH, const void *object, ShapeH shape, Token::OID_t &linkH) override
	Save new object in the container and return its handle. More...

virtual DbStatus	load (void **ptr, ShapeH shape, const Token::OID_t &lnkH, Token::OID_t &oid, bool any_next) override
	Find object within the container and load it into memory. More...

virtual DbStatus	clearStack ()
	Clear Transaction stack containing transaction requests. More...

virtual DbStatus	fetch (const Token::OID_t &linkH, Token::OID_t &stmt)
	Fetch refined object address. Default implementation returns identity. More...

virtual DbStatus	loadObject (void **ptr, ShapeH shape, Token::OID_t &oid)=0
	Find object by object identifier and load it into memory. More...

virtual DbStatus	isShapeSupported (const DbTypeInfo *typ) const =0
	Ask if a given shape is supported. More...

virtual DbStatus	open (DbDatabase &dbH, const std::string &nam, const DbTypeInfo *info, DbAccessMode mode)=0
	Open the container. More...

virtual DbStatus	select (DbSelect &criteria)=0
	Define selection criteria. More...

Protected Types
typedef std::vector< DbAction >	ActionList

Protected Member Functions
virtual	~DbContainerImp ()
	Standard destructor. More...

int	stackType () const
	Access accumulated stack entry types. More...

size_t	stackSize () const
	Access stack size. More...

virtual bool	updatesPending () const override
	Query the pending transaction stack. More...

ActionList::value_type *	stackEntry (size_t which)
	Internal: get access to stack entry. More...

virtual DbStatus	destroyObject (ActionList::value_type &)
	Destroy persistent object in the container; does not touch transient! More...

virtual DbStatus	updateObject (ActionList::value_type &)
	Update persistent object in the container. More...

virtual DbStatus	writeObject (ActionList::value_type &)
	Commit single entry to container. More...

virtual DbStatus	commitTransaction ()
	Execute object modification requests during a transaction. More...

Protected Attributes
std::string	m_name
	Container name. More...

bool	m_canUpdate
	Flag to indicate if object updates are supported. More...

bool	m_canDestroy
	Flag to indicate if object removals are supported. More...

Private Attributes
ActionList	m_stack
	Transaction fifo storage for writing. More...

size_t	m_size
	Current size of the transaction stack. More...

size_t	m_writeSize
	Number of objects to be written out during open transaction. More...

int	m_stackType
	Accumulated stack entry types. More...

Detailed Description

"Generic" Container implementation

Description: Generic helper class to implement stuff common to all existing Database containers. The base implementations can allways be overwritten.

Author: M.Frank

Version: 1.0

Definition at line 43 of file DbContainerImp.h.

Member Typedef Documentation

◆ ActionList

typedef std::vector< DbAction > pool::DbContainerImp::ActionList

protected

Definition at line 63 of file DbContainerImp.h.

Constructor & Destructor Documentation

◆ ~DbContainerImp()

virtual pool::DbContainerImp::~DbContainerImp ( )

protectedvirtual

Standard destructor.

◆ DbContainerImp()

pool::DbContainerImp::DbContainerImp ( )

Member Function Documentation

◆ allocate() [1/2]

virtual DbStatus pool::DbContainerImp::allocate	(	DbContainer &	cntH,
		const void *	object,
		ShapeH	shape,
		Token::OID_t &	oid
	)

overridevirtual

In place allocation of object location.

Implements pool::IDbContainer.

◆ allocate() [2/2]

virtual void* pool::DbContainerImp::allocate	(	unsigned long	siz,
		DbContainer &	cntH,
		ShapeH	shape
	)

overridevirtual

In place allocation of raw memory for the transient object.

Implements pool::IDbContainer.

◆ clearStack()

virtual DbStatus pool::DbContainerImp::clearStack ( )

virtual

Clear Transaction stack containing transaction requests.

◆ close()

virtual DbStatus pool::DbContainerImp::close ( )

overridevirtual

Close the container and deallocate resources.

Implements pool::IDbContainer.

Reimplemented in pool::RNTupleContainer, pool::RootTreeContainer, and pool::RootKeyContainer.

◆ commitTransaction()

virtual DbStatus pool::DbContainerImp::commitTransaction ( )

protectedvirtual

Execute object modification requests during a transaction.

◆ destroy() [1/2]

virtual DbStatus pool::DbContainerImp::destroy ( const Token::OID_t & lnkH )

overridevirtual

Add the specified object to the delete stack.

Implements pool::IDbContainer.

◆ destroy() [2/2]

virtual DbStatus pool::DbContainerImp::destroy ( DbSelect & )

inlineoverridevirtual

Perform DELETE statement.

Implements pool::IDbContainer.

Definition at line 155 of file DbContainerImp.h.

155 { return Error; }

◆ destroyObject()

virtual DbStatus pool::DbContainerImp::destroyObject ( ActionList::value_type & )

inlineprotectedvirtual

Destroy persistent object in the container; does not touch transient!

Reimplemented in pool::RootKeyContainer.

Definition at line 97 of file DbContainerImp.h.

98 { return Error; }

◆ fetch() [1/2]

virtual DbStatus pool::DbContainerImp::fetch	(	const Token::OID_t &	linkH,
		Token::OID_t &	stmt
	)

virtual

Fetch refined object address. Default implementation returns identity.

Reimplemented in pool::RootTreeContainer, and pool::RootKeyContainer.

◆ fetch() [2/2]

virtual DbStatus pool::DbContainerImp::fetch ( DbSelect & sel )

overridevirtual

Fetch next object address of the selection to set token.

Implements pool::IDbContainer.

Reimplemented in pool::RNTupleContainer, pool::RootTreeContainer, and pool::RootKeyContainer.

◆ free()

virtual DbStatus pool::DbContainerImp::free	(	void *	ptr,
		DbContainer &	cntH
	)

overridevirtual

In place deletion of raw memory.

Implements pool::IDbContainer.

◆ getOption()

virtual DbStatus pool::DbContainerImp::getOption ( DbOption & opt )

overridevirtual

Access options.

Parameters

opt	[IN] Reference to option object.

Returns: DbStatus code indicating success or failure.

Implements pool::IDbContainer.

Reimplemented in pool::RNTupleContainer, pool::RootTreeContainer, and pool::RootKeyContainer.

◆ isShapeSupported()

virtual DbStatus pool::IDbContainer::isShapeSupported ( const DbTypeInfo * typ ) const

pure virtualinherited

Ask if a given shape is supported.

Implemented in pool::RNTupleContainer, pool::RootTreeContainer, and pool::RootKeyContainer.

◆ load()

virtual DbStatus pool::DbContainerImp::load	(	void **	ptr,
		ShapeH	shape,
		const Token::OID_t &	lnkH,
		Token::OID_t &	oid,
		bool	any_next
	)

overridevirtual

Find object within the container and load it into memory.

Parameters

ptr	[IN/OUT] ROOT-style address of the pointer to object
shape	[IN] Object type
linkH	[IN] Preferred object OID
oid	[OUT] Actual object OID
any_next	[IN] On selection, objects may be skipped. If objects are skipped, the actual oid will differ from the preferred oid.

Returns: Status code indicating success or failure.

Implements pool::IDbContainer.

Reimplemented in pool::RootKeyContainer.

◆ loadObject()

virtual DbStatus pool::DbContainerImp::loadObject	(	void **	ptr,
		ShapeH	shape,
		Token::OID_t &	oid
	)

pure virtual

Find object by object identifier and load it into memory.

Parameters

ptr	[IN/OUT] ROOT-style address of the pointer to object
shape	[IN] Object type
oid	[OUT] Object OID

Returns: Status code indicating success or failure.

Implemented in pool::RNTupleContainer, pool::RootTreeContainer, pool::RootTreeIndexContainer, and pool::RootKeyContainer.

◆ name()

virtual std::string pool::DbContainerImp::name ( ) const

inlineoverridevirtual

Get container name.

Implements pool::IDbContainer.

Definition at line 115 of file DbContainerImp.h.

116 { return m_name; }

◆ nextRecordId()

virtual uint64_t pool::DbContainerImp::nextRecordId ( )

overridevirtual

Number of next record in the container (=size if no delete is allowed)

Implements pool::IDbContainer.

Reimplemented in pool::RNTupleContainer, pool::RootTreeIndexContainer, and pool::RootKeyContainer.

◆ open()

virtual DbStatus pool::IDbContainer::open	(	DbDatabase &	dbH,
		const std::string &	nam,
		const DbTypeInfo *	info,
		DbAccessMode	mode
	)

pure virtualinherited

Open the container.

Implemented in pool::RNTupleContainer, pool::RootTreeContainer, pool::RootKeyContainer, and pool::RootTreeIndexContainer.

◆ release()

virtual void pool::DbContainerImp::release ( )

inlineoverridevirtual

Release instance (Abstract interfaces do not expose destructor!)

Implements pool::IDbContainer.

Definition at line 111 of file DbContainerImp.h.

111 { delete this; }

◆ save() [1/2]

virtual DbStatus pool::DbContainerImp::save	(	DbContainer &	cntH,
		const void *	object,
		ShapeH	shape,
		Token::OID_t &	linkH
	)

overridevirtual

Save new object in the container and return its handle.

Parameters

cntH	[IN] Handle to container object.
object	[IN] Data object
linkH	[OUT] Internal OID to identify object.

Returns: DbStatus code indicating success or failure.

Implements pool::IDbContainer.

◆ save() [2/2]

virtual DbStatus pool::DbContainerImp::save ( DbObjectHandle< DbObject > & objH )

overridevirtual

Add single entry to container.

Implements pool::IDbContainer.

◆ select()

virtual DbStatus pool::IDbContainer::select ( DbSelect & criteria )

pure virtualinherited

Define selection criteria.

Implemented in pool::RNTupleContainer, pool::RootTreeContainer, and pool::RootKeyContainer.

◆ setOption()

virtual DbStatus pool::DbContainerImp::setOption ( const DbOption & opt )

overridevirtual

Set options.

Parameters

opt	[IN] Reference to option object.

Returns: DbStatus code indicating success or failure.

Implements pool::IDbContainer.

Reimplemented in pool::RNTupleContainer, pool::RootTreeContainer, and pool::RootKeyContainer.

◆ size()

virtual uint64_t pool::DbContainerImp::size ( )

overridevirtual

Size of the container.

Implements pool::IDbContainer.

Reimplemented in pool::RNTupleContainer, pool::RootTreeContainer, and pool::RootKeyContainer.

◆ stackEntry()

ActionList::value_type* pool::DbContainerImp::stackEntry ( size_t which )

inlineprotected

Internal: get access to stack entry.

Definition at line 94 of file DbContainerImp.h.

95 { return (which <= m_size) ? &(*(m_stack.begin()+which)) : 0; }

◆ stackSize()

size_t pool::DbContainerImp::stackSize ( ) const

inlineprotected

Access stack size.

Definition at line 88 of file DbContainerImp.h.

89 { return m_size; }

◆ stackType()

int pool::DbContainerImp::stackType ( ) const

inlineprotected

Access accumulated stack entry types.

Definition at line 85 of file DbContainerImp.h.

86 { return m_stackType; }

◆ transAct()

virtual DbStatus pool::DbContainerImp::transAct ( Transaction::Action )

overridevirtual

Execute Transaction Action.

Implements pool::IDbContainer.

Reimplemented in pool::RNTupleContainer, pool::RootTreeContainer, and pool::RootKeyContainer.

◆ update() [1/3]

virtual DbStatus pool::DbContainerImp::update	(	DbContainer &	cntH,
		const void *	object,
		ShapeH	shape,
		const DbObjectHandle< DbObject > &	objH
	)

overridevirtual

Update existing object in the container.

Parameters

cntH	[IN] Valid handle to container
object	[IN] Data object
objH	[IN] Object handle

Returns: Status code indicating success or failure.

Implements pool::IDbContainer.

◆ update() [2/3]

virtual DbStatus pool::DbContainerImp::update	(	DbContainer &	cntH,
		const void *	object,
		ShapeH	shape,
		const Token::OID_t &	linkH
	)

overridevirtual

Update existing object in the container.

Parameters

cntH	[IN] Valid handle to container
object	[IN] Data object
linkH	[IN/OUT] Object identifier

Returns: Status code indicating success or failure.

Implements pool::IDbContainer.

◆ update() [3/3]

virtual DbStatus pool::DbContainerImp::update ( DbSelect & )

inlineoverridevirtual

Perform UPDATE statement.

Implements pool::IDbContainer.

Definition at line 153 of file DbContainerImp.h.

153 { return Error; }

◆ updateObject()

virtual DbStatus pool::DbContainerImp::updateObject ( ActionList::value_type & )

inlineprotectedvirtual

Update persistent object in the container.

Definition at line 100 of file DbContainerImp.h.

101 { return Error; }

◆ updatesPending()

virtual bool pool::DbContainerImp::updatesPending ( ) const

inlineoverrideprotectedvirtual

Query the pending transaction stack.

Implements pool::IDbContainer.

Definition at line 91 of file DbContainerImp.h.

92 { return m_size > 0; }

◆ useNextRecordId()

virtual void pool::DbContainerImp::useNextRecordId ( uint64_t )

inlineoverridevirtual

Suggest next Record ID for tbe next object written - used only with synced indexes.

Implements pool::IDbContainer.

Reimplemented in pool::RootTreeIndexContainer, and pool::RNTupleContainer.

Definition at line 120 of file DbContainerImp.h.

120 {};

◆ writeObject()

virtual DbStatus pool::DbContainerImp::writeObject ( ActionList::value_type & )

inlineprotectedvirtual

Commit single entry to container.

Reimplemented in pool::RNTupleContainer, pool::RootTreeContainer, pool::RootTreeIndexContainer, and pool::RootKeyContainer.

Definition at line 103 of file DbContainerImp.h.

104 { return Error; }

Member Data Documentation

◆ m_canDestroy

bool pool::DbContainerImp::m_canDestroy

protected

Flag to indicate if object removals are supported.

Definition at line 80 of file DbContainerImp.h.

◆ m_canUpdate

bool pool::DbContainerImp::m_canUpdate

protected

Flag to indicate if object updates are supported.

Definition at line 78 of file DbContainerImp.h.

◆ m_name

std::string pool::DbContainerImp::m_name

protected

Container name.

Definition at line 76 of file DbContainerImp.h.

◆ m_size

size_t pool::DbContainerImp::m_size

private

Current size of the transaction stack.

Definition at line 69 of file DbContainerImp.h.

◆ m_stack

ActionList pool::DbContainerImp::m_stack

private

Transaction fifo storage for writing.

Definition at line 67 of file DbContainerImp.h.

◆ m_stackType

int pool::DbContainerImp::m_stackType

private

Accumulated stack entry types.

Definition at line 73 of file DbContainerImp.h.

◆ m_writeSize

size_t pool::DbContainerImp::m_writeSize

private

Number of objects to be written out during open transaction.

Definition at line 71 of file DbContainerImp.h.

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

DbContainerImp.h

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ActionList

Constructor & Destructor Documentation

◆ ~DbContainerImp()

◆ DbContainerImp()

Member Function Documentation

◆ allocate() [1/2]

◆ allocate() [2/2]

◆ clearStack()

◆ close()

◆ commitTransaction()

◆ destroy() [1/2]

◆ destroy() [2/2]

◆ destroyObject()

◆ fetch() [1/2]

◆ fetch() [2/2]

◆ free()

◆ getOption()

◆ isShapeSupported()

◆ load()

◆ loadObject()

◆ name()

◆ nextRecordId()

◆ open()

◆ release()

◆ save() [1/2]

◆ save() [2/2]

◆ select()

◆ setOption()

◆ size()

◆ stackEntry()

◆ stackSize()

◆ stackType()

◆ transAct()

◆ update() [1/3]

◆ update() [2/3]

◆ update() [3/3]

◆ updateObject()

◆ updatesPending()

◆ useNextRecordId()

◆ writeObject()

Member Data Documentation

◆ m_canDestroy

◆ m_canUpdate

◆ m_name

◆ m_size

◆ m_stack

◆ m_stackType

◆ m_writeSize