Datasource.h

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
    Datasource.h
 
    Qore Programming Language
 
    Copyright (C) 2003 - 2023 Qore Technologies, s.r.o.
 
    The Datasource class provides the low-level interface to Qore DBI drivers.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 
    Note that the Qore library is released under a choice of three open-source
    licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
    information.
*/
 
#ifndef _QORE_DATASOURCE_H
 
#define _QORE_DATASOURCE_H
 
#include <qore/QoreThreadLock.h>
#include <qore/QoreQueue.h>
 
#include <string>
 
class DBIDriver;
class DatasourceStatementHelper;
 
 
class Datasource {
    friend class QoreSQLStatement;
    friend hashdecl qore_ds_private;
 
private:
    hashdecl qore_ds_private *priv; // private implementation
 
    Datasource& operator=(const Datasource&) = delete;
 
    DLLLOCAL QoreValue exec_internal(bool doBind, const QoreString* query_str, const QoreListNode* args, ExceptionSink* xsink);
 
protected:
    DLLEXPORT void freeConnectionValues();
 
    DLLEXPORT void setConnectionValues();
 
    DLLEXPORT void setTransactionStatus(bool);
 
    DLLEXPORT void setPendingConnectionValues(const Datasource* other);
 
    DLLEXPORT int beginImplicitTransaction(ExceptionSink* xsink);
 
public:
 
    DLLLOCAL Datasource(DBIDriver* driver, DatasourceStatementHelper* dsh);
 
 
    DLLLOCAL Datasource(const Datasource& old, DatasourceStatementHelper* dsh);
 
 
    DLLEXPORT Datasource(DBIDriver* driver);
 
    /*
        @deprecated do not use
    */
    DLLEXPORT Datasource(const Datasource& old);
 
    DLLEXPORT virtual ~Datasource();
 
 
    DLLEXPORT bool getAutoCommit() const;
 
 
    DLLEXPORT const char* getUsername() const;
 
 
    DLLEXPORT const char* getPassword() const;
 
 
    DLLEXPORT const char* getDBName() const;
 
 
    DLLEXPORT const char* getDBEncoding() const;
 
 
    DLLEXPORT const char* getOSEncoding() const;
 
 
    DLLEXPORT const char* getHostName() const;
 
 
    DLLEXPORT int getPort() const;
 
 
    DLLEXPORT const std::string& getUsernameStr() const;
 
 
    DLLEXPORT const std::string& getPasswordStr() const;
 
 
    DLLEXPORT const std::string& getDBNameStr() const;
 
 
    DLLEXPORT const std::string& getDBEncodingStr() const;
 
 
    DLLEXPORT const std::string& getHostNameStr() const;
 
    DLLEXPORT void* getPrivateData() const;
 
    template <typename T>
    DLLLOCAL T* getPrivateData() const {
        return reinterpret_cast<T*>(getPrivateData());
    }
 
    template <typename T>
    DLLLOCAL T& getPrivateDataRef() const {
        return *getPrivateData<T>();
    }
 
 
    DLLEXPORT void setPrivateData(void* data);
 
 
    DLLEXPORT void setDBEncoding(const char* name);
 
    DLLEXPORT const QoreEncoding* getQoreEncoding() const;
 
 
    DLLEXPORT void setQoreEncoding(const QoreEncoding* enc);
 
 
    DLLEXPORT void setQoreEncoding(const char* name);
 
 
    DLLEXPORT void setPendingUsername(const char* u);
 
 
    DLLEXPORT void setPendingPassword(const char* p);
 
 
    DLLEXPORT void setPendingDBName(const char* d);
 
 
    DLLEXPORT void setPendingDBEncoding(const char* c);
 
 
    DLLEXPORT void setPendingHostName(const char* h);
 
 
    DLLEXPORT void setPendingPort(int port);
 
