PHP 4, PHP 5
mysql_fetch_field - Get column information from a result and return as an object
Code Examples

mysql_fetch_field( resource$result, [int$field_offset = 0] ): object

Returns an object containing field information. This function can be used to obtain information about fields in the provided query result.



The result resource that is being evaluated. This result comes from a call to mysql_query.


The numerical field offset. If the field offset is not specified, the next field that was not yet retrieved by this function is retrieved. The field_offset starts at 0.

Return Values

Returns an object containing field information. The properties of the object are:

name - column name

table - name of the table the column belongs to, which is the alias name if one is defined

max_length - maximum length of the column

not_null - 1 if the column cannot be null

primary_key - 1 if the column is a primary key

unique_key - 1 if the column is a unique key

multiple_key - 1 if the column is a non-unique key

numeric - 1 if the column is numeric

blob - 1 if the column is a BLOB

type - the type of the column

unsigned - 1 if the column is unsigned

zerofill - 1 if the column is zero-filled



Field names returned by this function are case-sensitive.


If field or tablenames are aliased in the SQL query the aliased name will be returned. The original name can be retrieved for instance by using mysqli_result::fetch_field.

Related Functions

Example of mysql_fetch_field

Show all examples for mysql_fetch_field

PHP Version: