Singleton base class for the low-level interface to the database. More...

#include <Database.h>

Collaboration diagram for Database:

[legend]

Classes
struct	DBImportQuery
	Struct for bulk write queries. More...

Public Types
enum	EDatabaseState { c_PreInit = 0 , c_InitGlobaltagList = 1 , c_Ready = 2 }
	State of the database. More...

using	DBQuery = Conditions::PayloadMetadata
	Struct for bulk read queries.

Public Member Functions
std::pair< TObject *, IntervalOfValidity >	getData (const EventMetaData &event, const std::string &name)
	Request an object from the database.

bool	getData (const EventMetaData &event, DBQuery &query)
	Request an object from the database.

bool	getData (const EventMetaData &event, std::vector< DBQuery > &query)
	Request multiple objects from the database.

const TObject *	getData (const std::string &name, int experiment, int run)
	Convenience function to get an object for an arbitrary experiment and run.

std::set< std::string >	getAllDataNames ()
	Return the names of all the payloads stored in the database at the time of this function is called.

bool	storeData (const std::string &name, TObject *object, const IntervalOfValidity &iov)
	Store an object in the database.

bool	storeData (TClonesArray *array, const IntervalOfValidity &iov)
	Store an ClonesArray in the database with the default name.

template<class T >
bool	storeData (T *object, const IntervalOfValidity &iov)
	Store an object in the database with the default name.

bool	storeData (std::list< DBImportQuery > &query)
	Store multiple objects in the database.

bool	addPayload (const std::string &name, const std::string &fileName, const IntervalOfValidity &iov)
	Add a payload file to the database.

std::string	getGlobalTags ()
	Return the global tags used by the database.

ScopeGuard	createScopedUpdateSession ()
	Make sure we have efficient http pipelinging during initialize/beginRun but don't keep session alive for full processing time.

void	initialize (const EDatabaseState target=c_Ready)
	Initialize the database connection settings on first use.

Static Public Member Functions
static Database &	Instance ()
	Instance of a singleton Database.

static void	reset (bool keepConfig=false)
	Reset the database instance.

static void	exposePythonAPI ()
	Exposes setGlobalTag function of the Database class to Python.

Protected Member Functions
	Database ()=default
	Hidden constructor, as it is a singleton.

	Database (const Database &)=delete
	No copy constructor, as it is a singleton.

	~Database ()
	Hidden destructor, as it is a singleton.

void	nextMetadataProvider ()
	Enable the next metadataprovider in the list.

