mysqli_result::fetch_field_direct

    mysqli_fetch_field_direct

    (PHP 5, PHP 7, PHP 8)

    mysqli_result::fetch_field_direct -- mysqli_fetch_field_direct — Fetch meta-data for a single field

    Description

    Object-oriented style

    publicmysqli_result::fetch_field_direct(int$index): object|false

    Procedural style

    mysqli_fetch_field_direct(mysqli_result$result, int$index): object|false

    Returns an object which contains field definition information from the specified 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().

    index

    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 index is available.

    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. As of PHP 8.1, this value is always 0.
    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 numeric 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 Name LIMIT 5";

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


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


    $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 Name LIMIT 5";

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


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


    mysqli_close($link);
    ?>

    The above examples will output:

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

    See Also

    To Top