VTK  9.1.0
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-------------------------------------------------------------------------*/
53#ifndef vtkSQLDatabase_h
54#define vtkSQLDatabase_h
55
56#include "vtkIOSQLModule.h" // For export macro
57#include "vtkObject.h"
58
59#include "vtkStdString.h" // Because at least one method returns a vtkStdString
60
63class vtkSQLQuery;
64class vtkStringArray;
65
66// This is a list of features that each database may or may not
67// support. As yet (April 2008) we don't provide access to most of
68// them.
69#define VTK_SQL_FEATURE_TRANSACTIONS 1000
70#define VTK_SQL_FEATURE_QUERY_SIZE 1001
71#define VTK_SQL_FEATURE_BLOB 1002
72#define VTK_SQL_FEATURE_UNICODE 1003
73#define VTK_SQL_FEATURE_PREPARED_QUERIES 1004
74#define VTK_SQL_FEATURE_NAMED_PLACEHOLDERS 1005
75#define VTK_SQL_FEATURE_POSITIONAL_PLACEHOLDERS 1006
76#define VTK_SQL_FEATURE_LAST_INSERT_ID 1007
77#define VTK_SQL_FEATURE_BATCH_OPERATIONS 1008
78#define VTK_SQL_FEATURE_TRIGGERS 1009 // supported
79
80// Default size for columns types which require a size to be specified
81// (i.e., VARCHAR), when no size has been specified
82#define VTK_SQL_DEFAULT_COLUMN_SIZE 32
83
84class VTKIOSQL_EXPORT vtkSQLDatabase : public vtkObject
85{
86public:
87 vtkTypeMacro(vtkSQLDatabase, vtkObject);
88 void PrintSelf(ostream& os, vtkIndent indent) override;
89
96 virtual bool Open(const char* password) = 0;
97
101 virtual void Close() = 0;
102
106 virtual bool IsOpen() = 0;
107
112
116 virtual bool HasError() = 0;
117
125 virtual const char* GetLastErrorText() = 0;
126
130 virtual const char* GetDatabaseType() = 0;
131
135 virtual vtkStringArray* GetTables() = 0;
136
140 virtual vtkStringArray* GetRecord(const char* table) = 0;
141
145 virtual bool IsSupported(int vtkNotUsed(feature)) { return false; }
146
150 virtual vtkStdString GetURL() = 0;
151
159 virtual vtkStdString GetTablePreamble(bool) { return vtkStdString(); }
160
172 vtkSQLDatabaseSchema* schema, int tblHandle, int colHandle);
173
189 vtkSQLDatabaseSchema* schema, int tblHandle, int idxHandle, bool& skipped);
190
204 vtkSQLDatabaseSchema* schema, int tblHandle, int trgHandle);
205
212
216 virtual bool EffectSchema(vtkSQLDatabaseSchema*, bool dropIfExists = false);
217
221 typedef vtkSQLDatabase* (*CreateFunction)(const char* URL);
222
224
229 static void RegisterCreateFromURLCallback(CreateFunction callback);
230 static void UnRegisterCreateFromURLCallback(CreateFunction callback);
233
243
244protected:
246 ~vtkSQLDatabase() override;
247
253 virtual bool ParseURL(const char* url) = 0;
254
255private:
256 vtkSQLDatabase(const vtkSQLDatabase&) = delete;
257 void operator=(const vtkSQLDatabase&) = delete;
258
260
263 class vtkCallbackVector;
264 static vtkCallbackVector* Callbacks;
266};
267
268#endif // vtkSQLDatabase_h
a simple class to control print indentation
Definition: vtkIndent.h:113
Key for vtkObjectBase values.
abstract base class for most VTK objects
Definition: vtkObject.h:82
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:69
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:105
a vtkAbstractArray subclass for strings
#define VTK_NEWINSTANCE