- Documentation Library
- Table of Contents
- MySQL 3.23/4.0/4.1 Manual
- Table of Contents
- 11.1.3 C API 関数の説明
- 11.1.3.1 mysql_affected_rows()
- 11.1.3.2 mysql_change_user()
- 11.1.3.3 mysql_character_set_name()
- 11.1.3.4 mysql_close()
- 11.1.3.5 mysql_connect()
- 11.1.3.6 mysql_create_db()
- 11.1.3.7 mysql_data_seek()
- 11.1.3.8 mysql_debug()
- 11.1.3.9 mysql_drop_db()
- 11.1.3.10 mysql_dump_debug_info()
- 11.1.3.11 mysql_eof()
- 11.1.3.12 mysql_errno()
- 11.1.3.13 mysql_error()
- 11.1.3.14 mysql_escape_string()
- 11.1.3.15 mysql_fetch_field()
- 11.1.3.16 mysql_fetch_fields()
- 11.1.3.17 mysql_fetch_field_direct()
- 11.1.3.18 mysql_fetch_lengths()
- 11.1.3.19 mysql_fetch_row()
- 11.1.3.20 mysql_field_count()
- 11.1.3.21 mysql_field_seek()
- 11.1.3.22 mysql_field_tell()
- 11.1.3.23 mysql_free_result()
- 11.1.3.24 mysql_get_client_info()
- 11.1.3.25 mysql_get_client_version()
- 11.1.3.26 mysql_get_host_info()
- 11.1.3.27 mysql_get_proto_info()
- 11.1.3.28 mysql_get_server_info()
- 11.1.3.29 mysql_get_server_version()
- 11.1.3.30 mysql_info()
- 11.1.3.31 mysql_init()
- 11.1.3.32 mysql_insert_id()
- 11.1.3.33 mysql_kill()
- 11.1.3.34 mysql_list_dbs()
- 11.1.3.35 mysql_list_fields()
- 11.1.3.36 mysql_list_processes()
- 11.1.3.37 mysql_list_tables()
- 11.1.3.38 mysql_num_fields()
- 11.1.3.39 mysql_num_rows()
- 11.1.3.40 mysql_options()
- 11.1.3.41 mysql_ping()
- 11.1.3.42 mysql_query()
- 11.1.3.43 mysql_real_connect()
- 11.1.3.44 mysql_real_escape_string()
- 11.1.3.45 mysql_real_query()
- 11.1.3.46 mysql_reload()
- 11.1.3.47 mysql_row_seek()
- 11.1.3.48 mysql_row_tell()
- 11.1.3.49 mysql_select_db()
- 11.1.3.50 mysql_set_server_option()
- 11.1.3.51 mysql_shutdown()
- 11.1.3.52 mysql_sqlstate()
- 11.1.3.53 mysql_ssl_set()
- 11.1.3.54 mysql_stat()
- 11.1.3.55 mysql_store_result()
- 11.1.3.56 mysql_thread_id()
- 11.1.3.57 mysql_use_result()
- 11.1.3.58 mysql_warning_count()
- 11.1.3.59 mysql_commit()
- 11.1.3.60 mysql_rollback()
- 11.1.3.61 mysql_autocommit()
- 11.1.3.62 mysql_more_results()
- 11.1.3.63 mysql_next_result()
MYSQL *mysql_real_connect(MYSQL *mysql, const char
*host, const char *user, const char *passwd, const char *db,
unsigned int port, const char *unix_socket, unsigned long
client_flag)
説明
mysql_real_connect()
は、host で動作している MySQL
データベースエンジンへの接続を確立しようとします。mysql_real_connect()
が正常終了しなければ、他の API
関数（mysql_get_client_info()
を除く）を実行できません。
パラメータの指定方法を次に示します。
1 つ目のパラメータには、既存の
MYSQL構造体のアドレスを指定する。mysql_real_connect()を呼び出す前に、mysql_init()を呼び出してMYSQL構造体を初期化する必要がある。mysql_options()を使用すると、さまざまな接続オプションを変更できる。 See 項11.1.3.40. 「mysql_options()」。hostパラメータには、ホスト名または IP アドレスのどちらかを指定する。hostにNULLまたは文字列"localhost"を指定した場合、ローカルホストに接続するものとみなされる。OS がソケット（Unix）または名前付きパイプ（Windows）をサポートしている場合、TCP/IP の代わりにそれらを使用してサーバに接続する。userパラメータにはユーザの MySQL ログイン ID を指定する。userにNULLまたは空文字列""を指定した場合、現在のユーザを使用するものとみなされる。Unix では現在のログイン名が使用される。Windows で ODBC を使用する場合は、現在のユーザ名を明示的に指定する必要がある。 See 項11.2.2. 「ODBC アドミニストレータのフィールドの設定方法」。-
passwdパラメータにはuserのパスワードを指定する。passwdにNULLを指定した場合、userテーブルのエントリのパスワードフィールドに何も指定されていない（空である）ユーザだけがチェック対象となる。データベース管理者は、この機能を使用して、パスワードを指定しているかどうかによってユーザに異なる特権を与えるという MySQL 特権システムをセットアップできる。注意:パスワードの暗号化はクライアント API によって自動的に処理されるので、
mysql_real_connect()を呼び出す前にパスワードの暗号化は不要である。 dbパラメータにはデータベース名を指定する。dbがNULLではない場合、この値が接続のデフォルトデータベースとして設定される。portパラメータに 0 以外の値を指定した場合、この値が TCP/IP 接続のポート番号として使用される。注意: 接続のタイプはhostパラメータによって決定される。unix_socketパラメータにNULL以外の値を指定した場合、この文字列がソケットまたは名前付きパイプに使用される。注意: 接続のタイプはhostパラメータによって決定される。-
client_flagパラメータには通常 0 を指定するが、極めて特殊な状況では以下に示すフラグを組み合わせて指定できる。フラグ名 フラグの説明 CLIENT_COMPRESS圧縮プロトコルを使用。 CLIENT_FOUND_ROWS影響を受けたレコードの数ではなく、検索結果の（一致した）レコードの数を返す。 CLIENT_IGNORE_SPACE関数名の末尾の空白を無視する。すべての関数名を予約語とする。 CLIENT_INTERACTIVEアイドル状態が（ wait_timeout秒ではなく）interactive_timeout秒継続したら接続をクローズする。CLIENT_LOCAL_FILESLOAD DATA LOCALの処理を有効にする。CLIENT_MULTI_STATEMENTSクライアントが複数行クエリ（‘ ;’ をステートメントの区切りとする）を送信する可能性があることをサーバに通知する。このフラグが設定されていない場合、複数行クエリは無効。MySQL 4.1 の新機能。CLIENT_MULTI_RESULTSクライアントが複数クエリまたはストアドプロシージャによって取得した複数の結果セットを処理できることをサーバに通知する。 CLIENT_MULTI_STATEMENTSが設定されている場合、このフラグは自動的に設定される。MySQL 4.1 の新機能。CLIENT_NO_SCHEMAdb_name.tbl_name.col_nameという構文の使用を禁止する。これは ODCB 向けの構文である。この構文を使用した場合、パーサでエラーが発生する。この構文は一部の ODBC プログラムでバグをトラップするために使用する。CLIENT_ODBCクライアントが ODBC 経由であることを通知する。この場合、 mysqldは ODBC クライアントに適した処理を行う。CLIENT_SSLSSL（暗号化プロトコル）を使用する。アプリケーションプログラムではこのフラグを設定しないこと。これはクライアントライブラリが内部で設定するフラグである。
戻り値
接続が正常に確立した場合は
MYSQL*
接続ハンドル。接続が確立しなかった場合は
NULL。接続が確立した場合、戻り値は
1 つ目のパラメータの値と同じです。
エラー
-
CR_CONN_HOST_ERRORMySQL サーバへの接続が確立しなかった。
-
CR_CONNECTION_ERRORローカルの MySQL サーバへの接続が確立しなかった。
-
CR_IPSOCK_ERRORIP ソケットの作成に失敗した。
-
CR_OUT_OF_MEMORYメモリが不足していた。
-
CR_SOCKET_CREATE_ERRORUnix ソケットの作成に失敗した。
-
CR_UNKNOWN_HOSTホスト名の IP アドレスが見つからなかった。
-
CR_VERSION_ERRORサーバに接続する際に、異なるプロトコルバージョンのクライアントライブラリを使用したために、プロトコルの不一致が発生した。このエラーは、
--old-protocolオプションを指定しないで起動した新しいバージョンのサーバに、非常に古いバージョンのクライアントライブラリを使用して接続を試みた場合に発生する可能性がある。 -
CR_NAMEDPIPEOPEN_ERRORWindows で名前付きパイプの作成に失敗した。
-
CR_NAMEDPIPEWAIT_ERRORWindows で名前付きパイプの待機に失敗した。
-
CR_NAMEDPIPESETSTATE_ERRORWindows でパイプハンドラの取得に失敗した。
-
CR_SERVER_LOSTconnect_timeoutが正の値であり、connect_timeout秒経過してもサーバに接続できなかった。またはinit-commandの実行中にサーバがダウンした。
例
MYSQL mysql;
mysql_init(&mysql);
mysql_options(&mysql,MYSQL_READ_DEFAULT_GROUP,"your_prog_name");
if (!mysql_real_connect(&mysql,"host","user","passwd","database",0,NULL,0))
{
fprintf(stderr, "Failed to connect to database: Error: %s\n",
mysql_error(&mysql));
}
この例では mysql_options()
を呼び出して MySQL ライブラリが
my.cnf ファイルの
[client] および
[your_prog_name]
セクションを読み込むように設定しています。このように設定することで、非標準的な方法でセットアップされた
MySQL
に対してもこのプログラムが正常に動作することを保証します。
注意:
接続が確立したとき、mysql_real_connect()
によって reconnect
フラグ（MYSQL
構造体の一部）の値が 1
に設定されます。このフラグは、接続が切断されてクエリを実行できない場合に、そこでクエリを終了せずに、サーバへの再接続を試みることを意味します。
This is a translation of the MySQL Reference Manual that can be found at dev.mysql.com. The original Reference Manual is in English, and this translation is not necessarily as up to date as the English version.
