Logo ROOT  
Reference Guide
TSQLiteServer Class Reference

Definition at line 19 of file TSQLiteServer.h.

Public Member Functions

 TSQLiteServer (const char *db, const char *uid=nullptr, const char *pw=nullptr)
 Open a connection to an SQLite DB server. More...
 
 ~TSQLiteServer ()
 Close SQLite DB. More...
 
 ClassDefOverride (TSQLiteServer, 0)
 
void Close (Option_t *opt="") final
 Close connection to SQLite DB. More...
 
Int_t CreateDataBase (const char *dbname) final
 Create a database. More...
 
Int_t DropDataBase (const char *dbname) final
 Drop (i.e. More...
 
Bool_t Exec (const char *sql) final
 Execute SQL command which does not produce any result sets. More...
 
TSQLResultGetColumns (const char *dbname, const char *table, const char *wild=nullptr) final
 List all columns in specified table (database argument is ignored). More...
 
TSQLResultGetDataBases (const char *wild=nullptr) final
 List all available databases. More...
 
TSQLTableInfoGetTableInfo (const char *tablename) final
 Produces SQL table info. More...
 
TSQLResultGetTables (const char *dbname, const char *wild=nullptr) final
 List all tables in the specified database. More...
 
Bool_t HasStatement () const final
 We assume prepared statements work for all SQLite-versions. More...
 
TSQLResultQuery (const char *sql) final
 Execute SQL command. More...
 
Int_t Reload () final
 Reload permission tables. More...
 
Int_t SelectDataBase (const char *dbname) final
 Select a database. More...
 
const char * ServerInfo () final
 Return server info, must be deleted by user. More...
 
Int_t Shutdown () final
 Shutdown the database server. More...
 
Bool_t StartTransaction () final
 submit "START TRANSACTION" query to database return kTRUE, if successful More...
 
TSQLStatementStatement (const char *sql, Int_t=100) final
 Produce TSQLiteStatement. More...
 
- Public Member Functions inherited from TSQLServer
virtual ~TSQLServer ()
 
virtual Bool_t Commit ()
 submit "COMMIT" query to database return kTRUE, if successful More...
 
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 More...
 
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 More...
 
const char * GetHost () const
 
virtual Int_t GetMaxIdentifierLength ()
 
Int_t GetPort () const
 
virtual TListGetTablesList (const char *wild=nullptr)
 Return list of user tables Parameter wild specifies wildcard for table names. More...
 
virtual Bool_t HasTable (const char *tablename)
 Tests if table of that name exists in database Return kTRUE, if table exists. More...
 
virtual Bool_t IsConnected () const
 
virtual Bool_t IsError () const
 
virtual Int_t Ping ()
 
virtual Bool_t PingVerify ()
 
virtual Bool_t Rollback ()
 submit "ROLLBACK" query to database return kTRUE, if successful More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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. More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Private Attributes

sqlite3 * fSQLite {nullptr}
 
TString fSrvInfo
 

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 = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TSQLServer
static TSQLServerConnect (const char *db, const char *uid, const char *pw)
 The db should be of the form: <dbms>://<host>[:<port>][/<database>], e.g. More...
 
static const char * GetFloatFormat ()
 return current printf format for float/double members, default "%e" More...
 
static void SetFloatFormat (const char *fmt="%e")
 set printf format for float/double members, default "%e" More...
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Member Functions inherited from TSQLServer
 TSQLServer ()
 
void ClearError ()
 reset error fields More...
 
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 More...
 
- 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). More...
 
void MakeZombie ()
 
- 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
 
- Static Protected Attributes inherited from TSQLServer
static const char * fgFloatFmt = "%e"
 

#include <TSQLiteServer.h>

Inheritance diagram for TSQLiteServer:
[legend]

Constructor & Destructor Documentation

◆ TSQLiteServer()

TSQLiteServer::TSQLiteServer ( const char *  db,
const char *  uid = nullptr,
const char *  pw = nullptr 
)

Open a connection to an SQLite DB server.

The db arguments should be of the form "sqlite://<database>", e.g.: "sqlite://test.sqlite" or "sqlite://:memory:" for a temporary database in memory. Note that for SQLite versions >= 3.7.7 the full string behind "sqlite://" is handed to sqlite3_open_v2() with SQLITE_OPEN_URI activated, so all URI accepted by it can be used.

Definition at line 33 of file TSQLiteServer.cxx.

◆ ~TSQLiteServer()

TSQLiteServer::~TSQLiteServer ( )

Close SQLite DB.

Definition at line 76 of file TSQLiteServer.cxx.

Member Function Documentation

