TableMapper.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  TableMapper.qm Copyright 2014 - 2023 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.
*/
 
// minimum Qore version
 
// 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:
            const OptionKeys = ...;
 
 
            const UserOptions = Mapper::UserOptions + {
                "unstable_input": <MapperOptionInfo>{
                    "type": "bool",
                    "desc": sprintf("if this is set to True then a slower insert/upsert method will be used that "
                        "verifies each input row; if False an optimized insert/upsert method is used (additionally "
                        "bulk inserts/upserts are possible) but all input hashes must have the same keys in the same "
                        "order; default: %y", OptionDefaults.unstable_input),
                },
                "insert_block": <MapperOptionInfo>{
                    "type": "int",
                    "desc": sprintf("the row block size used when bulk DML / batch inserts/upserts are used; "
                        "default: %y", OptionDefaults.insert_block),
                },
                "upsert": <MapperOptionInfo>{
                    "type": "bool",
                    "desc": "if True then data will be upserted instead of inserted",
                },
                "upsert_strategy": <MapperOptionInfo>{
                    "type": "string",
                    "desc": "the upsert strategy code to use; implies 'upsert'",
                },
            };
 
            const OptionDefaults = {
                "unstable_input": False,
                "insert_block": 1000,
            };
 
protected:
            SqlUtil::AbstractTable table;
 
            SqlUtil::AbstractDatabase db;
 
            bool has_returning;
 
            list ret_args = ();
 
            list out_args = ();
 
            bool unstable_input = False;
 
            Qore::SQL::AbstractSQLStatement stmt;
 
            int insert_block;
 
            hash hbuf;
            /* FIXME would be nice to have hbuf with hbuf_size in a class, but there are performance considerations.
            */
            *int hbuf_size;
 
            *code rowcode;
 
            bool upsert = False;
 
            *int upsert_strategy;
 
            *code upsert_code;
 
public:
 
 
        constructor(SqlUtil::Table target, hash<auto> mapv, *hash<auto> opts);
 
 
 
        constructor(SqlUtil::AbstractTable target, hash<auto> mapv, *hash<auto> opts);
 
 
 
        destructor();
 
 
          static *hash<string, AbstractDataField> getOutputRecord(string mapper_name, AbstractTable table, *hash<auto> opts, *hash<SqlUtilDataTypeOptionInfo> field_opts, *hash<auto> mapv);
 
protected:
         init(hash<auto> mapv, *hash<auto> opts);
public:
 
 
protected:
         auto mapFieldType(string key, hash<auto> mapping, AbstractDataProviderType type, auto value, hash<auto> rec);
public:
 
 
 
protected:
         checkMapField(string k, reference<auto> fh);
public:
 
 
 
        hash<string, bool> validKeys();
 
 
 
        hash<auto> optionKeys();
 
 
        hash<string, hash<MapperOptionInfo>> getUserOptions();
 
 
 
        hash<auto> insertRow(hash<auto> rec);
 
 
 
        setRowCode(*code rowc);
 
 
 
        *hash<auto> queueData(hash<auto> rec, *hash<auto> crec);
 
 
 
        *hash<auto> queueData(Qore::AbstractIterator iter, *hash<auto> crec);
 
 
 
        *hash<auto> queueData(list<auto> l, *hash<auto> crec);
 
 
 
protected:
         *hash<auto> queueDataIntern(hash<auto> rec);
public:
 
 
protected:
         hash record2Batch(hash h);
public:
 
 
protected:
         bool isMapperConstant();
public:
 
 
          static nothing addBatchToBatch(reference<hash<auto>> hb, hash<auto> batch);
 
 
          deprecated static nothing addBatchToBatch(reference<hash> hb, reference x1, hash batch, *reference x2);
 
 
        *hash<auto> flush();
 
 
 
        discard();
 
 
        // return nothing if nothing needs to be flushed
protected:
         *hash<auto> flushIntern(bool force_flush);
public:
 
 
        *list<hash<auto>> getReturning();
 
 
        logOutput(hash<auto> h);
 
 
 
        TableMapper::InboundTableMapperIterator iterator(Qore::AbstractIterator i);
 
 
          deprecated hash<auto> insertRowNoCommit(hash<auto> rec);
 
        nothing commit();
 
 
        nothing rollback();
 
 
        string getTableName();
 
 
        SqlUtil::AbstractTable getTable();
 
 
        Qore::SQL::AbstractDatasource getDatasource();
 
 
protected:
         error(string fmt);
public:
 
 
protected:
         error2(string ex, string fmt);
public:
 
    };
 
class InboundIdentityTableMapper : public TableMapper::InboundTableMapper {
 
public:
 
        constructor(SqlUtil::Table target, hash<auto> mapv = {}, *hash<auto> opts) ;
 
 
 
        constructor(SqlUtil::AbstractTable target, hash<auto> mapv = {}, *hash<auto> opts) ;
 
 
protected:
         init(hash<auto> mapv, *hash<auto> opts);
public:
 
 
protected:
         hash<string, AbstractDataField> getInputRecord(SqlUtil::AbstractTable table, *hash<auto> opts);
public:
 
    };
 
class InboundTableMapperIterator : public Mapper::AbstractMapperIterator {
 
public:
 
protected:
            TableMapper::InboundTableMapper mapc;
 
            int commit_limit;
 
            int cnt = 0;
 
            hash<auto> val;
 
public:
 
 
        constructor(Qore::AbstractIterator i, InboundTableMapper mapper) ;
 
 
 
        constructor(Qore::AbstractIterator i, SqlUtil::Table target, hash<auto> mapv, *hash<auto> opts, int commit_limit = 0) ;
 
 
 
        constructor(Qore::AbstractIterator i, SqlUtil::AbstractTable target, hash<auto> mapv, *hash<auto> opts, int commit_limit = 0) ;
 
 
 
        constructor(Qore::AbstractIterator i, TableMapper::InboundTableMapper mapv, int commit_limit) ;
 
 
        hash<auto> getValue();
 
 
 
        bool next();
 
 
        int commitLimit();
 
 
        nothing commit();
 
 
        nothing rollback();
 
 
        string getTableName();
 
 
 
        int getCount();
 
 
 
        resetCount();
 
 
        Qore::SQL::AbstractDatasource getDatasource();
 
 
 
        setRuntime(string key, auto value);
 
 
 
        setRuntime(hash<auto> runtime);
 
 
 
        replaceRuntime(*hash<auto> runtime);
 
 
 
        auto getRuntime(string key);
 
    };
 
 
class SqlStatementMapperIterator : public Mapper::AbstractMapperIterator {
 
public:
 
protected:
            Mapper::Mapper m_mapper;
 
public:
 
 
        constructor(TableMapper::AbstractSqlStatementOutboundMapper mapper)
 ;
 
 
 
        constructor(SqlUtil::AbstractTable table, hash<auto> sh, hash<auto> mapv, *hash<auto> opts)
 ;
 
 
 
        constructor(SqlUtil::Table table, hash<auto> sh, hash<auto> mapv, *hash<auto> opts)
 ;
 
 
 
        constructor(Qore::SQL::AbstractSQLStatement stmt, hash<auto> mapv, *hash<auto> opts)
 ;
 
 
protected:
         setup(hash<auto> mapv, *hash<auto> opts);
public:
 
 
        hash<auto> getValue();
 
 
 
        int getCount();
 
 
 
        resetCount();
 
 
        bool hasBulk();
 
 
 
        list<auto> mapBulk(int size);
 
 
 
        setRuntime(string key, auto value);
 
 
 
        setRuntime(hash<auto> runtime);
 
 
 
        replaceRuntime(*hash<auto> runtime);
 
 
 
        auto getRuntime(string key);
 
    }; // class SqlStatementMapperIterator
 
class AbstractSqlStatementOutboundMapper : public Mapper::Mapper {
 
public:
            const OptionKeys = ...;
 
 
            const OptionDefaults = {
                "select_block": 1000,
            };
 
protected:
            // internal SQLStatement
            AbstractSQLStatement m_stmt;
            // a select_block size. Taken from options
            int select_block;
            // original option hash
            *hash<auto> m_orig_opts;
 
public:
 
 
        constructor(hash<auto> mapv, *hash<auto> opts);
 
 
 
        hash<auto> optionKeys();
 
 
        hash<string, hash<MapperOptionInfo>> getUserOptions();
 
 
        commit();
 
 
        rollback();
 
 
        abstract Qore::SQL::AbstractDatasource getDatasource();
 
protected:
        abstract  initOptions(reference<hash> opts);
public:
 
protected:
        abstract  initStatement();
public:
 
 
        Qore::SQL::SQLStatement getRowIterator();
 
 
 
        Qore::SQL::AbstractSQLStatement getStatement();
 
 
 
        SqlStatementMapperIterator iterator();
 
 
 
        *hash<string, auto> getData();
 
 
 
        *list<auto> getDataRows();
 
 
protected:
          static *hash<string, AbstractDataField> getInputRecordFromStmt(AbstractSQLStatement stmt, *hash<auto> input);
public:
 
    }; // AbstractSqlStatementOutboundMapper
 
class SqlStatementOutboundMapper : public AbstractSqlStatementOutboundMapper {
 
public:
protected:
            // the target table object
            SqlUtil::AbstractTable m_table;
            // SqlUtil select hash
            *hash m_sh;
 
            const OptionKeys = ...;
 
 
            const UserOptions = {
                "sh": <MapperOptionInfo>{
                    "type": "hash",
                    "desc": "(optional) an SqlUtil select hash",
                },
            };
 
public:
 
 
        constructor(SqlUtil::Table source, *hash<auto> sh, hash<auto> mapv, *hash<auto> opts)
 ;
 
 
 
        constructor(SqlUtil::AbstractTable source, *hash<auto> sh, hash<auto> mapv, *hash<auto> opts)
 ;
 
 
 
        string getTableName();
 
 
 
        SqlUtil::AbstractTable getTable();
 
 
        Qore::SQL::AbstractDatasource getDatasource();
 
 
        initStatement();
 
 
 
        hash<auto> optionKeys();
 
 
        hash<string, hash<MapperOptionInfo>> getUserOptions();
 
 
protected:
         initOptions(reference<hash<auto>> opts);
public:
 
 
          static *hash<string, AbstractDataField> getStaticInputRecord(AbstractTable table, *hash<auto> select_hash, *reference<string> sql, *hash<auto> input);
    }; // SqlStatementOutboundMapper
 
class RawSqlStatementOutboundMapper : public AbstractSqlStatementOutboundMapper {
 
public:
protected:
            AbstractDatasource m_ds;
            string m_sql;
            *list m_sqlargs;
 
            const OptionKeys = ...;
 
 
            const UserOptions = {
                "select": <MapperOptionInfo>{
                    "type": "string",
                    "desc": "the SQL statement to use",
                },
                "bind": <MapperOptionInfo>{
                    "type": "list",
                    "desc": "(internal) a list of runtime bind values",
                },
            };
 
public:
 
 
        constructor(Qore::SQL::AbstractDatasource ds, string sql, *softlist<auto> sqlargs, hash<auto> mapv, *hash<auto> opts)
 ;
 
 
        Qore::SQL::AbstractDatasource getDatasource();
 
 
 
        hash<auto> optionKeys();
 
 
        hash<string, hash<MapperOptionInfo>> getUserOptions();
 
 
protected:
         initStatement();
public:
 
 
protected:
         initOptions(reference<hash<auto>> opts);
public:
 
 
          static *hash<string, AbstractDataField> getStaticInputRecord(Qore::SQL::AbstractDatasource ds, string sql, *softlist<auto> args, *hash<auto> input);
    }; // RawSqlStatementOutboundMapper
};