mysqli::prepare

mysqli_prepare

(PHP 5, PHP 7, PHP 8)

mysqli::prepare -- mysqli_prepare — 実行するための SQL文を準備する

説明

オブジェクト指向型

public mysqli::prepare(string $query): mysqli_stmt|false

手続き型

mysqli_prepare(mysqli $mysql, string $query): mysqli_stmt|false

SQL文を準備し、後でそれを操作するために使用するステートメントハンドルを返します。クエリは、単一の SQL文である必要があります。

SQL文のテンプレートには、ゼロ個以上のパラメータマーカ (?) を含めることができます。パラメータマーカは、プレースホルダとも呼ばれています。パラメータマーカは、SQL文を実行する前に mysqli_stmt_bind_param() を使用してアプリケーション変数にバインドする必要があります。

パラメータ

link

手続き型のみ: mysqli_connect() あるいは mysqli_init() が返す mysqliオブジェクト。

query

クエリを表す文字列。単一のSQL文である必要があります。

SQL文には、ゼロ個以上のパラメータマーカを含めることができますます。パラメータマーカはクエスチョンマーク(?) を適切な位置に置くことで埋め込みます。

注意:
パラメータのマーカは、それが SQL 文の適切な位置にある場合のみ有効です。例えば INSERT 文の VALUES() リストの中 (行に登録するカラムの値を指定する) や WHERE 句でカラムのデータと比較する値などが適切な位置の例です。しかし、識別子 (テーブルやカラムの名前) には使用できません。

戻り値

mysqli_prepare() はステートメントオブジェクトを返します。エラー時には false を返します。

エラー / 例外

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

例

例1 mysqli::prepare() の例

オブジェクト指向型

<?php

mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");

$city = "Amersfoort";

/* プリペアドステートメントを作成します。*/
$stmt = $mysqli->prepare("SELECT District FROM City WHERE Name=?");

/* マーカにパラメータをバインドします */
$stmt->bind_param("s", $city);

/* クエリを実行します */
$stmt->execute();

/* 結果変数をバインドします */
$stmt->bind_result($district);

/* 値を取得します */
$stmt->fetch();

printf("%s is in district %s\n", $city, $district);

手続き型

<?php

mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$link = mysqli_connect("localhost", "my_user", "my_password", "world");

$city = "Amersfoort";

/* プリペアドステートメントを作成します */
$stmt = mysqli_prepare($link, "SELECT District FROM City WHERE Name=?");

/* マーカにパラメータをバインドします */
mysqli_stmt_bind_param($stmt, "s", $city);

/* クエリを実行します */
mysqli_stmt_execute($stmt);

/* 結果変数をバインドします */
mysqli_stmt_bind_result($stmt, $district);

/* 値を取得します */
mysqli_stmt_fetch($stmt);

printf("%s is in district %s\n", $city, $district);

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

Amersfoort is in district Utrecht

参考

mysqli_stmt_execute() - プリペアドステートメントを実行する
mysqli_stmt_fetch() - プリペアドステートメントから結果を取得し、バインド変数に格納する
mysqli_stmt_bind_param() - プリペアドステートメントのパラメータに変数をバインドする
mysqli_stmt_bind_result() - 結果を保存するため、プリペアドステートメントに変数をバインドする
mysqli_stmt_get_result() - プリペアドステートメントから結果を mysqli_result オブジェクトとして取得する
mysqli_stmt_close() - プリペアドステートメントを閉じる