他のバージョンの文書11 | 10 | 9.6 | 9.5 | 9.4 | 9.3 | 9.2 | 9.1 | 9.0 | 8.4 | 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2

31.1. データベース接続制御関数

PostgreSQLのバックエンドサーバとの接続を作成するには、以下の関数を使用します。 アプリケーションプログラムはバックエンドとの接続を一度に複数個開くことができます。 (1つの理由として、複数のデータベースへのアクセスが挙げられます。) 個々の接続は、PQconnectdbPQconnectdbParamsまたはPQsetdbLogin関数を呼び出すことで得られるPGconnオブジェクトによって表されます。 なお、これらの関数は、PGconnオブジェクトに割り当てるほんのわずかなメモリの余裕さえもない場合を除き、NULLではなく常にオブジェクトのポインタを返します。 また、この接続オブジェクトを通じて問い合わせを送る前に、PQstatus関数を呼び出して、データベースとの接続に成功したかどうかを検査しなければなりません。

警告

Unix上で、libpq接続を開いたプロセスのフォークは、親と子のプロセスが同じソケットとオペレーティングシステムの資源を共有するため、予期せぬ結果を招くことがあります。 この理由により、新規実行形式を子プロセスが読み込むためexecを行うことが安全と言っても、このような使用法は推奨されません。

注意: Windowsでは、単一のデータベース接続が反復して開始と終了を繰り返す場合、性能を向上させる方法があります。 内部的には、接続開始と終了に対して、それぞれlibpqはWSAStartup()WSACleanup()を呼び出します。 WSAStartup()WSACleanup()で値が減少させられた内部Windowsライブラリ参照カウントを増加させます。 参照カウントがたった1の場合、WSACleanup()呼び出しは全てのリソースを解放し、全てのDLLはアンロードされます。 これは高価な操作です。 これを回避するには、最後のデータベース接続が閉じられる時、リソースが解放されないようにアプリケーションが手動でWSAStartup()を呼び出すことができます。

PQconnectdbParams

新たにデータベースサーバへの接続を作成します。

PGconn *PQconnectdbParams(const char **keywords, const char **values, int expand_dbname);

この関数は、2つのNULL終端の配列から取得したパラメータを使用して、データベースとの接続を新たに1つ確立します。 1つ目は文字列配列として定義されるkeywordsで、それぞれがキーワードとなります。 2つ目はvaluesで、各キーワードの値を提供します。 後述のPQsetdbLoginとは異なり、関数のシグネチャを変更せずにパラメータ集合を拡張できますので、アプリケーションプログラムを新たに作成する際には、この関数(もしくは非ブロックモードでよく似た処理をするPQconnectStartParamsPQconnectPoll)を使用することをお勧めします。

expand_dbnameが非ゼロの場合、dbnameキーワードの値をconninfo文字列として認識させることができます。 以下を参照してください。

空の配列を渡してすべてデフォルトパラメータを使用することができます。 また渡される配列に1つ以上のパラメータ設定を持たせることもできます。 これらの長さは一致しなければなりません。 keywords配列の最後の非NULL要素で処理は停止します。

現時点で有効なパラメータのキーワードは以下に示す通りです。

host

接続するホスト名を指定します。 この引数をスラッシュで始めた場合、TCP/IPによる通信ではなく、Unixドメインの通信を明示することになります。 その場合、この値はソケットファイルを格納するディレクトリの名前になります。 hostが指定されなかった場合のデフォルトは、/tmpにあるUnixドメインのソケットに接続することです。 (または、PostgreSQLの構築時に指定した別のディレクトリにあるソケットです。) Unixドメインソケットを持たないマシンにおけるデフォルトは、localhostに接続することです。

hostaddr

接続するホストのIPアドレスを指定します。 これは、172.28.40.9といった標準的なIPv4アドレス書式でなければなりません。 使用するマシンでIPv6をサポートする場合は、そのアドレスを使用することもできます。 このパラメータに非空の文字列が指定されると、TCP/IP通信が常に使用されます。

