Field Class Reference

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

#include <Field.h>

Classes
struct	Metadata

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::vector< uint8 >	GetBinary () const
bool	IsNull () const

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

Static Protected Member Functions
static uint32	SizeForType (MYSQL_FIELD *field)

Protected Attributes
struct {
uint32   length
void *   value
enum_field_types   type
bool   raw
}	data

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

(

)

{
 data.value = NULL;
 data.type = MYSQL_TYPE_NULL;
 data.length = 0;
 data.raw = false;
}

Field::~Field

(

)

{
 CleanUp();
}

Here is the call graph for this function:

Member Function Documentation

void Field::CleanUp ( )

inlineprotected

 {
 // Field does not own the data if fetched with prepared statement
 if (!data.raw)
 delete[] ((char*)data.value);
 data.value = NULL;
 }

Here is the caller graph for this function:

std::vector<uint8> Field::GetBinary ( ) const

inline

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

 result.resize(data.length);
 memcpy(result.data(), data.value, data.length);
 return result;
 }

bool Field::GetBool ( ) const

inline

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

Here is the caller graph for this function:

char const* Field::GetCString ( ) const

inline

 {
 if (!data.value)
 return NULL;

 #ifdef TRINITY_DEBUG
 if (IsNumeric())
 {
 TC_LOG_WARN("sql.sql", "Error: GetCString() on numeric field %s.%s (%s.%s) at index %u. Using type: %s.",
 meta.TableAlias, meta.Alias, meta.TableName, meta.Name, meta.Index, meta.Type);
 return NULL;
 }
 #endif
 return static_cast<char const*>(data.value);
 }

Here is the caller graph for this function:

double Field::GetDouble ( ) const

inline

 {
 if (!data.value)
 return 0.0f;

 #ifdef TRINITY_DEBUG
 if (!IsType(MYSQL_TYPE_DOUBLE) && !IsType(MYSQL_TYPE_NEWDECIMAL))
 {
 TC_LOG_WARN("sql.sql", "Warning: GetDouble() on non-double/non-decimal field %s.%s (%s.%s) at index %u. Using type: %s.",
 meta.TableAlias, meta.Alias, meta.TableName, meta.Name, meta.Index, meta.Type);
 return 0.0f;
 }
 #endif

 if (data.raw && !IsType(MYSQL_TYPE_NEWDECIMAL))
 return *reinterpret_cast<double*>(data.value);
 return static_cast<double>(atof((char*)data.value));
 }

float Field::GetFloat ( ) const

inline

 {
 if (!data.value)
 return 0.0f;

 #ifdef TRINITY_DEBUG
 if (!IsType(MYSQL_TYPE_FLOAT))
 {
 TC_LOG_WARN("sql.sql", "Warning: GetFloat() on non-float field %s.%s (%s.%s) at index %u. Using type: %s.",
 meta.TableAlias, meta.Alias, meta.TableName, meta.Name, meta.Index, meta.Type);
 return 0.0f;
 }
 #endif

 if (data.raw)
 return *reinterpret_cast<float*>(data.value);
 return static_cast<float>(atof((char*)data.value));
 }

int16 Field::GetInt16 ( ) const

inline

 {
 if (!data.value)
 return 0;

 #ifdef TRINITY_DEBUG
 if (!IsType(MYSQL_TYPE_SHORT) && !IsType(MYSQL_TYPE_YEAR))
 {
 TC_LOG_WARN("sql.sql", "Warning: GetInt16() on non-smallint field %s.%s (%s.%s) at index %u. Using type: %s.",
 meta.TableAlias, meta.Alias, meta.TableName, meta.Name, meta.Index, meta.Type);
 return 0;
 }
 #endif

 if (data.raw)
 return *reinterpret_cast<int16*>(data.value);
 return static_cast<int16>(strtol((char*)data.value, NULL, 10));
 }

Here is the caller graph for this function:

int32 Field::GetInt32 ( ) const

inline

 {
 if (!data.value)
 return 0;

 #ifdef TRINITY_DEBUG
 if (!IsType(MYSQL_TYPE_INT24) && !IsType(MYSQL_TYPE_LONG))
 {
 TC_LOG_WARN("sql.sql", "Warning: GetInt32() on non-(medium)int field %s.%s (%s.%s) at index %u. Using type: %s.",
 meta.TableAlias, meta.Alias, meta.TableName, meta.Name, meta.Index, meta.Type);
 return 0;
 }
 #endif

 if (data.raw)
 return *reinterpret_cast<int32*>(data.value);
 return static_cast<int32>(strtol((char*)data.value, NULL, 10));
 }

Here is the caller graph for this function:

int64 Field::GetInt64 ( ) const

inline

 {
 if (!data.value)
 return 0;

 #ifdef TRINITY_DEBUG
 if (!IsType(MYSQL_TYPE_LONGLONG) && !IsType(MYSQL_TYPE_BIT))
 {
 TC_LOG_WARN("sql.sql", "Warning: GetInt64() on non-bigint field %s.%s (%s.%s) at index %u. Using type: %s.",
 meta.TableAlias, meta.Alias, meta.TableName, meta.Name, meta.Index, meta.Type);
 return 0;
 }
 #endif

 if (data.raw)
 return *reinterpret_cast<int64*>(data.value);
 return static_cast<int64>(strtoll((char*)data.value, NULL, 10));
 }

Here is the caller graph for this function:

int8 Field::GetInt8 ( ) const

inline

 {
 if (!data.value)
 return 0;

 #ifdef TRINITY_DEBUG
 if (!IsType(MYSQL_TYPE_TINY))
 {
 TC_LOG_WARN("sql.sql", "Warning: GetInt8() on non-tinyint field %s.%s (%s.%s) at index %u. Using type: %s.",
 meta.TableAlias, meta.Alias, meta.TableName, meta.Name, meta.Index, meta.Type);
 return 0;
 }
 #endif

 if (data.raw)
 return *reinterpret_cast<int8*>(data.value);
 return static_cast<int8>(strtol((char*)data.value, NULL, 10));
 }

Here is the caller graph for this function:

std::string Field::GetString ( ) const

inline

 {
 if (!data.value)
 return "";

 char const* string = GetCString();
 if (!string)
 return "";

 return std::string(string, data.length);
 }

uint16 Field::GetUInt16 ( ) const

inline

 {
 if (!data.value)
 return 0;

 #ifdef TRINITY_DEBUG
 if (!IsType(MYSQL_TYPE_SHORT) && !IsType(MYSQL_TYPE_YEAR))
 {
 TC_LOG_WARN("sql.sql", "Warning: GetUInt16() on non-smallint field %s.%s (%s.%s) at index %u. Using type: %s.",
 meta.TableAlias, meta.Alias, meta.TableName, meta.Name, meta.Index, meta.Type);
 return 0;
 }
 #endif

 if (data.raw)
 return *reinterpret_cast<uint16*>(data.value);
 return static_cast<uint16>(strtoul((char*)data.value, nullptr, 10));
 }

uint32 Field::GetUInt32 ( ) const

inline

 {
 if (!data.value)
 return 0;

 #ifdef TRINITY_DEBUG
 if (!IsType(MYSQL_TYPE_INT24) && !IsType(MYSQL_TYPE_LONG))
 {
 TC_LOG_WARN("sql.sql", "Warning: GetUInt32() on non-(medium)int field %s.%s (%s.%s) at index %u. Using type: %s.",
 meta.TableAlias, meta.Alias, meta.TableName, meta.Name, meta.Index, meta.Type);
 return 0;
 }
 #endif

 if (data.raw)
 return *reinterpret_cast<uint32*>(data.value);
 return static_cast<uint32>(strtoul((char*)data.value, nullptr, 10));
 }

uint64 Field::GetUInt64 ( ) const

inline

 {
 if (!data.value)
 return 0;

 #ifdef TRINITY_DEBUG
 if (!IsType(MYSQL_TYPE_LONGLONG) && !IsType(MYSQL_TYPE_BIT))
 {
 TC_LOG_WARN("sql.sql", "Warning: GetUInt64() on non-bigint field %s.%s (%s.%s) at index %u. Using type: %s.",
 meta.TableAlias, meta.Alias, meta.TableName, meta.Name, meta.Index, meta.Type);
 return 0;
 }
 #endif

 if (data.raw)
 return *reinterpret_cast<uint64*>(data.value);
 return static_cast<uint64>(strtoull((char*)data.value, nullptr, 10));
 }

