Query specialization for no results (type void) and parameters of Data::Set type. More...

#include <query.hpp>

Inheritance diagram for ASql::Query< Parameters, void, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, void >:

List of all members.

Public Member Functions
	Query ()
	Query (const Query &x)
Parameters &	createParameters ()
	Create the parameter set for the query object.
const Parameters *	parameters () const
	Returns a const pointer to the parameter set.
void	setParameters (Parameters *parameters)
	Set's the parameter data to point to the passed single row parameter set.
Parameters *	parameters ()
	Returns a pointer to the parameter set.
Parameters *	relinquishParameters ()
	Relinquishes control over the parameter set.
unsigned int	insertId () const
	Returns the insert ID returned from the query or 0 if nothing.
unsigned int	rows () const
	Returns the rows affected/available from the query or 0 if nothing.
bool	busy () const
	Returns true if copies of this query still exist (query is still working in another thread).
Error	error () const
	Return the error object associated with the query.
void	setCallback (boost::function< void()> callback=boost::function< void()>())
	Set the callback function to be called at the end of the query.
bool	isCallback ()
	Return true if a callback is associated with this query.
boost::function< void()>	getCallback ()
	Get the callback function.
void	keepAlive (bool x)
	Set true if you want the query to not be cancelled when the original object is destroyed.
void	cancel ()
	Call this function to cancel the query.
void	enableRows ()
	Call this function to enable the retrieval of a row count (affected/available rows)
void	enableInsertId ()
	Call this function to enable the retrieval of an auto-increment insert ID.
void	reset ()
	Resets the object as though it was destroyed and reconstructed anew.

Static Public Member Functions
static Query &	staticRebuild (QueryPar &x)
	Takes a QueryPar reference and return a statically generated Query reference.
static Query &	dynamicRebuild (QueryPar &x)
	Takes a QueryPar reference and return a dynamically generated Query reference.

Protected Member Functions
void	setResults (void *results)
	Set's the shared data to point to the passed pointer.
void	setParameters (void *parameters)
	Set's the shared data to point to the passed pointer.
void *	relinquishResults ()
	Relinquishes control over the result data.
void *	results ()
	Return a void pointer to the result set.
const void *	results () const
	Return a const void pointer to the result set.

Detailed Description

template<class Parameters>
struct ASql::Query< Parameters, void, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, void >

Query specialization for no results (type void) and parameters of Data::Set type.

Template Parameters:

Parameters Type used to store parameter data. This specialization cover those types derived from Data::Set

Definition at line 637 of file query.hpp.

Constructor & Destructor Documentation

template<class Parameters >

ASql::Query< Parameters, void, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, void >::Query ( )

inline

Definition at line 639 of file query.hpp.

template<class Parameters >

ASql::Query< Parameters, void, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, void >::Query ( const Query< Parameters, void, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, void > & x )

inline

Definition at line 640 of file query.hpp.

Member Function Documentation

bool ASql::QueryPar::busy ( ) const

inlineinherited

Returns true if copies of this query still exist (query is still working in another thread).

Definition at line 263 of file query.hpp.

References ASql::QueryPar::m_sharedData.

void ASql::QueryPar::cancel ( )

inlineinherited

Call this function to cancel the query.

This will cancel the query at the earliest opportunity. Calling a cancel will rollback any changes in the associated transaction.

Definition at line 301 of file query.hpp.

References ASql::QueryPar::m_sharedData.

Referenced by ASql::QueryPar::~QueryPar().

template<class Parameters >

Parameters& ASql::Query< Parameters, void, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, void >::createParameters ( )

inline

Create the parameter set for the query object.

Returns:: A reference to the newly created parameter set.

Definition at line 652 of file query.hpp.

References ASql::QueryPar::parameters(), and ASql::QueryPar::setParameters().

template<class Parameters >

static Query& ASql::Query< Parameters, void, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, void >::dynamicRebuild ( QueryPar & x )

inlinestatic

Takes a QueryPar reference and return a dynamically generated Query reference.

Definition at line 646 of file query.hpp.

void ASql::QueryPar::enableInsertId ( )

inlineinherited

Call this function to enable the retrieval of an auto-increment insert ID.

Definition at line 311 of file query.hpp.

References ASql::QueryPar::m_sharedData.

void ASql::QueryPar::enableRows ( )

inlineinherited

