Definition at line 51 of file TMySQLServer.h.

Public Member Functions
	TMySQLServer (const char db, const char uid, const char *pw)
	Open a connection to a MySQL DB server.

	~TMySQLServer ()
	Close connection to MySQL DB server.

void	Close (Option_t *opt="") final
	Close connection to MySQL DB server.

Bool_t	Commit () final
	Commit changes.

Int_t	CreateDataBase (const char *dbname) final
	Create a database. Returns 0 if successful, non-zero otherwise.

Int_t	DropDataBase (const char *dbname) final
	Drop (i.e.

Bool_t	Exec (const char *sql) final
	Execute SQL command which does not produce any result sets.

TSQLResult *	GetColumns (const char dbname, const char table, const char *wild=nullptr) final
	List all columns in specified table in the specified database.

TSQLResult *	GetDataBases (const char *wild=nullptr) final
	List all available databases.

Int_t	GetMaxIdentifierLength () final

TSQLTableInfo *	GetTableInfo (const char *tablename) final
	Produces SQL table info.

TSQLResult *	GetTables (const char dbname, const char wild=nullptr) final
	List all tables in the specified database.

TList *	GetTablesList (const char *wild=nullptr) final
	Return list of tables with specified wildcard.

Bool_t	HasStatement () const final
	Return kTRUE if TSQLStatement class is supported.

Int_t	Ping () final
	Execute Ping to SQL Connection using the mysql_ping function.

Bool_t	PingVerify () final
	Execute Ping to SQL Connection.

TSQLResult *	Query (const char *sql) final
	Execute SQL command.

Int_t	Reload () final
	Reload permission tables.

Bool_t	Rollback () final
	Rollback changes.

Int_t	SelectDataBase (const char *dbname) final
	Select a database. Returns 0 if successful, non-zero otherwise.

const char *	ServerInfo () final
	Return server info in form "MySQL <vesrion>".

Int_t	Shutdown () final
	Shutdown the database server.

Bool_t	StartTransaction () final
	Start transaction.

TSQLStatement *	Statement (const char *sql, Int_t=100) final
	Produce TMySQLStatement.

Public Member Functions inherited from TSQLServer
virtual	~TSQLServer ()

virtual void	EnableErrorOutput (Bool_t on=kTRUE)

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

Int_t	GetPort () 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

TClass *	IsA () const override

virtual Bool_t	IsConnected () const

virtual Bool_t	IsError () const

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 TObject *	Clone (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 TObject *	DrawClone (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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () 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_t *	GetOption () 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, void vp)
	Only called by placement new when throwing an exception.

void	operator delete[] (void *ptr)
	Operator delete [].

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

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)

TObject &	operator= (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.

Protected Attributes
TString	fInfo

MYSQL *	fMySQL {nullptr}

Protected Attributes inherited from TSQLServer
TString	fDB

Int_t	fErrorCode {0}

TString	fErrorMsg

Bool_t	fErrorOut {kTRUE}

TString	fHost

Int_t	fPort {-1}

TString	fType

Additional Inherited Members
Public Types inherited from TSQLServer
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 )) }

Static Public Member Functions inherited from TSQLServer
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static TSQLServer *	Connect (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 TClass *	Class ()

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 Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions inherited from TSQLServer
	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 ()

Static Protected Attributes inherited from TSQLServer
static const char *	fgFloatFmt = "%e"

#include <TMySQLServer.h>

Inheritance diagram for TMySQLServer:

[legend]

Constructor & Destructor Documentation

◆ TMySQLServer()

TMySQLServer::TMySQLServer	(	const char *	db,
		const char *	uid,
		const char *	pw
	)

Open a connection to a MySQL DB server.

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

In addition, several parameters can be specified in url after "?" symbol: timeout=N n is connect timeout is seconds socket=socketname socketname should be name of Unix socket, used for connection multi_statements tell the server that the client may send multiple statements in a single string (separated by ;); multi_results tell the server that the client can handle multiple result sets from multiple-statement executions or stored procedures reconnect=0|1 enable or disable automatic reconnection to the server if the connection is found to have been lost compress use the compressed client/server protocol cnf_file=filename Read options from the named option file instead of from my.cnf cnf_group=groupname Read options from the named group from my.cnf or the file specified with cnf_file option If several parameters are specified, they should be separated by "&" symbol Example of connection argument: TSQLServer::Connect("mysql://host.domain/test?timeout=10&multi_statements");

Definition at line 83 of file TMySQLServer.cxx.

◆ ~TMySQLServer()

TMySQLServer::~TMySQLServer ( )

Close connection to MySQL DB server.

Definition at line 226 of file TMySQLServer.cxx.

Member Function Documentation

◆ Close()

void TMySQLServer::Close ( Option_t * opt = "" )

finalvirtual

Close connection to MySQL DB server.

Implements TSQLServer.

Definition at line 260 of file TMySQLServer.cxx.

◆ Commit()

Bool_t TMySQLServer::Commit ( )

finalvirtual

Commit changes.

Reimplemented from TSQLServer.

Definition at line 756 of file TMySQLServer.cxx.

◆ CreateDataBase()

Int_t TMySQLServer::CreateDataBase ( const char * dbname )

finalvirtual

Create a database. Returns 0 if successful, non-zero otherwise.

Implements TSQLServer.

Definition at line 608 of file TMySQLServer.cxx.

◆ DropDataBase()

Int_t TMySQLServer::DropDataBase ( const char * dbname )

finalvirtual

Drop (i.e.

delete) a database. Returns 0 if successful, non-zero otherwise.

Implements TSQLServer.

Definition at line 623 of file TMySQLServer.cxx.

◆ Exec()

Bool_t TMySQLServer::Exec ( const char * sql )

finalvirtual

Execute SQL command which does not produce any result sets.

Returns kTRUE if successful.

Reimplemented from TSQLServer.

Definition at line 293 of file TMySQLServer.cxx.

◆ GetColumns()

TSQLResult * TMySQLServer::GetColumns	(	const char *	dbname,
		const char *	table,
		const char *	wild = `nullptr`
	)

finalvirtual

List all columns in specified table in the specified database.

Wild is for wildcarding "t%" list all columns starting with "t". Returns a pointer to a TSQLResult object if successful, 0 otherwise. The result object must be deleted by the user.

Implements TSQLServer.

Definition at line 589 of file TMySQLServer.cxx.

◆ GetDataBases()

TSQLResult * TMySQLServer::GetDataBases ( const char * wild = nullptr )

finalvirtual

List all available databases.

Wild is for wildcarding "t%" list all databases starting with "t". Returns a pointer to a TSQLResult object if successful, 0 otherwise. The result object must be deleted by the user.

Implements TSQLServer.

Definition at line 323 of file TMySQLServer.cxx.

◆ GetMaxIdentifierLength()

Int_t TMySQLServer::GetMaxIdentifierLength ( )

inlinefinalvirtual

Reimplemented from TSQLServer.

Definition at line 72 of file TMySQLServer.h.

◆ GetTableInfo()

TSQLTableInfo * TMySQLServer::GetTableInfo ( const char * tablename )

finalvirtual

Produces SQL table info.

Object must be deleted by user.

Reimplemented from TSQLServer.

Definition at line 394 of file TMySQLServer.cxx.

◆ GetTables()

TSQLResult * TMySQLServer::GetTables	(	const char *	dbname,
		const char *	wild = `nullptr`
	)

finalvirtual

List all tables in the specified database.

Wild is for wildcarding "t%" list all tables starting with "t". Returns a pointer to a TSQLResult object if successful, 0 otherwise. The result object must be deleted by the user.

Implements TSQLServer.

Definition at line 340 of file TMySQLServer.cxx.

◆ GetTablesList()

TList * TMySQLServer::GetTablesList ( const char * wild = nullptr )

finalvirtual

Return list of tables with specified wildcard.

Reimplemented from TSQLServer.

Definition at line 357 of file TMySQLServer.cxx.

◆ HasStatement()

Bool_t TMySQLServer::HasStatement ( ) const

finalvirtual

Return kTRUE if TSQLStatement class is supported.

Starts from MySQL 4.1.

Reimplemented from TSQLServer.

Definition at line 700 of file TMySQLServer.cxx.

◆ Ping()

Int_t TMySQLServer::Ping ( )

finalvirtual

Execute Ping to SQL Connection using the mysql_ping function.

Returns 0 if successful, non-zero in case an error occured.

Reimplemented from TSQLServer.

Definition at line 822 of file TMySQLServer.cxx.

◆ PingVerify()

Bool_t TMySQLServer::PingVerify ( )

finalvirtual

Execute Ping to SQL Connection.

Since mysql_ping tries to reconnect by itself, a double call to the mysql function is implemented. Returns kTRUE if successful

Reimplemented from TSQLServer.

Definition at line 803 of file TMySQLServer.cxx.

◆ Query()

TSQLResult * TMySQLServer::Query ( const char * sql )

finalvirtual

Execute SQL command.

Result object must be deleted by the user. Returns a pointer to a TSQLResult object if successful, 0 otherwise. The result object must be deleted by the user.

Implements TSQLServer.

Definition at line 276 of file TMySQLServer.cxx.

◆ Reload()

Int_t TMySQLServer::Reload ( )

finalvirtual

Reload permission tables.

Returns 0 if successful, non-zero otherwise. User must have reload permissions.

Implements TSQLServer.

Definition at line 638 of file TMySQLServer.cxx.

◆ Rollback()

Bool_t TMySQLServer::Rollback ( )

finalvirtual

Rollback changes.

Reimplemented from TSQLServer.

Definition at line 778 of file TMySQLServer.cxx.

◆ SelectDataBase()

Int_t TMySQLServer::SelectDataBase ( const char * dbname )

finalvirtual

Select a database. Returns 0 if successful, non-zero otherwise.

Implements TSQLServer.

Definition at line 306 of file TMySQLServer.cxx.

◆ ServerInfo()

const char * TMySQLServer::ServerInfo ( )

finalvirtual

Return server info in form "MySQL <vesrion>".

Implements TSQLServer.

Definition at line 682 of file TMySQLServer.cxx.

◆ Shutdown()

Int_t TMySQLServer::Shutdown ( )

finalvirtual

Shutdown the database server.

Returns 0 if successful, non-zero otherwise. User must have shutdown permissions.

Implements TSQLServer.

Definition at line 659 of file TMySQLServer.cxx.

◆ StartTransaction()

Bool_t TMySQLServer::StartTransaction ( )

finalvirtual

Start transaction.

Reimplemented from TSQLServer.

Definition at line 746 of file TMySQLServer.cxx.

◆ Statement()

TSQLStatement * TMySQLServer::Statement	(	const char *	sql,
		Int_t	= `100`
	)

finalvirtual

Produce TMySQLStatement.

Reimplemented from TSQLServer.

Definition at line 713 of file TMySQLServer.cxx.

Member Data Documentation

◆ fInfo

TString TMySQLServer::fInfo

protected

Definition at line 55 of file TMySQLServer.h.

◆ fMySQL

MYSQL* TMySQLServer::fMySQL {nullptr}

protected

Definition at line 54 of file TMySQLServer.h.

Libraries for TMySQLServer:

[legend]

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

sql/mysql/inc/TMySQLServer.h
sql/mysql/src/TMySQLServer.cxx

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TMySQLServer()

◆ ~TMySQLServer()

Member Function Documentation

◆ Close()

◆ Commit()

◆ CreateDataBase()

◆ DropDataBase()

◆ Exec()

◆ GetColumns()

◆ GetDataBases()

◆ GetMaxIdentifierLength()

◆ GetTableInfo()

◆ GetTables()

◆ GetTablesList()

◆ HasStatement()

◆ Ping()

◆ PingVerify()

◆ Query()

◆ Reload()

◆ Rollback()

◆ SelectDataBase()

◆ ServerInfo()

◆ Shutdown()

◆ StartTransaction()

◆ Statement()

Member Data Documentation

◆ fInfo

◆ fMySQL