QwDatabase Class Reference

A database interface class. More...

#include <QwDatabase.h>

Inheritance diagram for QwDatabase:

Public Member Functions
	QwDatabase (const string &major="00", const string &minor="00", const string &point="0000")
	Simple constructor. More...
	QwDatabase (QwOptions &options, const string &major="00", const string &minor="00", const string &point="0000")
	Constructor with QwOptions object. More...
virtual	~QwDatabase ()
	Destructor. More...
void	SetAccessLevel (string accesslevel)
	Sets the access level flag based on string labels: "off", "ro", "rw". More...
Bool_t	AllowsReadAccess ()
Bool_t	AllowsWriteAccess ()
Bool_t	Connect ()
	Open a connection to the database using the predefined parameters. More...
void	Disconnect ()
Bool_t	Connected ()
const string	GetServerVersion ()
void	ProcessOptions (QwOptions &options)
	Processes the options contained in the QwOptions object. More...
void	ProcessOptions (const TString &dbname, const TString &username, const TString &passwd, const TString &dbhost="localhost", const Int_t dbport=0, const TString &accesslevel="ro")
	Processes database options. More...
mysqlpp::Query	Query (const char *qstr=0)
mysqlpp::Query	Query (const std::string &qstr)
const string	GetVersion ()
const string	GetVersionMajor ()
	Return a full version string for the DB schema. More...
const string	GetVersionMinor ()
const string	GetVersionPoint ()
const string	GetValidVersion ()
void	PrintServerInfo ()

Static Public Member Functions
static void	DefineOptions (QwOptions &options)
	Defines available class options for QwOptions. More...

Private Types
enum	EQwDBAccessLevel { kQwDatabaseOff, kQwDatabaseReadOnly, kQwDatabaseReadWrite }

Private Member Functions
Bool_t	ValidateConnection ()
	Checks that given connection parameters result in a valid connection. More...
bool	StoreDBVersion ()
	Retrieve database schema version information from database. More...
	QwDatabase (const QwDatabase &rhs)
	Copy Constructor (not implemented) More...
QwDatabase &	operator= (const QwDatabase &rhs)
	Assignment operator (not implemented) More...

Private Attributes
EQwDBAccessLevel	fAccessLevel
	Access level of the database instance. More...
string	fDatabase
	Name of database to connect to. More...
string	fDBServer
	Name of server carrying DB to connect to. More...
string	fDBUsername
	Name of account to connect to DB server with. More...
string	fDBPassword
	DB account password. More...
UInt_t	fDBPortNumber
	Port number to connect to on server (mysql default port is 3306) More...
Bool_t	fValidConnection
	True if a valid connection was established using defined connection information. More...
string	fVersionMajor
	Major version number of current DB schema. More...
string	fVersionMinor
	Minor version number of current DB schema. More...
string	fVersionPoint
	Point version number of current DB schema. More...
const string	kValidVersionMajor
const string	kValidVersionMinor
const string	kValidVersionPoint

Detailed Description

A database interface class.

This class provides the connection to the Qweak database to other objects in the Qweak analyzer. A static global object gQwDatabase is used to provide these services.

Definition at line 45 of file QwDatabase.h.

Member Enumeration Documentation

enum QwDatabase::EQwDBAccessLevel

private

Enumerator
kQwDatabaseOff
kQwDatabaseReadOnly
kQwDatabaseReadWrite

Definition at line 79 of file QwDatabase.h.

{kQwDatabaseOff, kQwDatabaseReadOnly, kQwDatabaseReadWrite};

Constructor & Destructor Documentation

QwDatabase::QwDatabase	(	const string &	major = "00",
		const string &	minor = "00",
		const string &	point = "0000"
	)

Simple constructor.

QwDatabase::QwDatabase	(	QwOptions &	options,
		const string &	major = "00",
		const string &	minor = "00",
		const string &	point = "0000"
	)

Constructor with QwOptions object.

The constructor initializes member fields using the values in the QwOptions object.

Parameters

options	The QwOptions object.
major	Major version number
minor	Minor version number
point	Point revision number

Definition at line 53 of file QwDatabase.cc.