hostの代わりにhostaddrを使用することで、アプリケーションがホスト名の検索を行なわずに済みます。 特に時間的制約があるアプリケーションでは重要になるでしょう。 しかし、Kerberos、GSSAPIおよびSSPI認証を行うアプリケーションでは、ホスト名が必要になります。 SSL証明書の完全な検証を行う場合も同様です。 以下の規則が使用されます。 hostaddrを使わずにhostを指定した場合は、ホスト名の検索が発生します。 hostを使わずにhostaddrを指定した場合、hostaddrはサーバのアドレスとなります。 ホスト名を必要する場合は接続試行が失敗します。 hosthostaddrの両方を指定した場合、hostaddrがサーバのアドレスとなります。 hostの値は認証や検証目的で必要とされない限り無視され、必要とされる場合にはホスト名として使用されます。 hosthostaddrに対応するマシンの名前と一致しない場合は、認証に失敗する可能性があるので注意してください。 また、hostaddrではなくhost~/.pgpass(項31.14を参照)での接続の識別に使用されます。

ホスト名もホストのアドレスも用いない場合、libpqはローカルのUnixドメインソケットを使用して接続します。 ただし、Unixドメインソケットを持たないマシンでは、localhostへの接続を試みます。

port

サーバホストでの接続用のポート番号、または、Unixドメイン接続の場合は、ソケットファイルの拡張子を指定します。

dbname

データベース名を指定します。 デフォルトはユーザ名と同じです。

user

データベースへ接続するPostgreSQLユーザ名を指定します。 デフォルトは、そのアプリケーションを実行しているユーザのオペレーティングシステム上の名前と同じです。

password

サーバがパスワードによる認証を必要とした場合に使用されるパスワードを指定します。

connect_timeout

接続用の最大待機時間を秒単位(10進数整数で表した文字列として記述してください)で指定します。 ゼロもしくは未設定は、無限時間の待機を意味します。 2秒未満の待機時間を使用することは勧めません。

options

実行時にサーバに送信するコマンドラインオプションを追加します。 例えば、これを-c geqo=offに設定すると、geqoパラメータのセッション値はoffになります。 有効なオプションに関する詳細は第18章を調べてください。

application_name

application_name設定パラメータの値を指定します。

fallback_application_name

application_name設定パラメータの予備値を指定します。 接続パラメータまたはPGAPPNAME環境変数によりapplication_nameの値が指定されない場合に、この値が使用されます。 予備の名前を指定することは、デフォルトのアプリケーション名を設定したいが、ユーザにもそれを上書きできるようにしておきたい、一般的なユーティリティプログラムで有用です。

keepalives

クライアント側におけるTCPキープアライブの使用を制御します。 デフォルト値は1であり、有効であることを意味します。 しかしキープアライブを望まない場合は、無効であることを意味するゼロに設定することができます。 このパラメータはUnixドメインソケット経由の接続では無視されます。

keepalives_idle

TCPがサーバにキープアライブメッセージを送信した後に活動を行わない期間を秒単位で制御します。 ゼロという値ではシステムのデフォルトを使用します。 Unixドメインソケット経由でなされた接続の場合もしくはキープアライブが無効な場合、このパラメータは無視されます。 これはTCP_KEEPIDLEソケットオプションまたはTCP_KEEPALIVEソケットオプションが利用できるシステムおよびWindowsでのみサポートされます。 他のシステムでは効果がありません。

keepalives_interval

TCPキープアライブメッセージに対する応答がサーバからない場合に、何秒後に再送を行うかを制御します。 ゼロという値ではシステムのデフォルトを使用します。 Unixドメインソケット経由でなされた接続の場合、またはキープアライブを無効にしている場合、このパラメータは無視されます。 これはTCP_KEEPINTVLソケットオプションが利用できるシステムおよびWindowsでのみサポートされます。 他のシステムでは効果がありません。

keepalives_count

サーバへのクライアント接続が不要になったとみなすまで、何回キープアライブの欠落を認めるかを制御します。 ゼロという値ではシステムのデフォルトを使用します。 Unixドメインソケット経由でなされた接続の場合、またはキープアライブを無効にしている場合、このパラメータは無視されます。 これはTCP_KEEPCNTソケットオプションが利用できるシステムでのみサポートされます。 他のシステムでは効果がありません。

tty

無視されます(以前は、これはサーバデバッグ出力を送信する場所を指定するものでした)。

sslmode

このオプションは、どのSSLによる安全なTCP/IP接続の優先度でサーバと調停するかを決定します。 6つのモードがあります。

表 31-1. sslmodeオプション

オプション説明
disableSSL接続のみ試行
allow最初に非SSL接続を試行。 失敗の場合SSL接続を試行
prefer(デフォルト)最初にSSL接続を試行。 失敗の場合、非SSL接続を試行
requireSSL接続のみ試行
verify-caSSL接続のみ試行し、サーバ証明書が信用されたCAから発行されたかを検証
verify-fullSSL接続のみ試行し、サーバ証明書が信用されたCAから発行されたか、およびそのサーバホスト名が証明書内のものと一致するかを検証

これらのオプションがどのように動くのかについては項31.17を参照してください。

sslmodeはUnixドメインソケット通信では無視されます。 SSLサポートなしでPostgreSQLがコンパイルされた場合に、requireverify-caverify-fullを使用するとエラーになります。 一方、allowpreferは使用できますが、実際にlibpqSSL接続を受け付けません。

requiressl

このオプションはsslmode設定を支持する観点から廃止予定になっています。

1に設定することで、サーバへのSSL接続が必要になります (これはsslmoderequireと同じです)。 サーバがSSL接続を受け付けない場合、Libpqは接続を拒絶します。 0(デフォルト)に設定することで、サーバと接続形式の調停を行います。 (sslmodepreferと同じです。) SSLサポート付きでPostgreSQLをコンパイルした場合にのみ、このオプションが利用できます。

sslcert

このパラメータは、~/.postgresql/postgresql.crtというデフォルトを置き換えるクライアントSSL証明書のファイル名を指定します。 このパラメータはSSL接続が確立していない場合は無視されます。

sslkey

このパラメータはクライアント証明書に対して使用される秘密鍵の場所を指定します。 デフォルトの~/.postgresql/postgresql.keyの代わりに使用されるファイル名、または外部"エンジン"(エンジンとはOpenSSLロード可能なモジュール)から得られるキーを指定することも可能です。 外部エンジンの指定にはコロンで区切ったエンジン名とエンジン特有の鍵識別子を含んでいなければなりません。 SSL接続が確立していない場合このパラメータは無視されます。

sslrootcert

このパラメータはSSL認証局(CA)の証明書のファイル名を指定します。 このファイルが存在する場合、サーバ証明書はこれらの認証局の1つで署名されているかどうか検証されます。 デフォルトは~/.postgresql/root.crtです。

sslcrl

このパラメータはSSL証明書失効リスト(CRL)のファイル名を指定します。 このファイルに列挙された証明書が存在した場合、それはサーバ証明書を承認しようとする時に拒絶されます。 デフォルトは~/.postgresql/root.crlです。

krbsrvname

Kerberos5またはGSSAPIの認証時に使われるKerberosサービス名です。 成功するためには、これはサーバのKerberos認証設定のサービス名と一致していなければなりません。 (項19.3.5および項19.3.3も参照してください。)

gsslib

GSSAPI認証で使用されるGSSライブラリです。 Windows上のみで使用されます。 libpqの認証がデフォルトのSSPIではなく、強制的にGSSAPIライブラリを使用させるにはgssapiを設定してください。

service

追加のパラメータ用に使用されるサービス名です。 pg_service.conf内の追加的な接続パラメータを保持するサービス名を指定します。 これによりアプリケーションはサービス名だけを指定でき、接続パラメータを集中的に保守できるようになります。 項31.15を参照してください。

パラメータが指定されなかった場合には、対応する環境変数がチェックされます(項31.13を参照してください)。 環境変数も設定されていない場合は、指定された組み込みのデフォルト値が使用されます。

expand_dbnameが非ゼロ、かつ、dbname=記号が含まれる場合、 PQconnectdbに渡された場合(後述)とまったく同じ方法でconninfoとして解釈されます。 これまで処理されたキーワードはconninfo文字列内のキーワードで上書きされます。

