Kitware.VTK.vtkSQLQuery Class Reference

vtkSQLQuery - executes an sql query and retrieves results More...

Inheritance diagram for Kitware.VTK.vtkSQLQuery:

Collaboration diagram for Kitware.VTK.vtkSQLQuery:

List of all members.

Public Member Functions
	vtkSQLQuery (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
virtual bool	BeginTransaction ()
	Begin, commit, or roll back a transaction. If the underlying database does not support transactions these calls will do nothing.
virtual bool	BindParameter (int index, byte value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, ushort value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, uint value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, sbyte value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, short value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, int value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, ulong value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, long value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, float value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, double value)
	Return the database associated with the query.
virtual bool	BindParameter (int index, string stringValue)
	Bind a string value -- string must be null-terminated.
virtual bool	BindParameter (int index, string stringValue, uint length)
	Bind a string value by specifying an array and a size.
virtual bool	BindParameter (int index, IntPtr data, uint length)
	Bind a blob value. Not all databases support blobs as a data type. Check vtkSQLDatabase::IsSupported(VTK_SQL_FEATURE_BLOB) to make sure.
virtual bool	ClearParameterBindings ()
	Reset all parameter bindings to NULL.
virtual bool	CommitTransaction ()
	Begin, commit, or roll back a transaction. If the underlying database does not support transactions these calls will do nothing.
string	EscapeString (string 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.
override bool	Execute ()
	Execute the query. This must be performed before any field name or data access functions are used.
virtual vtkSQLDatabase	GetDatabase ()
	Return the database associated with the query.
virtual string	GetQuery ()
	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.
override int	IsA (string type)
	Undocumented Block.
override bool	IsActive ()
	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.
new vtkSQLQuery	NewInstance ()
	Undocumented Block.
virtual bool	RollbackTransaction ()
	Begin, commit, or roll back a transaction. If the underlying database does not support transactions these calls will do nothing.
virtual bool	SetQuery (string query)
	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.
Static Public Member Functions
static new int	IsTypeOf (string type)
	Undocumented Block.
static new vtkSQLQuery	SafeDownCast (vtkObjectBase o)
	Undocumented Block.
Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkSQLQuery"
	Automatically generated type registration mechanics.
Static Public Attributes
static new readonly string	MRClassNameKey = "11vtkSQLQuery"
	Automatically generated type registration mechanics.
Protected Member Functions
override void	Dispose (bool disposing)
	Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.
Private Member Functions
static internal byte	vtkSQLQuery_BeginTransaction_01 (HandleRef pThis)
static internal byte	vtkSQLQuery_BindParameter_02 (HandleRef pThis, int index, byte value)
static internal byte	vtkSQLQuery_BindParameter_03 (HandleRef pThis, int index, ushort value)
static internal byte	vtkSQLQuery_BindParameter_04 (HandleRef pThis, int index, uint value)
static internal byte	vtkSQLQuery_BindParameter_05 (HandleRef pThis, int index, sbyte value)
static internal byte	vtkSQLQuery_BindParameter_06 (HandleRef pThis, int index, short value)
static internal byte	vtkSQLQuery_BindParameter_07 (HandleRef pThis, int index, int value)
static internal byte	vtkSQLQuery_BindParameter_08 (HandleRef pThis, int index, ulong value)
static internal byte	vtkSQLQuery_BindParameter_09 (HandleRef pThis, int index, long value)
static internal byte	vtkSQLQuery_BindParameter_10 (HandleRef pThis, int index, float value)
static internal byte	vtkSQLQuery_BindParameter_11 (HandleRef pThis, int index, double value)
static internal byte	vtkSQLQuery_BindParameter_12 (HandleRef pThis, int index, string stringValue)
static internal byte	vtkSQLQuery_BindParameter_13 (HandleRef pThis, int index, string stringValue, uint length)
static internal byte	vtkSQLQuery_BindParameter_14 (HandleRef pThis, int index, IntPtr data, uint length)
static internal byte	vtkSQLQuery_ClearParameterBindings_15 (HandleRef pThis)
static internal byte	vtkSQLQuery_CommitTransaction_16 (HandleRef pThis)
static internal IntPtr	vtkSQLQuery_EscapeString_17 (HandleRef pThis, string src, byte addSurroundingQuotes)
static internal byte	vtkSQLQuery_Execute_18 (HandleRef pThis)
static internal IntPtr	vtkSQLQuery_GetDatabase_19 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr	vtkSQLQuery_GetQuery_20 (HandleRef pThis)
static internal int	vtkSQLQuery_IsA_21 (HandleRef pThis, string type)
static internal byte	vtkSQLQuery_IsActive_22 (HandleRef pThis)
static internal int	vtkSQLQuery_IsTypeOf_23 (string type)
static internal IntPtr	vtkSQLQuery_NewInstance_24 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte	vtkSQLQuery_RollbackTransaction_25 (HandleRef pThis)
static internal IntPtr	vtkSQLQuery_SafeDownCast_26 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte	vtkSQLQuery_SetQuery_27 (HandleRef pThis, string query)
Static Private Member Functions
static	vtkSQLQuery ()
	Automatically generated type registration mechanics.

---

Detailed Description

vtkSQLQuery - executes an sql query and retrieves results

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

vtkSQLDatabase

---

Constructor & Destructor Documentation

static Kitware.VTK.vtkSQLQuery.vtkSQLQuery

(

)

[static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkSQLQuery.vtkSQLQuery	(	IntPtr	rawCppThis,
		bool	callDisposalMethod,
		bool	strong
	)

Automatically generated constructor - called from generated code. DO NOT call directly.

---

Member Function Documentation

virtual bool Kitware.VTK.vtkSQLQuery.BeginTransaction

(

)

[virtual]

Begin, commit, or roll back a transaction. If the underlying database does not support transactions these calls will do nothing.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		byte	value
	)		[virtual]

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		ushort	value
	)		[virtual]

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		uint	value
	)		[virtual]

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		sbyte	value
	)		[virtual]

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		short	value
	)		[virtual]

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		int	value
	)		[virtual]

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		ulong	value
	)		[virtual]

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		long	value
	)		[virtual]

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		float	value
	)		[virtual]

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		double	value
	)		[virtual]

