VTK
vtkSQLQuery.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkSQLQuery.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 =========================================================================*/
15 /*-------------------------------------------------------------------------
16  Copyright 2008 Sandia Corporation.
17  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18  the U.S. Government retains certain rights in this software.
19 -------------------------------------------------------------------------*/
63 #ifndef vtkSQLQuery_h
64 #define vtkSQLQuery_h
65 
66 #include "vtkIOSQLModule.h" // For export macro
67 #include "vtkRowQuery.h"
68 #include "vtkStdString.h" // for EscapeString()
69 
70 class vtkSQLDatabase;
71 class vtkVariant;
72 class vtkVariantArray;
73 
74 class VTKIOSQL_EXPORT vtkSQLQuery : public vtkRowQuery
75 {
76 public:
77  vtkTypeMacro(vtkSQLQuery, vtkRowQuery);
78  void PrintSelf(ostream& os, vtkIndent indent) override;
79 
81 
86  virtual bool SetQuery(const char *query);
87  virtual const char *GetQuery();
89 
95  bool IsActive() override { return this->Active; }
96 
102  bool Execute() override = 0;
103 
109  virtual bool BeginTransaction() { return true; }
110  virtual bool CommitTransaction() { return true; }
111  virtual bool RollbackTransaction() { return true; }
112 
114 
117  vtkGetObjectMacro(Database, vtkSQLDatabase);
119 
149  virtual bool BindParameter(int index, unsigned char value);
150  virtual bool BindParameter(int index, unsigned short value);
151  virtual bool BindParameter(int index, unsigned int value);
152  virtual bool BindParameter(int index, unsigned long value);
153  // The C and C++ standards leave it up to each compiler to decide
154  // whether chars are signed or unsigned by default. All the other
155  // types are signed unless otherwise specified.
156  virtual bool BindParameter(int index, signed char value);
157  virtual bool BindParameter(int index, short value);
158 
159  virtual bool BindParameter(int index, int value);
160 
161  virtual bool BindParameter(int index, long value);
162  virtual bool BindParameter(int index, unsigned long long value);
163  virtual bool BindParameter(int index, long long value);
164 
165  virtual bool BindParameter(int index, float value);
166  virtual bool BindParameter(int index, double value);
170  virtual bool BindParameter(int index, const char *stringValue);
174  virtual bool BindParameter(int index, const char *stringValue, size_t length);
175 
176  virtual bool BindParameter(int index, const vtkStdString &string);
177 
178  virtual bool BindParameter(int index, vtkVariant var);
184  virtual bool BindParameter(int index, const void *data, size_t length);
188  virtual bool ClearParameterBindings();
189 
200  virtual vtkStdString EscapeString( vtkStdString s, bool addSurroundingQuotes = true );
201 
211  char* EscapeString( const char* src, bool addSurroundingQuotes );
212 
213 protected:
215  ~vtkSQLQuery() override;
216 
224 
225  char* Query;
227  bool Active;
228 
229 private:
230  vtkSQLQuery(const vtkSQLQuery &) = delete;
231  void operator=(const vtkSQLQuery &) = delete;
232 };
233 
234 #endif // vtkSQLQuery_h
235 
vtkStdString.h
vtkSQLQuery::SetQuery
virtual bool SetQuery(const char *query)
The query string to be executed.
vtkX3D::value
@ value
Definition: vtkX3D.h:220
vtkSQLQuery::CommitTransaction
virtual bool CommitTransaction()
Definition: vtkSQLQuery.h:110
vtkSQLQuery::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkX3D::data
@ data
Definition: vtkX3D.h:315
vtkSQLQuery::EscapeString
virtual vtkStdString EscapeString(vtkStdString s, bool addSurroundingQuotes=true)
Escape a string for inclusion into an SQL query.
vtkSQLQuery::Execute
bool Execute() override=0
Execute the query.
vtkSQLQuery::Query
char * Query
Definition: vtkSQLQuery.h:225
vtkRowQuery.h
vtkX3D::length
@ length
Definition: vtkX3D.h:393
vtkVariantArray
An array holding vtkVariants.
Definition: vtkVariantArray.h:47
vtkSQLQuery::IsActive
bool IsActive() override
Return true if the query is active (i.e.
Definition: vtkSQLQuery.h:95
vtkSQLQuery::Active
bool Active
Definition: vtkSQLQuery.h:227
vtkSQLQuery::SetDatabase
void SetDatabase(vtkSQLDatabase *db)
Set the database associated with the query.
vtkSQLQuery::GetQuery
virtual const char * GetQuery()
vtkSQLQuery::RollbackTransaction
virtual bool RollbackTransaction()
Definition: vtkSQLQuery.h:111
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkSQLQuery::EscapeString
char * EscapeString(const char *src, bool addSurroundingQuotes)
Escape a string for inclusion into an SQL query.
vtkVariant
A atomic type representing the union of many types.
Definition: vtkVariant.h:72
vtkSQLQuery::vtkSQLQuery
vtkSQLQuery()
vtkSQLQuery::BeginTransaction
virtual bool BeginTransaction()
Begin, commit, or roll back a transaction.
Definition: vtkSQLQuery.h:109
vtkSQLQuery::~vtkSQLQuery
~vtkSQLQuery() override
vtkSQLQuery::Database
vtkSQLDatabase * Database
Definition: vtkSQLQuery.h:226
vtkRowQuery
abstract interface for queries that return row-oriented results.
Definition: vtkRowQuery.h:63
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:41
vtkSQLQuery::ClearParameterBindings
virtual bool ClearParameterBindings()
Reset all parameter bindings to nullptr.
vtkSQLQuery
executes an sql query and retrieves results
Definition: vtkSQLQuery.h:75
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkSQLDatabase
maintain a connection to an sql database
Definition: vtkSQLDatabase.h:91