TDbiTableMetaData Class Reference

Concept Table meta data i.e. data about the table itself More...

#include <TDbiTableMetaData.hxx>

Collaboration diagram for TDbiTableMetaData:

[legend]

List of all members.

Classes
struct	ColumnAttributes
	Column attributes. More...
Public Member Functions
	TDbiTableMetaData (const string &tableName="Unknown")
virtual	~TDbiTableMetaData ()
string	Sql () const
	Return SQL string to create table.
string	TableName () const
Bool_t	HasEpoch () const
UInt_t	NumCols () const
const TDbiFieldType &	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 TDbiFieldType &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
static 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
static ColumnAttributes	fgDummy
	Dummy attributes (used when requesting invalid column).
Friends
class	TDbiDBProxy

---

Detailed Description

Concept Table meta data i.e. data about the table itself

Id

TDbiTableMetaData.hxx,v 1.1 2011/01/18 05:49:20 finch Exp

Purpose To provide information on the names and types of columns Contact: A.Finch@lancaster.ac.uk to transient TDbiRowStream objects.

Definition at line 35 of file TDbiTableMetaData.hxx.

---

Member Enumeration Documentation

anonymous enum [private]

Sanity check: limit number of columns.

Enumerator:

MAXCOL

Definition at line 84 of file TDbiTableMetaData.hxx.

{ MAXCOL = 1000};

---

Constructor & Destructor Documentation

TDbiTableMetaData::TDbiTableMetaData

(

const string &

tableName = "Unknown"

)

TDbiTableMetaData::~TDbiTableMetaData

(

)

[virtual]

Definition at line 56 of file TDbiTableMetaData.cxx.

References SK_DBI_Trace.

                                      {
//
//
//  Purpose: Destructor


  SK_DBI_Trace( "Destroying TDbiTableMetaData" << "  ");

}

---

Member Function Documentation

void TDbiTableMetaData::Clear

(

)

[protected]

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

Definition at line 68 of file TDbiTableMetaData.cxx.

References fColAttr, and fNumCols.

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

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

  fColAttr.clear();
  fNumCols = 0;

}

Here is the caller graph for this function:

UInt_t TDbiTableMetaData::ColFieldConcept

(

Int_t

colNum

)

const [inline]

Definition at line 58 of file TDbiTableMetaData.hxx.

References TDbiTableMetaData::ColumnAttributes::Concept, and GetAttributes().

Referenced by TDbiInRowStream::RowAsCsv().

{ return GetAttributes(colNum).Concept;}

Here is the call graph for this function:

Here is the caller graph for this function:

const TDbiFieldType& TDbiTableMetaData::ColFieldType

(

Int_t

colNum

)

const [inline]

Definition at line 57 of file TDbiTableMetaData.hxx.

References GetAttributes(), and TDbiTableMetaData::ColumnAttributes::Type.

Referenced by TDbiInRowStream::AsString(), TDbiRowStream::ColFieldType(), TDbiRowStream::CurColFieldType(), TDbiInRowStream::RowAsCsv(), SetFromSql(), and Sql().

{ return GetAttributes(colNum).Type;}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t TDbiTableMetaData::ColIsNullable

(

Int_t

colNum

)

const [inline]

Definition at line 59 of file TDbiTableMetaData.hxx.

References GetAttributes(), and TDbiTableMetaData::ColumnAttributes::IsNullable.

Referenced by Sql().

{ return GetAttributes(colNum).IsNullable;}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t TDbiTableMetaData::ColMustDelimit

(

Int_t

colNum

)

const [inline]

Definition at line 60 of file TDbiTableMetaData.hxx.

References GetAttributes(), and TDbiTableMetaData::ColumnAttributes::MustDelimit.

Referenced by TDbiInRowStream::RowAsCsv().

{ return GetAttributes(colNum).MustDelimit;}

Here is the call graph for this function:

Here is the caller graph for this function:

string TDbiTableMetaData::ColName

(

Int_t

colNum

)

const [inline]

Definition at line 61 of file TDbiTableMetaData.hxx.

