maintain a connection to a MySQL database More...

#include <vtkMySQLDatabase.h>

Inheritance diagram for vtkMySQLDatabase:

Collaboration diagram for vtkMySQLDatabase:

Public Types
typedef vtkSQLDatabase	Superclass

Public Types inherited from vtkSQLDatabase
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)

vtkMySQLDatabase *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

bool	Open (const char *password=0)

void	Close ()

bool	IsOpen ()

vtkSQLQuery *	GetQueryInstance ()

vtkStringArray *	GetTables ()

vtkStringArray *	GetRecord (const char *table)

bool	IsSupported (int feature)

bool	HasError ()

const char *	GetLastErrorText ()

virtual vtkStdString	GetURL ()

virtual vtkStdString	GetTablePreamble (bool b)

bool	CreateDatabase (const char *dbName, bool dropExisting)

bool	DropDatabase (const char *dbName)

virtual bool	ParseURL (const char *url)


virtual char *	GetDatabaseType ()


virtual void	SetHostName (const char *)

virtual char *	GetHostName ()


virtual void	SetUser (const char *)

virtual char *	GetUser ()


virtual void	SetPassword (const char *)


virtual void	SetDatabaseName (const char *)

virtual char *	GetDatabaseName ()


virtual void	SetReconnect (int)

virtual int	GetReconnect ()

virtual void	ReconnectOn ()

virtual void	ReconnectOff ()


virtual void	SetServerPort (int)

virtual int	GetServerPort ()


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


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

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

void	PrintSelf (ostream &os, vtkIndent indent)

virtual bool	IsSupported (int vtkNotUsed(feature))

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

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 vtkMySQLDatabase *	SafeDownCast (vtkObjectBase *o)

static vtkMySQLDatabase *	New ()

Static Public Member Functions inherited from vtkSQLDatabase
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

	vtkMySQLDatabase ()

	~vtkMySQLDatabase ()

Protected Member Functions inherited from vtkSQLDatabase
	vtkSQLDatabase ()

	~vtkSQLDatabase ()

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 &)

Friends
class	vtkMySQLQuery

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 a MySQL database

