mysql-native v3.0.0
API Reference Home: [This Version] [Latest Version] [Other Versions]
Struct FieldDescription
A struct representing a field (column) description packet.
					
			struct FieldDescription
			;
					
				
			These packets, one for each column are sent before the data of a result set, followed by an EOF packet.
Constructors
| Name | Description | 
|---|---|
							
								this
							
						 | 
						Construct a FieldDescription from the raw data packet
 | 
					
Properties
| Name | Type | Description | 
|---|---|---|
							binary[get]
						 | 
						bool | Binary from flags | 
							charSet[get]
						 | 
						ushort | The character set in force | 
							db[get]
						 | 
						string | Database name for column as string | 
							flags[get]
						 | 
						FieldFlags | Column flags - unsigned, binary, null and so on | 
							isenum[get]
						 | 
						bool | Is-enum from flags | 
							isset[get]
						 | 
						bool | Is-set (a SET column that is) from flags | 
							length[get]
						 | 
						uint | The 'length' of the column as defined at table creation | 
							name[get]
						 | 
						string | Column name as string - this could be an alias | 
							notNull[get]
						 | 
						bool | NotNull from flags | 
							originalName[get]
						 | 
						string | Real column name as string | 
							originalTable[get]
						 | 
						string | Real table name for column as string | 
							scale[get]
						 | 
						ubyte | Precision for floating point values | 
							table[get]
						 | 
						string | Table name for column as string - this could be an alias as in 'from tablename as foo' | 
							type[get]
						 | 
						SQLType | The type of the column hopefully (but not always) corresponding to enum SQLType.
Only the low byte currently used.
 | 
					
							unsigned[get]
						 | 
						bool | Unsigned from flags | 
Methods
| Name | Description | 
|---|---|
							
								show
							
						 | 
						
See Also
http://forge.mysql.com/wiki/MySQL_Internals_ClientServer_Protocol#Field_Packet