References GetAttributes(), and TDbiTableMetaData::ColumnAttributes::Name.

Referenced by TDbiRowStream::ColName(), TDbiRowStream::CurColName(), HasEpoch(), SetFromSql(), and Sql().

{ return GetAttributes(colNum).Name;}

Here is the call graph for this function:

Here is the caller graph for this function:

void TDbiTableMetaData::ExpandTo

(

UInt_t

colNum

)

[private]

Definition at line 82 of file TDbiTableMetaData.cxx.

References fColAttr, fNumCols, and MAXCOL.

Referenced by SetAttributes().

                                              {
//
//
//  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;
  }
}

Here is the caller graph for this function:

const TDbiTableMetaData::ColumnAttributes & TDbiTableMetaData::GetAttributes

(

Int_t

colNum

)

const [private]

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

Definition at line 113 of file TDbiTableMetaData.cxx.

References fColAttr, fgDummy, fNumCols, and TDbiTableMetaData::ColumnAttributes::SetDefault().

Referenced by ColFieldConcept(), ColFieldType(), ColIsNullable(), ColMustDelimit(), ColName(), and SetAttributes().

                                                                                              {

// 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;

}

Here is the call graph for this function:

Here is the caller graph for this function:

string TDbiTableMetaData::GetToken

(

const char *&

strPtr

)

[static, private]

Use to parse table creation SQL - move to UtilString?

Definition at line 125 of file TDbiTableMetaData.cxx.

Referenced by SetFromSql().

                                                      {
//
//
//  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;

}

Here is the caller graph for this function:

Bool_t TDbiTableMetaData::HasEpoch

(

)

const [inline]

Definition at line 52 of file TDbiTableMetaData.hxx.

References ColName(), and NumCols().

Referenced by TDbiRowStream::HasEpoch(), and TDbiDBProxy::HasEpoch().

{return  this->NumCols() >=4 && this->ColName(4) == "EPOCH"; }

Here is the call graph for this function:

Here is the caller graph for this function:

UInt_t TDbiTableMetaData::NumCols

(

)

const [inline]

Definition at line 53 of file TDbiTableMetaData.hxx.

References fNumCols.

Referenced by HasEpoch(), TDbiRowStream::NumCols(), and Sql().

{ return fNumCols;}

Here is the caller graph for this function:

TDbiTableMetaData::ColumnAttributes & TDbiTableMetaData::SetAttributes

(

Int_t

colNum

)

[private]

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

Definition at line 149 of file TDbiTableMetaData.cxx.

References ExpandTo(), and GetAttributes().

Referenced by SetColFieldType(), SetColIsNullable(), and SetColName().

                                                                                 {

// 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<TDbiTableMetaData::ColumnAttributes&>(this->GetAttributes(colNum));

}

Here is the call graph for this function:

Here is the caller graph for this function:

void TDbiTableMetaData::SetColFieldType	(	const TDbiFieldType &	type,
		Int_t	colNum
	)			[protected]

Definition at line 162 of file TDbiTableMetaData.cxx.

References TDbiTableMetaData::ColumnAttributes::Concept, TDbiFieldType::GetConcept(), TDbi::kChar, TDbi::kDate, TDbi::kString, TDbiTableMetaData::ColumnAttributes::MustDelimit, SetAttributes(), and TDbiTableMetaData::ColumnAttributes::Type.

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

                                                     {
//
//
//  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 == TDbi::kString || concept == TDbi::kDate || concept == TDbi::kChar;
  attrib.Concept     = concept;

}

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 74 of file TDbiTableMetaData.hxx.

References TDbiTableMetaData::ColumnAttributes::IsNullable, and SetAttributes().

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

{ SetAttributes(colNum).IsNullable = isNullable;}

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 75 of file TDbiTableMetaData.hxx.

References TDbiTableMetaData::ColumnAttributes::Name, and SetAttributes().

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

{ SetAttributes(colNum).Name = name;}

Here is the call graph for this function:

Here is the caller graph for this function:

void TDbiTableMetaData::SetFromSql

(

const string &

sql

)

Recreate from SQL used to create table.

