VTK
9.3.20241008
|
maintain a connection to an sql database More...
#include <vtkSQLDatabase.h>
Public Types | |
typedef vtkObject | Superclass |
typedef vtkSQLDatabase *(* | CreateFunction) (const char *URL) |
Type for CreateFromURL callback. | |
Public Member Functions | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkSQLDatabase * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual bool | Open (const char *password)=0 |
Open a new connection to the database. | |
virtual void | Close ()=0 |
Close the connection to the database. | |
virtual bool | IsOpen ()=0 |
Return whether the database has an open connection. | |
virtual vtkSQLQuery * | GetQueryInstance ()=0 |
Return an empty query on this database. | |
virtual bool | HasError ()=0 |
Did the last operation generate an error. | |
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 vtkGetStringMacro in their implementation, because 99% of the time that will not be the correct thing to do... | |
virtual const char * | GetDatabaseType ()=0 |
Get the type of the database (e.g. | |
virtual vtkStringArray * | GetTables ()=0 |
Get the list of tables from the database. | |
virtual vtkStringArray * | GetRecord (const char *table)=0 |
Get the list of fields for a particular table. | |
virtual bool | IsSupported (int vtkNotUsed(feature)) |
Return whether a feature is supported by the database. | |
virtual vtkStdString | GetURL ()=0 |
Get the URL of the database. | |
virtual vtkStdString | GetTablePreamble (bool) |
Return the SQL string with the syntax of the preamble following a "CREATE TABLE" SQL statement. | |
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 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. | |
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 bool | EffectSchema (vtkSQLDatabaseSchema *, bool dropIfExists=false) |
Effect a database schema. | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
vtkTypeBool | HasObserver (unsigned long event) |
vtkTypeBool | HasObserver (const char *event) |
vtkTypeBool | InvokeEvent (unsigned long event) |
vtkTypeBool | InvokeEvent (const char *event) |
std::string | GetObjectDescription () const override |
The object description printed in messages and PrintSelf output. | |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Allow user to set the AbortFlagOn() with the return value of the callback method. | |
vtkTypeBool | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
vtkTypeBool | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
virtual void | SetObjectName (const std::string &objectName) |
Set/get the name of this object for reporting purposes. | |
virtual std::string | GetObjectName () const |
Set/get the name of this object for reporting purposes. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual std::string | GetObjectDescription () const |
The object description printed in messages and PrintSelf output. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual bool | UsesGarbageCollector () const |
Indicate whether the class uses vtkGarbageCollector or not. | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkSQLDatabase * | SafeDownCast (vtkObjectBase *o) |
static vtkSQLDatabase * | CreateFromURL (const char *URL) |
Create a the proper subclass given a URL. | |
static vtkInformationObjectBaseKey * | DATABASE () |
Stores the database class pointer as an information key. | |
static void | RegisterCreateFromURLCallback (CreateFunction callback) |
Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols. | |
static void | UnRegisterCreateFromURLCallback (CreateFunction callback) |
Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols. | |
static void | UnRegisterAllCreateFromURLCallbacks () |
Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols. | |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (vtkTypeBool val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static vtkTypeBool | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
Static Public Member Functions inherited from vtkObjectBase | |
static vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. | |
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkSQLDatabase () | |
~vtkSQLDatabase () override | |
virtual bool | ParseURL (const char *url)=0 |
Subclasses should override this method to determine connection parameters given the URL. | |
Protected Member Functions inherited from vtkObject | |
vtkObject () | |
~vtkObject () override | |
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods allow a command to exclusively grab all events. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
virtual void | ObjectFinalize () |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
Protected Attributes inherited from vtkObject | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
std::string | ObjectName |
Protected Attributes inherited from vtkObjectBase | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
maintain a connection to an sql database
Abstract base class for all SQL database connection classes. Manages a connection to the database, and is responsible for creating instances of the associated vtkSQLQuery objects associated with this class in order to perform execute queries on the database. To allow connections to a new type of database, create both a subclass of this class and vtkSQLQuery, and implement the required functions:
Open() - open the database connection, if possible. Close() - close the connection. GetQueryInstance() - create and return an instance of the vtkSQLQuery subclass associated with the database type.
The subclass should also provide API to set connection parameters.
This class also provides the function EffectSchema to transform a database schema into a SQL database.
Definition at line 75 of file vtkSQLDatabase.h.
typedef vtkObject vtkSQLDatabase::Superclass |
Definition at line 78 of file vtkSQLDatabase.h.
typedef vtkSQLDatabase *(* vtkSQLDatabase::CreateFunction) (const char *URL) |
Type for CreateFromURL callback.
Definition at line 212 of file vtkSQLDatabase.h.
|
protected |
|
overrideprotected |
|
static |
|
virtual |
Return 1 if this class is the same type of (or a subclass of) the named class.
Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObjectBase.
Reimplemented in vtkQtSQLDatabase, vtkMySQLDatabase, vtkODBCDatabase, vtkPostgreSQLDatabase, and vtkSQLiteDatabase.
|
static |
|
protectedvirtual |
Reimplemented in vtkQtSQLDatabase, vtkMySQLDatabase, vtkODBCDatabase, vtkPostgreSQLDatabase, and vtkSQLiteDatabase.
vtkSQLDatabase * vtkSQLDatabase::NewInstance | ( | ) | const |
|
overridevirtual |
Methods invoked by print to print information about the object including superclasses.
Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkObject.
Reimplemented in vtkSQLiteDatabase.
|
pure virtual |
Open a new connection to the database.
You need to set up any database parameters before calling this function. For database connections that do not require a password, pass an empty string. Returns true is the database was opened successfully, and false otherwise.
Implemented in vtkQtSQLDatabase, vtkODBCDatabase, vtkSQLiteDatabase, vtkMySQLDatabase, and vtkPostgreSQLDatabase.
|
pure virtual |
Close the connection to the database.
Implemented in vtkQtSQLDatabase, vtkMySQLDatabase, vtkODBCDatabase, vtkPostgreSQLDatabase, and vtkSQLiteDatabase.
|
pure virtual |
Return whether the database has an open connection.
Implemented in vtkQtSQLDatabase, vtkMySQLDatabase, vtkODBCDatabase, vtkPostgreSQLDatabase, and vtkSQLiteDatabase.
|
pure virtual |
Return an empty query on this database.
Implemented in vtkQtSQLDatabase, vtkMySQLDatabase, vtkODBCDatabase, vtkPostgreSQLDatabase, and vtkSQLiteDatabase.
|
pure virtual |
Did the last operation generate an error.
Implemented in vtkQtSQLDatabase, vtkMySQLDatabase, vtkODBCDatabase, vtkPostgreSQLDatabase, and vtkSQLiteDatabase.
|
pure virtual |
Get the last error text from the database I'm using const so that people do NOT use the standard vtkGetStringMacro in their implementation, because 99% of the time that will not be the correct thing to do...
Implemented in vtkQtSQLDatabase, vtkMySQLDatabase, vtkODBCDatabase, vtkPostgreSQLDatabase, and vtkSQLiteDatabase.
|
pure virtual |
Get the type of the database (e.g.
mysql, psql,..).
Implemented in vtkQtSQLDatabase, vtkMySQLDatabase, vtkODBCDatabase, vtkPostgreSQLDatabase, and vtkSQLiteDatabase.
|
pure virtual |
Get the list of tables from the database.
Implemented in vtkQtSQLDatabase, vtkMySQLDatabase, vtkODBCDatabase, vtkPostgreSQLDatabase, and vtkSQLiteDatabase.
|
pure virtual |
Get the list of fields for a particular table.
Implemented in vtkQtSQLDatabase, vtkMySQLDatabase, vtkODBCDatabase, vtkPostgreSQLDatabase, and vtkSQLiteDatabase.
|
inlinevirtual |
Return whether a feature is supported by the database.
Definition at line 136 of file vtkSQLDatabase.h.
|
pure virtual |
Get the URL of the database.
Implemented in vtkQtSQLDatabase, vtkMySQLDatabase, vtkODBCDatabase, vtkPostgreSQLDatabase, and vtkSQLiteDatabase.
|
inlinevirtual |
Return the SQL string with the syntax of the preamble following a "CREATE TABLE" SQL statement.
NB: by default, this method returns an empty string. It must be overwritten for those SQL backends which allow such preambles such as, e.g., MySQL.
Reimplemented in vtkMySQLDatabase.
Definition at line 150 of file vtkSQLDatabase.h.
|
virtual |
Return the SQL string with the syntax to create a column inside a "CREATE TABLE" SQL statement.
NB: this method implements the following minimally-portable syntax:
It must be overwritten for those SQL backends which have a different syntax such as, e.g., MySQL.
Reimplemented in vtkMySQLDatabase, vtkODBCDatabase, vtkPostgreSQLDatabase, and vtkSQLiteDatabase.
|
virtual |
Return the SQL string with the syntax to create an index inside a "CREATE TABLE" SQL statement.
NB1: this method implements the following minimally-portable syntax:
It must be overwritten for those SQL backends which have a different syntax such as, e.g., MySQL. NB2: this method does not assume that INDEX creation is supported within a CREATE TABLE statement. Therefore, should such an INDEX arise in the schema, a CREATE INDEX statement is returned and skipped is set to true. Otherwise, skipped will always be returned false.
Reimplemented in vtkMySQLDatabase, and vtkODBCDatabase.
|
virtual |
Return the SQL string with the syntax to create a trigger using a "CREATE TRIGGER" SQL statement.
NB1: support is contingent on VTK_FEATURE_TRIGGERS being recognized as a supported feature. Not all backends (e.g., SQLite) support it. NB2: this method implements the following minimally-portable syntax:
It must be overwritten for those SQL backends which have a different syntax such as, e.g., PostgreSQL.
|
static |
Create a the proper subclass given a URL.
The URL format for SQL databases is a true URL of the form: 'protocol://'[[username[':'password]'@']hostname[':'port]]'/'[dbname] .
|
virtual |
Effect a database schema.
|
static |
Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols.
The registered callbacks are tried in the order they are registered.
|
static |
Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols.
The registered callbacks are tried in the order they are registered.
|
static |
Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols.
The registered callbacks are tried in the order they are registered.
|
static |
Stores the database class pointer as an information key.
This is currently used to store database pointers as part of 'data on demand' data objects. For example: The application may have a table/tree/whatever of documents, the data structure is storing the meta-data but not the full text. Further down the pipeline algorithms or views may want to retrieve additional information (full text)for specific documents.
|
protectedpure virtual |
Subclasses should override this method to determine connection parameters given the URL.
This is called by CreateFromURL() to initialize the instance. Look at CreateFromURL() for details about the URL format.
Implemented in vtkQtSQLDatabase, vtkMySQLDatabase, vtkODBCDatabase, vtkPostgreSQLDatabase, and vtkSQLiteDatabase.