VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkSQLDatabase Class Referenceabstract

maintain a connection to an sql database More...

#include <vtkSQLDatabase.h>

Inheritance diagram for vtkSQLDatabase:
[legend]
Collaboration diagram for vtkSQLDatabase:
[legend]

Public Types

typedef vtkObject Superclass
 
typedef vtkSQLDatabase *(* CreateFunction) (const char *URL)
 Type for CreateFromURL callback. More...
 

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. More...
 
vtkSQLDatabaseNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool Open (const char *password)=0
 Open a new connection to the database. More...
 
virtual void Close ()=0
 Close the connection to the database. More...
 
virtual bool IsOpen ()=0
 Return whether the database has an open connection. More...
 
virtual vtkSQLQueryGetQueryInstance ()=0
 Return an empty query on this database. More...
 
virtual bool HasError ()=0
 Did the last operation generate an error. More...
 
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... More...
 
virtual const char * GetDatabaseType ()=0
 Get the type of the database (e.g. More...
 
virtual vtkStringArrayGetTables ()=0
 Get the list of tables from the database. More...
 
virtual vtkStringArrayGetRecord (const char *table)=0
 Get the list of fields for a particular table. More...
 
virtual bool IsSupported (int vtkNotUsed(feature))
 Return whether a feature is supported by the database. More...
 
virtual vtkStdString GetURL ()=0
 Get the URL of the database. More...
 
virtual vtkStdString GetTablePreamble (bool)
 Return the SQL string with the syntax of the preamble following a "CREATE TABLE" SQL statement. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual bool EffectSchema (vtkSQLDatabaseSchema *, bool dropIfExists=false)
 Effect a database schema. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSQLDatabaseSafeDownCast (vtkObjectBase *o)
 
static vtkSQLDatabaseCreateFromURL (const char *URL)
 Create a the proper subclass given a URL. More...
 
static void RegisterCreateFromURLCallback (CreateFunction callback)
 Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols. More...
 
static void UnRegisterCreateFromURLCallback (CreateFunction callback)
 
static void UnRegisterAllCreateFromURLCallbacks ()
 
static vtkInformationObjectBaseKeyDATABASE ()
 Stores the database class pointer as an information key. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkSQLDatabase ()
 
 ~vtkSQLDatabase () override
 
virtual bool ParseURL (const char *url)=0
 Subclasses should override this method to determine connection parameters given the URL. More...
 
- 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

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.

Thanks:
Thanks to Andrew Wilson from Sandia National Laboratories for his work on the database classes and for the SQLite example. Thanks to David Thompson and Philippe Pebay from Sandia National Laboratories for implementing this class.
See also
vtkSQLQuery vtkSQLDatabaseSchema
Examples:
vtkSQLDatabase (Examples)
Tests:
vtkSQLDatabase (Tests)

Definition at line 90 of file vtkSQLDatabase.h.

Member Typedef Documentation

◆ Superclass

Definition at line 93 of file vtkSQLDatabase.h.

◆ CreateFunction

typedef vtkSQLDatabase*(* vtkSQLDatabase::CreateFunction) (const char *URL)

Type for CreateFromURL callback.

Definition at line 225 of file vtkSQLDatabase.h.

Constructor & Destructor Documentation

◆ vtkSQLDatabase()

vtkSQLDatabase::vtkSQLDatabase ( )
protected

◆ ~vtkSQLDatabase()

vtkSQLDatabase::~vtkSQLDatabase ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkSQLDatabase::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkSQLDatabase::IsA ( const char *  name)
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 vtkODBCDatabase, vtkSQLiteDatabase, vtkPostgreSQLDatabase, and vtkMySQLDatabase.

◆ SafeDownCast()

static vtkSQLDatabase* vtkSQLDatabase::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSQLDatabase::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkSQLDatabase* vtkSQLDatabase::NewInstance ( ) const

◆ PrintSelf()

void vtkSQLDatabase::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

◆ Open()

virtual bool vtkSQLDatabase::Open ( const char *  password)
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 vtkPostgreSQLDatabase, vtkMySQLDatabase, vtkODBCDatabase, and vtkSQLiteDatabase.

◆ Close()

virtual void vtkSQLDatabase::Close ( )
pure virtual

Close the connection to the database.

Implemented in vtkODBCDatabase, vtkSQLiteDatabase, vtkPostgreSQLDatabase, and vtkMySQLDatabase.

◆ IsOpen()

virtual bool vtkSQLDatabase::IsOpen ( )
pure virtual

Return whether the database has an open connection.

Implemented in vtkODBCDatabase, vtkSQLiteDatabase, vtkPostgreSQLDatabase, and vtkMySQLDatabase.

◆ GetQueryInstance()

virtual vtkSQLQuery* vtkSQLDatabase::GetQueryInstance ( )
pure virtual

Return an empty query on this database.

Implemented in vtkODBCDatabase, vtkSQLiteDatabase, vtkPostgreSQLDatabase, and vtkMySQLDatabase.

◆ HasError()

virtual bool vtkSQLDatabase::HasError ( )
pure virtual

Did the last operation generate an error.

Implemented in vtkODBCDatabase, vtkSQLiteDatabase, vtkMySQLDatabase, and vtkPostgreSQLDatabase.

◆ GetLastErrorText()

virtual const char* vtkSQLDatabase::GetLastErrorText ( )
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 vtkSQLiteDatabase, vtkODBCDatabase, vtkMySQLDatabase, and vtkPostgreSQLDatabase.

◆ GetDatabaseType()

virtual const char* vtkSQLDatabase::GetDatabaseType ( )
pure virtual

Get the type of the database (e.g.

mysql, psql,..).

Implemented in vtkODBCDatabase, vtkSQLiteDatabase, vtkMySQLDatabase, and vtkPostgreSQLDatabase.

◆ GetTables()

virtual vtkStringArray* vtkSQLDatabase::GetTables ( )
pure virtual

Get the list of tables from the database.

Implemented in vtkPostgreSQLDatabase, vtkODBCDatabase, vtkSQLiteDatabase, and vtkMySQLDatabase.

◆ GetRecord()

virtual vtkStringArray* vtkSQLDatabase::GetRecord ( const char *  table)
pure virtual

Get the list of fields for a particular table.

Implemented in vtkPostgreSQLDatabase, vtkODBCDatabase, vtkSQLiteDatabase, and vtkMySQLDatabase.

◆ IsSupported()

virtual bool vtkSQLDatabase::IsSupported ( int   vtkNotUsedfeature)
inlinevirtual

Return whether a feature is supported by the database.

Definition at line 151 of file vtkSQLDatabase.h.

◆ GetURL()

virtual vtkStdString vtkSQLDatabase::GetURL ( )
pure virtual

Get the URL of the database.

Implemented in vtkPostgreSQLDatabase, vtkMySQLDatabase, vtkODBCDatabase, and vtkSQLiteDatabase.

◆ GetTablePreamble()

virtual vtkStdString vtkSQLDatabase::GetTablePreamble ( bool  )
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 165 of file vtkSQLDatabase.h.

◆ GetColumnSpecification()

virtual vtkStdString vtkSQLDatabase::GetColumnSpecification ( vtkSQLDatabaseSchema schema,
int  tblHandle,
int  colHandle 
)
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: <column name>=""> <column type>=""> <column attributes>=""> It must be overwritten for those SQL backends which have a different syntax such as, e.g., MySQL.

Reimplemented in vtkPostgreSQLDatabase, vtkMySQLDatabase, vtkODBCDatabase, and vtkSQLiteDatabase.

◆ GetIndexSpecification()

virtual vtkStdString vtkSQLDatabase::GetIndexSpecification ( vtkSQLDatabaseSchema schema,
int  tblHandle,
int  idxHandle,
bool &  skipped 
)
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: <index type>=""> 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.

◆ GetTriggerSpecification()

virtual vtkStdString vtkSQLDatabase::GetTriggerSpecification ( vtkSQLDatabaseSchema schema,
int  tblHandle,
int  trgHandle 
)
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: <trigger name>=""> {BEFORE | AFTER} <event> ON

EACH ROW <trigger action>=""> It must be overwritten for those SQL backends which have a different syntax such as, e.g., PostgreSQL.

◆ CreateFromURL()

static vtkSQLDatabase* vtkSQLDatabase::CreateFromURL ( const char *  URL)
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] .

◆ EffectSchema()

virtual bool vtkSQLDatabase::EffectSchema ( vtkSQLDatabaseSchema ,
bool  dropIfExists = false 
)
virtual

Effect a database schema.

◆ RegisterCreateFromURLCallback()

static void vtkSQLDatabase::RegisterCreateFromURLCallback ( CreateFunction  callback)
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.

◆ UnRegisterCreateFromURLCallback()

static void vtkSQLDatabase::UnRegisterCreateFromURLCallback ( CreateFunction  callback)
static

◆ UnRegisterAllCreateFromURLCallbacks()

static void vtkSQLDatabase::UnRegisterAllCreateFromURLCallbacks ( )
static

◆ DATABASE()

static vtkInformationObjectBaseKey* vtkSQLDatabase::DATABASE ( )
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.

◆ ParseURL()

virtual bool vtkSQLDatabase::ParseURL ( const char *  url)
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 vtkMySQLDatabase, vtkPostgreSQLDatabase, vtkODBCDatabase, and vtkSQLiteDatabase.


The documentation for this class was generated from the following file: