A Hyper SQL type.
More...
#include <SqlType.hpp>
|
| SqlType (TypeTag tag, uint32_t oid, hyper_type_modifier_t modifier=HYPER_UNUSED_MODIFIER) noexcept |
| Constructor.
|
|
TypeTag | getTag () const noexcept |
| Returns the type tag.
|
|
uint32_t | getInternalOid () const noexcept |
| Returns the internal oid.
|
|
uint32_t | getInternalTypeModifier () const noexcept |
| Returns the internal type modifier.
|
|
uint32_t | getPrecision () const noexcept |
| Returns the maximum precision parameter of the type if the type supports it, HYPER_UNUSED_MODIFIER otherwise.
|
|
uint32_t | getScale () const noexcept |
| Returns the scale parameter of the type if the type supports it, HYPER_UNUSED_MODIFIER otherwise.
|
|
uint32_t | getMaxLength () const noexcept |
| Returns the maximum length parameter of the type if the type supports it, HYPER_UNUSED_MODIFIER otherwise.
|
|
std::string | toString () const |
| Returns a string representation for debugging.
|
|
A Hyper SQL type.
Definition at line 44 of file SqlType.hpp.
◆ SqlType()
hyperapi::SqlType::SqlType |
( |
TypeTag |
tag, |
|
|
uint32_t |
oid, |
|
|
hyper_type_modifier_t |
modifier = HYPER_UNUSED_MODIFIER |
|
) |
| |
|
inlinenoexcept |
◆ bigInt()
static SqlType hyperapi::SqlType::bigInt |
( |
| ) |
|
|
inlinestaticnoexcept |
◆ boolean()
static SqlType hyperapi::SqlType::boolean |
( |
| ) |
|
|
inlinestaticnoexcept |
Returns the BOOL SQL type.
- Returns
- The BOOL SQL type
Definition at line 96 of file SqlType.hpp.
◆ bytes()
static SqlType hyperapi::SqlType::bytes |
( |
| ) |
|
|
inlinestaticnoexcept |
Returns the BYTEA SQL type.
- Returns
- The BYTEA SQL type
Definition at line 138 of file SqlType.hpp.
◆ character()
static SqlType hyperapi::SqlType::character |
( |
uint32_t |
maxLength | ) |
|
|
inlinestaticnoexcept |
Returns the CHARACTER SQL type.
- Parameters
-
maxLength | The maximum length |
- Returns
- The CHARACTER SQL type
Definition at line 155 of file SqlType.hpp.
◆ date()
static SqlType hyperapi::SqlType::date |
( |
| ) |
|
|
inlinestaticnoexcept |
◆ doublePrecision()
static SqlType hyperapi::SqlType::doublePrecision |
( |
| ) |
|
|
inlinestaticnoexcept |
◆ geography()
static SqlType hyperapi::SqlType::geography |
( |
| ) |
|
|
inlinestaticnoexcept |
◆ getInternalOid()
uint32_t hyperapi::SqlType::getInternalOid |
( |
| ) |
const |
|
inlinenoexcept |
Returns the internal oid.
Note: This method is internal and may therefore be subject to change in future versions of the API.
Definition at line 61 of file SqlType.hpp.
◆ getInternalTypeModifier()
uint32_t hyperapi::SqlType::getInternalTypeModifier |
( |
| ) |
const |
|
inlinenoexcept |
Returns the internal type modifier.
Note: This method is internal and may therefore be subject to change in future versions of the API.
Definition at line 68 of file SqlType.hpp.
◆ getTag()
TypeTag hyperapi::SqlType::getTag |
( |
| ) |
const |
|
inlinenoexcept |
◆ integer()
static SqlType hyperapi::SqlType::integer |
( |
| ) |
|
|
inlinestaticnoexcept |
◆ interval()
static SqlType hyperapi::SqlType::interval |
( |
| ) |
|
|
inlinestaticnoexcept |
Returns the INTERVAL SQL type.
- Returns
- The INTERVAL SQL type
Definition at line 170 of file SqlType.hpp.
◆ json()
static SqlType hyperapi::SqlType::json |
( |
| ) |
|
|
inlinestaticnoexcept |
Returns the JSON SQL type.
- Returns
- The JSON SQL type
Definition at line 160 of file SqlType.hpp.
◆ numeric()
static SqlType hyperapi::SqlType::numeric |
( |
uint16_t |
precision, |
|
|
uint16_t |
scale |
|
) |
| |
|
inlinestaticnoexcept |
Returns the NUMERIC SQL type.
- Parameters
-
precision | The precision |
scale | The scale |
- Returns
- The NUMERIC SQL type
Definition at line 118 of file SqlType.hpp.
◆ oid()
static SqlType hyperapi::SqlType::oid |
( |
| ) |
|
|
inlinestaticnoexcept |
Returns the OID SQL type.
- Returns
- The OID SQL type
Definition at line 133 of file SqlType.hpp.
◆ real()
static SqlType hyperapi::SqlType::real |
( |
| ) |
|
|
inlinestaticnoexcept |
Returns the REAL SQL type.
- Returns
- The REAL SQL type
Definition at line 123 of file SqlType.hpp.
◆ smallInt()
static SqlType hyperapi::SqlType::smallInt |
( |
| ) |
|
|
inlinestaticnoexcept |
◆ text()
static SqlType hyperapi::SqlType::text |
( |
| ) |
|
|
inlinestaticnoexcept |
◆ time()
static SqlType hyperapi::SqlType::time |
( |
| ) |
|
|
inlinestaticnoexcept |
Returns the TIME SQL type.
- Returns
- The TIME SQL type
Definition at line 175 of file SqlType.hpp.
◆ timestamp()
static SqlType hyperapi::SqlType::timestamp |
( |
| ) |
|
|
inlinestaticnoexcept |
◆ timestampTZ()
static SqlType hyperapi::SqlType::timestampTZ |
( |
| ) |
|
|
inlinestaticnoexcept |
Returns the TIMESTAMPTZ SQL type.
- Returns
- The TIMESTAMPTZ SQL type
Definition at line 185 of file SqlType.hpp.
◆ toString()
std::string hyperapi::SqlType::toString |
( |
| ) |
const |
Returns a string representation for debugging.
The returned string will be the SQL name of the type.
◆ varchar()
static SqlType hyperapi::SqlType::varchar |
( |
uint32_t |
maxLength | ) |
|
|
inlinestaticnoexcept |
Returns the VARCHAR SQL type.
- Parameters
-
maxLength | The maximum length |
- Returns
- The VARCHAR SQL type
Definition at line 149 of file SqlType.hpp.
The documentation for this class was generated from the following file: