VTK  9.3.1
vtkSQLiteQuery.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
28 #ifndef vtkSQLiteQuery_h
29 #define vtkSQLiteQuery_h
30 
31 #include "vtkIOSQLModule.h" // For export macro
32 #include "vtkSQLQuery.h"
33 
34 VTK_ABI_NAMESPACE_BEGIN
35 class vtkSQLiteDatabase;
36 class vtkVariant;
37 class vtkVariantArray;
38 
39 class VTKIOSQL_EXPORT vtkSQLiteQuery : public vtkSQLQuery
40 {
41 
42  friend class vtkSQLiteDatabase;
43 
44 public:
45  vtkTypeMacro(vtkSQLiteQuery, vtkSQLQuery);
46  void PrintSelf(ostream& os, vtkIndent indent) override;
47  static vtkSQLiteQuery* New();
48 
53  bool SetQuery(const char* query) override;
54 
60  bool Execute() override;
61 
65  int GetNumberOfFields() override;
66 
70  const char* GetFieldName(int i) override;
71 
75  int GetFieldType(int i) override;
76 
80  bool NextRow() override;
81 
85  bool HasError() override;
86 
88 
91  bool BeginTransaction() override;
92  bool RollbackTransaction() override;
93  bool CommitTransaction() override;
95 
99  vtkVariant DataValue(vtkIdType c) override;
100 
104  const char* GetLastErrorText() override;
105 
115  bool BindParameter(int index, unsigned char value) override;
116  bool BindParameter(int index, signed char value) override;
117  bool BindParameter(int index, unsigned short value) override;
118  bool BindParameter(int index, short value) override;
119  bool BindParameter(int index, unsigned int value) override;
120 
121  bool BindParameter(int index, int value) override;
122 
123  bool BindParameter(int index, unsigned long value) override;
124  bool BindParameter(int index, long value) override;
125  bool BindParameter(int index, unsigned long long value) override;
126  bool BindParameter(int index, long long value) override;
127 
128  bool BindParameter(int index, float value) override;
129  bool BindParameter(int index, double value) override;
133  bool BindParameter(int index, const char* stringValue) override;
137  bool BindParameter(int index, const char* stringValue, size_t length) override;
138 
139  bool BindParameter(int index, const vtkStdString& string) override;
140 
141  bool BindParameter(int index, vtkVariant value) override;
143 
148  bool BindParameter(int index, const void* data, size_t length) override;
149  bool ClearParameterBindings() override;
151 
152 protected:
153  vtkSQLiteQuery();
154  ~vtkSQLiteQuery() override;
155 
156  vtkSetStringMacro(LastErrorText);
157 
158 private:
159  vtkSQLiteQuery(const vtkSQLiteQuery&) = delete;
160  void operator=(const vtkSQLiteQuery&) = delete;
161 
162  class Priv;
163  Priv* Private;
164  bool InitialFetch;
165  int InitialFetchResult;
166  char* LastErrorText;
167  bool TransactionInProgress;
168 
170 
174  bool BindIntegerParameter(int index, int value);
175  bool BindDoubleParameter(int index, double value);
176  bool BindInt64Parameter(int index, vtkTypeInt64 value);
177  bool BindStringParameter(int index, const char* data, int length);
178  bool BindBlobParameter(int index, const void* data, int length);
180 };
181 
182 VTK_ABI_NAMESPACE_END
183 #endif // vtkSQLiteQuery_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 bool BindParameter(int index, unsigned char value)
Bind a parameter to a placeholder in a query.
maintain a connection to an SQLite database
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.
friend class vtkSQLiteQuery
vtkSQLQuery implementation for SQLite databases
a simple class to control print indentation
Definition: vtkIndent.h:28
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...