OracleExtensions.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
// @file OracleExtensions.qm OracleExtensions module definition

/*  OracleExtensions.qm Copyright (C) 2012 - 2014 Qore Technologies s.r.o.

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.
*/



/*  Version History
    * 2015-03-24 v1.2: Petr Vanek <petr.vanek@qoretechnologies.com>
      + small refactoring to allow using base classes with Qore::SQL::datasource and Qore::SQL::DatasourcePool
      + abstract OracleInstrumentationBase::setAppInfoCallback(*string oraclient, *string oramodule, *string oraaction);
      + abstract bool OracleInstrumentationBase::currentThreadInTransaction();
    * 2014-01-24 v1.1: Petr Vanek <petr.vanek@qoretechnologies.com>
      + OracleSQLstatement implemented
      + documentation fixes
    * 2012-02-05 v1.0: Petr Vanek <petr.vanek@qoretechnologies.com>
      + initial implementation
*/

namespace OracleExtensions {

class OracleInstrumentationBase
{
    private :
        *OracleExtensions::OracleApplicationInfo userInfo;
        *code autoCode;
        object m_ds;

public:

    constructor(*code userAutoInfo);


    *code autoCode() { return autoCode; }


    bool setAutomaticDBInfo(*OracleExtensions::OracleApplicationInfo item, bool checkTransaction=True);



    abstract setAppInfoCallback(*string oraclient, *string oramodule, *string oraaction);

    abstract bool currentThreadInTransaction();


    setAppInfo(*OracleExtensions::OracleApplicationInfo audit, bool fromSystem=True);


    setAppInfo(*string client, *string module, *string action, bool fromSystem=True);



}; // class OracleInstrumentationBase

class OracleDatasourceBase : public Qore::SQL::AbstractDatasource,public  OracleInstrumentationBase
{
    *string getDBName() { return m_ds.getDBName(); }
    *string getUserName() { return m_ds.getUserName(); }
    any getServerVersion() { return m_ds.getServerVersion(); }
    *string getPassword() { return m_ds.getPassword(); }
    hash getConfigHash() { return m_ds.getConfigHash(); }
    *int getPort() { return m_ds.getPort(); }
    string getConfigString() { return m_ds.getConfigString(); }
    any getClientVersion() { return m_ds.getClientVersion(); }
    *string getOSEncoding() { return m_ds.getOSEncoding(); }
    string getDriverName() { return m_ds.getDriverName(); }
    string getDBEncoding() { return m_ds.getDBEncoding(); }
    *string getHostName() { return m_ds.getHostName(); }
    bool inTransaction() { return m_ds.inTransaction(); }

    setAppInfoCallback(*string oraclient, *string oramodule, *string oraaction);


    bool currentThreadInTransaction();



    nothing beginTransaction(*string client, *string module, *string action);



    nothing beginTransaction(OracleExtensions::OracleApplicationInfo info);



    any exec(string sql);



    any execRaw(string sql);



    any select(string sql);



    any selectRow(string sql);



    any selectRows(string sql);



    any vexec(string sql, softlist vargs);



    any vselect(string sql, softlist vargs);



    any vselectRow(string sql, softlist vargs);



    any vselectRows(string sql, softlist vargs);



    any exec(OracleExtensions::OracleApplicationInfo info, string sql);



    any execRaw(OracleExtensions::OracleApplicationInfo info, string sql);



    any select(OracleExtensions::OracleApplicationInfo info, string sql);



    any selectRow(OracleExtensions::OracleApplicationInfo info, string sql);



    any selectRows(OracleExtensions::OracleApplicationInfo info, string sql);



    any vexec(OracleExtensions::OracleApplicationInfo info, string sql);



    any vselect(OracleExtensions::OracleApplicationInfo info, string sql);



    any vselectRow(OracleExtensions::OracleApplicationInfo info, string sql);



    any vselectRows(OracleExtensions::OracleApplicationInfo info, string sql);


};

OracleDatasourceBase::constructor(*code userAutoInfo)
    : OracleInstrumentationBase(userAutoInfo)
{
    userInfo = NOTHING;
}

nothing OracleDatasourceBase::commit();


nothing OracleDatasourceBase::rollback();


OracleDatasourceBase::setLongOpsProgress(OracleLongOps lo);


OracleDatasourceBase::outputEnable(*int bufferSize);


OracleDatasourceBase::outputDisable();


OracleDatasourceBase::outputPut(softstring text);


OracleDatasourceBase::outputPutLine(softstring text);


*string OracleDatasourceBase::outputGet();



class OracleApplicationInfo
{
    public :
        *string client;
        *string module;
        *string action;

public:


    constructor(*string client, *string module, *string action);


    clear();



    bool isEmpty();


}; // class OracleApplicationInfo


class OracleLongOps
{
    public :
        string op_name;
        string target_desc;
        string units;
        int op_context = 0;
        int sofar;
        int totalwork;

public:
    private :
        // A token which represents the v$session_longops row to update. Set this to set_session_longops_nohint to start a new row. Use the returned value from the prior call to reuse a row.
        *int rindex;
        // Saves information across calls to set_session_longops: It is for internal use and should not be modified by the caller.
        *int slno;
        // Specifies the object that is being worked on during the long running operation. For example, it could be a table ID that is being sorted. It appears as the TARGET column of v$session_longops.
        *int target;

public:


/*OracleLongOps::*/constructor(string op_name, string target_desc, string units, int totalwork) {
    if (op_name.strlen() > 64)
        throw "ORACLE-LONGOPS-ERROR",
              sprintf("Constructor argument 'op_name' must have length 64 bytes max. Got: %d", op_name.strlen());
    self.op_name = op_name;

    if (target_desc.strlen() > 32)
        throw "ORACLE-LONGOPS-ERROR",
              sprintf("Constructor argument 'target_desc' must have length 32 bytes max. Got: %d", target_desc.strlen());
    self.target_desc = target_desc;

    if (target_desc.strlen() > 32)
        throw "ORACLE-LONGOPS-ERROR",
              sprintf("Constructor argument 'units' must have length 32 bytes max. Got: %d", target_desc.strlen());
    self.units = units;

    if (totalwork < 1)
        throw "ORACLE-LONGOPS-ERROR",
              sprintf("Constructor argument 'totalwork' must have greater than 0. Got: %d", totalwork);
    self.totalwork = totalwork;

    sofar = 0;
};


bool /*OracleLongOps::*/inProgress();



*int /*OracleLongOps::*/getTarget();


} // class OracleLongOps


*int OracleLongOps::getRindex();


OracleLongOps::setRindex(int i);



*int OracleLongOps::getSlno();


OracleLongOps::setSlno(int i);




class OracleDatasourcePool : public OracleExtensions::OracleDatasourceBase {

public:


    constructor(string driver, *string user, *string pass, *string db, *string encoding, *string host, softint min=3, softint max=10, softint port=0, *code userAutoInfo)
        : OracleExtensions::OracleDatasourceBase(userAutoInfo)
    {
        m_ds = new DatasourcePool(driver, user, pass, db, encoding, host, min, max);
    }

    constructor(string desc, *code userAutoInfo)
        : OracleExtensions::OracleDatasourceBase(userAutoInfo)
    {
        m_ds = new DatasourcePool(desc);
    }

    constructor(hash opts, *code userAutoInfo)
        : OracleExtensions::OracleDatasourceBase(userAutoInfo)
    {
        m_ds = new DatasourcePool(opts);
    }

    constructor(DatasourcePool ds, *code userAutoInfo)
        : OracleExtensions::OracleDatasourceBase(userAutoInfo)
    {
        m_ds = ds;
    }

    any methodGate(string meth);


    DatasourcePool getDS() { return m_ds; }

}; // class OracleDatasourcePool



class OracleDatasource : public OracleExtensions::OracleDatasourceBase {

public:


