JavaScript Editor Javascript debugger     Website design 

mysqli_fetch_field

Returns the next field in the result set (PHP 5)
object mysqli_fetch_field ( mysqli_result result )

Procedural style:

Object oriented style (method):

mysqli_result {
  object fetch_field();
}

Returns the definition of one column of a result set as an object. Call this function repeatedly to retrieve information about all columns in the result set.

Parameters

result

Procedural style only: A result set identifier returned by mysqli_query(), mysqli_store_result() or mysqli_use_result().

Return Values

Returns an object which contains field definition information or FALSE if no field information is available.

Table 187. Object properties

PropertyDescription
nameThe name of the column
orgnameOriginal column name if an alias was specified
tableThe name of the table this field belongs to (if not calculated)
orgtableOriginal table name if an alias was specified
defThe default value for this field, represented as a string
max_lengthThe maximum width of the field for the result set.
lengthThe width of the field, as specified in the table definition.
charsetnrThe character set number for the field.
flagsAn integer representing the bit-flags for the field.
typeThe data type used for this field
decimalsThe number of decimals used (for integer fields)


Examples

Example 1495. Object oriented style

<?php
$mysqli
= new mysqli("localhost", "my_user", "my_password", "world");

/* check connection */
if (mysqli_connect_errno()) {
   
printf("Connect failed: %s\n", mysqli_connect_error());
   exit();
}

$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";

if (
$result = $mysqli->query($query)) {

   
/* Get field information for all columns */
   
while ($finfo = $result->fetch_field()) {

       
printf("Name:     %s\n", $finfo->name);
       
printf("Table:    %s\n", $finfo->table);
       
printf("max. Len: %d\n", $finfo->max_length);
       
printf("Flags:    %d\n", $finfo->flags);
       
printf("Type:     %d\n\n", $finfo->type);
   }
   
$result->close();
}

/* close connection */
$mysqli->close();
?>


Example 1496. Procedural style

<?php
$link
= mysqli_connect("localhost", "my_user", "my_password", "world");

/* check connection */
if (mysqli_connect_errno()) {
   
printf("Connect failed: %s\n", mysqli_connect_error());
   exit();
}

$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";

if (
$result = mysqli_query($link, $query)) {

   
/* Get field information for all fields */
   
while ($finfo = mysqli_fetch_field($result)) {

       
printf("Name:     %s\n", $finfo->name);
       
printf("Table:    %s\n", $finfo->table);
       
printf("max. Len: %d\n", $finfo->max_length);
       
printf("Flags:    %d\n", $finfo->flags);
       
printf("Type:     %d\n\n", $finfo->type);
   }
   
mysqli_free_result($result);
}

/* close connection */
mysqli_close($link);
?>


The above example will output:

Name:     Name
Table:    Country
max. Len: 11
Flags:    1
Type:     254

Name:     SurfaceArea
Table:    Country
max. Len: 10
Flags:    32769
Type:     4