VTK  9.3.1
vtkODBCDatabase.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
4 
57 #ifndef vtkODBCDatabase_h
58 #define vtkODBCDatabase_h
59 
60 #include "vtkIOODBCModule.h" // For export macro
61 #include "vtkSQLDatabase.h"
62 
63 VTK_ABI_NAMESPACE_BEGIN
64 class vtkSQLQuery;
65 class vtkODBCQuery;
66 class vtkStringArray;
67 class vtkODBCInternals;
68 
69 class VTKIOODBC_EXPORT vtkODBCDatabase : public vtkSQLDatabase
70 {
71 
72  friend class vtkODBCQuery;
73 
74 public:
76  void PrintSelf(ostream& os, vtkIndent indent) override;
77  static vtkODBCDatabase* New();
78 
84  bool Open(const char* password) override;
85 
89  void Close() override;
90 
94  bool IsOpen() override;
95 
99  vtkSQLQuery* GetQueryInstance() override;
100 
104  const char* GetLastErrorText() override;
105 
109  vtkStringArray* GetTables() override;
110 
114  vtkStringArray* GetRecord(const char* table) override;
115 
119  bool IsSupported(int feature) override;
120 
122 
127  vtkSetStringMacro(DataSourceName);
128  vtkGetStringMacro(DataSourceName);
130 
131  vtkSetMacro(ServerPort, int);
132  vtkSetStringMacro(HostName);
133  vtkSetStringMacro(UserName);
134  vtkSetStringMacro(DatabaseName);
135  vtkGetStringMacro(DatabaseName);
136  vtkSetStringMacro(Password);
137 
138  bool HasError() override;
139 
141 
144  const char* GetDatabaseType() override { return this->DatabaseType; }
146 
147  vtkStdString GetURL() override;
148 
157  vtkSQLDatabaseSchema* schema, int tblHandle, int colHandle) override;
158 
164  vtkSQLDatabaseSchema* schema, int tblHandle, int idxHandle, bool& skipped) override;
165 
170  bool CreateDatabase(const char* dbName, bool dropExisting);
171 
176  bool DropDatabase(const char* dbName);
177 
183  bool ParseURL(const char* url) override;
184 
185 protected:
186  vtkODBCDatabase();
187  ~vtkODBCDatabase() override;
188 
189  vtkSetStringMacro(LastErrorText);
190 
191 private:
192  vtkStringArray* Tables;
193  vtkStringArray* Record;
194 
195  char* LastErrorText;
196 
197  char* HostName;
198  char* UserName;
199  char* Password;
200  char* DataSourceName;
201  char* DatabaseName;
202  int ServerPort;
203 
204  vtkODBCInternals* Internals;
205 
206  // We want this to be private, a user of this class
207  // should not be setting this for any reason
208  vtkSetStringMacro(DatabaseType);
209 
210  char* DatabaseType;
211 
212  vtkODBCDatabase(const vtkODBCDatabase&) = delete;
213  void operator=(const vtkODBCDatabase&) = delete;
214 };
215 
216 VTK_ABI_NAMESPACE_END
217 #endif // vtkODBCDatabase_h
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:28
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...
virtual bool IsSupported(int vtkNotUsed(feature))
Return whether a feature is supported by the database.
virtual bool Open(const char *password)=0
Open a new connection to the database.
virtual bool ParseURL(const char *url)=0
Subclasses should override this method to determine connection parameters given the URL...
virtual bool HasError()=0
Did the last operation generate an error.
a vtkAbstractArray subclass for strings
virtual vtkStdString GetURL()=0
Get the URL of the database.
represent an SQL database schema
virtual vtkStringArray * GetRecord(const char *table)=0
Get the list of fields for a particular table.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
maintain a connection to an sql database
const char * GetDatabaseType() override
String representing database type (e.g.
virtual void Close()=0
Close the connection to the database.
Simple class to hide ODBC structures.
virtual vtkStdString GetIndexSpecification(vtkSQLDatabaseSchema *schema, int tblHandle, int idxHandle, bool &skipped)
Return the SQL string with the syntax to create an index inside a "CREATE TABLE" SQL statement...
a simple class to control print indentation
Definition: vtkIndent.h:28
friend class vtkODBCDatabase
Definition: vtkODBCQuery.h:34
maintain an ODBC connection to a SQL database
virtual vtkSQLQuery * GetQueryInstance()=0
Return an empty query on this database.
virtual bool IsOpen()=0
Return whether the database has an open connection.
virtual const char * GetLastErrorText()=0
Get the last error text from the database I'm using const so that people do NOT use the standard vtkG...
executes an sql query and retrieves results
Definition: vtkSQLQuery.h:59
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
virtual vtkStringArray * GetTables()=0
Get the list of tables from the database.
vtkSQLQuery implementation for ODBC connections to databases
Definition: vtkODBCQuery.h:31