wxSQLite3: wxSQLite3Statement Class Reference

wxSQLite3 3.3.1

- Main Page
- Classes
- Files

- Class List
- Class Hierarchy
- Class Members

Public Member Functions | List of all members
wxSQLite3Statement Class Reference

Represents a prepared SQL statement. More...

`#include <wxsqlite3.h>`

## Public Member Functions
| wxSQLite3Statement ()
| Constructor. More...
| wxSQLite3Statement (const wxSQLite3Statement &statement)
| Copy constructor. More...
wxSQLite3Statement & | operator= (const wxSQLite3Statement &statement)
| Assignement constructor. More...
| wxSQLite3Statement (wxSQLite3DatabaseReference *db, wxSQLite3StatementReference *stmt)
| Constructor (internal use only) More...
virtual | ~wxSQLite3Statement ()
| Destructor. More...
int | ExecuteUpdate ()
| Execute the database update represented by this statement. More...
wxSQLite3ResultSet | ExecuteQuery ()
| Execute the query represented by this statement. More...
int | ExecuteScalar ()
| Execute a scalar SQL query statement given as a wxString. More...
int | GetParamCount ()
| Get the number of statement parameters. More...
int | GetParamIndex (const wxString &paramName)
| Get the index of a parameter with a given name. More...
wxString | GetParamName (int paramIndex)
| Get the name of a paramater at the given position. More...
void | Bind (int paramIndex, const wxString &stringValue)
| Bind parameter to a string value. More...
void | Bind (int paramIndex, int intValue)
| Bind parameter to a integer value. More...
void | Bind (int paramIndex, wxLongLong int64Value)
| Bind parameter to a 64-bit integer value. More...
void | Bind (int paramIndex, double doubleValue)
| Bind parameter to a double value. More...
void | Bind (int paramIndex, const char *charValue)
| Bind parameter to a utf-8 character string value. More...
void | Bind (int paramIndex, const unsigned char *blobValue, int blobLen)
| Bind parameter to a BLOB value. More...
void | Bind (int paramIndex, const wxMemoryBuffer &blobValue)
| Bind parameter to a BLOB value. More...
void | BindDate (int paramIndex, const wxDateTime &date)
| Bind parameter to a date value. More...
void | BindTime (int paramIndex, const wxDateTime &time)
| Bind parameter to a time value. More...
void | BindDateTime (int paramIndex, const wxDateTime &datetime)
| Bind parameter to a date and time value. More...
void | BindTimestamp (int paramIndex, const wxDateTime &timestamp)
| Bind parameter to a timestamp value. More...
void | BindNumericDateTime (int paramIndex, const wxDateTime &datetime)
| Bind parameter to a date and time value. More...
void | BindUnixDateTime (int paramIndex, const wxDateTime &datetime)
| Bind parameter to a date and time value. More...
void | BindJulianDayNumber (int paramIndex, const wxDateTime &datetime)
| Bind parameter to a date and time value. More...
void | BindBool (int paramIndex, bool value)
| Bind parameter to a boolean value. More...
void | BindNull (int paramIndex)
| Bind parameter to a NULL value. More...
void | BindZeroBlob (int paramIndex, int blobSize)
| Bind parameter to a Zero BLOB value. More...
void | ClearBindings ()
| Clear all parameter bindings. More...
wxString | GetSQL ()
| Get the original SQL string for the prepared statement. More...
void | Reset ()
| Reset the prepared statement. More...
bool | IsReadOnly ()
| Determine whether the statement is read-only. More...
void | Finalize ()
| Finalize the prepared statement. More...
bool | IsOk ()
| Validate associated SQLite database and statement. More...
bool | IsBusy ()
| Determine if a prepared statement has been reset. More...
int | Status (wxSQLite3StatementStatus opCode, bool resetFlag=false)
| Determine internal operation counters of the underlying prepared statement. More...

## Detailed Description

Represents a prepared SQL statement.

## Constructor & Destructor Documentation

wxSQLite3Statement::wxSQLite3Statement | ( |  | ) |

Constructor.

wxSQLite3Statement::wxSQLite3Statement | ( | const wxSQLite3Statement & | statement | ) |

Copy constructor.

wxSQLite3Statement::wxSQLite3Statement | ( | wxSQLite3DatabaseReference * | db,
|  | wxSQLite3StatementReference * | 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

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

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

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

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

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

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

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

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

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

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

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

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

void wxSQLite3Statement::BindNull | ( | int | paramIndex | ) |

Bind parameter to a NULL value.

Parameters

  paramIndex | index 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). 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

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

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

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

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

  paramIndex | index of the parameter. The first parameter has an index of 1.
  blobSize | size 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 | ( |  | ) |

Execute the query represented by this statement.

Returns
  result set instance

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

  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.

wxString wxSQLite3Statement::GetSQL | ( |  | ) |

Get the original SQL string for the prepared statement.

Returns
  the original SQL string used to prepare the statement

bool wxSQLite3Statement::IsBusy | ( |  | ) |

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

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.

int wxSQLite3Statement::Status | ( | wxSQLite3StatementStatus | opCode,
|  | bool | resetFlag = `false`
| ) |  |

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 files:

- wxsqlite3.h
- wxsqlite3.cpp