VTK  9.3.1
vtkODBCQuery.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
3 // SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
18 #ifndef vtkODBCQuery_h
19 #define vtkODBCQuery_h
20 
21 #include "vtkIOODBCModule.h" // For export macro
22 #include "vtkSQLQuery.h"
23 
24 VTK_ABI_NAMESPACE_BEGIN
25 class vtkODBCDatabase;
26 class vtkVariant;
27 class vtkVariantArray;
28 class vtkODBCInternals;
29 class vtkODBCQueryInternals;
30 
31 class VTKIOODBC_EXPORT vtkODBCQuery : public vtkSQLQuery
32 {
33 
34  friend class vtkODBCDatabase;
35 
36 public:
37  vtkTypeMacro(vtkODBCQuery, vtkSQLQuery);
38  void PrintSelf(ostream& os, vtkIndent indent) override;
39  static vtkODBCQuery* New();
40 
46  bool Execute() override;
47 
51  int GetNumberOfFields() override;
52 
56  const char* GetFieldName(int i) override;
57 
61  int GetFieldType(int i) override;
62 
66  bool NextRow() override;
67 
71  bool HasError() override;
72 
76  vtkVariant DataValue(vtkIdType c) override;
77 
81  const char* GetLastErrorText() override;
82 
84 
87  bool BeginTransaction() override;
88  bool CommitTransaction() override;
89  bool RollbackTransaction() override;
91 
93 
98  bool SetQuery(const char* queryString) override;
99  const char* GetQuery() override;
101 
111  bool BindParameter(int index, unsigned char value) override;
112  bool BindParameter(int index, signed char value) override;
113  bool BindParameter(int index, unsigned short value) override;
114  bool BindParameter(int index, signed short value) override;
115  bool BindParameter(int index, unsigned int value) override;
116 
117  bool BindParameter(int index, int value) override;
118 
119  bool BindParameter(int index, unsigned long value) override;
120  bool BindParameter(int index, signed long value) override;
121  bool BindParameter(int index, unsigned long long value) override;
122  bool BindParameter(int index, long long value) override;
123 
124  bool BindParameter(int index, float value) override;
125  bool BindParameter(int index, double value) override;
129  bool BindParameter(int index, const char* stringValue) override;
131 
134  bool BindParameter(int index, const char* stringValue, size_t length) override;
135  bool BindParameter(int index, const vtkStdString& string) override;
138 
143  bool BindParameter(int index, const void* data, size_t length) override;
144  bool ClearParameterBindings() override;
146 
147 protected:
148  vtkODBCQuery();
149  ~vtkODBCQuery() override;
150 
151  vtkSetStringMacro(LastErrorText);
152  vtkSetStringMacro(QueryText);
153  vtkGetStringMacro(QueryText);
154 
155  char* QueryText;
156 
157 private:
158  vtkODBCQuery(const vtkODBCQuery&) = delete;
159  void operator=(const vtkODBCQuery&) = delete;
160 
161  void ClearCurrentRow();
162  bool CacheCurrentRow();
163 
164  bool CacheTimeColumn(int column);
165  bool CacheIntervalColumn(int column);
166  bool CacheCharColumn(int column);
167  bool CacheLongLongColumn(int column);
168  bool CacheBinaryColumn(int column);
169  bool CacheBooleanColumn(int column);
170  bool CacheStringColumn(int column);
171  bool CacheWideStringColumn(int column);
172  bool CacheDecimalColumn(int column);
173  bool CacheNumericColumn(int column);
174  bool CacheIntColumn(int column);
175  bool CacheFloatColumn(int column);
176  bool CacheDoubleColumn(int column);
177 
178  vtkODBCQueryInternals* Internals;
179  bool InitialFetch;
180  char* LastErrorText;
181 };
182 
183 VTK_ABI_NAMESPACE_END
184 #endif // vtkODBCQuery_h
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual bool SetQuery(const char *query)
The query string to be executed.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:28
virtual bool NextRow()=0
Advance row, return false if past end.
An array holding vtkVariants.
bool Execute() override=0
Execute the query.
virtual const char * GetFieldName(int i)=0
Return the name of the specified query field.
virtual const char * GetQuery()
The query string to be executed.
virtual bool BindParameter(int index, unsigned char value)
Bind a parameter to a placeholder in a query.
friend class vtkODBCQuery
virtual bool CommitTransaction()
Definition: vtkSQLQuery.h:95
int vtkIdType
Definition: vtkType.h:315
A type representing the union of many types.
Definition: vtkVariant.h:52
virtual bool HasError()=0
Returns true if an error is set, otherwise false.
Simple class to hide ODBC structures.
a simple class to control print indentation
Definition: vtkIndent.h:28
maintain an ODBC connection to a SQL database
virtual int GetNumberOfFields()=0
The number of fields in the query result.
virtual bool RollbackTransaction()
Definition: vtkSQLQuery.h:96
virtual bool BeginTransaction()
Begin, commit, or roll back a transaction.
Definition: vtkSQLQuery.h:94
virtual int GetFieldType(int i)=0
Return the type of the field, using the constants defined in vtkType.h.
virtual bool ClearParameterBindings()
Reset all parameter bindings to nullptr.
virtual vtkVariant DataValue(vtkIdType c)=0
Return data in current row, field c.
executes an sql query and retrieves results
Definition: vtkSQLQuery.h:59
virtual const char * GetLastErrorText()=0
Get the last error text from the query.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
char * QueryText
Definition: vtkODBCQuery.h:153
vtkSQLQuery implementation for ODBC connections to databases
Definition: vtkODBCQuery.h:31