Wt  3.3.2
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | List of all members
Wt::Dbo::SqlStatement Class Referenceabstract

Abstract base class for a prepared SQL statement. More...

Inheritance diagram for Wt::Dbo::SqlStatement:
Inheritance graph
[legend]

Public Member Functions

virtual ~SqlStatement ()
 Destructor.
 
bool use ()
 Uses the statement. More...
 
void done ()
 Finish statement use. More...
 
virtual void reset ()=0
 Resets the statement.
 
virtual void bind (int column, const std::string &value)=0
 Binds a value to a column.
 
virtual void bind (int column, short value)=0
 Binds a value to a column.
 
virtual void bind (int column, int value)=0
 Binds a value to a column.
 
virtual void bind (int column, long long value)=0
 Binds a value to a column.
 
virtual void bind (int column, float value)=0
 Binds a value to a column.
 
virtual void bind (int column, double value)=0
 Binds a value to a column.
 
virtual void bind (int column, const boost::posix_time::ptime &value, SqlDateTimeType type)=0
 Binds a value to a column.
 
virtual void bind (int column, const boost::posix_time::time_duration &value)=0
 Binds a value to a column.
 
virtual void bind (int column, const std::vector< unsigned char > &value)=0
 Binds a value to a column.
 
virtual void bindNull (int column)=0
 Binds null to a column.
 
virtual void execute ()=0
 Executes the statement.
 
virtual long long insertedId ()=0
 Returns the id if the statement was an SQL insert.
 
virtual int affectedRowCount ()=0
 Returns the affected number of rows. More...
 
virtual bool nextRow ()=0
 Fetches the next result row. More...
 
virtual bool getResult (int column, std::string *value, int size)=0
 Fetches a result value. More...
 
virtual bool getResult (int column, short *value)=0
 Fetches a result value. More...
 
virtual bool getResult (int column, int *value)=0
 Fetches a result value. More...
 
virtual bool getResult (int column, long long *value)=0
 Fetches a result value. More...
 
virtual bool getResult (int column, float *value)=0
 Fetches a result value. More...
 
virtual bool getResult (int column, double *value)=0
 Fetches a result value. More...
 
virtual bool getResult (int column, boost::posix_time::ptime *value, SqlDateTimeType type)=0
 Fetches a result value. More...
 
virtual bool getResult (int column, boost::posix_time::time_duration *value)=0
 Fetches a result value. More...
 
virtual bool getResult (int column, std::vector< unsigned char > *value, int size)=0
 Fetches a result value. More...
 
virtual std::string sql () const =0
 Returns the prepared SQL string.
 

Detailed Description

Abstract base class for a prepared SQL statement.

The statement may be used multiple times, but cannot be used concurrently. It also cannot be copied.

This class is part of Wt::Dbo's backend API, and should not be used directly. Its interface must be reimplemented for each backend corresponding to a supported database.

See Also
SqlConnection

Member Function Documentation

virtual int Wt::Dbo::SqlStatement::affectedRowCount ( )
pure virtual

Returns the affected number of rows.

This is only useful for an SQL update or delete statement.

Implemented in Wt::Dbo::backend::MySQLStatement.

void Wt::Dbo::SqlStatement::done ( )

Finish statement use.

Marks the statement as no longer used and resets the statement.

See Also
use()
virtual bool Wt::Dbo::SqlStatement::getResult ( int  column,
std::string *  value,
int  size 
)
pure virtual

Fetches a result value.

Returns true when the value was not null.

Implemented in Wt::Dbo::backend::MySQLStatement.

virtual bool Wt::Dbo::SqlStatement::getResult ( int  column,
short *  value 
)
pure virtual

Fetches a result value.

Returns true when the value was not null.

Implemented in Wt::Dbo::backend::MySQLStatement.

virtual bool Wt::Dbo::SqlStatement::getResult ( int  column,
int *  value 
)
pure virtual

Fetches a result value.

Returns true when the value was not null.

Implemented in Wt::Dbo::backend::MySQLStatement.

virtual bool Wt::Dbo::SqlStatement::getResult ( int  column,
long long *  value 
)
pure virtual

Fetches a result value.

Returns true when the value was not null.

Implemented in Wt::Dbo::backend::MySQLStatement.

virtual bool Wt::Dbo::SqlStatement::getResult ( int  column,
float *  value 
)
pure virtual

Fetches a result value.

Returns true when the value was not null.

Implemented in Wt::Dbo::backend::MySQLStatement.

virtual bool Wt::Dbo::SqlStatement::getResult ( int  column,
double *  value 
)
pure virtual

Fetches a result value.

Returns true when the value was not null.

Implemented in Wt::Dbo::backend::MySQLStatement.

virtual bool Wt::Dbo::SqlStatement::getResult ( int  column,
boost::posix_time::ptime *  value,
SqlDateTimeType  type 
)
pure virtual

Fetches a result value.

Returns true when the value was not null.

Implemented in Wt::Dbo::backend::MySQLStatement.

virtual bool Wt::Dbo::SqlStatement::getResult ( int  column,
boost::posix_time::time_duration *  value 
)
pure virtual

Fetches a result value.

Returns true when the value was not null.

Implemented in Wt::Dbo::backend::MySQLStatement.

virtual bool Wt::Dbo::SqlStatement::getResult ( int  column,
std::vector< unsigned char > *  value,
int  size 
)
pure virtual

Fetches a result value.

Returns true when the value was not null.

Implemented in Wt::Dbo::backend::MySQLStatement.

virtual bool Wt::Dbo::SqlStatement::nextRow ( )
pure virtual

Fetches the next result row.

Returns true if there was one more row to be fetched.

Implemented in Wt::Dbo::backend::MySQLStatement.

bool Wt::Dbo::SqlStatement::use ( )

Uses the statement.

Marks the statement as in-use. If the statement is already in use, return false. In that case, we will later provision that a statement can be cloned and that a list of equivalent statement is kept in the statement cache of a connectin.


Generated on Wed Mar 12 2014 for the C++ Web Toolkit (Wt) by doxygen 1.8.4