Call this function to enable the retrieval of a row count (affected/available rows)

Definition at line 304 of file query.hpp.

References ASql::QueryPar::m_sharedData.

Error ASql::QueryPar::error ( ) const

inlineinherited

Return the error object associated with the query.

Note this will be a default Error object if there was no error.

Definition at line 269 of file query.hpp.

References ASql::QueryPar::m_sharedData.

boost::function<void()> ASql::QueryPar::getCallback ( )

inlineinherited

Get the callback function.

Definition at line 285 of file query.hpp.

References ASql::QueryPar::m_sharedData.

Referenced by ASql::ConnectionPar< T >::intHandler().

unsigned int ASql::QueryPar::insertId ( ) const

inlineinherited

Returns the insert ID returned from the query or 0 if nothing.

Definition at line 253 of file query.hpp.

References ASql::QueryPar::m_sharedData.

bool ASql::QueryPar::isCallback ( )

inlineinherited

Return true if a callback is associated with this query.

Definition at line 282 of file query.hpp.

References ASql::QueryPar::m_sharedData.

Referenced by ASql::ConnectionPar< T >::intHandler().

void ASql::QueryPar::keepAlive ( bool x )

inlineinherited

Set true if you want the query to not be cancelled when the original object is destroyed.

Note that the default is to cancel and this must be called from the original query object.

Definition at line 294 of file query.hpp.

References ASql::QueryPar::FLAG_KEEPALIVE, and ASql::QueryPar::m_flags.

Referenced by ASql::QueryPar::reset().

template<class Parameters >

const Parameters* ASql::Query< Parameters, void, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, void >::parameters ( ) const

inline

Returns a const pointer to the parameter set.

Reimplemented from ASql::QueryPar.

Definition at line 655 of file query.hpp.

References ASql::QueryPar::parameters().

template<class Parameters >

Parameters* ASql::Query< Parameters, void, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, void >::parameters ( )

inline

Returns a pointer to the parameter set.

Reimplemented from ASql::QueryPar.

Definition at line 667 of file query.hpp.

References ASql::QueryPar::parameters().

template<class Parameters >

Parameters* ASql::Query< Parameters, void, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, void >::relinquishParameters ( )

inline

Relinquishes control over the parameter set.

