php8.5
Home/ Manual/ mysql / functions/ mysql_field_flags

mysql_field_flags

PHP function Edit on GitHub ✎

(PHP 4, PHP 5)

Get the flags associated with the specified field in a result

Note mysqli_fetch_field_direct [flags]PDOStatement::getColumnMeta [flags]

Description

mysql_field_flags(resource $result, int $field_offset): string|false

mysql_field_flags() returns the field flags of the specified field. The flags are reported as a single word per flag separated by a single space, so that you can split the returned value using explode().

Parameters

Return Values

Returns a string of flags associated with the resultFalseforfailure.

The following flags are reported, if your version of MySQL is current enough to support them: "not_null", "primary_key", "unique_key", "multiple_key", "blob", "unsigned", "zerofill", "binary", "enum", "auto_increment" and "timestamp".

Examples

A mysql_field_flags() example

php
<?php
$result = mysql_query("SELECT id,email FROM people WHERE id = '42'");
if (!$result) {
    echo 'Could not run query: ' . mysql_error();
    exit;
}
$flags = mysql_field_flags($result, 0);

echo $flags;
print_r(explode(' ', $flags));
?>

The above example will output something similar to:

output
not_null primary_key auto_increment
Array
(
    [0] => not_null
    [1] => primary_key
    [2] => auto_increment
)

Notes

See Also

Source: reference/mysql/functions/mysql-field-flags.xml · from the official PHP manual (php/doc-en)