VTK  9.3.1
vtkSQLiteDatabase.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
36 #ifndef vtkSQLiteDatabase_h
37 #define vtkSQLiteDatabase_h
38 
39 #include "vtkIOSQLModule.h" // For export macro
40 #include "vtkSQLDatabase.h"
41 
42 VTK_ABI_NAMESPACE_BEGIN
43 class vtkSQLQuery;
44 class vtkSQLiteQuery;
45 class vtkStringArray;
47 
48 class VTKIOSQL_EXPORT vtkSQLiteDatabase : public vtkSQLDatabase
49 {
50 
51  friend class vtkSQLiteQuery;
52 
53 public:
55  void PrintSelf(ostream& os, vtkIndent indent) override;
56  static vtkSQLiteDatabase* New();
57 
58  enum
59  {
63  CREATE
64  };
65 
67 
76  bool Open(const char* password) override;
77  bool Open(const char* password, int mode);
79 
83  void Close() override;
84 
88  bool IsOpen() override;
89 
93  vtkSQLQuery* GetQueryInstance() override;
94 
98  vtkStringArray* GetTables() override;
99 
103  vtkStringArray* GetRecord(const char* table) override;
104 
108  bool IsSupported(int feature) override;
109 
113  bool HasError() override;
114 
118  const char* GetLastErrorText() override;
119 
121 
124  const char* GetDatabaseType() override { return this->DatabaseType; }
126 
128 
131  vtkGetFilePathMacro(DatabaseFileName);
132  vtkSetFilePathMacro(DatabaseFileName);
134 
138  vtkStdString GetURL() override;
139 
149  vtkSQLDatabaseSchema* schema, int tblHandle, int colHandle) override;
150 
151 protected:
153  ~vtkSQLiteDatabase() override;
154 
160  bool ParseURL(const char* url) override;
161 
162 private:
163  vtkSQLiteDatabaseInternals* Internal;
164 
165  // We want this to be private, a user of this class
166  // should not be setting this for any reason
167  vtkSetStringMacro(DatabaseType);
168 
169  vtkStringArray* Tables;
170 
171  char* DatabaseType;
172  char* DatabaseFileName;
173 
174  vtkStdString TempURL;
175 
176  vtkSQLiteDatabase(const vtkSQLiteDatabase&) = delete;
177  void operator=(const vtkSQLiteDatabase&) = delete;
178 };
179 
180 VTK_ABI_NAMESPACE_END
181 #endif // vtkSQLiteDatabase_h
friend class vtkSQLiteDatabase
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...
maintain a connection to an SQLite database
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
vtkSQLQuery implementation for SQLite databases
virtual void Close()=0
Close the connection to the database.
a simple class to control print indentation
Definition: vtkIndent.h:28
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
const char * GetDatabaseType() override
String representing database type (e.g.
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.