<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ibase.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.ibase-connect.php',
    1 => 'ibase_connect',
    2 => 'Open a connection to a database',
  ),
  'up' => 
  array (
    0 => 'ref.ibase.php',
    1 => 'Firebird/InterBase Functions',
  ),
  'prev' => 
  array (
    0 => 'function.ibase-commit-ret.php',
    1 => 'ibase_commit_ret',
  ),
  'next' => 
  array (
    0 => 'function.ibase-db-info.php',
    1 => 'ibase_db_info',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/ibase/functions/ibase-connect.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ibase-connect" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ibase_connect</h1>
  <p class="verinfo">(PHP 5, PHP 7 &lt; 7.4.0)</p><p class="refpurpose"><span class="refname">ibase_connect</span> &mdash; <span class="dc-title">Open a connection to a database</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ibase-connect-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ibase_connect</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$database</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$username</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$password</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$charset</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$buffers</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$dialect</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$role</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$sync</code><span class="initializer"> = ?</span></span><br>): <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span></div>

  <p class="simpara">
   Establishes a connection to an Firebird/InterBase server.
  </p>
  <p class="simpara">
   In case a second call is made to <span class="function"><strong>ibase_connect()</strong></span> 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&#039;s closed earlier by explicitly calling <span class="function"><a href="function.ibase-close.php" class="function">ibase_close()</a></span>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ibase-connect-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">database</code></dt>
    <dd>
     <span class="simpara">
      The <code class="parameter">database</code> 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 &#039;hostname:&#039; (TCP/IP), &#039;hostname/port:&#039;
      (TCP/IP with interbase server on custom TCP port), &#039;//hostname/&#039;
      (NetBEUI), depending on the connection
      protocol used.
     </span>
    </dd>
   
   
    <dt><code class="parameter">username</code></dt>
    <dd>
     <span class="simpara">
      The user name. Can be set with the
      <code class="literal">ibase.default_user</code> <var class="filename">php.ini</var> directive.
     </span>
    </dd>
   
   
    <dt><code class="parameter">password</code></dt>
    <dd>
     <span class="simpara">
      The password for <code class="parameter">username</code>. Can be set with the
      <code class="literal">ibase.default_password</code> <var class="filename">php.ini</var> directive.
     </span>
    </dd>
   
   
    <dt><code class="parameter">charset</code></dt>
    <dd>
     <span class="simpara">
      <code class="parameter">charset</code> is the default character set for a
      database.
     </span>
    </dd>
   
   
    <dt><code class="parameter">buffers</code></dt>
    <dd>
     <span class="simpara">
      <code class="parameter">buffers</code> is the number of database buffers to
      allocate for the server-side cache. If 0 or omitted, server chooses
      its own default.
     </span>
    </dd>
   
   
    <dt><code class="parameter">dialect</code></dt>
    <dd>
     <span class="simpara">
      <code class="parameter">dialect</code> selects the default SQL dialect for any
      statement executed within a connection, and it defaults to the highest
      one supported by client libraries.
     </span>
    </dd>
   
   
    <dt><code class="parameter">role</code></dt>
    <dd>
     <span class="simpara">
      Functional only with InterBase 5 and up.
     </span>
    </dd>
   
   
    <dt><code class="parameter">sync</code></dt>
    <dd>
     <span class="simpara">
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ibase-connect-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   Returns an Firebird/InterBase link identifier on success, or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on error.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.ibase-connect-errors">
  <h3 class="title">Errors/Exceptions</h3>
  <p class="simpara">
   If you get some error like &quot;arithmetic exception, numeric overflow, or
   string truncation. Cannot transliterate character between character sets&quot;
   (this occurs when you try use some character with accents) when using this
   and after <span class="function"><a href="function.ibase-query.php" class="function">ibase_query()</a></span> you must set the character set
   (i.e. ISO8859_1 or your current character set).
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.ibase-connect-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 <span class="function"><strong>ibase_connect()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$host </span><span style="color: #007700">= </span><span style="color: #DD0000">'localhost:/path/to/your.gdb'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$dbh </span><span style="color: #007700">= </span><span style="color: #0000BB">ibase_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$host</span><span style="color: #007700">, </span><span style="color: #0000BB">$username</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$stmt </span><span style="color: #007700">= </span><span style="color: #DD0000">'SELECT * FROM tblname'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$sth </span><span style="color: #007700">= </span><span style="color: #0000BB">ibase_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbh</span><span style="color: #007700">, </span><span style="color: #0000BB">$stmt</span><span style="color: #007700">);<br />while (</span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">ibase_fetch_object</span><span style="color: #007700">(</span><span style="color: #0000BB">$sth</span><span style="color: #007700">)) {<br />    echo </span><span style="color: #0000BB">$row</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">email</span><span style="color: #007700">, </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">ibase_free_result</span><span style="color: #007700">(</span><span style="color: #0000BB">$sth</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">ibase_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbh</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.ibase-connect-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.ibase-pconnect.php" class="function" rel="rdfs-seeAlso">ibase_pconnect()</a> - Open a persistent connection to an InterBase database</span></li>
   <li><span class="function"><a href="function.ibase-close.php" class="function" rel="rdfs-seeAlso">ibase_close()</a> - Close a connection to an InterBase database</span></li>
  </ul>
 </div>


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