References QwLog::endl(), fAccessLevel, fDatabase, fDBPassword, fDBPortNumber, fDBServer, fDBUsername, fValidConnection, fVersionMajor, fVersionMinor, fVersionPoint, kQwDatabaseOff, ProcessOptions(), and QwDebug.

                                                                                                        : Connection(), kValidVersionMajor(major), kValidVersionMinor(minor), kValidVersionPoint(point)
{
  QwDebug << "Greetings from QwDatabase extended constructor." << QwLog::endl;

  // Initialize member fields
  fDatabase=fDBServer=fDBUsername=fDBPassword="";
  fVersionMajor=fVersionMinor=fVersionPoint="";

  fAccessLevel = kQwDatabaseOff;

  fDBPortNumber      = 0;
  fValidConnection   = false;

  ProcessOptions(options);

}

Here is the call graph for this function:

QwDatabase::~QwDatabase ( )

virtual

Destructor.

The destructor says "Good-bye World!"

Definition at line 72 of file QwDatabase.cc.

References Disconnect(), QwLog::endl(), and QwDebug.

{
  QwDebug << "QwDatabase::~QwDatabase() : Good-bye World from QwDatabase destructor!" << QwLog::endl;
  if( connected() ) Disconnect();
}

Here is the call graph for this function:

QwDatabase::QwDatabase ( const QwDatabase &  rhs )

private

Copy Constructor (not implemented)

Member Function Documentation

Bool_t QwDatabase::AllowsReadAccess ( )

inline

Definition at line 55 of file QwDatabase.h.

References fAccessLevel, kQwDatabaseReadOnly, and kQwDatabaseReadWrite.

Referenced by QwParityDB::SetupOneRun().

{return (fAccessLevel==kQwDatabaseReadOnly || fAccessLevel==kQwDatabaseReadWrite);};

Here is the caller graph for this function:

Bool_t QwDatabase::AllowsWriteAccess ( )

inline

Definition at line 56 of file QwDatabase.h.

References fAccessLevel, and kQwDatabaseReadWrite.

Referenced by main().

{return (fAccessLevel==kQwDatabaseReadWrite);};

Here is the caller graph for this function:

bool QwDatabase::Connect

(

)

Open a connection to the database using the predefined parameters.

This function is used to initiate a database connection.

Definition at line 175 of file QwDatabase.cc.

References QwLog::endl(), fAccessLevel, fDatabase, fDBPassword, fDBPortNumber, fDBServer, fDBUsername, fValidConnection, kQwDatabaseOff, QwError, and ValidateConnection().

Referenced by QwEPICSEvent::FillDB(), QwRegression::FillDB(), QwBlinder::FillDB(), QwMainCerenkovDetector::FillDB(), QwBeamLine::FillDB(), QwIntegratedRaster::FillDB(), QwHelicity::FillDB(), QwLumi::FillDB(), QwBeamMod::FillDB_MPS(), QwBlinder::FillErrDB(), QwMainCerenkovDetector::FillErrDB(), QwBeamLine::FillErrDB(), QwIntegratedRaster::FillErrDB(), QwLumi::FillErrDB(), QwParityDB::FillParameterFiles(), QwEPICSEvent::FillSlowControlsData(), QwEPICSEvent::FillSlowControlsSettings(), QwEPICSEvent::FillSlowControlsStrigs(), QwBlinder::ReadSeed(), QwParityDB::SetAnalysisID(), QwParityDB::SetRunID(), QwParityDB::SetRunletID(), QwParityDB::SetRunNumber(), QwParityDB::StoreErrorCodeIDs(), QwParityDB::StoreLumiDetectorIDs(), QwParityDB::StoreMainDetectorIDs(), QwParityDB::StoreMeasurementIDs(), QwParityDB::StoreMonitorIDs(), QwParityDB::StoreSlowControlDetectorIDs(), QwBlinder::WriteChecksum(), and QwBlinder::WriteTestValues().

