sqlite_query

SQLiteDatabase::query

(PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)

sqlite_query -- SQLiteDatabase::query — 指定したデータベースに対してクエリを実行し、結果ハンドルを返す

説明

resource sqlite_query ( resource $dbhandle , string $query [, int $result_type = SQLITE_BOTH [, string &$error_msg ]] )

resource sqlite_query ( string $query , resource $dbhandle [, int $result_type = SQLITE_BOTH [, string &$error_msg ]] )

オブジェクト指向型 (メソッド):

SQLiteResult SQLiteDatabase::query ( string $query [, int $result_type = SQLITE_BOTH [, string &$error_msg ]] )

指定したデータベースにより query で指定した SQL ステートメントを実行します。

パラメータ

dbhandle

SQLite データベースリソース。手続きに従って、 sqlite_open() から返されます。このパラメータは、オブジェクト指向言語型メソッドを使用する場合は不要です。

query

実行するクエリ

クエリ内のデータは適切にエスケープする必要があります。

result_type

オプションの result_type パラメータには定数を指定でき、返される配列の添字を定義します。 SQLITE_ASSOC を用いると、連想配列の添字(名前フィールド)のみが返されます。一方、SQLITE_NUM は、数値の添字(フィールド番号)のみを返します。SQLITE_BOTH は、連想配列の添字と数値の添字の両方を返します。 SQLITE_BOTH がこの関数のデフォルトです。

error_msg

もしエラーが発生した場合、ここに保存されます。SQL 構文のエラーは sqlite_last_error() 関数で取得することができないため、このパラメータが特に重要となります。

注意: (MySQL のような)他のデータベースエクステンションとの互換性のため、 2 種類の構文がサポートされています。推奨されるのは最初の構文で、dbhandle パラメータを関数の最初のパラメータとするものです。

返り値

この関数は結果ハンドルを返します。失敗した場合に FALSE を返します。レコードを返すクエリの場合、結果ハンドルは sqlite_fetch_array() や sqlite_seek() のような関数で使用することができます。

クエリの型によらず、この関数はクエリが失敗した場合にFALSE を返します。

sqlite_query() は、バッファリングされ、シーク可能な結果ハンドルを返します。これは、レコードにランダムにアクセスする必要がある小さなクエリの場合に有用です。バッファリングされた結果ハンドルは、結果全体を保持するためのメモリを確保し、結果が取得されるまでは値を返しません。データに連続的にアクセスしたい場合、かわりにより高性能な sqlite_unbuffered_query() を使用することが推奨されます。

変更履歴

バージョン	説明
5.1.0	`error_msg` パラメータが追加されました。

注意

警告

SQLiteは、セミコロンで区切られた複数のクエリを実行します。これにより、ファイルからロードするかスクリプトに埋め込んだ SQL をバッチ実行することができます。しかしながら、これは関数の結果が使用されない場合のみ動作します。使用されない場合、最初の SQL ステートメントのみ実行されます。関数 sqlite_exec() は常に複数の SQL ステートメントを実行します。

複数のクエリを実行する際、この関数の返り値は、エラーの場合に FALSEとなります。しかし、それ以外の場合は不定となります。 (成功した場合にTRUEとなるか、結果ハンドルを返す可能性があります)

参考

sqlite_unbuffered_query() - 事前取得していないクエリを実行し、全てのデータをバッファリングする
sqlite_array_query() - 指定したデータベースに対してクエリを実行し、配列を返す