executes an sql query and retrieves results More...

#include <vtkSQLQuery.h>

Inheritance diagram for vtkSQLQuery:

Collaboration diagram for vtkSQLQuery:

Public Types
typedef vtkRowQuery	Superclass

Public Types inherited from vtkRowQuery
typedef vtkObject	Superclass

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

vtkSQLQuery *	NewInstance () const

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

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

bool	Execute () override=0
	Execute the query. More...

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

virtual bool	CommitTransaction ()

virtual bool	RollbackTransaction ()

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

virtual bool	BindParameter (int index, unsigned short value)

virtual bool	BindParameter (int index, unsigned int value)

virtual bool	BindParameter (int index, unsigned long value)

virtual bool	BindParameter (int index, signed char value)

virtual bool	BindParameter (int index, short value)

virtual bool	BindParameter (int index, int value)

virtual bool	BindParameter (int index, long value)

virtual bool	BindParameter (int index, unsigned long long value)

virtual bool	BindParameter (int index, long long value)

virtual bool	BindParameter (int index, float value)

virtual bool	BindParameter (int index, double value)

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

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

virtual bool	BindParameter (int index, const vtkStdString &string)

virtual bool	BindParameter (int index, vtkVariant var)

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

virtual bool	ClearParameterBindings ()
	Reset all parameter bindings to nullptr. More...

virtual vtkStdString	EscapeString (vtkStdString s, bool addSurroundingQuotes=true)
	Escape a string for inclusion into an SQL query. More...

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


virtual bool	SetQuery (const char *query)
	The query string to be executed. 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

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

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

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

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

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

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

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

virtual bool	HasError ()=0
	Returns true if an error is set, otherwise false. More...

virtual const char *	GetLastErrorText ()=0
	Get the last error text from the query. 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 ()

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

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 vtkTypeBool	IsTypeOf (const char *type)

static vtkSQLQuery *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkRowQuery
static vtkTypeBool	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

	vtkSQLQuery ()

	~vtkSQLQuery () override

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

Protected Member Functions inherited from vtkRowQuery
	vtkRowQuery ()

	~vtkRowQuery () 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 &)

Protected Attributes
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

executes an sql query and retrieves results

The abstract superclass of SQL query classes. Instances of subclasses of vtkSQLQuery are created using the GetQueryInstance() function in vtkSQLDatabase. To implement a query connection for a new database type, subclass both vtkSQLDatabase and vtkSQLQuery, and implement the required functions. For the query class, this involves the following:

Execute() - Execute the query on the database. No results need to be retrieved at this point, unless you are performing caching.

GetNumberOfFields() - After Execute() is performed, returns the number of fields in the query results.

GetFieldName() - The name of the field at an index.

GetFieldType() - The data type of the field at an index.

NextRow() - Advances the query results by one row, and returns whether there are more rows left in the query.

DataValue() - Extract a single data value from the current row.

Begin/Rollback/CommitTransaction() - These methods are optional but recommended if the database supports transactions.

Thanks:: Thanks to Andrew Wilson from Sandia National Laboratories for his work on the database classes.

See also: vtkSQLDatabase

Examples:: vtkSQLQuery (Examples)

Tests:: vtkSQLQuery (Tests)

Definition at line 74 of file vtkSQLQuery.h.

Member Typedef Documentation

typedef vtkRowQuery vtkSQLQuery::Superclass

Definition at line 77 of file vtkSQLQuery.h.

Constructor & Destructor Documentation

vtkSQLQuery::vtkSQLQuery ( )

protected

vtkSQLQuery::~vtkSQLQuery ( )

overrideprotected

Member Function Documentation

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

static

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

Reimplemented in vtkSQLiteQuery, vtkPostgreSQLQuery, vtkODBCQuery, and vtkMySQLQuery.

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

static

virtual vtkObjectBase* vtkSQLQuery::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRowQuery.

Reimplemented in vtkSQLiteQuery, vtkPostgreSQLQuery, vtkODBCQuery, and vtkMySQLQuery.

vtkSQLQuery* vtkSQLQuery::NewInstance ( ) const

void vtkSQLQuery::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 vtkRowQuery.

virtual bool vtkSQLQuery::SetQuery ( const char * query )

virtual

The query string to be executed.

Since some databases will process the query string as soon as it's set, this method returns a boolean to indicate success or failure.

Reimplemented in vtkODBCQuery, vtkSQLiteQuery, and vtkMySQLQuery.

virtual const char* vtkSQLQuery::GetQuery ( )

virtual

The query string to be executed.

Since some databases will process the query string as soon as it's set, this method returns a boolean to indicate success or failure.

Reimplemented in vtkODBCQuery.

bool vtkSQLQuery::IsActive ( )

inlineoverridevirtual

Return true if the query is active (i.e.

execution was successful and results are ready to be fetched). Returns false on error or inactive query.

Implements vtkRowQuery.

Definition at line 95 of file vtkSQLQuery.h.

bool vtkSQLQuery::Execute ( )

overridepure virtual

Execute the query.

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

Implements vtkRowQuery.

Implemented in vtkSQLiteQuery, vtkMySQLQuery, vtkODBCQuery, and vtkPostgreSQLQuery.

virtual bool vtkSQLQuery::BeginTransaction ( )

inlinevirtual

Begin, commit, or roll back a transaction.

If the underlying database does not support transactions these calls will do nothing.

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, vtkPostgreSQLQuery, and vtkMySQLQuery.

Definition at line 109 of file vtkSQLQuery.h.

virtual bool vtkSQLQuery::CommitTransaction ( )

inlinevirtual

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, vtkPostgreSQLQuery, and vtkMySQLQuery.

Definition at line 110 of file vtkSQLQuery.h.

virtual bool vtkSQLQuery::RollbackTransaction ( )

inlinevirtual

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, vtkPostgreSQLQuery, and vtkMySQLQuery.

Definition at line 111 of file vtkSQLQuery.h.

virtual vtkSQLDatabase* vtkSQLQuery::GetDatabase ( )

virtual

Return the database associated with the query.

virtual bool vtkSQLQuery::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 in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

virtual bool vtkSQLQuery::BindParameter	(	int	index,
		unsigned short	value
	)

virtual

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

virtual bool vtkSQLQuery::BindParameter	(	int	index,
		unsigned int	value
	)

virtual

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

virtual bool vtkSQLQuery::BindParameter	(	int	index,
		unsigned long	value
	)

virtual

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

virtual bool vtkSQLQuery::BindParameter	(	int	index,
		signed char	value
	)

virtual

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

virtual bool vtkSQLQuery::BindParameter	(	int	index,
		short	value
	)

virtual

Reimplemented in vtkSQLiteQuery.

virtual bool vtkSQLQuery::BindParameter	(	int	index,
		int	value
	)

virtual

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

virtual bool vtkSQLQuery::BindParameter	(	int	index,
		long	value
	)

virtual

Reimplemented in vtkSQLiteQuery.

virtual bool vtkSQLQuery::BindParameter	(	int	index,
		unsigned long long	value
	)

virtual

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

virtual bool vtkSQLQuery::BindParameter	(	int	index,
		long long	value
	)

virtual

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

virtual bool vtkSQLQuery::BindParameter	(	int	index,
		float	value
	)

virtual

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

virtual bool vtkSQLQuery::BindParameter	(	int	index,
		double	value
	)

virtual

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

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

virtual

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

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

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

virtual

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

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

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

virtual

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

virtual bool vtkSQLQuery::BindParameter	(	int	index,
		vtkVariant	var
	)

virtual

Reimplemented in vtkSQLiteQuery.

virtual bool vtkSQLQuery::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 in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

virtual bool vtkSQLQuery::ClearParameterBindings ( )

virtual

Reset all parameter bindings to nullptr.

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

virtual vtkStdString vtkSQLQuery::EscapeString	(	vtkStdString	s,
		bool	addSurroundingQuotes = `true`
	)

virtual

Escape a string for inclusion into an SQL query.

If addSurroundingQuotes is true, then quotation marks appropriate to the backend database will be added to enclose the escaped string. This argument defaults to true.

A default, simple-minded implementation is provided for database backends that do not provde a way to escape strings for use inside queries.

Reimplemented in vtkMySQLQuery, and vtkPostgreSQLQuery.

char* vtkSQLQuery::EscapeString	(	const char *	src,
		bool	addSurroundingQuotes
	)

Escape a string for inclusion into an SQL query.

This method exists to provide a wrappable version of the method that takes and returns vtkStdString objects. You are responsible for calling delete [] on the character array returned by this method. This method simply calls the vtkStdString variant and thus need not be re-implemented by subclasses.

void vtkSQLQuery::SetDatabase ( vtkSQLDatabase * db )

protected

Set the database associated with the query.

This is only to be called by the corresponding database class on creation of the query in GetQueryInstance().

Member Data Documentation

char* vtkSQLQuery::Query

protected

Definition at line 225 of file vtkSQLQuery.h.

vtkSQLDatabase* vtkSQLQuery::Database

protected

Definition at line 226 of file vtkSQLQuery.h.

bool vtkSQLQuery::Active

protected

Definition at line 227 of file vtkSQLQuery.h.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/IO/SQL/vtkSQLQuery.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation