Logo ROOT   6.18/05
Reference Guide
TMySQLStatement.h
Go to the documentation of this file.
1// @(#)root/mysql:$Id$
2// Author: Sergey Linev 6/02/2006
3
4/*************************************************************************
5 * Copyright (C) 1995-2006, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
11
12#ifndef ROOT_TMySQLStatement
13#define ROOT_TMySQLStatement
14
15#include "TSQLStatement.h"
16
17
18#include <mysql.h>
19
20#if MYSQL_VERSION_ID < 40100
21typedef struct { int dummy; } MYSQL_STMT;
22typedef struct { int dummy; } MYSQL_BIND;
23#endif
24
25// MariaDB is fork of MySQL and still include definition of my_bool
26// MariaDB major version is 10, therefore it confuses version ID here
27#ifndef MARIADB_VERSION_ID
28#if MYSQL_VERSION_ID > 80000 && MYSQL_VERSION_ID < 100000
29typedef bool my_bool;
30#endif
31#endif
32
34
35protected:
36
37 struct TParamData {
38 void* fMem; //! allocated data buffer
39 Int_t fSize; //! size of allocated data
40 Int_t fSqlType; //! sqltype of parameter
41 Bool_t fSign; //! signed - not signed type
42 ULong_t fResLength; //! length argument
43 my_bool fResNull; //! indicates if argument is null
44 char* fStrBuffer; //! special buffer to be used for string conversions
45 char* fFieldName; //! buffer for field name
46 };
47
48 MYSQL_STMT *fStmt; //! executed statement
49 Int_t fNumBuffers; //! number of statement parameters
50 MYSQL_BIND *fBind; //! array of bind data
51 TParamData *fBuffer; //! parameter definition structures
52 Int_t fWorkingMode; //! 1 - setting parameters, 2 - retrieving results
53 Int_t fIterationCount;//! number of iteration
54 Bool_t fNeedParBind; //! indicates when parameters bind should be called
55
56 Bool_t IsSetParsMode() const { return fWorkingMode==1; }
57 Bool_t IsResultSetMode() const { return fWorkingMode==2; }
58
59 Bool_t SetSQLParamType(Int_t npar, int sqltype, Bool_t sig, ULong_t sqlsize = 0);
60
61 long double ConvertToNumeric(Int_t npar);
62 const char *ConvertToString(Int_t npar);
63
64 void FreeBuffers();
66
67 void *BeforeSet(const char* method, Int_t npar, Int_t sqltype, Bool_t sig = kTRUE, ULong_t size = 0);
68
70
71private:
72 TMySQLStatement(const TMySQLStatement&); // Not implemented.
73 TMySQLStatement &operator=(const TMySQLStatement&); // Not implemented.
74
75public:
76 TMySQLStatement(MYSQL_STMT* stmt, Bool_t errout = kTRUE);
77 virtual ~TMySQLStatement();
78
80 static void SetAllocSizeLimit(ULong_t sz) { fgAllocSizeLimit = sz; }
81
82 virtual void Close(Option_t * = "");
83
84 virtual Int_t GetBufferLength() const { return 1; }
85 virtual Int_t GetNumParameters();
86
87 virtual Bool_t SetNull(Int_t npar);
88 virtual Bool_t SetInt(Int_t npar, Int_t value);
89 virtual Bool_t SetUInt(Int_t npar, UInt_t value);
90 virtual Bool_t SetLong(Int_t npar, Long_t value);
91 virtual Bool_t SetLong64(Int_t npar, Long64_t value);
92 virtual Bool_t SetULong64(Int_t npar, ULong64_t value);
93 virtual Bool_t SetDouble(Int_t npar, Double_t value);
94 virtual Bool_t SetString(Int_t npar, const char* value, Int_t maxsize = 256);
95 virtual Bool_t SetBinary(Int_t npar, void* mem, Long_t size, Long_t maxsize = 0x1000);
96 virtual Bool_t SetDate(Int_t npar, Int_t year, Int_t month, Int_t day);
97 virtual Bool_t SetTime(Int_t npar, Int_t hour, Int_t min, Int_t sec);
98 virtual Bool_t SetDatime(Int_t npar, Int_t year, Int_t month, Int_t day, Int_t hour, Int_t min, Int_t sec);
99 virtual Bool_t SetTimestamp(Int_t npar, Int_t year, Int_t month, Int_t day, Int_t hour, Int_t min, Int_t sec, Int_t frac = 0);
100
101 virtual Bool_t NextIteration();
102
103 virtual Bool_t Process();
104 virtual Int_t GetNumAffectedRows();
105
106 virtual Bool_t StoreResult();
107 virtual Int_t GetNumFields();
108 virtual const char *GetFieldName(Int_t nfield);
109 virtual Bool_t NextResultRow();
110
111 virtual Bool_t IsNull(Int_t npar);
112 virtual Int_t GetInt(Int_t npar);
113 virtual UInt_t GetUInt(Int_t npar);
114 virtual Long_t GetLong(Int_t npar);
115 virtual Long64_t GetLong64(Int_t npar);
116 virtual ULong64_t GetULong64(Int_t npar);
117 virtual Double_t GetDouble(Int_t npar);
118 virtual const char *GetString(Int_t npar);
119 virtual Bool_t GetBinary(Int_t npar, void* &mem, Long_t& size);
120 virtual Bool_t GetDate(Int_t npar, Int_t& year, Int_t& month, Int_t& day);
121 virtual Bool_t GetTime(Int_t npar, Int_t& hour, Int_t& min, Int_t& sec);
122 virtual Bool_t GetDatime(Int_t npar, Int_t& year, Int_t& month, Int_t& day, Int_t& hour, Int_t& min, Int_t& sec);
123 virtual Bool_t GetTimestamp(Int_t npar, Int_t& year, Int_t& month, Int_t& day, Int_t& hour, Int_t& min, Int_t& sec, Int_t&);
124
125 ClassDef(TMySQLStatement, 0); // SQL statement class for MySQL DB
126};
127
128#endif
int Int_t
Definition: RtypesCore.h:41
unsigned int UInt_t
Definition: RtypesCore.h:42
unsigned long ULong_t
Definition: RtypesCore.h:51
long Long_t
Definition: RtypesCore.h:50
bool Bool_t
Definition: RtypesCore.h:59
double Double_t
Definition: RtypesCore.h:55
long long Long64_t
Definition: RtypesCore.h:69
unsigned long long ULong64_t
Definition: RtypesCore.h:70
const Bool_t kTRUE
Definition: RtypesCore.h:87
const char Option_t
Definition: RtypesCore.h:62
#define ClassDef(name, id)
Definition: Rtypes.h:326
static ULong64_t fgAllocSizeLimit
void SetBuffersNumber(Int_t n)
Allocate buffers for statement parameters/ result fields.
void * BeforeSet(const char *method, Int_t npar, Int_t sqltype, Bool_t sig=kTRUE, ULong_t size=0)
Check boundary condition before setting value of parameter.
virtual Int_t GetNumFields()
Return number of fields in result set.
virtual Bool_t GetTimestamp(Int_t npar, Int_t &year, Int_t &month, Int_t &day, Int_t &hour, Int_t &min, Int_t &sec, Int_t &)
Return field value as time stamp.
virtual const char * GetString(Int_t npar)
Return field value as string.
Bool_t IsSetParsMode() const
indicates when parameters bind should be called
virtual Bool_t SetString(Int_t npar, const char *value, Int_t maxsize=256)
Set parameter value as string.
const char * ConvertToString(Int_t npar)
Convert field value to string.
TMySQLStatement(const TMySQLStatement &)
virtual Bool_t Process()
Process statement.
static ULong_t GetAllocSizeLimit()
virtual Bool_t GetTime(Int_t npar, Int_t &hour, Int_t &min, Int_t &sec)
Return field value as time.
MYSQL_STMT * fStmt
virtual Int_t GetBufferLength() const
virtual Bool_t SetDate(Int_t npar, Int_t year, Int_t month, Int_t day)
Set parameter value as date.
virtual Bool_t GetBinary(Int_t npar, void *&mem, Long_t &size)
Return field value as binary array.
virtual Int_t GetNumAffectedRows()
Return number of affected rows after statement is processed.
virtual Bool_t NextResultRow()
Shift cursor to nect row in result set.
virtual Bool_t SetULong64(Int_t npar, ULong64_t value)
Set parameter value as unsigned 64-bit integer.
Int_t fWorkingMode
parameter definition structures
virtual Long_t GetLong(Int_t npar)
Return field value as long integer.
static void SetAllocSizeLimit(ULong_t sz)
void FreeBuffers()
Release all buffers, used by statement.
Int_t fIterationCount
1 - setting parameters, 2 - retrieving results
virtual Bool_t SetDouble(Int_t npar, Double_t value)
Set parameter value as double.
virtual Bool_t SetInt(Int_t npar, Int_t value)
Set parameter value as integer.
virtual Bool_t SetDatime(Int_t npar, Int_t year, Int_t month, Int_t day, Int_t hour, Int_t min, Int_t sec)
Set parameter value as date & time.
virtual Bool_t IsNull(Int_t npar)
Checks if field value is null.
Bool_t IsResultSetMode() const
virtual ~TMySQLStatement()
Destructor.
Bool_t SetSQLParamType(Int_t npar, int sqltype, Bool_t sig, ULong_t sqlsize=0)
Set parameter type to be used as buffer.
virtual Bool_t SetLong(Int_t npar, Long_t value)
Set parameter value as long integer.
virtual Bool_t SetTime(Int_t npar, Int_t hour, Int_t min, Int_t sec)
Set parameter value as time.
virtual void Close(Option_t *="")
Close statement.
TParamData * fBuffer
array of bind data
virtual Bool_t SetUInt(Int_t npar, UInt_t value)
Set parameter value as unsigned integer.
virtual Bool_t NextIteration()
Increment iteration counter for statement, where parameter can be set.
TMySQLStatement & operator=(const TMySQLStatement &)
Bool_t fNeedParBind
number of iteration
virtual Bool_t SetNull(Int_t npar)
Set NULL as parameter value.
virtual Bool_t SetTimestamp(Int_t npar, Int_t year, Int_t month, Int_t day, Int_t hour, Int_t min, Int_t sec, Int_t frac=0)
Set parameter value as timestamp.
virtual UInt_t GetUInt(Int_t npar)
Return field value as unsigned integer.
virtual Int_t GetInt(Int_t npar)
Return field value as integer.
virtual Bool_t SetLong64(Int_t npar, Long64_t value)
Set parameter value as 64-bit integer.
virtual Bool_t GetDate(Int_t npar, Int_t &year, Int_t &month, Int_t &day)
Return field value as date.
virtual ULong64_t GetULong64(Int_t npar)
Return field value as unsigned 64-bit integer.
Int_t fNumBuffers
executed statement
virtual const char * GetFieldName(Int_t nfield)
Returns field name in result set.
virtual Double_t GetDouble(Int_t npar)
Return field value as double.
virtual Bool_t SetBinary(Int_t npar, void *mem, Long_t size, Long_t maxsize=0x1000)
Set parameter value as binary data.
virtual Bool_t StoreResult()
Store result of statement processing to access them via GetInt(), GetDouble() and so on methods.
virtual Int_t GetNumParameters()
Return number of statement parameters.
virtual Bool_t GetDatime(Int_t npar, Int_t &year, Int_t &month, Int_t &day, Int_t &hour, Int_t &min, Int_t &sec)
Return field value as date & time.
virtual Long64_t GetLong64(Int_t npar)
Return field value as 64-bit integer.
long double ConvertToNumeric(Int_t npar)
Convert field to numeric value.
MYSQL_BIND * fBind
number of statement parameters
const Int_t n
Definition: legend1.C:16
char * fFieldName
special buffer to be used for string conversions
Bool_t fSign
sqltype of parameter
char * fStrBuffer
indicates if argument is null
ULong_t fResLength
signed - not signed type
Int_t fSize
allocated data buffer
my_bool fResNull
length argument
Int_t fSqlType
size of allocated data