一般的にキーワードはこれらの配列の先頭からインデックス順で処理されます。 この影響はキーワードが繰り返された場合で、最後に処理された値が残ることになります。 このため、dbnameキーワードの記述場所に注意することで、conninfo文字列により何が上書きされるか、何が上書きされないかを決定することができます。

PQconnectdb

新たにデータベースサーバへの接続を作成します。

PGconn *PQconnectdb(const char *conninfo);

この関数はconninfo文字列から取得されるパラメータを使用して、新しいデータベース接続を開きます。

空の文字列を渡してすべてデフォルトパラメータを使用することができます。 また空白文字で区切ることで1つ以上のパラメータ設定を持たせることもできます。 各パラメータはkeyword = valueという形式で設定されます。 等号記号の前後の空白文字は省略可能です。 空の値を記述する、もしくは、空白文字を含む値を記述するためには、例えばkeyword = 'a value'のように単一引用符でくくってください。 値内の単一引用符およびバックスラッシュはバックスラッシュでエスケープ、つまり\'および\\のようにしなければなりません。

現在認識されるパラメータキーワードは前述の通りです。

PQsetdbLogin

新たにデータベースサーバへの接続を作成します。

PGconn *PQsetdbLogin(const char *pghost,
                     const char *pgport,
                     const char *pgoptions,
                     const char *pgtty,
                     const char *dbName,
                     const char *login,
                     const char *pwd);

これはパラメータ群を固定したPQconnectdbの前身です。 設定できないパラメータが常に固定値になる点を除き、同一の機能を持ちます。 固定したパラメータに対してNULLもしくは空文字列とすると、それはデフォルトを使用することになります。

dbName内に=記号が含まれる場合、PQconnectdbに渡された場合とまったく同じ扱いでconninfo文字列として扱われます。 その後残りのパラメータが上のように適用されます。

PQsetdb

新たにデータベースサーバへの接続を作成します。

PGconn *PQsetdb(char *pghost,
                char *pgport,
                char *pgoptions,
                char *pgtty,
                char *dbName);

これは、loginpwdにNULLポインタを設定するPQsetdbLoginを呼び出すマクロです。 非常に古いプログラムへの後方互換性のために提供されています。

PQconnectStartParams
PQconnectStart
PQconnectPoll

ブロックしない方法で、データベースサーバへの接続を作成します。

PGconn *PQconnectStartParams(const char **keywords, const char **values, int expand_dbname);

PGconn *PQconnectStart(const char *conninfo);

PostgresPollingStatusType PQconnectPoll(PGconn *conn);

これら3つの関数を使用して、リモートI/Oの実行時にアプリケーションスレッドの実行がブロックされないように、データベースサーバへの接続を作成します。 この手法の利点は、I/O の終了待ちがPQconnectdbParamsまたはPQconnectdb内部ではなく、アプリケーションプログラムのメインループでできることにあります。 これによって、アプリケーションは他の処理と並行してこの処理を管理することができます。

PQconnectStartParamsでは、上でPQconnectdbParamsで説明したように、データベース接続はkeywordsおよびvalues配列から取得され、expand_dbnameによって制御されたパラメータを使用して確立します。

PQconnectStartでは、上でPQconnectdbで説明したように、conninfo文字列から取得されたパラメータを使用してデータベース接続を確立します。

PQconnectStartParamsPQconnectStartPQconnectPollのどちらも以下の制限に適合する場合ブロックしません。

  • hostaddrhostパラメータは、ホスト名からのIPアドレス検索やホスト名の逆引きが起こらないように適切に使用されなければいけません。 これらのパラメータについての詳細は、前述のPQconnectdbParamsの節を参照してください。

  • PQtraceを呼び出す場合は、トレースに使用するストリームオブジェクトがブロックされないことが保証されていなくてはなりません。

  • プログラマ自身が、後に示すように、PQconnectPollを呼び出す前にソケットが適切な状態にあることを保証しなくてはいけません。

注意:PQconnectStartParamsの使用は後述のPQconnectStartと類似しています。