{
  /* Open a connection to the database using the predefined parameters.
   * Must call QwDatabase::ConnectionInfo() first.
   */

  //  Return flase, if we're not using the DB.
  if (fAccessLevel==kQwDatabaseOff) return false;

  // Make sure not already connected
  if (connected()) return true;

  // If never connected before, then make sure connection parameters form
  // valid connection
  if (!fValidConnection) {
    ValidateConnection();
  }

  if (fValidConnection) {
    return connect(fDatabase.c_str(), fDBServer.c_str(), fDBUsername.c_str(), fDBPassword.c_str(), (unsigned int) fDBPortNumber);
    //   return connect(fDatabase.Data(), fDBServer.Data(), fDBUsername.Data(), fDBPassword.Data(), (unsigned int) fDBPortNumber);
  } else {
    QwError << "QwDatabase::Connect() : Must establish valid connection to database." << QwLog::endl;
    return false;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t QwDatabase::Connected ( )

inline

Definition at line 60 of file QwDatabase.h.

Referenced by QwParityDB::~QwParityDB().

{ return connected(); }

Here is the caller graph for this function:

void QwDatabase::DefineOptions ( QwOptions &  options )

static

Defines available class options for QwOptions.

Defines configuration options for QwDatabase class using QwOptions functionality.

Should apparently by called by QwOptions::DefineOptions() in QwParityOptions.h

Definition at line 209 of file QwDatabase.cc.

References QwOptions::AddOptions().

Referenced by QwOptions::DefineOptions().

{
  // Specify command line options for use by QwDatabase
  options.AddOptions("Database options")("QwDatabase.accesslevel", po::value<string>(), "database access level (OFF,RO,RW)");
  options.AddOptions("Database options")("QwDatabase.dbname", po::value<string>(), "database name");
  options.AddOptions("Database options")("QwDatabase.dbserver", po::value<string>(), "database server name");
  options.AddOptions("Database options")("QwDatabase.dbusername", po::value<string>(), "database username");
  options.AddOptions("Database options")("QwDatabase.dbpassword", po::value<string>(), "database password");
  options.AddOptions("Database options")("QwDatabase.dbport", po::value<int>()->default_value(0), "database server port number (defaults to standard mysql port)");
}

Here is the call graph for this function:

Here is the caller graph for this function:

void QwDatabase::Disconnect ( )

inline

Definition at line 59 of file QwDatabase.h.

Referenced by QwEPICSEvent::FillDB(), QwRegression::FillDB(), QwBlinder::FillDB(), QwMainCerenkovDetector::FillDB(), QwBeamLine::FillDB(), QwIntegratedRaster::FillDB(), QwHelicity::FillDB(), QwLumi::FillDB(), QwBeamMod::FillDB_MPS(), QwBlinder::FillErrDB(), QwMainCerenkovDetector::FillErrDB(), QwBeamLine::FillErrDB(), QwIntegratedRaster::FillErrDB(), QwLumi::FillErrDB(), QwParityDB::FillParameterFiles(), QwEPICSEvent::FillSlowControlsData(), QwEPICSEvent::FillSlowControlsSettings(), QwEPICSEvent::FillSlowControlsStrigs(), QwBlinder::ReadSeed(), QwParityDB::SetAnalysisID(), QwParityDB::SetRunID(), QwParityDB::SetRunletID(), QwParityDB::SetRunNumber(), StoreDBVersion(), QwParityDB::StoreErrorCodeIDs(), QwParityDB::StoreLumiDetectorIDs(), QwParityDB::StoreMainDetectorIDs(), QwParityDB::StoreMeasurementIDs(), QwParityDB::StoreMonitorIDs(), QwParityDB::StoreSlowControlDetectorIDs(), QwBlinder::WriteChecksum(), QwBlinder::WriteTestValues(), ~QwDatabase(), and QwParityDB::~QwParityDB().

{disconnect();}; //<! Close an open database connection

Here is the caller graph for this function:

const string QwDatabase::GetServerVersion ( )

inline

Definition at line 61 of file QwDatabase.h.

Referenced by PrintServerInfo().

{return server_version();}; //<! Get database server version

Here is the caller graph for this function:

const string QwDatabase::GetValidVersion

(

)

Definition at line 309 of file QwDatabase.cc.

References kValidVersionMajor, kValidVersionMinor, and kValidVersionPoint.

Referenced by ValidateConnection().

                                        {
  string version = kValidVersionMajor + "." + kValidVersionMinor + "." + kValidVersionPoint;
  return version;
}

Here is the caller graph for this function:

const string QwDatabase::GetVersion

(

)

Definition at line 304 of file QwDatabase.cc.

References fVersionMajor, fVersionMinor, and fVersionPoint.

Referenced by main(), and ValidateConnection().

                                   {
  string version = fVersionMajor + "." + fVersionMinor + "." + fVersionPoint;
  return version;
}

Here is the caller graph for this function:

const string QwDatabase::GetVersionMajor ( )

inline

Return a full version string for the DB schema.

Definition at line 71 of file QwDatabase.h.

References fVersionMajor.

{return fVersionMajor;} //<! fVersionMajor getter

const string QwDatabase::GetVersionMinor ( )

inline

Definition at line 72 of file QwDatabase.h.

References fVersionMinor.

{return fVersionMinor;} //<! fVersionMinor getter

const string QwDatabase::GetVersionPoint ( )

inline

Definition at line 73 of file QwDatabase.h.

References fVersionPoint.

{return fVersionPoint;} //<! fVersionPoint getter

QwDatabase& QwDatabase::operator= ( const QwDatabase &  rhs )

private

Assignment operator (not implemented)

void QwDatabase::PrintServerInfo

(

)

This function prints the server information.

Definition at line 283 of file QwDatabase.cc.

References BLUE, BOLD, fDatabase, fDBPortNumber, fDBServer, fDBUsername, fValidConnection, GetServerVersion(), NORMAL, and RED.

{
  if (fValidConnection)
    {
      printf("\nQwDatabase MySQL ");
      printf("%s v%s %s -----------------\n", BOLD, GetServerVersion().c_str(), NORMAL);
      printf("Database server : %s%10s%s",    RED,  fDBServer.c_str(),   NORMAL);
      printf(" name   : %s%12s%s",            BLUE, fDatabase.c_str(),   NORMAL);
      printf(" user   : %s%6s%s",             RED,  fDBUsername.c_str(), NORMAL);
      printf(" port   : %s%6d%s\n",           BLUE, fDBPortNumber,       NORMAL);
      printf(" %s\n\n", server_status().c_str());
    }
  else
    {
      printf("There is no connection.\n");
    }

  return;
}

Here is the call graph for this function:

void QwDatabase::ProcessOptions

(

QwOptions &

options

)

Processes the options contained in the QwOptions object.

Loads the configuration options for QwDatabase class into this instance of QwDatabase from the QwOptions object.

Parameters

options

Options object

Definition at line 225 of file QwDatabase.cc.

References QwLog::endl(), fAccessLevel, fDatabase, fDBPassword, fDBPortNumber, fDBServer, fDBUsername, QwOptions::GetValue(), QwOptions::HasValue(), kQwDatabaseOff, QwWarning, and SetAccessLevel().

Referenced by QwDatabase().

{
  if (options.HasValue("QwDatabase.accesslevel")) {
    string access = options.GetValue<string>("QwDatabase.accesslevel");
    SetAccessLevel(access);
  }
  else {
    QwWarning << "QwDatabase::ProcessOptions : No access level specified; database access is OFF" << QwLog::endl;
    fAccessLevel = kQwDatabaseOff;
  }
  if (options.HasValue("QwDatabase.dbport")) {
    fDBPortNumber = options.GetValue<int>("QwDatabase.dbport");
  }
  if (options.HasValue("QwDatabase.dbname")) {
    fDatabase = options.GetValue<string>("QwDatabase.dbname");
  }
  if (options.HasValue("QwDatabase.dbusername")) {
    fDBUsername = options.GetValue<string>("QwDatabase.dbusername");
  }
  if (options.HasValue("QwDatabase.dbpassword")) {
    fDBPassword = options.GetValue<string>("QwDatabase.dbpassword");
  }
  if (options.HasValue("QwDatabase.dbserver")) {
    fDBServer = options.GetValue<string>("QwDatabase.dbserver");
  }

  return;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void QwDatabase::ProcessOptions	(	const TString &	dbname,
		const TString &	username,
		const TString &	passwd,
		const TString &	dbhost = "localhost",
		const Int_t	dbport = 0,
		const TString &	accesslevel = "ro"
	)

Processes database options.

Definition at line 254 of file QwDatabase.cc.

References fDatabase, fDBPassword, fDBPortNumber, fDBServer, fDBUsername, and SetAccessLevel().

{
  SetAccessLevel(static_cast<string>(accesslevel));
  fDatabase = dbname;
  fDBUsername = username;
  fDBPassword = passwd;
  fDBServer = dbhost;
  fDBPortNumber = dbport;
}

Here is the call graph for this function:

mysqlpp::Query QwDatabase::Query ( const char *  qstr = 0 )

inline

Definition at line 66 of file QwDatabase.h.

Referenced by QwEPICSEvent::FillDB(), QwRegression::FillDB(), QwBlinder::FillDB(), QwMainCerenkovDetector::FillDB(), QwBeamLine::FillDB(), QwIntegratedRaster::FillDB(), QwHelicity::FillDB(), QwLumi::FillDB(), QwBeamMod::FillDB_MPS(), QwBlinder::FillErrDB(), QwMainCerenkovDetector::FillErrDB(), QwBeamLine::FillErrDB(), QwIntegratedRaster::FillErrDB(), QwLumi::FillErrDB(), QwParityDB::FillParameterFiles(), QwEPICSEvent::FillSlowControlsData(), QwEPICSEvent::FillSlowControlsSettings(), QwEPICSEvent::FillSlowControlsStrigs(), QwBlinder::ReadSeed(), QwParityDB::SetAnalysisID(), QwParityDB::SetRunID(), QwParityDB::SetRunletID(), QwParityDB::SetRunNumber(), StoreDBVersion(), QwParityDB::StoreErrorCodeIDs(), QwParityDB::StoreLumiDetectorIDs(), QwParityDB::StoreMainDetectorIDs(), QwParityDB::StoreMeasurementIDs(), QwParityDB::StoreMonitorIDs(), QwParityDB::StoreSlowControlDetectorIDs(), QwBlinder::WriteChecksum(), and QwBlinder::WriteTestValues().

{return query(qstr);} //<! Generate a query to the database.

Here is the caller graph for this function:

mysqlpp::Query QwDatabase::Query ( const std::string &  qstr )

inline

Definition at line 67 of file QwDatabase.h.

{return query(qstr);} //<! Generate a query to the database.

void QwDatabase::SetAccessLevel

(

string

accesslevel

)

Sets the access level flag based on string labels: "off", "ro", "rw".

Definition at line 264 of file QwDatabase.cc.

References QwLog::endl(), fAccessLevel, kQwDatabaseOff, kQwDatabaseReadOnly, kQwDatabaseReadWrite, and QwWarning.

Referenced by ProcessOptions().

{
  TString level = accesslevel.c_str();
  level.ToLower();
  if (level=="off")     fAccessLevel = kQwDatabaseOff;
  else if (level=="ro") fAccessLevel = kQwDatabaseReadOnly;
  else if (level=="rw") fAccessLevel = kQwDatabaseReadWrite;
  else{
    QwWarning << "QwDatabase::SetAccessLevel  : Unrecognized access level \""
        << accesslevel << "\"; setting database access OFF"
        << QwLog::endl;
    fAccessLevel = kQwDatabaseOff;
  }
  return;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool QwDatabase::StoreDBVersion ( )

private

Retrieve database schema version information from database.

Definition at line 318 of file QwDatabase.cc.

References Disconnect(), QwLog::endl(), fVersionMajor, fVersionMinor, fVersionPoint, Query(), QwDebug, and QwError.

Referenced by ValidateConnection().

{
  try
    {
      mysqlpp::Query query = this->Query();

      query << "SELECT * FROM db_schema";
      std::vector<db_schema> res;
      query.storein(res);
      QwDebug << "QwDatabase::StoreDBVersion => Number of rows returned:  " << res.size() << QwLog::endl;

      // If there is more than one run in the DB with the same run number, then there will be trouble later on.  Catch and bomb out.
      if (res.size()>1)
  {
    QwError << "Unable to find unique schema version in database." << QwLog::endl;
    QwError << "Schema query returned " << res.size() << "rows." << QwLog::endl;
    QwError << "Please make sure that db_schema contains one unique." << QwLog::endl;
    this->Disconnect();
    return false;
  }

      // Run already exists in database.  Pull run_id and move along.
      if (res.size()==1)
  {
    QwDebug << "QwDatabase::StoreDBVersion => db_schema_id = " << res.at(0).db_schema_id << QwLog::endl;

    fVersionMajor=res.at(0).major_release_number;
    fVersionMinor=res.at(0).minor_release_number;
    fVersionPoint=res.at(0).point_release_number;
    this->Disconnect();
  }
    }
  catch (const mysqlpp::Exception& er)
    {
      QwError << er.what() << QwLog::endl;
      disconnect();
      return false;
    }

  return true;

}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t QwDatabase::ValidateConnection ( )

private

Checks that given connection parameters result in a valid connection.

This function is used to load the connection information for the database. It tests the connection to make sure it is valid and causes a program exit if no valid connection can be formed.

It is called the first time Connect() is called.

Definition at line 84 of file QwDatabase.cc.

References Qw::e, QwLog::endl(), fAccessLevel, fDatabase, fDBPassword, fDBPortNumber, fDBServer, fDBUsername, fValidConnection, fVersionMajor, fVersionMinor, fVersionPoint, GetValidVersion(), GetVersion(), kQwDatabaseOff, kQwDatabaseReadWrite, kValidVersionMajor, kValidVersionMinor, kValidVersionPoint, QwDebug, QwError, QwMessage, QwWarning, and StoreDBVersion().

Referenced by Connect().

{
  QwDebug << "Entering QwDatabase::ValidateConnection()..." << QwLog::endl;

  // Bool_t status;
  //
  // Retrieve options if they haven't already been filled.
  //
  //   if (fDatabase.empty()){
  //     status = ProcessOptions(gQwOptions);
  //     if (!status) return status;
  //   }

  //  Check values.
  if (fAccessLevel!=kQwDatabaseOff){
    if (fDatabase.empty()){
      QwError << "QwDatabase::ValidateConnection() : No database supplied.  Unable to connect." << QwLog::endl;
      fValidConnection=false;
    }
    if (fDBUsername.empty()){
      QwError << "QwDatabase::ValidateConnection() : No database username supplied.  Unable to connect." << QwLog::endl;
      fValidConnection=false;
    }
    if (fDBPassword.empty()){
      QwError << "QwDatabase::ValidateConnection() : No database password supplied.  Unable to connect." << QwLog::endl;
      fValidConnection=false;
    }
    if (fDBServer.empty()){
      QwMessage << "QwDatabase::ValidateConnection() : No database server supplied.  Attempting localhost." << QwLog::endl;
      fDBServer = "localhost";
    }
    //
    // Try to connect with given information
    //
    try {
      connect(fDatabase.c_str(), fDBServer.c_str(), fDBUsername.c_str(),
        fDBPassword.c_str(), (unsigned int) fDBPortNumber);
      //    connect(dbname.Data(), server.Data(), username.Data(), password.Data(), (unsigned int) port);
    } catch (std::exception const& e) {
      QwError << "QwDatabase::ValidateConnection() : " << QwLog::endl;
      QwError << e.what() << " while validating connection" << QwLog::endl;
      QwError << "Database name = " << fDatabase <<QwLog::endl;
      QwError << "Database server = " << fDBServer <<QwLog::endl;
      QwError << "Database username = " << fDBUsername <<QwLog::endl;
      QwError << "Database port = " << fDBPortNumber <<QwLog::endl;
      QwError << "Continuing without database." << QwLog::endl;
      QwWarning << "Might have left database connection dangling..." << QwLog::endl;
      fAccessLevel = kQwDatabaseOff;
      return kFALSE;
    }

    QwDebug << "QwDatabase::ValidateConnection() : Made it past connect() call."  << QwLog::endl;

    // Get database schema version information
    if (StoreDBVersion()) {
      fValidConnection=true;
      // Success!
      QwMessage << "QwDatabase::ValidateConnection() : Successfully connected to requested database." << QwLog::endl;
    } else {
      QwError << "QwDatabase::ValidateConnection() : Unsuccessfully connected to requested database." << QwLog::endl;
      // Connection was bad so clear the member variables
      fValidConnection=false;
      fDatabase.clear();
      fDBServer.clear();
      fDBUsername.clear();
      fDBPassword.clear();
      fDBPortNumber=0;
    }
    disconnect();
  }

  // Check to make sure database and QwDatabase schema versions match up.
  if (fAccessLevel==kQwDatabaseReadWrite && 
      (fVersionMajor != kValidVersionMajor ||
      fVersionMinor != kValidVersionMinor ||
      fVersionPoint < kValidVersionPoint)) {
    fValidConnection = false;
    QwError << "QwDatabase::ValidConnection() : Connected database schema inconsistent with current version of analyzer." << QwLog::endl;
    QwError << "  Database version is " << this->GetVersion() << QwLog::endl;
    QwError << "  Required database version is " << this->GetValidVersion() << QwLog::endl;
    QwError << "  Please connect to a database supporting the required schema version." << QwLog::endl;
    exit(1);
  }

  QwDebug << "QwDatabase::ValidateConnection() : Exiting successfully." << QwLog::endl;
  return fValidConnection;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

EQwDBAccessLevel QwDatabase::fAccessLevel

private

Access level of the database instance.

Definition at line 91 of file QwDatabase.h.

Referenced by AllowsReadAccess(), AllowsWriteAccess(), Connect(), ProcessOptions(), QwDatabase(), SetAccessLevel(), and ValidateConnection().

string QwDatabase::fDatabase

private

Name of database to connect to.

Definition at line 93 of file QwDatabase.h.

Referenced by Connect(), PrintServerInfo(), ProcessOptions(), QwDatabase(), and ValidateConnection().

string QwDatabase::fDBPassword

private

DB account password.

Definition at line 96 of file QwDatabase.h.

Referenced by Connect(), ProcessOptions(), QwDatabase(), and ValidateConnection().

UInt_t QwDatabase::fDBPortNumber

private

Port number to connect to on server (mysql default port is 3306)

Definition at line 97 of file QwDatabase.h.

Referenced by Connect(), PrintServerInfo(), ProcessOptions(), QwDatabase(), and ValidateConnection().

string QwDatabase::fDBServer

private

Name of server carrying DB to connect to.

Definition at line 94 of file QwDatabase.h.

Referenced by Connect(), PrintServerInfo(), ProcessOptions(), QwDatabase(), and ValidateConnection().

string QwDatabase::fDBUsername

private

Name of account to connect to DB server with.

Definition at line 95 of file QwDatabase.h.

Referenced by Connect(), PrintServerInfo(), ProcessOptions(), QwDatabase(), and ValidateConnection().

Bool_t QwDatabase::fValidConnection

private

True if a valid connection was established using defined connection information.

Definition at line 98 of file QwDatabase.h.

Referenced by Connect(), PrintServerInfo(), QwDatabase(), and ValidateConnection().

string QwDatabase::fVersionMajor

private

Major version number of current DB schema.

Definition at line 100 of file QwDatabase.h.

Referenced by GetVersion(), GetVersionMajor(), QwDatabase(), StoreDBVersion(), and ValidateConnection().

string QwDatabase::fVersionMinor

private

Minor version number of current DB schema.

Definition at line 101 of file QwDatabase.h.

Referenced by GetVersion(), GetVersionMinor(), QwDatabase(), StoreDBVersion(), and ValidateConnection().

string QwDatabase::fVersionPoint

private

Point version number of current DB schema.

Definition at line 102 of file QwDatabase.h.

Referenced by GetVersion(), GetVersionPoint(), QwDatabase(), StoreDBVersion(), and ValidateConnection().

const string QwDatabase::kValidVersionMajor

private

Definition at line 103 of file QwDatabase.h.

Referenced by GetValidVersion(), and ValidateConnection().

const string QwDatabase::kValidVersionMinor

private

Definition at line 104 of file QwDatabase.h.

Referenced by GetValidVersion(), and ValidateConnection().

const string QwDatabase::kValidVersionPoint

private

Definition at line 105 of file QwDatabase.h.

Referenced by GetValidVersion(), and ValidateConnection().

---

The documentation for this class was generated from the following files:

• QwDatabase.h
• QwDatabase.cc