Database Access Functions


Database Access functions

These functions are used in context of database access

void fwConfigurationDB_openDBConnection (string dbConnectionName, dbConnection &dbCon, dyn_string &exceptionInfo)
void _fwConfigurationDB_executeSqlFromFile (dbConnection dbCon, string fileName, string whatItIs, dyn_string &exceptionInfo, bool breakOnDbError=TRUE)
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)

Function Documentation

void fwConfigurationDB_openDBConnection ( string  dbConnectionName,
dbConnection &  dbCon,
dyn_string &  exceptionInfo 
)

opens connection to the database

Parameters:
exceptionInfo standard exception handling variable
Returned error codes:

void _fwConfigurationDB_executeSqlFromFile ( dbConnection  dbCon,
string  fileName,
string  whatItIs,
dyn_string &  exceptionInfo,
bool  breakOnDbError = TRUE 
)

executes SQL statements stored in a file

Note that the all commands in the file should be terminated by the semicolon (;) character, which should be the last characted in the line. The comments (lines starting with "-" character) and white-spaces are a also automatically removed.

Parameters:
dbCon database connection descriptor
filename the name of the file, where the SQL statements are stored. The file needs to be in the "config" directory of the project.
whatItIs a short text describing the context in which the statements are executed. Used only for printouts.
exceptionInfo standard exception handling variable
breakOnDbError (optional, default is TRUE) determines if the function should return terminate with an exception upon first encountered error, or it should rather try to finish the remaining commands (the errors encountered in a meantime will be reported at the end).

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 
)


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