mysqli_stmt::result_metadata

    mysqli_stmt_result_metadata

    (PHP 5, PHP 7, PHP 8)

    mysqli_stmt::result_metadata -- mysqli_stmt_result_metadata — プリペアドステートメントから結果セットのメタデータを返す

    説明

    オブジェクト指向型

    public mysqli_stmt::result_metadata(): mysqli_result|false

    手続き型

    mysqli_stmt_result_metadata(mysqli_stmt $statement): mysqli_result|false

    mysqli_prepare() に渡したステートメントが 結果セットを返すものであった場合、mysqli_stmt_result_metadata() はオブジェクトを返します。このオブジェクトは、結果のフィールド数や 各フィールドの情報などのメタ情報を取得するために使用可能です。

    注意:

    メタデータを取得するには、この結果セットポインタを、以下のいずれかの (フィールドベースの) 関数に渡します。

    結果セットは、使用終了後に開放すべきです。そのためには、結果セットを mysqli_free_result() に渡します。

    注意:

    mysqli_stmt_result_metadata() が返す結果セットには メタデータのみが含まれています。実際の行データは含まれません。行データを 取得するには、ステートメントハンドルを mysqli_stmt_fetch() に渡してください。

    パラメータ

    stmt

    手続き型のみ: mysqli_stmt_init() が返す mysqli_stmt オブジェクト。

    戻り値

    結果のオブジェクトを返します。エラー時には false を返します。

    エラー / 例外

    mysqli のエラー報告 (MYSQLI_REPORT_ERROR) が有効になっており、かつ要求された操作が失敗した場合は、警告が発生します。さらに、エラー報告のモードが MYSQLI_REPORT_STRICT に設定されていた場合は、mysqli_sql_exception が代わりにスローされます。

    例

    例1 オブジェクト指向型

    <?php
    $mysqli     = new mysqli("localhost", "my_user", "my_password", "test");

    $mysqli->query("DROP TABLE IF EXISTS friends");
    $mysqli->query("CREATE TABLE friends (id int, name varchar(20))");

    $mysqli->query("INSERT INTO friends VALUES (1,'Hartmut'), (2, 'Ulf')");

    $stmt = $mysqli->prepare("SELECT id, name FROM friends");
    $stmt->execute();

    /* メタデータの結果セットを取得します */
    $result = $stmt->result_metadata();

    /* メタデータ結果セットからフィールド情報を取得します */
    $field = $result->fetch_field();

    printf("Fieldname: %s\n", $field->name);

    /* 結果セットを閉じます */
    $result->close();

    /* 接続を閉じます */
    $mysqli->close();
    ?>

    例2 手続き型

    <?php
    $link     = mysqli_connect("localhost", "my_user", "my_password", "test");

    mysqli_query($link, "DROP TABLE IF EXISTS friends");
    mysqli_query($link, "CREATE TABLE friends (id int, name varchar(20))");

    mysqli_query($link, "INSERT INTO friends VALUES (1,'Hartmut'), (2, 'Ulf')");

    $stmt = mysqli_prepare($link, "SELECT id, name FROM friends");
    mysqli_stmt_execute($stmt);

    /* メタデータの結果セットを取得します */
    $result = mysqli_stmt_result_metadata($stmt);

    /* メタデータ結果セットからフィールド情報を取得します */
    $field = mysqli_fetch_field($result);

    printf("Fieldname: %s\n", $field->name);

    /* 結果セットを閉じます */
    mysqli_free_result($result);

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

    参考

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 1 note

    up
    25
    potherca at gmail dot com
    14 years ago
    If result_metadata() returns false but error/errno/sqlstate tells you no error occurred, this means your query is one that does not produce a result set, i.e. an INSERT/UPDATE/DELETE query instead of a SELECT query.

    This is stated in the documentation where it says "If a statement passed to mysqli_prepare() is one that produces a result set, mysqli_stmt_result_metadata() returns the result object", but it might not be clear to everyone what this entails exactly.

    Hope this helps.
    ＋add a note
    To Top