ibase-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ibase-connect">
 <refnamediv>
  <refname>ibase_connect</refname>
  <refpurpose>Open a connection to a database</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>ibase_connect</methodname>
   <methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>buffers</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>dialect</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>role</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>sync</parameter></methodparam>
  </methodsynopsis>
  <para>
   Establishes a connection to an Firebird/InterBase server.
  </para>
  <para>
   In case a second call is made to <function>ibase_connect</function> with
   the same arguments, no new link will be established, but instead, the link
   identifier of the already opened link will be returned. The link to the
   server will be closed as soon as the execution of the script ends, unless
   it's closed earlier by explicitly calling <function>ibase_close</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>database</parameter></term>
     <listitem>
      <para>
       The <parameter>database</parameter> argument has to be a valid path to
       database file on the server it resides on. If the server is not local,
       it must be prefixed with either 'hostname:' (TCP/IP), 'hostname/port:'
       (TCP/IP with interbase server on custom TCP port), '//hostname/'
       (NetBEUI), depending on the connection
       protocol used.   
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>username</parameter></term>
     <listitem>
      <para>
       The user name. Can be set with the
       <literal>ibase.default_user</literal> &php.ini; directive.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>password</parameter></term>
     <listitem>
      <para>
       The password for <parameter>username</parameter>. Can be set with the
       <literal>ibase.default_password</literal> &php.ini; directive.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>charset</parameter></term>
     <listitem>
      <para>
       <parameter>charset</parameter> is the default character set for a
       database.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>buffers</parameter></term>
     <listitem>
      <para>
       <parameter>buffers</parameter> is the number of database buffers to
       allocate for the server-side cache. If 0 or omitted, server chooses
       its own default.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dialect</parameter></term>
     <listitem>
      <para>
       <parameter>dialect</parameter> selects the default SQL dialect for any
       statement executed within a connection, and it defaults to the highest
       one supported by client libraries.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>role</parameter></term>
     <listitem>
      <para>
       Functional only with InterBase 5 and up.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>sync</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an Firebird/InterBase link identifier on success, or &false; on error.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   If you get some error like "arithmetic exception, numeric overflow, or
   string truncation. Cannot transliterate character between character sets"
   (this occurs when you try use some character with accents) when using this
   and after <function>ibase_query</function> you must set the character set
   (i.e. ISO8859_1 or your current character set).
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>ibase_connect</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$host = 'localhost:/path/to/your.gdb';

$dbh = ibase_connect($host, $username, $password);
$stmt = 'SELECT * FROM tblname';
$sth = ibase_query($dbh, $stmt);
while ($row = ibase_fetch_object($sth)) {
    echo $row->email, "\n";
}
ibase_free_result($sth);
ibase_close($dbh);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ibase_pconnect</function></member>
    <member><function>ibase_close</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
-->