unLHCLoggingDB 9.3.0
unLHCLoggingDBSql.ctl File Reference

Library containing database related functions of the unLHCLoggingDB component. More...

Functions

bool unLHCLoggingDBSql_openDbConnection (string sDbName, string sDbUser, string sDbPass, bool printDebug=true)
 
bool unLHCLoggingDBSql_startCommand (dbCommand &cmd, string &sql)
 
bool unLHCLoggingDBSql_executeCommand (dbCommand &cmd, mapping &map, dyn_dyn_mixed &result, bool columnWise=false)
 
bool unLHCLoggingDBSql_finishCommand (dbCommand &cmd)
 
dyn_dyn_mixed unLHCLoggingDBSql_queryDataWithParameterMapping (string sqlQuery, mapping params, dyn_string &dsExInfo, bool columnWise=false, bool blocking=true)
 
dyn_dyn_mixed unLHCLoggingDBSql_queryData (string sqlQuery, dyn_string &dsExInfo, bool columnWise=false, bool blocking=true)
 
void unLHCLoggingDBSql_executeWithBoundData (string sql, dyn_dyn_mixed &data)
 
void unLHCLoggingDBSql_executeWithParameterMapping (string sql, mapping params)
 
void unLHCLoggingDBSql_execute (string sql)
 
void unLHCLoggingDBSql_beginTransaction ()
 
void unLHCLoggingDBSql_commitTransaction ()
 
void unLHCLoggingDBSql_rollbackTransaction ()
 
dyn_string unLHCLoggingDBSql_getDbSchemas (dyn_string &dsExInfo)
 
dyn_string unLHCLoggingDBSql_getRdbSource (string sDbSchema, dyn_string &dsExInfo)
 
dyn_dyn_mixed unLHCLoggingDBSql_getLogVarInfo (string sDbSchema, dyn_string &dsExInfo, bool bUTC=false, bool bGetHierarchies=true)
 
dyn_dyn_mixed unLHCLoggingDBSql_getLogVariables (string sDbSchema, dyn_string &dsExInfo)
 
unsigned unLHCLoggingDBSql_getNumberOfLogVariables (string sDbSchema, dyn_string &dsExInfo)
 
unsigned unLHCLoggingDBSql_getNumberOfHierarchies (string sDbSchema, dyn_string &dsExInfo)
 
dyn_dyn_mixed unLHCLoggingDBSql_getElementDetails (string sVariableId, dyn_string &dsExInfo)
 
string unLHCLoggingDBSql_getElementNameFromVariableName (string sVariableName, dyn_string &dsExInfo)
 
dyn_dyn_mixed unLHCLoggingDBSql_getTransferHistory (string sVariableId, time tStart, time tEnd, bool bUTC=false, dyn_string &dsExInfo)
 
dyn_dyn_mixed unLHCLoggingDBSql_getElementHistory (string sVariableId, time tStart, time tEnd, bool bUTC=false, dyn_string &dsExInfo)
 
dyn_string unLHCLoggingDBSql_getMetaUsers (dyn_string &dsExInfo)
 
dyn_string unLHCLoggingDBSql_getMetaUsersForSchema (string sSchemaName, dyn_string &dsExInfo)
 
bool unLHCLoggingDBSql_checkUserPass (string sUser, string sPass)
 
void unLHCLoggingDBSql_getSystemIntegrityCredentials (string &sUser, string &sPass, dyn_string &dsExInfo)
 
bool unLHCLoggingDBSql_createDataCategory (string sName, string sSubName, string sTransferGroupId)
 
bool unLHCLoggingDBSql_updateTransferGroupId (string sDataCatName, string sDataCatSubName, string sTransferGroupId)
 
dyn_dyn_mixed unLHCLoggingDBSql_getDataCategories (dyn_string &dsExInfo)
 
dyn_dyn_mixed unLHCLoggingDBSql_getDataCategoriesForSpecific (string sSchema, string sUser, dyn_string &dsExInfo)
 
dyn_dyn_mixed unLHCLoggingDBSql_getDataCategoryMapping (dyn_string &dsExInfo)
 
void unLHCLoggingDBSql_addDataCategoryMapping (string sUser, string sSchema, string sDataCategory, dyn_string &dsExInfo)
 
void unLHCLoggingDBSql_updateDataCategoryMapping (string sNewUser, string sNewSchema, string sNewDataCategory, string sOldUser, string sOldSchema, string sOldDataCategory, dyn_string &dsExInfo)
 
void unLHCLoggingDBSql_deleteDataCategoryMapping (string sUser, string sSchema, string sDataCategory, dyn_string &dsExInfo)
 
bool unLHCLoggingDBSql_registerDataForLogging (const dyn_string &dsElementId, const dyn_string &dsVariableName, const dyn_string &dsRDBSource, const dyn_string &dsUnit, const dyn_string &dsDescription, const dyn_string &dsDataCategoryId, const dyn_string &dsHierarchy, const string sUser, const string sPass)
 
time unLHCLoggingDBSql_getDbSysTime (dyn_string &dsExInfo)
 
dyn_dyn_mixed unLHCLoggingDBSql_getTransferHistoryForTestDpe (string sVarName, dyn_string &dsExInfo)
 
dyn_dyn_mixed unLHCLoggingDBSql_getTransferStats (string job, time tStart, time tEnd, bool bUTC, dyn_string &exceptionInfo)
 
dyn_dyn_mixed unLHCLoggingDBSql_getTransferStatsForDataCategory (string dataCategoryId, time tStart, time tEnd, bool bUTC, dyn_string &exceptionInfo)
 
dyn_dyn_mixed unLHCLoggingDBSql_getTransferJobIds (dyn_string &dsExInfo)
 
dyn_dyn_mixed unLHCLoggingDBSql_getTransferJobDetails (string sRdbSource, bool bUTC, dyn_string &dsExInfo)
 
dyn_dyn_mixed unLHCLoggingDBSql_getTransferJobStatus (string sRdbSource, dyn_string &dsExInfo)
 
dyn_dyn_mixed unLHCLoggingDBSql_getSessionInfo (const string sJobNumber, dyn_string &dsExInfo, bool bUTC=false)
 
dyn_dyn_mixed unLHCLoggingDBSql_getDataCategoriesOfSchema (string sDbSchema, dyn_string &dsExInfo)
 
string unLHCLoggingDBSql_getDataCategoryId (string sDataCategory, dyn_string &dsExInfo)
 
bool unLHCLoggingDBSql_unregisterVariablesFromLogging (const dyn_string &dsSignalNames)
 
bool unLHCLoggingDBSql_renameVariables (const dyn_string &dsSignalNameOld, const dyn_string &dsSignalNameNew, const dyn_string &dsDescriptionNew, const dyn_string &dsUnitNew)
 
void unLHCLoggingDBSql_renameVariablesImpl (const dyn_string &dsSignalNameOld, const dyn_string &dsSignalNameNew, const dyn_string &dsDescriptionNew, const dyn_string &dsUnitNew)
 
bool unLHCLoggingDBSql_deleteHierarchies (const dyn_string &dsSignalNames)
 
dyn_dyn_mixed unLHCLoggingDBSql_getInconsistentData (const string sDbSchema, dyn_string &dsExInfo)
 
unsigned unLHCLoggingDBSql_getNumSignalsHavingInconsistentArchiveGroup (const string sDbSchema, dyn_string &dsExInfo)
 
dyn_dyn_mixed unLHCLoggingDBSql_getElements (const string sDbSchema, dyn_string &dsExInfo)
 
dyn_dyn_mixed unLHCLoggingDBSql_getElementsExceptInternalDPs (const string sDbSchema, dyn_string &dsExInfo)
 
dyn_string unLHCLoggingDBSql_getSystemsUsingSchema (const string sDbSchema, dyn_string &dsExInfo)
 
bool unLHCLoggingDBSql_triggerRetransferForRdbSource (string sRdbSource, time tStart)
 
dyn_string unLHCLoggingDBSql_getAllRdbSources (dyn_string &dsExInfo)
 

Variables

const string c_unLHCLoggingDBSql_LibVersion = "1.2.0"
 Version of this library.
 
global dbConnection g_unLHCLoggingDBSql_dbConnection
 Database connection.
 
int g_unLHCLoggingDBSql_queryTimeoutCheckInterval = 250
 Magic numbers.
 

Detailed Description

Library containing database related functions of the unLHCLoggingDB component.

Date
04/09/2014
Author
Josef Hofer

Usage: Public

PVSS manager usage: CTRL, UI

Constraints:

  • PVSS Version: 3.11
  • Operating System: Linux

Function Documentation

◆ unLHCLoggingDBSql_openDbConnection()

bool unLHCLoggingDBSql_openDbConnection ( string  sDbName,
string  sDbUser,
string  sDbPass,
bool  printDebug = true 
)

Connect to db, if the connectionName exists, then use the existing. If connexction fails return FALSE.

Parameters
sDbNameinput, database name
sDbUserinput, database user
sDbPassinput, database password (encrypted)
Returns
output, true: success, false: error

◆ unLHCLoggingDBSql_startCommand()

bool unLHCLoggingDBSql_startCommand ( dbCommand &  cmd,
string &  sql 
)

Start execution of a db command

Parameters
cmdinput, command
sqlinput, sql query text
Returns
true:success, false:error

◆ unLHCLoggingDBSql_executeCommand()

bool unLHCLoggingDBSql_executeCommand ( dbCommand &  cmd,
mapping &  map,
dyn_dyn_mixed &  result,
bool  columnWise = false 
)

Execute a db command with paramter mapping and get result

Parameters
cmdinput, command
mapinput, parameter mapping
resultoutput, result as dyn_dyn_mixed
Returns
true:success, false:error

◆ unLHCLoggingDBSql_finishCommand()

bool unLHCLoggingDBSql_finishCommand ( dbCommand &  cmd)

Finish execution of a db command

Parameters
cmdinput, command
sqlinput, sql query text
Returns
true:success, false:error

◆ unLHCLoggingDBSql_queryDataWithParameterMapping()

dyn_dyn_mixed unLHCLoggingDBSql_queryDataWithParameterMapping ( string  sqlQuery,
mapping  params,
dyn_string &  dsExInfo,
bool  columnWise = false,
bool  blocking = true 
)

Execute sql query with parameter mapping

Parameters
sqlQueryinput, SQL query string
paramsinput, parameter mapping
dsExInfooutput, Exception information
columnWiseinput, false: get result row wise, true: get result column wise
blockinginput, execute blocking queries on default, but we can also switch to asynchronous mode
Returns
data output, result of the query

◆ unLHCLoggingDBSql_queryData()

dyn_dyn_mixed unLHCLoggingDBSql_queryData ( string  sqlQuery,
dyn_string &  dsExInfo,
bool  columnWise = false,
bool  blocking = true 
)

Execute sql query

Parameters
sqlQueryinput, SQL query string
dsExInfooutput, Exception information
columnWiseinput, false: get result row wise, true: get result column wise
Returns
data output, result of the query

◆ unLHCLoggingDBSql_executeWithBoundData()

void unLHCLoggingDBSql_executeWithBoundData ( string  sql,
dyn_dyn_mixed &  data 
)

Execute sql command with bound data

Using this function we will gain speed by sending a sql command just once (e.g. an insert into statement) but executing it many times with different input data (provided through the dyn_dyn_mixed input-parameter) unLHCLoggingDBSql_executeWithBoundData("INSERT INTO myTable(colId,colName,colUnit) VALUES(:data1,:data2,:data3)");

Parameters
sqlinput, SQL command string
datainput, data to be inserted
Exceptions
throwsan exception on error

◆ unLHCLoggingDBSql_executeWithParameterMapping()

void unLHCLoggingDBSql_executeWithParameterMapping ( string  sql,
mapping  params 
)

Execute sql command with parameter mapping

Parameters
sqlinput, SQL command string
paramsinput, Parameter mapping like: param["user"]=sUserName;
Exceptions
throwsan exception on error

◆ unLHCLoggingDBSql_execute()

void unLHCLoggingDBSql_execute ( string  sql)

Execute sql command

Parameters
sqlinput, SQL command string
Exceptions
throwsan exception on error

◆ unLHCLoggingDBSql_beginTransaction()

void unLHCLoggingDBSql_beginTransaction ( )

start a transaction

Exceptions
throwsan exception on error

◆ unLHCLoggingDBSql_commitTransaction()

void unLHCLoggingDBSql_commitTransaction ( )

commit a transaction

Exceptions
throwsan exception on error

◆ unLHCLoggingDBSql_rollbackTransaction()

void unLHCLoggingDBSql_rollbackTransaction ( )

rollback a transaction

◆ unLHCLoggingDBSql_getDbSchemas()

dyn_string unLHCLoggingDBSql_getDbSchemas ( dyn_string &  dsExInfo)

