VTK
vtkPostgreSQLQuery.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPostgreSQLQuery.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 -------------------------------------------------------------------------*/
39 #ifndef vtkPostgreSQLQuery_h
40 #define vtkPostgreSQLQuery_h
41 
42 #include "vtkIOPostgreSQLModule.h" // For export macro
43 #include "vtkSQLQuery.h"
44 
46 class vtkVariant;
47 class vtkVariantArray;
48 class vtkPostgreSQLQueryPrivate;
49 
50 class VTKIOPOSTGRESQL_EXPORT vtkPostgreSQLQuery : public vtkSQLQuery
51 {
52 public:
53  static vtkPostgreSQLQuery* New();
54  void PrintSelf( ostream& os, vtkIndent indent ) override;
56 
62  bool Execute() override;
63 
67  int GetNumberOfFields() override;
68 
72  const char* GetFieldName( int i ) override;
73 
77  int GetFieldType( int i ) override;
78 
82  bool NextRow() override;
83 
87  bool HasError() override;
88 
90 
93  bool BeginTransaction() override;
94  bool RollbackTransaction() override;
95  bool CommitTransaction() override;
97 
101  vtkVariant DataValue( vtkIdType c ) override;
102 
106  const char* GetLastErrorText() override;
107 
111  vtkStdString EscapeString( vtkStdString s, bool addSurroundingQuotes = true ) override;
112 
117  int GetNumberOfRows();
118 
119 protected:
122 
123  vtkSetStringMacro(LastErrorText);
124 
125  bool IsColumnBinary(int whichColumn);
126  const char *GetColumnRawData(int whichColumn);
127 
131 
132  vtkPostgreSQLQueryPrivate *QueryInternals;
133 
134  void DeleteQueryResults();
135 
136  friend class vtkPostgreSQLDatabase;
137 
138 private:
139  vtkPostgreSQLQuery( const vtkPostgreSQLQuery& ) = delete;
140  void operator = ( const vtkPostgreSQLQuery& ) = delete;
141 };
142 
143 #endif // vtkPostgreSQLQuery_h
144 
vtkRowQuery::GetFieldName
virtual const char * GetFieldName(int i)=0
Return the name of the specified query field.
vtkIdType
int vtkIdType
Definition: vtkType.h:347
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.
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::Execute
bool Execute() override=0
Execute the query.
vtkPostgreSQLDatabase
maintain a connection to a PostgreSQL database
Definition: vtkPostgreSQLDatabase.h:60
vtkVariantArray
An array holding vtkVariants.
Definition: vtkVariantArray.h:46
vtkRowQuery::HasError
virtual bool HasError()=0
Returns true if an error is set, otherwise false.
vtkPostgreSQLQuery::CurrentRow
int CurrentRow
Definition: vtkPostgreSQLQuery.h:130
vtkSQLQuery::RollbackTransaction
virtual bool RollbackTransaction()
Definition: vtkSQLQuery.h:111
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkPostgreSQLQuery
vtkSQLQuery implementation for PostgreSQL databases
Definition: vtkPostgreSQLQuery.h:50
vtkVariant
A atomic type representing the union of many types.
Definition: vtkVariant.h:71
vtkPostgreSQLQuery::TransactionInProgress
bool TransactionInProgress
Definition: vtkPostgreSQLQuery.h:128
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.
vtkPostgreSQLQuery::QueryInternals
vtkPostgreSQLQueryPrivate * QueryInternals
Definition: vtkPostgreSQLQuery.h:132
vtkSQLQuery.h
vtkPostgreSQLQuery::LastErrorText
char * LastErrorText
Definition: vtkPostgreSQLQuery.h:129
vtkRowQuery::GetFieldType
virtual int GetFieldType(int i)=0
Return the type of the field, using the constants defined in vtkType.h.
vtkPostgreSQLDatabase::vtkPostgreSQLQuery
friend class vtkPostgreSQLQuery
Definition: vtkPostgreSQLDatabase.h:63
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:40
vtkSQLQuery
executes an sql query and retrieves results
Definition: vtkSQLQuery.h:74
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.