MySQL 改良版拡張モジュール

はじめに
mysqli の概要
クイックスタートガイド
インストール/設定
mysqli 拡張モジュールでの持続的接続
定義済み定数
ノート
The MySQLi Extension Function Summary
mysqli — mysqli クラス
- mysqli::$affected_rows — 直前の MySQL の操作で変更された行の数を得る
- mysqli::autocommit — データベース更新の自動コミットをオンまたはオフにする
- mysqli::begin_transaction — トランザクションを開始する
- mysqli::change_user — 指定されたデータベース接続のユーザー名を変更する
- mysqli::character_set_name — データベース接続の現在の文字コードセットを返す
- mysqli::close — 事前にオープンしているデータベース接続を閉じる
- mysqli::commit — 現在のトランザクションをコミットする
- mysqli::$connect_errno — 直近の接続コールに関するエラーコードを返す
- mysqli::$connect_error — 直近の接続エラーの説明を返す
- mysqli::__construct — 新規に MySQL サーバーへの接続をオープンする
- mysqli::debug — デバッグ操作を行う
- mysqli::dump_debug_info — デバッグ情報をログに出力する
- mysqli::$errno — 直近の関数コールによるエラーコードを返す
- mysqli::$error_list — 直近で実行したコマンドからのエラーの一覧を返す
- mysqli::$error — 直近のエラーの内容を文字列で返す
- mysqli::execute_query — SQL文を準備し、変数をバインドし、実行する
- mysqli::$field_count — 直近のクエリのカラムの数を返す
- mysqli::get_charset — 文字セットオブジェクトを返す
- mysqli::$client_info — MySQL クライアント情報を取得する
- mysqli::$client_version — MySQL クライアントのバージョンを整数値で返す
- mysqli::get_connection_stats — クライアント接続に関する統計情報を返す
- mysqli::$host_info — 使用している接続の型を文字列で返す
- mysqli::$protocol_version — 使用している MySQL プロトコルのバージョンを返す
- mysqli::$server_info — MySQL サーバーのバージョンを返す
- mysqli::$server_version — MySQL サーバーのバージョンを整数値で返す
- mysqli::get_warnings — SHOW WARNINGS の結果を取得する
- mysqli::$info — 直近に実行されたクエリの情報を取得する
- mysqli::init — MySQLi を初期化し、mysqli_real_connect() で使うオブジェクトを返す
- mysqli::$insert_id — 直近のクエリの AUTO_INCREMENT カラムで生成した値を返す
- mysqli::kill — サーバーに MySQL スレッドの停止を問い合わせる
- mysqli::more_results — マルチクエリからの結果がまだ残っているかどうかを調べる
- mysqli::multi_query — データベース上でひとつ以上のクエリを実行する
- mysqli::next_result — multi_query の、次の結果を準備する
- mysqli::options — オプションを設定する
- mysqli::ping — サーバーとの接続をチェックし、もし切断されている場合は再接続を試みる
- mysqli::poll — 接続を問い合わせる
- mysqli::prepare — 実行するための SQL文を準備する
- mysqli::query — データベース上でクエリを実行する
- mysqli::real_connect — mysql サーバーとの接続をオープンする
- mysqli::real_escape_string — 接続の現在の文字セットを考慮して、SQL 文で使用する文字列の特殊文字をエスケープする
- mysqli::real_query — SQL クエリを実行する
- mysqli::reap_async_query — 非同期クエリから結果を取得する
- mysqli::refresh — リフレッシュする
- mysqli::release_savepoint — 現在のトランザクションのセーブポイント群から、指定した名前のセーブポイントを削除する
- mysqli::rollback — 現在のトランザクションをロールバックする
- mysqli::savepoint — トランザクションのセーブポイントを設定する
- mysqli::select_db — クエリを実行するためのデフォルトのデータベースを選択する
- mysqli::set_charset — クライアントの文字セットを設定する
- mysqli::$sqlstate — 直前の MySQL の操作での SQLSTATE エラーを返す
- mysqli::ssl_set — SSL を使用したセキュアな接続を確立する
- mysqli::stat — 現在のシステム状態を取得する
- mysqli::stmt_init — ステートメントを初期化し、mysqli_stmt_prepare で使用するオブジェクトを返す
- mysqli::store_result — 直近のクエリから結果セットを転送する
- mysqli::$thread_id — 現在の接続のスレッド ID を返す
- mysqli::thread_safe — スレッドセーフであるかどうかを返す
- mysqli::use_result — 結果セットの取得を開始する
- mysqli::$warning_count — 指定した接続の直近のクエリから発生した警告の数を返す
mysqli_stmt — mysqli_stmt クラス
- mysqli_stmt::$affected_rows — 直近に実行されたステートメントで変更・削除・追加、あるいは選択された行の総数を返す
- mysqli_stmt::attr_get — ステートメントの属性の現在の値を取得する
- mysqli_stmt::attr_set — プリペアドステートメントの振る舞いを変更する
- mysqli_stmt::bind_param — プリペアドステートメントのパラメータに変数をバインドする
- mysqli_stmt::bind_result — 結果を保存するため、プリペアドステートメントに変数をバインドする
- mysqli_stmt::close — プリペアドステートメントを閉じる
- mysqli_stmt::__construct — 新しい mysqli_stmt オブジェクトを構築する
- mysqli_stmt::data_seek — バッファリングされた結果中の、任意の行にポインタを移動する
- mysqli_stmt::$errno — 直近のステートメントのコールに関するエラーコードを返す
- mysqli_stmt::$error_list — 直近で実行したステートメントからのエラーの一覧を返す
- mysqli_stmt::$error — 直近のステートメントのエラー内容を文字列で返す
- mysqli_stmt::execute — プリペアドステートメントを実行する
- mysqli_stmt::fetch — プリペアドステートメントから結果を取得し、バインド変数に格納する
- mysqli_stmt::$field_count — 指定したステートメントのカラム数を返す
- mysqli_stmt::free_result — 指定したステートメントハンドルの結果を格納したメモリを開放する
- mysqli_stmt::get_result — プリペアドステートメントから結果を mysqli_result オブジェクトとして取得する
- mysqli_stmt::get_warnings — SHOW WARNINGS の結果を取得する
- mysqli_stmt::$insert_id — 直近の INSERT 操作で生成した ID を取得する
- mysqli_stmt::more_results — 複数クエリで、次の結果が存在するかどうかを調べる
- mysqli_stmt::next_result — 複数クエリから、次の結果を読み込む
- mysqli_stmt::$num_rows — サーバーから取得した結果セットの行数を返す
- mysqli_stmt::$param_count — 指定したステートメントのパラメータ数を返す
- mysqli_stmt::prepare — SQL ステートメントを実行するために準備する
- mysqli_stmt::reset — プリペアドステートメントをリセットする
- mysqli_stmt::result_metadata — プリペアドステートメントから結果セットのメタデータを返す
- mysqli_stmt::send_long_data — データをブロックで送信する
- mysqli_stmt::$sqlstate — 直前のステートメントの操作での SQLSTATE エラーを返す
- mysqli_stmt::store_result — 内部バッファに結果を保存する
mysqli_result — mysqli_result クラス
- mysqli_result::__construct — mysqli_result オブジェクトを構築する
- mysqli_result::$current_field — 結果ポインタにおける現在のフィールドオフセットを取得する
- mysqli_result::data_seek — 結果の任意の行にポインタを移動する
- mysqli_result::fetch_all — 結果のすべての行を連想配列・数値添字配列あるいはその両方の形式で取得する
- mysqli_result::fetch_array — 結果セットの次の行を連想配列・数値添字配列あるいはその両方の形式で取得する
- mysqli_result::fetch_assoc — 結果セットの次の行を連想配列で取得する
- mysqli_result::fetch_column — 結果セットの次の行から、単一のカラムの値を取得する
- mysqli_result::fetch_field_direct — 単一のフィールドのメタデータを取得する
- mysqli_result::fetch_field — 結果セットの次のフィールドを返す
- mysqli_result::fetch_fields — 結果セットのフィールド情報をオブジェクトの配列で返す
- mysqli_result::fetch_object — 結果セットの次の行を取得し、オブジェクトとして返す
- mysqli_result::fetch_row — 結果セットの次の行を数値添字配列で取得する
- mysqli_result::$field_count — 結果セットのフィールド数を取得する
- mysqli_result::field_seek — 結果ポインタを、指定したフィールドオフセットに設定する
- mysqli_result::free — 結果に関連付けられたメモリを開放する
- mysqli_result::getIterator — 外部イテレータを取得する
- mysqli_result::$lengths — 結果セットにおける現在の行のカラムの長さを返す
- mysqli_result::$num_rows — 結果セットの行数を取得する
mysqli_driver — mysqli_driver クラス
- mysqli_driver::embedded_server_end — 組み込みサーバーを停止する
- mysqli_driver::embedded_server_start — 組み込みサーバーを初期化して開始する
- mysqli_driver::$report_mode — mysqli のエラー報告モードを設定する
mysqli_warning — mysqli_warning クラス
- mysqli_warning::__construct — インスタンス化を禁止するための private なコンストラクタ
- mysqli_warning::next — 次の警告を取得する
mysqli_sql_exception — mysqli_sql_exception クラス
- mysqli_sql_exception::getSqlState — SQLSTATE エラーコードを含む情報を返す
エイリアスおよび非推奨の Mysqli 関数
- mysqli_connect — mysqli::__construct のエイリアス
- mysqli::escape_string — mysqli_real_escape_string のエイリアス
- mysqli_execute — mysqli_stmt_execute のエイリアス
- mysqli_get_client_stats — プロセスごとのクライアントの統計を返す
- mysqli_get_links_stats — オープン済みとキャッシュ済みのリンクに関する情報を返す
- mysqli_report — mysqli_driver->report_mode のエイリアス
- mysqli::set_opt — mysqli_options のエイリアス
変更履歴

