Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

DbiTableMetaData Class Reference

Concept Table meta data i.e. data about the table itself Purpose To provide information on the names and types of columns More...

#include <DbiTableMetaData.h>

List of all members.

Public Member Functions

 DbiTableMetaData (const string &tableName="Unknown")
virtual ~DbiTableMetaData ()
string Sql (Dbi::DbTypes dbType=Dbi::kMySQL) const
 Return SQL string to create table.
string TableName () const
Bool_t HasRowCounter () const
UInt_t NumCols () const
const DbiFieldType & ColFieldType (Int_t colNum) const
UInt_t ColFieldConcept (Int_t colNum) const
Bool_t ColIsNullable (Int_t colNum) const
Bool_t ColMustDelimit (Int_t colNum) const
string ColName (Int_t colNum) const
void SetFromSql (const string &sql)
 Recreate from SQL used to create table.

Protected Member Functions

void Clear ()
 .....................................................................
void SetColIsNullable (Int_t colNum, Bool_t isNullable=true)
void SetColName (const string &name, Int_t colNum)
void SetColFieldType (const DbiFieldType &type, Int_t colNum)

Private Types

enum  { MAXCOL = 1000 }
 Sanity check: limit number of columns. More...

Private Member Functions

void ExpandTo (UInt_t colNum)
const ColumnAttributes & GetAttributes (Int_t colNum) const
 Return a column attributes (will be dummy entry if requesting invalid column).
ColumnAttributes & SetAttributes (Int_t colNum)
 Return a setable column attributes (will be dummy entry if requesting invalid column).

Static Private Member Functions

string GetToken (const char *&strPtr)
 Use to parse table creation SQL - move to UtilString?

Private Attributes

std::vector< ColumnAttributes > fColAttr
 Column attributes indexed by column (starting from 0).
UInt_t fNumCols
 Number of columns.
string fTableName
 Table name (either XXX or XXXVLD).

Static Private Attributes

ColumnAttributes fgDummy
 Dummy attributes (used when requesting invalid column).

Friends

class DbiDBProxy

Detailed Description

Concept Table meta data i.e. data about the table itself Purpose To provide information on the names and types of columns

Id
DbiTableMetaData.h,v 1.16 2007/04/26 14:19:57 west Exp

DatabaseInterface

Contact: n.west1@physics.ox.ac.uk to transient DbiRowStream objects.

Definition at line 35 of file DbiTableMetaData.h.

Member Enumeration Documentation

anonymous enum [private]
 

Sanity check: limit number of columns.

Enumeration values:
MAXCOL 

Definition at line 84 of file DbiTableMetaData.h.

00084 { MAXCOL = 1000};

Constructor & Destructor Documentation

DbiTableMetaData::DbiTableMetaData (  const string &  tableName = "Unknown"  ) 
 

Definition at line 35 of file DbiTableMetaData.cxx.

References LEA_CTOR, and MSG.

00035                                                           :
00036 fNumCols(0),
00037 fTableName(tableName)
00038 {
00039 //
00040 //
00041 //  Purpose:  Default constructor
00042 
00043 //  Program Notes:-
00044 //  =============
00045 
00046 //  This is filled by the owning DbiTableProxy, as it is too low level to
00047 //  use the cascade to fill itself, hence the friend status granted to DbiDBProxy. 
00048 
00049   LEA_CTOR    //Leak Checker
00050 
00051   MSG("Dbi", Msg::kVerbose) << "Creating DbiTableMetaData" << endl;
00052 
00053 }

DbiTableMetaData::~DbiTableMetaData (   )  [virtual]
 

Definition at line 57 of file DbiTableMetaData.cxx.

References LEA_DTOR, and MSG.

00057                                     {
00058 //
00059 //
00060 //  Purpose: Destructor
00061 
00062   LEA_DTOR    //Leak Checker
00063 
00064   MSG("Dbi", Msg::kVerbose) << "Destroying DbiTableMetaData" << endl;
00065 
00066 }

Member Function Documentation

void DbiTableMetaData::Clear (   )  [protected]
 

.....................................................................

Definition at line 70 of file DbiTableMetaData.cxx.

References fColAttr, and fNumCols.

Referenced by SetFromSql(), and DbiDBProxy::StoreMetaData().

00070                              {
00071 //
00072 //
00073 //  Purpose: Clear out existing data (apart from table name)
00074 //
00075 //  Contact:   N. West
00076 
00077   fColAttr.clear();
00078   fNumCols = 0;
00079 
00080 }