Protected Attributes
std::vector< std::string >	m_metadataConfigurations
	List of available metadata providers (which haven't been tried yet)

std::string	m_currentProvider
	Name of the currently used metadata provider.

std::vector< std::string >	m_globalTags
	List of globaltags to be used.

std::set< std::string >	m_usableTagStates
	Set of usable globaltag states to be handed to the metadata providers.

std::unique_ptr< Conditions::MetadataProvider >	m_metadataProvider
	Currently active metadata provider.

std::unique_ptr< Conditions::PayloadProvider >	m_payloadProvider
	The active payload provider.

std::unique_ptr< Conditions::TestingPayloadStorage >	m_payloadCreation
	testing payload storage to create new payloads

std::vector< Conditions::TestingPayloadStorage >	m_testingPayloads
	optional list of testing payload storages to look for existing payloads

EDatabaseState	m_configState {c_PreInit}
	Current configuration state of the database.

Detailed Description

Singleton base class for the low-level interface to the database.

To be used by the DBStore. Currently the Database instance keeps the ownership of the objects, but this may change for the final backend.

Definition at line 42 of file Database.h.

Member Typedef Documentation

◆ DBQuery

using DBQuery = Conditions::PayloadMetadata

Struct for bulk read queries.

Definition at line 72 of file Database.h.

Member Enumeration Documentation

◆ EDatabaseState

enum EDatabaseState

State of the database.

Enumerator
c_PreInit	Before any initialization.
c_InitGlobaltagList	Globaltag list has been finalized metadata providers not and globaltags are not checked for usability.
c_Ready	Everything is ready.

Definition at line 45 of file Database.h.

                        {
      c_PreInit = 0,
      c_InitGlobaltagList = 1,
      c_Ready = 2,
    };

Member Function Documentation

◆ addPayload()

bool addPayload	(	const std::string &	name,
		const std::string &	fileName,
		const IntervalOfValidity &	iov
	)

inline

Add a payload file to the database.

Parameters

name	Name that identifies the object in the database.
fileName	The name of the payload file.
iov	The interval of validity of the the object.

Returns: True if the storage of the object succeeded.

Definition at line 192 of file Database.h.

    {
      if (!m_payloadCreation) initialize();
      return m_payloadCreation->storePayload(name, fileName, iov);
    }

◆ getAllDataNames()

std::set< std::string > getAllDataNames ( )

inline

Return the names of all the payloads stored in the database at the time of this function is called.

This is equivalent to getting all the payloads' names used by the current basf2 process.

Definition at line 146 of file Database.h.

146{ return DBStore::Instance().getAllEntryNames(); };

Belle2::DBStore::Instance

static DBStore & Instance()

Instance of a singleton DBStore.

Definition: DBStore.cc:28

Belle2::DBStore::getAllEntryNames

std::set< std::string > getAllEntryNames()

Return the names of all the payloads stored in the database at the time of this function is called.

Definition: DBStore.cc:196

◆ getData() [1/2]

bool getData	(	const EventMetaData &	event,
		DBQuery &	query
	)

inline

Request an object from the database.

Parameters

event	The metadata of the event for which the object should be valid.
query	Object containing the necessary identification which will be filled with all information about the payload.

Returns: True if the payload could be found. False otherwise.

Definition at line 110 of file Database.h.

    {
      std::vector<DBQuery> container{query};
      bool found = getData(event, container);
      query = container[0];
      return found;
    }

◆ getData() [2/2]

const TObject * getData	(	const std::string &	name,
		int	experiment,
		int	run
	)

inline

Convenience function to get an object for an arbitrary experiment and run.

Parameters

[in]	name	The name identifying the object.
[in]	experiment	The experiment number.
[in]	run	The run number.

Definition at line 135 of file Database.h.

    {
      EventMetaData eventMetaData(1, run, experiment);
      return getData(eventMetaData, name).first;
    }

◆ storeData() [1/2]

bool storeData	(	T *	object,
		const IntervalOfValidity &	iov
	)

inline

Store an object in the database with the default name.

Parameters

object	The object that should be stored in the database.
iov	The interval of validity of the the object.

Returns: True if the storage of the object succeeded.

Definition at line 174 of file Database.h.

174{return storeData(DBStore::objectName<T>(""), object, iov);};

Belle2::Database::storeData

bool storeData(const std::string &name, TObject *object, const IntervalOfValidity &iov)

Store an object in the database.

Definition: Database.cc:141

◆ storeData() [2/2]

bool storeData	(	TClonesArray *	array,
		const IntervalOfValidity &	iov
	)

inline

Store an ClonesArray in the database with the default name.

Parameters

array	The object that should be stored in the database.
iov	The interval of validity of the the object.

Returns: True if the storage of the object succeeded.

Definition at line 165 of file Database.h.

165{return storeData(DataStore::defaultArrayName(array->ClassName()), array, iov);};

Belle2::DataStore::defaultArrayName

static std::string defaultArrayName()

Return the default storage name for an array of the given type.

Definition: DataStore.h:157

Member Data Documentation

◆ m_configState

EDatabaseState m_configState {c_PreInit}

protected

Current configuration state of the database.

Definition at line 246 of file Database.h.

◆ m_currentProvider

std::string m_currentProvider

protected

Name of the currently used metadata provider.

Definition at line 232 of file Database.h.

◆ m_globalTags

std::vector<std::string> m_globalTags

protected

List of globaltags to be used.

Definition at line 234 of file Database.h.

◆ m_metadataConfigurations

std::vector<std::string> m_metadataConfigurations

protected

List of available metadata providers (which haven't been tried yet)

Definition at line 230 of file Database.h.

◆ m_metadataProvider

std::unique_ptr<Conditions::MetadataProvider> m_metadataProvider

protected

Currently active metadata provider.

Definition at line 238 of file Database.h.

◆ m_payloadCreation

std::unique_ptr<Conditions::TestingPayloadStorage> m_payloadCreation

protected

testing payload storage to create new payloads

Definition at line 242 of file Database.h.

◆ m_payloadProvider

std::unique_ptr<Conditions::PayloadProvider> m_payloadProvider

protected

The active payload provider.

Definition at line 240 of file Database.h.

◆ m_testingPayloads

std::vector<Conditions::TestingPayloadStorage> m_testingPayloads

protected

optional list of testing payload storages to look for existing payloads

Definition at line 244 of file Database.h.

◆ m_usableTagStates

std::set<std::string> m_usableTagStates

protected

Set of usable globaltag states to be handed to the metadata providers.

Definition at line 236 of file Database.h.

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

framework/database/include/Database.h
framework/database/src/Database.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ DBQuery

Member Enumeration Documentation

◆ EDatabaseState

Member Function Documentation

◆ addPayload()

◆ getAllDataNames()

◆ getData() [1/2]

◆ getData() [2/2]

◆ storeData() [1/2]

◆ storeData() [2/2]

Member Data Documentation

◆ m_configState

◆ m_currentProvider

◆ m_globalTags

◆ m_metadataConfigurations

◆ m_metadataProvider

◆ m_payloadCreation

◆ m_payloadProvider

◆ m_testingPayloads

◆ m_usableTagStates