VTK  9.2.6
vtkSQLDatabase.h
Go to the documentation of this file.
1/*=========================================================================
2
3Program: Visualization Toolkit
4Module: vtkSQLDatabase.h
5
6Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7All rights reserved.
8See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10This software is distributed WITHOUT ANY WARRANTY; without even
11the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12PURPOSE. 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-------------------------------------------------------------------------*/
59#ifndef vtkSQLDatabase_h
60#define vtkSQLDatabase_h
61
62#include "vtkIOSQLModule.h" // For export macro
63#include "vtkObject.h"
64
65#include "vtkStdString.h" // Because at least one method returns a vtkStdString
66
69class vtkSQLQuery;
70class vtkStringArray;
71
72// This is a list of features that each database may or may not
73// support. As yet (April 2008) we don't provide access to most of
74// them.
75#define VTK_SQL_FEATURE_TRANSACTIONS 1000
76#define VTK_SQL_FEATURE_QUERY_SIZE 1001
77#define VTK_SQL_FEATURE_BLOB 1002
78#define VTK_SQL_FEATURE_UNICODE 1003
79#define VTK_SQL_FEATURE_PREPARED_QUERIES 1004
80#define VTK_SQL_FEATURE_NAMED_PLACEHOLDERS 1005
81#define VTK_SQL_FEATURE_POSITIONAL_PLACEHOLDERS 1006
82#define VTK_SQL_FEATURE_LAST_INSERT_ID 1007
83#define VTK_SQL_FEATURE_BATCH_OPERATIONS 1008
84#define VTK_SQL_FEATURE_TRIGGERS 1009 // supported
85
86// Default size for columns types which require a size to be specified
87// (i.e., VARCHAR), when no size has been specified
88#define VTK_SQL_DEFAULT_COLUMN_SIZE 32
89
90class VTKIOSQL_EXPORT vtkSQLDatabase : public vtkObject
91{
92public:
93 vtkTypeMacro(vtkSQLDatabase, vtkObject);
94 void PrintSelf(ostream& os, vtkIndent indent) override;
95
102 virtual bool Open(const char* password) = 0;
103
107 virtual void Close() = 0;
108
112 virtual bool IsOpen() = 0;
113
118
122 virtual bool HasError() = 0;
123
131 virtual const char* GetLastErrorText() = 0;
132
136 virtual const char* GetDatabaseType() = 0;
137
141 virtual vtkStringArray* GetTables() = 0;
142
146 virtual vtkStringArray* GetRecord(const char* table) = 0;
147
151 virtual bool IsSupported(int vtkNotUsed(feature)) { return false; }
152
156 virtual vtkStdString GetURL() = 0;
157
165 virtual vtkStdString GetTablePreamble(bool) { return vtkStdString(); }
166
178 vtkSQLDatabaseSchema* schema, int tblHandle, int colHandle);
179
195 vtkSQLDatabaseSchema* schema, int tblHandle, int idxHandle, bool& skipped);
196
210 vtkSQLDatabaseSchema* schema, int tblHandle, int trgHandle);
211
218
222 virtual bool EffectSchema(vtkSQLDatabaseSchema*, bool dropIfExists = false);
223
227 typedef vtkSQLDatabase* (*CreateFunction)(const char* URL);
228
230
235 static void RegisterCreateFromURLCallback(CreateFunction callback);
236 static void UnRegisterCreateFromURLCallback(CreateFunction callback);
239
249
250protected:
252 ~vtkSQLDatabase() override;
253
259 virtual bool ParseURL(const char* url) = 0;
260
261private:
262 vtkSQLDatabase(const vtkSQLDatabase&) = delete;
263 void operator=(const vtkSQLDatabase&) = delete;
264
266
269 class vtkCallbackVector;
270 static vtkCallbackVector* Callbacks;
272};
273
274#endif // vtkSQLDatabase_h
a simple class to control print indentation
Definition vtkIndent.h:40
Key for vtkObjectBase values.
abstract base class for most VTK objects
Definition vtkObject.h:63
represent an SQL database schema
maintain a connection to an sql database
virtual vtkSQLQuery * GetQueryInstance()=0
Return an empty query on this database.
static vtkInformationObjectBaseKey * DATABASE()
Stores the database class pointer as an information key.
virtual bool Open(const char *password)=0
Open a new connection to the database.
virtual vtkStdString GetTriggerSpecification(vtkSQLDatabaseSchema *schema, int tblHandle, int trgHandle)
Return the SQL string with the syntax to create a trigger using a "CREATE TRIGGER" SQL statement.
virtual vtkStringArray * GetRecord(const char *table)=0
Get the list of fields for a particular table.
virtual const char * GetDatabaseType()=0
Get the type of the database (e.g.
virtual vtkStdString GetTablePreamble(bool)
Return the SQL string with the syntax of the preamble following a "CREATE TABLE" SQL statement.
virtual vtkStdString GetURL()=0
Get the URL of the database.
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 ParseURL(const char *url)=0
Subclasses should override this method to determine connection parameters given the URL.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
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.
~vtkSQLDatabase() override
static vtkSQLDatabase * CreateFromURL(const char *URL)
Create a the proper subclass given a URL.
static void UnRegisterCreateFromURLCallback(CreateFunction callback)
Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQ...
virtual bool HasError()=0
Did the last operation generate an error.
virtual bool IsSupported(int vtkNotUsed(feature))
Return whether a feature is supported by the database.
virtual void Close()=0
Close the connection to the database.
static void RegisterCreateFromURLCallback(CreateFunction callback)
Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQ...
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...
virtual vtkStringArray * GetTables()=0
Get the list of tables from the database.
virtual bool IsOpen()=0
Return whether the database has an open connection.
static void UnRegisterAllCreateFromURLCallbacks()
Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQ...
virtual bool EffectSchema(vtkSQLDatabaseSchema *, bool dropIfExists=false)
Effect a database schema.
executes an sql query and retrieves results
Definition vtkSQLQuery.h:75
Wrapper around std::string to keep symbols short.
a vtkAbstractArray subclass for strings
#define VTK_NEWINSTANCE