Get all DB schemas, which have an ELEMENTS table

Parameters
dsExInfooutput: Exception info
Returns
dsDbSchemas output: List of DB schemas

◆ unLHCLoggingDBSql_getRdbSource()

dyn_string unLHCLoggingDBSql_getRdbSource ( string  sDbSchema,
dyn_string &  dsExInfo 
)

Get all RDB Sources of a specific DB schema

Parameters
sDbSchemainput, Database schema
dsExInfooutput: Exception info
Returns
sqlResult output, list of distinct rdb sources

◆ unLHCLoggingDBSql_getLogVarInfo()

dyn_dyn_mixed unLHCLoggingDBSql_getLogVarInfo ( string  sDbSchema,
dyn_string &  dsExInfo,
bool  bUTC = false,
bool  bGetHierarchies = true 
)

Get all variables of a specified db schema that are registered for logging and retrieve detail informations

Parameters
sDbSchemainput, Database schema
bUTCinput, true=show timestamps as UTC, false=show timestamps as localtime
dsExInfooutput: Exception info
Returns
sqlResult output, Query result (column wise)

line 1: Variable ID line 2: Variable Name line 3: Dpe NAME line 4: Dpe ALIAS line 5: Data category line 6: User name line 7: Logging required line 8: Registered for logging line 9: Rdb source line 10: Hierarchy line 11: Transfer job ID line 12: Timestamp last job run line 13: Timestamp last logged line 14: No records last logged line 15: description

◆ unLHCLoggingDBSql_getLogVariables()

dyn_dyn_mixed unLHCLoggingDBSql_getLogVariables ( string  sDbSchema,
dyn_string &  dsExInfo 
)

Get all variables of a specified db schema that are registered for logging

Parameters
sDbSchemainput, Database schema
dsExInfooutput: Exception info
Returns
sqlResult output, Query result (column wise)

line 1: Variable Name line 2: Element Name line 3: Variable Description line 4: Hierarchy Path line 5: Data category

◆ unLHCLoggingDBSql_getNumberOfLogVariables()

unsigned unLHCLoggingDBSql_getNumberOfLogVariables ( string  sDbSchema,
dyn_string &  dsExInfo 
)

Get number of registered elements for a specific database schema

Parameters
sDbSchemainput, Database schema
dsExInfooutput Exception info
Returns
sqlResult output, No of elements

◆ unLHCLoggingDBSql_getNumberOfHierarchies()

unsigned unLHCLoggingDBSql_getNumberOfHierarchies ( string  sDbSchema,
dyn_string &  dsExInfo 
)

Get number of registered hierarchies for a specific database schema

Parameters
sDbSchemainput, Database schema
dsExInfooutput Exception info
Returns
sqlResult output, No of elements

◆ unLHCLoggingDBSql_getElementDetails()

dyn_dyn_mixed unLHCLoggingDBSql_getElementDetails ( string  sVariableId,
dyn_string &  dsExInfo 
)

Get details of a particular element

Use this function only to query single elements because it is not very fast, which is caused by the prequery of the dbSchema name

Parameters
sVariableIdinput, Variable ID of the selected element
dsExInfooutput, ExceptionInfo
Returns
sqlResult output, Result of the query (row wise)

column 1: Variable name column 2: Datapoint name column 3: Data category column 4: User name column 5: Logging requred column 6: Registered for logging column 7: Rdb source column 8: Hierarchy

◆ unLHCLoggingDBSql_getElementNameFromVariableName()

string unLHCLoggingDBSql_getElementNameFromVariableName ( string  sVariableName,
dyn_string &  dsExInfo 
)

Get the full dpe name from a signal name

Use this function only to query single elements because it is not very fast, which is caused by the prequery of the dbSchema name

Parameters
sVariableNameinput, Variable Name of the selected element
dsExInfooutput, ExceptionInfo
Returns
full dpe name as a string

◆ unLHCLoggingDBSql_getTransferHistory()

dyn_dyn_mixed unLHCLoggingDBSql_getTransferHistory ( string  sVariableId,
time  tStart,
time  tEnd,
bool  bUTC = false,
dyn_string &  dsExInfo 
)

Get the transfer history of a specific element (MDB -> LDB)

Parameters
sVariableIdinput, Variable ID of the selected element
tStartinput, Query start time (UTC only)
tEndinput, Query end time (UTC only)
bUTCinput, Display timestamps of query result in UTC or LOCAL
dsExInfooutput, ExceptionInfo
Returns
sqlResult output, Result of the query (column wise)

line 1: Time created line 2: Time first checked line 3: Time last checked line 4: No of records checked line 5: Time last logged line 6: No of records logged

◆ unLHCLoggingDBSql_getElementHistory()

dyn_dyn_mixed unLHCLoggingDBSql_getElementHistory ( string  sVariableId,
time  tStart,
time  tEnd,
bool  bUTC = false,
dyn_string &  dsExInfo 
)

Get value history of a specific meta variable

Parameters
sVariableIdinput, VARIABLE_ID of the selected element
tStartinput, Query start time (UTC only)
tEndinput, Query end time (UTC only)
bUTCinput, Display timestamps of query result in UTC or LOCAL
dsExInfooutput, ExceptionInfo
Returns
sqlResult output, Result of the query (column wise)

line 1: Time archived to MDB line 2: Value

◆ unLHCLoggingDBSql_getMetaUsers()

dyn_string unLHCLoggingDBSql_getMetaUsers ( dyn_string &  dsExInfo)

Get meta users from RDB2NXCALS.META_USERS

Parameters
dsExInfooutput, Exception information
Returns
list of user names

◆ unLHCLoggingDBSql_getMetaUsersForSchema()

dyn_string unLHCLoggingDBSql_getMetaUsersForSchema ( string  sSchemaName,
dyn_string &  dsExInfo 
)

Get meta users from RDB2NXCALS.META_USERS for a specific db schema

Parameters
dsExInfooutput, Exception information
Returns
list of user names

◆ unLHCLoggingDBSql_checkUserPass()

bool unLHCLoggingDBSql_checkUserPass ( string  sUser,
string  sPass 
)

Check if user pass combination is found in the database

Parameters
sUseroutput, username
sPassoutput, password
Returns
output, true: success, false: error

◆ unLHCLoggingDBSql_getSystemIntegrityCredentials()

void unLHCLoggingDBSql_getSystemIntegrityCredentials ( string &  sUser,
string &  sPass,
dyn_string &  dsExInfo 
)

Get credentials for user SystemIntegrity

Parameters
sUseroutput, username
sPassoutput, password
dsExInfooutput, Exception information

◆ unLHCLoggingDBSql_createDataCategory()

bool unLHCLoggingDBSql_createDataCategory ( string  sName,
string  sSubName,
string  sTransferGroupId 
)

Create a new data category

Parameters
sNameinput, data category name
sSubNameinput, data category sub name
sTransferGroupIdinput, transfer group id
Returns
output, true: sucess, false:error

◆ unLHCLoggingDBSql_updateTransferGroupId()

bool unLHCLoggingDBSql_updateTransferGroupId ( string  sDataCatName,
string  sDataCatSubName,
string  sTransferGroupId 
)

Update transfer group of an existing data category

Parameters
sDataCatNameinput, data category name
sDataCatSubNameinput, data category sub name
sTransferGroupIdinput, transfer group id
Returns
output, true: sucess, false:error

◆ unLHCLoggingDBSql_getDataCategories()

dyn_dyn_mixed unLHCLoggingDBSql_getDataCategories ( dyn_string &  dsExInfo)

Get data categories from RDB2NXCALS.META_VARIABLE_CATEGORIES

Parameters
dsExInfooutput, Exception information
Returns
sqlResult output, data categories

line 1: data category id line 2: data category name line 3: data category sub name line 4: data category name / data category sub name line 5: data transfer group id

◆ unLHCLoggingDBSql_getDataCategoriesForSpecific()

dyn_dyn_mixed unLHCLoggingDBSql_getDataCategoriesForSpecific ( string  sSchema,
string  sUser,
dyn_string &  dsExInfo 
)

Get available data categories for Specific Schema and User

Parameters
sSchemainput, schema name
sUserinput, user name
dsExInfooutput, Exception information
Returns
sqlResult output, data categories

line 1: data category id line 2: data category name line 3: data category sub name line 4: data category name / data category sub name line 5: data transfer group id

◆ unLHCLoggingDBSql_getDataCategoryMapping()

dyn_dyn_mixed unLHCLoggingDBSql_getDataCategoryMapping ( dyn_string &  dsExInfo)

Get mapping between data category, schema and user

Parameters
dsExInfooutput, Exception information
Returns
sqlResult output, data cagegory mapping (column wise)

column 1: data category name/subname column 2: schema name column 3: user name

◆ unLHCLoggingDBSql_addDataCategoryMapping()

void unLHCLoggingDBSql_addDataCategoryMapping ( string  sUser,
string  sSchema,
string  sDataCategory,
dyn_string &  dsExInfo 
)

Add mapping between data category, schema and user

Parameters
sUserinput, user name
sSchemainput, schema name
sDataCategoryinput, data categrory id as string
dsExInfooutput, Exception information

◆ unLHCLoggingDBSql_updateDataCategoryMapping()

void unLHCLoggingDBSql_updateDataCategoryMapping ( string  sNewUser,
string  sNewSchema,
string  sNewDataCategory,
string  sOldUser,
string  sOldSchema,
string  sOldDataCategory,
dyn_string &  dsExInfo 
)

Update mapping between data category, schema and user

Parameters
sNewUserinput, user name
sNewSchemainput, schema name
sNewDataCategoryinput, data categrory id as string
sOldUserinput, user name
sOldSchemainput, schema name
sOldDataCategoryinput, data categrory id as string
dsExInfooutput, Exception information

◆ unLHCLoggingDBSql_deleteDataCategoryMapping()

void unLHCLoggingDBSql_deleteDataCategoryMapping ( string  sUser,
string  sSchema,
string  sDataCategory,
dyn_string &  dsExInfo 
)

Remove mapping between data category, schema and user

Parameters
sUserinput, user name
sSchemainput, schema name
sDataCategoryinput, data categrory id as string
dsExInfooutput, Exception information

◆ unLHCLoggingDBSql_registerDataForLogging()

bool unLHCLoggingDBSql_registerDataForLogging ( const dyn_string &  dsElementId,
const dyn_string &  dsVariableName,
const dyn_string &  dsRDBSource,
const dyn_string &  dsUnit,
const dyn_string &  dsDescription,
const dyn_string &  dsDataCategoryId,
const dyn_string &  dsHierarchy,
const string  sUser,
const string  sPass 
)

Register new elements for logging

Parameters
dsElementIdinput, list of element ids
dsVariableNameinput, list of variable names
dsRDBSourceinput, list of RDB sources
dsUnitinput, list of units
dsDescriptioninput, list of descriptions
dsDataCategoryIdinput, list of data category ids
dsHierarchyinput, list of Hierarchies
sUserinput, username from meta_users
sPassinput, password from meta_users
Returns
output, true: success, false: error

◆ unLHCLoggingDBSql_getDbSysTime()

time unLHCLoggingDBSql_getDbSysTime ( dyn_string &  dsExInfo)

Query current database system time

Parameters
dsExInfooutput, Exception information
Returns
sqlResult output, database systimestamp as local time

◆ unLHCLoggingDBSql_getTransferHistoryForTestDpe()

dyn_dyn_mixed unLHCLoggingDBSql_getTransferHistoryForTestDpe ( string  sVarName,
dyn_string &  dsExInfo 
)

Get the most recent entry from transfer history for a specific signal name

This function is used by the test datapoints of system integrity plugin but it can be used for any variable.

Parameters
sVarNameinput, Variable Name of the test datapoint
dsExInfooutput, Exception information
Returns
sqlResult output, Result of the query (row wise)

sqlResult[1][1]: variable_name sqlResult[1][2]: last_logged_utc_stamp at local

◆ unLHCLoggingDBSql_getTransferStats()

dyn_dyn_mixed unLHCLoggingDBSql_getTransferStats ( string  job,
time  tStart,
time  tEnd,
bool  bUTC,
dyn_string &  exceptionInfo 
)

Query for transfer statistics per transfer job

Parameters
jobinput, name of the transfer job
tStartinput, utc start time of time window
tEndinput, utc end time of time window
bUTCinput, true=show timestamps as UTC, false=show timestamps as localtime
dsExInfooutput, Exception information
Returns
sqlResult output, Result of the query (column wise)

line 1: session_id line 2: session_start_utc line 3: session_type line 4: time_in_s line 5: no_of_recs line 6: time_in_s line 7: no_of_recs

◆ unLHCLoggingDBSql_getTransferStatsForDataCategory()

