pg_async
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Attributes | List of all members
tip::db::pg::field_description Struct Reference

Description of a field returned by the backend. More...

#include <common.hpp>

Public Attributes

std::string name
 The field name. More...
 
integer table_oid
 If the field can be identified as a column of a specific table, the object ID of the table; otherwise zero. More...
 
smallint attribute_number
 If the field can be identified as a column of a specific table, the attribute number of the column; otherwise zero. More...
 
oids::type::oid_type type_oid
 The object ID of the field's data type. More...
 
smallint type_size
 The data type size (see pg_type.typlen). Note that negative values denote variable-width types. More...
 
integer type_mod
 The type modifier (see pg_attribute.atttypmod). The meaning of the modifier is type-specific. More...
 
protocol_data_format format_code
 The format code being used for the field. Currently will be zero (text) or one (binary). In a RowDescription returned from the statement variant of Describe, the format code is not yet known and will always be zero. More...
 
integer max_size
 

Detailed Description

Description of a field returned by the backend.

Definition at line 291 of file common.hpp.

Member Data Documentation

smallint tip::db::pg::field_description::attribute_number

If the field can be identified as a column of a specific table, the attribute number of the column; otherwise zero.

Definition at line 302 of file common.hpp.

protocol_data_format tip::db::pg::field_description::format_code

The format code being used for the field. Currently will be zero (text) or one (binary). In a RowDescription returned from the statement variant of Describe, the format code is not yet known and will always be zero.

Definition at line 319 of file common.hpp.

integer tip::db::pg::field_description::max_size

Maximum size of the field in the result set

Definition at line 320 of file common.hpp.

std::string tip::db::pg::field_description::name

The field name.

Definition at line 294 of file common.hpp.

integer tip::db::pg::field_description::table_oid

If the field can be identified as a column of a specific table, the object ID of the table; otherwise zero.

Definition at line 298 of file common.hpp.

integer tip::db::pg::field_description::type_mod

The type modifier (see pg_attribute.atttypmod). The meaning of the modifier is type-specific.

Definition at line 312 of file common.hpp.

oids::type::oid_type tip::db::pg::field_description::type_oid

The object ID of the field's data type.

Definition at line 304 of file common.hpp.

smallint tip::db::pg::field_description::type_size

The data type size (see pg_type.typlen). Note that negative values denote variable-width types.

Definition at line 308 of file common.hpp.


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