Document php.ini options for ibm_db2.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@187092 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Dan Scott 2005-05-27 15:08:23 +00:00
parent 4b886a0c83
commit 0aabeb5add
2 changed files with 130 additions and 8 deletions

106
reference/ibm_db2/ini.xml Normal file
View file

@ -0,0 +1,106 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section id="extname.configuration">
&reftitle.runtime;
&extension.runtime;
<para>
<table>
<title>ibm_db2 &ConfigureOptions;</title>
<tgroup cols="3">
<thead>
<row>
<entry>&Name;</entry>
<entry>&Default;</entry>
<entry>&Changeable;</entry>
</row>
</thead>
<tbody>
<row>
<entry>ibm_db2.binmode</entry>
<entry>1</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>ibm_db2.instance_name</entry>
<entry>&null;</entry>
<entry>PHP_INI_SYSTEM</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
&ini.descriptions.title;
<para>
<variablelist>
<varlistentry id="ini.extname.ibm-db2.binmode">
<term>
<parameter>ibm-db2.binmode</parameter>
<type>integer</type>
</term>
<listitem>
<para>
This option controls the mode used for converting to and from binary
data in the PHP application.
<itemizedlist>
<listitem>
<para>
1 (DB2_BINARY)
</para>
</listitem>
<listitem>
<para>
2 (DB2_CONVERT)
</para>
</listitem>
<listitem>
<para>
3 (DB2_PASSTHRU)
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.extname.ibm-db2.instance-name">
<term>
<parameter>ibm-db2.instance-name</parameter>
<type>string</type>
</term>
<listitem>
<para>
On Linux and UNIX operating systems, this option defines the name of the
instance to use for cataloged database connections. If this option is set,
its value overrides the DB2INSTANCE environment variable setting.
</para>
<para>
This option is ignored on Windows operating systems.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<!-- 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:"../../../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
-->

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<reference id="ref.ibm-db2">
<title>IBM DB2, Cloudscape and Apache Derby Functions</title>
@ -26,11 +26,25 @@
To connect to IBM DB2 Universal Database for z/OS or iSeries, you also
require IBM DB2 Connect or the equivalent DRDA gateway software.
</para>
<section id="ibm-db2.requirements.unix">
<title>Requirements on Linux or Unix</title>
<para>
On Linux or Unix operating systems, ensure that the user invoking the
PHP executable or SAPI has sourced the DB2 instance environment before
accessing these functions. If you created a DB2 instance in
<filename>/home/db2inst1/</filename>, for example, you must issue the
The user invoking the PHP executable or SAPI must specify the DB2 instance
before accessing these functions. You can set the name of the DB2 instance
in &php.ini; using the <literal>ibm_db2.instance_name</literal>
configuration option, or you can source the DB2 instance profile before
invoking the PHP executable.
</para>
<para>
If you created a DB2 instance named <literal>db2inst1</literal> in
<filename>/home/db2inst1/</filename>, for example, you can add the
following line to &php.ini;:
<screen>
<![CDATA[
ibm_db2.instance_name=db2inst1
]]>
</screen>
If you do not set this option in &php.ini;, you must issue the
following command to modify your environment variables to enable access to
DB2:
<screen>
@ -39,16 +53,18 @@ bash$ source /home/db2inst1/sqllib/db2profile
]]>
</screen>
To enable your PHP-enabled Web server to access these functions, you must
add the same command to your Web server start script (typically
<filename>/etc/init.d/httpd</filename> or
either set the <literal>ibm_db2.instance_name</literal> configuration
option in &php.ini;, or source the DB2 instance environment in your Web
server start script (typically <filename>/etc/init.d/httpd</filename> or
<filename>/etc/init.d/apache</filename>).
</para>
</section>
</section>
<!-- Information found in configure.xml -->
&reference.ibm-db2.configure;
<!-- Information found in ini.xml -->
<!--&reference.ibm-db2.ini;-->
&reference.ibm-db2.ini;
&reference.ibm-db2.constants;
<section id="ibm-db2.resources">