File: reference.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (151 lines) | stat: -rw-r--r-- 4,336 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

 <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="ref.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>
 &reference.pdo-firebird.pdo-firebird;
<!-- 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
-->