Qore Programming Language 0.8.8

- Main Page
- Related Pages
- Modules
- Classes
- Files

- File List
- File Members

All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Datasource.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3 Datasource.h
4
5 Qore Programming Language
6
7 Copyright 2003 - 2013 David Nichols
8
9 The Datasource class provides the low-level interface to Qore DBI drivers.
10
11 This library is free software; you can redistribute it and/or
12 modify it under the terms of the GNU Lesser General Public
13 License as published by the Free Software Foundation; either
14 version 2.1 of the License, or (at your option) any later version.
15
16 This library is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 Lesser General Public License for more details.
20
21 You should have received a copy of the GNU Lesser General Public
22 License along with this library; if not, write to the Free Software
23 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24 */
25
26 #ifndef _QORE_DATASOURCE_H
27
28 #define _QORE_DATASOURCE_H
29
30 #include <qore/QoreThreadLock.h>
31
32 #include <string>
33
34 class DBIDriver;
35
37
45 class Datasource {
46 friend class QoreSQLStatement;
47
48 private:
49 struct qore_ds_private *priv; // private implementation
50
52 DLLLOCAL Datasource& operator=(const Datasource&);
53
55 DLLLOCAL AbstractQoreNode* exec_internal(bool doBind, const QoreString* query_str, const QoreListNode* args, ExceptionSink* xsink);
56
57 protected:
59 DLLEXPORT void freeConnectionValues();
60
62 DLLEXPORT void setConnectionValues();
63
65 DLLEXPORT void setTransactionStatus(bool);
66
68 DLLEXPORT void setPendingConnectionValues(const Datasource* other);
69
71 DLLEXPORT int beginImplicitTransaction(ExceptionSink* xsink);
72
73 public:
75
78 DLLEXPORT Datasource(DBIDriver* driver);
79
81 DLLEXPORT Datasource(const Datasource& old);
82
84 DLLEXPORT virtual ~Datasource();
85
87
90 DLLEXPORT bool getAutoCommit() const;
91
93
96 DLLEXPORT const char* getUsername() const;
97
99
102 DLLEXPORT const char* getPassword() const;
103
105
108 DLLEXPORT const char* getDBName() const;
109
111
114 DLLEXPORT const char* getDBEncoding() const;
115
117
120 DLLEXPORT const char* getOSEncoding() const;
121
123
126 DLLEXPORT const char* getHostName() const;
127
129
132 DLLEXPORT int getPort() const;
133
135
138 DLLEXPORT const std::string& getUsernameStr() const;
139
141
144 DLLEXPORT const std::string& getPasswordStr() const;
145
147
150 DLLEXPORT const std::string& getDBNameStr() const;
151
153
156 DLLEXPORT const std::string& getDBEncodingStr() const;
157
159
162 DLLEXPORT const std::string& getHostNameStr() const;
163
165 DLLEXPORT void* getPrivateData() const;
166
168 template <typename T>
169 DLLLOCAL T* getPrivateData() const {
170 return reinterpret_cast<T*>(getPrivateData());
171 }
172
174 template <typename T>
175 DLLLOCAL T& getPrivateDataRef() const {
176 return *getPrivateData<T>();
177 }
178
180
183 DLLEXPORT void setPrivateData(void* data);
184
186
189 DLLEXPORT void setDBEncoding(const char* name);
190
192 DLLEXPORT const QoreEncoding* getQoreEncoding() const;
193
195
198 DLLEXPORT void setQoreEncoding(const QoreEncoding* enc);
199
201
204 DLLEXPORT void setQoreEncoding(const char* name);
205
207
210 DLLEXPORT void setPendingUsername(const char* u);
211
213
216 DLLEXPORT void setPendingPassword(const char* p);
217
219
222 DLLEXPORT void setPendingDBName(const char* d);
223
225
228 DLLEXPORT void setPendingDBEncoding(const char* c);
229
231
234 DLLEXPORT void setPendingHostName(const char* h);
235
237
240 DLLEXPORT void setPendingPort(int port);
241
242 DLLEXPORT void setAutoCommit(bool ac);
243
245
248 DLLEXPORT int open(ExceptionSink* xsink);
249
251
256 DLLEXPORT AbstractQoreNode* select(const QoreString* query_str, const QoreListNode* args, ExceptionSink* xsink);
257
259
264 DLLEXPORT AbstractQoreNode* selectRows(const QoreString* query_str, const QoreListNode* args, ExceptionSink* xsink);
265
267
274 DLLEXPORT QoreHashNode* selectRow(const QoreString* query_str, const QoreListNode* args, ExceptionSink* xsink);
275
277
284 DLLEXPORT AbstractQoreNode* exec(const QoreString* query_str, const QoreListNode* args, ExceptionSink* xsink);
285
287
297 DLLEXPORT AbstractQoreNode* execRaw(const QoreString* query_str, const QoreListNode* args, ExceptionSink* xsink);
298
300
307 DLLEXPORT AbstractQoreNode* execRaw(const QoreString* query_str, ExceptionSink* xsink);
308
310
314 DLLEXPORT int commit(ExceptionSink* xsink);
315
317
321 DLLEXPORT int rollback(ExceptionSink* xsink);
322
324 DLLEXPORT int close();
325
327 DLLEXPORT void reset(ExceptionSink* xsink);
328
330
333 DLLEXPORT QoreListNode* getCapabilityList() const;
334
336
339 DLLEXPORT int getCapabilities() const;
340
342
344 DLLEXPORT QoreStringNode* getPendingUsername() const;
345
347
349 DLLEXPORT QoreStringNode* getPendingPassword() const;
350
352
354 DLLEXPORT QoreStringNode* getPendingDBName() const;
355
357
359 DLLEXPORT QoreStringNode* getPendingDBEncoding() const;
360
362
365 DLLEXPORT QoreStringNode* getPendingHostName() const;
366
368
371 DLLEXPORT int getPendingPort() const;
372
378 DLLEXPORT int beginTransaction(ExceptionSink* xsink);
379
381
384 DLLEXPORT bool isInTransaction() const;
385
387
391 DLLEXPORT bool activeTransaction() const;
392
394
397 DLLEXPORT bool isOpen() const;
398
400
403 DLLEXPORT Datasource* copy() const;
404
406 DLLEXPORT const char* getDriverName() const;
407
409
413 DLLEXPORT AbstractQoreNode* getServerVersion(ExceptionSink* xsink);
414
416
419 DLLEXPORT AbstractQoreNode* getClientVersion(ExceptionSink* xsink) const;
420
422
425 DLLEXPORT const DBIDriver* getDriver() const;
426
428
432 DLLEXPORT void connectionAborted();
433
435
437 DLLEXPORT bool wasConnectionAborted() const;
438
440
444 DLLEXPORT int autoCommit(ExceptionSink* xsink);
445
447
454 DLLEXPORT QoreHashNode* getOptionHash() const;
455
457
463 DLLEXPORT int setOption(const char* opt, const AbstractQoreNode* val, ExceptionSink* xsink);
464
466
473 DLLEXPORT AbstractQoreNode* getOption(const char* opt, ExceptionSink* xsink);
474
476
484 DLLEXPORT const QoreHashNode* getConnectOptions() const;
485
487
490 DLLEXPORT QoreHashNode* getConfigHash() const;
491
493
496 DLLEXPORT QoreStringNode* getConfigString() const;
497 };
498
499 #endif // _QORE_DATASOURCE_H
500
Datasource::getAutoCommit
DLLEXPORT bool getAutoCommit() const
returns the autocommit status
Datasource::setPendingConnectionValues
DLLEXPORT void setPendingConnectionValues(const Datasource *other)
copies all pending connection values to another Datasource
Datasource::getDriver
DLLEXPORT const DBIDriver * getDriver() const
returns the DBIDriver pointer used for this object
Datasource::getPrivateData
DLLLOCAL T * getPrivateData() const
returns the private DBI-specific data structure for this object
Definition: Datasource.h:169
Datasource::getPendingUsername
DLLEXPORT QoreStringNode * getPendingUsername() const
returns the pending username for the next connection
Datasource::getOption
DLLEXPORT AbstractQoreNode * getOption(const char *opt, ExceptionSink *xsink)
Returns the current value for the given option.
Datasource::getPendingDBName
DLLEXPORT QoreStringNode * getPendingDBName() const
returns the pending database (or schema) name for the next connection
Datasource::setPendingPort
DLLEXPORT void setPendingPort(int port)
sets the port number to be used for the next connection
Datasource::getPasswordStr
DLLEXPORT const std::string & getPasswordStr() const
returns the password used for the last connection
QoreEncoding
defines string encoding functions in Qore
Definition: QoreEncoding.h:72
Datasource::getConnectOptions
DLLEXPORT const QoreHashNode * getConnectOptions() const
returns the valid options for this driver with descriptions and current values for the current dataso...
Datasource::wasConnectionAborted
DLLEXPORT bool wasConnectionAborted() const
returns the connection aborted status
Datasource::commit
DLLEXPORT int commit(ExceptionSink *xsink)
commits the current transaction to the database
QoreHashNode
This is the hash or associative list container type in Qore, dynamically allocated only...
Definition: QoreHashNode.h:41
Datasource::~Datasource
virtual DLLEXPORT ~Datasource()
the Datasource is closed if it&#39;s still open and the object is destroyed
Datasource::setPendingUsername
DLLEXPORT void setPendingUsername(const char *u)
sets the username to be used for the next connection
Datasource::autoCommit
DLLEXPORT int autoCommit(ExceptionSink *xsink)
called from subclasses when releasing the transaction lock
Datasource::freeConnectionValues
DLLEXPORT void freeConnectionValues()
frees all connection values
Datasource::getUsernameStr
DLLEXPORT const std::string & getUsernameStr() const
returns the username used for the last connection
Datasource::getQoreEncoding
DLLEXPORT const QoreEncoding * getQoreEncoding() const
returns the QoreEncoding pointer used for this connection
Datasource::activeTransaction
DLLEXPORT bool activeTransaction() const
returns true if a transaction is in progress and DB commands have been issued since the transaction w...
Datasource::getPendingDBEncoding
DLLEXPORT QoreStringNode * getPendingDBEncoding() const
returns the pending database-specific character encoding name for the next connection ...
Datasource::setPendingHostName
DLLEXPORT void setPendingHostName(const char *h)
sets the hostname to be used for the next connection
Datasource::getConfigString
DLLEXPORT QoreStringNode * getConfigString() const
returns a string representing the configuration of the current object
AbstractQoreNode
The base class for all value and parse types in Qore expression trees.
Definition: AbstractQoreNode.h:47
Datasource::reset
DLLEXPORT void reset(ExceptionSink *xsink)
closes and opens the connection
Datasource::getPrivateDataRef
DLLLOCAL T & getPrivateDataRef() const
returns the private DBI-specific data structure for this object
Definition: Datasource.h:175
Datasource::getPassword
DLLEXPORT const char * getPassword() const
returns the password used for the last connection
DBIDriver
this class provides the internal link to the database driver for Qore&#39;s DBI layer ...
Definition: DBI.h:325
Datasource::getDBEncodingStr
DLLEXPORT const std::string & getDBEncodingStr() const
returns the database-specific character encoding name used for the last connection ...
Datasource::setPendingDBName
DLLEXPORT void setPendingDBName(const char *d)
sets the database (or schema) name to be used for the next connection
Datasource::getDBNameStr
DLLEXPORT const std::string & getDBNameStr() const
returns the database (or schema) name used for the last connection
QoreString
Qore&#39;s string type supported by the QoreEncoding class.
Definition: QoreString.h:42
QoreStringNode
Qore&#39;s string value type, reference counted, dynamically-allocated only.
Definition: QoreStringNode.h:40
Datasource::getDriverName
DLLEXPORT const char * getDriverName() const
returns the name of the current DBI driver
Datasource::setOption
DLLEXPORT int setOption(const char *opt, const AbstractQoreNode *val, ExceptionSink *xsink)
sets an option for the datasource
Datasource::isInTransaction
DLLEXPORT bool isInTransaction() const
returns the transaction status flag
Datasource::execRaw
DLLEXPORT AbstractQoreNode * execRaw(const QoreString *query_str, const QoreListNode *args, ExceptionSink *xsink)
executes SQL throught the &quot;execRaw&quot; function of the DBI driver and returns the result, makes an implicit connection if necessary
Datasource::beginTransaction
DLLEXPORT int beginTransaction(ExceptionSink *xsink)
Datasource::getPendingPassword
DLLEXPORT QoreStringNode * getPendingPassword() const
returns the pending password for the next connection
Datasource::getDBName
DLLEXPORT const char * getDBName() const
returns the database (or schema) name used for the last connection
QoreListNode
This is the list container type in Qore, dynamically allocated only, reference counted.
Definition: QoreListNode.h:44
Datasource::setPendingPassword
DLLEXPORT void setPendingPassword(const char *p)
sets the password to be used for the next connection
Datasource::Datasource
DLLEXPORT Datasource(DBIDriver *driver)
creates the object and binds it to a particular DBIDriver
Datasource::connectionAborted
DLLEXPORT void connectionAborted()
should be called by the DBIDriver if the connection to the server is lost
Datasource::rollback
DLLEXPORT int rollback(ExceptionSink *xsink)
rolls back the current transaction to the database
Datasource::setConnectionValues
DLLEXPORT void setConnectionValues()
copies pending values to current values
Datasource::getDBEncoding
DLLEXPORT const char * getDBEncoding() const
returns the database-specific character encoding name used for the last connection ...
Datasource::setQoreEncoding
DLLEXPORT void setQoreEncoding(const QoreEncoding *enc)
sets the QoreEncoding used for this connection
Datasource
the base class for accessing databases in Qore through a Qore DBI driver
Definition: Datasource.h:45
Datasource::getClientVersion
DLLEXPORT AbstractQoreNode * getClientVersion(ExceptionSink *xsink) const
executes the &quot;get_client_version&quot; function of the driver, if any, and returns the result ...
Datasource::selectRows
DLLEXPORT AbstractQoreNode * selectRows(const QoreString *query_str, const QoreListNode *args, ExceptionSink *xsink)
executes SQL throught the &quot;selectRows&quot; function of the DBI driver and returns the result...
Datasource::getOSEncoding
DLLEXPORT const char * getOSEncoding() const
returns the OS (or Qore) character encoding name used for the last connection
Datasource::select
DLLEXPORT AbstractQoreNode * select(const QoreString *query_str, const QoreListNode *args, ExceptionSink *xsink)
executes SQL throught the &quot;select&quot; function of the DBI driver and returns the result, makes an implicit connection if necessary
Datasource::getCapabilityList
DLLEXPORT QoreListNode * getCapabilityList() const
returns a QoreListNode object of all capability strings of the current driver, the caller owns the re...
ExceptionSink
container for holding Qore-language exception information and also for registering a &quot;thread_exit&quot; ca...
Definition: ExceptionSink.h:35
Datasource::getPort
DLLEXPORT int getPort() const
returns the port number used for the last connection
Datasource::beginImplicitTransaction
DLLEXPORT int beginImplicitTransaction(ExceptionSink *xsink)
calls the &quot;begin_implicit_transaction&quot; DBI method if it exists
Datasource::isOpen
DLLEXPORT bool isOpen() const
returns true if the connection is currently open
Datasource::getServerVersion
DLLEXPORT AbstractQoreNode * getServerVersion(ExceptionSink *xsink)
executes the &quot;get_server_version&quot; function of the driver, if any, and returns the result...
Datasource::copy
DLLEXPORT Datasource * copy() const
returns a copy of this object with the same DBIDriver and pending connection values ...
Datasource::getUsername
DLLEXPORT const char * getUsername() const
returns the username used for the last connection
Datasource::setPendingDBEncoding
DLLEXPORT void setPendingDBEncoding(const char *c)
sets the database-specific name of the character-encoding to be used for the next connection ...
Datasource::getCapabilities
DLLEXPORT int getCapabilities() const
returns the capability mask of the current driver
Datasource::getPendingPort
DLLEXPORT int getPendingPort() const
returns the pending port number for the next connection
Datasource::selectRow
DLLEXPORT QoreHashNode * selectRow(const QoreString *query_str, const QoreListNode *args, ExceptionSink *xsink)
executes SQL throught the &quot;selectRow&quot; function of the DBI driver and returns the result, makes an implicit connection if necessary
Datasource::setTransactionStatus
DLLEXPORT void setTransactionStatus(bool)
sets the transaction status
Datasource::setPrivateData
DLLEXPORT void setPrivateData(void *data)
sets the private DBI-specific data structure for this object
Datasource::exec
DLLEXPORT AbstractQoreNode * exec(const QoreString *query_str, const QoreListNode *args, ExceptionSink *xsink)
executes SQL throught the &quot;exec&quot; function of the DBI driver and returns the result, makes an implicit connection if necessary
Datasource::open
DLLEXPORT int open(ExceptionSink *xsink)
opens a connection to the database
Datasource::getOptionHash
DLLEXPORT QoreHashNode * getOptionHash() const
returns the valid options for this driver with descriptions and current values for the current dataso...
Datasource::getHostNameStr
DLLEXPORT const std::string & getHostNameStr() const
returns the host name used for the last connection
Datasource::getConfigHash
DLLEXPORT QoreHashNode * getConfigHash() const
returns a hash representing the configuration of the current object
Datasource::setDBEncoding
DLLEXPORT void setDBEncoding(const char *name)
sets the database-specific character encoding name used for the current connection ...
Datasource::getPrivateData
DLLEXPORT void * getPrivateData() const
returns the private DBI-specific data structure for this object
Datasource::getHostName
DLLEXPORT const char * getHostName() const
returns the host name used for the last connection
Datasource::getPendingHostName
DLLEXPORT QoreStringNode * getPendingHostName() const
returns the pending host name for the next connection
Datasource::close
DLLEXPORT int close()
closes the connection