dyn_dyn_mixed unLHCLoggingDBSql_getTransferStatsForDataCategory ( string  dataCategoryId,
time  tStart,
time  tEnd,
bool  bUTC,
dyn_string &  exceptionInfo 
)

Get transfer statistics for a specific data category

Parameters
dataCategoryIdinput, data category id
tStartinput, utc start time of time window
tEndinput, utc end time of time window
bUTCinput, true=show timestamps as UTC, false=show timestamps as localtime
dsExInfooutput, Exception information
Returns
Result of the query (column wise)

◆ unLHCLoggingDBSql_getTransferJobIds()

dyn_dyn_mixed unLHCLoggingDBSql_getTransferJobIds ( dyn_string &  dsExInfo)

Execute SQL query to get transfer job IDs

Parameters
dsExInfooutput, Exception information
Returns
sqlResult output, result of the query (column wise)

◆ unLHCLoggingDBSql_getTransferJobDetails()

dyn_dyn_mixed unLHCLoggingDBSql_getTransferJobDetails ( string  sRdbSource,
bool  bUTC,
dyn_string &  dsExInfo 
)

Execute SQL query to get information of RDB transfer jobs

Parameters
sRdbSourceinput, show transfer jobs related to this RDB SOURCE
bUTCinput, true=show timestamps as UTC, false=show timestamps as localtime
dsExInfooutput, Exception information
Returns
sqlResult output, Result of the query (column wise)

line 1: job name line 2: job enabled line 3: job state line 4: last start date line 5: last run duration line 6: next run date line 7: load in percent

◆ unLHCLoggingDBSql_getTransferJobStatus()

dyn_dyn_mixed unLHCLoggingDBSql_getTransferJobStatus ( string  sRdbSource,
dyn_string &  dsExInfo 
)

SQL query to get current status of transfer jobs

Parameters
sRdbSourceinput, show transfer jobs related to this RDB SOURCE
dsExInfooutput, Exception information
Returns
sqlResult output, Result of the query

sqlResult[1]: job name sqlResult[2]: job enabled sqlResult[3]: job state sqlResult[4]: last start date (utc)

◆ unLHCLoggingDBSql_getSessionInfo()

dyn_dyn_mixed unLHCLoggingDBSql_getSessionInfo ( const string  sJobNumber,
dyn_string &  dsExInfo,
bool  bUTC = false 
)

Execute SQL query to get information about the latest session

Parameters
sJobNumberinput, job number as a string, e.g.: "7"
dsExInfooutput, Exception information
bUTCinput, true=show timestamps as UTC, false=show timestamps as localtime
Returns
sqlResult

column 1: session id column 2: session type column 3: session start column 4: session end column 5: operation type column 6: operation time column 7: operation no of records

◆ unLHCLoggingDBSql_getDataCategoriesOfSchema()

dyn_dyn_mixed unLHCLoggingDBSql_getDataCategoriesOfSchema ( string  sDbSchema,
dyn_string &  dsExInfo 
)

Get all data categories related to a DB-schema

Parameters
sDbSchemainput, list of user names
dsExInfooutput, Exception information
Returns
dsDataCategories output, list of data categories

◆ unLHCLoggingDBSql_getDataCategoryId()

string unLHCLoggingDBSql_getDataCategoryId ( string  sDataCategory,
dyn_string &  dsExInfo 
)

Get data category id of a data category

Parameters
sDataCategoryinput, "data_category_name/data_category_sub_name"
dsExInfooutput, Exception information
Returns
output, data category id as a string

◆ unLHCLoggingDBSql_unregisterVariablesFromLogging()

bool unLHCLoggingDBSql_unregisterVariablesFromLogging ( const dyn_string &  dsSignalNames)

Unregisters a set of signals from logging

Parameters
dsSignalNamesinput, set of signals to unregister
Returns
true: success, false: error

◆ unLHCLoggingDBSql_renameVariables()

bool unLHCLoggingDBSql_renameVariables ( const dyn_string &  dsSignalNameOld,
const dyn_string &  dsSignalNameNew,
const dyn_string &  dsDescriptionNew,
const dyn_string &  dsUnitNew 
)

Renames given signals and updates description and unit. Changes are propagated to LDB

This function also works for exchanging names for renamed variables (ie A->B and B->A). It renames variables in two steps: first to a temp name and then to the proper new name. It rolls back in case of errors.

