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

Property	Description
name	The name of the column
orgname	Original column name if an alias was specified
table	The name of the table this field belongs to (if not calculated)
orgtable	Original table name if an alias was specified
def	The default value for this field, represented as a string
max_length	The maximum width of the field for the result set.
length	The width of the field, as specified in the table definition.
charsetnr	The character set number for the field.
flags	An integer representing the bit-flags for the field.
type	The data type used for this field
decimals	The number of decimals used (for integer fields)

Examples

Example 1495. Object oriented style

copy to clipboard

<?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

copy to clipboard

<?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:

copy to clipboard

Name:     Name

Table:    Country

max. Len: 11

Flags:    1

Type:     254


Name:     SurfaceArea

Table:    Country

max. Len: 10

Flags:    32769

Type:     4

See Also

mysqli_num_fields()

mysqli_fetch_field_direct()

mysqli_fetch_fields()

mysqli_field_seek()

Code Examples / Notes » mysqli_fetch_field

dedlfix

There are MYSQLI_TYPE_* constants for the type property (listed in http://php.net/manual/en/ref.mysqli.php). e.g. <?php if ($finfo->type == MYSQLI_TYPE_VAR_STRING) // a VARCHAR

marc-andrÃ©

The "type" property will return a numerical representation of a field type instead of a "meaningful" string. Here is an array that may help you: <?php $mysqli_type = array(); $mysqli_type[0] = "decimal"; $mysqli_type[1] = "tinyint"; $mysqli_type[2] = "smallint"; $mysqli_type[3] = "int"; $mysqli_type[4] = "float"; $mysqli_type[5] = "double"; $mysqli_type[7] = "timestamp"; $mysqli_type[8] = "bigint"; $mysqli_type[9] = "mediumint"; $mysqli_type[10] = "date"; $mysqli_type[11] = "time"; $mysqli_type[12] = "datetime"; $mysqli_type[13] = "year"; $mysqli_type[252] = "blob"; // text, blob, tinyblob,mediumblob, etc... $mysqli_type[253] = "string"; // varchar and char $mysqli_type[254] = "enum"; ?>

jonathan

Some corrections ;o) $mysqli_type = array(); $mysqli_type[0] = "DECIMAL"; $mysqli_type[1] = "TINYINT"; $mysqli_type[2] = "SMALLINT"; $mysqli_type[3] = "INTEGER"; $mysqli_type[4] = "FLOAT"; $mysqli_type[5] = "DOUBLE"; $mysqli_type[7] = "TIMESTAMP"; $mysqli_type[8] = "BIGINT"; $mysqli_type[9] = "MEDIUMINT"; $mysqli_type[10] = "DATE"; $mysqli_type[11] = "TIME"; $mysqli_type[12] = "DATETIME"; $mysqli_type[13] = "YEAR"; $mysqli_type[14] = "DATE"; $mysqli_type[16] = "BIT"; $mysqli_type[246] = "DECIMAL"; $mysqli_type[247] = "ENUM"; $mysqli_type[248] = "SET"; $mysqli_type[249] = "TINYBLOB"; $mysqli_type[250] = "MEDIUMBLOB"; $mysqli_type[251] = "LONGBLOB"; $mysqli_type[252] = "BLOB"; $mysqli_type[253] = "VARCHAR"; $mysqli_type[254] = "CHAR"; $mysqli_type[255] = "GEOMETRY";

jakerosoft

<? $fieldinfo = $result->fetch_field(); if ($fieldinfo & MYSQLI_NOT_NULL_FLAG) { print "not null flag is set"; } else { print "not null flag is NOT set"; } ?>

mysqli_fetch_field

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

Parameters

Return Values

Table 187. Object properties

Examples

Example 1495. Object oriented style

Example 1496. Procedural style

Code Examples / Notes » mysqli_fetch_field

Change Language

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