VTK  9.0.1
vtkSQLiteDatabase.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkSQLiteDatabase.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 -------------------------------------------------------------------------*/
46 #ifndef vtkSQLiteDatabase_h
47 #define vtkSQLiteDatabase_h
48 
49 #include "vtkIOSQLModule.h" // For export macro
50 #include "vtkSQLDatabase.h"
51 
52 class vtkSQLQuery;
53 class vtkSQLiteQuery;
54 class vtkStringArray;
56 
57 class VTKIOSQL_EXPORT vtkSQLiteDatabase : public vtkSQLDatabase
58 {
59 
60  friend class vtkSQLiteQuery;
61 
62 public:
64  void PrintSelf(ostream& os, vtkIndent indent) override;
65  static vtkSQLiteDatabase* New();
66 
67  enum
68  {
72  CREATE
73  };
74 
76 
85  bool Open(const char* password) override;
86  bool Open(const char* password, int mode);
88 
92  void Close() override;
93 
97  bool IsOpen() override;
98 
102  vtkSQLQuery* GetQueryInstance() override;
103 
107  vtkStringArray* GetTables() override;
108 
112  vtkStringArray* GetRecord(const char* table) override;
113 
117  bool IsSupported(int feature) override;
118 
122  bool HasError() override;
123 
127  const char* GetLastErrorText() override;
128 
130 
133  const char* GetDatabaseType() override { return this->DatabaseType; }
135 
137 
140  vtkGetStringMacro(DatabaseFileName);
141  vtkSetStringMacro(DatabaseFileName);
143 
147  vtkStdString GetURL() override;
148 
156  vtkSQLDatabaseSchema* schema, int tblHandle, int colHandle) override;
157 
158 protected:
160  ~vtkSQLiteDatabase() override;
161 
167  bool ParseURL(const char* url) override;
168 
169 private:
170  vtkSQLiteDatabaseInternals* Internal;
171 
172  // We want this to be private, a user of this class
173  // should not be setting this for any reason
174  vtkSetStringMacro(DatabaseType);
175 
176  vtkStringArray* Tables;
177 
178  char* DatabaseType;
179  char* DatabaseFileName;
180 
181  vtkStdString TempURL;
182 
183  vtkSQLiteDatabase(const vtkSQLiteDatabase&) = delete;
184  void operator=(const vtkSQLiteDatabase&) = delete;
185 };
186 
187 #endif // vtkSQLiteDatabase_h
vtkSQLDatabase::GetRecord
virtual vtkStringArray * GetRecord(const char *table)=0
Get the list of fields for a particular table.
vtkSQLDatabase::IsSupported
virtual bool IsSupported(int vtkNotUsed(feature))
Return whether a feature is supported by the database.
Definition: vtkSQLDatabase.h:145
vtkSQLDatabase::Close
virtual void Close()=0
Close the connection to the database.
vtkSQLDatabase::HasError
virtual bool HasError()=0
Did the last operation generate an error.
vtkSQLiteDatabaseInternals
Definition: vtkSQLiteDatabaseInternals.h:21
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkSQLDatabase::GetQueryInstance
virtual vtkSQLQuery * GetQueryInstance()=0
Return an empty query on this database.
vtkSQLDatabase.h
vtkSQLDatabase::IsOpen
virtual bool IsOpen()=0
Return whether the database has an open connection.
vtkSQLDatabase::Open
virtual bool Open(const char *password)=0
Open a new connection to the database.
vtkSQLiteDatabase::CREATE_OR_CLEAR
@ CREATE_OR_CLEAR
Definition: vtkSQLiteDatabase.h:71
vtkSQLiteDatabase::USE_EXISTING_OR_CREATE
@ USE_EXISTING_OR_CREATE
Definition: vtkSQLiteDatabase.h:70
vtkSQLDatabase::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkSQLiteDatabase
maintain a connection to an SQLite database
Definition: vtkSQLiteDatabase.h:57
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkSQLiteQuery::vtkSQLiteDatabase
friend class vtkSQLiteDatabase
Definition: vtkSQLiteQuery.h:57
vtkX3D::url
@ url
Definition: vtkX3D.h:239
vtkSQLDatabase::GetTables
virtual vtkStringArray * GetTables()=0
Get the list of tables from the database.
vtkSQLiteDatabase::USE_EXISTING
@ USE_EXISTING
Definition: vtkSQLiteDatabase.h:69
vtkSQLDatabaseSchema
represent an SQL database schema
Definition: vtkSQLDatabaseSchema.h:61
vtkSQLDatabase::GetURL
virtual vtkStdString GetURL()=0
Get the URL of the database.
vtkSQLDatabase::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.
vtkSQLiteDatabase::GetDatabaseType
const char * GetDatabaseType() override
String representing database type (e.g.
Definition: vtkSQLiteDatabase.h:133
vtkStringArray
a vtkAbstractArray subclass for strings
Definition: vtkStringArray.h:36
vtkX3D::mode
@ mode
Definition: vtkX3D.h:253
vtkSQLDatabase::ParseURL
virtual bool ParseURL(const char *url)=0
Subclasses should override this method to determine connection parameters given the URL.
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:34
vtkSQLDatabase::GetLastErrorText
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...
vtkSQLQuery
executes an sql query and retrieves results
Definition: vtkSQLQuery.h:68
vtkSQLDatabase
maintain a connection to an sql database
Definition: vtkSQLDatabase.h:84
vtkSQLiteQuery
vtkSQLQuery implementation for SQLite databases
Definition: vtkSQLiteQuery.h:54