mysqli クラス

はじめに

PHP と MySQL データベースの間の接続を表します。

クラス概要

mysqli

/* プロパティ */

public readonly intstring $affected_rows;

public readonly string $client_info;

public readonly int $client_version;

public readonly int $connect_errno;

public readonly stringnull $connect_error;

public readonly int $errno;

public readonly string $error;

public readonly array $error_list;

public readonly int $field_count;

public readonly string $host_info;

public readonly stringnull $info;

public readonly intstring $insert_id;

public readonly string $server_info;

public readonly int $server_version;

public readonly string $sqlstate;

public readonly int $protocol_version;

public readonly int $thread_id;

public readonly int $warning_count;

/* メソッド */

public __construct(
    stringnull $hostname = null,
    stringnull $username = null,
    stringnull $password = null,
    stringnull $database = null,
    intnull $port = null,
    stringnull $socket = null
)

public bool autocommit(bool $enable)

public bool begin_transaction(int $flags = 0, stringnull $name = null)

public bool change_user(string $username, string $password, stringnull $database)

public string character_set_name()

public true close()

public bool commit(int $flags = 0, stringnull $name = null)

public bool connect(
    stringnull $hostname = null,
    stringnull $username = null,
    stringnull $password = null,
    stringnull $database = null,
    intnull $port = null,
    stringnull $socket = null
)

