mysqli::options

mysqli_options

(PHP 5)

mysqli::options -- mysqli_options — オプションを設定する

説明

オブジェクト指向型

bool mysqli::options ( int $option , mixed $value )

手続き型

bool mysqli_options ( mysqli $link , int $option , mixed $value )

接続に関する追加オプションを設定し、接続の振る舞いに影響を与えるために使用します。

この関数は、いくつかのオプションを設定して複数回コールされることがあります。

mysqli_options() は、 mysqli_init() がコールされた後、 mysqli_real_connect() の前にコールしなければなりません。

パラメータ

link

手続き型のみ: mysqli_connect() あるいは mysqli_init() が返すリンク ID。

option

指定するオプション。以下の値のいずれかです。

**使用可能なオプション**
名前	説明
`MYSQLI_OPT_CONNECT_TIMEOUT`	接続のタイムアウト秒数 (PHP 5.3.1 以降、Windows 上での TCP/IP 接続をサポートします)。
`MYSQLI_OPT_LOCAL_INFILE`	LOAD LOCAL INFILE の使用可/不可。
`MYSQLI_INIT_COMMAND`	MySQL サーバーへの接続後に実行するコマンド。
`MYSQLI_READ_DEFAULT_FILE`	`my.cnf` の代わりに、指定した名前のファイルから設定を読み込みます。
`MYSQLI_READ_DEFAULT_GROUP`	`my.cnf` の指定した名前のグループ、あるいは `MYSQL_READ_DEFAULT_FILE` で指定したファイルから設定を読み込みます。
`MYSQLI_SERVER_PUBLIC_KEY`	RSA 公開鍵ファイル。SHA-256 ベースの認証で使います。

value

オプションに設定する値。

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

変更履歴

バージョン	説明
5.5.0	`MYSQLI_SERVER_PUBLIC_KEY` オプションが追加されました。

例

mysqli_real_connect() を参照ください。

注意

注意:
MySQLnd は常に、サーバーのデフォルト文字セットを想定しています。この文字セットは接続時のハンドシェイク/認証のときに送信され、これを mysqlnd が使います。

Libmysql が使うデフォルトの文字セットは my.cnf で設定したものです。あるいは明示的に mysqli_options() をコールして設定することもできます。これは、 mysqli_init() のあとで mysqli_real_connect() を実行する前にコールします。

参考

mysqli_init() - MySQLi を初期化し、mysqli_real_connect() で使用するリソースを返す
mysqli_real_connect() - mysql サーバーとの接続をオープンする