A class that implements a prepared query for PostgreSQL data access driver. More...

#include <PreparedQuery.h>

Inheritance diagram for te::pgis::PreparedQuery:

Public Member Functions
void	bind (int i, char value)
	Binds the i-th parameter of the query to a value. More...

void	bind (int i, unsigned char value)
	Binds the i-th parameter of the query to a value. More...

void	bind (int i, boost::int16_t value)
	Binds the i-th parameter of the query to a value. More...

void	bind (int i, boost::int32_t value)
	Binds the i-th parameter of the query to a value. More...

void	bind (int i, boost::int64_t value)
	Binds the i-th parameter of the query to a value. More...

void	bind (int i, bool value)
	Binds the i-th parameter of the query to a value. More...

void	bind (int i, float value)
	Binds the i-th parameter of the query to a value. More...

void	bind (int i, double value)
	Binds the i-th parameter of the query to a value. More...

void	bind (int i, const std::string &value)
	Binds the i-th parameter of the query to a value. More...

void	bind (int i, const te::dt::ByteArray &value)
	Binds the i-th parameter of the query to a value. More...

void	bind (int i, const te::gm::Geometry &value)
	Binds the i-th parameter of the query to a value. More...

void	bind (int i, const te::rst::Raster &value)
	Binds the i-th parameter of the query to a value. More...

void	bind (int i, const te::dt::DateTime &value)
	Binds the i-th parameter of the query to a value. More...

void	bind (int i, const te::da::DataSet &value)
	Binds the i-th parameter of the query to a value. More...

void	bind (int i, const te::dt::AbstractData &ad)
	Binds the i-th parameter of the query to a value. More...

void	bind (const std::vector< std::size_t > &propertiesPos, std::size_t offset, te::da::DataSet *d)

void	bind (const std::vector< std::size_t > &propertiesPos, te::da::DataSet *d)

void	bind (te::da::DataSet *d)

void	bindNumeric (int i, const std::string &value)
	Binds the i-th parameter of the query to a value. More...

void	clear ()

void	execute ()

std::string	getName () const
	It returns the prepared query name. More...

te::da::DataSourceTransactor *	getTransactor () const
	It returns a pointer to the underlying data source transactor. More...

void	prepare (const te::da::Query &query, const std::vector< te::dt::Property *> &paramTypes)
	It prepares the query that may be used for commands that are used mutiple times (select, insert, update and delete). More...

void	prepare (const std::string &query, const std::vector< te::dt::Property *> &paramTypes)
	It prepares the query using native dialect. More...

void	prepare (const std::string &query, const std::vector< int > &paramTypes)

	PreparedQuery (Transactor *t, const std::string &pqname)

te::da::DataSet *	query (te::common::TraverseType travType=te::common::FORWARDONLY, te::common::AccessPolicy rwRole=te::common::RAccess)

	~PreparedQuery ()
	Virtual destructor. More...

Private Attributes
std::size_t	m_nparams

int *	m_paramFormats

int *	m_paramLengths

char **	m_paramValues

std::string	m_qname

PGresult *	m_result

Transactor *	m_t

Detailed Description

A class that implements a prepared query for PostgreSQL data access driver.

Note

Some general notes:

bind doesn't need to set length for fixed-size types.

Review pending bind methods (raster, date, array, ...).

We need a numeric type by tomorrow!

Definition at line 68 of file PreparedQuery.h.

Constructor & Destructor Documentation

◆ PreparedQuery()

te::pgis::PreparedQuery::PreparedQuery	(	Transactor *	t,
		const std::string &	pqname
	)

◆ ~PreparedQuery()

te::pgis::PreparedQuery::~PreparedQuery ( )

virtual

Virtual destructor.

Reimplemented from te::da::PreparedQuery.

Member Function Documentation

◆ bind() [1/18]

void te::pgis::PreparedQuery::bind	(	int	i,
		char	value
	)

virtual

Binds the i-th parameter of the query to a value.

Parameters

i	The parameter index.
value	The parameter value.

Implements te::da::PreparedQuery.

◆ bind() [2/18]

void te::pgis::PreparedQuery::bind	(	int	i,
		unsigned char	value
	)

virtual

Binds the i-th parameter of the query to a value.

Parameters

i	The parameter index.
value	The parameter value.

Implements te::da::PreparedQuery.

◆ bind() [3/18]

void te::pgis::PreparedQuery::bind	(	int	i,
		boost::int16_t	value
	)

virtual

Binds the i-th parameter of the query to a value.

Parameters

i	The parameter index.
value	The parameter value.

Implements te::da::PreparedQuery.

◆ bind() [4/18]

void te::pgis::PreparedQuery::bind	(	int	i,
		boost::int32_t	value
	)

virtual

Binds the i-th parameter of the query to a value.

Parameters

i	The parameter index.
value	The parameter value.

Implements te::da::PreparedQuery.

◆ bind() [5/18]

void te::pgis::PreparedQuery::bind	(	int	i,
		boost::int64_t	value
	)

virtual

Binds the i-th parameter of the query to a value.

Parameters

i	The parameter index.
value	The parameter value.

Implements te::da::PreparedQuery.

◆ bind() [6/18]

void te::pgis::PreparedQuery::bind	(	int	i,
		bool	value
	)

virtual

Binds the i-th parameter of the query to a value.

Parameters

i	The parameter index.
value	The parameter value.

Implements te::da::PreparedQuery.

◆ bind() [7/18]

void te::pgis::PreparedQuery::bind	(	int	i,
		float	value
	)

virtual

Binds the i-th parameter of the query to a value.

Parameters

i	The parameter index.
value	The parameter value.

Implements te::da::PreparedQuery.

◆ bind() [8/18]

void te::pgis::PreparedQuery::bind	(	int	i,
		double	value
	)

virtual

Binds the i-th parameter of the query to a value.

Parameters

i	The parameter index.
value	The parameter value.

Implements te::da::PreparedQuery.

◆ bind() [9/18]

void te::pgis::PreparedQuery::bind	(	int	i,
		const std::string &	value
	)

virtual

Binds the i-th parameter of the query to a value.

Parameters

i	The parameter index.
value	The parameter value.

Implements te::da::PreparedQuery.

◆ bind() [10/18]

void te::pgis::PreparedQuery::bind	(	int	i,
		const te::dt::ByteArray &	value
	)

virtual

Binds the i-th parameter of the query to a value.

Parameters

i	The parameter index.
value	The parameter value.

Implements te::da::PreparedQuery.

◆ bind() [11/18]

void te::pgis::PreparedQuery::bind	(	int	i,
		const te::gm::Geometry &	value
	)

virtual

Binds the i-th parameter of the query to a value.

Parameters

i	The parameter index.
value	The parameter value.

Implements te::da::PreparedQuery.

◆ bind() [12/18]

void te::pgis::PreparedQuery::bind	(	int	i,
		const te::rst::Raster &	value
	)

virtual

Binds the i-th parameter of the query to a value.

Parameters

i	The parameter index.
value	The parameter value.

Implements te::da::PreparedQuery.

◆ bind() [13/18]

void te::pgis::PreparedQuery::bind	(	int	i,
		const te::dt::DateTime &	value
	)

virtual

Binds the i-th parameter of the query to a value.

Parameters

i	The parameter index.
value	The parameter value.

Implements te::da::PreparedQuery.

◆ bind() [14/18]

void te::pgis::PreparedQuery::bind	(	int	i,
		const te::da::DataSet &	value
	)

virtual

Binds the i-th parameter of the query to a value.

Parameters

i	The parameter index.
value	The parameter value.

Implements te::da::PreparedQuery.

◆ bind() [15/18]

void te::pgis::PreparedQuery::bind	(	int	i,
		const te::dt::AbstractData &	ad
	)

virtual

Binds the i-th parameter of the query to a value.

Parameters

i	The parameter index.
value	The parameter value.

Reimplemented from te::da::PreparedQuery.

◆ bind() [16/18]

void te::pgis::PreparedQuery::bind	(	const std::vector< std::size_t > &	propertiesPos,
		std::size_t	offset,
		te::da::DataSet *	d
	)

Note: PostgeSQL driver extended method.

◆ bind() [17/18]

void te::pgis::PreparedQuery::bind	(	const std::vector< std::size_t > &	propertiesPos,
		te::da::DataSet *	d
	)

Note: PostgeSQL driver extended method.

◆ bind() [18/18]

void te::pgis::PreparedQuery::bind ( te::da::DataSet * d )

Note: PostgeSQL driver extended method.

◆ bindNumeric()

void te::pgis::PreparedQuery::bindNumeric	(	int	i,
		const std::string &	value
	)

virtual

Binds the i-th parameter of the query to a value.

Parameters

i	The parameter index.
value	The parameter value.

Implements te::da::PreparedQuery.

◆ clear()

void te::pgis::PreparedQuery::clear ( )

Note: PostgeSQL driver extended method.

◆ execute()

void te::pgis::PreparedQuery::execute ( )

virtual

Implements te::da::PreparedQuery.

◆ getName()

std::string te::pgis::PreparedQuery::getName ( ) const

virtual

It returns the prepared query name.

Parameters

return The prepared query name.

Implements te::da::PreparedQuery.

◆ getTransactor()

te::da::DataSourceTransactor* te::pgis::PreparedQuery::getTransactor ( ) const

virtual

It returns a pointer to the underlying data source transactor.

Returns: A pointer to the underlying data source transactor.

Implements te::da::PreparedQuery.

◆ prepare() [1/3]

void te::pgis::PreparedQuery::prepare	(	const te::da::Query &	query,
		const std::vector< te::dt::Property *> &	paramTypes
	)

virtual

It prepares the query that may be used for commands that are used mutiple times (select, insert, update and delete).

This command will submit a request to create a prepared query with the given parameters.

Parameters

query	The query to be prepared.
paramTypes	The list of parameters data type.

Exceptions

Exception It throws an exception if the prepared query can not be created. For example if another prepared query with the same name already exists, this may throws an exception.

Implements te::da::PreparedQuery.

◆ prepare() [2/3]

void te::pgis::PreparedQuery::prepare	(	const std::string &	query,
		const std::vector< te::dt::Property *> &	paramTypes
	)

virtual

It prepares the query using native dialect.

This command may be used for commands that are used mutiple times (select, insert, update and delete).

This command will submit a request to create a prepared query with the given parameters.

Parameters

query	The query to be prepared.
paramTypes	The list of parameters data type.

Exceptions

Exception It throws an exception if the prepared query can not be created. For example if another prepared query with the same name already exists, this may throws an exception.

Implements te::da::PreparedQuery.

◆ prepare() [3/3]

void te::pgis::PreparedQuery::prepare	(	const std::string &	query,
		const std::vector< int > &	paramTypes
	)

Note: PostgeSQL driver extended method.

◆ query()

te::da::DataSet* te::pgis::PreparedQuery::query	(	te::common::TraverseType	travType = `te::common::FORWARDONLY`,
		te::common::AccessPolicy	rwRole = `te::common::RAccess`
	)

virtual

Implements te::da::PreparedQuery.

Member Data Documentation

◆ m_nparams

std::size_t te::pgis::PreparedQuery::m_nparams

private

Definition at line 153 of file PreparedQuery.h.

◆ m_paramFormats

int* te::pgis::PreparedQuery::m_paramFormats

private

Definition at line 152 of file PreparedQuery.h.

◆ m_paramLengths

int* te::pgis::PreparedQuery::m_paramLengths

private

Definition at line 151 of file PreparedQuery.h.

◆ m_paramValues

char** te::pgis::PreparedQuery::m_paramValues

private

Definition at line 150 of file PreparedQuery.h.

◆ m_qname

std::string te::pgis::PreparedQuery::m_qname

private

Definition at line 154 of file PreparedQuery.h.

◆ m_result

PGresult* te::pgis::PreparedQuery::m_result

private

Definition at line 149 of file PreparedQuery.h.

◆ m_t

Transactor* te::pgis::PreparedQuery::m_t

private

Definition at line 148 of file PreparedQuery.h.

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

/home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/postgis/PreparedQuery.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PreparedQuery()

◆ ~PreparedQuery()

Member Function Documentation

◆ bind() [1/18]

◆ bind() [2/18]

◆ bind() [3/18]

◆ bind() [4/18]

◆ bind() [5/18]

◆ bind() [6/18]

◆ bind() [7/18]

◆ bind() [8/18]

◆ bind() [9/18]

◆ bind() [10/18]

◆ bind() [11/18]

◆ bind() [12/18]

◆ bind() [13/18]

◆ bind() [14/18]

◆ bind() [15/18]

◆ bind() [16/18]

◆ bind() [17/18]

◆ bind() [18/18]

◆ bindNumeric()

◆ clear()

◆ execute()

◆ getName()

◆ getTransactor()

◆ prepare() [1/3]

◆ prepare() [2/3]

◆ prepare() [3/3]

◆ query()

Member Data Documentation

◆ m_nparams

◆ m_paramFormats

◆ m_paramLengths

◆ m_paramValues

◆ m_qname

◆ m_result

◆ m_t