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 Member Functions
virtual int	IsA (const char *type)
vtkSQLQuery *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
bool	IsActive ()
virtual bool	Execute ()=0
virtual bool	BindParameter (int index, unsigned char value)
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, vtkTypeUInt64 value)
virtual bool	BindParameter (int index, vtkTypeInt64 value)
virtual bool	BindParameter (int index, float value)
virtual bool	BindParameter (int index, double value)
virtual bool	BindParameter (int index, const char *stringValue)
virtual bool	BindParameter (int index, const void *data, size_t length)
virtual bool	ClearParameterBindings ()
char *	EscapeString (const char *src, bool addSurroundingQuotes)

virtual bool	SetQuery (const char *query)
virtual const char *	GetQuery ()

virtual bool	BeginTransaction ()
virtual bool	CommitTransaction ()
virtual bool	RollbackTransaction ()

virtual vtkSQLDatabase *	GetDatabase ()

virtual bool	BindParameter (int index, const char *stringValue, size_t length)
virtual bool	BindParameter (int index, const vtkStdString &string)
virtual bool	BindParameter (int index, vtkVariant var)

virtual vtkStdString	EscapeString (vtkStdString s, bool addSurroundingQuotes=true)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkSQLQuery *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkSQLQuery ()
	~vtkSQLQuery ()
void	SetDatabase (vtkSQLDatabase *db)
Protected Attributes
char *	Query
vtkSQLDatabase *	Database
bool	Active

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 73 of file vtkSQLQuery.h.

Member Typedef Documentation

typedef vtkRowQuery vtkSQLQuery::Superclass

Reimplemented from vtkRowQuery.

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, vtkPostgreSQLQuery, and vtkMySQLQuery.

Definition at line 76 of file vtkSQLQuery.h.

Constructor & Destructor Documentation

vtkSQLQuery::vtkSQLQuery ( ) [protected]

vtkSQLQuery::~vtkSQLQuery ( ) [protected]

Member Function Documentation

static int vtkSQLQuery::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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, vtkODBCQuery, vtkPostgreSQLQuery, and vtkMySQLQuery.

virtual int 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, vtkODBCQuery, vtkPostgreSQLQuery, and vtkMySQLQuery.

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

Reimplemented from vtkRowQuery.

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, vtkPostgreSQLQuery, and vtkMySQLQuery.

virtual vtkObjectBase* vtkSQLQuery::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkRowQuery.

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, vtkPostgreSQLQuery, and vtkMySQLQuery.

vtkSQLQuery* vtkSQLQuery::NewInstance ( ) const

Reimplemented from vtkRowQuery.

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, vtkPostgreSQLQuery, and vtkMySQLQuery.

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

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, vtkMySQLQuery, and vtkPostgreSQLQuery.

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 ( ) [inline, virtual]

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 90 of file vtkSQLQuery.h.

virtual bool vtkSQLQuery::Execute ( ) [pure 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 ( ) [inline, virtual]

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 99 of file vtkSQLQuery.h.

virtual bool vtkSQLQuery::CommitTransaction ( ) [inline, virtual]

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 100 of file vtkSQLQuery.h.

virtual bool vtkSQLQuery::RollbackTransaction ( ) [inline, virtual]

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 101 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,
		vtkTypeUInt64	value
	)		`[virtual]`

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

virtual bool vtkSQLQuery::BindParameter	(	int	index,
		vtkTypeInt64	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]`

Bind a string value by specifying an array and a size

Reimplemented in vtkSQLiteQuery, vtkODBCQuery, and vtkMySQLQuery.

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

Bind a string value by specifying an array and a size

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

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