非ブロック接続要求を始めるにはまず、conn=PQconnectStart("connection_info_string")を呼び出します。 connがNULLの場合、libpqが新たにPGconn構造体を割り当てられなかったことを表します。 そうでない場合は、適切なPGconnへのポインタが返されます (ただし、データベースに正しく接続されていることを表しているわけではありません)。 PQconnectStartから値が返ってきた段階で、status=PQstatus(conn)を呼び出します。 もし、statusCONNECTION_BADと等しい場合には、PQconnectStartが失敗しています。

PQconnectStartが成功したら、次は接続シーケンスを進めるために、libpqをポーリングします。 データベース接続の背後にあるソケットの記述子を取り出すには、PQsocket(conn)を使用します。 以下の繰り返しです。 直前のPQconnectPoll(conn)PGRES_POLLING_READINGの場合、ソケットの読み込み準備が整うまで待機します。 (select()poll()などのシステム関数で示されます。) そして、再度PQconnectPoll(conn)を呼び出します。 反対に直前のPQconnectPoll(conn)PGRES_POLLING_WRITINGの場合、ソケットの書き込み準備が整うまで待機し、その後、PQconnectPoll(conn)を再度呼び出します。 まだPQconnectPollを呼び出していない場合、つまり、PQconnectStartの呼び出し直後では、直前がPGRES_POLLING_WRITINGであった場合と同様の処理を行ないます。 この繰り返しをPQconnectPoll(conn)が、接続手続きの失敗を示すPGRES_POLLING_FAILED、もしくは、接続確立に成功したことを示すPGRES_POLLING_OKを返すまで継続します。

接続している間は、いつでもPQstatusを呼び出すことで、接続の状態を検査することができます。 この関数がCONNECTION_BADを返す場合、接続手続きは失敗しており、CONNECTION_OKを返す場合、接続が確立しています。 上述のように、このいずれの状態も、PQconnectPollの戻り値から同様に検出できます。 これ以外の状態は、非同期の接続手続きの間(のみに)現れることがあります。 これらは、接続プロシージャの現在の段階を示すものであり、例えばユーザへのフィードバックを提供することに使用できます。 以下の状態があります。

CONNECTION_STARTED

接続の確立待ち状態です。

CONNECTION_MADE

接続はOKです。送信待ち状態です。

CONNECTION_AWAITING_RESPONSE

サーバからの応答待ち状態です。

CONNECTION_AUTH_OK

認証済みです。バックエンドの起動待ち状態です。

CONNECTION_SSL_STARTUP

SSL暗号化の調停状態です。

CONNECTION_SETENV

環境が提供するパラメータ設定の調停状態です。

これらの定数は(互換性を保つため)なくなることはありませんが、アプリケーションは、これらが特定の順で出現したり、本書に書いてある値のどれかに必ずステータス値が該当するということを決して当てにしてはいけません。 アプリケーションは、以下に示すようにするべきです。

switch(PQstatus(conn))
{
    case CONNECTION_STARTED:
        feedback = "Connecting...";
        break;

    case CONNECTION_MADE:
        feedback = "Connected to server...";
        break;
.
.
.
    default:
        feedback = "Connecting...";
}

PQconnectPollを使用する場合、connect_timeout接続パラメータは無視されます。 経過時間が長過ぎるかどうかの判定はアプリケーションの責任で行ないます。 さもないと、PQconnectStartの後のPQconnectPollの繰り返しがPQconnectdbと同じになります。

PQconnectStartが非NULLポインタを返した場合、処理を終了する際には、構造体や関連するメモリブロックを始末するために、PQfinishを呼び出さなくてはならないことに注意してください。 この処理は、接続試行が失敗した場合やその試行を中断する場合にも、必ず実行されなければいけません。

PQconndefaults

デフォルトの接続オプションを返します。

PQconninfoOption *PQconndefaults(void);

typedef struct
{
    char   *keyword;   /* このオプションのキーワード */
    char   *envvar;    /* 代替となる環境変数の名前 */
    char   *compiled;  /* 代替となるコンパイル時に組み込まれたデフォルト値 */
    char   *val;       /* オプションの現在値、もしくは、NULL */
    char   *label;     /* 接続ダイアログ内の当該フィールドのラベル */
    char   *dispchar;  /* 接続ダイアログ内の当該フィールドをどのように表示するかの指示
                          値:
                          ""        入力された値をそのまま表示
                          "*"       値を隠すパスワードフィールド用
                          "D"       デバッグオプション。デフォルトで何も表示しません */
    int     dispsize;  /* ダイアログ用のフィールドの大きさ(文字数単位) */
} PQconninfoOption;

接続オプションの配列を返します。 これは、使用可能なPQconnectdb用オプションの全てや、その時点でのデフォルト値を決定するために使用することができます。 戻り値は、PQconninfoOption構造体の配列へのポインタで、keywordポインタがNULLとなる項目が配列の末尾にきます。 メモリが確保できなかった場合にはNULLポインタを返します。 現在のデフォルト値(val フィールド)は、環境変数や他のコンテキストに依存します。 呼び出し側では、接続オプションの情報は、読み込み専用として取り扱わなければいけません。

オプションの配列を処理した後は、PQconninfoFreeを使用して解放します。 この処理をしないと、PQconndefaultsが呼び出されるたびに少しずつメモリリークが発生します。

PQconninfoParse

提供された接続文字列から構文解析された接続オプションを返します。

PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg);

接続文字列の構文解析を行い、配列として結果オプションを返すか、または接続文字列に問題があった場合にNULLを返します。 これは提供された接続文字列の中のPQconnectdbオプションを決定するのに使用することができます。 戻り値はPQconninfoOption構造体の配列を指し示し、それはNULLkeywordポインタを所有している項目で終結します。

文字列内で明示的に指定されたオプションのみ結果配列の中で値集合を持つことに注意してください。 いかなるデフォルトも挿入されません。

errmsgが非NULLであれば、成功した場合*errmsgNULLに設定され、そうでなければ、問題を説明したmallocされたエラー文字列になります。 (NULLが返されたときであっても*errmsgNULLに設定されることもあり得ます。 これはメモリ不足状態を意味します。)

オプション配列を処理した後、それをPQconninfoFreeに渡して解放してください。 これが行われない場合、PQconninfoParseへのそれぞれの呼び出しに対してメモリーリークが起こります。 反対に、エラーが起こり、そしてerrmsgが非NULLであれば、PQfreememを使用してエラー文字列を必ず解放してください。

PQfinish

サーバとの接続を閉ざします。 また、PGconnオブジェクトが占めるメモリも解放します。

void PQfinish(PGconn *conn);

たとえサーバへの接続試行が失敗しても(PQstatusで調べます)、アプリケーションはPQfinishを呼び出しPGconnオブジェクトが占めるメモリを解放するべきです。 そしてPQfinishを呼び出したら、もうPGconnへのポインタを使ってはいけません。

PQreset

サーバへの通信チャンネルをリセットします。

void PQreset(PGconn *conn);

この関数はサーバへの接続を閉じ、以前使用したパラメータを全て使用して、同一のサーバへ新しく接続を確立します。 これは、作業中の接続が失われた場合のエラーの修復に役立つでしょう。

PQresetStart
PQresetPoll

非ブロッキング方式で、サーバへの接続チャンネルをリセットします。

int PQresetStart(PGconn *conn);

PostgresPollingStatusType PQresetPoll(PGconn *conn);

これらの関数はサーバへの接続を閉じ、それから再度、以前使用したパラメータを全て使用して、同じサーバと新たな接続を確立しようとします。 これらは作業中の接続が失われた場合のエラー修復に役立つでしょう。 PQreset(前述)との違いは、この2つの関数が非ブロック方式で動作することです。 また、これらの関数はPQconnectStartParamsPQconnectStartおよびPQconnectPollと同じ制限を受けます。

接続リセットを始めるには、PQresetStartを呼び出します。 この関数がゼロを返す場合、リセットに失敗しています。 戻り値が1ならば、PQconnectPollを使って接続を確立した時とまったく同じに、PQresetPollを使用してリセットのポーリングを行います。