Reference to one row in a result. More...

#include <tuple.hxx>

Inheritance diagram for pqxx::tuple:

Collaboration diagram for pqxx::tuple:

Public Types
typedef const_tuple_iterator	const_iterator

typedef const_reverse_tuple_iterator	const_reverse_iterator

typedef tuple_difference_type	difference_type

typedef const_iterator	iterator

typedef const_tuple_iterator	pointer

typedef field	reference

typedef const_reverse_iterator	reverse_iterator

typedef tuple_size_type	size_type

Public Member Functions
	tuple (const result *r, size_t i) throw ()

	~tuple () throw ()

const_iterator	begin () const throw ()

bool PQXX_PURE	empty () const throw ()

const_iterator	end () const throw ()

size_t	num () const

size_t	rownumber () const throw ()

size_type	size () const throw ()

tuple	slice (size_type Begin, size_type End) const
	Produce a slice of this tuple, containing the given range of columns. More...

void	swap (tuple &) throw ()

Comparison
bool PQXX_PURE	operator== (const tuple &) const throw ()

bool	operator!= (const tuple &rhs) const throw ()

Field access
reference	front () const throw ()

reference	back () const throw ()

const_reverse_tuple_iterator	rbegin () const

const_reverse_tuple_iterator	rend () const

reference	operator[] (size_type) const throw ()

reference	operator[] (int) const throw ()

reference	operator[] (const char[]) const

reference	operator[] (const PGSTD::string &) const

reference	at (size_type) const throw (range_error)

reference	at (int) const throw (range_error)

reference	at (const char[]) const

reference	at (const PGSTD::string &) const

Column information
size_type	column_number (const PGSTD::string &ColName) const
	Number of given column (throws exception if it doesn't exist) More...

size_type	column_number (const char[]) const
	Number of given column (throws exception if it doesn't exist) More...

oid	column_type (size_type) const
	Type of given column. More...

oid	column_type (int ColNum) const
	Type of given column. More...

oid	column_type (const PGSTD::string &ColName) const
	Type of given column. More...

oid	column_type (const char ColName[]) const
	Type of given column. More...

oid	column_table (size_type ColNum) const
	What table did this column come from? More...

oid	column_table (int ColNum) const
	What table did this column come from? More...

oid	column_table (const PGSTD::string &ColName) const
	What table did this column come from? More...

size_type	table_column (size_type) const
	What column number in its table did this result column come from? More...

size_type	table_column (int ColNum) const
	What column number in its table did this result column come from? More...

size_type	table_column (const PGSTD::string &ColName) const
	What column number in its table did this result column come from? More...

Protected Attributes
size_type	m_Begin

size_type	m_End

const result *	m_Home

size_t	m_Index

Private Member Functions
	tuple ()

Friends
class	field

Detailed Description

Reference to one row in a result.

A tuple represents one row (also called a tuple) in a query result set. It also acts as a container mapping column numbers or names to field values (see below):

cout << tuple["date"].c_str() << ": " << tuple["name"].c_str() << endl;

The tuple itself acts like a (non-modifyable) container, complete with its own const_iterator and const_reverse_iterator.

Member Typedef Documentation

typedef const_tuple_iterator pqxx::tuple::const_iterator

typedef const_reverse_tuple_iterator pqxx::tuple::const_reverse_iterator

typedef tuple_difference_type pqxx::tuple::difference_type

typedef const_iterator pqxx::tuple::iterator

typedef const_tuple_iterator pqxx::tuple::pointer

typedef field pqxx::tuple::reference

typedef const_reverse_iterator pqxx::tuple::reverse_iterator

typedef tuple_size_type pqxx::tuple::size_type

Constructor & Destructor Documentation

pqxx::tuple::tuple	(	const result *	r,
		size_t	i
	)		throw ()

Deprecated:: Do not use this constructor. It will become private.

pqxx::tuple::~tuple ( ) throw ()

inline

pqxx::tuple::tuple ( )

private

Member Function Documentation

reference pqxx::tuple::at ( size_type ) const throw (range_error)

reference pqxx::tuple::at ( int ) const throw (range_error)

reference pqxx::tuple::at ( const char [] ) const

reference pqxx::tuple::at ( const PGSTD::string & ) const

reference pqxx::tuple::back ( ) const throw ()

const_iterator pqxx::tuple::begin ( ) const throw ()

size_type pqxx::tuple::column_number ( const PGSTD::string & ColName ) const

inline

Number of given column (throws exception if it doesn't exist)

References column_number().

Referenced by column_number().

Here is the call graph for this function:

Here is the caller graph for this function:

size_type pqxx::tuple::column_number ( const char [] ) const

Number of given column (throws exception if it doesn't exist)

oid pqxx::tuple::column_table ( size_type ColNum ) const

What table did this column come from?

oid pqxx::tuple::column_table ( int ColNum ) const

inline

What table did this column come from?

References column_table().

Referenced by column_table().

Here is the call graph for this function:

Here is the caller graph for this function:

oid pqxx::tuple::column_table ( const PGSTD::string & ColName ) const

inline

What table did this column come from?

References column_table().

Referenced by column_table().

Here is the call graph for this function:

Here is the caller graph for this function:

oid pqxx::tuple::column_type ( size_type ) const

Type of given column.

oid pqxx::tuple::column_type ( int ColNum ) const

inline

Type of given column.

References column_type().

Referenced by column_type().

Here is the call graph for this function:

Here is the caller graph for this function:

oid pqxx::tuple::column_type ( const PGSTD::string & ColName ) const

inline

Type of given column.

References column_type().

Referenced by column_type().

Here is the call graph for this function:

Here is the caller graph for this function:

oid pqxx::tuple::column_type ( const char ColName[] ) const

inline

Type of given column.

References column_type().

Referenced by column_type().

Here is the call graph for this function:

Here is the caller graph for this function:

bool PQXX_PURE pqxx::tuple::empty ( ) const throw ()

const_iterator pqxx::tuple::end ( ) const throw ()

reference pqxx::tuple::front ( ) const throw ()

size_t pqxx::tuple::num ( ) const

inline

Referenced by pqxx::const_result_iterator::operator-().

Here is the caller graph for this function:

bool pqxx::tuple::operator!= ( const tuple & rhs ) const throw ()

inline

bool PQXX_PURE pqxx::tuple::operator== ( const tuple & ) const throw ()

reference pqxx::tuple::operator[] ( size_type ) const throw ()

reference pqxx::tuple::operator[] ( int ) const throw ()

reference pqxx::tuple::operator[] ( const char [] ) const

reference pqxx::tuple::operator[] ( const PGSTD::string & ) const

const_reverse_tuple_iterator pqxx::tuple::rbegin ( ) const

const_reverse_tuple_iterator pqxx::tuple::rend ( ) const

size_t pqxx::tuple::rownumber ( ) const throw ()

inline

size_type pqxx::tuple::size ( ) const throw ()

inline

tuple pqxx::tuple::slice	(	size_type	Begin,
		size_type	End
	)		const

Produce a slice of this tuple, containing the given range of columns.

The slice runs from the range's starting column to the range's end column, exclusive. It looks just like a normal result tuple, except slices can be empty.

Warning: Slicing is a relatively new feature, and not all software may be prepared to deal with empty slices. If there is any chance that your program might be creating empty slices and passing them to code that may not be designed with the possibility of empty tuples in mind, be sure to test for that case.

void pqxx::tuple::swap ( tuple & ) throw ()

size_type pqxx::tuple::table_column ( size_type ) const

What column number in its table did this result column come from?

A meaningful answer can be given only if the column in question comes directly from a column in a table. If the column is computed in any other way, a logic_error will be thrown.

Parameters

ColNum a zero-based column number in this result set

Returns: a zero-based column number in originating table

Requires libpq from PostgreSQL 7.4 or better, as well as a server version of at least 7.4.

size_type pqxx::tuple::table_column ( int ColNum ) const

inline

What column number in its table did this result column come from?

References table_column().

Referenced by table_column().

Here is the call graph for this function:

Here is the caller graph for this function:

size_type pqxx::tuple::table_column ( const PGSTD::string & ColName ) const

inline

What column number in its table did this result column come from?

References table_column().

Referenced by table_column().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class field

friend

Member Data Documentation

size_type pqxx::tuple::m_Begin

protected

size_type pqxx::tuple::m_End

protected

const result* pqxx::tuple::m_Home

protected

size_t pqxx::tuple::m_Index

protected

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

/usr/include/pqxx/tuple.hxx

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation