fwConfigurationDB_DBAccess.ctl File Reference


Database Access functions

These functions are used in context of database access

void fwConfigurationDB_openDBConnection (string dbConnectionName, dbConnection &dbCon, dyn_string &exceptionInfo)
void fwConfigurationDB_checkOpenDB (dyn_string &exceptionInfo)
void _fwConfigurationDB_executeDBQuery (string sql, dbConnection conn, dyn_dyn_mixed &aRecords, dyn_string &exceptionInfo, int numCol=999, bool columnWise=FALSE, dyn_int colTypes=0, dyn_mixed bindParams="")
void _fwConfigurationDB_executeDBBulkCmd (string sql, dbConnection conn, dyn_dyn_mixed data, dyn_string &exceptionInfo, bool columnWise=FALSE)
void _fwConfigurationDB_executeDBCmd (string sql, dbConnection conn, dyn_mixed params, dyn_string &exceptionInfo)
void _fwConfigurationDB_startCommand (string sql, dbConnection &connection, anytype &dbCmd, dyn_string &exceptionInfo)
void _fwConfigurationDB_finishCommand (anytype &dbCmd, dyn_string &exceptionInfo)
void _fwConfigurationDB_bindExecuteCommand (anytype &dbCmd, mapping params, dyn_string &exceptionInfo)
void fwConfigurationDB_executeSqlSimple (string sql, dbConnection connection, dyn_string &exceptionInfo)
void _fwConfigurationDB_executeSqlFromFile (dbConnection dbCon, string fileName, string whatItIs, dyn_string &exceptionInfo, bool breakOnDbError=TRUE)

Error Codes in DBAccess package

see also Error Codes overview module.

const int fwConfigurationDB_ERROR_DBNoConnection = -162

Functions

void fwConfigurationDB_dbConnect (string dbConnectionName, string connectString, string dbType, string dbName, string dbUser, string dbPassword, string schemaName, string schemaReadOnly, dbConnection &dbCon, dyn_string &exceptionInfo, bool errorIfOpenFails=TRUE)
void _fwConfigurationDB_getDBDriver (string dbType, string &driver, dyn_string &exceptionInfo)
void _fwConfigurationDB_checkSequenceSane (dbConnection conn, string seqName, string tblName, string colName, dyn_string &exceptionInfo)
void _fwConfigurationDB_getBatchOfSequenceNumbers (dbConnection conn, string seqName, int howMany, dyn_int &seq, dyn_string &exceptionInfo)
string _fwConfigurationDB_extractOraErrCode (string errTxt, string &oraMsg)
void fwConfigurationDB_callPlSqlApi (string functionName, dyn_mixed functionParams, string inputColumns, string outputColumns, dyn_dyn_mixed inputData, dyn_dyn_mixed &outputData, dyn_string &exceptionInfo, dyn_int outputColumnTypes=0, bool cleanupInputTable=TRUE)
void _fwConfigurationDB_DBSchemaSanityCheck (dyn_string &exceptionInfo)
float fwConfigurationDB_verifyDBSchema (dbConnection dbCon, dyn_string &exceptionInfo)
void _fwConfigurationDB_EnsureSequencesAreSane (dyn_string &exceptionInfo)

Variables

global string _fwConfigurationDB_fileVersion_fwConfigurationDB_DBAccess_ctl = "3.4.0"

Detailed Description

This package contains database access functions of the Configuration Database tool

Author:
Piotr Golonka (IT-CO/BE)
Date:
May 2009

Function Documentation

void fwConfigurationDB_dbConnect ( string  dbConnectionName,
string  connectString,
string  dbType,
string  dbName,
string  dbUser,
string  dbPassword,
string  schemaName,
string  schemaReadOnly,
dbConnection &  dbCon,
dyn_string &  exceptionInfo,
bool  errorIfOpenFails = TRUE 
)

void _fwConfigurationDB_getDBDriver ( string  dbType,
string &  driver,
dyn_string &  exceptionInfo 
)

void _fwConfigurationDB_checkSequenceSane ( dbConnection  conn,
string  seqName,
string  tblName,
string  colName,
dyn_string &  exceptionInfo 
)

void _fwConfigurationDB_getBatchOfSequenceNumbers ( dbConnection  conn,
string  seqName,
int  howMany,
dyn_int &  seq,
dyn_string &  exceptionInfo 
)

string _fwConfigurationDB_extractOraErrCode ( string  errTxt,
string &  oraMsg 
)

void fwConfigurationDB_callPlSqlApi ( string  functionName,
dyn_mixed  functionParams,
string  inputColumns,
string  outputColumns,
dyn_dyn_mixed  inputData,
dyn_dyn_mixed &  outputData,
dyn_string &  exceptionInfo,
dyn_int  outputColumnTypes = 0,
bool  cleanupInputTable = TRUE 
)

void _fwConfigurationDB_DBSchemaSanityCheck ( dyn_string &  exceptionInfo  ) 

Performs sanity checks of the database schema, signals errors, tries to recover as much as possible.

float fwConfigurationDB_verifyDBSchema ( dbConnection  dbCon,
dyn_string &  exceptionInfo 
)

Returns the version of the DB Schema

void _fwConfigurationDB_EnsureSequencesAreSane ( dyn_string &  exceptionInfo  ) 


Variable Documentation

global string _fwConfigurationDB_fileVersion_fwConfigurationDB_DBAccess_ctl = "3.4.0"

fwConfigurationDB_ERROR_DBNoConnection = -162

connection to database does not exist


Generated on Thu May 14 12:06:04 2009 for Configuration Database component by  doxygen 1.4.7