DbiTableMetaData.cxx

Go to the documentation of this file.

#include <cassert>
#include <cctype>
#include <sstream>

#include "TString.h"

#include "DatabaseInterface/Dbi.h"
#include "DatabaseInterface/DbiString.h"
#include "DatabaseInterface/DbiTableMetaData.h"
#include "LeakChecker/Lea.h"
#include "MessageService/MsgService.h"

ClassImp(DbiTableMetaData)

//   Definition of static data members
//   *********************************

CVSID("$Id: DbiTableMetaData.cxx,v 1.20 2007/04/26 14:19:57 west Exp $");

DbiTableMetaData::ColumnAttributes DbiTableMetaData::fgDummy;

//    Definition of all member functions (static or otherwise)
//    *******************************************************
//
//    -  ordered: ctors, dtor, operators then in alphabetical order.

//.....................................................................

DbiTableMetaData::DbiTableMetaData(const string& tableName) :
fNumCols(0),
fTableName(tableName)
{
//
//
//  Purpose:  Default constructor

//  Program Notes:-
//  =============

//  This is filled by the owning DbiTableProxy, as it is too low level to
//  use the cascade to fill itself, hence the friend status granted to DbiDBProxy. 

  LEA_CTOR    //Leak Checker

  MSG("Dbi", Msg::kVerbose) << "Creating DbiTableMetaData" << endl;

}

//.....................................................................

DbiTableMetaData::~DbiTableMetaData() {
//
//
//  Purpose: Destructor

  LEA_DTOR    //Leak Checker

  MSG("Dbi", Msg::kVerbose) << "Destroying DbiTableMetaData" << endl;

}


void DbiTableMetaData::Clear() {
//
//
//  Purpose: Clear out existing data (apart from table name)
//
//  Contact:   N. West

  fColAttr.clear();
  fNumCols = 0;

}

//.....................................................................

void DbiTableMetaData::ExpandTo(UInt_t colNum) {
//
//
//  Purpose: Expand table if required to specied colNum 
//
//  Arguments: 
//    colNum       in    Column number to expand to (1,2...).
//
//  Return:    
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o 

//  Program Notes:-
//  =============

//  None.

  assert ( colNum < MAXCOL );
  while ( fNumCols < colNum ) {
    fColAttr.push_back(ColumnAttributes());
    ++fNumCols;
  }
}

//.....................................................................

const  DbiTableMetaData::ColumnAttributes&  DbiTableMetaData::GetAttributes(Int_t colNum) const {

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

  if ( colNum > 0 && colNum <= (signed) fNumCols ) return fColAttr[colNum-1];
  fgDummy.SetDefault();
  return fgDummy;

}

//.....................................................................

string DbiTableMetaData::GetToken(const char*& strPtr) {
//
//
//  Purpose:  Skip spaces and return next token from string and move pointer on.

  string token;

// Skip white space and quit if at EOS.
  while ( isspace(*strPtr) ) ++strPtr;
  if ( *strPtr == 0 ) return token;

// Collect the first character whatever it is.
  char firstChar = *strPtr++;
  token = firstChar;
  if ( ! isalnum(firstChar) && firstChar != '_' ) return token;

// Collect more if collecting alphanumeric + underscore string
  while ( isalnum(*strPtr) || *strPtr == '_' ) token += *strPtr++;
  return token;

}
 
//.....................................................................

 DbiTableMetaData::ColumnAttributes& DbiTableMetaData::SetAttributes(Int_t colNum) {

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

  this->ExpandTo(colNum);
  // Using const metho so must cast away constness.
  return const_cast<DbiTableMetaData::ColumnAttributes&>(this->GetAttributes(colNum));

}


//.....................................................................

void DbiTableMetaData::SetColFieldType(const DbiFieldType& fieldType,
                                       Int_t colNum) {
//
//
//  Purpose:  Define field type for specified column.
//
//  Arguments: 
//    fieldType    in    Column field type.
//    colNum       in    Column number (1,2...)
//

  ColumnAttributes&  attrib(this->SetAttributes(colNum));
  UInt_t concept     = fieldType.GetConcept();
  attrib.Type        = fieldType;
  attrib.MustDelimit = concept == Dbi::kString || concept == Dbi::kDate || concept == Dbi::kChar;
  attrib.Concept     = concept;

}

//.....................................................................

void DbiTableMetaData::SetFromSql(const string& sql) {
//
//
//  Purpose:  Reconstruct this object using SQL to create table.


  TString SqlUpper(sql);
  SqlUpper.ToUpper();

  const char* strPtr = SqlUpper.Data();

  string token1(DbiTableMetaData::GetToken(strPtr));
  string token2(DbiTableMetaData::GetToken(strPtr));
  string token3(DbiTableMetaData::GetToken(strPtr));
  string token4(DbiTableMetaData::GetToken(strPtr));

  if ( token1 != "CREATE" || token2 != "TABLE" || token4 != "(" ) {
    MSG("Dbi",Msg::kError) << "Cannot recreate: SQL " << SqlUpper 
                           << " does not start CREATE TABLE ... (" << endl;
    return;
  }

  this->Clear();
  fTableName = token3;
  MSG("Dbi",Msg::kSynopsis) << "Recreating  DbiTableMetaData for table " << fTableName << endl;

// Loop processing column specifications.
  Int_t col = 0;

  string delim;
  while ( delim != ")" ) {
    string name = DbiTableMetaData::GetToken(strPtr);

//  Deal with INDEX and PRIMARY KEY
    if ( name == "INDEX" ||  name == "KEY" || name == "PRIMARY" ) {
      if ( name == "PRIMARY" || name == "KEY" )delim = DbiTableMetaData::GetToken(strPtr);
      delim = DbiTableMetaData::GetToken(strPtr);
      if ( delim == "(" ) while ( delim != ")" ) delim = DbiTableMetaData::GetToken(strPtr);
      delim = DbiTableMetaData::GetToken(strPtr);
      continue;
    }

//  Collect name and type.
    ++col;
    this->SetColName(name,col);
    this->SetColIsNullable(col);

    string type = DbiTableMetaData::GetToken(strPtr);
    int precision = 0;
    delim = DbiTableMetaData::GetToken(strPtr);
    if ( delim == "(" ) {
      delim = DbiTableMetaData::GetToken(strPtr);
      istringstream is(delim);
      is >> precision;
      delim = DbiTableMetaData::GetToken(strPtr);
      delim = DbiTableMetaData::GetToken(strPtr);
    }
    DbiFieldType ft(type,precision);
    this->SetColFieldType(ft,col);
    MSG("Dbi",Msg::kSynopsis) << "  Column: " << col << " name " << this->ColName(col) 
                          << " type " << this->ColFieldType(col).AsString() 
                          << " precision " << precision << endl;

//  Collect optional qualifiers.

    while ( delim != ","  &&  delim != ")" ) {
      string opt2 = DbiTableMetaData::GetToken(strPtr);
      if ( delim == "NOT" && opt2 == "NULL") {
        this->SetColIsNullable(col,false);
        delim = DbiTableMetaData::GetToken(strPtr);
      }
      else if ( delim == "PRIMARY" && opt2 == "KEY") {
        delim = DbiTableMetaData::GetToken(strPtr);
      }
      else if ( delim == "AUTO_INCREMENT") {
        delim = opt2;
      }
      else if ( delim == "UNSIGNED") {
        delim = opt2;
      }
      else {
        MSG("Dbi",Msg::kWarning) <<"Column: " << col << " name " << name << " type " << ft.AsString()
                              << " ignoring unknown option: " << delim << endl;
        delim = opt2;
      }
    }
  }

}


//.....................................................................

string DbiTableMetaData::Sql(Dbi::DbTypes dbType_target) const {
//
//
//  Purpose:  Return SQL string to create table.
//
//  Arguments: 
//    dbType_target  in    The target database type (either  kMySQL or kOracle)
//    
//
//  Return:    SQL command to create required table.
//             For an ORACLE target DB, there will be multiple semi-colon separated
//             commands within the string.

  Bool_t mainTable = fTableName.substr(fTableName.size()-3,3) != "VLD";
  bool hasRowCounter = false;

  string tableName = fTableName;
  DbiString sql;
  sql.GetString() = "";
  sql << "create table " << tableName << "(";


//  Assemble columns.

  int numCols = this->NumCols();
  for(int i=1; i<= numCols; i++) {

    if ( this->ColName(i) == "ROW_COUNTER" ) hasRowCounter = true;
    sql << this->ColName(i) << " " ;
    sql << this->ColFieldType(i).AsSQLString(dbType_target);

    if(    dbType_target == Dbi::kMySQL
        && this->ColName(i) == "SEQNO" 
        && ! mainTable )          sql << " not null primary key" ;

    else if( ! this->ColIsNullable(i)
            || this->ColName(i) == "SEQNO"
            || this->ColName(i) == "ROW_COUNTER"
           ) sql << " not null" ;
      
    if (i < numCols)              sql << ", ";

  }

// Deal with key/index/constraint.

// Nothing to do for the special xxxSEQNO tables.
  if ( fTableName == "GLOBALSEQNO" ||  fTableName == "LOCALSEQNO" ) {
    sql << ")";
  }

// Deal with MySQL
  else if (dbType_target == Dbi::kMySQL ) {
    if ( mainTable ) {
      if ( hasRowCounter )  sql << ", primary key (SEQNO,ROW_COUNTER)";
      else                  sql << ", index (SEQNO)";
    }
    else {
      sql << ", key TIMESTART (TIMESTART), key TIMEEND (TIMEEND)";
    }
    sql << ")"; 
  }

// Deal with ORACLE 
  else {
    if ( mainTable ) {
      sql << ", constraint FK_" << fTableName << " foreign key(SEQNO) references "
          << fTableName << "VLD(SEQNO)";
      if ( hasRowCounter ) 
        sql << ", constraint PK_" << fTableName 
            << "VLD primary key(SEQNO,ROW_COUNTER) using index tablespace MINOS_DEV_IDX";
    }
    else {
      sql << ", constraint PK_" << fTableName 
          << "VLD primary key(SEQNO) using index tablespace MINOS_DEV_IDX";
    }
    sql << ")tablespace MINOS_DEV_DATA";

    if ( mainTable) {
      if ( ! hasRowCounter ) 
        sql << "; create index " << tableName << "_idx  on " 
            << tableName << "(seqno) tablespace MINOS_DEV_IDX";
      sql << "; create index " << fTableName << "VLD_idx2 on " 
          << fTableName << "VLD(TIMESTART) tablespace MINOS_DEV_IDX";
      sql << "; create index " << fTableName << "VLD_idx3 on " 
          << fTableName << "VLD(TIMEEND) tablespace MINOS_DEV_IDX";
    }
    else {

    }
  }

// For ORACLE, create public synonym and grant access.

  if ( dbType_target == Dbi::kOracle ) {
    sql << "; create public synonym " << tableName << " for " << tableName;
    sql << "; grant  select on " << tableName << " to minos_reader";
    sql << "; grant  select,insert,update on " << tableName << " to minos_writer";
  }

  return sql.GetString();

}

---