php8.5
Home/ Manual/ mysqli / mysqli_result/ mysqli_result::fetch_field_direct

mysqli_result::fetch_field_direct

PHP function Edit on GitHub ✎

(PHP 5, PHP 7, PHP 8)

Fetch meta-data for a single field

Description

Oop

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

Procedural

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

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.

Examples

Oop

php
<?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();
?>

Procedural

php
<?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);
?>

Outputs

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

See Also

Source: reference/mysqli/mysqli_result/fetch-field-direct.xml · from the official PHP manual (php/doc-en)