PHP マニュアル: 単一のフィールドのメタデータを取得する

説明

オブジェクト指向型

public objectfalse mysqli_result::fetch_field_direct(int $index)

手続き型

objectfalse mysqli_fetch_field_direct(mysqli_result $result, int $index)

指定した結果セットから、フィールド定義情報を含むオブジェクトを返します。

パラメータ

result: 手続き型のみ: mysqli_query、mysqli_store_result、mysqli_use_result、mysqli_stmt_get_result が返す mysqli_result オブジェクト。
index: フィールド番号。この値は 0 から フィールド数 - 1 までの範囲でなければなりません。

戻り値

フィールド定義情報を含むオブジェクトを返します。もし、指定した index のフィールドの情報が取得できない場合は 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 Name LIMIT 5";

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

    /* カラム '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();
}

/* 接続を閉じます */
$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 Name LIMIT 5";

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

    /* カラム '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);
}

/* 接続を閉じます */
mysqli_close($link);
?>

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

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

参考

mysqli_num_fields
mysqli_fetch_field
mysqli_fetch_fields