    constructor(string driver, *string user, *string pass, *string db, *string encoding, *string host, softint port=0, *code userAutoInfo)
        : OracleExtensions::OracleDatasourceBase(userAutoInfo)
    {
        m_ds = new Datasource(driver, user, pass, db, encoding, host, port);
    }

    constructor(string desc, *code userAutoInfo)
        : OracleExtensions::OracleDatasourceBase(userAutoInfo)
    {
        m_ds = new Datasource(desc);
    }

    constructor(hash opts, *code userAutoInfo)
        : OracleExtensions::OracleDatasourceBase(userAutoInfo)
    {
        m_ds = new Datasource(opts);
    }

    constructor(Datasource ds, *code userAutoInfo)
        : OracleExtensions::OracleDatasourceBase(userAutoInfo)
    {
        m_ds = ds;
    }

    nothing setAutoCommit(bool auto);


    any methodGate(string meth);


}; // class OracleDatasource



class OracleSQLStatement : public Qore::SQL::SQLStatement,public  OracleExtensions::OracleInstrumentationBase {

public:


    constructor(Qore::SQL::Datasource ds, *code userAutoInfo)
        : Qore::SQL::SQLStatement(ds),
          OracleExtensions::OracleInstrumentationBase(userAutoInfo)
    {
        m_ds = ds;
    }


    constructor(Qore::SQL::DatasourcePool ds, *code userAutoInfo)
        : Qore::SQL::SQLStatement(ds),
          OracleExtensions::OracleInstrumentationBase(userAutoInfo)
    {
        m_ds = ds;
    }


    constructor(OracleExtensions::OracleDatasource ds)
        : Qore::SQL::SQLStatement(ds.privateDS()),
          OracleExtensions::OracleInstrumentationBase(ds.autoCode())
    {
        m_ds = ds.privateDS();
    }


    constructor(OracleExtensions::OracleDatasourcePool ds)
        : Qore::SQL::SQLStatement(ds.privateDS()),
          OracleExtensions::OracleInstrumentationBase(ds.autoCode())
    {
        m_ds = ds.privateDS();
    }

    setAppInfoCallback(*string oraclient, *string oramodule, *string oraaction);


    bool currentThreadInTransaction();


    nothing exec();


    nothing execArgs(softlist vargs);


    bool next();


    nothing commit();


    nothing rollback();


}; // class OracleSQLStatement


} // namespace OracleExtensions




// qore -DOracleExtensionsTest=1 OracleExtensions.qm
extern string connstr = "oracle:pvanek_omq/omq@xbox";


any stmtTest(object o);


any test(object o, string m);


testData(object o1, object o2, string m);



extern bool backRun = True;
backRunLogger();


testLongOps(object o);


testDBMSOut(object o)
{
    printf("testDBMS\n");

    o.outputEnable();
    o.outputPutLine('foo');
    o.outputPutLine(111);
    o.outputPutLine(now());
    o.exec("begin dbms_output.put_line(%v); end;", "hey, it's server here");

    *string res = o.outputGet();
    printf("DBMS_OUTPUT RESULT:\n%N\n", res);
    o.outputDisable();
}

extern Counter autoCnt();
*OracleExtensions::OracleApplicationInfo getAutoInfo()
{
//    printf("getAutoInfo: called\n");
    autoCnt.inc();
    return new OracleExtensions::OracleApplicationInfo("user module",
                                                       sprintf("auto info: %d", autoCnt.getCount()),
                                                       sprintf("auto info: %n", now())
                                                    );
}

baseTest(object dd);


testDataDiffs();


testPoolConnectionCount();


{
    background backRunLogger();
    on_exit backRun = False;

    OracleExtensions::OracleDatasource dd(connstr, \getAutoInfo());
    dd.setAutoCommit(False);
    baseTest(dd);

    OracleExtensions::OracleDatasourcePool dp(connstr, \getAutoInfo());
    baseTest(dp);

    testDataDiffs();

    testPoolConnectionCount();

    stmtTest(dd);
    stmtTest(dp);
}