mysqli::query

mysqli_query

(PHP 5, PHP 7, PHP 8)

mysqli::query -- mysqli_queryデータベース上でクエリを実行する

説明

オブジェクト指向型

public mysqli::query(string $query, int $result_mode = MYSQLI_STORE_RESULT): mysqli_result|bool

手続き型

mysqli_query(mysqli $mysql, string $query, int $result_mode = MYSQLI_STORE_RESULT): mysqli_result|bool

データベースに対してクエリ query を実行します。

警告

セキュリティ上の注意: SQLインジェクション

クエリに入力値を含める場合は、プリペアドステートメント を使うべきです。使わない場合、データを適切にフォーマットし、全ての文字列は mysqli_real_escape_string() を使ってエスケープしなければいけません。

DML (INSERT、UPDATE あるいは DELETE) 以外のクエリについては、 この関数は mysqli_real_query() に続けて mysqli_use_result() あるいは mysqli_store_result() をコールすることと同等です。

注意:

サーバーの max_allowed_packet よりも長いステートメントを mysqli_query() に渡した場合、 返ってくるエラーコードは MySQL Native Driver (mysqlnd) を使っているか MySQL Client Library (libmysqlclient) を使っているかで異なります。 それぞれ、次のように振る舞います。

  • Linux 上の mysqlnd では、エラーコード 1153 を返します。 エラーメッセージは got a packet bigger than max_allowed_packet bytes です。

  • Windows 上の mysqlnd では、エラーコード 2006 を返します。 エラーメッセージは server has gone away です。

  • すべてのプラットフォームの libmysqlclient では、エラーコード 2006 を返します。エラーメッセージは server has gone away です。

パラメータ

link

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

query

クエリ文字列。

result_mode

MySQLサーバーからどのように結果が返されたかを示す結果モード。 以下の3つの定数のうちのいずれかです。

MYSQLI_STORE_RESULT (デフォルト) - バッファリングされた結果セットを mysqli_result オブジェクトとして返します。

MYSQLI_USE_RESULT - バッファリングせずに結果セットを mysqli_result オブジェクトとして返します。 取得されるのを待っているレコードが存在する限り、 接続はビジーとなり、Commands out of sync エラーを返します。 このエラーを回避するには、全てのレコードをサーバーから取得するか、 結果セットを mysqli_free_result() 関数をコールすることで捨てなければいけません。

MYSQLI_ASYNC (mysqlnd で利用できます) - クエリを非同期実行します。よって結果セットはすぐには返されません。 このようなクエリから結果を取得するには、 mysqli_poll() を使います。 MYSQLI_STORE_RESULTMYSQLI_USE_RESULT と組み合わせて使います。

戻り値

失敗した場合に false を返します。 結果セットを生成するクエリ、 つまり SELECT, SHOW, DESCRIBE あるいは EXPLAIN が成功した場合は、mysqli_query()mysqli_result オブジェクトを返します。それ以外のクエリが成功した場合は、 mysqli_query()true を返します。

エラー / 例外

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

例1 mysqli::query() の例

オブジェクト指向型

<?php

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

/* 結果セットを返さないテーブルを作成します。*/
$mysqli->query("CREATE TEMPORARY TABLE myCity LIKE City");
printf("Table myCity successfully created.\n");

/* 結果セットを返す SELECT 文 */
$result = $mysqli->query("SELECT Name FROM City LIMIT 10");
printf("Select returned %d rows.\n", $result->num_rows);

/* 大量のデータを取得しなければならない場合、MYSQLI_USE_RESULT を使います */
$result = $mysqli->query("SELECT * FROM City", MYSQLI_USE_RESULT);

/* 注意: 全てのレコードが取得されるか、結果セットがクローズされるまで
サーバーとやりとりを行うあらゆる関数は実行できません。あらゆる呼び出しは
'out of sync' を返します */
$mysqli->query("SET @a:='this will not work'");

手続き型

<?php

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

/* 結果セットを返さないテーブルを作成します。*/
mysqli_query($link, "CREATE TEMPORARY TABLE myCity LIKE City");
printf("Table myCity successfully created.\n");

/* 結果セットを返す SELECT 文 */
$result = mysqli_query($link, "SELECT Name FROM City LIMIT 10");
printf("Select returned %d rows.\n", mysqli_num_rows($result));

/* 大量のデータを取得しなければならない場合、MYSQLI_USE_RESULT を使います */
$result = mysqli_query($link, "SELECT * FROM City", MYSQLI_USE_RESULT);

/* 注意: 全てのレコードが取得されるか、結果セットがクローズされるまで
サーバーとやりとりを行うあらゆる関数は実行できません。あらゆる呼び出しは
'out of sync' を返します */
mysqli_query($link, "SET @a:='this will not work'");

上の例の出力は、 たとえば以下のようになります。

Table myCity successfully created.
Select returned 10 rows.

Fatal error: Uncaught mysqli_sql_exception: Commands out of sync; you can't run this command now in...

参考