pg-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./ja/functions/pgsql.xml, last change in rev 1.1 -->
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id="function.pg-connect" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_connect</refname>
  <refpurpose>PostgreSQL 接続をオープンする</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>PgSql\Connection</type><type>false</type></type><methodname>pg_connect</methodname>
   <methodparam><type>string</type><parameter>connection_string</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_connect</function> は、<parameter>connection_string</parameter>
   で指定された情報を用いてデータベースとの接続をオープンします。
  </para>
  <para>
   同じ <parameter>connection_string</parameter> 引数で 2 回
   <function>pg_connect</function> 関数がコールされた場合は、
   <parameter>flags</parameter> に
   <constant>PGSQL_CONNECT_FORCE_NEW</constant> を指定していない限り
   既存の接続が返されます。
  </para>
  <para>
   複数のパラメータをサポートする古い構文
   <command>$conn = pg_connect("host", "port", "options", "tty", "dbname")
   </command>
   は推奨されません。
  </para>
 </refsect1>

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

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合に <classname>PgSql\Connection</classname>
   クラスのインスタンスを返します。
   &return.falseforfailure;
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.1.0</entry>
      <entry>
       <classname>PgSql\Connection</classname>
       クラスのインスタンスを返すようになりました。
       これより前のバージョンでは、
       &resource; を返していました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_connect</function> の使用法</title>
    <programlisting role="php">
<![CDATA[
<?php
$dbconn = pg_connect("dbname=mary");
// "mary"という名前のデータベースに接続

$dbconn2 = pg_connect("host=localhost port=5432 dbname=mary");
// "localhost"のポート"5432"にて"mary"という名前のデータベースに接続

$dbconn3 = pg_connect("host=sheep port=5432 dbname=mary user=lamb password=foo");
// ユーザー名とパスワードを指定してホスト"sheep"上の"mary"という名前のデータベースに接続

$conn_string = "host=sheep port=5432 dbname=test user=lamb password=bar";
$dbconn4 = pg_connect($conn_string);
// ユーザー名とパスワードを指定してホスト"sheep"上の"test"という名前のデータベースへ接続

$dbconn5 = pg_connect("host=localhost options='--client_encoding=UTF8'");
// "localhost" のデータベースに接続する際に、エンコーディングを UTF-8 に指定
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_pconnect</function></member>
    <member><function>pg_close</function></member>
    <member><function>pg_host</function></member>
    <member><function>pg_port</function></member>
    <member><function>pg_tty</function></member>
    <member><function>pg_options</function></member>
    <member><function>pg_dbname</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->