VTK
vtkPostgreSQLDatabase.h
Go to the documentation of this file.
1 /* -*- Mode: C++; -*- */
2 /*=========================================================================
3 
4  Program: Visualization Toolkit
5  Module: vtkPostgreSQLDatabase.h
6 
7  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
8  All rights reserved.
9  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
10 
11  This software is distributed WITHOUT ANY WARRANTY; without even
12  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
13  PURPOSE. See the above copyright notice for more information.
14 
15 =========================================================================*/
16 /*-------------------------------------------------------------------------
17  Copyright 2008 Sandia Corporation.
18  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
19  the U.S. Government retains certain rights in this software.
20 -------------------------------------------------------------------------*/
49 #ifndef vtkPostgreSQLDatabase_h
50 #define vtkPostgreSQLDatabase_h
51 
52 #include "vtkIOPostgreSQLModule.h" // For export macro
53 #include "vtkSQLDatabase.h"
54 
55 class vtkPostgreSQLQuery;
56 class vtkStringArray;
58 struct PQconn;
59 
60 class VTKIOPOSTGRESQL_EXPORT vtkPostgreSQLDatabase : public vtkSQLDatabase
61 {
62 
63  friend class vtkPostgreSQLQuery;
64  friend class vtkPostgreSQLQueryPrivate;
65 
66 public:
68  void PrintSelf(ostream& os, vtkIndent indent);
70 
76  bool Open( const char* password = 0 );
77 
81  void Close();
82 
86  bool IsOpen();
87 
92 
96  virtual bool HasError();
97 
101  const char* GetLastErrorText();
102 
104 
107  vtkGetStringMacro(DatabaseType);
109 
111 
114  virtual void SetHostName( const char* );
115  vtkGetStringMacro(HostName);
117 
119 
122  virtual void SetUser( const char* );
125 
129  virtual void SetPassword( const char* );
130 
132 
135  virtual void SetDatabaseName( const char* );
136  vtkGetStringMacro(DatabaseName);
138 
140 
143  virtual void SetConnectOptions( const char* );
144  vtkGetStringMacro(ConnectOptions);
146 
148 
151  virtual void SetServerPort( int );
152  virtual int GetServerPortMinValue()
153  {
154  return 0;
155  }
156  virtual int GetServerPortMaxValue()
157  {
158  return VTK_INT_MAX;
159  }
160  vtkGetMacro(ServerPort, int);
162 
169  virtual vtkStdString GetURL();
170 
175 
179  vtkStringArray* GetRecord( const char* table );
180 
184  bool IsSupported( int feature );
185 
190 
195  bool CreateDatabase( const char* dbName, bool dropExisting = false );
196 
201  bool DropDatabase( const char* dbName );
202 
210  vtkSQLDatabaseSchema* schema, int tblHandle, int colHandle );
211 
217  virtual bool ParseURL(const char* url);
218 
219 protected:
222 
238 
239  vtkSetStringMacro(DatabaseType);
240  vtkSetStringMacro(LastErrorText);
241  void NullTrailingWhitespace( char* msg );
242  bool OpenInternal( const char* connectionOptions );
243 
249  char* HostName;
250  char* User;
251  char* Password;
256 
257 private:
258  vtkPostgreSQLDatabase( const vtkPostgreSQLDatabase& ) VTK_DELETE_FUNCTION;
259  void operator = ( const vtkPostgreSQLDatabase& ) VTK_DELETE_FUNCTION;
260 };
261 
262 // This is basically the body of the SetStringMacro but with a
263 // call to update an additional vtkTimeStamp. We inline the implementation
264 // so that wrapping will work.
265 #define vtkSetStringPlusMTimeMacro(className,name,timeStamp) \
266  inline void className::Set##name (const char* _arg) \
267  { \
268  vtkDebugMacro(<< this->GetClassName() << " (" << this << "): setting " << #name " to " << (_arg?_arg:"(null)") ); \
269  if ( this->name == NULL && _arg == NULL) { return;} \
270  if ( this->name && _arg && (!strcmp(this->name,_arg))) { return;} \
271  delete [] this->name; \
272  if (_arg) \
273  { \
274  size_t n = strlen(_arg) + 1; \
275  char *cp1 = new char[n]; \
276  const char *cp2 = (_arg); \
277  this->name = cp1; \
278  do { *cp1++ = *cp2++; } while ( --n ); \
279  } \
280  else \
281  { \
282  this->name = NULL; \
283  } \
284  this->Modified(); \
285  this->timeStamp.Modified(); \
286  this->Close(); /* Force a re-open on next query */ \
287  }
288 
294 
296 {
297  vtkDebugMacro(<< this->GetClassName() << " (" << this << "): setting ServerPort to " << _arg );
298  if ( this->ServerPort != ( _arg < 0 ? 0 : ( _arg > VTK_INT_MAX ? VTK_INT_MAX : _arg ) ) )
299  {
300  this->ServerPort = ( _arg < 0 ? 0 : ( _arg > VTK_INT_MAX ? VTK_INT_MAX : _arg ) );
301  this->Modified();
302  this->URLMTime.Modified();
303  this->Close(); // Force a re-open on next query
304  }
305 }
306 
307 #endif // vtkPostgreSQLDatabase_h
vtkPostgreSQLDatabase::Password
char * Password
Definition: vtkPostgreSQLDatabase.h:251
vtkPostgreSQLDatabasePrivate
internal details of a connection to a PostgreSQL database
Definition: vtkPostgreSQLDatabasePrivate.h:47
vtkPostgreSQLDatabase::~vtkPostgreSQLDatabase
~vtkPostgreSQLDatabase()
vtkPostgreSQLDatabase::New
static vtkPostgreSQLDatabase * New()
VTK_INT_MAX
#define VTK_INT_MAX
Definition: vtkType.h:153
vtkPostgreSQLDatabase::IsSupported
bool IsSupported(int feature)
Return whether a feature is supported by the database.
vtkPostgreSQLDatabase::HostName
char * HostName
Definition: vtkPostgreSQLDatabase.h:249
vtkPostgreSQLDatabase::SetPassword
virtual void SetPassword(const char *)
The user's password for connecting to the database server.
vtkPostgreSQLDatabase::Open
bool Open(const char *password=0)
Open a new connection to the database.
vtkPostgreSQLDatabase::GetServerPortMinValue
virtual int GetServerPortMinValue()
Definition: vtkPostgreSQLDatabase.h:152
vtkPostgreSQLDatabase::GetColumnSpecification
virtual vtkStdString GetColumnSpecification(vtkSQLDatabaseSchema *schema, int tblHandle, int colHandle)
Return the SQL string with the syntax to create a column inside a "CREATE TABLE" SQL statement.
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:36
vtkPostgreSQLDatabase::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkPostgreSQLDatabase::IsOpen
bool IsOpen()
Return whether the database has an open connection.
vtkObject::Modified
virtual void Modified()
Update the modification time for this object.
vtkPostgreSQLDatabase
maintain a connection to a PostgreSQL database
Definition: vtkPostgreSQLDatabase.h:61
vtkPostgreSQLDatabase::DatabaseType
char * DatabaseType
Definition: vtkPostgreSQLDatabase.h:248
vtkPostgreSQLDatabase::URLMTime
vtkTimeStamp URLMTime
Definition: vtkPostgreSQLDatabase.h:244
vtkPostgreSQLDatabase::ServerPort
int ServerPort
Definition: vtkPostgreSQLDatabase.h:253
vtkPostgreSQLDatabase::OpenInternal
bool OpenInternal(const char *connectionOptions)
vtkPostgreSQLDatabase::Connection
vtkPostgreSQLDatabasePrivate * Connection
Definition: vtkPostgreSQLDatabase.h:245
vtkSQLDatabase.h
vtkPostgreSQLDatabase::Close
void Close()
Close the connection to the database.
vtkPostgreSQLDatabase::SetServerPort
virtual void SetServerPort(int)
The port used for connecting to the database.
Definition: vtkPostgreSQLDatabase.h:295
vtkPostgreSQLDatabase::User
char * User
Definition: vtkPostgreSQLDatabase.h:250
vtkPostgreSQLDatabase::GetTables
vtkStringArray * GetTables()
Get the list of tables from the database.
vtkPostgreSQLDatabase::Tables
vtkStringArray * Tables
Definition: vtkPostgreSQLDatabase.h:247
vtkPostgreSQLDatabase::ConnectOptions
char * ConnectOptions
Definition: vtkPostgreSQLDatabase.h:254
vtkObjectBase::GetClassName
const char * GetClassName() const
Return the class name as a string.
vtkPostgreSQLDatabase::SetConnectOptions
virtual void SetConnectOptions(const char *)
Additional options for the database.
vtkTimeStamp::Modified
void Modified()
Set this objects time to the current time.
vtkPostgreSQLDatabase::vtkPostgreSQLDatabase
vtkPostgreSQLDatabase()
vtkPostgreSQLDatabase::ConnectionMTime
vtkTimeStamp ConnectionMTime
Definition: vtkPostgreSQLDatabase.h:246
vtkPostgreSQLDatabase::CreateDatabase
bool CreateDatabase(const char *dbName, bool dropExisting=false)
Create a new database, optionally dropping any existing database of the same name.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkPostgreSQLQuery
vtkSQLQuery implementation for PostgreSQL databases
Definition: vtkPostgreSQLQuery.h:51
vtkPostgreSQLDatabase::GetDatabases
vtkStringArray * GetDatabases()
Return a list of databases on the server.
vtkPostgreSQLDatabase::HasError
virtual bool HasError()
Did the last operation generate an error.
vtkPostgreSQLDatabase::GetServerPortMaxValue
virtual int GetServerPortMaxValue()
Definition: vtkPostgreSQLDatabase.h:156
vtkPostgreSQLDatabase::NullTrailingWhitespace
void NullTrailingWhitespace(char *msg)
vtkX3D::url
@ url
Definition: vtkX3D.h:233
vtkGetStringMacro
vtkGetStringMacro(ExtensionsString)
Returns a string listing all available extensions.
vtkPostgreSQLDatabase::ParseURL
virtual bool ParseURL(const char *url)
Overridden to determine connection parameters given the URL.
vtkPostgreSQLDatabase::GetRecord
vtkStringArray * GetRecord(const char *table)
Get the list of fields for a particular table.
vtkSQLDatabaseSchema
represent an SQL database schema
Definition: vtkSQLDatabaseSchema.h:65
vtkPostgreSQLDatabase::UpdateDataTypeMap
void UpdateDataTypeMap()
Create or refresh the map from Postgres column types to VTK array types.
vtkPostgreSQLDatabase::LastErrorText
char * LastErrorText
Definition: vtkPostgreSQLDatabase.h:255
vtkStringArray
a vtkAbstractArray subclass for strings
Definition: vtkStringArray.h:43
vtkPostgreSQLDatabase::DropDatabase
bool DropDatabase(const char *dbName)
Drop a database if it exists.
vtkSetStringPlusMTimeMacro
#define vtkSetStringPlusMTimeMacro(className, name, timeStamp)
Definition: vtkPostgreSQLDatabase.h:265
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:49
vtkPostgreSQLDatabase::SetDatabaseName
virtual void SetDatabaseName(const char *)
The name of the database to connect to.
vtkPostgreSQLDatabase::GetURL
virtual vtkStdString GetURL()
Get a URL referencing the current database connection.
vtkPostgreSQLDatabase::SetUser
virtual void SetUser(const char *)
The user name for connecting to the database server.
vtkSQLQuery
executes an sql query and retrieves results
Definition: vtkSQLQuery.h:75
vtkPostgreSQLDatabase::GetLastErrorText
const char * GetLastErrorText()
Get the last error text from the database.
vtkPostgreSQLDatabase::DatabaseName
char * DatabaseName
Definition: vtkPostgreSQLDatabase.h:252
vtkPostgreSQLDatabase::SetHostName
virtual void SetHostName(const char *)
The database server host name.
vtkPostgreSQLDatabase::GetQueryInstance
vtkSQLQuery * GetQueryInstance()
Return an empty query on this database.
vtkSQLDatabase
maintain a connection to an sql database
Definition: vtkSQLDatabase.h:91