<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.pgsql.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.pg-connect.php',
    1 => 'pg_connect',
    2 => 'PostgreSQL 接続をオープンする',
  ),
  'up' => 
  array (
    0 => 'ref.pgsql.php',
    1 => 'PostgreSQL 関数',
  ),
  'prev' => 
  array (
    0 => 'function.pg-close.php',
    1 => 'pg_close',
  ),
  'next' => 
  array (
    0 => 'function.pg-connect-poll.php',
    1 => 'pg_connect_poll',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/pgsql/functions/pg-connect.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.pg-connect" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">pg_connect</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">pg_connect</span> &mdash; <span class="dc-title">PostgreSQL 接続をオープンする</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.pg-connect-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>pg_connect</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$connection_string</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span>): <span class="type"><span class="type"><a href="class.pgsql-connection.php" class="type PgSql\Connection">PgSql\Connection</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>pg_connect()</strong></span> は、<code class="parameter">connection_string</code>
   で指定された情報を用いてデータベースとの接続をオープンします。
  </p>
  <p class="para">
   同じ <code class="parameter">connection_string</code> 引数で 2 回
   <span class="function"><strong>pg_connect()</strong></span> 関数がコールされた場合は、
   <code class="parameter">flags</code> に
   <strong><code><a href="pgsql.constants.php#constant.pgsql-connect-force-new">PGSQL_CONNECT_FORCE_NEW</a></code></strong> を指定していない限り
   既存の接続が返されます。
  </p>
  <p class="para">
   複数のパラメータをサポートする古い構文
   <strong class="command">$conn = pg_connect(&quot;host&quot;, &quot;port&quot;, &quot;options&quot;, &quot;tty&quot;, &quot;dbname&quot;)
   </strong>
   は推奨されません。
  </p>
 </div>


<div class="refsect1 parameters" id="refsect1-function.pg-connect-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">connection_string</code></dt>
     <dd>
      <p class="para">
       すべてデフォルトのパラメータを使用する場合には
       <code class="parameter">connection_string</code> を空にすることが可能です。
       または 1 つ以上のパラメータを空白で区切って指定することも可能です。
       個々のパラメータは <code class="literal">keyword = value</code> の形式で
       設定します。等号の前後の空白はあってもなくてもかまいません。
       空の値や空白を含む値を指定する場合は、その値をシングルクォートで
       囲みます（例: <code class="literal">keyword = &#039;a value&#039;</code>）。値の中に
       シングルクォートやバックスラッシュが含まれる場合は、それらを
       バックスラッシュでエスケープする必要があります（例: \&#039; および \\）。
      </p>
      <p class="para">
       現在利用できるパラメータは以下のとおりです。
       <code class="parameter">host</code>, <code class="parameter">hostaddr</code>, <code class="parameter">port</code>,
       <code class="parameter">dbname</code> (デフォルトは <code class="parameter">user</code> の値), <code class="parameter">user</code>,
       <code class="parameter">password</code>, <code class="parameter">connect_timeout</code>,
       <code class="parameter">options</code>, <code class="parameter">tty</code>（無視されます）, <code class="parameter">sslmode</code>,
       <code class="parameter">requiressl</code>（非推奨。代わりに <code class="parameter">sslmode</code> を推奨します）
       および <code class="parameter">service</code> 。これらのうち実際にどの
       パラメータが使えるかは、PostgreSQL のバージョンに依存します。
      </p>
      <p class="para">
       <code class="parameter">options</code> パラメータを使うと、
       サーバー側で実行されるコマンドラインパラメータを指定することができます。
      </p>
     </dd>
    
    
     <dt><code class="parameter">flags</code></dt>
     <dd>
      <p class="para">
       <strong><code><a href="pgsql.constants.php#constant.pgsql-connect-force-new">PGSQL_CONNECT_FORCE_NEW</a></code></strong> が渡された場合は、
       たとえ <code class="parameter">connection_string</code> が既存の接続と
       まったく同一であっても新しい接続をオープンします。
      </p>
      <p class="para">
       <strong><code><a href="pgsql.constants.php#constant.pgsql-connect-async">PGSQL_CONNECT_ASYNC</a></code></strong> を指定すると、
       非同期接続を確立します。この接続の状態は、
       <span class="function"><a href="function.pg-connect-poll.php" class="function">pg_connect_poll()</a></span> あるいは
       <span class="function"><a href="function.pg-connection-status.php" class="function">pg_connection_status()</a></span> で確認できます。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.pg-connect-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   成功した場合に <span class="classname"><a href="class.pgsql-connection.php" class="classname">PgSql\Connection</a></span>
   クラスのインスタンスを返します。
   失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します
  </p>
 </div>

 
 <div class="refsect1 changelog" id="refsect1-function.pg-connect-changelog">
  <h3 class="title">変更履歴</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>バージョン</th>
      <th>説明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.1.0</td>
      <td>
       <span class="classname"><a href="class.pgsql-connection.php" class="classname">PgSql\Connection</a></span>
       クラスのインスタンスを返すようになりました。
       これより前のバージョンでは、
       <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> を返していました。
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.pg-connect-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <span class="function"><strong>pg_connect()</strong></span> の使用法</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$dbconn </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"dbname=mary"</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// "mary"という名前のデータベースに接続<br /><br /></span><span style="color: #0000BB">$dbconn2 </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"host=localhost port=5432 dbname=mary"</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// "localhost"のポート"5432"にて"mary"という名前のデータベースに接続<br /><br /></span><span style="color: #0000BB">$dbconn3 </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"host=sheep port=5432 dbname=mary user=lamb password=foo"</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// ユーザー名とパスワードを指定してホスト"sheep"上の"mary"という名前のデータベースに接続<br /><br /></span><span style="color: #0000BB">$conn_string </span><span style="color: #007700">= </span><span style="color: #DD0000">"host=sheep port=5432 dbname=test user=lamb password=bar"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$dbconn4 </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_string</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// ユーザー名とパスワードを指定してホスト"sheep"上の"test"という名前のデータベースへ接続<br /><br /></span><span style="color: #0000BB">$dbconn5 </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"host=localhost options='--client_encoding=UTF8'"</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// "localhost" のデータベースに接続する際に、エンコーディングを UTF-8 に指定<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.pg-connect-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.pg-pconnect.php" class="function" rel="rdfs-seeAlso">pg_pconnect()</a> - 持続的な PostgreSQL 接続をオープンする</span></li>
    <li><span class="function"><a href="function.pg-close.php" class="function" rel="rdfs-seeAlso">pg_close()</a> - PostgreSQL 接続をクローズする</span></li>
    <li><span class="function"><a href="function.pg-host.php" class="function" rel="rdfs-seeAlso">pg_host()</a> - 接続に関連するホスト名を返す</span></li>
    <li><span class="function"><a href="function.pg-port.php" class="function" rel="rdfs-seeAlso">pg_port()</a> - 接続に関連するポート番号を返す</span></li>
    <li><span class="function"><a href="function.pg-tty.php" class="function" rel="rdfs-seeAlso">pg_tty()</a> - 接続に関する TTY 名を返す</span></li>
    <li><span class="function"><a href="function.pg-options.php" class="function" rel="rdfs-seeAlso">pg_options()</a> - 接続に関連するオプションを取得する</span></li>
    <li><span class="function"><a href="function.pg-dbname.php" class="function" rel="rdfs-seeAlso">pg_dbname()</a> - データベース名を取得する</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>