    DLLEXPORT void setAutoCommit(bool ac);
 
 
    DLLEXPORT int open(ExceptionSink* xsink);
 
 
    DLLEXPORT QoreValue select(const QoreString* query_str, const QoreListNode* args, ExceptionSink* xsink);
 
 
    DLLEXPORT QoreValue selectRows(const QoreString* query_str, const QoreListNode* args, ExceptionSink* xsink);
 
 
    DLLEXPORT QoreHashNode* selectRow(const QoreString* query_str, const QoreListNode* args, ExceptionSink* xsink);
 
 
    DLLEXPORT QoreValue exec(const QoreString* query_str, const QoreListNode* args, ExceptionSink* xsink);
 
 
    DLLEXPORT QoreValue execRaw(const QoreString* query_str, const QoreListNode* args, ExceptionSink* xsink);
 
 
    DLLEXPORT QoreValue execRaw(const QoreString* query_str, ExceptionSink* xsink);
 
 
    DLLEXPORT QoreHashNode* describe(const QoreString* query_str, const QoreListNode* args, ExceptionSink* xsink);
 
 
    DLLEXPORT int commit(ExceptionSink* xsink);
 
 
    DLLEXPORT int rollback(ExceptionSink* xsink);
 
    DLLEXPORT int close();
 
    DLLEXPORT void reset(ExceptionSink* xsink);
 
 
    DLLEXPORT QoreListNode* getCapabilityList() const;
 
 
    DLLEXPORT int getCapabilities() const;
 
 
    DLLEXPORT QoreStringNode* getPendingUsername() const;
 
 
    DLLEXPORT QoreStringNode* getPendingPassword() const;
 
 
    DLLEXPORT QoreStringNode* getPendingDBName() const;
 
 
    DLLEXPORT QoreStringNode* getPendingDBEncoding() const;
 
 
    DLLEXPORT QoreStringNode* getPendingHostName() const;
 
 
    DLLEXPORT int getPendingPort() const;
 
    DLLEXPORT int beginTransaction(ExceptionSink* xsink);
 
 
    DLLEXPORT bool isInTransaction() const;
 
 
    DLLEXPORT bool activeTransaction() const;
 
 
    DLLEXPORT bool isOpen() const;
 
 
    DLLEXPORT Datasource* copy() const;
 
 
    DLLEXPORT const char* getDriverName() const;
 
 
    DLLEXPORT QoreValue getServerVersion(ExceptionSink* xsink);
 
 
    DLLEXPORT QoreValue getClientVersion(ExceptionSink* xsink) const;
 
 
    DLLEXPORT QoreStringNode* getDriverRealName(ExceptionSink* xsink);
 
 
    DLLEXPORT const DBIDriver* getDriver() const;
 
 
    DLLEXPORT void connectionAborted();
 
 
    DLLEXPORT void connectionAborted(ExceptionSink* xsink);
 
 
    DLLEXPORT void connectionLost(ExceptionSink* xsink);
 
 
    DLLEXPORT void connectionRecovered(ExceptionSink* xsink);
 
 
    DLLEXPORT bool wasConnectionAborted() const;
 
 
    DLLEXPORT int autoCommit(ExceptionSink* xsink);
 
 
    DLLEXPORT QoreHashNode* getOptionHash() const;
 
 
    DLLEXPORT QoreHashNode* getCurrentOptionHash() const;
 
 
    DLLEXPORT int setOption(const char* opt, const QoreValue val, ExceptionSink* xsink);
 
 
    DLLEXPORT QoreValue getOption(const char* opt, ExceptionSink* xsink);
 
 
    DLLEXPORT const QoreHashNode* getConnectOptions() const;
 
 
    DLLEXPORT QoreHashNode* getConfigHash() const;
 
 
    DLLEXPORT QoreStringNode* getConfigString() const;
 
 
    DLLEXPORT void setEventQueue(Queue* q, QoreValue arg, ExceptionSink* xsink);
 
 
    DLLEXPORT QoreHashNode* getEventQueueHash(Queue*& q, int event_code) const;
 
 
    DLLEXPORT QoreObject* getSQLStatementObjectForResultSet(void* stmt_private_data);
};
 
#endif // _QORE_DATASOURCE_H