fb-cpp 0.0.2
A modern C++ wrapper for the Firebird database API
Loading...
Searching...
No Matches
fbcpp::Descriptor Struct Referencefinal

Describes a parameter or column. More...

#include <Descriptor.h>

Collaboration diagram for fbcpp::Descriptor:

Public Attributes

DescriptorOriginalType originalType
 Original SQL type as reported by Firebird.
 
DescriptorAdjustedType adjustedType
 Adjusted type after normalization for easier handling.
 
int scale
 Decimal scale for numeric types; zero for non-numeric types.
 
unsigned length
 Length in bytes of the column or parameter data.
 
unsigned offset
 Byte offset of this field within the message buffer.
 
unsigned nullOffset
 Byte offset of the null indicator within the message buffer.
 
bool isNullable
 Indicates whether the column or parameter can contain null values.
 
std::string name
 Column or parameter name.
 
std::string relation
 Table or relation this column belongs to (empty for expressions).
 
std::string alias
 Column alias as it appears in the query's SELECT list.
 
std::string owner
 Owner of the relation (empty for expressions).
 
unsigned charSetId
 Character set ID for string and BLOB columns.
 
int subType
 Sub-type (BLOB sub-type or numeric sub-type).
 

Detailed Description

Describes a parameter or column.

Definition at line 247 of file Descriptor.h.

Member Data Documentation

◆ adjustedType

DescriptorAdjustedType fbcpp::Descriptor::adjustedType

Adjusted type after normalization for easier handling.

Definition at line 257 of file Descriptor.h.

◆ alias

std::string fbcpp::Descriptor::alias

Column alias as it appears in the query's SELECT list.

Definition at line 297 of file Descriptor.h.

◆ charSetId

unsigned fbcpp::Descriptor::charSetId

Character set ID for string and BLOB columns.

Definition at line 307 of file Descriptor.h.

◆ isNullable

bool fbcpp::Descriptor::isNullable

Indicates whether the column or parameter can contain null values.

Definition at line 282 of file Descriptor.h.

◆ length

unsigned fbcpp::Descriptor::length

Length in bytes of the column or parameter data.

Definition at line 267 of file Descriptor.h.

◆ name

std::string fbcpp::Descriptor::name

Column or parameter name.

Definition at line 287 of file Descriptor.h.

◆ nullOffset

unsigned fbcpp::Descriptor::nullOffset

Byte offset of the null indicator within the message buffer.

Definition at line 277 of file Descriptor.h.

◆ offset

unsigned fbcpp::Descriptor::offset

Byte offset of this field within the message buffer.

Definition at line 272 of file Descriptor.h.

◆ originalType

DescriptorOriginalType fbcpp::Descriptor::originalType

Original SQL type as reported by Firebird.

Definition at line 252 of file Descriptor.h.

◆ owner

std::string fbcpp::Descriptor::owner

Owner of the relation (empty for expressions).

Definition at line 302 of file Descriptor.h.

◆ relation

std::string fbcpp::Descriptor::relation

Table or relation this column belongs to (empty for expressions).

Definition at line 292 of file Descriptor.h.

◆ scale

int fbcpp::Descriptor::scale

Decimal scale for numeric types; zero for non-numeric types.

Definition at line 262 of file Descriptor.h.

◆ subType

int fbcpp::Descriptor::subType

Sub-type (BLOB sub-type or numeric sub-type).

Definition at line 312 of file Descriptor.h.


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