ATLAS Offline Software
Loading...
Searching...
No Matches
DbDatabase.h
Go to the documentation of this file.
1/*
2 Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
3*/
4#ifndef DBDATABASE_H
5#define DBDATABASE_H
6
7// Framework include files
10#include "StorageSvc/pool.h"
12
13// STL include files
14#include <vector>
15#include <string>
16#include <map>
17
18class StatusCode;
19class ITechFactory;
20
21// Forward declarations
22class ITechDatabase;
23class ITechContainer;
24class DbDomain;
25class DbDatabase;
26class DbDatabaseObj;
27class DbContainer;
28class DbContainerObj;
29class DbOption;
30class DbTypeInfo;
31
39class DbDatabase : public DbHandleBase<DbDatabaseObj> {
40 protected:
42 typedef std::pair<std::string, std::string> Parameter;
44 typedef std::vector< Parameter > Parameters;
45
48 public:
50 explicit DbDatabase(const DbType& typ=pool::POOL_StorageType) { m_type = typ; }
52 DbDatabase(const DbDatabase& cp) : Base() { switchPtr(cp.m_ptr); }
56 virtual ~DbDatabase() { switchPtr(0); }
59 if ( &copy != this ) {
60 m_type = copy.m_type;
61 switchPtr( copy.m_ptr );
62 }
63 return *this;
64 }
65
66 DbDatabase& operator=(const int /* nuller */ ) {
67 switchPtr(0);
68 return *this;
69 }
70
71 // Move
73 {
74 setPtr (cp.m_ptr);
75 setType (cp.m_type);
76 cp.setPtr (nullptr);
77 cp.setType(DbType(0));
78 }
80 {
81 if (&cp != this) {
82 switchPtr (nullptr);
83 setPtr (cp.m_ptr);
84 setType (cp.m_type);
85 cp.setPtr (nullptr);
86 cp.setType(DbType(0));
87 }
88 return *this;
89 }
90
92 int refCount() const;
94 Io::IoFlag openMode() const;
96 const std::string& name() const;
98 void setName(const std::string& nam);
100 const std::string& logon() const;
102 long long int size() const;
105 const ITechFactory* techFactory() const;
107 StatusCode add(const std::string& name, DbContainerObj* cnt);
109 StatusCode remove(const DbContainerObj* cnt);
111 const DbContainerObj* find(const std::string& nam) const;
113 DbContainerObj* find(const std::string& nam);
115 const Token* token() const;
117 const DbDomain& containedIn() const;
120 bool exist(DbDomain& domH, const std::string& nam) const;
122
128 StatusCode open(DbDomain& domH,
129 const std::string& pfn,
130 const std::string& fid,
131 Io::IoFlag mode = Io::READ);
133 StatusCode close();
135 StatusCode retire();
137 bool isOpen() const;
139
142 StatusCode transAct(Transaction::Action action);
144
147 StatusCode setOption(const DbOption& refOpt);
149
152 StatusCode getOption(DbOption& refOpt);
154 StatusCode addParam(const std::string& nam, const std::string& val);
156 StatusCode param(const std::string& nam, std::string& val) const;
157
159 StatusCode read(const Token& token, const DbTypeInfo* tinfo, void** object);
161 std::string cntName(Token& token) const;
163 StatusCode makeLink(Token* pToken, Token::OID_t& linkH);
165 StatusCode addShape(const DbTypeInfo* tinfo);
167 const DbTypeInfo* objectShape(const RootType& typeH) const;
169 const DbTypeInfo* objectShape(const Guid& nam) const;
171 const DbTypeInfo* contShape(const std::string& nam) const;
173 const Token* cntToken(const std::string& cntName);
175 StatusCode containers(std::vector<const Token*>& conts, bool intern=false);
176 StatusCode containers(std::vector<ITechContainer*>& conts, bool intern=false);
179 const ITechDatabase* info() const;
181 void setAge(int value);
183 int age() const;
184};
185
186#endif
TTypeAdapter RootType
Definition RootType.h:211
This file contains the class definition for the Token class (migrated from POOL).
Description:
Description: This class is a handle managing access and lifetime for the Container implementation obj...
Definition DbContainer.h:31
Description: Technology independent part of a Database object implementation.
Description: Handle managing a DbDatabaseObj, a generic Database object.
Definition DbDatabase.h:39
DbDomain & containedIn()
StatusCode close()
Close Database.
StatusCode read(const Token &token, const DbTypeInfo *tinfo, void **object)
read an object referenced by the token
DbDatabase(DbDatabase &&cp)
Definition DbDatabase.h:72
const ITechFactory * techFactory() const
StatusCode makeLink(Token *pToken, Token::OID_t &linkH)
Add association link to link container.
const DbContainerObj * find(const std::string &nam) const
Select container object in Database.
void switchPtr(DbDatabaseObj *obj)
Assign transient object properly (including reference counting).
StatusCode remove(const DbContainerObj *cnt)
Find domain in session.
const std::string & logon() const
Access to db logon string.
StatusCode open(DbDomain &domH, const std::string &pfn, const std::string &fid, Io::IoFlag mode=Io::READ)
Open Database using given domain.
StatusCode containers(std::vector< const Token * > &conts, bool intern=false)
Allow access to all known containers.
StatusCode setOption(const DbOption &refOpt)
Set options.
StatusCode transAct(Transaction::Action action)
Commit Database Transaction.
std::vector< Parameter > Parameters
Parameter container definition.
Definition DbDatabase.h:44
const DbDomain & containedIn() const
Access to domain object.
int age() const
Access age value.
StatusCode param(const std::string &nam, std::string &val) const
Retrieve existing parameter by name.
DbDatabase(const DbType &typ=pool::POOL_StorageType)
Constructor with initializing arguments.
Definition DbDatabase.h:50
DbDatabase(const DbDatabase &cp)
Copy constructor.
Definition DbDatabase.h:52
DbDatabase & operator=(const DbDatabase &copy)
Assignment (copy) operator.
Definition DbDatabase.h:58
StatusCode addShape(const DbTypeInfo *tinfo)
Add persistent type to the Database.
DbContainerObj * find(const std::string &nam)
Select container object in Database.
virtual ~DbDatabase()
Standard destructor.
Definition DbDatabase.h:56
void setAge(int value)
Update database age.
const DbTypeInfo * objectShape(const RootType &typeH) const
Retrieve persistent type information by class handle.
std::pair< std::string, std::string > Parameter
Parameter definition.
Definition DbDatabase.h:42
const DbTypeInfo * objectShape(const Guid &nam) const
Retrieve persistent type information by name.
StatusCode add(const std::string &name, DbContainerObj *cnt)
Add domain to session.
StatusCode retire()
End database access, but still leave database accessible.
bool isOpen() const
Check if the database was opened.
std::string cntName(Token &token) const
Retrieve container name from link container (using token oid, rather than contID).
const Token * cntToken(const std::string &cntName)
Access local container token (if container exists).
const DbTypeInfo * contShape(const std::string &nam) const
Retrieve persistent type information by container.
int refCount() const
Access reference counter.
ITechFactory * techFactory()
Allow access to the Database implementation.
StatusCode containers(std::vector< ITechContainer * > &conts, bool intern=false)
DbDatabase(DbDatabaseObj *obj)
Constructor.
Definition DbDatabase.h:54
DbDatabase & operator=(const int)
Assignment operator to reset handle using 0.
Definition DbDatabase.h:66
ITechDatabase * info()
Let the implementation access the internals.
StatusCode addParam(const std::string &nam, const std::string &val)
Add a persistent parameter to the file.
const Token * token() const
Access the token of the database object.
bool exist(DbDomain &domH, const std::string &nam) const
Check for existence of Database within domain.
Io::IoFlag openMode() const
Access to access mode member.
void setName(const std::string &nam)
Set db name (FID) after opening in case opening happened by PFN.
long long int size() const
Access the size of the database: May be undefined for some technologies.
const std::string & name() const
Access to db name (FID).
StatusCode getOption(DbOption &refOpt)
Access options.
const ITechDatabase * info() const
Description:
Definition DbDomain.h:33
DbHandleBase< _DataType > Base
void setType(const DbType &typ)
void setPtr(DbDatabaseObj *ptr)
Description: Definition an option to be supplied to database objects.
Definition DbOption.h:22
Definition of class DbTypeInfo.
Definition DbTypeInfo.h:31
Keeps information about storage technology.
Definition DbType.h:15
This class provides a encapsulation of a GUID/UUID/CLSID/IID data structure (128 bit number).
Definition Guid.h:25
Description: Interface to the technology specific implementation of the Container object.
Description: Interface to the technology specific implementation of a Database object.
This class provides a token that identifies in a unique way objects on the persistent storage.
Definition Token.h:22
::StatusCode StatusCode
StatusCode definition for legacy code.
static const DbType POOL_StorageType
Definition DbType.h:71