pqxx::result Class Reference

Query or command result set. More...

#include <result.hxx>

Inheritance diagram for pqxx::result:

List of all members.

Public Types
typedef unsigned long	size_type
typedef signed long	difference_type
typedef tuple	reference
typedef const_iterator	pointer
typedef PGSTD::iterator< PGSTD::random_access_iterator_tag, const tuple, result::difference_type, const_iterator, tuple >	const_iterator_base
Public Member Functions
	result () throw ()
	result (const result &rhs) throw ()
result &	operator= (const result &rhs) throw ()
bool	operator== (const result &) const throw ()
bool	operator!= (const result &rhs) const throw ()
const_reverse_iterator	rbegin () const
const_reverse_iterator	rend () const
const_iterator	begin () const throw ()
const_iterator	end () const throw ()
reference	front () const throw ()
reference	back () const throw ()
size_type	size () const throw ()
bool	empty () const
size_type	capacity () const throw ()
void	swap (result &) throw ()
const tuple	operator[] (size_type i) const throw ()
const tuple	at (size_type) const throw (PGSTD::out_of_range)
tuple::size_type	columns () const throw ()
	Number of columns in result.
tuple::size_type	column_number (const char ColName[]) const
	Number of given column (throws exception if it doesn't exist).
tuple::size_type	column_number (const PGSTD::string &Name) const
	Number of given column (throws exception if it doesn't exist).
const char *	column_name (tuple::size_type Number) const
	Name of column with this number (throws exception if it doesn't exist).
oid	column_type (tuple::size_type ColNum) const
	Type of given column.
oid	column_type (int ColNum) const
	Type of given column.
oid	column_type (const PGSTD::string &ColName) const
	Type of given column.
oid	column_type (const char ColName[]) const
	Type of given column.
oid	inserted_oid () const
	If command was INSERT of 1 row, return oid of inserted row.
size_type	affected_rows () const
	If command was INSERT, UPDATE, or DELETE, return number of affected rows.
void	clear () throw ()
Friends
class	pqxx::result::field
class	connection_base
class	pipeline
class	Cursor

---

Detailed Description

Query or command result set.

This behaves as a container (as defined by the C++ standard library) and provides random access const iterators to iterate over its tuples. A tuple can also be accessed by indexing a result R by the tuple's zero-based number:

for (result::size_type i=0; i < R.size(); ++i) Process(R[i]);

---

Member Typedef Documentation

typedef PGSTD::iterator<PGSTD::random_access_iterator_tag, const tuple, result::difference_type, const_iterator, tuple> pqxx::result::const_iterator_base

typedef signed long pqxx::result::difference_type

typedef const_iterator pqxx::result::pointer

typedef tuple pqxx::result::reference

typedef unsigned long pqxx::result::size_type

---

Constructor & Destructor Documentation

pqxx::result::result (   )  throw ()

pqxx::result::result (  const result &  rhs  )  throw ()

---

Member Function Documentation

pqxx::result::size_type pqxx::result::affected_rows (   )  const

If command was INSERT, UPDATE, or DELETE, return number of affected rows. Returns: Number of affected rows if last command was INSERT, UPDATE, or DELETE; zero for all other commands.

const pqxx::result::tuple pqxx::result::at (  size_type   )  const throw (PGSTD::out_of_range)

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

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

size_type pqxx::result::capacity (   )  const throw ()

void pqxx::internal::PQAlloc< internal::pq::PGresult >::clear (   )  throw ()

const char * pqxx::result::column_name (  tuple::size_type  Number  )  const

Name of column with this number (throws exception if it doesn't exist).

tuple::size_type pqxx::result::column_number (  const PGSTD::string &  Name  )  const

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

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

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

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

Type of given column.

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

Type of given column.

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

Type of given column.

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

Type of given column.

tuple::size_type pqxx::result::columns (   )  const throw ()

Number of columns in result.

bool pqxx::result::empty (   )  const

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

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

oid pqxx::result::inserted_oid (   )  const

If command was INSERT of 1 row, return oid of inserted row. Returns: Identifier of inserted row if exactly one row was inserted, or oid_none otherwise.

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

result& pqxx::result::operator= (  const result &  rhs  )  throw ()

bool pqxx::result::operator== (  const result &   )  const throw ()

const tuple pqxx::result::operator[] (  size_type  i  )  const throw ()

const_reverse_iterator pqxx::result::rbegin (   )  const

const_reverse_iterator pqxx::result::rend (   )  const

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

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

---

Friends And Related Function Documentation

friend class connection_base [friend]

friend class Cursor [friend]

friend class pipeline [friend]

friend class pqxx::result::field [friend]

---

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

• result.hxx
• result.cxx

---