This class provides a VTK interface to MySQL (http://www.mysql.com). Unlike file-based databases like SQLite, you talk to MySQL through a client/server connection. You must specify the hostname, (optional) port to connect to, username, password and database name in order to connect.

See also: vtkMySQLQuery

Tests:: vtkMySQLDatabase (Tests)

Definition at line 49 of file vtkMySQLDatabase.h.

Member Typedef Documentation

typedef vtkSQLDatabase vtkMySQLDatabase::Superclass

Definition at line 56 of file vtkMySQLDatabase.h.

Constructor & Destructor Documentation

vtkMySQLDatabase::vtkMySQLDatabase ( )

protected

vtkMySQLDatabase::~vtkMySQLDatabase ( )

protected

Member Function Documentation

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

static

virtual int vtkMySQLDatabase::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 vtkSQLDatabase.

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

static

virtual vtkObjectBase* vtkMySQLDatabase::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkSQLDatabase.

vtkMySQLDatabase* vtkMySQLDatabase::NewInstance ( ) const

void vtkMySQLDatabase::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.

static vtkMySQLDatabase* vtkMySQLDatabase::New ( )

static

bool vtkMySQLDatabase::Open ( const char * password = 0 )

virtual

Open a new connection to the database. You need to set the filename before calling this function. Returns true if the database was opened successfully; false otherwise.

Implements vtkSQLDatabase.

void vtkMySQLDatabase::Close ( )

virtual

Close the connection to the database.

Implements vtkSQLDatabase.

bool vtkMySQLDatabase::IsOpen ( )

virtual

Return whether the database has an open connection

Implements vtkSQLDatabase.

vtkSQLQuery* vtkMySQLDatabase::GetQueryInstance ( )

virtual

Return an empty query on this database.

Implements vtkSQLDatabase.

vtkStringArray* vtkMySQLDatabase::GetTables ( )

virtual

Get the list of tables from the database

Implements vtkSQLDatabase.

vtkStringArray* vtkMySQLDatabase::GetRecord ( const char * table )

virtual

Get the list of fields for a particular table

Implements vtkSQLDatabase.

bool vtkMySQLDatabase::IsSupported ( int feature )

Return whether a feature is supported by the database.

bool vtkMySQLDatabase::HasError ( )

virtual

Did the last operation generate an error

Implements vtkSQLDatabase.

const char* vtkMySQLDatabase::GetLastErrorText ( )

virtual

Get the last error text from the database

Implements vtkSQLDatabase.

virtual char* vtkMySQLDatabase::GetDatabaseType ( )

virtual

String representing database type (e.g. "mysql").

Implements vtkSQLDatabase.

virtual void vtkMySQLDatabase::SetHostName ( const char * )

virtual

The database server host name.

virtual char* vtkMySQLDatabase::GetHostName ( )

virtual

The database server host name.

virtual void vtkMySQLDatabase::SetUser ( const char * )

virtual

The user name for connecting to the database server.

virtual char* vtkMySQLDatabase::GetUser ( )

virtual

The user name for connecting to the database server.

virtual void vtkMySQLDatabase::SetPassword ( const char * )

virtual

The user's password for connecting to the database server.

virtual void vtkMySQLDatabase::SetDatabaseName ( const char * )

virtual

The name of the database to connect to.

virtual char* vtkMySQLDatabase::GetDatabaseName ( )

virtual

The name of the database to connect to.

virtual void vtkMySQLDatabase::SetReconnect ( int )

virtual

Should automatic reconnection be enabled? This defaults to true. If you change its value, you must do so before any call to Open().

virtual int vtkMySQLDatabase::GetReconnect ( )

virtual

Should automatic reconnection be enabled? This defaults to true. If you change its value, you must do so before any call to Open().

virtual void vtkMySQLDatabase::ReconnectOn ( )

virtual

Should automatic reconnection be enabled? This defaults to true. If you change its value, you must do so before any call to Open().

virtual void vtkMySQLDatabase::ReconnectOff ( )

virtual

Should automatic reconnection be enabled? This defaults to true. If you change its value, you must do so before any call to Open().

virtual void vtkMySQLDatabase::SetServerPort ( int )

virtual

The port used for connecting to the database.

virtual int vtkMySQLDatabase::GetServerPort ( )

virtual

The port used for connecting to the database.

virtual vtkStdString vtkMySQLDatabase::GetURL ( )

virtual

Get the URL of the database.

Implements vtkSQLDatabase.

virtual vtkStdString vtkMySQLDatabase::GetTablePreamble ( bool b )

inlinevirtual

Return the SQL string with the syntax of the preamble following a "CREATE TABLE" SQL statement. NB: this method implements the MySQL-specific IF NOT EXISTS syntax, used when b = false.

Reimplemented from vtkSQLDatabase.

Definition at line 137 of file vtkMySQLDatabase.h.

virtual vtkStdString vtkMySQLDatabase::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. NB1: this method implements the MySQL-specific syntax:

`<column name>` <column type>
<column attributes>

NB2: if a column has type SERIAL in the schema, this will be turned into INT NOT NULL AUTO_INCREMENT. Therefore, one should not pass NOT NULL as an attribute of a column whose type is SERIAL.

Reimplemented from vtkSQLDatabase.

virtual vtkStdString vtkMySQLDatabase::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 MySQL-specific syntax:

<index type> [<index name>] 
(`<column name 1>`,... )

NB2: since MySQL supports INDEX creation within a CREATE TABLE statement, skipped is always returned false.

Reimplemented from vtkSQLDatabase.

bool vtkMySQLDatabase::CreateDatabase	(	const char *	dbName,
		bool	dropExisting
	)

Create a new database, optionally dropping any existing database of the same name. Returns true when the database is properly created and false on failure.

bool vtkMySQLDatabase::DropDatabase ( const char * dbName )

Drop a database if it exists. Returns true on success and false on failure.

virtual bool vtkMySQLDatabase::ParseURL ( const char * url )

virtual

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

Implements vtkSQLDatabase.

Friends And Related Function Documentation

friend class vtkMySQLQuery

friend

Definition at line 52 of file vtkMySQLDatabase.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation