Definition at line 21 of file TSQLStatement.h.

Public Member Functions
virtual	~TSQLStatement ()=default

virtual void	Close (Option_t *="")

virtual void	EnableErrorOutput (Bool_t on=kTRUE)

virtual Bool_t	GetBinary (Int_t, void *&, Long_t &)

virtual Int_t	GetBufferLength () const =0

virtual Bool_t	GetDate (Int_t, Int_t &, Int_t &, Int_t &)

TDatime	GetDatime (Int_t)
	return value of parameter in form of TDatime Be aware, that TDatime does not allow dates before 1995-01-01

virtual Bool_t	GetDatime (Int_t, Int_t &, Int_t &, Int_t &, Int_t &, Int_t &, Int_t &)

Int_t	GetDay (Int_t)
	return day value for parameter (if applicable)

virtual Double_t	GetDouble (Int_t)

virtual Int_t	GetErrorCode () const
	Abstract base class defining SQL statements, which can be submitted in bulk to DB server.

virtual const char *	GetErrorMsg () const
	returns error message of last operation if no errors, return 0 Each specific implementation of TSQLStatement provides its own error messages

virtual const char *	GetFieldName (Int_t)=0

Int_t	GetHour (Int_t)
	return hours value for parameter (if applicable)

virtual Int_t	GetInt (Int_t)

virtual Bool_t	GetLargeObject (Int_t col, void *&mem, Long_t &size)

virtual Long_t	GetLong (Int_t)

virtual Long64_t	GetLong64 (Int_t)

Int_t	GetMinute (Int_t)
	return minutes value for parameter (if applicable)

Int_t	GetMonth (Int_t)
	return month value for parameter (if applicable)

virtual Int_t	GetNumAffectedRows ()

virtual Int_t	GetNumFields ()=0

virtual Int_t	GetNumParameters ()=0

Int_t	GetSecond (Int_t)
	return seconds value for parameter (if applicable)

Int_t	GetSecondsFraction (Int_t)
	return seconds fraction value for parameter (if applicable)

virtual const char *	GetString (Int_t)

virtual Bool_t	GetTime (Int_t, Int_t &, Int_t &, Int_t &)

TDatime	GetTimestamp (Int_t)
	return value of parameter in form of TDatime Be aware, that TDatime does not allow dates before 1995-01-01

virtual Bool_t	GetTimestamp (Int_t, Int_t &, Int_t &, Int_t &, Int_t &, Int_t &, Int_t &, Int_t &)
	Get parameter as timestamp.

virtual Bool_t	GetTimestamp (Int_t, TTimeStamp &)
	Get parameter as TTimeStamp.

virtual UInt_t	GetUInt (Int_t)

virtual ULong64_t	GetULong64 (Int_t)

virtual Bool_t	GetVDouble (Int_t, std::vector< Double_t > &)

virtual Bool_t	GetVInt (Int_t, std::vector< Int_t > &)

virtual Bool_t	GetVLong (Int_t, std::vector< Long_t > &)

virtual Bool_t	GetVLong64 (Int_t, std::vector< Long64_t > &)

virtual Bool_t	GetVUInt (Int_t, std::vector< UInt_t > &)

virtual Bool_t	GetVULong64 (Int_t, std::vector< ULong64_t > &)

Int_t	GetYear (Int_t)
	return year value for parameter (if applicable)

TClass *	IsA () const override

virtual Bool_t	IsError () const

virtual Bool_t	IsNull (Int_t)

virtual Bool_t	NextIteration ()=0

virtual Bool_t	NextResultRow ()=0

virtual Bool_t	Process ()=0

virtual Bool_t	SetBinary (Int_t, void *, Long_t, Long_t=0x1000)

Bool_t	SetDate (Int_t, const TDatime &)
	set only date value for specified parameter from TDatime object

virtual Bool_t	SetDate (Int_t, Int_t, Int_t, Int_t)

Bool_t	SetDatime (Int_t, const TDatime &)
	set date & time value for specified parameter from TDatime object

virtual Bool_t	SetDatime (Int_t, Int_t, Int_t, Int_t, Int_t, Int_t, Int_t)

virtual Bool_t	SetDouble (Int_t, Double_t)

virtual Bool_t	SetInt (Int_t, Int_t)

virtual Bool_t	SetLargeObject (Int_t col, void *mem, Long_t size, Long_t maxsize=0x1000)

virtual Bool_t	SetLong (Int_t, Long_t)

virtual Bool_t	SetLong64 (Int_t, Long64_t)

virtual Bool_t	SetMaxFieldSize (Int_t, Long_t)

virtual Bool_t	SetNull (Int_t)

virtual Bool_t	SetString (Int_t, const char *, Int_t=256)

Bool_t	SetTime (Int_t, const TDatime &)
	set only time value for specified parameter from TDatime object

virtual Bool_t	SetTime (Int_t, Int_t, Int_t, Int_t)

virtual void	SetTimeFormating (const char *)

Bool_t	SetTimestamp (Int_t, const TDatime &)
	set timestamp value for specified parameter from TDatime object

virtual Bool_t	SetTimestamp (Int_t, const TTimeStamp &)
	Set parameter as TTimeStamp.

virtual Bool_t	SetTimestamp (Int_t, Int_t, Int_t, Int_t, Int_t, Int_t, Int_t, Int_t=0)
	Set parameter as timestamp.

virtual Bool_t	SetUInt (Int_t, UInt_t)

virtual Bool_t	SetULong64 (Int_t, ULong64_t)

virtual Bool_t	SetVDouble (Int_t, const std::vector< Double_t >, const char , const char )

virtual Bool_t	SetVInt (Int_t, const std::vector< Int_t >, const char , const char )

virtual Bool_t	SetVLong (Int_t, const std::vector< Long_t >, const char , const char )

virtual Bool_t	SetVLong64 (Int_t, const std::vector< Long64_t >, const char , const char )

virtual Bool_t	SetVUInt (Int_t, const std::vector< UInt_t >, const char , const char )

virtual Bool_t	SetVULong64 (Int_t, const std::vector< ULong64_t >, const char , const char )

virtual Bool_t	StoreResult ()=0

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) noexcept
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.

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 *, size_t)
	Operator delete for sized deallocation.

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 *, size_t)
	Operator delete [] for sized deallocation.

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) noexcept
	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 TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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 Member Functions
	TSQLStatement (Bool_t errout=kTRUE)

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 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
Int_t	fErrorCode {0}

TString	fErrorMsg

Bool_t	fErrorOut {kFALSE}

Additional Inherited Members
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 )) }

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

