BulkSqlUtil.qm.dox.h

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

/*  BulkSqlUtil.qm Copyright 2015 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.
*/

// minimum required Qore version

// require type definitions everywhere

// enable all warnings

// assume local scope for variables, do not use "$" signs

// use SqlUtil


/*  Version History
    * 2015-08-02 v1.0: David Nichols <david@qore.org>
      + the initial version of the BulkSqlUtil module
*/

namespace BulkSqlUtil {

    class AbstractBulkOperation {

public:
        public :
            const OptionKeys = (
                "block_size": sprintf("the row block size used for bulk DML / batch operations; default: %y", OptionDefaults.block_size),
                "info_log": "a call reference / closure for informational logging",
                );

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

public:

        private :
            SqlUtil::AbstractTable table;

            softint block_size;

            hash hbuf;

            hash cval;

            *code info_log;

            int row_count = 0;

            string opname;

            list ret_args = ();

public:


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



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



        destructor();


        private init(*hash opts);



        queueData(hash data);



        queueData(list l);


        private setupInitialRowColumns(hash row);


        private setupInitialRow(hash row);



        flush();


        private flushIntern();



        discard();


        nothing commit();


        nothing rollback();


        string getTableName();


        SqlUtil::AbstractTable getTable();


        Qore::SQL::AbstractDatasource getDatasource();


        int getRowCount();


        abstract private flushImpl();
    };


class BulkInsertOperation : public BulkSqlUtil::AbstractBulkOperation {

public:
        private :
            SQLStatement stmt;

            *code rowcode;

            hash static_ret_expr;

public:


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



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



        setRowCode(*code rowc);


        private init(*hash opts);


        private setupInitialRowColumns(hash row);


        private setupInitialRow(hash row);


        private setupStaticRowValues(reference row);



        private flushImpl();

    };


class BulkUpsertOperation : public BulkSqlUtil::AbstractBulkOperation {

public:
        private :
            // upsert strategy to use
            int upsert_strategy;
            // upsert closure
            code upsert;

public:


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



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


        private init(*hash opts);


        private flushImpl();

    };
};