Definition at line 183 of file TDbiTableMetaData.cxx.

References TDbiFieldType::AsString(), DbiDetector::AsString(), Clear(), ColFieldType(), ColName(), fTableName, GetToken(), SetColFieldType(), SetColIsNullable(), SetColName(), SK_DBI_Log, SK_DBI_Severe, and SK_DBI_Warn.

                                                    {
//
//
//  Purpose:  Reconstruct this object using SQL to create table.


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

  const char* strPtr = SqlUpper.Data();

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

  if ( token1 != "CREATE" || token2 != "TABLE" || token4 != "(" ) {
    SK_DBI_Severe( "Cannot recreate: SQL " << SqlUpper
                           << " does not start CREATE TABLE ... (" << "  ");
    return;
  }

  this->Clear();
  fTableName = token3;
  SK_DBI_Log( "Recreating  TDbiTableMetaData for table " << fTableName << "  ");

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

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

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

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

    string type = TDbiTableMetaData::GetToken(strPtr);
    int precision = 0;
    delim = TDbiTableMetaData::GetToken(strPtr);
    if ( delim == "(" ) {
      delim = TDbiTableMetaData::GetToken(strPtr);
      istringstream is(delim);
      is >> precision;
      delim = TDbiTableMetaData::GetToken(strPtr);
      delim = TDbiTableMetaData::GetToken(strPtr);
    }
    TDbiFieldType ft(type,precision);
    this->SetColFieldType(ft,col);
    SK_DBI_Log( "  Column: " << col << " name " << this->ColName(col)
                          << " type " << this->ColFieldType(col).AsString()
                          << " precision " << precision << "  ");

//  Collect optional qualifiers.

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

}

Here is the call graph for this function:

string TDbiTableMetaData::Sql

(

)

const

Return SQL string to create table.

Definition at line 276 of file TDbiTableMetaData.cxx.

References TDbiFieldType::AsSQLString(), ColFieldType(), ColIsNullable(), ColName(), fTableName, TDbiString::GetString(), and NumCols().

Referenced by TDbiSqlValPacket::SetMetaData().

                                    {
//
//
//  Purpose:  Return SQL string to create table.
//
//  Return:    SQL command to create required table.

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

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


//  Assemble columns.

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

    sql << this->ColName(i) << " " ;
    sql << this->ColFieldType(i).AsSQLString();

    if(    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 << ")";
  }

  else {
   if ( mainTable ) {
      sql << ", primary key (SEQNO,ROW_COUNTER)";
    }
    else {
      sql << ", key TIMESTART (TIMESTART), key TIMEEND (TIMEEND)";
    }
    sql << ")";
  }

  return sql.GetString();

}

Here is the call graph for this function:

Here is the caller graph for this function:

string TDbiTableMetaData::TableName

(

)

const [inline]

Definition at line 51 of file TDbiTableMetaData.hxx.

References fTableName.

Referenced by TDbiDBProxy::StoreMetaData(), TDbiRowStream::TableName(), and TDbiRowStream::TableNameTc().

{ return fTableName; }

Here is the caller graph for this function:

---

Friends And Related Function Documentation

friend class TDbiDBProxy [friend]

Definition at line 38 of file TDbiTableMetaData.hxx.

---

Member Data Documentation

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

Column attributes indexed by column (starting from 0).

Definition at line 118 of file TDbiTableMetaData.hxx.

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

ColumnAttributes TDbiTableMetaData::fgDummy [static, private]

Dummy attributes (used when requesting invalid column).

Definition at line 106 of file TDbiTableMetaData.hxx.

Referenced by GetAttributes().

UInt_t TDbiTableMetaData::fNumCols [private]

Number of columns.

Definition at line 121 of file TDbiTableMetaData.hxx.

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

string TDbiTableMetaData::fTableName [private]

Table name (either XXX or XXXVLD).

Definition at line 124 of file TDbiTableMetaData.hxx.

Referenced by SetFromSql(), Sql(), and TableName().

---

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

• src/TDbiTableMetaData.hxx
• src/TDbiTableMetaData.cxx