dbExec.h

Go to the documentation of this file.

 
// Copyright (c) 2013-2015 OpenM++
// This code is licensed under the MIT license (see LICENSE.txt for details)
 
#ifndef DB_EXEC_H
#define DB_EXEC_H
 
#include <mutex>
using namespace std;
 
#include "libopenm/omLog.h"
#include "libopenm/db/dbCommon.h"
 
namespace openm
{
    class IDbExec
    {
    public:
        virtual ~IDbExec(void) noexcept = 0;
 
        static IDbExec * create(const string & i_sqlProvider, const string & i_connectionStr);
 
        virtual string provider(void) const = 0;
 
        virtual int selectToInt(const string & i_sql, int i_default) = 0;
 
        virtual long long selectToLong(const string & i_sql, long long i_default) = 0;
 
        virtual string selectToStr(const string & i_sql) = 0;
 
        virtual bool selectToBool(const string & i_sql) = 0;
 
        virtual double selectToDouble(const string & i_sql, double i_default) = 0;
 
        virtual vector<string> selectRowStr(const string & i_sql) = 0;
 
        virtual IRowBaseVec selectRowVector(const string & i_sql, const IRowAdapter & i_adapter) = 0;
 
        virtual IRowBaseList selectRowList(const string & i_sql, const IRowAdapter & i_adapter) = 0;
 
        virtual void selectToRowProcessor(const string & i_sql, const IRowAdapter & i_adapter, IRowProcessor & i_processor) = 0;
 
        virtual size_t selectColumn(
            const string & i_sql, int i_column, const type_info & i_type, size_t i_size, void * io_valueArr
        ) = 0;
 
        virtual size_t update(const string & i_sql) = 0;
 
        virtual void beginTransaction(void) = 0;
 
        virtual unique_lock<recursive_mutex> beginTransactionThreaded(void) = 0;
 
        virtual void commit(void) = 0;
 
        virtual void rollback(void) = 0;
 
        virtual bool isTransaction(void) = 0;
 
        virtual void createStatement(const string & i_sql, int i_paramCount, const type_info ** i_typeArr) = 0;
 
        virtual void releaseStatement(void) noexcept = 0;
 
        virtual void executeStatement(int i_paramCount, const DbValue * i_valueArr) = 0;
 
        static list<string> parseListOfProviderNames(const string & i_sqlProviderNames);
 
        static bool isValidProviderName(const char * i_sqlProvider);
 
        static bool isSqlKeyword(const char * i_keyword, size_t i_length = 0);
 
        static const int maxDbTableNameSize = 63;
 
        static const string makeDbNamePrefix(int i_id, const string & i_src);
 
        static const string makeDbNameSuffix(int i_id, const string & i_src, const string i_digest);
 
        static string bigIntTypeName(const string & i_sqlProvider);
 
        static string floatTypeName(const string & i_sqlProvider);
 
        static string textTypeName(const string & i_sqlProvider, int i_size);
 
        static string valueDbType(const string & i_sqlProvider, const string & i_typeName, int i_typeId);
 
        static string makeSqlBeginTransaction(const string & i_sqlProvider);
 
        static string makeSqlCommitTransaction(const string & i_sqlProvider);
 
        static string makeSqlCreateTableIfNotExist(
            const string & i_sqlProvider, const string & i_tableName, const string & i_tableBodySql
        );
 
        static string makeSqlCreateViewReplace(
            const string & i_sqlProvider, const string & i_viewName, const string & i_viewBodySql
        );
 
        virtual void runSqlScript(const string & i_sqlScript) = 0;
 
     private:
        // if max size of db table name is too short then use crc32(md5) digest
        // table name is: paramNameAsPrefix + _p + md5Suffix, for example: ageSex_p12345678
        // prefix based on parameter name or output table name
        // suffix is 32 chars of md5 or 8 chars of crc32
        // there is extra 2 chars: _p, _w, _v, _a in table name between prefix and suffix
        //
        // 2016-08-17: always use short crc32 name suffix
        // isCrc32Name = minSize < 50;
 
         static const bool isCrc32Name = true;                                      // if true then use crc32 as db table name suffix
         static const int dbSuffixSize = isCrc32Name ? 8 : 32;                      // db table suffix name size
         static const int dbPrefixSize = maxDbTableNameSize - (2 + dbSuffixSize);   // db table prefix name size
    };
}
 
#endif  // DB_EXEC_H