uint8 Field::GetUInt8 ( ) const

inline

 {
 if (!data.value)
 return 0;

 #ifdef TRINITY_DEBUG
 if (!IsType(MYSQL_TYPE_TINY))
 {
 TC_LOG_WARN("sql.sql", "Warning: GetUInt8() on non-tinyint field %s.%s (%s.%s) at index %u. Using type: %s.",
 meta.TableAlias, meta.Alias, meta.TableName, meta.Name, meta.Index, meta.Type);
 return 0;
 }
 #endif

 if (data.raw)
 return *reinterpret_cast<uint8*>(data.value);
 return static_cast<uint8>(strtoul((char*)data.value, nullptr, 10));
 }

bool Field::IsNull ( ) const

inline

 {
 return data.value == NULL;
 }

bool Field::IsNumeric ( ) const

inlineprotected

 {
 return (data.type == MYSQL_TYPE_TINY ||
 data.type == MYSQL_TYPE_SHORT ||
 data.type == MYSQL_TYPE_INT24 ||
 data.type == MYSQL_TYPE_LONG ||
 data.type == MYSQL_TYPE_FLOAT ||
 data.type == MYSQL_TYPE_DOUBLE ||
 data.type == MYSQL_TYPE_LONGLONG );
 }

bool Field::IsType ( enum_field_types  type ) const

inlineprotected

 {
 return data.type == type;
 }

void Field::SetByteValue ( void *  newValue, enum_field_types  newType, uint32  length  )

protected

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

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

protected

{
 if (data.value)
 CleanUp();

 // This value stores somewhat structured data that needs function style casting
 if (newValue)
 {
 data.value = new char[length + 1];
 memcpy(data.value, newValue, length);
 *(reinterpret_cast<char*>(data.value) + length) = '\0';
 data.length = length;
 }

 data.type = newType;
 data.raw = false;
}

Here is the call graph for this function:

static uint32 Field::SizeForType ( MYSQL_FIELD *  field )

inlinestaticprotected

 {
 switch (field->type)
 {
 case MYSQL_TYPE_NULL:
 return 0;
 case MYSQL_TYPE_TINY:
 return 1;
 case MYSQL_TYPE_YEAR:
 case MYSQL_TYPE_SHORT:
 return 2;
 case MYSQL_TYPE_INT24:
 case MYSQL_TYPE_LONG:
 case MYSQL_TYPE_FLOAT:
 return 4;
 case MYSQL_TYPE_DOUBLE:
 case MYSQL_TYPE_LONGLONG:
 case MYSQL_TYPE_BIT:
 return 8;

 case MYSQL_TYPE_TIMESTAMP:
 case MYSQL_TYPE_DATE:
 case MYSQL_TYPE_TIME:
 case MYSQL_TYPE_DATETIME:
 return sizeof(MYSQL_TIME);

 case MYSQL_TYPE_TINY_BLOB:
 case MYSQL_TYPE_MEDIUM_BLOB:
 case MYSQL_TYPE_LONG_BLOB:
 case MYSQL_TYPE_BLOB:
 case MYSQL_TYPE_STRING:
 case MYSQL_TYPE_VAR_STRING:
 return field->max_length + 1;

 case MYSQL_TYPE_DECIMAL:
 case MYSQL_TYPE_NEWDECIMAL:
 return 64;

 case MYSQL_TYPE_GEOMETRY:
 /*
 Following types are not sent over the wire:
 MYSQL_TYPE_ENUM:
 MYSQL_TYPE_SET:
 */
 default:
 TC_LOG_WARN("sql.sql", "SQL::SizeForType(): invalid field type %u", uint32(field->type));
 return 0;
 }
 }

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class PreparedResultSet

friend

friend class ResultSet

friend

Member Data Documentation

struct { ... } Field::data

uint32 Field::length

bool Field::raw

enum_field_types Field::type

void* 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