◆ ClassDefOverride()

TSQLiteServer::ClassDefOverride ( TSQLiteServer  ,
 
)

◆ Close()

void TSQLiteServer::Close ( Option_t opt = "")
finalvirtual

Close connection to SQLite DB.

Implements TSQLServer.

Definition at line 86 of file TSQLiteServer.cxx.

◆ CreateDataBase()

Int_t TSQLiteServer::CreateDataBase ( const char *  dbname)
finalvirtual

Create a database.

Always returns non-zero for SQLite, as it has only one DB per file.

Implements TSQLServer.

Definition at line 281 of file TSQLiteServer.cxx.

◆ DropDataBase()

Int_t TSQLiteServer::DropDataBase ( const char *  dbname)
finalvirtual

Drop (i.e.

delete) a database. Always returns non-zero for SQLite, as it has only one DB per file.

Implements TSQLServer.

Definition at line 291 of file TSQLiteServer.cxx.

◆ Exec()

Bool_t TSQLiteServer::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 142 of file TSQLiteServer.cxx.

◆ GetColumns()

TSQLResult * TSQLiteServer::GetColumns ( const char *  dbname,
const char *  table,
const char *  wild = nullptr 
)
finalvirtual

List all columns in specified table (database argument is ignored).

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. For SQLite, this fails with wildcard, as the column names are not queryable! If no wildcard is used, the result of PRAGMA table_info(table) is returned, which contains the names in field 1.

Implements TSQLServer.

Definition at line 209 of file TSQLiteServer.cxx.

◆ GetDataBases()

TSQLResult * TSQLiteServer::GetDataBases ( const char *  wild = nullptr)
finalvirtual

List all available databases.

Always returns 0 for SQLite, as only one DB exists per file.

Implements TSQLServer.

Definition at line 174 of file TSQLiteServer.cxx.

◆ GetTableInfo()

TSQLTableInfo * TSQLiteServer::GetTableInfo ( const char *  tablename)
finalvirtual

Produces SQL table info.

Object must be deleted by user.

Reimplemented from TSQLServer.

Definition at line 230 of file TSQLiteServer.cxx.

◆ GetTables()

TSQLResult * TSQLiteServer::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 186 of file TSQLiteServer.cxx.

◆ HasStatement()

Bool_t TSQLiteServer::HasStatement ( ) const
finalvirtual

We assume prepared statements work for all SQLite-versions.

As we actually use the recommended sqlite3_prepare(), or, if possible, sqlite3_prepare_v2(), this already introduces the "compile time check".

Reimplemented from TSQLServer.

Definition at line 333 of file TSQLiteServer.cxx.

◆ Query()

TSQLResult * TSQLiteServer::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 114 of file TSQLiteServer.cxx.

◆ Reload()

Int_t TSQLiteServer::Reload ( )
finalvirtual

Reload permission tables.

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

Implements TSQLServer.

Definition at line 301 of file TSQLiteServer.cxx.

◆ SelectDataBase()

Int_t TSQLiteServer::SelectDataBase ( const char *  dbname)
finalvirtual

Select a database.

Always returns non-zero for SQLite, as only one DB exists per file.

Implements TSQLServer.

Definition at line 164 of file TSQLiteServer.cxx.

◆ ServerInfo()

const char * TSQLiteServer::ServerInfo ( )
finalvirtual

Return server info, must be deleted by user.

Implements TSQLServer.

Definition at line 377 of file TSQLiteServer.cxx.

◆ Shutdown()

Int_t TSQLiteServer::Shutdown ( )
finalvirtual

Shutdown the database server.

Returns 0 if successful, non-zero otherwise. Makes no sense for SQLite, always returns -1.

Implements TSQLServer.

Definition at line 316 of file TSQLiteServer.cxx.

◆ StartTransaction()

Bool_t TSQLiteServer::StartTransaction ( )
finalvirtual

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

Reimplemented from TSQLServer.

Definition at line 104 of file TSQLiteServer.cxx.

◆ Statement()

TSQLStatement * TSQLiteServer::Statement ( const char *  sql,
Int_t  = 100 
)
finalvirtual

Produce TSQLiteStatement.

Reimplemented from TSQLServer.

Definition at line 341 of file TSQLiteServer.cxx.

Member Data Documentation

◆ fSQLite

sqlite3* TSQLiteServer::fSQLite {nullptr}
private

Definition at line 23 of file TSQLiteServer.h.

◆ fSrvInfo

TString TSQLiteServer::fSrvInfo
private

Definition at line 22 of file TSQLiteServer.h.

Libraries for TSQLiteServer:
[legend]

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