wxSQLite3::Statement Class Reference

Represents a prepared SQL statement. More...

#include <wxsqlite3.h>

Public Member Functions
	Statement ()
	Constructor.
	Statement (DatabaseHandlePtr db, StatementHandlePtr stmt)
	Constructor (internal use only).
	Statement (const Statement &)=default
Statement &	operator= (const Statement &)=default
	Statement (Statement &&)=default
Statement &	operator= (Statement &&)=default
virtual	~Statement ()
	Destructor.
int	ExecuteUpdate ()
	Execute the database update represented by this statement.
ResultSet	ExecuteQuery ()
	Execute the query represented by this statement.
int	ExecuteScalar ()
	Execute a scalar SQL query statement given as a wxString.
int	GetParamCount () const
	Get the number of statement parameters.
int	GetParamIndex (const wxString &paramName) const
	Get the index of a parameter with a given name.
wxString	GetParamName (int paramIndex) const
	Get the name of a paramater at the given position.
void	Bind (int paramIndex, const wxString &stringValue)
	Bind parameter to a string value.
void	Bind (int paramIndex, int intValue)
	Bind parameter to a integer value.
void	Bind (int paramIndex, wxLongLong int64Value)
	Bind parameter to a 64-bit integer value.
void	Bind (int paramIndex, double doubleValue)
	Bind parameter to a double value.
void	Bind (int paramIndex, const char *charValue)
	Bind parameter to a utf-8 character string value.
void	Bind (int paramIndex, const unsigned char *blobValue, int blobLen)
	Bind parameter to a BLOB value.
void	Bind (int paramIndex, const wxMemoryBuffer &blobValue)
	Bind parameter to a BLOB value.
void	Bind (int paramIndex, void *pointer, const wxString &pointerType, void(*DeletePointer)(void *)=nullptr)
	Bind parameter to a pointer value.
void	BindDate (int paramIndex, const wxDateTime &date)
	Bind parameter to a date value.
void	BindTime (int paramIndex, const wxDateTime &time)
	Bind parameter to a time value.
void	BindDateTime (int paramIndex, const wxDateTime &datetime)
	Bind parameter to a date and time value.
void	BindTimestamp (int paramIndex, const wxDateTime &timestamp)
	Bind parameter to a timestamp value.
void	BindNumericDateTime (int paramIndex, const wxDateTime &datetime)
	Bind parameter to a date and time value.
void	BindUnixDateTime (int paramIndex, const wxDateTime &datetime)
	Bind parameter to a date and time value.
void	BindJulianDayNumber (int paramIndex, const wxDateTime &datetime)
	Bind parameter to a date and time value.
void	BindBool (int paramIndex, bool value)
	Bind parameter to a boolean value.
void	BindNull (int paramIndex)
	Bind parameter to a NULL value.
void	BindZeroBlob (int paramIndex, int blobSize)
	Bind parameter to a Zero BLOB value.
void	ClearBindings ()
	Clear all parameter bindings.
wxString	GetSQL () const
	Get the original SQL string for the prepared statement.
wxString	GetExpandedSQL () const
	Get the original SQL string for the prepared statement with expanded bound parameters.
void	Reset ()
	Reset the prepared statement.
bool	IsReadOnly () const
	Determine whether the statement is read-only.
void	Finalize ()
	Finalize the prepared statement.
bool	IsOk () const
	Validate associated SQLite database and statement.
bool	IsBusy () const
	Determine if a prepared statement has been reset.
int	Status (StatementStatus opCode, bool resetFlag=false) const
	Determine internal operation counters of the underlying prepared statement.
template<typename T>
void	Bind (int paramIndex, std::optional< T > const &value)
	Bind a std::optional value to a placeholder in the statement.
template<typename... T>
void	BindTuple (std::tuple< T... > const &values)
	Bind a tuple of parameters with specified types to placeholders in the statement.
template<typename... T>
void	BindTuple (const std::tuple< T... > &values, const std::array< int, sizeof...(T)> &paramIndices)
	Bind a tuple of parameters with specified types to placeholders in the statement.

Detailed Description

Represents a prepared SQL statement.

Constructor & Destructor Documentation

Statement() [1/4]

wxSQLite3::Statement::Statement

(

)

Constructor.

Statement() [2/4]

wxSQLite3::Statement::Statement	(	DatabaseHandlePtr	db,
		StatementHandlePtr	stmt )

Constructor (internal use only).

Statement() [3/4]

wxSQLite3::Statement::Statement ( const Statement & )

default

Statement() [4/4]

wxSQLite3::Statement::Statement ( Statement && )

default

~Statement()

virtual wxSQLite3::Statement::~Statement ( )

virtual

Destructor.

Member Function Documentation

Bind() [1/9]

void wxSQLite3::Statement::Bind	(	int	paramIndex,
		const char *	charValue )

Bind parameter to a utf-8 character string value.

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
charValue	value of the parameter

Bind() [2/9]

void wxSQLite3::Statement::Bind	(	int	paramIndex,
		const unsigned char *	blobValue,
		int	blobLen )

Bind parameter to a BLOB value.

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
blobValue	value of the parameter
blobLen	length of the blob in bytes

Bind() [3/9]

void wxSQLite3::Statement::Bind	(	int	paramIndex,
		const wxMemoryBuffer &	blobValue )

Bind parameter to a BLOB value.

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
blobValue	value of the parameter

Bind() [4/9]

void wxSQLite3::Statement::Bind	(	int	paramIndex,
		const wxString &	stringValue )

Bind parameter to a string value.

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
stringValue	value of the parameter

Bind() [5/9]

void wxSQLite3::Statement::Bind	(	int	paramIndex,
		double	doubleValue )

Bind parameter to a double value.

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
doubleValue	value of the parameter

Bind() [6/9]

void wxSQLite3::Statement::Bind	(	int	paramIndex,
		int	intValue )

Bind parameter to a integer value.

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
intValue	value of the parameter

Bind() [7/9]

template<typename T>

void wxSQLite3::Statement::Bind ( int paramIndex, std::optional< T > const & value )

inline

Bind a std::optional value to a placeholder in the statement.

The specified type template parameter determines the type of the value. The value can be std::nullopt representing a SQL NULL value. Supported types: int, wxLongLong, double, wxString, wxDateTime, and bool.

Parameters

paramIndex

index of the column. Indices start with 1.

Bind() [8/9]

void wxSQLite3::Statement::Bind	(	int	paramIndex,
		void *	pointer,
		const wxString &	pointerType,
		void(*	DeletePointer )(void *) = nullptr )

Bind parameter to a pointer value.

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
pointer	pointer value of the parameter
pointerType	descriptive name of the pointer type as expected by the extension module
DeletePointer	pointer to a function for deleting the object pointed to by the pointer after use in SQLite (default: NULL)

Bind() [9/9]

void wxSQLite3::Statement::Bind	(	int	paramIndex,
		wxLongLong	int64Value )

Bind parameter to a 64-bit integer value.

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
int64Value	value of the parameter

BindBool()

void wxSQLite3::Statement::BindBool	(	int	paramIndex,
		bool	value )

Bind parameter to a boolean value.

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
value	value of the parameter

BindDate()

void wxSQLite3::Statement::BindDate	(	int	paramIndex,
		const wxDateTime &	date )

Bind parameter to a date value.

Only the date part is stored in format 'YYYY-MM-DD'.

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
date	value of the parameter

BindDateTime()

void wxSQLite3::Statement::BindDateTime	(	int	paramIndex,
		const wxDateTime &	datetime )

Bind parameter to a date and time value.

Date and time are stored in format 'YYYY-MM-DD HH:MM:SS'.

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
datetime	value of the parameter

BindJulianDayNumber()

void wxSQLite3::Statement::BindJulianDayNumber	(	int	paramIndex,
		const wxDateTime &	datetime )

Bind parameter to a date and time value.

The date/time value is transferred to the database as a Julian Day Number value (i.e. double).

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
datetime	value of the parameter

BindNull()

void wxSQLite3::Statement::BindNull

(

int

paramIndex

)

Bind parameter to a NULL value.

Parameters

paramIndex

index of the parameter. The first parameter has an index of 1.

BindNumericDateTime()

void wxSQLite3::Statement::BindNumericDateTime	(	int	paramIndex,
		const wxDateTime &	datetime )

Bind parameter to a date and time value.

The date/time value is transferred to the database as a numeric value (i.e. int64). The value is measured in milliseconds since 1970-01-01.

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
datetime	value of the parameter

BindTime()

void wxSQLite3::Statement::BindTime	(	int	paramIndex,
		const wxDateTime &	time )

Bind parameter to a time value.

Only the time part is stored in format 'HH:MM:SS'.

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
time	value of the parameter

BindTimestamp()

void wxSQLite3::Statement::BindTimestamp	(	int	paramIndex,
		const wxDateTime &	timestamp )

Bind parameter to a timestamp value.

Timestamp is stored in format 'YYYY-MM-DD HH:MM:SS.mmm'.

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
timestamp	value of the parameter

BindTuple() [1/2]

template<typename... T>

void wxSQLite3::Statement::BindTuple ( const std::tuple< T... > & values, const std::array< int, sizeof...(T)> & paramIndices )

inline

Bind a tuple of parameters with specified types to placeholders in the statement.

The specified type template parameters of the tuple determine the number and types of the values to be bound to placeholders in the SQL statement.

Parameters

values	Tuple of values, can contain std::nullopt
paramIndices	Array of 1-based indices of placeholders to which the tuple members should be bound

BindTuple() [2/2]

template<typename... T>

void wxSQLite3::Statement::BindTuple ( std::tuple< T... > const & values )

inline

Bind a tuple of parameters with specified types to placeholders in the statement.

The specified type template parameters of the tuple determine the number and types of the values to be bound to placeholders in the SQL statement.

Parameters

values

Tuple of values, can contain std::nullopt

BindUnixDateTime()

void wxSQLite3::Statement::BindUnixDateTime	(	int	paramIndex,
		const wxDateTime &	datetime )

Bind parameter to a date and time value.

The date/time value is transferred to the database as an integer value. The value is measured in seconds since 1970-01-01.

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
datetime	value of the parameter

BindZeroBlob()

void wxSQLite3::Statement::BindZeroBlob	(	int	paramIndex,
		int	blobSize )

Bind parameter to a Zero BLOB value.

Space for a BLOB is reserved and filled with binary zeros for later reference through a BLOB handle.

Parameters

paramIndex	index of the parameter. The first parameter has an index of 1.
blobSize	size of the BLOB

ClearBindings()

void wxSQLite3::Statement::ClearBindings

(

)

Clear all parameter bindings.

Sets all the parameters in the prepared SQL statement back to NULL.

ExecuteQuery()

ResultSet wxSQLite3::Statement::ExecuteQuery

(

)

Execute the query represented by this statement.

Returns

result set instance

ExecuteScalar()

int wxSQLite3::Statement::ExecuteScalar

(

)

Execute a scalar SQL query statement given as a wxString.

Allows to easily retrieve the result of queries returning a single integer result like SELECT COUNT(*) FROM table WHERE condition.

Returns

first column of first row as an int

ExecuteUpdate()

int wxSQLite3::Statement::ExecuteUpdate

(

)

Execute the database update represented by this statement.

Returns

the number of database rows that were changed (or inserted or deleted)

Finalize()

void wxSQLite3::Statement::Finalize

(

)

Finalize the prepared statement.

GetExpandedSQL()

wxString wxSQLite3::Statement::GetExpandedSQL

(

)

const

Get the original SQL string for the prepared statement with expanded bound parameters.

Returns

the original SQL string used to prepare the statement with expanded bound parameters

GetParamCount()

int wxSQLite3::Statement::GetParamCount

(

)

const

Get the number of statement parameters.

Returns

the number of parameters in the prepared statement

GetParamIndex()

int wxSQLite3::Statement::GetParamIndex

(

const wxString &

paramName

)

const

Get the index of a parameter with a given name.

Parameters

paramName

Returns

the index of the parameter with the given name. The name must match exactly. If there is no parameter with the given name, return 0.

GetParamName()

wxString wxSQLite3::Statement::GetParamName

(

int

paramIndex

)

const

Get the name of a paramater at the given position.

Parameters

paramIndex

index of the parameter. The first parameter has an index of 1.

Returns

the name of the paramIndex-th parameter in the precompiled statement. Parameters of the form ":AAA" or "$VVV" have a name which is the string ":AAA" or "$VVV". Parameters of the form "?" have no name.

GetSQL()

wxString wxSQLite3::Statement::GetSQL

(

)

const

Get the original SQL string for the prepared statement.

Returns

the original SQL string used to prepare the statement

IsBusy()

bool wxSQLite3::Statement::IsBusy

(

)

const

Determine if a prepared statement has been reset.

Returns

TRUE if the prepared statement has been stepped at least once but has not run to completion and/or has not been reset, FALSE otherwise

IsOk()

bool wxSQLite3::Statement::IsOk

(

)

const

Validate associated SQLite database and statement.

Returns

TRUE if both, a SQLite database and a SQLite statement, are associated, FALSE otherwise

IsReadOnly()

bool wxSQLite3::Statement::IsReadOnly

(

)

const

Determine whether the statement is read-only.

Returns

TRUE if the statement is read-only, FALSE otherwise

Since

SQLite3 version 3.7.4

Note

For SQLite3 version before version 3.7.4 this method returns always FALSE.

operator=() [1/2]

Statement & wxSQLite3::Statement::operator= ( const Statement & )

default

operator=() [2/2]

Statement & wxSQLite3::Statement::operator= ( Statement && )

default

Reset()

void wxSQLite3::Statement::Reset

(

)

Reset the prepared statement.

Resets the statement back to it's initial state, ready to be re-executed. Any SQL statement variables that had values bound to them retain their values.

Status()

int wxSQLite3::Statement::Status	(	StatementStatus	opCode,
		bool	resetFlag = false ) const

Determine internal operation counters of the underlying prepared statement.

Prepared statements maintain various counters to measure the performance of specific operations. This method allows to monitor the performance characteristics of the prepared statement.

Parameters

opCode	operation code of the operation to be queried
resetFlag	flag whether the associated counter should be reset to zero (default: false)

Returns

the counter value for the requested counter

---

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

• wxsqlite3.h