mysqli_result::fetch_field

    mysqli_fetch_field

    (PHP 5, PHP 7, PHP 8)

    mysqli_result::fetch_field -- mysqli_fetch_field — Returns the next field in the result set

    Description

    Object-oriented style

    publicmysqli_result::fetch_field(): object|false

    Procedural style

    mysqli_fetch_field(mysqli_result$result): object|false

    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 mysqli_result object returned by mysqli_query(), mysqli_store_result(), mysqli_use_result() or mysqli_stmt_get_result().

    Return Values

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

    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
    defReserved for default value, currently always ""
    dbThe name of the database
    catalogThe catalog name, always "def"
    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 #1 Object-oriented style

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


    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)) {


    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();
    }


    $mysqli->close();
    ?>

    Example #2 Procedural style

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


    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)) {


    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);
    }


    mysqli_close($link);
    ?>

    The above examples will output:

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

    See Also

    To Top