mysqli_result::fetch_field

mysqli_fetch_field

(PHP 5, PHP 7, PHP 8)

mysqli_result::fetch_field -- mysqli_fetch_field結果セットの次のフィールドを返す

説明

オブジェクト指向型

public mysqli_result::fetch_field(): object|false

手続き型

mysqli_fetch_field(mysqli_result $result): object|false

結果セットから ひとつのカラムの情報をオブジェクトとして返します。この関数を 繰り返しコールすることで、結果セットのすべてのカラムについての情報が 取得可能です。

パラメータ

result

手続き型のみ: mysqli_query()mysqli_store_result()mysqli_use_result()mysqli_stmt_get_result() が返す mysqli_result オブジェクト。

戻り値

フィールド定義情報を含むオブジェクトを返します。もし フィールドの情報が取得できない場合は、false を返します。

オブジェクトのプロパティ
プロパティ 説明
name カラムの名前。
orgname エイリアスが指定されている場合の、本来の名前。
table フィールドが属するテーブルの名前 (演算をしていない場合)。
orgtable エイリアスが指定されている場合の、本来のテーブル名。
def 未使用。常に空文字列になります。
db データベースの名前。
catalog 未使用。常に "def" になります。
max_length 結果セットにおけるフィールドの最大幅。PHP 8.1 以降では、この値は常に 0 です。
length テーブルの定義で指定されているフィールド幅 (バイト単位)。 文字列型のカラムの場合、 値の長さは接続の文字セットによって異なります。 たとえば文字セットが latin1、 つまりシングルバイトの文字セットの場合、 クエリ SELECT 'abc' の値の長さは3になります。 一方で文字セットが utf8mb4 の場合、 つまりマルチバイトの文字セットの場合、 文字は4バイトまでの長さをとります。値の長さは12になります。
charsetnr フィールドの文字セット番号。
flags フィールドのビットフラグを整数型で表す。
type フィールドのデータ型。
decimals 数値型のフィールドの場合の桁数。時間フィールドの場合は、秒単位の精度。

例1 オブジェクト指向型

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

例2 手続き型

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

上の例の出力は以下となります。

Name:     Name
Table:    Country
max. Len: 11
Flags:    1
Type:     254

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

参考

add a note

User Contributed Notes 8 notes

up
52
iansoko at hotmail dot com
13 years ago
here are the data types that correspond to the TYPE number returned by fetch_field. thought i would post this here since i couldn't find the info elsewhere.numerics -------------BIT: 16TINYINT: 1BOOL: 1SMALLINT: 2MEDIUMINT: 9INTEGER: 3BIGINT: 8SERIAL: 8FLOAT: 4DOUBLE: 5DECIMAL: 246NUMERIC: 246FIXED: 246dates------------DATE: 10DATETIME: 12TIMESTAMP: 7TIME: 11YEAR: 13strings & binary------------CHAR: 254VARCHAR: 253ENUM: 254SET: 254BINARY: 254VARBINARY: 253TINYBLOB: 252BLOB: 252MEDIUMBLOB: 252TINYTEXT: 252TEXT: 252MEDIUMTEXT: 252LONGTEXT: 252
up
15
ragtag at hotmail dot com
16 years ago
The flags used by MySql are:                                                                                                                                                   NOT_NULL_FLAG = 1                                                                                     PRI_KEY_FLAG = 2                                                                                      UNIQUE_KEY_FLAG = 4                                                                                   BLOB_FLAG = 16                                                                                        UNSIGNED_FLAG = 32                                                                                    ZEROFILL_FLAG = 64                                                                                    BINARY_FLAG = 128                                                                                     ENUM_FLAG = 256                                                                                       AUTO_INCREMENT_FLAG = 512                                                                             TIMESTAMP_FLAG = 1024                                                                                 SET_FLAG = 2048                                                                                       NUM_FLAG = 32768                                                                                      PART_KEY_FLAG = 16384                                                                                 GROUP_FLAG = 32768                                                                                    UNIQUE_FLAG = 65536                                                                            To test if a flag is set you can use & like so:<?php$meta = $mysqli_result_object->fetch_field();if ($meta->flags & 4) {   echo 'Unique key flag is set'; } ?>
up
3
andre at koethur dot de
11 years ago
Here are two methods for converting the 'type' and 'flags' attributes to text for debugging purposes. They both use the predefined MYSQLI_ constants to generate the text.<?phppublic static function h_type2txt($type_id){    static $types;    if (!isset($types))    {        $types = array();        $constants = get_defined_constants(true);        foreach ($constants['mysqli'] as $c => $n) if (preg_match('/^MYSQLI_TYPE_(.*)/', $c, $m)) $types[$n] = $m[1];    }    return array_key_exists($type_id, $types)? $types[$type_id] : NULL;}public static function h_flags2txt($flags_num){    static $flags;    if (!isset($flags))    {        $flags = array();        $constants = get_defined_constants(true);        foreach ($constants['mysqli'] as $c => $n) if (preg_match('/MYSQLI_(.*)_FLAG$/', $c, $m)) if (!array_key_exists($n, $flags)) $flags[$n] = $m[1];    }    $result = array();    foreach ($flags as $n => $t) if ($flags_num & $n) $result[] = $t;    return implode(' ', $result);}?>
up
1
sofe2038 at gmail dot com
7 years ago
The constants in a few other comments above appear to be inaccurate. Here are some more official references that seem quite hard to search.The "type" attribute: https://dev.mysql.com/doc/internals/en/com-query-response.html#column-typeThe "flags" attribute: https://github.com/google/mysql/blob/master/include/mysql_com.h#L133In addition, all attributes are explained on the COM_QUERY_RESPONSE page too: https://dev.mysql.com/doc/internals/en/com-query-response.html#column-definition
up
1
rvila at revolutionvisualarts dot com
8 years ago
The predefined constant values returned by the function get_predefined_constants() for:MYSQLI_TYPE_CHAR = 1MYSQLI _TYPE_TINYINT = 1If the code is used to categorized the type of field use this values will of course create confusion. For example:if($fieldtype === "CHAR"){    $field_html_attribute = "text";    $field_html_length = 1;} elseif($fieldtype === "TINYINT") {    $field_html_attribute = "number";    $field_html_length = 1;}If an array is created to set the key as the numeric value and the value of that key as the the text title, TINYINT will be replaced by CHAR value. But is this process is reversed, then the code will select TINYINT if the foreach statement set to break when the numeric value of the flag equals the value of the current key as the first intance.Base in the note added by Johnathan at http://php.net/manual/en/mysqli.field-count.php the values should be:CHAR = 254TINYINT = 1But predefined function attributes the value 254 to MYSQLI_TYPE_STRING.Just for FYI
up
2
miqrogroove at gmail dot com
12 years ago
Beware the values of the predefined constants.  They do not always correlate with the actual field types.  For example:MYSQLI_TYPE_BLOB: 252MYSQLI_TYPE_TINY_BLOB: 249MYSQLI_TYPE_MEDIUM_BLOB: 250MYSQLI_TYPE_LONG_BLOB: 251MySQLi will indeed return a value of 252 for a tinytext field, but as you can see, this does not correspond to the value of MYSQLI_TYPE_TINY_BLOB.
up
0
nick
7 years ago
It is not possible to get the values for an enum or set field through fetch_fields(). As far as I can tell this is because it hasn't been implemented in the mysqlnd api but whatever the reason it is not possible and you must issue a query like SHOW COLUMNS directly and interrogate the result to determine them.Incidentally you need to check the enum_flag rather than look for the enum_type to determine whether a field is enum or not. The type returned is usually some kind of string.
up
2
Anonymous
13 years ago
The constants for the TYPE number returned by fetch_field are enumerated here (MYSQLI_TYPE_*):http://php.net/manual/en/mysqli.constants.php
To Top