Return the database associated with the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		string	stringValue
	)		[virtual]

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

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		string	stringValue,
		uint	length
	)		[virtual]

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

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.BindParameter	(	int	index,
		IntPtr	data,
		uint	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 Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.ClearParameterBindings

(

)

[virtual]

Reset all parameter bindings to NULL.

Reimplemented in Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

virtual bool Kitware.VTK.vtkSQLQuery.CommitTransaction

(

)

[virtual]

Begin, commit, or roll back a transaction. If the underlying database does not support transactions these calls will do nothing.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

override void Kitware.VTK.vtkSQLQuery.Dispose

(

bool

disposing

)

[protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkRowQuery.

Reimplemented in Kitware.VTK.vtkSQLiteQuery, Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkPostgreSQLQuery.

string Kitware.VTK.vtkSQLQuery.EscapeString	(	string	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.

override bool Kitware.VTK.vtkSQLQuery.Execute

(

)

[virtual]

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

Reimplemented from Kitware.VTK.vtkRowQuery.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

virtual vtkSQLDatabase Kitware.VTK.vtkSQLQuery.GetDatabase

(

)

[virtual]

Return the database associated with the query.

Here is the call graph for this function:

virtual string Kitware.VTK.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.

override int Kitware.VTK.vtkSQLQuery.IsA

(

string

type

)

[virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkRowQuery.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

override bool Kitware.VTK.vtkSQLQuery.IsActive

(

)

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

Reimplemented from Kitware.VTK.vtkRowQuery.

static new int Kitware.VTK.vtkSQLQuery.IsTypeOf

(

string

type

)

[static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkRowQuery.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

new vtkSQLQuery Kitware.VTK.vtkSQLQuery.NewInstance

(

)

Undocumented Block.

Reimplemented from Kitware.VTK.vtkRowQuery.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

virtual bool Kitware.VTK.vtkSQLQuery.RollbackTransaction

(

)

[virtual]

Begin, commit, or roll back a transaction. If the underlying database does not support transactions these calls will do nothing.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

static new vtkSQLQuery Kitware.VTK.vtkSQLQuery.SafeDownCast

(

vtkObjectBase

o

)

[static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkRowQuery.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

Here is the call graph for this function:

virtual bool Kitware.VTK.vtkSQLQuery.SetQuery

(

string

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 Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkSQLiteQuery.

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_BeginTransaction_01

(

HandleRef

pThis

)

[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_BindParameter_02	(	HandleRef	pThis,
		int	index,
		byte	value
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_BindParameter_03	(	HandleRef	pThis,
		int	index,
		ushort	value
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_BindParameter_04	(	HandleRef	pThis,
		int	index,
		uint	value
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_BindParameter_05	(	HandleRef	pThis,
		int	index,
		sbyte	value
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_BindParameter_06	(	HandleRef	pThis,
		int	index,
		short	value
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_BindParameter_07	(	HandleRef	pThis,
		int	index,
		int	value
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_BindParameter_08	(	HandleRef	pThis,
		int	index,
		ulong	value
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_BindParameter_09	(	HandleRef	pThis,
		int	index,
		long	value
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_BindParameter_10	(	HandleRef	pThis,
		int	index,
		float	value
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_BindParameter_11	(	HandleRef	pThis,
		int	index,
		double	value
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_BindParameter_12	(	HandleRef	pThis,
		int	index,
		string	stringValue
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_BindParameter_13	(	HandleRef	pThis,
		int	index,
		string	stringValue,
		uint	length
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_BindParameter_14	(	HandleRef	pThis,
		int	index,
		IntPtr	data,
		uint	length
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_ClearParameterBindings_15

(

HandleRef

pThis

)

[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_CommitTransaction_16

(

HandleRef

pThis

)

[private]

static internal IntPtr Kitware.VTK.vtkSQLQuery.vtkSQLQuery_EscapeString_17	(	HandleRef	pThis,
		string	src,
		byte	addSurroundingQuotes
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_Execute_18

(

HandleRef

pThis

)

[private]

static internal IntPtr Kitware.VTK.vtkSQLQuery.vtkSQLQuery_GetDatabase_19	(	HandleRef	pThis,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal IntPtr Kitware.VTK.vtkSQLQuery.vtkSQLQuery_GetQuery_20

(

HandleRef

pThis

)

[private]

static internal int Kitware.VTK.vtkSQLQuery.vtkSQLQuery_IsA_21	(	HandleRef	pThis,
		string	type
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_IsActive_22

(

HandleRef

pThis

)

[private]

static internal int Kitware.VTK.vtkSQLQuery.vtkSQLQuery_IsTypeOf_23

(

string

type

)

[private]

static internal IntPtr Kitware.VTK.vtkSQLQuery.vtkSQLQuery_NewInstance_24	(	HandleRef	pThis,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_RollbackTransaction_25

(

HandleRef

pThis

)

[private]

static internal IntPtr Kitware.VTK.vtkSQLQuery.vtkSQLQuery_SafeDownCast_26	(	HandleRef	o,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal byte Kitware.VTK.vtkSQLQuery.vtkSQLQuery_SetQuery_27	(	HandleRef	pThis,
		string	query
	)		[private]

---

Member Data Documentation

new readonly string Kitware.VTK.vtkSQLQuery.MRClassNameKey = "11vtkSQLQuery" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkRowQuery.

Reimplemented in Kitware.VTK.vtkSQLiteQuery, Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkPostgreSQLQuery.

new const string Kitware.VTK.vtkSQLQuery.MRFullTypeName = "Kitware.VTK.vtkSQLQuery"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkRowQuery.

Reimplemented in Kitware.VTK.vtkSQLiteQuery, Kitware.VTK.vtkMySQLQuery, and Kitware.VTK.vtkPostgreSQLQuery.

---

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

• csharp/vtkSQLQuery.cs