TableMapper.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-

/*  TableMapper.qm Copyright 2014 - 2016 Qore Technologies, sro

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

// this module requires Qore 0.8.12 or better

// require type definitions everywhere

// enable all warnings

// don't use "$" signs for variables and class members, assume local variable scope

// requires the Mapper module
// requires the SqlUtil module


namespace TableMapper {
class InboundTableMapper : public Mapper::Mapper {

public:
        public :
            const OptionKeys = Mapper::OptionKeys + (
                "unstable_input": sprintf("if this is set to True then a slower insert method will be used that verifies each input row; if False an optimized insert method is used (additionally bulk inserts are possible) but all input hashes must have the same keys in the same order; default: %y", OptionDefaults.unstable_input),
                "insert_block": sprintf("the row block size used when bulk DML / batch inserts are used; default: %y", OptionDefaults.insert_block),
                "rowcode": "a closure or call reference taking a single hash argument representing the row values inserted plus any output values generated in the insert (such as sequence values, for example)",
                );

            const OptionDefaults = (
                "unstable_input": False,
                "insert_block": 1000,
                );

public:

        private :
            SqlUtil::AbstractTable table;

            SqlUtil::AbstractDatabase db;

            bool has_returning;

            list ret_args = ();

            list out_args = ();

            bool unstable_input = False;

            SQLStatement stmt;

            int insert_block;

            hash hbuf;

            *code rowcode;

public:


        constructor(SqlUtil::Table target, hash mapv, *hash opts);



        constructor(SqlUtil::AbstractTable target, hash mapv, *hash opts);



        destructor();


          static hash getOutputRecord(*string mname, AbstractTable table, *hash output);

        private init(hash mapv, *hash opts);


        private mapFieldType(string key, hash m, reference v, hash rec);



        private checkMapField(string k, reference fh);



        hash validTypes();



        hash validKeys();



        hash optionKeys();



        hash insertRow(hash rec);



        setRowCode(*code rowc);



        *hash queueData(hash rec, *hash crec);



        *hash queueData(AbstractIterator iter, *hash crec);



        private *hash queueDataIntern(hash rec);



        *hash flush();



        discard();


        private hash flushIntern();


        *list getReturning();


        logOutput(hash h);


          deprecated hash insertRowNoCommit(hash rec);

        nothing commit();


        nothing rollback();


        string getTableName();


        SqlUtil::AbstractTable getTable();


        Qore::SQL::AbstractDatasource getDatasource();


        private error(string fmt);


        private error2(string ex, string fmt);

    };

class InboundIdentityTableMapper : public TableMapper::InboundTableMapper {

public:

        constructor(SqlUtil::Table target, hash mapv = {}, *hash opts) ;



        constructor(SqlUtil::AbstractTable target, hash mapv = {}, *hash opts) ;


        private init(hash mapv, *hash opts);


          static hash getStaticInputRecord(SqlUtil::AbstractTable table);
    };

class InboundTableMapperIterator : public Mapper::AbstractMapperIterator {

public:
        public :

public:

        private :
            TableMapper::InboundTableMapper mapc;

            int commit_limit;

            int cnt = 0;

            hash val;

public:


        constructor(Qore::AbstractIterator i, SqlUtil::Table target, hash mapv, *hash opts, int commit_limit = 0) ;



        constructor(Qore::AbstractIterator i, SqlUtil::AbstractTable target, hash mapv, *hash opts, int commit_limit = 0) ;



        constructor(Qore::AbstractIterator i, TableMapper::InboundTableMapper mapv, int commit_limit = 0) ;


        hash getValue();



        bool next();


        int commitLimit();


        nothing commit();


        nothing rollback();


        string getTableName();



        int getCount();



        resetCount();


        Qore::SQL::AbstractDatasource getDatasource();

    };


class SqlStatementMapperIterator : public Mapper::AbstractMapperIterator {

public:
        public :

public:

        private :
            Mapper::Mapper m_mapper;

public:


        constructor(SqlUtil::AbstractTable table, hash sh, hash mapv, *hash opts)
 ;



        constructor(SqlUtil::Table table, hash sh, hash mapv, *hash opts)
 ;



        constructor(Qore::SQL::SQLStatement stmt, hash mapv, *hash opts)
 ;


        private setup(hash mapv, *hash opts);


        hash getValue();



        int getCount();



        resetCount();


        bool hasBulk();



        list mapBulk(int size);

    }; // class SqlStatementMapperIterator

class AbstractSqlStatementOutboundMapper : public Mapper::Mapper {

public:
        public :
            const OptionKeys = Mapper::OptionKeys + (
                "table": "(required) the AbstractTable object for the source of the data",
                "sh": "(optional) an SqlUtil select hash",
                "select_block" : sprintf("the row block size used when bulk DML / batch inserts are used; default: %y", OptionDefaults.select_block),
                );

            const OptionDefaults = (
                "select_block": 1000,
                );

public:

        private :
            // internal SQLStatement
            SQLStatement m_stmt;
            // a select_block size. Taken from options
            int select_block;
            // original option hash
            *hash m_orig_opts;

public:


        constructor(hash mapv, *hash opts);



        hash optionKeys();


        commit();


        rollback();


        abstract Qore::SQL::AbstractDatasource getDatasource();

        abstract private initOptions(reference opts);

        abstract private initStatement();


        SqlStatementMapperIterator iterator();



        *hash getData();



        *list getDataRows();


    }; // AbstractSqlStatementOutboundMapper

class SqlStatementOutboundMapper : public AbstractSqlStatementOutboundMapper {

public:
        private :
            // the target table object
            SqlUtil::AbstractTable m_table;
            // SqlUtil select hash
            *hash m_sh;

public:


        constructor(SqlUtil::Table source, *hash sh, hash mapv, *hash opts)
 ;



        constructor(SqlUtil::AbstractTable source, *hash sh, hash mapv, *hash opts)
 ;



        string getTableName();



        SqlUtil::AbstractTable getTable();


        Qore::SQL::AbstractDatasource getDatasource();


          static *hash getStaticInputRecord(AbstractTable table, *hash select_hash, *reference sql);

        initStatement();


        private initOptions(reference opts);

    }; // SqlStatementOutboundMapper

class RawSqlStatementOutboundMapper : public AbstractSqlStatementOutboundMapper {

public:
        private :
            AbstractDatasource m_ds;
            string m_sql;
            *list m_sqlargs;

public:


        constructor(Qore::SQL::AbstractDatasource ds, string sql, *softlist sqlargs, hash mapv, *hash opts)
 ;


        Qore::SQL::AbstractDatasource getDatasource();


          static *hash getStaticInputRecord(Qore::SQL::AbstractDatasource ds, string sql, *softlist args);

        private initStatement();


        private initOptions(reference opts);

    }; // RawSqlStatementOutboundMapper
};