JavaScript Editor Javascript debugger     Website design 

mysqli_fetch_field_direct

Fetch meta-data for a single field (PHP 5)
object mysqli_fetch_field_direct ( mysqli_result result, int fieldnr )

Procedural style:

Object oriented style (method):

mysqli_result {
  object fetch_field_direct(int fieldnr);
}

Returns an object which contains field definition informations from specified resultset.

Parameters

result

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

fieldnr

The field number. This value must be in the range from 0 to number of fields - 1.

Return Values

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

Table 186. Object attributes

AttributeDescription
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 tabl 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 1493. 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 Name LIMIT 5";

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

   
/* Get field information for column 'SurfaceArea' */
   
$finfo = $result->fetch_field_direct(1);

   
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", $finfo->type);

   
$result->close();
}

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


Example 1494. 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 Name LIMIT 5";

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

   
/* Get field information for column 'SurfaceArea' */
   
$finfo = mysqli_fetch_field_direct($result, 1);

   
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", $finfo->type);

   
mysqli_free_result($result);
}

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


The above example will output:

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