VTK
vtkMySQLQuery.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkMySQLQuery.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
36 #ifndef vtkMySQLQuery_h
37 #define vtkMySQLQuery_h
38 
39 #include "vtkIOMySQLModule.h" // For export macro
40 #include "vtkSQLQuery.h"
41 
42 typedef bool my_bool;
43 class vtkMySQLDatabase;
44 class vtkVariant;
45 class vtkVariantArray;
46 class vtkMySQLQueryInternals;
47 
48 class VTKIOMYSQL_EXPORT vtkMySQLQuery : public vtkSQLQuery
49 {
50 
51  friend class vtkMySQLDatabase;
52 
53 public:
54  vtkTypeMacro(vtkMySQLQuery, vtkSQLQuery);
55  void PrintSelf(ostream& os, vtkIndent indent);
56  static vtkMySQLQuery *New();
57 
62  bool SetQuery(const char *query);
63 
69  bool Execute();
70 
72 
78  virtual bool BeginTransaction();
79  virtual bool CommitTransaction();
80  virtual bool RollbackTransaction();
82 
86  int GetNumberOfFields();
87 
91  const char* GetFieldName(int i);
92 
96  int GetFieldType(int i);
97 
101  bool NextRow();
102 
106  bool HasError();
107 
112 
116  const char* GetLastErrorText();
117 
127  bool BindParameter(int index, unsigned char value);
128  bool BindParameter(int index, signed char value);
129  bool BindParameter(int index, unsigned short value);
130  bool BindParameter(int index, signed short value);
131  bool BindParameter(int index, unsigned int value);
132 
133  bool BindParameter(int index, int value);
134 
135  bool BindParameter(int index, unsigned long value);
136  bool BindParameter(int index, signed long value);
137  bool BindParameter(int index, unsigned long long value);
138  bool BindParameter(int index, long long value);
139 
140  bool BindParameter(int index, float value);
141  bool BindParameter(int index, double value);
145  bool BindParameter(int index, const char *stringValue);
147 
150  bool BindParameter(int index, const char *stringValue, size_t length);
151  bool BindParameter(int index, const vtkStdString &string);
153 
155 
160  bool BindParameter(int index, const void *data, size_t length);
161  bool ClearParameterBindings();
163 
167  virtual vtkStdString EscapeString( vtkStdString src, bool addSurroundingQuotes = true );
168 
169 protected:
170  vtkMySQLQuery();
171  ~vtkMySQLQuery();
172 
173  vtkSetStringMacro(LastErrorText);
174 
175 private:
176  vtkMySQLQuery(const vtkMySQLQuery &) VTK_DELETE_FUNCTION;
177  void operator=(const vtkMySQLQuery &) VTK_DELETE_FUNCTION;
178 
179  vtkMySQLQueryInternals *Internals;
180  bool InitialFetch;
181  char *LastErrorText;
182 };
183 
184 #endif // vtkMySQLQuery_h
185 
vtkRowQuery::GetFieldName
virtual const char * GetFieldName(int i)=0
Return the name of the specified query field.
vtkMySQLDatabase::vtkMySQLQuery
friend class vtkMySQLQuery
Definition: vtkMySQLDatabase.h:53
vtkSQLQuery::SetQuery
virtual bool SetQuery(const char *query)
The query string to be executed.
my_bool
bool my_bool
Definition: vtkMySQLQuery.h:42
vtkX3D::value
Definition: vtkX3D.h:220
vtkIdType
int vtkIdType
Definition: vtkType.h:287
vtkSQLQuery::CommitTransaction
virtual bool CommitTransaction()
Definition: vtkSQLQuery.h:110
vtkX3D::data
Definition: vtkX3D.h:315
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkSQLQuery::EscapeString
virtual vtkStdString EscapeString(vtkStdString s, bool addSurroundingQuotes=true)
Escape a string for inclusion into an SQL query.
vtkSQLQuery::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkX3D::length
Definition: vtkX3D.h:393
vtkVariantArray
An array holding vtkVariants.
Definition: vtkVariantArray.h:46
vtkRowQuery::HasError
virtual bool HasError()=0
Returns true if an error is set, otherwise false.
vtkMySQLDatabase
maintain a connection to a MySQL database
Definition: vtkMySQLDatabase.h:50
vtkSQLQuery::BindParameter
virtual bool BindParameter(int index, unsigned char value)
Bind a parameter to a placeholder in a query.
vtkSQLQuery::RollbackTransaction
virtual bool RollbackTransaction()
Definition: vtkSQLQuery.h:111
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkVariant
A atomic type representing the union of many types.
Definition: vtkVariant.h:75
vtkMySQLQuery
vtkSQLQuery implementation for MySQL databases
Definition: vtkMySQLQuery.h:48
vtkRowQuery::GetNumberOfFields
virtual int GetNumberOfFields()=0
The number of fields in the query result.
vtkSQLQuery::BeginTransaction
virtual bool BeginTransaction()
Begin, commit, or roll back a transaction.
Definition: vtkSQLQuery.h:109
vtkRowQuery::DataValue
virtual vtkVariant DataValue(vtkIdType c)=0
Return data in current row, field c.
vtkSQLQuery.h
vtkRowQuery::GetFieldType
virtual int GetFieldType(int i)=0
Return the type of the field, using the constants defined in vtkType.h.
vtkSQLQuery::Execute
virtual bool Execute()=0
Execute the query.
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:47
vtkSQLQuery::ClearParameterBindings
virtual bool ClearParameterBindings()
Reset all parameter bindings to NULL.
vtkSQLQuery
executes an sql query and retrieves results
Definition: vtkSQLQuery.h:74
vtkX3D::index
Definition: vtkX3D.h:246
vtkRowQuery::NextRow
virtual bool NextRow()=0
Advance row, return false if past end.
vtkRowQuery::GetLastErrorText
virtual const char * GetLastErrorText()=0
Get the last error text from the query.