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

#include <row.hxx>

Inheritance diagram for pqxx::row:

Public Types
using	size_type = row_size_type

using	difference_type = row_difference_type

using	const_iterator = const_row_iterator

using	iterator = const_iterator

using	reference = field

using	pointer = const_row_iterator

using	const_reverse_iterator = const_reverse_row_iterator

using	reverse_iterator = const_reverse_iterator

Public Member Functions
	row ()=default

	row (result r, size_t i) noexcept

	~row () noexcept=default

const_iterator	begin () const noexcept

const_iterator	cbegin () const noexcept

const_iterator	end () const noexcept

const_iterator	cend () const noexcept

size_type	size () const noexcept

void	swap (row &) noexcept

size_t	rownumber () const noexcept
	Row number, assuming this is a real row and not end()/rend(). More...

size_t	num () const

row	slice (size_type Begin, size_type End) const

PQXX_PURE bool	empty () const noexcept

Comparison
PQXX_PURE bool	operator== (const row &) const noexcept

bool	operator!= (const row &rhs) const noexcept

Field access
reference	front () const noexcept

reference	back () const noexcept

const_reverse_row_iterator	rbegin () const

const_reverse_row_iterator	crbegin () const

const_reverse_row_iterator	rend () const

const_reverse_row_iterator	crend () const

reference	operator[] (size_type) const noexcept

reference	operator[] (int) const noexcept

reference	operator[] (const char[]) const

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

reference	at (size_type) const

reference	at (int) const

reference	at (const char[]) const

reference	at (const std::string &) const

Column information
size_type	column_number (const std::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 std::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 std::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 std::string &ColName) const
	What column number in its table did this result column come from? More...

Protected Attributes
result	m_result
	Result set of which this is one row. More...

long	m_index = 0
	Row number. More...

size_type	m_begin = 0
	First column in slice. This row ignores lower-numbered columns. More...

size_type	m_end = 0
	End column in slice. This row only sees lower-numbered columns. More...

Friends
class	field

Detailed Description

Reference to one row in a result.

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

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

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

Member Typedef Documentation

◆ const_iterator

using pqxx::row::const_iterator = const_row_iterator

◆ const_reverse_iterator

using pqxx::row::const_reverse_iterator = const_reverse_row_iterator

◆ difference_type

using pqxx::row::difference_type = row_difference_type

◆ iterator

using pqxx::row::iterator = const_iterator

◆ pointer

using pqxx::row::pointer = const_row_iterator

◆ reference

using pqxx::row::reference = field

◆ reverse_iterator

using pqxx::row::reverse_iterator = const_reverse_iterator

◆ size_type

using pqxx::row::size_type = row_size_type

Constructor & Destructor Documentation

◆ row() [1/2]

pqxx::row::row ( )

default

◆ row() [2/2]

pqxx::row::row	(	result	r,
		size_t	i
	)

noexcept

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

Implementation of the pqxx::result class and support classes.

pqxx::result represents the set of result rows from a database query.

See COPYING for copyright license. If you did not receive a file called COPYING with this source code, please notify the distributor of this mistake, or contact the author.

◆ ~row()

pqxx::row::~row ( )

defaultnoexcept

Member Function Documentation

◆ at() [1/4]

pqxx::field pqxx::row::at ( size_type i ) const

References operator[](), and size().

Referenced by at(), operator[](), and pqxx::pipeline::resume().

◆ at() [2/4]

pqxx::row::reference pqxx::row::at ( int i ) const

References at().

◆ at() [3/4]

pqxx::field pqxx::row::at ( const char f[] ) const

Address field by name.

Warning: This is much slower than indexing by number, or iterating.

References column_number(), and m_begin.

◆ at() [4/4]

pqxx::row::reference pqxx::row::at ( const std::string & s ) const

Address field by name.

Warning: This is much slower than indexing by number, or iterating.

References at().

◆ back()

pqxx::row::reference pqxx::row::back ( ) const

noexcept

References m_end.

◆ begin()

pqxx::row::const_iterator pqxx::row::begin ( ) const

noexcept

References m_begin.

Referenced by cbegin(), and rend().

◆ cbegin()

pqxx::row::const_iterator pqxx::row::cbegin ( ) const

noexcept

References begin().

◆ cend()

pqxx::row::const_iterator pqxx::row::cend ( ) const

noexcept

References end().

◆ column_number() [1/2]

size_type pqxx::row::column_number ( const std::string & ColName ) const

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

Referenced by at().

◆ column_number() [2/2]

pqxx::row::size_type pqxx::row::column_number ( const char ColName[] ) const

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

References pqxx::result::column_name(), pqxx::result::column_number(), m_begin, m_end, and m_result.

◆ column_table() [1/3]

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

What table did this column come from?

References pqxx::result::column_table(), m_begin, and m_result.

◆ column_table() [2/3]

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

What table did this column come from?

◆ column_table() [3/3]

oid pqxx::row::column_table ( const std::string & ColName ) const

What table did this column come from?

◆ column_type() [1/4]

pqxx::oid pqxx::row::column_type ( size_type ColNum ) const

Type of given column.

References pqxx::result::column_type(), m_begin, and m_result.

◆ column_type() [2/4]

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

Type of given column.

◆ column_type() [3/4]