UInt_t DbiTableMetaData::ColFieldConcept (  Int_t  colNum  )  const [inline]
 

Definition at line 58 of file DbiTableMetaData.h.

Referenced by DbiResultSet::RowAsCsv().

00058 { return GetAttributes(colNum).Concept;}

const DbiFieldType& DbiTableMetaData::ColFieldType (  Int_t  colNum  )  const [inline]
 

Definition at line 57 of file DbiTableMetaData.h.

Referenced by DbiResultSet::AsString(), DbiRowStream::ColFieldType(), DbiRowStream::CurColFieldType(), DbiResultSet::RowAsCsv(), SetFromSql(), and Sql().

00057 { return GetAttributes(colNum).Type;}

Bool_t DbiTableMetaData::ColIsNullable (  Int_t  colNum  )  const [inline]
 

Definition at line 59 of file DbiTableMetaData.h.

Referenced by Sql().

00059 { return GetAttributes(colNum).IsNullable;}

Bool_t DbiTableMetaData::ColMustDelimit (  Int_t  colNum  )  const [inline]
 

Definition at line 60 of file DbiTableMetaData.h.

Referenced by DbiResultSet::RowAsCsv().

00060 { return GetAttributes(colNum).MustDelimit;}

string DbiTableMetaData::ColName (  Int_t  colNum  )  const [inline]
 

Definition at line 61 of file DbiTableMetaData.h.

Referenced by DbiResultSet::AsString(), DbuDaqMonitorModule::CheckForRowCounterColumn(), DbiRowStream::ColName(), DbiRowStream::CurColName(), DbuDaqMonitorModule::GetCommentFieldName(), SetFromSql(), and Sql().

00061 { return GetAttributes(colNum).Name;}

void DbiTableMetaData::ExpandTo (  UInt_t  colNum  )  [private]
 

Definition at line 84 of file DbiTableMetaData.cxx.

References fColAttr, fNumCols, and MAXCOL.

Referenced by SetAttributes().

00084                                              {
00085 //
00086 //
00087 //  Purpose: Expand table if required to specied colNum 
00088 //
00089 //  Arguments: 
00090 //    colNum       in    Column number to expand to (1,2...).
00091 //
00092 //  Return:    
00093 //
00094 //  Contact:   N. West
00095 //
00096 //  Specification:-
00097 //  =============
00098 //
00099 //  o 
00100 
00101 //  Program Notes:-
00102 //  =============
00103 
00104 //  None.
00105 
00106   assert ( colNum < MAXCOL );
00107   while ( fNumCols < colNum ) {
00108     fColAttr.push_back(ColumnAttributes());
00109     ++fNumCols;
00110   }
00111 }

const DbiTableMetaData::ColumnAttributes & DbiTableMetaData::GetAttributes (  Int_t  colNum  )  const [private]
 

Return a column attributes (will be dummy entry if requesting invalid column).

Definition at line 115 of file DbiTableMetaData.cxx.

References fColAttr, fgDummy, and DbiTableMetaData::ColumnAttributes::SetDefault().

Referenced by SetAttributes().

00115                                                                                             {
00116 
00117 // Return a column attributes (will be dummy entry if requesting invalid column)
00118 
00119   if ( colNum > 0 && colNum <= (signed) fNumCols ) return fColAttr[colNum-1];
00120   fgDummy.SetDefault();
00121   return fgDummy;
00122 
00123 }

string DbiTableMetaData::GetToken (  const char *&  strPtr  )  [static, private]
 

Use to parse table creation SQL - move to UtilString?

Definition at line 127 of file DbiTableMetaData.cxx.

Referenced by SetFromSql().

00127                                                      {
00128 //
00129 //
00130 //  Purpose:  Skip spaces and return next token from string and move pointer on.
00131 
00132   string token;
00133 
00134 // Skip white space and quit if at EOS.
00135   while ( isspace(*strPtr) ) ++strPtr;
00136   if ( *strPtr == 0 ) return token;
00137 
00138 // Collect the first character whatever it is.
00139   char firstChar = *strPtr++;
00140   token = firstChar;
00141   if ( ! isalnum(firstChar) && firstChar != '_' ) return token;
00142 
00143 // Collect more if collecting alphanumeric + underscore string
00144   while ( isalnum(*strPtr) || *strPtr == '_' ) token += *strPtr++;
00145   return token;
00146 
00147 }

Bool_t DbiTableMetaData::HasRowCounter (   )  const [inline]
 

Definition at line 52 of file DbiTableMetaData.h.

Referenced by DbiTableProxyRegistry::HasRowCounter(), DbiDBProxy::QuerySeqNo(), DbiDBProxy::QuerySeqNos(), and DbiSqlValPacket::Store().

00052 {return  this->NumCols() >=2 && this->ColName(2) == "ROW_COUNTER"; }

UInt_t DbiTableMetaData::NumCols (   )  const [inline]
 

Definition at line 53 of file DbiTableMetaData.h.

Referenced by DbuDaqMonitorModule::CheckForRowCounterColumn(), DbuDaqMonitorModule::GetCommentFieldName(), DbiRowStream::NumCols(), and Sql().

00053 { return fNumCols;}

DbiTableMetaData::ColumnAttributes & DbiTableMetaData::SetAttributes (  Int_t  colNum  )  [private]
 

Return a setable column attributes (will be dummy entry if requesting invalid column).

Definition at line 151 of file DbiTableMetaData.cxx.

References ExpandTo(), and GetAttributes().

00151                                                                                {
00152 
00153 // Return a column attributes (will be dummy entry if requesting invalid column)
00154 
00155   this->ExpandTo(colNum);
00156   // Using const metho so must cast away constness.
00157   return const_cast<DbiTableMetaData::ColumnAttributes&>(this->GetAttributes(colNum));
00158 
00159 }

void DbiTableMetaData::SetColFieldType (  const DbiFieldType &  type,
Int_t  colNum
)  [protected]
 

Definition at line 164 of file DbiTableMetaData.cxx.

References DbiFieldType::GetConcept().

Referenced by SetFromSql(), and DbiDBProxy::StoreMetaData().

00165                                                      {
00166 //
00167 //
00168 //  Purpose:  Define field type for specified column.
00169 //
00170 //  Arguments: 
00171 //    fieldType    in    Column field type.
00172 //    colNum       in    Column number (1,2...)
00173 //
00174 
00175   ColumnAttributes&  attrib(this->SetAttributes(colNum));
00176   UInt_t concept     = fieldType.GetConcept();
00177   attrib.Type        = fieldType;
00178   attrib.MustDelimit = concept == Dbi::kString || concept == Dbi::kDate || concept == Dbi::kChar;
00179   attrib.Concept     = concept;
00180 
00181 }

void DbiTableMetaData::SetColIsNullable (  Int_t  colNum,
Bool_t  isNullable = true
)  [inline, protected]
 

Definition at line 74 of file DbiTableMetaData.h.

Referenced by SetFromSql(), and DbiDBProxy::StoreMetaData().

00074 { SetAttributes(colNum).IsNullable = isNullable;}

void DbiTableMetaData::SetColName (  const string &  name,
Int_t  colNum
)  [inline, protected]
 

Definition at line 75 of file DbiTableMetaData.h.

Referenced by SetFromSql(), and DbiDBProxy::StoreMetaData().

00075 { SetAttributes(colNum).Name = name;}

void DbiTableMetaData::SetFromSql (  const string &  sql  ) 
 

Recreate from SQL used to create table.

Definition at line 185 of file DbiTableMetaData.cxx.

References DbiFieldType::AsString(), Clear(), ColFieldType(), ColName(), fTableName, GetToken(), MSG, SetColFieldType(), SetColIsNullable(), and SetColName().

Referenced by DbiStatement::TranslateSQL().

00185                                                    {
00186 //
00187 //
00188 //  Purpose:  Reconstruct this object using SQL to create table.
00189 
00190 
00191   TString SqlUpper(sql);
00192   SqlUpper.ToUpper();
00193 
00194   const char* strPtr = SqlUpper.Data();
00195 
00196   string token1(DbiTableMetaData::GetToken(strPtr));
00197   string token2(DbiTableMetaData::GetToken(strPtr));
00198   string token3(DbiTableMetaData::GetToken(strPtr));
00199   string token4(DbiTableMetaData::GetToken(strPtr));
00200 
00201   if ( token1 != "CREATE" || token2 != "TABLE" || token4 != "(" ) {
00202     MSG("Dbi",Msg::kError) << "Cannot recreate: SQL " << SqlUpper 
00203                            << " does not start CREATE TABLE ... (" << endl;
00204     return;
00205   }
00206 
00207   this->Clear();
00208   fTableName = token3;
00209   MSG("Dbi",Msg::kSynopsis) << "Recreating  DbiTableMetaData for table " << fTableName << endl;
00210 
00211 // Loop processing column specifications.
00212   Int_t col = 0;
00213 
00214   string delim;
00215   while ( delim != ")" ) {
00216     string name = DbiTableMetaData::GetToken(strPtr);
00217 
00218 //  Deal with INDEX and PRIMARY KEY
00219     if ( name == "INDEX" ||  name == "KEY" || name == "PRIMARY" ) {
00220       if ( name == "PRIMARY" || name == "KEY" )delim = DbiTableMetaData::GetToken(strPtr);
00221       delim = DbiTableMetaData::GetToken(strPtr);
00222       if ( delim == "(" ) while ( delim != ")" ) delim = DbiTableMetaData::GetToken(strPtr);
00223       delim = DbiTableMetaData::GetToken(strPtr);
00224       continue;
00225     }
00226 
00227 //  Collect name and type.
00228     ++col;
00229     this->SetColName(name,col);
00230     this->SetColIsNullable(col);
00231 
00232     string type = DbiTableMetaData::GetToken(strPtr);
00233     int precision = 0;
00234     delim = DbiTableMetaData::GetToken(strPtr);
00235     if ( delim == "(" ) {
00236       delim = DbiTableMetaData::GetToken(strPtr);
00237       istringstream is(delim);
00238       is >> precision;
00239       delim = DbiTableMetaData::GetToken(strPtr);
00240       delim = DbiTableMetaData::GetToken(strPtr);
00241     }
00242     DbiFieldType ft(type,precision);
00243     this->SetColFieldType(ft,col);
00244     MSG("Dbi",Msg::kSynopsis) << "  Column: " << col << " name " << this->ColName(col) 
00245                           << " type " << this->ColFieldType(col).AsString() 
00246                           << " precision " << precision << endl;
00247 
00248 //  Collect optional qualifiers.
00249 
00250     while ( delim != ","  &&  delim != ")" ) {
00251       string opt2 = DbiTableMetaData::GetToken(strPtr);
00252       if ( delim == "NOT" && opt2 == "NULL") {
00253         this->SetColIsNullable(col,false);
00254         delim = DbiTableMetaData::GetToken(strPtr);
00255       }
00256       else if ( delim == "PRIMARY" && opt2 == "KEY") {
00257         delim = DbiTableMetaData::GetToken(strPtr);
00258       }
00259       else if ( delim == "AUTO_INCREMENT") {
00260         delim = opt2;
00261       }
00262       else if ( delim == "UNSIGNED") {
00263         delim = opt2;
00264       }
00265       else {
00266         MSG("Dbi",Msg::kWarning) <<"Column: " << col << " name " << name << " type " << ft.AsString()
00267                               << " ignoring unknown option: " << delim << endl;
00268         delim = opt2;
00269       }
00270     }
00271   }
00272 
00273 }

string DbiTableMetaData::Sql (  Dbi::DbTypes  dbType = Dbi::kMySQL  )  const
 

Return SQL string to create table.

Definition at line 278 of file DbiTableMetaData.cxx.

References DbiFieldType::AsSQLString(), ColFieldType(), ColIsNullable(), ColName(), fTableName, DbiString::GetString(), and NumCols().

Referenced by DbiSqlValPacket::SetMetaData(), and DbiStatement::TranslateSQL().

