php-doc-en/reference/pdo_firebird/reference.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- State: experimental -->

 <reference xml:id="ref.pdo-firebird" xmlns="http://docbook.org/ns/docbook">
  <?phpdoc extension-membership="bundledexternal" ?>
  <title>Firebird Functions (PDO_FIREBIRD)</title>
  <titleabbrev>Firebird (PDO)</titleabbrev>
  <partintro>

   <section xml:id="pdo-firebird.intro">
   &reftitle.intro;
    <para>
     PDO_FIREBIRD is a driver that implements the PHP Data Objects (PDO)
     interface to enable access from PHP to Firebird database.
    </para>
   </section>
   &reference.pdo-firebird.configure;
   &reference.pdo-firebird.constants;
  </partintro>

  <refentry xml:id="ref.pdo-firebird.connection">
   <refnamediv>
    <refname>PDO_FIREBIRD DSN</refname>
    <refpurpose>Connecting to Firebird databases</refpurpose>
   </refnamediv>

   <refsect1 role="description">
    &reftitle.description;
    <para>
     The PDO_FIREBIRD Data Source Name (DSN) is composed of the following elements:
     <variablelist>
      <varlistentry>
       <term>DSN prefix</term>
       <listitem>
        <para>
        The DSN prefix is <userinput>firebird:</userinput>.
        </para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><literal>dbname</literal></term>
       <listitem>
        <para>
         The name of the database.
        </para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><literal>charset</literal></term>
       <listitem>
        <para>
         The character set.
        </para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><literal>role</literal></term>
       <listitem>
        <para>
         The SQL role name.
        </para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><literal>dialect</literal></term>
       <listitem>
        <para>
         The dialect of the database; either <literal>1</literal> or <literal>3</literal>.
         If not specified, the dialect defaults to <literal>3</literal>.
         Available as of PHP 7.4.0.
        </para>
       </listitem>
      </varlistentry>
     </variablelist>
    </para>
   </refsect1>
   <refsect1 role="examples">
    &reftitle.examples;
    <para>
     <example>
      <title>PDO_FIREBIRD DSN example with path</title>
      <para>
       The following example shows a PDO_FIREBIRD DSN for connecting to
       Firebird databases:
       <programlisting><![CDATA[
firebird:dbname=/path/to/DATABASE.FDB
]]>
       </programlisting>
      </para>
     </example>
     <example>
      <title>PDO_FIREBIRD DSN example with port and path</title>
      <para>
       The following example shows a PDO_FIREBIRD DSN for connecting to
       a Firebird database using hostname port and path:
       <programlisting><![CDATA[
firebird:dbname=hostname/port:/path/to/DATABASE.FDB
]]>
       </programlisting>
      </para>
     </example>
     <example>
      <title>PDO_FIREBIRD DSN example with localhost and path to employee.fdb on Debian system</title>
      <para>
       The following example shows a PDO_FIREBIRD DSN for connecting to
       a Firebird database employee.fdb using localhost:
       <programlisting><![CDATA[
firebird:dbname=localhost:/var/lib/firebird/2.5/data/employee.fdb
]]>
       </programlisting>
      </para>
     </example>
     <example>
      <title>PDO_FIREBIRD DSN to connect to a dialect 1 database</title>
      <para>
       The following example shows a PDO_FIREBIRD DSN for connecting to
       a Firebird database test.fdb which has been created using dialect 1.
       This is only supported as of PHP 7.4.0.
      </para>
      <programlisting>
<![CDATA[
firebird:dbname=localhost:/var/lib/firebird/2.5/data/test.fdb;charset=utf-8;dialect=1
]]>
</programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

 </reference>
<!-- 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
-->