public true debug(string $options)

public bool dump_debug_info()

public mysqli_resultbool execute_query(string $query, arraynull $params = null)

public objectnull get_charset()

public string get_client_info()

public array get_connection_stats()

public string get_server_info()

public mysqli_warningfalse get_warnings()

public boolnull init()

public bool kill(int $process_id)

public bool more_results()

public bool multi_query(string $query)

public bool next_result()

public bool options(int $option, stringint $value)

public bool ping()

public static intfalse poll(
    arraynull &$read,
    arraynull &$error,
    array &$reject,
    int $seconds,
    int $microseconds = 0
)

public mysqli_stmtfalse prepare(string $query)

public mysqli_resultbool query(string $query, int $result_mode = MYSQLI_STORE_RESULT)

public bool real_connect(
    stringnull $hostname = null,
    stringnull $username = null,
    stringnull $password = null,
    stringnull $database = null,
    intnull $port = null,
    stringnull $socket = null,
    int $flags = 0
)

public string real_escape_string(string $string)

public bool real_query(string $query)

public mysqli_resultbool reap_async_query()

public bool refresh(int $flags)

public bool release_savepoint(string $name)

public bool rollback(int $flags = 0, stringnull $name = null)

public bool savepoint(string $name)

public bool select_db(string $database)

public bool set_charset(string $charset)

public true ssl_set(
    stringnull $key,
    stringnull $certificate,
    stringnull $ca_certificate,
    stringnull $ca_path,
    stringnull $cipher_algos
)

public stringfalse stat()

public mysqli_stmtfalse stmt_init()

public mysqli_resultfalse store_result(int $mode = 0)

public bool thread_safe()

public mysqli_resultfalse use_result()

mysqli_stmt クラス

はじめに

プリペアドステートメントを表します。

クラス概要

mysqli_stmt

/* プロパティ */

public readonly intstring $affected_rows;

public readonly intstring $insert_id;

public readonly intstring $num_rows;

public readonly int $param_count;

public readonly int $field_count;

public readonly int $errno;

public readonly string $error;

public readonly array $error_list;

public readonly string $sqlstate;

public int $id;

/* メソッド */

public __construct(mysqli $mysql, stringnull $query = null)

public int attr_get(int $attribute)

public bool attr_set(int $attribute, int $value)

public bool bind_param(string $types, mixed &$var, mixed &...$vars)

public bool bind_result(mixed &$var, mixed &...$vars)

public true close()

public void data_seek(int $offset)

public bool execute(arraynull $params = null)

public boolnull fetch()

public void free_result()

public mysqli_resultfalse get_result()

public mysqli_warningfalse get_warnings()

public bool more_results()

public bool next_result()

public intstring num_rows()

public bool prepare(string $query)

public bool reset()

public mysqli_resultfalse result_metadata()

public bool send_long_data(int $param_num, string $data)

public bool store_result()

プロパティ

id: プリペアドステートメントの ID を保持します。

mysqli_result クラス

はじめに

データベースへのクエリにより得られた結果セットを表します。

クラス概要

mysqli_result

implements IteratorAggregate

/* プロパティ */

public readonly int $current_field;

public readonly int $field_count;

public readonly arraynull $lengths;

public readonly intstring $num_rows;

public int $type;

/* メソッド */

public __construct(mysqli $mysql, int $result_mode = MYSQLI_STORE_RESULT)

public bool data_seek(int $offset)

public array fetch_all(int $mode = MYSQLI_NUM)

public arraynullfalse fetch_array(int $mode = MYSQLI_BOTH)

public arraynullfalse fetch_assoc()

public nullintfloatstringfalse fetch_column(int $column = 0)

public objectfalse fetch_field_direct(int $index)

public objectfalse fetch_field()

public array fetch_fields()

public objectnullfalse fetch_object(string $class = "stdClass", array $constructor_args = [])

public arraynullfalse fetch_row()

public true field_seek(int $index)

public void free()

public void close()

public void free_result()

public Iterator getIterator()

プロパティ

type: 結果セットをバッファリングするか、しないかを整数で設定します。 (バッファリングする場合は MYSQLI_STORE_RESULT を、しない場合は MYSQLI_USE_RESULT をそれぞれ設定します)

変更履歴

バージョン	説明
8.0.0	mysqli_result は、 IteratorAggregate を実装するようになりました。これより前のバージョンでは、 Traversable を実装していました。

mysqli_driver クラス

はじめに

mysqli_driver クラスは、monostate パターンのインスタンスです。つまり、任意の数の mysqli_driver インスタンスからアクセスできるドライバはたったひとつということです。

クラス概要

final mysqli_driver

/* プロパティ */

public readonly string $client_info;

public readonly int $client_version;

public readonly int $driver_version;

public int $report_mode;

プロパティ

client_info: クライアント API ヘッダのバージョン
client_version: クライアントのバージョン
driver_version: MySQLi ドライバのバージョン

警告
このプロパティは、PHP 8.1.0 で 非推奨 になります。このプロパティに頼らないことを強く推奨します。
embedded: MySQLi Embedded のサポートが有効かどうか

警告
このプロパティは、PHP 8.0.0 で削除されました。
reconnect: 再接続を許可するかどうか (INI 設定 mysqli.reconnect を参照ください)

警告
このプロパティは、INI ディレクティブ mysqli.reconnect と一緒に、PHP 8.2.0 で 削除されました。
report_mode: MYSQLI_REPORT_OFF、 MYSQLI_REPORT_ALL あるいは以下の MYSQLI_REPORT_STRICT (エラー時に例外をスローする)、 MYSQLI_REPORT_ERROR (エラーを報告する) および MYSQLI_REPORT_INDEX (インデックス関連のエラーを報告する) の組み合わせを設定します。 mysqli_report も参照ください。

変更履歴

バージョン	説明
8.2.0	mysqli_driver::$reconnect が削除されました。
8.1.0	mysqli_driver::$driver_version は推奨されなくなりました。
8.0.0	mysqli_driver::$embedded が削除されました。
7.4.0	mysqli_driver::embedded_server_start と mysqli_driver:embedded_server_end が削除されました。

mysqli_warning クラス

はじめに

MySQL の警告を表します。

クラス概要

final mysqli_warning

/* プロパティ */

public string $message;

public string $sqlstate;

public int $errno;

/* メソッド */

private __construct()

public bool next()

プロパティ

message: メッセージ文字列
sqlstate: SQL state
errno: エラー番号

mysqli_sql_exception クラス

はじめに

mysqli の例外を処理するクラスです。

クラス概要

final mysqli_sql_exception

extends RuntimeException

/* プロパティ */

protected string $sqlstate = "00000";

/* 継承したプロパティ */

protected string $message = "";

private string $string = "";

protected int $code;

protected string $file = "";

protected int $line;

private array $trace = [];

private Throwablenull $previous = null;

/* メソッド */

public string mysqli_sql_exception::getSqlState()

/* 継承したメソッド */

public Exception::__construct(string $message = "", int $code = 0, Throwablenull $previous = null)

final public string Exception::getMessage()

final public Throwablenull Exception::getPrevious()

final public int Exception::getCode()

final public string Exception::getFile()

final public int Exception::getLine()

final public array Exception::getTrace()

final public string Exception::getTraceAsString()

public string Exception::__toString()

private void Exception::__clone()

プロパティ

sqlstate: エラーの SQLSTATE。