Static Protected Member Functions inherited from TObject
static void	SavePrimitiveConstructor (std::ostream &out, TClass cl, const char variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
	Save object constructor in the output stream "out".

static void	SavePrimitiveDraw (std::ostream &out, const char variable_name, Option_t option=nullptr)
	Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

static TString	SavePrimitiveVector (std::ostream &out, const char prefix, Int_t len, Double_t arr, Bool_t empty_line=kFALSE)
	Save array in the output stream "out" as vector.

#include <TSQLStatement.h>

Inheritance diagram for TSQLStatement:

[legend]

Constructor & Destructor Documentation

◆ TSQLStatement()

TSQLStatement::TSQLStatement ( Bool_t errout = kTRUE )

inlineprotected

Definition at line 24 of file TSQLStatement.h.

◆ ~TSQLStatement()

virtual TSQLStatement::~TSQLStatement ( )

virtualdefault

Member Function Documentation

◆ Class()

static TClass * TSQLStatement::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TSQLStatement::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TSQLStatement::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 121 of file TSQLStatement.h.

◆ ClearError()

void TSQLStatement::ClearError ( )

protected

reset error fields

Definition at line 255 of file TSQLStatement.cxx.

◆ Close()

virtual void TSQLStatement::Close ( Option_t * = "" )

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 41 of file TSQLStatement.h.

◆ DeclFileName()

static const char * TSQLStatement::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 121 of file TSQLStatement.h.

◆ EnableErrorOutput()

virtual void TSQLStatement::EnableErrorOutput ( Bool_t on = kTRUE )

inlinevirtual

Definition at line 119 of file TSQLStatement.h.

◆ GetBinary()

virtual Bool_t TSQLStatement::GetBinary	(	Int_t	,
		void *&	,
		Long_t &	)

inlinevirtual

See also: GetLargeObject

Reimplemented in TSQLiteStatement.

Definition at line 89 of file TSQLStatement.h.

◆ GetBufferLength()

virtual Int_t TSQLStatement::GetBufferLength ( ) const

pure virtual

Implemented in TSQLiteStatement.

◆ GetDate()

virtual Bool_t TSQLStatement::GetDate	(	Int_t	,
		Int_t &	,
		Int_t &	,
		Int_t &	)

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 95 of file TSQLStatement.h.

◆ GetDatime() [1/2]

TDatime TSQLStatement::GetDatime ( Int_t npar )

return value of parameter in form of TDatime Be aware, that TDatime does not allow dates before 1995-01-01

Definition at line 311 of file TSQLStatement.cxx.

◆ GetDatime() [2/2]

virtual Bool_t TSQLStatement::GetDatime	(	Int_t	,
		Int_t &	,
		Int_t &	,
		Int_t &	,
		Int_t &	,
		Int_t &	,
		Int_t &	)

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 97 of file TSQLStatement.h.

◆ GetDay()

Int_t TSQLStatement::GetDay ( Int_t npar )

return day value for parameter (if applicable)

Definition at line 351 of file TSQLStatement.cxx.

◆ GetDouble()

virtual Double_t TSQLStatement::GetDouble ( Int_t )

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 86 of file TSQLStatement.h.

◆ GetErrorCode()

Int_t TSQLStatement::GetErrorCode ( ) const

virtual

Abstract base class defining SQL statements, which can be submitted in bulk to DB server.

This is alternative to TSQLServer::Query() method, which allows only pure text queries and pure text result in TSQLResult classes. TSQLStatement is designed to support following features:

usage of basic data types (like int or double) as parameters in SQL statements
bulk operation when inserting/updating/selecting data in database
uasge of basic data types when accessing result set of executed query

1. Creation of statement

To create an instance of the TSQLStatement class, the TSQLServer::Statement() method should be used. Depending on the driver used for an ODBC connection, the appropriate object instance will be created. For the moment there are six different implementations of the TSQLStatement class: for MySQL, Oracle, PostgreSQL, SQLite3 and ODBC. Hopefully, support of ODBC will allow usage of statements for most existing RDBMS.

// first, connect to the database TSQLServer* serv = TSQLServer::Connect("mysql://hostname.domain:3306/test", "user", "pass"); // check if connection is ok if ((serv!=0) && serv->IsConnected()) { // create instance of sql-statement TSQLStatement* stmt = serv->Statement("CREATE TABLE TESTTABLE (ID1 INT, ID2 INT, FFIELD VARCHAR(255), FVALUE VARCHAR(255))"; // process statement stmt->Process(); // destroy object delete stmt; } delete serv;

2. Insert data to data base

There is a special syntax of SQL queries which allows to use values provided as parameters. For instance, to insert one row into the TESTTABLE created with the previous example, one can simply execute a query like:

serv->Query("INSERT INTO TESTTABLE VALUES (1, 2, \"name1\", \"value1\"");

However, when many (100-1000) rows should be inserted, each call of TSQLServer::Query() method will cause communication loop with database server, and the statement has to be evaluated each time instead of using a prepared statement. As a result, insertion of data takes too much time.

TSQLStatement provides a mechanism to insert many rows at once. First of all, an appropriate statement should be created:

TSQLStatement* stmt = serv->Statement("INSERT INTO TESTTABLE (ID1, ID2, FFIELD, FVALUE) VALUES (?, ?, ?, ?)", 100);

Here question marks "?" indicate where statement parameters can be inserted. To specify values of parameters, SetInt(), SetDouble(), SetString() and other methods of the TSQLStatement class should be used. Before parameters values can be specified, the NextIteration() method of statement class should be called. For each new row, NextIteration() has to be called first, then parameters values are specified. There is one limitation for most type-aware DBMS - once a parameter is set as integer via SetInt(), all other rows should be specified as integer. At the end, TSQLStatement::Process() should be called. Here a small example:

// first, create statement TSQLStatement* stmt = serv->Statement("INSERT INTO TESTTABLE (ID1, ID2, FFIELD, FVALUE) VALUES (?, ?, ?, ?)", 100);

for (int n=0;n<357;n++) if (stmt->NextIteration()) { stmt->SetInt(0, 123); stmt->SetUInt(1, n+10); stmt->SetString(2, Form("name %d",n), 200); stmt->SetString(3, Form("value %d", n+10), 200); }

stmt->Process(); delete stmt;

The second argument in the TSQLServer::Statement() method specifies the depth of of buffers which are used to keep parameter values (100 in the example). It is not a limitation of the number of rows which can be inserted with the statement. When buffers are filled, they will be submitted to database and can be reused again. This happens transparent to the user in the NextIteration() method.

Oracle and some ODBC drivers support buffering of parameter values and, as a result, bulk insert (update) operation. MySQL (native driver and MyODBC 3) does not support such a mode of operation, therefore adding new rows will result in communication loop to database.

Local databases (SQLite3) do not use any buffering at all in the TSQLStatement implementation (but inside the library). They still profit from the usage of prepared statements. When inserting many rows into a SQLite3 database, consider using a transaction via the methods StartTransaction() and Commit() of the TSQLServer, as autocommit is active by default and causes a sync to disk after each single insert.

One should also mention differences between Oracle and ODBC SQL syntax for parameters. ODBC (and MySQL) use question marks to specify the position where parameters should be inserted (as shown in the example). Oracle uses :1, :2 and so on as marks to specify the position of parameter 0, 1, and so on. Therefore, similar to the example, a query will look like:

TSQLStatement* stmt = serv->Statement("INSERT INTO TESTTABLE (ID1, ID2, FFIELD, FVALUE) VALUES (:1, :2, :3, :4)", 100);

SQLite3 supports both these syntaxes and some more.

There is a possibility to set a parameter value to NULL with the SetNull() method. If this method is to be called for the first iteration, one should first call another Set... method to identify the actual type which will be used for the parameter later.

3. Getting data from database

To request data from a database, the SELECT statement should be used. After a SELECT statement is created, it must be processed with the TSQLStatement::Process() method and the result of statement should be stored in internal buffers with the method TSQLStatement::StoreResult(). Information about selected fields (columns) can be obtained with GetNumFields() and GetFieldName() methods. To receive data for the next result row, NextResultRow() method should be called. Value from each column can be retrieved with the GetInt(), GetDouble(), GetString() and other methods.

There are no strict limitations on which method should be used to get column values. GetString() can be used as a generic method, which should always return correct result, but also conversions between most basic data types are supported. For instance, if a column contains integer values, GetInt(), GetLong64(), GetDouble() and GetString() methods can be used. If column has floating point format, GetDouble() and GetString() methods can be used without loss of precision while GetInt() or GetLong64() will return only the integer part of the value. One also can test whether a value is NULL with the IsNull() method.

The buffer length specified for a statement in the TSQLServer::Statement() call will also be used to allocate buffers for column values. Usage of these buffers is transparent for users and does not limit the number of rows which can be accessed with one statement. Again, local databases do not work with buffers inside TSQLStatement at all and ignore this value. Example of select query:

stmt = serv->Statement("SELECT * FROM TESTTABLE", 100); // process statement if (stmt->Process()) { // store result of statement in buffer stmt->StoreResult();

// display info about selected field std::cout << "NumFields = " << stmt->GetNumFields() << std::endl; for (int n=0;n<stmt->GetNumFields();n++) std::cout << "Field " << n << " = " << stmt->GetFieldName(n) << std::endl;

// extract rows one after another while (stmt->NextResultRow()) { Double_t id1 = stmt->GetDouble(0); UInt_t id2 = stmt->GetUInt(1); const char* name1 = stmt->GetString(2); const char* name2 = stmt->GetString(3); std::cout << id1 << " - " << id2 << " " << name1 << " " << name2 << std::endl; } }

4. Working with date/time parameters

The current implementation supports date, time, date&time and timestamp data (all time intervals are not supported yet). To set or get date/time values, the following methods should be used: SetTime()/GetTime() - only time (hour:min:sec), SetDate()/GetDate() - only date (year-month-day), SetDatime()/GetDatime() - date and time SetTimestamp()/GetTimestamp() - timestamp with seconds fraction For some of these methods TDatime type can be used as parameter / return value. Be aware that TDatime supports only dates after 1995-01-01. There are also methods to get year, month, day, hour, minutes and seconds separately.

Note that different SQL databases treat date/time types differently. For instance, MySQL has all correspondent types (TIME, DATE, DATETIME and TIMESTAMP), Oracle native driver supports only DATE (which is actually date and time) and TIMESTAMP ODBC interface provides access for time, date and timestamps, for PostgreSQL, TIMESTAMP is available and can be retrieved via all methods, the implementation for SQLite interprets the column content as a timestamp with second fraction. Due to these differences, one should use correct methods to access such data. For instance, in MySQL SQL type 'DATE' is only date (one should use GetDate() to access such data), while in Oracle it is date and time. Therefore, to get complete data from a 'DATE' column in Oracle, one should use the GetDatime() method.

The only difference between timestamp and date/time is that timestamp has a fractional seconds part. Be aware that the fractional part has different meanings (actual value) in different SQL plugins. For PostgreSQL, it is given back as microseconds, while for SQLite3, milliseconds correspond to the fraction (similar to the DATETIME-functions implemented in the SQLite3 language).

5. Binary data

Most modern data bases support just binary data, which is typically has SQL type name 'BLOB'. To access data in such columns, GetBinary()/SetBinary() methods should be used. The current implementation implies that the complete content of the column must be retrieved at once. Therefore, very big data of gigabytes size may cause a problem.

In addition, for PostgresSQL, the methods GetLargeObject()/SetLargeObject() are implemented with similar syntax. They retrieve a large object for the OID given in the column of the statement. For non-PostgreSQL databases, calling GetLargeObject()/SetLargeObject() is redirected to GetBinary()/SetBinary().

Since ROOT 6.36, the GetLargeObject/GetBinary(Int_t col, void* &mem, Long_t& size) API is defined strictly to return new memory mem that must be released with delete [] (unsigned char *) mem by the caller. Older uses of this API (such as those of oracle, mysql, odbc) that relied on internal buffer management (owning pointers) were removed in ROOT 6.38. returns error code of last operation if res==0, no error Each specific implementation of TSQLStatement provides its own error coding

Definition at line 237 of file TSQLStatement.cxx.

◆ GetErrorMsg()

const char * TSQLStatement::GetErrorMsg ( ) const

virtual

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

Definition at line 247 of file TSQLStatement.cxx.

◆ GetFieldName()

virtual const char * TSQLStatement::GetFieldName ( Int_t )

pure virtual

Implemented in TSQLiteStatement.

◆ GetHour()

Int_t TSQLStatement::GetHour ( Int_t npar )

return hours value for parameter (if applicable)

Definition at line 362 of file TSQLStatement.cxx.

◆ GetInt()

virtual Int_t TSQLStatement::GetInt ( Int_t )

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 81 of file TSQLStatement.h.

◆ GetLargeObject()

virtual Bool_t TSQLStatement::GetLargeObject	(	Int_t	col,
		void *&	mem,
		Long_t &	size )

inlinevirtual

Note: Since ROOT 6.36, this API is defined to return new memory that must be released with delete [] (unsigned char *) mem by the caller. Older uses of this API (such as those of oracle, mysql, odbc) that relied on internal buffer management (owning pointers) were removed in ROOT 6.38.

Definition at line 93 of file TSQLStatement.h.

◆ GetLong()

virtual Long_t TSQLStatement::GetLong ( Int_t )

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 83 of file TSQLStatement.h.

◆ GetLong64()

virtual Long64_t TSQLStatement::GetLong64 ( Int_t )

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 84 of file TSQLStatement.h.

◆ GetMinute()

Int_t TSQLStatement::GetMinute ( Int_t npar )

return minutes value for parameter (if applicable)

Definition at line 373 of file TSQLStatement.cxx.

◆ GetMonth()

Int_t TSQLStatement::GetMonth ( Int_t npar )

return month value for parameter (if applicable)

Definition at line 340 of file TSQLStatement.cxx.

◆ GetNumAffectedRows()

virtual Int_t TSQLStatement::GetNumAffectedRows ( )

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 72 of file TSQLStatement.h.

◆ GetNumFields()

virtual Int_t TSQLStatement::GetNumFields ( )

pure virtual

Implemented in TSQLiteStatement.

◆ GetNumParameters()

virtual Int_t TSQLStatement::GetNumParameters ( )

pure virtual

Implemented in TSQLiteStatement.

◆ GetSecond()

Int_t TSQLStatement::GetSecond ( Int_t npar )

return seconds value for parameter (if applicable)

Definition at line 384 of file TSQLStatement.cxx.

◆ GetSecondsFraction()

Int_t TSQLStatement::GetSecondsFraction ( Int_t npar )

return seconds fraction value for parameter (if applicable)

Definition at line 395 of file TSQLStatement.cxx.

◆ GetString()

virtual const char * TSQLStatement::GetString ( Int_t )

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 87 of file TSQLStatement.h.

◆ GetTime()

virtual Bool_t TSQLStatement::GetTime	(	Int_t	,
		Int_t &	,
		Int_t &	,
		Int_t &	)

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 96 of file TSQLStatement.h.

◆ GetTimestamp() [1/3]

TDatime TSQLStatement::GetTimestamp ( Int_t npar )

return value of parameter in form of TDatime Be aware, that TDatime does not allow dates before 1995-01-01

Definition at line 406 of file TSQLStatement.cxx.

◆ GetTimestamp() [2/3]

Bool_t TSQLStatement::GetTimestamp	(	Int_t	,
		Int_t &	,
		Int_t &	,
		Int_t &	,
		Int_t &	,
		Int_t &	,
		Int_t &	,
		Int_t &	)

virtual

Get parameter as timestamp.

Reimplemented in TSQLiteStatement, and TSQLiteStatement.

Definition at line 441 of file TSQLStatement.cxx.

◆ GetTimestamp() [3/3]

Bool_t TSQLStatement::GetTimestamp	(	Int_t	,
		TTimeStamp &	)

virtual

Get parameter as TTimeStamp.

Reimplemented in TSQLiteStatement.

Definition at line 449 of file TSQLStatement.cxx.

◆ GetUInt()

virtual UInt_t TSQLStatement::GetUInt ( Int_t )

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 82 of file TSQLStatement.h.

◆ GetULong64()

virtual ULong64_t TSQLStatement::GetULong64 ( Int_t )

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 85 of file TSQLStatement.h.

◆ GetVDouble()

virtual Bool_t TSQLStatement::GetVDouble	(	Int_t	,
		std::vector< Double_t > &	)

inlinevirtual

Definition at line 114 of file TSQLStatement.h.

◆ GetVInt()

virtual Bool_t TSQLStatement::GetVInt	(	Int_t	,
		std::vector< Int_t > &	)

inlinevirtual

Definition at line 109 of file TSQLStatement.h.

◆ GetVLong()

virtual Bool_t TSQLStatement::GetVLong	(	Int_t	,
		std::vector< Long_t > &	)

inlinevirtual

Definition at line 111 of file TSQLStatement.h.

◆ GetVLong64()

virtual Bool_t TSQLStatement::GetVLong64	(	Int_t	,
		std::vector< Long64_t > &	)

inlinevirtual

Definition at line 112 of file TSQLStatement.h.

◆ GetVUInt()

virtual Bool_t TSQLStatement::GetVUInt	(	Int_t	,
		std::vector< UInt_t > &	)

inlinevirtual

Definition at line 110 of file TSQLStatement.h.

◆ GetVULong64()

virtual Bool_t TSQLStatement::GetVULong64	(	Int_t	,
		std::vector< ULong64_t > &	)

inlinevirtual

Definition at line 113 of file TSQLStatement.h.

◆ GetYear()

Int_t TSQLStatement::GetYear ( Int_t npar )

return year value for parameter (if applicable)

Definition at line 329 of file TSQLStatement.cxx.

◆ IsA()

TClass * TSQLStatement::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 121 of file TSQLStatement.h.

◆ IsError()

virtual Bool_t TSQLStatement::IsError ( ) const

inlinevirtual

Definition at line 116 of file TSQLStatement.h.

◆ IsNull()

virtual Bool_t TSQLStatement::IsNull ( Int_t )

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 80 of file TSQLStatement.h.

◆ NextIteration()

virtual Bool_t TSQLStatement::NextIteration ( )

pure virtual

Implemented in TSQLiteStatement.

◆ NextResultRow()

virtual Bool_t TSQLStatement::NextResultRow ( )

pure virtual

Implemented in TSQLiteStatement.

◆ Process()

virtual Bool_t TSQLStatement::Process ( )

pure virtual

Implemented in TSQLiteStatement.

◆ SetBinary()

virtual Bool_t TSQLStatement::SetBinary	(	Int_t	,
		void *	,
		Long_t	,
		Long_t	= 0x1000 )

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 61 of file TSQLStatement.h.

◆ SetDate() [1/2]

Bool_t TSQLStatement::SetDate	(	Int_t	npar,
		const TDatime &	tm )

set only date value for specified parameter from TDatime object

Definition at line 276 of file TSQLStatement.cxx.

◆ SetDate() [2/2]

virtual Bool_t TSQLStatement::SetDate	(	Int_t	,
		Int_t	,
		Int_t	,
		Int_t	)

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 51 of file TSQLStatement.h.

◆ SetDatime() [1/2]

Bool_t TSQLStatement::SetDatime	(	Int_t	npar,
		const TDatime &	tm )

set date & time value for specified parameter from TDatime object

Definition at line 292 of file TSQLStatement.cxx.

◆ SetDatime() [2/2]

virtual Bool_t TSQLStatement::SetDatime	(	Int_t	,
		Int_t	,
		Int_t	,
		Int_t	,
		Int_t	,
		Int_t	,
		Int_t	)

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 55 of file TSQLStatement.h.

◆ SetDouble()

virtual Bool_t TSQLStatement::SetDouble	(	Int_t	,
		Double_t	)

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 49 of file TSQLStatement.h.

◆ SetError()

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

protected

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

Definition at line 265 of file TSQLStatement.cxx.

◆ SetInt()

virtual Bool_t TSQLStatement::SetInt	(	Int_t	,
		Int_t	)

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 44 of file TSQLStatement.h.

◆ SetLargeObject()

virtual Bool_t TSQLStatement::SetLargeObject	(	Int_t	col,
		void *	mem,
		Long_t	size,
		Long_t	maxsize = 0x1000 )

inlinevirtual

Definition at line 62 of file TSQLStatement.h.

◆ SetLong()

virtual Bool_t TSQLStatement::SetLong	(	Int_t	,
		Long_t	)

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 46 of file TSQLStatement.h.

◆ SetLong64()

virtual Bool_t TSQLStatement::SetLong64	(	Int_t	,
		Long64_t	)

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 47 of file TSQLStatement.h.

◆ SetMaxFieldSize()

virtual Bool_t TSQLStatement::SetMaxFieldSize	(	Int_t	,
		Long_t	)

inlinevirtual

Definition at line 77 of file TSQLStatement.h.

◆ SetNull()

virtual Bool_t TSQLStatement::SetNull ( Int_t )

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 43 of file TSQLStatement.h.

◆ SetString()

virtual Bool_t TSQLStatement::SetString	(	Int_t	,
		const char *	,
		Int_t	= 256 )

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 50 of file TSQLStatement.h.

◆ SetTime() [1/2]

Bool_t TSQLStatement::SetTime	(	Int_t	npar,
		const TDatime &	tm )

set only time value for specified parameter from TDatime object

Definition at line 284 of file TSQLStatement.cxx.

◆ SetTime() [2/2]

virtual Bool_t TSQLStatement::SetTime	(	Int_t	,
		Int_t	,
		Int_t	,
		Int_t	)

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 53 of file TSQLStatement.h.

◆ SetTimeFormating()

virtual void TSQLStatement::SetTimeFormating ( const char * )

inlinevirtual

Definition at line 60 of file TSQLStatement.h.

◆ SetTimestamp() [1/3]

Bool_t TSQLStatement::SetTimestamp	(	Int_t	npar,
		const TDatime &	tm )

set timestamp value for specified parameter from TDatime object

Definition at line 301 of file TSQLStatement.cxx.

◆ SetTimestamp() [2/3]

Bool_t TSQLStatement::SetTimestamp	(	Int_t	,
		const TTimeStamp &	)

virtual

Set parameter as TTimeStamp.

Reimplemented in TSQLiteStatement.

Definition at line 432 of file TSQLStatement.cxx.

◆ SetTimestamp() [3/3]

Bool_t TSQLStatement::SetTimestamp	(	Int_t	,
		Int_t	,
		Int_t	,
		Int_t	,
		Int_t	,
		Int_t	,
		Int_t	,
		Int_t	= 0 )

virtual

Set parameter as timestamp.

Reimplemented in TSQLiteStatement, and TSQLiteStatement.

Definition at line 424 of file TSQLStatement.cxx.

◆ SetUInt()

virtual Bool_t TSQLStatement::SetUInt	(	Int_t	,
		UInt_t	)

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 45 of file TSQLStatement.h.

◆ SetULong64()

virtual Bool_t TSQLStatement::SetULong64	(	Int_t	,
		ULong64_t	)

inlinevirtual

Reimplemented in TSQLiteStatement.

Definition at line 48 of file TSQLStatement.h.

◆ SetVDouble()

virtual Bool_t TSQLStatement::SetVDouble	(	Int_t	,
		const std::vector< Double_t >	,
		const char *	,
		const char *	)

inlinevirtual

Definition at line 69 of file TSQLStatement.h.

◆ SetVInt()

virtual Bool_t TSQLStatement::SetVInt	(	Int_t	,
		const std::vector< Int_t >	,
		const char *	,
		const char *	)

inlinevirtual

Definition at line 64 of file TSQLStatement.h.

◆ SetVLong()

virtual Bool_t TSQLStatement::SetVLong	(	Int_t	,
		const std::vector< Long_t >	,
		const char *	,
		const char *	)

inlinevirtual

Definition at line 66 of file TSQLStatement.h.

◆ SetVLong64()

virtual Bool_t TSQLStatement::SetVLong64	(	Int_t	,
		const std::vector< Long64_t >	,
		const char *	,
		const char *	)

inlinevirtual

Definition at line 67 of file TSQLStatement.h.

◆ SetVUInt()

virtual Bool_t TSQLStatement::SetVUInt	(	Int_t	,
		const std::vector< UInt_t >	,
		const char *	,
		const char *	)

inlinevirtual

Definition at line 65 of file TSQLStatement.h.

◆ SetVULong64()

virtual Bool_t TSQLStatement::SetVULong64	(	Int_t	,
		const std::vector< ULong64_t >	,
		const char *	,
		const char *	)

inlinevirtual

Definition at line 68 of file TSQLStatement.h.

◆ StoreResult()

virtual Bool_t TSQLStatement::StoreResult ( )

pure virtual

Implemented in TSQLiteStatement.

◆ Streamer()

void TSQLStatement::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TSQLStatement::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 121 of file TSQLStatement.h.

Member Data Documentation

◆ fErrorCode

Int_t TSQLStatement::fErrorCode {0}

protected

Definition at line 26 of file TSQLStatement.h.

◆ fErrorMsg

TString TSQLStatement::fErrorMsg

protected

Definition at line 27 of file TSQLStatement.h.

◆ fErrorOut

Bool_t TSQLStatement::fErrorOut {kFALSE}

protected

Definition at line 28 of file TSQLStatement.h.

Libraries for TSQLStatement:

[legend]

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

net/net/inc/TSQLStatement.h
net/net/src/TSQLStatement.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TSQLStatement()

◆ ~TSQLStatement()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ ClearError()

◆ Close()

◆ DeclFileName()

◆ EnableErrorOutput()

◆ GetBinary()

◆ GetBufferLength()

◆ GetDate()

◆ GetDatime() [1/2]

◆ GetDatime() [2/2]

◆ GetDay()

◆ GetDouble()

◆ GetErrorCode()

1. Creation of statement

2. Insert data to data base

3. Getting data from database

4. Working with date/time parameters

5. Binary data

◆ GetErrorMsg()

◆ GetFieldName()

◆ GetHour()

◆ GetInt()

◆ GetLargeObject()

◆ GetLong()

◆ GetLong64()

◆ GetMinute()

◆ GetMonth()

◆ GetNumAffectedRows()

◆ GetNumFields()

◆ GetNumParameters()

◆ GetSecond()

◆ GetSecondsFraction()

◆ GetString()

◆ GetTime()

◆ GetTimestamp() [1/3]

◆ GetTimestamp() [2/3]

◆ GetTimestamp() [3/3]

◆ GetUInt()

◆ GetULong64()

◆ GetVDouble()

◆ GetVInt()

◆ GetVLong()

◆ GetVLong64()

◆ GetVUInt()

◆ GetVULong64()

◆ GetYear()

◆ IsA()

◆ IsError()

◆ IsNull()

◆ NextIteration()

◆ NextResultRow()

◆ Process()

◆ SetBinary()

◆ SetDate() [1/2]

◆ SetDate() [2/2]

◆ SetDatime() [1/2]

◆ SetDatime() [2/2]

◆ SetDouble()

◆ SetError()

◆ SetInt()

◆ SetLargeObject()

◆ SetLong()

◆ SetLong64()

◆ SetMaxFieldSize()

◆ SetNull()

◆ SetString()

◆ SetTime() [1/2]

◆ SetTime() [2/2]

◆ SetTimeFormating()