VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
vtkMySQLDatabase Class Reference

maintain a connection to a MySQL database More...

#include <vtkMySQLDatabase.h>

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

Public Types

typedef vtkSQLDatabase Superclass
 
- Public Types inherited from vtkSQLDatabase
typedef vtkObject Superclass
 
typedef vtkSQLDatabase *(* CreateFunction) (const char *URL)
 Type for CreateFromURL callback. More...
 

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkMySQLDatabaseNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
bool Open (const char *password=0)
 Open a new connection to the database. More...
 
void Close ()
 Close the connection to the database. More...
 
bool IsOpen ()
 Return whether the database has an open connection. More...
 
vtkSQLQueryGetQueryInstance ()
 Return an empty query on this database. More...
 
vtkStringArrayGetTables ()
 Get the list of tables from the database. More...
 
vtkStringArrayGetRecord (const char *table)
 Get the list of fields for a particular table. More...
 
bool IsSupported (int feature)
 Return whether a feature is supported by the database. More...
 
bool HasError ()
 Did the last operation generate an error. More...
 
const char * GetLastErrorText ()
 Get the last error text from the database. More...
 
virtual vtkStdString GetURL ()
 Get the URL of the database. More...
 
virtual vtkStdString GetTablePreamble (bool b)
 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...
 
bool CreateDatabase (const char *dbName, bool dropExisting)
 Create a new database, optionally dropping any existing database of the same name. More...
 
bool DropDatabase (const char *dbName)
 Drop a database if it exists. More...
 
virtual bool ParseURL (const char *url)
 Overridden to determine connection parameters given the URL. More...
 
const char * GetDatabaseType () override
 String representing database type (e.g. More...
 
virtual void SetHostName (const char *)
 The database server host name. More...
 
virtual char * GetHostName ()
 The database server host name. More...
 
virtual void SetUser (const char *)
 The user name for connecting to the database server. More...
 
virtual char * GetUser ()
 The user name for connecting to the database server. More...
 
virtual void SetPassword (const char *)
 The user's password for connecting to the database server. More...
 
virtual void SetDatabaseName (const char *)
 The name of the database to connect to. More...
 
virtual char * GetDatabaseName ()
 The name of the database to connect to. More...
 
virtual void SetReconnect (int)
 Should automatic reconnection be enabled? This defaults to true. More...
 
virtual int GetReconnect ()
 Should automatic reconnection be enabled? This defaults to true. More...
 
virtual void ReconnectOn ()
 Should automatic reconnection be enabled? This defaults to true. More...
 
virtual void ReconnectOff ()
 Should automatic reconnection be enabled? This defaults to true. More...
 
virtual void SetServerPort (int)
 The port used for connecting to the database. More...
 
virtual int GetServerPort ()
 The port used for connecting to the database. More...
 
- Public Member Functions inherited from vtkSQLDatabase
vtkSQLDatabaseNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool IsSupported (int vtkNotUsed(feature))
 Return whether a feature is supported by the database. 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMySQLDatabaseSafeDownCast (vtkObjectBase *o)
 
static vtkMySQLDatabaseNew ()
 
- Static Public Member Functions inherited from vtkSQLDatabase
static int IsTypeOf (const char *type)
 
static vtkSQLDatabaseSafeDownCast (vtkObjectBase *o)
 
static vtkSQLDatabaseCreateFromURL (const char *URL)
 Create a the proper subclass given a URL. More...
 
static vtkInformationObjectBaseKeyDATABASE ()
 Stores the database class pointer as an information key. 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)
 Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols. More...
 
static void UnRegisterAllCreateFromURLCallbacks ()
 Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols. 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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
 
 vtkMySQLDatabase ()
 
 ~vtkMySQLDatabase ()
 
- Protected Member Functions inherited from vtkSQLDatabase
 vtkSQLDatabase ()
 
 ~vtkSQLDatabase () override
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- 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 50 of file vtkMySQLDatabase.h.

Member Typedef Documentation

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.

const char* vtkMySQLDatabase::GetDatabaseType ( )
inlineoverridevirtual

String representing database type (e.g.

"mysql").

Implements vtkSQLDatabase.

Definition at line 111 of file vtkMySQLDatabase.h.

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 178 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 nullptr AUTO_INCREMENT. Therefore, one should not pass NOT nullptr 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 53 of file vtkMySQLDatabase.h.


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