FieldDescription

A struct representing a field (column) description packet.

These packets, one for each column are sent before the data of a result set, followed by an EOF packet.

struct FieldDescription {

this(ubyte[] packet);

string db [@property getter];

string table [@property getter];

string originalTable [@property getter];

string name [@property getter];

string originalName [@property getter];

ushort charSet [@property getter];

uint length [@property getter];

SQLType type [@property getter];

FieldFlags flags [@property getter];

ubyte scale [@property getter];

bool notNull [@property getter];

bool unsigned [@property getter];

bool binary [@property getter];

bool isenum [@property getter];

bool isset [@property getter];

}

Constructors

this this(ubyte[] packet): Construct a FieldDescription from the raw data packet

Members

Functions

show void show(): Undocumented in source. Be warned that the author may not have intended to support it.

Properties

binary bool binary [@property getter]: Binary from flags
charSet ushort charSet [@property getter]: The character set in force
db string db [@property getter]: Database name for column as string
flags FieldFlags flags [@property getter]: Column flags - unsigned, binary, null and so on
isenum bool isenum [@property getter]: Is-enum from flags
isset bool isset [@property getter]: Is-set (a SET column that is) from flags
length uint length [@property getter]: The 'length' of the column as defined at table creation
name string name [@property getter]: Column name as string - this could be an alias
notNull bool notNull [@property getter]: NotNull from flags
originalName string originalName [@property getter]: Real column name as string
originalTable string originalTable [@property getter]: Real table name for column as string
scale ubyte scale [@property getter]: Precision for floating point values
table string table [@property getter]: Table name for column as string - this could be an alias as in 'from tablename as foo'
type SQLType type [@property getter]: The type of the column hopefully (but not always) corresponding to enum mysql.protocol.constants.SQLType. Only the low byte currently used.
unsigned bool unsigned [@property getter]: Unsigned from flags

See Also

http://forge.mysql.com/wiki/MySQL_Internals_ClientServer_Protocol#Field_Packet

Meta

Source

See Implementation

mysql protocol packets functions

structs