oid pqxx::row::column_type ( const std::string & ColName ) const

Type of given column.

◆ column_type() [4/4]

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

Type of given column.

◆ crbegin()

pqxx::row::const_reverse_iterator pqxx::row::crbegin ( ) const

References rbegin().

◆ crend()

pqxx::row::const_reverse_iterator pqxx::row::crend ( ) const

References rend().

◆ empty()

bool pqxx::row::empty ( ) const

noexcept

References m_begin, and m_end.

◆ end()

pqxx::row::const_iterator pqxx::row::end ( ) const

noexcept

References m_end.

Referenced by cend(), and rbegin().

◆ front()

pqxx::row::reference pqxx::row::front ( ) const

noexcept

References m_begin.

Referenced by pqxx::transaction_base::exec1(), pqxx::transaction_base::exec_params1(), and pqxx::transaction_base::exec_prepared1().

◆ num()

size_t pqxx::row::num ( ) const

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

◆ operator!=()

bool pqxx::row::operator!= ( const row & rhs ) const

noexcept

◆ operator==()

bool pqxx::row::operator== ( const row & rhs ) const

noexcept

References size().

◆ operator[]() [1/4]

pqxx::row::reference pqxx::row::operator[] ( size_type i ) const

noexcept

References m_begin.

Referenced by at(), and operator[]().

◆ operator[]() [2/4]

pqxx::row::reference pqxx::row::operator[] ( int i ) const

noexcept

References operator[]().

◆ operator[]() [3/4]

pqxx::row::reference pqxx::row::operator[] ( const char f[] ) const

Address field by name.

Warning: This is much slower than indexing by number, or iterating.

References at().

◆ operator[]() [4/4]

pqxx::row::reference pqxx::row::operator[] ( const std::string & s ) const

Address field by name.

Warning: This is much slower than indexing by number, or iterating.

References operator[]().

◆ rbegin()

pqxx::row::const_reverse_iterator pqxx::row::rbegin ( ) const

References end().

Referenced by crbegin().

◆ rend()

pqxx::row::const_reverse_iterator pqxx::row::rend ( ) const

References begin().

Referenced by crend().

◆ rownumber()

size_t pqxx::row::rownumber ( ) const

noexcept

Row number, assuming this is a real row and not end()/rend().

◆ size()

size_type pqxx::row::size ( ) const

noexcept

Referenced by at(), operator==(), and slice().

◆ slice()

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

Produce a slice of this row, 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 row, 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 rows in mind, be sure to test for that case.

References m_begin, and size().

◆ swap()

void pqxx::row::swap ( row & rhs )

noexcept

References m_begin, m_end, m_index, m_result, and pqxx::result::swap().

◆ table_column() [1/3]

pqxx::row::size_type pqxx::row::table_column ( size_type ColNum ) 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

References m_begin, m_result, and pqxx::result::table_column().

◆ table_column() [2/3]

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

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

◆ table_column() [3/3]

size_type pqxx::row::table_column ( const std::string & ColName ) const

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

Friends And Related Function Documentation

◆ field

friend class field

friend

Member Data Documentation

◆ m_begin

size_type pqxx::row::m_begin = 0

protected

First column in slice. This row ignores lower-numbered columns.

Referenced by at(), begin(), column_number(), column_table(), column_type(), empty(), front(), operator[](), slice(), swap(), and table_column().

◆ m_end

size_type pqxx::row::m_end = 0

protected

End column in slice. This row only sees lower-numbered columns.

Referenced by back(), column_number(), empty(), end(), and swap().

◆ m_index

long pqxx::row::m_index = 0

protected

Row number.

You'd expect this to be a size_t, but due to the way reverse iterators are related to regular iterators, it must be allowed to underflow to -1.

Referenced by swap().

◆ m_result

result pqxx::row::m_result

protected

Result set of which this is one row.

Referenced by column_number(), column_table(), column_type(), swap(), and table_column().

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

row.hxx
row.cxx

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_reverse_iterator

◆ difference_type

◆ iterator

◆ pointer

◆ reference

◆ reverse_iterator

◆ size_type

Constructor & Destructor Documentation

◆ row() [1/2]

◆ row() [2/2]

◆ ~row()

Member Function Documentation

◆ at() [1/4]

◆ at() [2/4]

◆ at() [3/4]

◆ at() [4/4]

◆ back()

◆ begin()

◆ cbegin()

◆ cend()

◆ column_number() [1/2]

◆ column_number() [2/2]

◆ column_table() [1/3]

◆ column_table() [2/3]

◆ column_table() [3/3]

◆ column_type() [1/4]

◆ column_type() [2/4]

◆ column_type() [3/4]

◆ column_type() [4/4]

◆ crbegin()

◆ crend()

◆ empty()

◆ end()

◆ front()

◆ num()

◆ operator!=()

◆ operator==()

◆ operator[]() [1/4]

◆ operator[]() [2/4]

◆ operator[]() [3/4]

◆ operator[]() [4/4]

◆ rbegin()

◆ rend()

◆ rownumber()

◆ size()

◆ slice()

◆ swap()

◆ table_column() [1/3]

◆ table_column() [2/3]

◆ table_column() [3/3]

Friends And Related Function Documentation

◆ field

Member Data Documentation

◆ m_begin

◆ m_end

◆ m_index

◆ m_result