maintain a connection to an sql database More...

#include <vtkSQLDatabase.h>

Inheritance diagram for vtkSQLDatabase:

Collaboration diagram for vtkSQLDatabase:

Public Types
typedef vtkObject	Superclass


typedef vtkSQLDatabase (	CreateFunction) (const char *URL)

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkSQLDatabase *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual bool	Open (const char *password)=0

virtual void	Close ()=0

virtual bool	IsOpen ()=0

virtual vtkSQLQuery *	GetQueryInstance ()=0

virtual bool	HasError ()=0

virtual const char *	GetLastErrorText ()=0

virtual char *	GetDatabaseType ()=0

virtual vtkStringArray *	GetTables ()=0

virtual vtkStringArray *	GetRecord (const char *table)=0

virtual bool	IsSupported (int vtkNotUsed(feature))

virtual vtkStdString	GetURL ()=0

virtual vtkStdString	GetTablePreamble (bool)

virtual bool	EffectSchema (vtkSQLDatabaseSchema *, bool dropIfExists=false)


virtual vtkStdString	GetColumnSpecification (vtkSQLDatabaseSchema *schema, int tblHandle, int colHandle)


virtual vtkStdString	GetIndexSpecification (vtkSQLDatabaseSchema *schema, int tblHandle, int idxHandle, bool &skipped)


virtual vtkStdString	GetTriggerSpecification (vtkSQLDatabaseSchema *schema, int tblHandle, int trgHandle)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkSQLDatabase *	SafeDownCast (vtkObjectBase *o)

static vtkSQLDatabase *	CreateFromURL (const char *URL)

static vtkInformationObjectBaseKey *	DATABASE ()


static void	RegisterCreateFromURLCallback (CreateFunction callback)

static void	UnRegisterCreateFromURLCallback (CreateFunction callback)

static void	UnRegisterAllCreateFromURLCallbacks ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkSQLDatabase ()

	~vtkSQLDatabase ()

virtual bool	ParseURL (const char *url)=0

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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
vtkAtomicInt32	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 89 of file vtkSQLDatabase.h.

Member Typedef Documentation

typedef vtkObject vtkSQLDatabase::Superclass

Definition at line 92 of file vtkSQLDatabase.h.

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

Type for CreateFromURL callback.

Definition at line 194 of file vtkSQLDatabase.h.

Constructor & Destructor Documentation

vtkSQLDatabase::vtkSQLDatabase ( )

protected

vtkSQLDatabase::~vtkSQLDatabase ( )

protected

Member Function Documentation

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

static

virtual int 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 vtkObject.

Reimplemented in vtkODBCDatabase, vtkSQLiteDatabase, vtkPostgreSQLDatabase, and vtkMySQLDatabase.

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

static

virtual vtkObjectBase* vtkSQLDatabase::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkODBCDatabase, vtkSQLiteDatabase, vtkPostgreSQLDatabase, and vtkMySQLDatabase.

vtkSQLDatabase* vtkSQLDatabase::NewInstance ( ) const

void vtkSQLDatabase::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

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.

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 vtkODBCDatabase, vtkSQLiteDatabase, vtkPostgreSQLDatabase, and vtkMySQLDatabase.

virtual void vtkSQLDatabase::Close ( )

pure virtual

Close the connection to the database.

Implemented in vtkODBCDatabase, vtkSQLiteDatabase, vtkPostgreSQLDatabase, and vtkMySQLDatabase.

virtual bool vtkSQLDatabase::IsOpen ( )

pure virtual

Return whether the database has an open connection.

Implemented in vtkODBCDatabase, vtkSQLiteDatabase, vtkPostgreSQLDatabase, and vtkMySQLDatabase.

virtual vtkSQLQuery* vtkSQLDatabase::GetQueryInstance ( )

pure virtual

Return an empty query on this database.

Implemented in vtkODBCDatabase, vtkSQLiteDatabase, vtkPostgreSQLDatabase, and vtkMySQLDatabase.

virtual bool vtkSQLDatabase::HasError ( )

pure virtual

Did the last operation generate an error

Implemented in vtkODBCDatabase, vtkSQLiteDatabase, vtkPostgreSQLDatabase, and vtkMySQLDatabase.

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, vtkPostgreSQLDatabase, and vtkMySQLDatabase.

virtual char* vtkSQLDatabase::GetDatabaseType ( )

pure virtual

Get the type of the database (e.g. mysql, psql,..).

Implemented in vtkODBCDatabase, vtkSQLiteDatabase, vtkPostgreSQLDatabase, and vtkMySQLDatabase.

virtual vtkStringArray* vtkSQLDatabase::GetTables ( )

pure virtual

Get the list of tables from the database.

Implemented in vtkPostgreSQLDatabase, vtkODBCDatabase, vtkSQLiteDatabase, and vtkMySQLDatabase.

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.

virtual bool vtkSQLDatabase::IsSupported ( int vtkNotUsedfeature )

inlinevirtual

Return whether a feature is supported by the database.

Definition at line 130 of file vtkSQLDatabase.h.

virtual vtkStdString vtkSQLDatabase::GetURL ( )

pure virtual

Get the URL of the database.

Implemented in vtkODBCDatabase, vtkPostgreSQLDatabase, vtkMySQLDatabase, and vtkSQLiteDatabase.

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 139 of file vtkSQLDatabase.h.

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, vtkODBCDatabase, vtkMySQLDatabase, and vtkSQLiteDatabase.

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.

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.

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]

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

virtual

Effect a database schema.

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.

static void vtkSQLDatabase::UnRegisterCreateFromURLCallback ( 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.

static void vtkSQLDatabase::UnRegisterAllCreateFromURLCallbacks ( )

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 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.

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, vtkODBCDatabase, vtkPostgreSQLDatabase, and vtkSQLiteDatabase.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/SQL/vtkSQLDatabase.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation