VTK
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 -------------------------------------------------------------------------*/
52 #ifndef vtkSQLiteDatabase_h
53 #define vtkSQLiteDatabase_h
54 
55 #include "vtkIOSQLModule.h" // For export macro
56 #include "vtkSQLDatabase.h"
57 
58 class vtkSQLQuery;
59 class vtkSQLiteQuery;
60 class vtkStringArray;
62 
63 class VTKIOSQL_EXPORT vtkSQLiteDatabase : public vtkSQLDatabase
64 {
65 
66  friend class vtkSQLiteQuery;
67 
68 public:
70  void PrintSelf(ostream& os, vtkIndent indent) override;
72 
73  enum {
77  CREATE
78  };
79 
81 
90  bool Open(const char* password) override;
91  bool Open(const char* password, int mode);
93 
97  void Close() override;
98 
102  bool IsOpen() override;
103 
108 
113 
117  vtkStringArray* GetRecord(const char *table) override;
118 
122  bool IsSupported(int feature) override;
123 
127  bool HasError() override;
128 
132  const char* GetLastErrorText() override;
133 
135 
138  const char* GetDatabaseType() override
139  {
140  return this->DatabaseType;
141  }
143 
145 
148  vtkGetStringMacro(DatabaseFileName);
149  vtkSetStringMacro(DatabaseFileName);
151 
155  vtkStdString GetURL() override;
156 
164  int tblHandle,
165  int colHandle ) override;
166 
167 protected:
169  ~vtkSQLiteDatabase() override;
170 
176  bool ParseURL(const char* url) override;
177 
178 private:
179  vtkSQLiteDatabaseInternals *Internal;
180 
181  // We want this to be private, a user of this class
182  // should not be setting this for any reason
183  vtkSetStringMacro(DatabaseType);
184 
185  vtkStringArray *Tables;
186 
187  char* DatabaseType;
188  char* DatabaseFileName;
189 
190  vtkStdString TempURL;
191 
192  vtkSQLiteDatabase(const vtkSQLiteDatabase &) = delete;
193  void operator=(const vtkSQLiteDatabase &) = delete;
194 };
195 
196 #endif // vtkSQLiteDatabase_h
197 
vtkSQLiteDatabase::ParseURL
bool ParseURL(const char *url) override
Overridden to determine connection parameters given the URL.
vtkSQLiteDatabase::HasError
bool HasError() override
Did the last operation generate an error.
vtkSQLiteDatabase::IsOpen
bool IsOpen() override
Return whether the database has an open connection.
vtkSQLiteDatabaseInternals
Definition: vtkSQLiteDatabaseInternals.h:22
vtkSQLiteDatabase::GetLastErrorText
const char * GetLastErrorText() override
Get the last error text from the database.
vtkSQLiteDatabase::USE_EXISTING_OR_CREATE
@ USE_EXISTING_OR_CREATE
Definition: vtkSQLiteDatabase.h:75
vtkSQLiteDatabase::IsSupported
bool IsSupported(int feature) override
Return whether a feature is supported by the database.
vtkSQLDatabase.h
vtkSQLiteDatabase::Close
void Close() override
Close the connection to the database.
vtkSQLiteDatabase::USE_EXISTING
@ USE_EXISTING
Definition: vtkSQLiteDatabase.h:74
vtkSQLiteDatabase::New
static vtkSQLiteDatabase * New()
vtkSQLiteDatabase::Open
bool Open(const char *password, int mode)
vtkSQLiteDatabase::Open
bool Open(const char *password) override
Open a new connection to the database.
vtkSQLiteDatabase::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:64
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkSQLiteDatabase::GetColumnSpecification
vtkStdString GetColumnSpecification(vtkSQLDatabaseSchema *schema, int tblHandle, int colHandle) override
Return the SQL string with the syntax to create a column inside a "CREATE TABLE" SQL statement.
vtkSQLiteDatabase::CREATE_OR_CLEAR
@ CREATE_OR_CLEAR
Definition: vtkSQLiteDatabase.h:76
vtkSQLiteQuery::vtkSQLiteDatabase
friend class vtkSQLiteDatabase
Definition: vtkSQLiteQuery.h:57
vtkSQLiteDatabase::GetURL
vtkStdString GetURL() override
Get the URL of the database.
vtkX3D::url
@ url
Definition: vtkX3D.h:233
vtkSQLiteDatabase::GetTables
vtkStringArray * GetTables() override
Get the list of tables from the database.
vtkSQLDatabaseSchema
represent an SQL database schema
Definition: vtkSQLDatabaseSchema.h:65
vtkSQLiteDatabase::GetDatabaseType
const char * GetDatabaseType() override
String representing database type (e.g.
Definition: vtkSQLiteDatabase.h:138
vtkStringArray
a vtkAbstractArray subclass for strings
Definition: vtkStringArray.h:43
vtkSQLiteDatabase::vtkSQLiteDatabase
vtkSQLiteDatabase()
vtkX3D::mode
@ mode
Definition: vtkX3D.h:247
vtkSQLiteDatabase::~vtkSQLiteDatabase
~vtkSQLiteDatabase() override
vtkSQLiteDatabase::GetQueryInstance
vtkSQLQuery * GetQueryInstance() override
Return an empty query on this database.
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:41
vtkSQLiteDatabase::GetRecord
vtkStringArray * GetRecord(const char *table) override
Get the list of fields for a particular table.
vtkSQLQuery
executes an sql query and retrieves results
Definition: vtkSQLQuery.h:75
vtkSQLDatabase
maintain a connection to an sql database
Definition: vtkSQLDatabase.h:91
vtkSQLiteQuery
vtkSQLQuery implementation for SQLite databases
Definition: vtkSQLiteQuery.h:55