pg_connect
名前
pg_connect -- サーバとの接続を開きます。
概要
pg_connect -conninfo connectOptions
pg_connect dbName ?-host hostName? ?-port portNumber? ?-tty tty? ?-options serverOptions?
説明
pg_connectはPostgreSQLサーバとの接続を開きます。
2つの構文を使用できます。
pg_connectの古い構文では、設定可能なオプションはそれぞれ別々のオプションスイッチを持ちます。
新しい形式では、複数のオプション値を持つことができる、単一のオプション文字が提供されています。
pg_conndefaultsを使用して、新しい構文で使用可能なオプションの情報を取り出すことができます。
引数
新様式
- connectOptions
keyword = valueという書式でそれぞれを記述した、接続オプション文字列です。
有効なオプションの一覧はPQconnectdblibpq関数の説明部分に記載されています。
旧様式
- dbName
接続するデータベースの名前です。
- -host hostName
接続するデータベースサーバのホスト名です。
- -port portNumber
接続するデータベースサーバのTCPポート番号です。
- -tty tty
省略可能な、サーバからのデバッグ出力用のファイルもしくはTTYです。
- -options serverOptions
サーバに渡す、追加設定オプションです。
戻り値
成功時、データベース接続用ハンドルが返されます。
ハンドルは、pgsqlという接頭詞で始まります。