00278                                                            {
00279 //
00280 //
00281 //  Purpose:  Return SQL string to create table.
00282 //
00283 //  Arguments: 
00284 //    dbType_target  in    The target database type (either  kMySQL or kOracle)
00285 //    
00286 //
00287 //  Return:    SQL command to create required table.
00288 //             For an ORACLE target DB, there will be multiple semi-colon separated
00289 //             commands within the string.
00290 
00291   Bool_t mainTable = fTableName.substr(fTableName.size()-3,3) != "VLD";
00292   bool hasRowCounter = false;
00293 
00294   string tableName = fTableName;
00295   DbiString sql;
00296   sql.GetString() = "";
00297   sql << "create table " << tableName << "(";
00298 
00299 
00300 //  Assemble columns.
00301 
00302   int numCols = this->NumCols();
00303   for(int i=1; i<= numCols; i++) {
00304 
00305     if ( this->ColName(i) == "ROW_COUNTER" ) hasRowCounter = true;
00306     sql << this->ColName(i) << " " ;
00307     sql << this->ColFieldType(i).AsSQLString(dbType_target);
00308 
00309     if(    dbType_target == Dbi::kMySQL
00310         && this->ColName(i) == "SEQNO" 
00311         && ! mainTable )          sql << " not null primary key" ;
00312 
00313     else if( ! this->ColIsNullable(i)
00314             || this->ColName(i) == "SEQNO"
00315             || this->ColName(i) == "ROW_COUNTER"
00316            ) sql << " not null" ;
00317       
00318     if (i < numCols)              sql << ", ";
00319 
00320   }
00321 
00322 // Deal with key/index/constraint.
00323 
00324 // Nothing to do for the special xxxSEQNO tables.
00325   if ( fTableName == "GLOBALSEQNO" ||  fTableName == "LOCALSEQNO" ) {
00326     sql << ")";
00327   }
00328 
00329 // Deal with MySQL
00330   else if (dbType_target == Dbi::kMySQL ) {
00331     if ( mainTable ) {
00332       if ( hasRowCounter )  sql << ", primary key (SEQNO,ROW_COUNTER)";
00333       else                  sql << ", index (SEQNO)";
00334     }
00335     else {
00336       sql << ", key TIMESTART (TIMESTART), key TIMEEND (TIMEEND)";
00337     }
00338     sql << ")"; 
00339   }
00340 
00341 // Deal with ORACLE 
00342   else {
00343     if ( mainTable ) {
00344       sql << ", constraint FK_" << fTableName << " foreign key(SEQNO) references "
00345           << fTableName << "VLD(SEQNO)";
00346       if ( hasRowCounter ) 
00347         sql << ", constraint PK_" << fTableName 
00348             << "VLD primary key(SEQNO,ROW_COUNTER) using index tablespace MINOS_DEV_IDX";
00349     }
00350     else {
00351       sql << ", constraint PK_" << fTableName 
00352           << "VLD primary key(SEQNO) using index tablespace MINOS_DEV_IDX";
00353     }
00354     sql << ")tablespace MINOS_DEV_DATA";
00355 
00356     if ( mainTable) {
00357       if ( ! hasRowCounter ) 
00358         sql << "; create index " << tableName << "_idx  on " 
00359             << tableName << "(seqno) tablespace MINOS_DEV_IDX";
00360       sql << "; create index " << fTableName << "VLD_idx2 on " 
00361           << fTableName << "VLD(TIMESTART) tablespace MINOS_DEV_IDX";
00362       sql << "; create index " << fTableName << "VLD_idx3 on " 
00363           << fTableName << "VLD(TIMEEND) tablespace MINOS_DEV_IDX";
00364     }
00365     else {
00366 
00367     }
00368   }
00369 
00370 // For ORACLE, create public synonym and grant access.
00371 
00372   if ( dbType_target == Dbi::kOracle ) {
00373     sql << "; create public synonym " << tableName << " for " << tableName;
00374     sql << "; grant  select on " << tableName << " to minos_reader";
00375     sql << "; grant  select,insert,update on " << tableName << " to minos_writer";
00376   }
00377 
00378   return sql.GetString();
00379 
00380 }

string DbiTableMetaData::TableName (   )  const [inline]
 

Definition at line 51 of file DbiTableMetaData.h.

Referenced by DbiDBProxy::StoreMetaData(), DbiRowStream::TableName(), and DbiRowStream::TableNameTc().

00051 { return fTableName; }

Friends And Related Function Documentation

friend class DbiDBProxy [friend]
 

Definition at line 38 of file DbiTableMetaData.h.

Member Data Documentation

std::vector<ColumnAttributes> DbiTableMetaData::fColAttr [private]
 

Column attributes indexed by column (starting from 0).

Definition at line 118 of file DbiTableMetaData.h.

Referenced by Clear(), ExpandTo(), and GetAttributes().

DbiTableMetaData::ColumnAttributes DbiTableMetaData::fgDummy [static, private]
 

Dummy attributes (used when requesting invalid column).

Definition at line 26 of file DbiTableMetaData.cxx.

Referenced by GetAttributes().

UInt_t DbiTableMetaData::fNumCols [private]
 

Number of columns.

Definition at line 121 of file DbiTableMetaData.h.

Referenced by Clear(), and ExpandTo().

string DbiTableMetaData::fTableName [private]
 

Table name (either XXX or XXXVLD).

Definition at line 124 of file DbiTableMetaData.h.

Referenced by SetFromSql(), and Sql().

The documentation for this class was generated from the following files:
Generated on Mon Feb 15 11:09:04 2010 for loon by  doxygen 1.3.9.1