VTK
9.0.20210227
|
maintain a connection to a MySQL database More...
#include <vtkMySQLDatabase.h>
Public Types | |
typedef vtkSQLDatabase | Superclass |
![]() | |
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... | |
vtkMySQLDatabase * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
bool | Open (const char *password=nullptr) override |
Open a new connection to the database. More... | |
void | Close () override |
Close the connection to the database. More... | |
bool | IsOpen () override |
Return whether the database has an open connection. More... | |
vtkSQLQuery * | GetQueryInstance () override |
Return an empty query on this database. More... | |
vtkStringArray * | GetTables () override |
Get the list of tables from the database. More... | |
vtkStringArray * | GetRecord (const char *table) override |
Get the list of fields for a particular table. More... | |
bool | IsSupported (int feature) override |
Return whether a feature is supported by the database. More... | |
bool | HasError () override |
Did the last operation generate an error. More... | |
const char * | GetLastErrorText () override |
Get the last error text from the database. 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 () |
virtual void | SetUser (const char *) |
The user name for connecting to the database server. More... | |
virtual char * | GetUser () |
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 () |
virtual void | SetReconnect (int) |
Should automatic reconnection be enabled? This defaults to true. More... | |
virtual int | GetReconnect () |
virtual void | ReconnectOn () |
virtual void | ReconnectOff () |
virtual void | SetServerPort (int) |
The port used for connecting to the database. More... | |
virtual int | GetServerPort () |
vtkStdString | GetURL () override |
Get the URL of the database. More... | |
vtkStdString | GetTablePreamble (bool b) override |
Return the SQL string with the syntax of the preamble following a "CREATE TABLE" SQL statement. More... | |
vtkStdString | GetColumnSpecification (vtkSQLDatabaseSchema *schema, int tblHandle, int colHandle) override |
Return the SQL string with the syntax to create a column inside a "CREATE TABLE" SQL statement. More... | |
vtkStdString | GetIndexSpecification (vtkSQLDatabaseSchema *schema, int tblHandle, int idxHandle, bool &skipped) override |
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... | |
bool | ParseURL (const char *url) override |
Overridden to determine connection parameters given the URL. More... | |
![]() | |
vtkSQLDatabase * | NewInstance () 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... | |
![]() | |
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) |
vtkCommand * | GetCommand (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) |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
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). 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... | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. More... | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkMySQLDatabase * | SafeDownCast (vtkObjectBase *o) |
static vtkMySQLDatabase * | New () |
![]() | |
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. 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 vtkInformationObjectBaseKey * | DATABASE () |
Stores the database class pointer as an information key. More... | |
![]() | |
static vtkObject * | New () |
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 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 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). More... | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More... | |
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. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkMySQLDatabase () | |
~vtkMySQLDatabase () override | |
![]() | |
vtkSQLDatabase () | |
~vtkSQLDatabase () override | |
![]() | |
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 () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Friends | |
class | vtkMySQLQuery |
Additional Inherited Members | |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
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.
Definition at line 47 of file vtkMySQLDatabase.h.
Definition at line 53 of file vtkMySQLDatabase.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 vtkSQLDatabase.
|
static |
|
protectedvirtual |
Reimplemented from vtkSQLDatabase.
vtkMySQLDatabase* vtkMySQLDatabase::NewInstance | ( | ) | const |
|
overridevirtual |
|
static |
|
overridevirtual |
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.
|
overridevirtual |
Close the connection to the database.
Implements vtkSQLDatabase.
|
overridevirtual |
Return whether the database has an open connection.
Implements vtkSQLDatabase.
|
overridevirtual |
Return an empty query on this database.
Implements vtkSQLDatabase.
|
overridevirtual |
Get the list of tables from the database.
Implements vtkSQLDatabase.
|
overridevirtual |
Get the list of fields for a particular table.
Implements vtkSQLDatabase.
|
override |
Return whether a feature is supported by the database.
|
overridevirtual |
Did the last operation generate an error.
Implements vtkSQLDatabase.
|
overridevirtual |
Get the last error text from the database.
Implements vtkSQLDatabase.
|
inlineoverridevirtual |
String representing database type (e.g.
"mysql").
Implements vtkSQLDatabase.
Definition at line 108 of file vtkMySQLDatabase.h.
|
virtual |
The database server host name.
|
virtual |
|
virtual |
The user name for connecting to the database server.
|
virtual |
|
virtual |
The user's password for connecting to the database server.
|
virtual |
The name of the database to connect to.
|
virtual |
|
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 |
|
virtual |
|
virtual |
|
virtual |
The port used for connecting to the database.
|
virtual |
|
overridevirtual |
Get the URL of the database.
Implements vtkSQLDatabase.
|
inlineoverridevirtual |
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 172 of file vtkMySQLDatabase.h.
|
overridevirtual |
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.
|
overridevirtual |
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.
|
overridevirtual |
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.
|
friend |
Definition at line 50 of file vtkMySQLDatabase.h.