#include <StorageSvc/IDbContainer.h>

Inheritance diagram for pool::IDbContainer:

Collaboration diagram for pool::IDbContainer:

Public Member Functions
virtual void	release ()=0
	Release the technology specific implementation. More...

virtual uint64_t	size ()=0
	Access to container size. More...

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

virtual DbStatus	setOption (const DbOption &refOpt)=0
	Set options. More...

virtual DbStatus	getOption (DbOption &refOpt)=0
	Access options. More...

virtual void *	allocate (unsigned long siz, DbContainer &cntH, ShapeH shape)=0
	In place allocation of raw memory. More...

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

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

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

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

virtual DbStatus	close ()=0
	Close the container. More...

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

virtual DbStatus	checkAccess (DbDatabase &dbH, const std::string &nam) const =0
	Check if we can access the container for reading with the given type. More...

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

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

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

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

virtual DbStatus	save (DbObjectHandle< DbObject > &objH)=0
	Add object to the container. More...

virtual DbStatus	transAct (Transaction::Action)=0
	Execute Transaction Action. More...

Protected Member Functions
virtual	~IDbContainer ()
	Destructor (called only by sub-classes) More...

Detailed Description

Description:

Interface to the implementation specific part of a container object objects.

Author: M.Frank

Version: 1.0

Definition at line 46 of file IDbContainer.h.

Constructor & Destructor Documentation

◆ ~IDbContainer()

virtual pool::IDbContainer::~IDbContainer ( )

inlineprotectedvirtual

Destructor (called only by sub-classes)

Definition at line 49 of file IDbContainer.h.

49 { }

Member Function Documentation

◆ allocate() [1/2]

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

pure virtual

In place allocation of object location.

Implemented in pool::DbContainerImp.

◆ allocate() [2/2]

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

pure virtual

In place allocation of raw memory.

Implemented in pool::DbContainerImp.

◆ checkAccess()

virtual DbStatus pool::IDbContainer::checkAccess	(	DbDatabase &	dbH,
		const std::string &	nam
	)		const

pure virtual

Check if we can access the container for reading with the given type.

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

◆ close()

virtual DbStatus pool::IDbContainer::close ( )

pure virtual

Close the container.

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

◆ fetch()

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

pure virtual

Fetch next object address of the selection to set token.

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

◆ free()

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

pure virtual

In place deletion of raw memory.

Implemented in pool::DbContainerImp.

◆ getOption()

virtual DbStatus pool::IDbContainer::getOption ( DbOption & refOpt )

pure virtual

Access options.

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

◆ load()

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

pure virtual

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.