wxSQLite3 2.1.2
Public Member Functions
wxSQLite3Statement Class Reference

Represents a prepared SQL statement. More...

#include <wxsqlite3.h>

List of all members.

Public Member Functions

 wxSQLite3Statement ()
 Constructor.
 wxSQLite3Statement (const wxSQLite3Statement &statement)
 Copy constructor.
wxSQLite3Statementoperator= (const wxSQLite3Statement &statement)
 Assignement constructor.
 wxSQLite3Statement (void *db, void *stmt)
 Constructor (internal use only)
virtual ~wxSQLite3Statement ()
 Destructor.
int ExecuteUpdate ()
 Execute the database update represented by this statement.
wxSQLite3ResultSet ExecuteQuery (bool transferStatementOwnership=false)
 Execute the query represented by this statement.
int ExecuteScalar ()
 Execute a scalar SQL query statement given as a wxString.
int GetParamCount ()
 Get the number of statement parameters.
int GetParamIndex (const wxString &paramName)
 Get the index of a parameter with a given name.
wxString GetParamName (int paramIndex)
 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 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 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 ()
 Get the original SQL string for the prepared statement.
void Reset ()
 Reset the prepared statement.
bool IsReadOnly ()
 Determine whether the statement is read-only.
void Finalize ()
 Finalize the prepared statement.
bool IsOk ()
 Validate associated SQLite database and statement.

Detailed Description

Represents a prepared SQL statement.


Constructor & Destructor Documentation

wxSQLite3Statement::wxSQLite3Statement ( )

Constructor.

wxSQLite3Statement::wxSQLite3Statement ( const wxSQLite3Statement statement)

Copy constructor.

wxSQLite3Statement::wxSQLite3Statement ( void *  db,
void *  stmt 
)

Constructor (internal use only)

wxSQLite3Statement::~wxSQLite3Statement ( ) [virtual]

Destructor.


Member Function Documentation

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

Bind parameter to a string value.

Parameters:
paramIndexindex of the parameter. The first parameter has an index of 1.
stringValuevalue of the parameter
void wxSQLite3Statement::Bind ( int  paramIndex,
int  intValue 
)

Bind parameter to a integer value.

Parameters:
paramIndexindex of the parameter. The first parameter has an index of 1.
intValuevalue of the parameter
void wxSQLite3Statement::Bind ( int  paramIndex,
wxLongLong  int64Value 
)

Bind parameter to a 64-bit integer value.

Parameters:
paramIndexindex of the parameter. The first parameter has an index of 1.
int64Valuevalue of the parameter
void wxSQLite3Statement::Bind ( int  paramIndex,
double  doubleValue 
)

Bind parameter to a double value.

Parameters:
paramIndexindex of the parameter. The first parameter has an index of 1.
doubleValuevalue of the parameter
void wxSQLite3Statement::Bind ( int  paramIndex,
const char *  charValue 
)

Bind parameter to a utf-8 character string value.

Parameters:
paramIndexindex of the parameter. The first parameter has an index of 1.
charValuevalue of the parameter
void wxSQLite3Statement::Bind ( int  paramIndex,
const unsigned char *  blobValue,
int  blobLen 
)

Bind parameter to a BLOB value.

Parameters:
paramIndexindex of the parameter. The first parameter has an index of 1.
blobValuevalue of the parameter
blobLenlength of the blob in bytes
void wxSQLite3Statement::Bind ( int  paramIndex,
const wxMemoryBuffer &  blobValue 
)

Bind parameter to a BLOB value.

Parameters:
paramIndexindex of the parameter. The first parameter has an index of 1.
blobValuevalue of the parameter
void wxSQLite3Statement::BindBool ( int  paramIndex,
bool  value 
)

Bind parameter to a boolean value.

Parameters:
paramIndexindex of the parameter. The first parameter has an index of 1.
valuevalue of the parameter
void wxSQLite3Statement::BindDate ( int  paramIndex,
const wxDateTime &  date 
)

Bind parameter to a date value.

Parameters:
paramIndexindex of the parameter. The first parameter has an index of 1.
datevalue of the parameter
void wxSQLite3Statement::BindDateTime ( int  paramIndex,
const wxDateTime &  datetime 
)

Bind parameter to a date and time value.

Parameters:
paramIndexindex of the parameter. The first parameter has an index of 1.
datetimevalue of the parameter
void wxSQLite3Statement::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:
paramIndexindex of the parameter. The first parameter has an index of 1.
datetimevalue of the parameter
void wxSQLite3Statement::BindNull ( int  paramIndex)

Bind parameter to a NULL value.

Parameters:
paramIndexindex of the parameter. The first parameter has an index of 1.
void wxSQLite3Statement::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).

Parameters:
paramIndexindex of the parameter. The first parameter has an index of 1.
datetimevalue of the parameter
void wxSQLite3Statement::BindTime ( int  paramIndex,
const wxDateTime &  time 
)

Bind parameter to a time value.

Parameters:
paramIndexindex of the parameter. The first parameter has an index of 1.
timevalue of the parameter
void wxSQLite3Statement::BindTimestamp ( int  paramIndex,
const wxDateTime &  timestamp 
)

Bind parameter to a timestamp value.

Parameters:
paramIndexindex of the parameter. The first parameter has an index of 1.
timestampvalue of the parameter
void wxSQLite3Statement::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:
paramIndexindex of the parameter. The first parameter has an index of 1.
blobSizesize of the BLOB
void wxSQLite3Statement::ClearBindings ( )

Clear all parameter bindings.

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

wxSQLite3ResultSet wxSQLite3Statement::ExecuteQuery ( bool  transferStatementOwnership = false)

Execute the query represented by this statement.

Parameters:
transferStatementOwnershipif TRUE the ownership of the underlying SQLite statement object is transferred to the created result set (default: FALSE)
Returns:
result set instance
Note:
the transfer of ownership of the underlying SQLite statement object can be performed only once. If the transfer of ownership has been requested this wxSQL3Statement instance isn't usable anymore as soon as the result set is destroyed. If the transfer of ownership isn't requested the created result set can be used to retrieve the selected data rows only as long as this wxSQLite3Statement instance exists.
int wxSQLite3Statement::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
int wxSQLite3Statement::ExecuteUpdate ( )

Execute the database update represented by this statement.

Returns:
the number of database rows that were changed (or inserted or deleted)
void wxSQLite3Statement::Finalize ( )

Finalize the prepared statement.

int wxSQLite3Statement::GetParamCount ( )

Get the number of statement parameters.

Returns:
the number of parameters in the prepared statement
int wxSQLite3Statement::GetParamIndex ( const wxString &  paramName)

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.
wxString wxSQLite3Statement::GetParamName ( int  paramIndex)

Get the name of a paramater at the given position.

Parameters:
paramIndexindex 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.
wxString wxSQLite3Statement::GetSQL ( )

Get the original SQL string for the prepared statement.

Returns:
the original SQL string used to prepare the statement
bool wxSQLite3Statement::IsOk ( )

Validate associated SQLite database and statement.

Returns:
TRUE if both, a SQLite database and a SQLite statement, are associated, FALSE otherwise
bool wxSQLite3Statement::IsReadOnly ( )

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.
wxSQLite3Statement & wxSQLite3Statement::operator= ( const wxSQLite3Statement statement)

Assignement constructor.

void wxSQLite3Statement::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.


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