Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TSQLServer Class Referenceabstract

Definition at line 41 of file TSQLServer.h.

Public Types

enum  ESQLDataTypes {
  kSQL_NONE = -1 , kSQL_CHAR = 1 , kSQL_VARCHAR = 2 , kSQL_INTEGER = 3 ,
  kSQL_FLOAT = 4 , kSQL_DOUBLE = 5 , kSQL_NUMERIC = 6 , kSQL_BINARY = 7 ,
  kSQL_TIMESTAMP = 8
}
 printf argument for floats and doubles, either "%f" or "%e" or "%10f" and so on More...
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 

Public Member Functions

virtual ~TSQLServer ()
 
virtual void Close (Option_t *option="")=0
 
virtual Bool_t Commit ()
 submit "COMMIT" query to database return kTRUE, if successful
 
virtual Int_t CreateDataBase (const char *dbname)=0
 
virtual Int_t DropDataBase (const char *dbname)=0
 
virtual void EnableErrorOutput (Bool_t on=kTRUE)
 
virtual Bool_t Exec (const char *sql)
 Execute sql query.
 
virtual TSQLResultGetColumns (const char *dbname, const char *table, const char *wild=nullptr)=0
 
virtual TSQLResultGetDataBases (const char *wild=nullptr)=0
 
const char * GetDB () const
 
const char * GetDBMS () const
 
virtual Int_t GetErrorCode () const
 returns error code of last operation if res==0, no error Each specific implementation of TSQLServer provides its own error coding
 
virtual const char * GetErrorMsg () const
 returns error message of last operation if no errors, return 0 Each specific implementation of TSQLServer provides its own error messages
 
const char * GetHost () const
 
virtual Int_t GetMaxIdentifierLength ()
 
Int_t GetPort () const
 
virtual TSQLTableInfoGetTableInfo (const char *tablename)
 Produce TSQLTableInfo object, which contain info about table itself and each table column Object must be deleted by user.
 
virtual TSQLResultGetTables (const char *dbname, const char *wild=nullptr)=0
 
virtual TListGetTablesList (const char *wild=nullptr)
 Return list of user tables Parameter wild specifies wildcard for table names.
 
virtual Bool_t HasStatement () const
 
virtual Bool_t HasTable (const char *tablename)
 Tests if table of that name exists in database Return kTRUE, if table exists.
 
virtual Bool_t HasTransactionInFlight ()
 returns kTRUE when transaction is running Must be implemented in derived classes
 
TClassIsA () const override
 
virtual Bool_t IsConnected () const
 
virtual Bool_t IsError () const
 
virtual Int_t Ping ()
 
virtual Bool_t PingVerify ()
 
virtual TSQLResultQuery (const char *sql)=0
 
virtual Int_t Reload ()=0
 
virtual Bool_t Rollback ()
 submit "ROLLBACK" query to database return kTRUE, if successful
 
virtual Int_t SelectDataBase (const char *dbname)=0
 
virtual const char * ServerInfo ()=0
 
virtual Int_t Shutdown ()=0
 
virtual Bool_t StartTransaction ()
 submit "START TRANSACTION" query to database return kTRUE, if successful
 
virtual TSQLStatementStatement (const char *, Int_t=100)
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
 
virtual void Copy (TObject &object) const
 Copy this to obj.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual const char * GetName () const
 Returns name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object.
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout.
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static TSQLServerConnect (const char *db, const char *uid, const char *pw)
 The db should be of the form: <dbms>://<host>[:<port>][/<database>], e.g.: mysql://pcroot.cern.ch:3456/test, oracle://srv1.cern.ch/main, pgsql://... or sqlite://<database>... The uid is the username and pw the password that should be used for the connection.
 
static const char * DeclFileName ()
 
static const char * GetFloatFormat ()
 return current printf format for float/double members, default "%e"
 
static void SetFloatFormat (const char *fmt="%e")
 set printf format for float/double members, default "%e"
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

Protected Member Functions

 TSQLServer ()
 
void ClearError ()
 reset error fields
 
void SetError (Int_t code, const char *msg, const char *method=nullptr)
 set new values for error fields if method is specified, displays error message
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void MakeZombie ()
 

Protected Attributes

TString fDB
 
Int_t fErrorCode {0}
 
TString fErrorMsg
 
Bool_t fErrorOut {kTRUE}
 
TString fHost
 
Int_t fPort {-1}
 
TString fType
 

Static Protected Attributes

static const char * fgFloatFmt = "%e"
 

Additional Inherited Members

- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 

#include <TSQLServer.h>

Inheritance diagram for TSQLServer:
[legend]

Member Enumeration Documentation

◆ ESQLDataTypes

printf argument for floats and doubles, either "%f" or "%e" or "%10f" and so on

Enumerator
kSQL_NONE 
kSQL_CHAR 
kSQL_VARCHAR 
kSQL_INTEGER 
kSQL_FLOAT 
kSQL_DOUBLE 
kSQL_NUMERIC 
kSQL_BINARY 
kSQL_TIMESTAMP 

Definition at line 60 of file TSQLServer.h.

Constructor & Destructor Documentation

◆ TSQLServer()

TSQLServer::TSQLServer ( )
inlineprotected

Definition at line 52 of file TSQLServer.h.

◆ ~TSQLServer()

virtual TSQLServer::~TSQLServer ( )
inlinevirtual

Definition at line 72 of file TSQLServer.h.

Member Function Documentation

◆ Class()

static TClass * TSQLServer::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TSQLServer::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TSQLServer::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 117 of file TSQLServer.h.

◆ ClearError()

void TSQLServer::ClearError ( )
protected

reset error fields

Definition at line 119 of file TSQLServer.cxx.

◆ Close()

virtual void TSQLServer::Close ( Option_t option = "")
pure virtual

◆ Commit()

Bool_t TSQLServer::Commit ( )
virtual

submit "COMMIT" query to database return kTRUE, if successful

Reimplemented in TMySQLServer, TODBCServer, and TSQLiteServer.

Definition at line 160 of file TSQLServer.cxx.

◆ Connect()

TSQLServer * TSQLServer::Connect ( const char *  db,
const char *  uid,
const char *  pw 
)
static

The db should be of the form: <dbms>://<host>[:<port>][/<database>], e.g.: mysql://pcroot.cern.ch:3456/test, oracle://srv1.cern.ch/main, pgsql://... or sqlite://<database>... The uid is the username and pw the password that should be used for the connection.

Depending on the <dbms> the shared library (plugin) for the selected system will be loaded. When the connection could not be opened 0 is returned.

Definition at line 61 of file TSQLServer.cxx.

◆ CreateDataBase()

virtual Int_t TSQLServer::CreateDataBase ( const char *  dbname)
pure virtual

◆ DeclFileName()

static const char * TSQLServer::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 117 of file TSQLServer.h.

◆ DropDataBase()

virtual Int_t TSQLServer::DropDataBase ( const char *  dbname)
pure virtual

◆ EnableErrorOutput()

virtual void TSQLServer::EnableErrorOutput ( Bool_t  on = kTRUE)
inlinevirtual

Definition at line 102 of file TSQLServer.h.

◆ Exec()

Bool_t TSQLServer::Exec ( const char *  sql)
virtual

Execute sql query.

Useful for commands like DROP TABLE or INSERT, where result set is not interested. Return kTRUE if no error

Reimplemented in TMySQLServer, TODBCServer, and TSQLiteServer.

Definition at line 85 of file TSQLServer.cxx.

◆ GetColumns()

virtual TSQLResult * TSQLServer::GetColumns ( const char *  dbname,
const char *  table,
const char *  wild = nullptr 
)
pure virtual

◆ GetDataBases()

virtual TSQLResult * TSQLServer::GetDataBases ( const char *  wild = nullptr)
pure virtual

◆ GetDB()

const char * TSQLServer::GetDB ( ) const
inline

Definition at line 95 of file TSQLServer.h.

◆ GetDBMS()

const char * TSQLServer::GetDBMS ( ) const
inline

Definition at line 94 of file TSQLServer.h.

◆ GetErrorCode()

Int_t TSQLServer::GetErrorCode ( ) const
virtual

returns error code of last operation if res==0, no error Each specific implementation of TSQLServer provides its own error coding

Definition at line 101 of file TSQLServer.cxx.

◆ GetErrorMsg()

const char * TSQLServer::GetErrorMsg ( ) const
virtual

returns error message of last operation if no errors, return 0 Each specific implementation of TSQLServer provides its own error messages

Definition at line 111 of file TSQLServer.cxx.

◆ GetFloatFormat()

const char * TSQLServer::GetFloatFormat ( )
static

return current printf format for float/double members, default "%e"

Definition at line 279 of file TSQLServer.cxx.

◆ GetHost()

const char * TSQLServer::GetHost ( ) const
inline

Definition at line 96 of file TSQLServer.h.

◆ GetMaxIdentifierLength()

virtual Int_t TSQLServer::GetMaxIdentifierLength ( )
inlinevirtual

Reimplemented in TMySQLServer, and TODBCServer.

Definition at line 87 of file TSQLServer.h.

◆ GetPort()

Int_t TSQLServer::GetPort ( ) const
inline

Definition at line 97 of file TSQLServer.h.

◆ GetTableInfo()

TSQLTableInfo * TSQLServer::GetTableInfo ( const char *  tablename)
virtual

Produce TSQLTableInfo object, which contain info about table itself and each table column Object must be deleted by user.

Reimplemented in TMySQLServer, TODBCServer, TPgSQLServer, and TSQLiteServer.

Definition at line 246 of file TSQLServer.cxx.

◆ GetTables()

virtual TSQLResult * TSQLServer::GetTables ( const char *  dbname,
const char *  wild = nullptr 
)
pure virtual

◆ GetTablesList()

TList * TSQLServer::GetTablesList ( const char *  wild = nullptr)
virtual

Return list of user tables Parameter wild specifies wildcard for table names.

It either contains exact table name to verify that table is exists or wildcard with "%" (any number of symbols) and "_" (exactly one symbol). Example of valid wildcards: "%", "%name","___user__". If wild=="", list of all available tables will be produced. List contain just tables names in the TObjString. List must be deleted by the user. Example code of method usage:

TList* lst = serv->GetTablesList(); TIter next(lst); TObject* obj; while (obj = next()) std::cout << "Table: " << obj->GetName() << std::endl; delete lst;

Reimplemented in TMySQLServer, and TODBCServer.

Definition at line 192 of file TSQLServer.cxx.

◆ HasStatement()

virtual Bool_t TSQLServer::HasStatement ( ) const
inlinevirtual

Reimplemented in TMySQLServer, TODBCServer, TPgSQLServer, and TSQLiteServer.

Definition at line 79 of file TSQLServer.h.

◆ HasTable()

Bool_t TSQLServer::HasTable ( const char *  tablename)
virtual

Tests if table of that name exists in database Return kTRUE, if table exists.

Definition at line 218 of file TSQLServer.cxx.

◆ HasTransactionInFlight()

Bool_t TSQLServer::HasTransactionInFlight ( )
virtual

returns kTRUE when transaction is running Must be implemented in derived classes

Reimplemented in TSQLiteServer.

Definition at line 150 of file TSQLServer.cxx.

◆ IsA()

TClass * TSQLServer::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 117 of file TSQLServer.h.

◆ IsConnected()

virtual Bool_t TSQLServer::IsConnected ( ) const
inlinevirtual

Definition at line 93 of file TSQLServer.h.

◆ IsError()

virtual Bool_t TSQLServer::IsError ( ) const
inlinevirtual

Definition at line 99 of file TSQLServer.h.

◆ Ping()

virtual Int_t TSQLServer::Ping ( )
inlinevirtual

Reimplemented in TMySQLServer.

Definition at line 110 of file TSQLServer.h.

◆ PingVerify()

virtual Bool_t TSQLServer::PingVerify ( )
inlinevirtual

Reimplemented in TMySQLServer.

Definition at line 109 of file TSQLServer.h.

◆ Query()

virtual TSQLResult * TSQLServer::Query ( const char *  sql)
pure virtual

◆ Reload()

virtual Int_t TSQLServer::Reload ( )
pure virtual

◆ Rollback()

Bool_t TSQLServer::Rollback ( )
virtual

submit "ROLLBACK" query to database return kTRUE, if successful

Reimplemented in TMySQLServer, TODBCServer, and TSQLiteServer.

Definition at line 169 of file TSQLServer.cxx.

◆ SelectDataBase()

virtual Int_t TSQLServer::SelectDataBase ( const char *  dbname)
pure virtual

◆ ServerInfo()

virtual const char * TSQLServer::ServerInfo ( )
pure virtual

◆ SetError()

void TSQLServer::SetError ( Int_t  code,
const char *  msg,
const char *  method = nullptr 
)
protected

set new values for error fields if method is specified, displays error message

Definition at line 129 of file TSQLServer.cxx.

◆ SetFloatFormat()

void TSQLServer::SetFloatFormat ( const char *  fmt = "%e")
static

set printf format for float/double members, default "%e"

Definition at line 270 of file TSQLServer.cxx.

◆ Shutdown()

virtual Int_t TSQLServer::Shutdown ( )
pure virtual

◆ StartTransaction()

Bool_t TSQLServer::StartTransaction ( )
virtual

submit "START TRANSACTION" query to database return kTRUE, if successful

Reimplemented in TMySQLServer, TODBCServer, and TSQLiteServer.

Definition at line 141 of file TSQLServer.cxx.

◆ Statement()

virtual TSQLStatement * TSQLServer::Statement ( const char *  ,
Int_t  = 100 
)
inlinevirtual

Reimplemented in TMySQLServer, TODBCServer, TPgSQLServer, and TSQLiteServer.

Definition at line 77 of file TSQLServer.h.

◆ Streamer()

void TSQLServer::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TSQLServer::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 117 of file TSQLServer.h.

Member Data Documentation

◆ fDB

TString TSQLServer::fDB
protected

Definition at line 46 of file TSQLServer.h.

◆ fErrorCode

Int_t TSQLServer::fErrorCode {0}
protected

Definition at line 48 of file TSQLServer.h.

◆ fErrorMsg

TString TSQLServer::fErrorMsg
protected

Definition at line 49 of file TSQLServer.h.

◆ fErrorOut

Bool_t TSQLServer::fErrorOut {kTRUE}
protected

Definition at line 50 of file TSQLServer.h.

◆ fgFloatFmt

const char * TSQLServer::fgFloatFmt = "%e"
staticprotected

Definition at line 57 of file TSQLServer.h.

◆ fHost

TString TSQLServer::fHost
protected

Definition at line 45 of file TSQLServer.h.

◆ fPort

Int_t TSQLServer::fPort {-1}
protected

Definition at line 47 of file TSQLServer.h.

◆ fType

TString TSQLServer::fType
protected

Definition at line 44 of file TSQLServer.h.

Libraries for TSQLServer:

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