Dmitigr Pgfe  1.1beta
The modern C++ API to PostgreSQL
Public Member Functions | List of all members
Row Class Referenceabstract

Represents an abstraction of a row produced by a server. More...

#include <dmitigr/pgfe/row.hpp>

Inheritance diagram for Row:
Response Compositional Server_message Message

Public Member Functions

virtual const Row_infoinfo () const noexcept=0
 
virtual const Datadata (std::size_t index) const =0
 
virtual const Datadata (const std::string &name, std::size_t offset=0) const =0
 
- Public Member Functions inherited from Compositional
virtual ~Compositional ()=default
 The destructor. More...
 
virtual std::size_t field_count () const =0
 
virtual bool has_fields () const =0
 
virtual const std::string & field_name (std::size_t index) const =0
 
virtual std::optional< std::size_t > field_index (const std::string &name, std::size_t offset=0) const =0
 
virtual std::size_t field_index_throw (const std::string &name, std::size_t offset=0) const =0
 Similar to field_index(const std::string&, std::size_t) except the requirement. More...
 
virtual bool has_field (const std::string &name, std::size_t offset=0) const =0
 

Detailed Description

Represents an abstraction of a row produced by a server.

Member Function Documentation

◆ data() [1/2]

virtual const Data* data ( std::size_t  index) const
pure virtual
Returns
The field data of this row, or nullptr if NULL.
Parameters
index- see Compositional.
Requires
Index in range [0, field_count()).

◆ data() [2/2]

virtual const Data* data ( const std::string &  name,
std::size_t  offset = 0 
) const
pure virtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
name- see Compositional;
offset- see Compositional.
Requires
has_field(name, offset).
See also
has_field()

◆ info()

virtual const Row_info* info ( ) const
pure virtualnoexcept
Returns
The information about this row.

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