VTK  9.1.20211115
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkQtSQLDatabase Class Reference

maintains a connection to an sql database More...

#include <vtkQtSQLDatabase.h>

Inheritance diagram for vtkQtSQLDatabase:
[legend]
Collaboration diagram for vtkQtSQLDatabase:
[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 vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkQtSQLDatabaseNewInstance () 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...
 
vtkSQLQueryGetQueryInstance () override
 Return an empty query on this database. More...
 
vtkStringArrayGetTables () override
 Get the list of tables from the database. More...
 
vtkStringArrayGetRecord (const char *table) override
 Get the list of fields for a particular table. More...
 
vtkStringArrayGetColumns ()
 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...
 
- 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 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...
 
- 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 ()
 
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...
 
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...
 
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...
 
- Public Member Functions inherited from vtkObjectBase
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 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 vtkQtSQLDatabaseNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkQtSQLDatabaseSafeDownCast (vtkObjectBase *o)
 
static vtkSQLDatabaseCreateFromURL (const char *URL)
 Create a the proper subclass given a URL. More...
 
- Static Public Member Functions inherited from vtkSQLDatabase
static vtkTypeBool 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 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkQtSQLDatabase ()
 
 ~vtkQtSQLDatabase () override
 
bool ParseURL (const char *url) override
 Overridden to determine connection parameters given the URL. More...
 
- 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 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
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkQtSQLQuery
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

maintains a connection to an sql database

Implements a vtkSQLDatabase using an underlying Qt QSQLDatabase.

Definition at line 40 of file vtkQtSQLDatabase.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkQtSQLDatabase.h.

Constructor & Destructor Documentation

◆ vtkQtSQLDatabase()

vtkQtSQLDatabase::vtkQtSQLDatabase ( )
protected

◆ ~vtkQtSQLDatabase()

vtkQtSQLDatabase::~vtkQtSQLDatabase ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkQtSQLDatabase* vtkQtSQLDatabase::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkQtSQLDatabase::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkQtSQLDatabase::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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkQtSQLDatabase::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkSQLDatabase.

◆ NewInstance()

vtkQtSQLDatabase* vtkQtSQLDatabase::NewInstance ( ) const

◆ PrintSelf()

void vtkQtSQLDatabase::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ Open()

bool vtkQtSQLDatabase::Open ( const char *  password)
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.

◆ Close()

void vtkQtSQLDatabase::Close ( )
overridevirtual

Close the connection to the database.

Implements vtkSQLDatabase.

◆ IsOpen()

bool vtkQtSQLDatabase::IsOpen ( )
overridevirtual

Return whether the database has an open connection.

Implements vtkSQLDatabase.

◆ GetQueryInstance()

vtkSQLQuery* vtkQtSQLDatabase::GetQueryInstance ( )
overridevirtual

Return an empty query on this database.

Implements vtkSQLDatabase.

◆ GetTables()

vtkStringArray* vtkQtSQLDatabase::GetTables ( )
overridevirtual

Get the list of tables from the database.

Implements vtkSQLDatabase.

◆ GetRecord()

vtkStringArray* vtkQtSQLDatabase::GetRecord ( const char *  table)
overridevirtual

Get the list of fields for a particular table.

Implements vtkSQLDatabase.

◆ GetColumns()

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.

◆ SetColumnsTable()

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.

◆ IsSupported()

bool vtkQtSQLDatabase::IsSupported ( int  feature)
override

Return whether a feature is supported by the database.

◆ HasError()

bool vtkQtSQLDatabase::HasError ( )
overridevirtual

Did the last operation generate an error.

Implements vtkSQLDatabase.

◆ GetLastErrorText()

const char* vtkQtSQLDatabase::GetLastErrorText ( )
overridevirtual

Get the last error text from the database.

Implements vtkSQLDatabase.

◆ GetDatabaseType()

const char* vtkQtSQLDatabase::GetDatabaseType ( )
inlineoverridevirtual

String representing Qt database type (e.g.

"mysql").

Implements vtkSQLDatabase.

Definition at line 112 of file vtkQtSQLDatabase.h.

◆ SetDatabaseType()

virtual void vtkQtSQLDatabase::SetDatabaseType ( const char *  )
virtual

String representing Qt database type (e.g.

"mysql").

◆ SetHostName()

virtual void vtkQtSQLDatabase::SetHostName ( const char *  )
virtual

The database server host name.

◆ GetHostName()

virtual char* vtkQtSQLDatabase::GetHostName ( )
virtual

The database server host name.

◆ SetUserName()

virtual void vtkQtSQLDatabase::SetUserName ( const char *  )
virtual

The user name for connecting to the database server.

◆ GetUserName()

virtual char* vtkQtSQLDatabase::GetUserName ( )
virtual

The user name for connecting to the database server.

◆ SetDatabaseName()

virtual void vtkQtSQLDatabase::SetDatabaseName ( const char *  )
virtual

The name of the database to connect to.

◆ GetDatabaseName()

virtual char* vtkQtSQLDatabase::GetDatabaseName ( )
virtual

The name of the database to connect to.

◆ SetConnectOptions()

virtual void vtkQtSQLDatabase::SetConnectOptions ( const char *  )
virtual

Additional options for the database.

◆ GetConnectOptions()

virtual char* vtkQtSQLDatabase::GetConnectOptions ( )
virtual

Additional options for the database.

◆ SetPort()

void vtkQtSQLDatabase::SetPort ( int  port)
inline

Definition at line 151 of file vtkQtSQLDatabase.h.

◆ GetPort()

int vtkQtSQLDatabase::GetPort ( )
inline

Definition at line 153 of file vtkQtSQLDatabase.h.

◆ SetDbPort()

virtual void vtkQtSQLDatabase::SetDbPort ( int  )
virtual

The port used for connecting to the database.

◆ GetDbPort()

virtual int vtkQtSQLDatabase::GetDbPort ( )
virtual

The port used for connecting to the database.

◆ CreateFromURL()

static vtkSQLDatabase* vtkQtSQLDatabase::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] .

◆ GetURL()

vtkStdString vtkQtSQLDatabase::GetURL ( )
overridevirtual

Get the URL of the database.

Implements vtkSQLDatabase.

◆ ParseURL()

bool vtkQtSQLDatabase::ParseURL ( const char *  url)
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.

Friends And Related Function Documentation

◆ vtkQtSQLQuery

friend class vtkQtSQLQuery
friend

Definition at line 189 of file vtkQtSQLDatabase.h.

Member Data Documentation

◆ DatabaseType

char* vtkQtSQLDatabase::DatabaseType
protected

Definition at line 180 of file vtkQtSQLDatabase.h.

◆ HostName

char* vtkQtSQLDatabase::HostName
protected

Definition at line 181 of file vtkQtSQLDatabase.h.

◆ UserName

char* vtkQtSQLDatabase::UserName
protected

Definition at line 182 of file vtkQtSQLDatabase.h.

◆ DatabaseName

char* vtkQtSQLDatabase::DatabaseName
protected

Definition at line 183 of file vtkQtSQLDatabase.h.

◆ DbPort

int vtkQtSQLDatabase::DbPort
protected

Definition at line 184 of file vtkQtSQLDatabase.h.

◆ ConnectOptions

char* vtkQtSQLDatabase::ConnectOptions
protected

Definition at line 185 of file vtkQtSQLDatabase.h.

◆ QtDatabase

QSqlDatabase vtkQtSQLDatabase::QtDatabase
protected

Definition at line 187 of file vtkQtSQLDatabase.h.


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