mysqli_stmt::result_metadata

mysqli_stmt_result_metadata

プリペアドステートメントから結果セットのメタデータを返す

説明

オブジェクト指向型

public mysqli_resultfalse mysqli_stmt::result_metadata()

手続き型

mysqli_resultfalse mysqli_stmt_result_metadata(mysqli_stmt $statement)

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

この関数は空の mysqli_result オブジェクトを返します。これにより、実際のデータ行を取得せずに、プリペアドステートメントからメタデータ情報にアクセスできます。 mysqli_stmt_get_result を使用して、プリペアドステートメントから結果オブジェクトとして結果セット全体を取得する場合、この関数を使用する必要はありません。

注意:
この結果セットは、結果セットのメタデータをフィールドベースで処理する関数にのみ渡せます。渡せる関数の例として、以下が挙げられます:

mysqli_num_fields

mysqli_fetch_field

mysqli_fetch_field_direct

mysqli_fetch_fields

mysqli_field_count

mysqli_field_seek

mysqli_field_tell

mysqli_free_result

注意: mysqli_stmt_result_metadata が返す結果セットにはメタデータのみが含まれています。実際の行データは含まれません。行データを取得するには、ステートメントハンドルを mysqli_stmt_get_result または、 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);
?>

例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_prepare
mysqli_free_result
mysqli_stmt_get_result