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

Inheritance diagram for Wt::Dbo::SqlStatement:

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. The size is the expected size of sql string type and can be used to dimension buffers but the return string may be bigger.

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

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

pure virtual

Fetches a result value.