VTK
9.1.0
|
maintains a connection to an sql database More...
#include <vtkQtSQLDatabase.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... | |
vtkQtSQLDatabase * | 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) 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... | |
vtkStringArray * | GetColumns () |
Returns a list of columns for a particular table. More... | |
void | SetColumnsTable (const char *table) |
Set the table used by GetColumns() Note that this is mainly for use with the VTK parallel server. 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... | |
vtkStdString | GetURL () override |
Get the URL of the database. More... | |
const char * | GetDatabaseType () override |
String representing Qt database type (e.g. More... | |
virtual void | SetDatabaseType (const char *) |
String representing Qt 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 | SetUserName (const char *) |
The user name for connecting to the database server. More... | |
virtual char * | GetUserName () |
The user name 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 | SetConnectOptions (const char *) |
Additional options for the database. More... | |
virtual char * | GetConnectOptions () |
Additional options for the database. More... | |
void | SetPort (int port) |
int | GetPort () |
virtual void | SetDbPort (int) |
The port used for connecting to the database. More... | |
virtual int | GetDbPort () |
The port used for connecting to the database. More... | |
![]() | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. 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 | 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 vtkSQLQuery * | GetQueryInstance ()=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 vtkStringArray * | GetTables ()=0 |
Get the list of tables from the database. More... | |
virtual vtkStringArray * | GetRecord (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... | |
![]() | |
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 | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
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) |
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... | |
vtkCommand * | GetCommand (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... | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | 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... | |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. 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 | 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... | |
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 vtkQtSQLDatabase * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkQtSQLDatabase * | SafeDownCast (vtkObjectBase *o) |
static vtkSQLDatabase * | CreateFromURL (const char *URL) |
Create a the proper subclass given a URL. More... | |
![]() | |
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 vtkInformationObjectBaseKey * | DATABASE () |
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 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 () |
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 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 |
vtkQtSQLDatabase () | |
~vtkQtSQLDatabase () override | |
bool | ParseURL (const char *url) override |
Overridden to determine connection parameters given the URL. More... | |
![]() | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkSQLDatabase () | |
~vtkSQLDatabase () override | |
virtual bool | ParseURL (const char *url)=0 |
Subclasses should override this method to determine connection parameters given the URL. More... | |
![]() | |
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... | |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
char * | DatabaseType |
char * | HostName |
char * | UserName |
char * | DatabaseName |
int | DbPort |
char * | ConnectOptions |
QSqlDatabase | QtDatabase |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Friends | |
class | vtkQtSQLQuery |
Additional Inherited Members | |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
maintains a connection to an sql database
Implements a vtkSQLDatabase using an underlying Qt QSQLDatabase.
Definition at line 40 of file vtkQtSQLDatabase.h.
Definition at line 44 of file vtkQtSQLDatabase.h.
|
protected |
|
overrideprotected |
|
static |
|
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.
vtkQtSQLDatabase * vtkQtSQLDatabase::NewInstance | ( | ) | const |
|
overridevirtual |
|
overridevirtual |
Open a new connection to the database.
You need to set up any database parameters before calling this function. Returns true is the database was opened successfully, and 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.
vtkStringArray * vtkQtSQLDatabase::GetColumns | ( | ) |
Returns a list of columns for a particular table.
Note that this is mainly for use with the VTK parallel server. Serial VTK developers should prefer to use GetRecord() instead.
void vtkQtSQLDatabase::SetColumnsTable | ( | const char * | table | ) |
Set the table used by GetColumns() Note that this is mainly for use with the VTK parallel server.
Serial VTK developers should prefer to use GetRecord() instead.
|
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 Qt database type (e.g.
"mysql").
Implements vtkSQLDatabase.
Definition at line 112 of file vtkQtSQLDatabase.h.
|
virtual |
String representing Qt database type (e.g.
"mysql").
|
virtual |
The database server host name.
|
virtual |
The database server host name.
|
virtual |
The user name for connecting to the database server.
|
virtual |
The user name for connecting to the database server.
|
virtual |
The name of the database to connect to.
|
virtual |
The name of the database to connect to.
|
virtual |
Additional options for the database.
|
virtual |
Additional options for the database.
|
inline |
Definition at line 151 of file vtkQtSQLDatabase.h.
|
inline |
Definition at line 153 of file vtkQtSQLDatabase.h.
|
virtual |
The port used for connecting to the database.
|
virtual |
The port used for connecting to the database.
|
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] .
|
overridevirtual |
Get the URL of the database.
Implements vtkSQLDatabase.
|
overrideprotectedvirtual |
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 189 of file vtkQtSQLDatabase.h.
|
protected |
Definition at line 180 of file vtkQtSQLDatabase.h.
|
protected |
Definition at line 181 of file vtkQtSQLDatabase.h.
|
protected |
Definition at line 182 of file vtkQtSQLDatabase.h.
|
protected |
Definition at line 183 of file vtkQtSQLDatabase.h.
|
protected |
Definition at line 184 of file vtkQtSQLDatabase.h.
|
protected |
Definition at line 185 of file vtkQtSQLDatabase.h.
|
protected |
Definition at line 187 of file vtkQtSQLDatabase.h.