Calling this will disassociate the query object (and it's copies) from the parameter set but won't delete it. Use this if you are done with your query object but want to keep your parameter set around. The end result in the query object (and it's copies) is to have no parameter set associated with it.

Returns:: Pointer to the disassociated parameter set

Reimplemented from ASql::QueryPar.

Definition at line 679 of file query.hpp.

References ASql::QueryPar::relinquishParameters().

void* ASql::QueryPar::relinquishResults ( )

inlineprotectedinherited

Relinquishes control over the result data.

Calling this will disassociate the query object (and it's copies) from the result data but won't delete it. Use this if you are done with your query object but want to keep your result data around. The end result in the query object (and it's copies) is to have no result data associated with it.

Returns:: Pointer to the disassociated result data

Reimplemented in ASql::Query< void, Results, void, typename boost::enable_if< boost::is_base_of< Data::SetContainer, Results > >::type >, ASql::Query< void, Results, void, typename boost::enable_if< boost::is_base_of< Data::Set, Results > >::type >, ASql::Query< Parameters, Results, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, typename boost::enable_if< boost::is_base_of< Data::SetContainer, Results > >::type >, and ASql::Query< Parameters, Results, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, typename boost::enable_if< boost::is_base_of< Data::Set, Results > >::type >.

Definition at line 195 of file query.hpp.

References ASql::QueryPar::m_sharedData.

Referenced by ASql::Query< Parameters, Results, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, typename boost::enable_if< boost::is_base_of< Data::Set, Results > >::type >::relinquishResults(), ASql::Query< Parameters, Results, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, typename boost::enable_if< boost::is_base_of< Data::SetContainer, Results > >::type >::relinquishResults(), ASql::Query< void, Results, void, typename boost::enable_if< boost::is_base_of< Data::Set, Results > >::type >::relinquishResults(), and ASql::Query< void, Results, void, typename boost::enable_if< boost::is_base_of< Data::SetContainer, Results > >::type >::relinquishResults().

void ASql::QueryPar::reset ( )

inlineinherited

Resets the object as though it was destroyed and reconstructed anew.

Definition at line 318 of file query.hpp.

References ASql::QueryPar::FLAG_ORIGINAL, ASql::QueryPar::keepAlive(), ASql::QueryPar::m_flags, and ASql::QueryPar::m_sharedData.

void* ASql::QueryPar::results ( )

inlineprotectedinherited

Return a void pointer to the result set.

Usually you would keep the original typed pointer around but if you lost it for some reason you can use this and cast it.

Reimplemented in ASql::Query< void, Results, void, typename boost::enable_if< boost::is_base_of< Data::SetContainer, Results > >::type >, ASql::Query< void, Results, void, typename boost::enable_if< boost::is_base_of< Data::Set, Results > >::type >, ASql::Query< Parameters, Results, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, typename boost::enable_if< boost::is_base_of< Data::SetContainer, Results > >::type >, and ASql::Query< Parameters, Results, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, typename boost::enable_if< boost::is_base_of< Data::Set, Results > >::type >.

Definition at line 214 of file query.hpp.

References ASql::QueryPar::m_sharedData.

const void* ASql::QueryPar::results ( ) const

inlineprotectedinherited

Return a const void pointer to the result set.

Usually you would keep the original typed pointer around but if you lost it for some reason you can use this and cast it.

Reimplemented in ASql::Query< void, Results, void, typename boost::enable_if< boost::is_base_of< Data::SetContainer, Results > >::type >, ASql::Query< void, Results, void, typename boost::enable_if< boost::is_base_of< Data::Set, Results > >::type >, ASql::Query< Parameters, Results, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, typename boost::enable_if< boost::is_base_of< Data::SetContainer, Results > >::type >, and ASql::Query< Parameters, Results, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, typename boost::enable_if< boost::is_base_of< Data::Set, Results > >::type >.

Definition at line 221 of file query.hpp.

References ASql::QueryPar::m_sharedData.

unsigned int ASql::QueryPar::rows ( ) const

inlineinherited

Returns the rows affected/available from the query or 0 if nothing.

Note that if using for the number of rows from a query this will represent the number of rows available before a LIMIT.

Definition at line 260 of file query.hpp.

References ASql::QueryPar::m_sharedData.

void ASql::QueryPar::setCallback ( boost::function< void()> callback = boost::function<void()>() )

inlineinherited

Set the callback function to be called at the end of the query.

Note that this will be called even if there is an error or the query can cancelled.

Definition at line 275 of file query.hpp.

References ASql::QueryPar::callback(), and ASql::QueryPar::m_sharedData.

Referenced by ASql::ConnectionPar< T >::intHandler().

void ASql::QueryPar::setParameters ( void * parameters )

inlineprotectedinherited

Set's the shared data to point to the passed pointer.

Note that the QueryPar class assumes responsibility for destroying the parameter set unless explicitly released with relinquishParameters().

Parameters:

[in] parameters A pointer to the parameter data

Definition at line 183 of file query.hpp.

References ASql::QueryPar::m_sharedData, and ASql::QueryPar::parameters().

template<class Parameters >

void ASql::Query< Parameters, void, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, void >::setParameters ( Parameters * parameters )

inline

Set's the parameter data to point to the passed single row parameter set.

Note that the Query object assumes responsibility for destroying the parameter set unless explicitly released with relinquishParameters().

Parameters:

[in] parameters A pointer to the parameter data set

Definition at line 664 of file query.hpp.

References ASql::QueryPar::setParameters().

void ASql::QueryPar::setResults ( void * results )

inlineprotectedinherited

Set's the shared data to point to the passed pointer.

Note that the QueryPar class assumes responsibility for destroying the result set unless explicitly released with relinquishResults().

Parameters:

[out] results A pointer to the result data

Definition at line 174 of file query.hpp.

References ASql::QueryPar::m_sharedData, and ASql::QueryPar::results().

template<class Parameters >

static Query& ASql::Query< Parameters, void, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, void >::staticRebuild ( QueryPar & x )

inlinestatic

Takes a QueryPar reference and return a statically generated Query reference.

Definition at line 643 of file query.hpp.

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

query.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

template<class Parameters> struct ASql::Query< Parameters, void, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, void >

Constructor & Destructor Documentation

Member Function Documentation

template<class Parameters>
struct ASql::Query< Parameters, void, typename boost::enable_if< boost::is_base_of< Data::Set, Parameters > >::type, void >