Field Class Reference

Class used to access individual fields of database query result. More...

#include <Field.h>

Public Member Functions
	Field ()
	~Field ()
bool	GetBool () const
uint8	GetUInt8 () const
int8	GetInt8 () const
uint16	GetUInt16 () const
int16	GetInt16 () const
uint32	GetUInt32 () const
int32	GetInt32 () const
uint64	GetUInt64 () const
int64	GetInt64 () const
float	GetFloat () const
double	GetDouble () const
char const *	GetCString () const
std::string	GetString () const
std::string_view	GetStringView () const
std::vector< uint8 >	GetBinary () const
template<size_t S>
std::array< uint8, S >	GetBinary () const
bool	IsNull () const

Protected Member Functions
void	SetByteValue (char const *newValue, uint32 length)
void	SetStructuredValue (char const *newValue, uint32 length)
bool	IsType (DatabaseFieldTypes type) const
bool	IsNumeric () const

Protected Attributes
struct {
char const *   value
uint32   length
bool   raw
}	data

Private Member Functions
void	LogWrongType (char const *getter) const
void	SetMetadata (QueryResultFieldMetadata const *fieldMeta)
void	GetBinarySizeChecked (uint8 *buf, size_t size) const

Private Attributes
QueryResultFieldMetadata const *	meta

Friends
class	ResultSet
class	PreparedResultSet

Detailed Description

Class used to access individual fields of database query result.

Guideline on field type matching:

MySQL type	method to use
TINYINT	GetBool, GetInt8, GetUInt8
SMALLINT	GetInt16, GetUInt16
MEDIUMINT, INT	GetInt32, GetUInt32
BIGINT	GetInt64, GetUInt64
FLOAT	GetFloat
DOUBLE, DECIMAL	GetDouble
CHAR, VARCHAR,	GetCString, GetString
TINYTEXT, MEDIUMTEXT,	GetCString, GetString
TEXT, LONGTEXT	GetCString, GetString
TINYBLOB, MEDIUMBLOB,	GetBinary, GetString
BLOB, LONGBLOB	GetBinary, GetString
BINARY, VARBINARY	GetBinary

Return types of aggregate functions:

Function	Type
MIN, MAX	Same as the field
SUM, AVG	DECIMAL
COUNT	BIGINT

Constructor & Destructor Documentation

Field()

Field::Field

(

)

{
 data.value = nullptr;
 data.length = 0;
 data.raw = false;
 meta = nullptr;
}

~Field()

Field::~Field ( )

default

Member Function Documentation

GetBinary() [1/2]

std::vector< uint8 > Field::GetBinary

(

)

const

{
 std::vector<uint8> result;
 if (!data.value || !data.length)
 return result;
 
 result.resize(data.length);
 memcpy(result.data(), data.value, data.length);
 return result;
}

Here is the caller graph for this function:

GetBinary() [2/2]

template<size_t S>

std::array< uint8, S > Field::GetBinary ( ) const

inline

 {
 std::array<uint8, S> buf;
 GetBinarySizeChecked(buf.data(), S);
 return buf;
 }

GetBinarySizeChecked()

void Field::GetBinarySizeChecked ( uint8 *  buf, size_t  size  ) const

private

{
 ASSERT(data.value && (data.length == length), "Expected %zu-byte binary blob, got %sdata (%u bytes) instead", length, data.value ? "" : "no ", data.length);
 memcpy(buf, data.value, length);
}

GetBool()

bool Field::GetBool ( ) const

inline

 {
 return GetUInt8() == 1 ? true : false;
 }

Here is the caller graph for this function:

GetCString()

char const * Field::GetCString

(

)

const

{
 if (!data.value)
 return nullptr;
 
#ifdef TRINITY_STRICT_DATABASE_TYPE_CHECKS
 if (IsNumeric() && data.raw)
 {
 LogWrongType(__FUNCTION__);
 return nullptr;
 }
#endif
 return static_cast<char const*>(data.value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetDouble()

double Field::GetDouble

(

)

const

{
 if (!data.value)
 return 0.0f;
 
#ifdef TRINITY_STRICT_DATABASE_TYPE_CHECKS
 if (!IsType(DatabaseFieldTypes::Double) && !IsType(DatabaseFieldTypes::Decimal))
 {
 LogWrongType(__FUNCTION__);
 return 0.0f;
 }
#endif
 
 if (data.raw && !IsType(DatabaseFieldTypes::Decimal))
 return *reinterpret_cast<double const*>(data.value);
 return static_cast<double>(atof(data.value));
}

Here is the call graph for this function:

GetFloat()

float Field::GetFloat

(

)

const

{
 if (!data.value)
 return 0.0f;
 
#ifdef TRINITY_STRICT_DATABASE_TYPE_CHECKS
 if (!IsType(DatabaseFieldTypes::Float))
 {
 LogWrongType(__FUNCTION__);
 return 0.0f;
 }
#endif
 
 if (data.raw)
 return *reinterpret_cast<float const*>(data.value);
 return static_cast<float>(atof(data.value));
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetInt16()

int16 Field::GetInt16

(

)

const

{
 if (!data.value)
 return 0;
 
#ifdef TRINITY_STRICT_DATABASE_TYPE_CHECKS
 if (!IsType(DatabaseFieldTypes::Int16))
 {
 LogWrongType(__FUNCTION__);
 return 0;
 }
#endif
 
 if (data.raw)
 return *reinterpret_cast<int16 const*>(data.value);
 return static_cast<int16>(strtol(data.value, nullptr, 10));
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetInt32()

int32 Field::GetInt32

(

)

const

{
 if (!data.value)
 return 0;
 
#ifdef TRINITY_STRICT_DATABASE_TYPE_CHECKS
 if (!IsType(DatabaseFieldTypes::Int32))
 {
 LogWrongType(__FUNCTION__);
 return 0;
 }
#endif
 
 if (data.raw)
 return *reinterpret_cast<int32 const*>(data.value);
 return static_cast<int32>(strtol(data.value, nullptr, 10));
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetInt64()

int64 Field::GetInt64

(

)

const

{
 if (!data.value)
 return 0;
 
#ifdef TRINITY_STRICT_DATABASE_TYPE_CHECKS
 if (!IsType(DatabaseFieldTypes::Int64))
 {
 LogWrongType(__FUNCTION__);
 return 0;
 }
#endif
 
 if (data.raw)
 return *reinterpret_cast<int64 const*>(data.value);
 return static_cast<int64>(strtoll(data.value, nullptr, 10));
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetInt8()

int8 Field::GetInt8

(

)

const

{
 if (!data.value)
 return 0;
 
#ifdef TRINITY_STRICT_DATABASE_TYPE_CHECKS
 if (!IsType(DatabaseFieldTypes::Int8))
 {
 LogWrongType(__FUNCTION__);
 return 0;
 }
#endif
 
 if (data.raw)
 return *reinterpret_cast<int8 const*>(data.value);
 return static_cast<int8>(strtol(data.value, nullptr, 10));
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetString()

std::string Field::GetString

(

)

const

{
 if (!data.value)
 return "";
 
 char const* string = GetCString();
 if (!string)
 return "";
 
 return std::string(string, data.length);
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetStringView()

std::string_view Field::GetStringView

(

)

const

{
 if (!data.value)
 return {};
 
 char const* const string = GetCString();
 if (!string)
 return {};
 
 return { string, data.length };
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetUInt16()

uint16 Field::GetUInt16

(

)

const

{
 if (!data.value)
 return 0;
 
#ifdef TRINITY_STRICT_DATABASE_TYPE_CHECKS
 if (!IsType(DatabaseFieldTypes::Int16))
 {
 LogWrongType(__FUNCTION__);
 return 0;
 }
#endif
 
 if (data.raw)
 return *reinterpret_cast<uint16 const*>(data.value);
 return static_cast<uint16>(strtoul(data.value, nullptr, 10));
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetUInt32()

uint32 Field::GetUInt32

(

)

const

{
 if (!data.value)
 return 0;
 
#ifdef TRINITY_STRICT_DATABASE_TYPE_CHECKS
 if (!IsType(DatabaseFieldTypes::Int32))
 {
 LogWrongType(__FUNCTION__);
 return 0;
 }
#endif
 
 if (data.raw)
 return *reinterpret_cast<uint32 const*>(data.value);
 return static_cast<uint32>(strtoul(data.value, nullptr, 10));
}

Here is the call graph for this function:

GetUInt64()

uint64 Field::GetUInt64

(

)

const

{
 if (!data.value)
 return 0;
 
#ifdef TRINITY_STRICT_DATABASE_TYPE_CHECKS
 if (!IsType(DatabaseFieldTypes::Int64))
 {
 LogWrongType(__FUNCTION__);
 return 0;
 }
#endif
 
 if (data.raw)
 return *reinterpret_cast<uint64 const*>(data.value);
 return static_cast<uint64>(strtoull(data.value, nullptr, 10));
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetUInt8()

uint8 Field::GetUInt8

(

)

const

{
 if (!data.value)
 return 0;
 
#ifdef TRINITY_STRICT_DATABASE_TYPE_CHECKS
 if (!IsType(DatabaseFieldTypes::Int8))
 {
 LogWrongType(__FUNCTION__);
 return 0;
 }
#endif
 
 if (data.raw)
 return *reinterpret_cast<uint8 const*>(data.value);
 return static_cast<uint8>(strtoul(data.value, nullptr, 10));
}

Here is the call graph for this function:

Here is the caller graph for this function:

IsNull()

bool Field::IsNull ( ) const

inline

 {
 return data.value == nullptr;
 }

Here is the caller graph for this function:

IsNumeric()

bool Field::IsNumeric ( ) const

protected

{
 return (meta->Type == DatabaseFieldTypes::Int8 ||
 meta->Type == DatabaseFieldTypes::Int16 ||
 meta->Type == DatabaseFieldTypes::Int32 ||
 meta->Type == DatabaseFieldTypes::Int64 ||
 meta->Type == DatabaseFieldTypes::Float ||
 meta->Type == DatabaseFieldTypes::Double);
}

Here is the caller graph for this function:

IsType()

bool Field::IsType ( DatabaseFieldTypes  type ) const

protected

{
 return meta->Type == type;
}

Here is the caller graph for this function:

LogWrongType()

void Field::LogWrongType ( char const *  getter ) const

private

{
 TC_LOG_WARN("sql.sql", "Warning: {} on {} field {}.{} ({}.{}) at index {}.",
 getter, meta->TypeName, meta->TableAlias, meta->Alias, meta->TableName, meta->Name, meta->Index);
}

Here is the caller graph for this function:

SetByteValue()

void Field::SetByteValue ( char const *  newValue, uint32  length  )

protected

{
 // This value stores raw bytes that have to be explicitly cast later
 data.value = newValue;
 data.length = length;
 data.raw = true;
}

SetMetadata()

void Field::SetMetadata ( QueryResultFieldMetadata const *  fieldMeta )

private

{
 meta = fieldMeta;
}

Here is the caller graph for this function:

SetStructuredValue()

void Field::SetStructuredValue ( char const *  newValue, uint32  length  )

protected

{
 // This value stores somewhat structured data that needs function style casting
 data.value = newValue;
 data.length = length;
 data.raw = false;
}

Friends And Related Function Documentation

PreparedResultSet

friend class PreparedResultSet

friend

ResultSet

friend class ResultSet

friend

Member Data Documentation

struct { ... } Field::data

length

uint32 Field::length

meta

QueryResultFieldMetadata const* Field::meta

private

raw

bool Field::raw

value

char const* Field::value

---

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

• src/server/database/Database/Field.h
• src/server/database/Database/Field.cpp