ATLAS Offline Software
Loading...
Searching...
No Matches
DbStorageExplorer.h
Go to the documentation of this file.
1/*
2 Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
3*/
4
5#ifndef POOL_DBSTORAGEEXPLORER_H
6#define POOL_DBSTORAGEEXPLORER_H
7
8// Framework include files
11
12/*
13 * pool namespace declaration
14 */
15namespace pool {
16
17 // Forward declarations
18 class DbStorageSvc;
19 class DbDomain;
20 class DbOption;
21
35 class DbStorageExplorer : virtual public IStorageExplorer, public AthMessaging
36 {
37 typedef std::vector<const Token*> TokenVec;
38
41
44
46 std::string m_name;
47
48 public:
49
52
54
56 DbStorageExplorer(const std::string& name,
57 DbDomain& domH,
58 DbStorageSvc* pOuter);
59
62
64
66 virtual DbStatus queryInterface(const Guid& riid,
67 void** ppvUnknown);
68
70 virtual unsigned int addRef();
71
73 virtual unsigned int release();
74
76
93 virtual DbStatus startSession(int mode,
94 int tech,
95 SessionH& session);
96
98
110 virtual DbStatus endSession(const SessionH session);
111
113
128 virtual DbStatus connect( const SessionH sessionH,
129 int mode,
130 FileDescriptor& refDB);
131
133
147
149
156 TokenVec& conts,
157 bool intern);
158
160
168 const std::string& nam,
169 std::string& val);
170
172
183 virtual DbStatus getDomainOption(const SessionH sessionH,
184 DbOption& opt);
185
187
198 virtual DbStatus setDomainOption(const SessionH sessionH,
199 const DbOption& opt);
200
202
211 DbOption& opt);
212
214
223 const DbOption& opt);
224
226
236 const std::string& cntName,
237 DbOption& opt);
238
240
250 const std::string& cntName,
251 const DbOption& opt);
252
254
262 const std::string& cntName,
263 DbSelect& sel);
264
266
274 virtual DbStatus next(DbSelect& context, Token*& refpTok);
275 };
276} // End namespace pool
277#endif // POOL_DBSTORAGEEXPLORER_H
AthMessaging(IMessageSvc *msgSvc, const std::string &name)
Constructor.
This class provides a token that identifies in a unique way objects on the persistent storage.
Definition Token.h:21
Description:
Definition DbDomain.h:47
Description: Definition an option to be supplied to database objects.
Definition DbOption.h:36
Definition of the DbSelect class.
Definition DbSelect.h:43
This class is highly inspired by the error code distribution system as it is used in DEC/VMS or MS/WN...
Definition DbStatus.h:64
virtual unsigned int addRef()
IInterface implementation: Reference Interface instance.
virtual unsigned int release()
IInterface implementation: Release Interface instance.
virtual DbStatus setDatabaseOption(FileDescriptor &refDB, const DbOption &opt)
Set options for a given database.
virtual ~DbStorageExplorer()
Standard destructor.
virtual DbStatus dbParam(FileDescriptor &refDB, const std::string &nam, std::string &val)
Retrieve existing parameter by name.
virtual DbStatus setDomainOption(const SessionH sessionH, const DbOption &opt)
Set options for a given database domain.
DbStorageSvc * m_pOuter
Reference to outer interface.
DbDomain & m_domH
Reference to domain handle.
virtual DbStatus next(DbSelect &context, Token *&refpTok)
Access the next token of a sequence.
virtual DbStatus connect(const SessionH sessionH, int mode, FileDescriptor &refDB)
Connect to a logical Database unit.
virtual DbStatus startSession(int mode, int tech, SessionH &session)
Start a new Database Session.
virtual DbStatus getContainerOption(FileDescriptor &refDB, const std::string &cntName, DbOption &opt)
Access options for a given database container.
virtual DbStatus getDomainOption(const SessionH sessionH, DbOption &opt)
Access options for a given database domain.
virtual DbStatus select(FileDescriptor &refDB, const std::string &cntName, DbSelect &sel)
Initiate a selection on a given container.
virtual DbStatus endSession(const SessionH session)
End the Database session.
virtual DbStatus queryInterface(const Guid &riid, void **ppvUnknown)
IInterface implementation: Query interfaces of Interface.
std::vector< const Token * > TokenVec
DbStorageExplorer(const std::string &name, DbDomain &domH, DbStorageSvc *pOuter)
Initializing Constructor: Constructs an object of type DbStorageExplorer.
std::string m_name
Explorer name.
virtual DbStatus disconnect(FileDescriptor &refDB)
Disconnect from a logical Database unit.
virtual DbStatus containers(FileDescriptor &refDB, TokenVec &conts, bool intern)
Access the containers in a given database.
virtual DbStatus setContainerOption(FileDescriptor &refDB, const std::string &cntName, const DbOption &opt)
Set options for a given database container.
DbStorageExplorer()
Standard Constructor: Constructs an object of type DbStorageExplorer.
virtual DbStatus getDatabaseOption(FileDescriptor &refDB, DbOption &opt)
Access options for a given database.
The DbStorageSvc class is able to handle user request for.
The IStorageExplorer interface is able to handle user request for.
pool namespace
Definition libname.h:15
class Session * SessionH