Parameters
dsSignalNameOldinput, list of signals to be renamed
dsSignalNameNewinput, list of new signal names
dsDescriptionNewinput, list of new signal descriptions
dsUnitNewinput, list of new signal units
Returns
true: success, false: error
See also
https://issues.cern.ch/browse/CALS-2878

◆ unLHCLoggingDBSql_renameVariablesImpl()

void unLHCLoggingDBSql_renameVariablesImpl ( const dyn_string &  dsSignalNameOld,
const dyn_string &  dsSignalNameNew,
const dyn_string &  dsDescriptionNew,
const dyn_string &  dsUnitNew 
)
private

Renames given signals and updates description and unit. Changes are propagated to LDB

This internal function does neither commit nor rollback in case of error, use unLHCLoggingDBSql_renameVariables instead This function does NOT work for exchanging names for renamed variables (ie A->B and B->A).

Parameters
dsSignalNameOldinput, list of signals to be renamed
dsSignalNameNewinput, list of new signal names
dsDescriptionNewinput, list of new signal descriptions
dsUnitNewinput, list of new signal units
Exceptions
throwsan exception in case of error
See also
https://issues.cern.ch/browse/CALS-2878

◆ unLHCLoggingDBSql_deleteHierarchies()

bool unLHCLoggingDBSql_deleteHierarchies ( const dyn_string &  dsSignalNames)

Deletes hierarchies for given signals

Parameters
dsSignalNamesinput, set of signals for which we want to delte the hierarchies
Returns
true: success, false: error

◆ unLHCLoggingDBSql_getInconsistentData()

dyn_dyn_mixed unLHCLoggingDBSql_getInconsistentData ( const string  sDbSchema,
dyn_string &  dsExInfo 
)

Find inconsistency between registered data (meta_variables) and dpes (elements)

Parameters
sDbSchemainput, name of the db schema to check
dsExInfooutput, Exception information
Returns
output, list of inconsistent variables

column 1: variable_id column2: variable_name

◆ unLHCLoggingDBSql_getNumSignalsHavingInconsistentArchiveGroup()

unsigned unLHCLoggingDBSql_getNumSignalsHavingInconsistentArchiveGroup ( const string  sDbSchema,
dyn_string &  dsExInfo 
)

Get number of signals registered for logging, having incosistencies between RDB_SOURCE and ARCHIVE_GROUP

Parameters
sDbSchemainput, name of the db schema to check
dsExInfooutput, Exception information
Returns
output, number of inconsistenc signals

◆ unLHCLoggingDBSql_getElements()

dyn_dyn_mixed unLHCLoggingDBSql_getElements ( const string  sDbSchema,
dyn_string &  dsExInfo 
)

Get all elements in a specific db schema

Parameters
sDbSchemainput, db schema to look for elements
Returns
output, true: ok, false: problem

◆ unLHCLoggingDBSql_getElementsExceptInternalDPs()

dyn_dyn_mixed unLHCLoggingDBSql_getElementsExceptInternalDPs ( const string  sDbSchema,
dyn_string &  dsExInfo 
)

Get all elements in a specific db schema

Parameters
sDbSchemainput, db schema to look for elements
Returns
output, true: ok, false: problem

◆ unLHCLoggingDBSql_getSystemsUsingSchema()

dyn_string unLHCLoggingDBSql_getSystemsUsingSchema ( const string  sDbSchema,
dyn_string &  dsExInfo 
)

Get all systems that are using a specific db schema

Parameters
sDbSchemainput, db schema to look for elements
Returns
output, mapping of system names and system ids

◆ unLHCLoggingDBSql_triggerRetransferForRdbSource()

bool unLHCLoggingDBSql_triggerRetransferForRdbSource ( string  sRdbSource,
time  tStart 
)

Trigger retransfer for given RDB_SOURCE starting from a certain START_TIME

Parameters
sDbSchemainput, RDB_SOURCE to retransfer
tStartinput, START_TIME for retransfer (localtime)
Returns
output, true:sucess, false:error

◆ unLHCLoggingDBSql_getAllRdbSources()

dyn_string unLHCLoggingDBSql_getAllRdbSources ( dyn_string &  dsExInfo)

Get all RDB_SOURCES, that are currently registered

Parameters
dsExInfooutput, Exception information
Returns
output, List of RDB_SOURCES