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 
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);
163 
167  virtual vtkStdString EscapeString( vtkStdString src, bool addSurroundingQuotes = true );
168 
169 protected:
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 
vtkMySQLDatabase::vtkMySQLQuery
friend class vtkMySQLQuery
Definition: vtkMySQLDatabase.h:53
vtkMySQLQuery::BindParameter
bool BindParameter(int index, const void *data, size_t length)
Bind a blob value.
my_bool
bool my_bool
Definition: vtkMySQLQuery.h:42
vtkMySQLQuery::BindParameter
bool BindParameter(int index, signed short value)
vtkMySQLQuery::vtkMySQLQuery
vtkMySQLQuery()
vtkMySQLQuery::BindParameter
bool BindParameter(int index, int value)
vtkMySQLQuery::DataValue
vtkVariant DataValue(vtkIdType c)
Return data in current row, field c.
vtkMySQLQuery::BindParameter
bool BindParameter(int index, signed long value)
vtkX3D::value
@ value
Definition: vtkX3D.h:220
vtkMySQLQuery::ClearParameterBindings
bool ClearParameterBindings()
Reset all parameter bindings to NULL.
vtkIdType
int vtkIdType
Definition: vtkType.h:287
vtkX3D::data
@ data
Definition: vtkX3D.h:315
vtkMySQLQuery::BindParameter
bool BindParameter(int index, unsigned int value)
vtkMySQLQuery::BindParameter
bool BindParameter(int index, unsigned long value)
vtkX3D::length
@ length
Definition: vtkX3D.h:393
vtkVariantArray
An array holding vtkVariants.
Definition: vtkVariantArray.h:47
vtkMySQLQuery::HasError
bool HasError()
Return true if there is an error on the current query.
vtkMySQLQuery::GetNumberOfFields
int GetNumberOfFields()
The number of fields in the query result.
vtkMySQLQuery::BeginTransaction
virtual bool BeginTransaction()
Begin, commit, or roll back a transaction.
vtkMySQLDatabase
maintain a connection to a MySQL database
Definition: vtkMySQLDatabase.h:51
vtkSQLQuery::BindParameter
virtual bool BindParameter(int index, unsigned char value)
Bind a parameter to a placeholder in a query.
vtkMySQLQuery::BindParameter
bool BindParameter(int index, long long value)
vtkMySQLQuery::BindParameter
bool BindParameter(int index, const vtkStdString &string)
vtkMySQLQuery::BindParameter
bool BindParameter(int index, unsigned long long value)
vtkMySQLQuery::GetLastErrorText
const char * GetLastErrorText()
Get the last error text from the query.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkMySQLQuery::SetQuery
bool SetQuery(const char *query)
Set the SQL query string.
vtkMySQLQuery::GetFieldType
int GetFieldType(int i)
Return the type of the field, using the constants defined in vtkType.h.
vtkVariant
A atomic type representing the union of many types.
Definition: vtkVariant.h:76
vtkMySQLQuery::BindParameter
bool BindParameter(int index, unsigned char value)
Bind a parameter to a placeholder in a query.
vtkMySQLQuery::RollbackTransaction
virtual bool RollbackTransaction()
vtkMySQLQuery
vtkSQLQuery implementation for MySQL databases
Definition: vtkMySQLQuery.h:49
vtkMySQLQuery::BindParameter
bool BindParameter(int index, signed char value)
vtkMySQLQuery::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkMySQLQuery::GetFieldName
const char * GetFieldName(int i)
Return the name of the specified query field.
vtkMySQLQuery::BindParameter
bool BindParameter(int index, double value)
vtkSQLQuery.h
vtkMySQLQuery::NextRow
bool NextRow()
Advance row, return false if past end.
vtkMySQLQuery::~vtkMySQLQuery
~vtkMySQLQuery()
vtkMySQLQuery::BindParameter
bool BindParameter(int index, float value)
vtkMySQLQuery::EscapeString
virtual vtkStdString EscapeString(vtkStdString src, bool addSurroundingQuotes=true)
Escape a string for use in a query.
vtkMySQLQuery::CommitTransaction
virtual bool CommitTransaction()
vtkMySQLQuery::New
static vtkMySQLQuery * New()
vtkMySQLQuery::Execute
bool Execute()
Execute the query.
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:49
vtkSQLQuery
executes an sql query and retrieves results
Definition: vtkSQLQuery.h:75
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkMySQLQuery::BindParameter
bool BindParameter(int index, const char *stringValue, size_t length)
Bind a string value by specifying an array and a size.
vtkMySQLQuery::BindParameter
bool BindParameter(int index, unsigned short value)
vtkMySQLQuery::BindParameter
bool BindParameter(int index, const char *stringValue)
Bind a string value – string must be null-terminated.