vtkSQLQuery implementation for MySQL databases More...

#include <vtkMySQLQuery.h>

Inheritance diagram for vtkMySQLQuery:

Collaboration diagram for vtkMySQLQuery:

Public Types
typedef vtkSQLQuery	Superclass

Public Types inherited from vtkSQLQuery
typedef vtkRowQuery	Superclass

Public Types inherited from vtkRowQuery
typedef vtkObject	Superclass

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

vtkMySQLQuery *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

bool	SetQuery (const char *query)
	Set the SQL query string. More...

bool	Execute ()
	Execute the query. More...

int	GetNumberOfFields ()
	The number of fields in the query result. More...

const char *	GetFieldName (int i)
	Return the name of the specified query field. More...

int	GetFieldType (int i)
	Return the type of the field, using the constants defined in vtkType.h. More...

bool	NextRow ()
	Advance row, return false if past end. More...

bool	HasError ()
	Return true if there is an error on the current query. More...

vtkVariant	DataValue (vtkIdType c)
	Return data in current row, field c. More...

const char *	GetLastErrorText ()
	Get the last error text from the query. More...

bool	BindParameter (int index, unsigned char value)
	Bind a parameter to a placeholder in a query. More...

bool	BindParameter (int index, signed char value)

bool	BindParameter (int index, unsigned short value)

bool	BindParameter (int index, signed short value)

bool	BindParameter (int index, unsigned int value)

bool	BindParameter (int index, int value)

bool	BindParameter (int index, unsigned long value)

bool	BindParameter (int index, signed long value)

bool	BindParameter (int index, unsigned long long value)

bool	BindParameter (int index, long long value)

bool	BindParameter (int index, float value)

bool	BindParameter (int index, double value)

bool	BindParameter (int index, const char *stringValue)
	Bind a string value – string must be null-terminated. More...

virtual vtkStdString	EscapeString (vtkStdString src, bool addSurroundingQuotes=true)
	Escape a string for use in a query. More...


virtual bool	BeginTransaction ()
	Begin, commit, or roll back a transaction. More...

virtual bool	CommitTransaction ()
	Begin, commit, or roll back a transaction. More...

virtual bool	RollbackTransaction ()
	Begin, commit, or roll back a transaction. More...


bool	BindParameter (int index, const char *stringValue, size_t length)
	Bind a string value by specifying an array and a size. More...

bool	BindParameter (int index, const vtkStdString &string)
	Bind a string value by specifying an array and a size. More...


bool	BindParameter (int index, const void *data, size_t length)
	Bind a blob value. More...

bool	ClearParameterBindings ()
	Bind a blob value. More...

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

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

bool	IsActive ()
	Return true if the query is active (i.e. More...

virtual bool	BindParameter (int index, short value)

virtual bool	BindParameter (int index, long value)

virtual bool	BindParameter (int index, vtkVariant var)

char *	EscapeString (const char *src, bool addSurroundingQuotes)
	Escape a string for inclusion into an SQL query. More...

virtual const char *	GetQuery ()
	The query string to be executed. More...

virtual vtkSQLDatabase *	GetDatabase ()
	Return the database associated with the query. More...

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

int	GetFieldIndex (char *name)
	Return the index of the specified query field. More...

bool	NextRow (vtkVariantArray *rowArray)
	Advance row, return false if past end. More...

virtual void	SetCaseSensitiveFieldNames (bool)
	Many databases do not preserve case in field names. More...

virtual bool	GetCaseSensitiveFieldNames ()
	Many databases do not preserve case in field names. More...

virtual void	CaseSensitiveFieldNamesOn ()
	Many databases do not preserve case in field names. More...

virtual void	CaseSensitiveFieldNamesOff ()
	Many databases do not preserve case in field names. 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...

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

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

static vtkMySQLQuery *	New ()

Static Public Member Functions inherited from vtkSQLQuery
static int	IsTypeOf (const char *type)

static vtkSQLQuery *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkRowQuery
static int	IsTypeOf (const char *type)

static vtkRowQuery *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
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 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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkMySQLQuery ()

	~vtkMySQLQuery ()

virtual void	SetLastErrorText (const char *)

Protected Member Functions inherited from vtkSQLQuery
	vtkSQLQuery ()

	~vtkSQLQuery ()

void	SetDatabase (vtkSQLDatabase *db)
	Set the database associated with the query. More...

Protected Member Functions inherited from vtkRowQuery
	vtkRowQuery ()

	~vtkRowQuery ()

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=NULL)
	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	vtkMySQLDatabase

Additional Inherited Members
Protected Attributes inherited from vtkSQLQuery
char *	Query

vtkSQLDatabase *	Database

bool	Active

Protected Attributes inherited from vtkRowQuery
bool	CaseSensitiveFieldNames

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

vtkSQLQuery implementation for MySQL databases

This is an implementation of vtkSQLQuery for MySQL databases. See the documentation for vtkSQLQuery for information about what the methods do.

Bug:: Since MySQL requires that all bound parameters be passed in a single mysql_stmt_bind_param call, there is no way to determine which one is causing an error when one occurs.

See also: vtkSQLDatabase vtkSQLQuery vtkMySQLDatabase

Definition at line 47 of file vtkMySQLQuery.h.

Member Typedef Documentation

typedef vtkSQLQuery vtkMySQLQuery::Superclass

Definition at line 53 of file vtkMySQLQuery.h.

Constructor & Destructor Documentation

vtkMySQLQuery::vtkMySQLQuery ( )

protected

vtkMySQLQuery::~vtkMySQLQuery ( )

protected

Member Function Documentation

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

static

virtual int vtkMySQLQuery::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 vtkSQLQuery.

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

static

virtual vtkObjectBase* vtkMySQLQuery::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkSQLQuery.

vtkMySQLQuery* vtkMySQLQuery::NewInstance ( ) const

void vtkMySQLQuery::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 vtkMySQLQuery* vtkMySQLQuery::New ( )

static

bool vtkMySQLQuery::SetQuery ( const char * query )

virtual

Set the SQL query string.

This must be performed before Execute() or BindParameter() can be called.

Reimplemented from vtkSQLQuery.

bool vtkMySQLQuery::Execute ( )

virtual

Execute the query.

This must be performed before any field name or data access functions are used.

Implements vtkSQLQuery.

virtual bool vtkMySQLQuery::BeginTransaction ( )

virtual

Begin, commit, or roll back a transaction.

Calling any of these methods will overwrite the current query text and call Execute() so any previous query text and results will be lost.

Reimplemented from vtkSQLQuery.

virtual bool vtkMySQLQuery::CommitTransaction ( )

virtual

Begin, commit, or roll back a transaction.

Calling any of these methods will overwrite the current query text and call Execute() so any previous query text and results will be lost.

Reimplemented from vtkSQLQuery.

virtual bool vtkMySQLQuery::RollbackTransaction ( )

virtual

Begin, commit, or roll back a transaction.

Calling any of these methods will overwrite the current query text and call Execute() so any previous query text and results will be lost.

Reimplemented from vtkSQLQuery.

int vtkMySQLQuery::GetNumberOfFields ( )

virtual

The number of fields in the query result.

Implements vtkRowQuery.

const char* vtkMySQLQuery::GetFieldName ( int i )

virtual

Return the name of the specified query field.

Implements vtkRowQuery.

int vtkMySQLQuery::GetFieldType ( int i )

virtual

Return the type of the field, using the constants defined in vtkType.h.

Implements vtkRowQuery.

bool vtkMySQLQuery::NextRow ( )

virtual

Advance row, return false if past end.

Implements vtkRowQuery.

bool vtkMySQLQuery::HasError ( )

virtual

Return true if there is an error on the current query.

Implements vtkRowQuery.

vtkVariant vtkMySQLQuery::DataValue ( vtkIdType c )

virtual

Return data in current row, field c.

Implements vtkRowQuery.

const char* vtkMySQLQuery::GetLastErrorText ( )

virtual

Get the last error text from the query.

Implements vtkRowQuery.

bool vtkMySQLQuery::BindParameter	(	int	index,
		unsigned char	value
	)

virtual

Bind a parameter to a placeholder in a query.

A full discussion of this feature is beyond the scope of this header file, but in short, here's how it works:

Instead of saying "SELECT foo FROM mytable WHERE myfield = 12345" you can say "SELECT foo FROM mytable WHERE myfield = ?". The ? character is a placeholder for a parameter that must then be bound. Call BindParameter(0, 12345) to bind the integer value 12345 to that field. Placeholders are indexed starting at 0.

You are responsible for making sure that the types match when you call BindParameter. You don't have to get it precisely correct: in general, the SQL driver is smart enough to do things like cast a short to a long or a float to a double.

Bound parameters were introduced in ANSI SQL 92. Please see that standard for more information.

Most of these methods are excluded from wrapping because the Java wrapper treats all integer types from char up through 64-bit long as 'int'. This is incorrect behavior but what else am I going to do?

Finally, the default implementation for BindParameter(int, vtkVariant) dispatches to one of the more type-specific versions. It should be OK to use in database drivers without modification.

Reimplemented from vtkSQLQuery.

bool vtkMySQLQuery::BindParameter	(	int	index,
		signed char	value
	)

virtual

Reimplemented from vtkSQLQuery.

bool vtkMySQLQuery::BindParameter	(	int	index,
		unsigned short	value
	)

virtual

Reimplemented from vtkSQLQuery.

bool vtkMySQLQuery::BindParameter	(	int	index,
		signed short	value
	)

bool vtkMySQLQuery::BindParameter	(	int	index,
		unsigned int	value
	)

virtual

Reimplemented from vtkSQLQuery.

bool vtkMySQLQuery::BindParameter	(	int	index,
		int	value
	)

virtual

Reimplemented from vtkSQLQuery.

bool vtkMySQLQuery::BindParameter	(	int	index,
		unsigned long	value
	)

virtual

Reimplemented from vtkSQLQuery.

bool vtkMySQLQuery::BindParameter	(	int	index,
		signed long	value
	)

bool vtkMySQLQuery::BindParameter	(	int	index,
		unsigned long long	value
	)

virtual

Reimplemented from vtkSQLQuery.

bool vtkMySQLQuery::BindParameter	(	int	index,
		long long	value
	)

virtual

Reimplemented from vtkSQLQuery.

bool vtkMySQLQuery::BindParameter	(	int	index,
		float	value
	)

virtual

Reimplemented from vtkSQLQuery.

bool vtkMySQLQuery::BindParameter	(	int	index,
		double	value
	)

virtual

Reimplemented from vtkSQLQuery.

bool vtkMySQLQuery::BindParameter	(	int	index,
		const char *	stringValue
	)

virtual

Bind a string value – string must be null-terminated.

Reimplemented from vtkSQLQuery.

bool vtkMySQLQuery::BindParameter	(	int	index,
		const char *	stringValue,
		size_t	length
	)

virtual

Bind a string value by specifying an array and a size.

Reimplemented from vtkSQLQuery.

bool vtkMySQLQuery::BindParameter	(	int	index,
		const vtkStdString &	string
	)

virtual

Bind a string value by specifying an array and a size.

Reimplemented from vtkSQLQuery.

bool vtkMySQLQuery::BindParameter	(	int	index,
		const void *	data,
		size_t	length
	)

virtual

Bind a blob value.

Not all databases support blobs as a data type. Check vtkSQLDatabase::IsSupported(VTK_SQL_FEATURE_BLOB) to make sure.

Reimplemented from vtkSQLQuery.

bool vtkMySQLQuery::ClearParameterBindings ( )

virtual

Bind a blob value.

Not all databases support blobs as a data type. Check vtkSQLDatabase::IsSupported(VTK_SQL_FEATURE_BLOB) to make sure.

Reimplemented from vtkSQLQuery.

virtual vtkStdString vtkMySQLQuery::EscapeString	(	vtkStdString	src,
		bool	addSurroundingQuotes = `true`
	)

virtual

Escape a string for use in a query.

Reimplemented from vtkSQLQuery.

virtual void vtkMySQLQuery::SetLastErrorText ( const char * )

protectedvirtual

Friends And Related Function Documentation

friend class vtkMySQLDatabase

friend

Definition at line 50 of file vtkMySQLQuery.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/IO/MySQL/vtkMySQLQuery.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