correct markup

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@279014 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Yannick Torres 2009-04-19 21:01:35 +00:00
parent f6258411ba
commit 2c711db1a0
10 changed files with 503 additions and 501 deletions

View file

@ -1,76 +1,76 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<section xml:id="ingres.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
&pecl.moved;
&pecl.info;
<link xlink:href="&url.pecl.package;ingres">&url.pecl.package;ingres</link>.
</para>
<para>
The DLL for this PECL extension may be downloaded from <link
xlink:href="&url.ingres.peclext;">&url.ingres.peclext;</link>.
</para>
<para>
To have these functions available, you must <link
xlink:href="&url.pecl.package;ingres">download</link> and compile
this extension, enabling Ingres support using the
<option role="configure">--with-ingres[=DIR]</option> option, where DIR is
the Ingres base directory. If the II_SYSTEM environment variable is not
set correctly you may need to use
<option role="configure">--with-ingres=DIR</option>
to specify your Ingres installation directory.
</para>
<para>
PHP code written for version 2.x and later is not backward-compatible with
earlier versions of this PHP extension. However, it is possible to run two
incompatible releases within the same PHP environment using the <option
role="configure">--enable-ingres2</option> option. This configuration option
renames the extension to ingres2, changing function names, configuration
settings, and constants. For example, with this option enabled,
<function>ingres_connect</function> becomes
<function>ingres2_connect</function>.
</para>
<para>
To use this extension the system environment variable II_SYSTEM must be
defined. Linux and UNIX users will also need to define the shared library
search path, for example, LD_LIBRARY_PATH. When used with the Apache web server
these variables must be
set explicitly in the startup script for Apache. In addition, the PassEnv
directive is required for the Ingres extension to load the correct shared
libraries. For example:
</para>
<example>
<informalexample>
<screen>
<![CDATA[
<IfModule mod_env.c>
PassEnv II_SYSTEM
PassEnv LD_LIBRARY_PATH
</IfModule>
]]>
</screen>
</informalexample>
</example>
</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
-->
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<section xml:id="ingres.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
&pecl.moved;
&pecl.info;
<link xlink:href="&url.pecl.package;ingres">&url.pecl.package;ingres</link>.
</para>
<para>
The DLL for this PECL extension may be downloaded from <link
xlink:href="&url.ingres.peclext;">&url.ingres.peclext;</link>.
</para>
<para>
To have these functions available, you must <link
xlink:href="&url.pecl.package;ingres">download</link> and compile
this extension, enabling Ingres support using the
<option role="configure">--with-ingres[=DIR]</option> option, where DIR is
the Ingres base directory. If the <varname>II_SYSTEM</varname> environment variable is not
set correctly you may need to use
<option role="configure">--with-ingres=DIR</option>
to specify your Ingres installation directory.
</para>
<para>
PHP code written for version 2.x and later is not backward-compatible with
earlier versions of this PHP extension. However, it is possible to run two
incompatible releases within the same PHP environment using the <option
role="configure">--enable-ingres2</option> option. This configuration option
renames the extension to ingres2, changing function names, configuration
settings, and constants. For example, with this option enabled,
<function>ingres_connect</function> becomes
<function>ingres2_connect</function>.
</para>
<para>
To use this extension the system environment variable II_SYSTEM must be
defined. Linux and UNIX users will also need to define the shared library
search path, for example, <varname>LD_LIBRARY_PATH</varname>. When used with the Apache web server
these variables must be
set explicitly in the startup script for Apache. In addition, the <literal>PassEnv</literal>
directive is required for the Ingres extension to load the correct shared
libraries. For example:
</para>
<example>
<informalexample>
<screen>
<![CDATA[
<IfModule mod_env.c>
PassEnv II_SYSTEM
PassEnv LD_LIBRARY_PATH
</IfModule>
]]>
</screen>
</informalexample>
</example>
</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.11 $ -->
<!-- $Revision: 1.12 $ -->
<refentry xml:id="function.ingres-fetch-array" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ingres_fetch_array</refname>
@ -81,9 +81,9 @@ $bar = $result["country"];
<term><parameter>result_type</parameter></term>
<listitem>
<para>
The result type. This <parameter>result_type</parameter> can be INGRES_NUM for
enumerated array, INGRES_ASSOC for associative array, or
INGRES_BOTH (default).
The result type. This <parameter>result_type</parameter> can be <constant>INGRES_NUM</constant> for
enumerated array, <constant>INGRES_ASSOC</constant> for associative array, or
<constant>INGRES_BOTH</constant> (default).
</para>
</listitem>
</varlistentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- $Revision: 1.11 $ -->
<refentry xml:id="function.ingres-fetch-object" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ingres_fetch_object</refname>
@ -55,8 +55,8 @@
<listitem>
<para>
(Optional argument.) <parameter>result_type</parameter> is a
constant and can take the following values: INGRES_ASSOC,
INGRES_NUM, and INGRES_BOTH.
constant and can take the following values: <constant>INGRES_ASSOC</constant>,
<constant>INGRES_NUM</constant>, and <constant>INGRES_BOTH</constant>.
</para>
</listitem>
</varlistentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.ingres-field-length" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ingres_field_length</refname>
@ -16,8 +16,8 @@
<para>
<function>ingres_field_length</function> returns the length of a
field. This is the number of bytes the server uses to store
the field. For detailed information, see the Ingres <emphasis>OpenAPI User
Guide</emphasis>, Appendix "Data Types" in the Ingres documentation.
the field. For detailed information, see the Ingres <literal>OpenAPI User
Guide</literal>, Appendix <literal>"Data Types"</literal> in the Ingres documentation.
</para>
</refsect1>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.ingres-field-precision" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ingres_field_precision</refname>
@ -16,8 +16,8 @@
<para>
<function>ingres_field_precision</function> returns the precision
of a field. This value is used only for decimal, float, and money
SQL data types. For detailed information, see the Ingres <emphasis>OpenAPI
User Guide</emphasis>, Appendix "Data Types" in the Ingres documentation.
SQL data types. For detailed information, see the Ingres <literal>OpenAPI
User Guide</literal>, Appendix "Data Types" in the Ingres documentation.
</para>
</refsect1>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.ingres-field-scale" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ingres_field_scale</refname>
@ -16,8 +16,8 @@
<para>
<function>ingres_field_scale</function> returns the scale of a
field. This value is used only for the decimal SQL data
type. For detailed information, see the Ingres <emphasis>OpenAPI User
Guide</emphasis>, Appendix "Data Types" in the Ingres documentation.
type. For detailed information, see the Ingres <literal>OpenAPI User
Guide</literal>, Appendix <literal>"Data Types"</literal> in the Ingres documentation.
</para>
</refsect1>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.ingres-field-type" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ingres_field_type</refname>
@ -49,13 +49,14 @@
<para>
<function>ingres_field_type</function> returns the type of a
field in a query result, or &false; on failure. Examples of
types returned are IIAPI_BYTE_TYPE, IIAPI_CHA_TYPE,
IIAPI_DTE_TYPE, IIAPI_FLT_TYPE, IIAPI_INT_TYPE,
IIAPI_VCH_TYPE. Some of these types can map to more than one
SQL type depending on the length of the field (see
types returned are <literal>IIAPI_BYTE_TYPE</literal>,
<literal>IIAPI_CHA_TYPE</literal>, <literal>IIAPI_DTE_TYPE</literal>,
<literal>IIAPI_FLT_TYPE</literal>, <literal>IIAPI_INT_TYPE</literal>,
<literal>IIAPI_VCH_TYPE</literal>. Some of these types can map to more
than one SQL type depending on the length of the field (see
<function>ingres_field_length</function>). For example
IIAPI_FLT_TYPE can be a float4 or a float8. For detailed
information, see the Ingres <emphasis>OpenAPI User Guide</emphasis>, Appendix
information, see the Ingres <literal>OpenAPI User Guide</literal>, Appendix
"Data Types" in the Ingres documentation.
</para>
</refsect1>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.ingres-prepare" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ingres_prepare</refname>
@ -56,8 +56,8 @@
<term><parameter>query</parameter></term>
<listitem>
<para>
A valid SQL query (see the Ingres <emphasis>SQL reference
guide</emphasis>) in the Ingres documentation.
A valid SQL query (see the Ingres <literal>SQL reference
guide</literal>) in the Ingres documentation.
See the <link linkend="function.ingres-query.query">query</link>
parameter in <function>ingres_query</function> for a list of SQL
statements which cannot be executed using

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- $Revision: 1.12 $ -->
<refentry xml:id="function.ingres-query" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ingres_query</refname>
@ -58,47 +58,47 @@
<term><parameter>query</parameter></term>
<listitem>
<para>
A valid SQL query (see the Ingres <emphasis>SQL reference
guide</emphasis>) in the Ingres documentation.
A valid SQL query (see the Ingres <literal>SQL reference
guide</literal>) in the Ingres documentation.
</para>
<para>
The following types of SQL queries cannot be sent with this function:
<itemizedlist>
<listitem>
<simpara>
close (see <function>ingres_close</function>)
<literal>close</literal> (see <function>ingres_close</function>)
</simpara>
</listitem>
<listitem>
<simpara>
commit (see <function>ingres_commit</function>)
<literal>commit</literal> (see <function>ingres_commit</function>)
</simpara>
</listitem>
<listitem>
<simpara>
connect (see <function>ingres_connect</function>)
<literal>connect</literal> (see <function>ingres_connect</function>)
</simpara>
</listitem>
<listitem>
<simpara>
disconnect (see <function>ingres_close</function>)
<literal>disconnect</literal> (see <function>ingres_close</function>)
</simpara>
</listitem>
<listitem>
<simpara>get dbevent</simpara>
<simpara><literal>get dbevent</literal></simpara>
</listitem>
<listitem>
<simpara>prepare to commit</simpara>
<simpara><literal>prepare to commit</literal></simpara>
</listitem>
<listitem>
<simpara>
rollback (see <function>ingres_rollback</function>)
<literal>rollback</literal> (see <function>ingres_rollback</function>)
</simpara>
</listitem>
<listitem><simpara>savepoint</simpara></listitem>
<listitem><simpara><literal>savepoint</literal></simpara></listitem>
<listitem>
<simpara>
set autocommit (see <function>ingres_autocommit</function>)
<literal>set autocommit</literal> (see <function>ingres_autocommit</function>)
</simpara>
</listitem>
<listitem>

View file

@ -1,388 +1,389 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<section xml:id="ingres.configuration" xmlns="http://docbook.org/ns/docbook">
&reftitle.runtime;
&extension.runtime;
<para>
<table>
<title>Ingres configuration options</title>
<tgroup cols="4">
<thead align="left">
<row>
<entry>Name</entry>
<entry>Default</entry>
<entry>Changeable</entry>
<entry>Changelog</entry>
</row>
</thead>
<tbody>
<row>
<entry><link
linkend="ini.ingres.allow-persistent">ingres.allow_persistent</link></entry>
<entry>"1"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since ingres 1.0.0</entry>
</row>
<row>
<entry><link
linkend="ini.ingres.array-index-start">ingres.array_index_start</link></entry>
<entry>"1"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 1.4.0.</entry>
</row>
<row>
<entry><link linkend="ini.ingres.auto">ingres.auto</link></entry>
<entry>"1"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 2.0.0.</entry>
</row>
<row>
<entry><link
linkend="ini.ingres.blob-segment-length">ingres.blob_segment_length</link></entry>
<entry>"4096"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 1.2.0.</entry>
</row>
<row>
<entry><link linkend="ini.ingres.cursor-mode">ingres.cursor_mode</link></entry>
<entry>"0"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 1.1.0.</entry>
</row>
<row>
<entry><link
linkend="ini.ingres.default-database">ingres.default_database</link></entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 1.0.0</entry>
</row>
<row>
<entry><link
linkend="ini.ingres.default-password">ingres.default_password</link></entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.ingres.default-user">ingres.default_user</link></entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.ingres.describe">ingres.describe</link></entry>
<entry>1</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 2.1.0</entry>
</row>
<row>
<entry><link
linkend="ini.ingres.fetch-buffer-size">ingres.fetch_buffer_size</link></entry>
<entry>100</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 2.1.0</entry>
</row>
<row>
<entry><link linkend="ini.ingres.max-links">ingres.max_links</link></entry>
<entry>"-1"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since ingres 1.0.0</entry>
</row>
<row>
<entry><link
linkend="ini.ingres.max-persistent">ingres.max_persistent</link></entry>
<entry>"-1"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since ingres 1.0.0</entry>
</row>
<row>
<entry><link
linkend="ini.ingres.reuse-connection">ingres.reuse_connection</link></entry>
<entry>"1"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 2.0.0</entry>
</row>
<row>
<entry><link linkend="ini.ingres.scrollable">ingres.scrollable</link></entry>
<entry>"1"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 2.0.0.</entry>
</row>
<row>
<entry><link linkend="ini.ingres.trace">ingres.trace</link></entry>
<entry>"0"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 2.0.0.</entry>
</row>
<row>
<entry><link
linkend="ini.ingres.trace-connect">ingres.trace_connect</link></entry>
<entry>"0"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 1.2.1.</entry>
</row>
<row>
<entry><link linkend="ini.ingres.utf8">ingres.utf8</link></entry>
<entry>"1"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 2.0.0.</entry>
</row>
</tbody>
</tgroup>
</table>
&ini.php.constants;
</para>
&ini.descriptions.title;
<para>
<variablelist>
<varlistentry xml:id="ini.ingres.allow-persistent">
<term>
<parameter>ingres.allow_persistent</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Specifies whether to allow
<link linkend="features.persistent-connections">persistent connections</link>
to Ingres
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.array-index-start">
<term>
<parameter>ingres.array_index_start</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Specifies, by default, the array returned by <function>ingres_fetch_array</function>
and <function>ingres_fetch_row</function> indexes from 1.
To make the Ingres extension compatible with other database extensions,
set this to 0.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.auto">
<term>
<parameter>ingres.auto</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Enables or disables autocommit emulation. Ingres cannot have multiple cursors
open with autocommit enabled. When enabled, the driver emulates autocommit.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.blob-segment-length">
<term>
<parameter>ingres.blob_segment_length</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Specifies the amount of memory to use when reading BLOB data, in bytes
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.cursor-mode">
<term>
<parameter>ingres.cursor_mode</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Specifies the default mode for cursors opened with ingres_prepare(). Valid values
are INGRES_CURSOR_UPDATE or INGRES_CURSOR_READONLY.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.default-database">
<term>
<parameter>ingres.default_database</parameter>
<type>string</type>
</term>
<listitem>
<para>
Specifies the default database name to use when connecting to the database
server if no other name is specified. Does not apply in
&sqlsafemode;.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.default-password">
<term>
<parameter>ingres.default_password</parameter>
<type>string</type>
</term>
<listitem>
<para>
Specifies the default password to use when connecting to the database
server if no other name is specified. Does not apply in
&sqlsafemode;.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.default-user">
<term>
<parameter>ingres.default_user</parameter>
<type>string</type>
</term>
<listitem>
<para>
Specifies the default user name to use when connecting to the database
server if no other name is specified. Does not apply in
&sqlsafemode;.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.describe">
<term>
<parameter>ingres.describe</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Enables the use of DESCRIBE INPUT to determine the expected data types
for queries that use parameters. Available with Ingres 9.1.0 and later.
When disabled, queries that have parameters passed may need to manually
describe the types of those parameters using the <link
linkend="function.ingres-query.types">types</link> parameter in
<function>ingres_query</function>.
</para>
<note>
<para>
Enabling this feature with ingres_query() will cause additional
communications traffic between this extension and the server. To
minimize this additional traffic, use ingres_prepare() and
ingres_execute().
</para>
</note>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.fetch-buffer-size">
<term>
<parameter>ingres.fetch_buffer_size</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Specifies the number of pre-fetch rows that <function>ingres_fetch_array</function>,
<function>ingres_fetch_object</function> and
<function>ingres_fetch_row</function> will try and fetch in one fetch operation.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.max-links">
<term>
<parameter>ingres.max_links</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Specifies the maximum number of Ingres sessions allowed per process or thread.
The number of sessions should not exceed the total number of
connected sessions configured within Ingres.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.max-persistent">
<term>
<parameter>ingres.max_persistent</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Specifies the maximum number of persistent Ingres sessions allowed per process or
thread. The number of sessions should not exceed the total
number of connected sessions configured within Ingres.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.reuse-connection">
<term>
<parameter>ingres.reuse_connection</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Reuses an existing active connection if connecting to the same database
with the same user name
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.scrollable">
<term>
<parameter>ingres.scrollable</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Enables support for scrollable cursors. When fetching CLOB or BLOB data, this
should be set to &false;. Available with Ingres 9.2.0 or later.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.trace">
<term>
<parameter>ingres.trace</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Enables simple tracing using E_NOTICE messages
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.trace-connect">
<term>
<parameter>ingres.trace_connect</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Prints E_NOTICE messages during ingres_connect or ingres_pconnect calls
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.utf8">
<term>
<parameter>ingres.utf8</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Assumes that strings being passed to National Character column types
(NVARCHAR or NCHAR) are using UTF8 encoding and converts them to UTF16
for the server
</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
-->
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<section xml:id="ingres.configuration" xmlns="http://docbook.org/ns/docbook">
&reftitle.runtime;
&extension.runtime;
<para>
<table>
<title>Ingres configuration options</title>
<tgroup cols="4">
<thead align="left">
<row>
<entry>Name</entry>
<entry>Default</entry>
<entry>Changeable</entry>
<entry>Changelog</entry>
</row>
</thead>
<tbody>
<row>
<entry><link
linkend="ini.ingres.allow-persistent">ingres.allow_persistent</link></entry>
<entry>"1"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since ingres 1.0.0</entry>
</row>
<row>
<entry><link
linkend="ini.ingres.array-index-start">ingres.array_index_start</link></entry>
<entry>"1"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 1.4.0.</entry>
</row>
<row>
<entry><link linkend="ini.ingres.auto">ingres.auto</link></entry>
<entry>"1"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 2.0.0.</entry>
</row>
<row>
<entry><link
linkend="ini.ingres.blob-segment-length">ingres.blob_segment_length</link></entry>
<entry>"4096"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 1.2.0.</entry>
</row>
<row>
<entry><link linkend="ini.ingres.cursor-mode">ingres.cursor_mode</link></entry>
<entry>"0"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 1.1.0.</entry>
</row>
<row>
<entry><link
linkend="ini.ingres.default-database">ingres.default_database</link></entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 1.0.0</entry>
</row>
<row>
<entry><link
linkend="ini.ingres.default-password">ingres.default_password</link></entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.ingres.default-user">ingres.default_user</link></entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.ingres.describe">ingres.describe</link></entry>
<entry>1</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 2.1.0</entry>
</row>
<row>
<entry><link
linkend="ini.ingres.fetch-buffer-size">ingres.fetch_buffer_size</link></entry>
<entry>100</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 2.1.0</entry>
</row>
<row>
<entry><link linkend="ini.ingres.max-links">ingres.max_links</link></entry>
<entry>"-1"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since ingres 1.0.0</entry>
</row>
<row>
<entry><link
linkend="ini.ingres.max-persistent">ingres.max_persistent</link></entry>
<entry>"-1"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since ingres 1.0.0</entry>
</row>
<row>
<entry><link
linkend="ini.ingres.reuse-connection">ingres.reuse_connection</link></entry>
<entry>"1"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 2.0.0</entry>
</row>
<row>
<entry><link linkend="ini.ingres.scrollable">ingres.scrollable</link></entry>
<entry>"1"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 2.0.0.</entry>
</row>
<row>
<entry><link linkend="ini.ingres.trace">ingres.trace</link></entry>
<entry>"0"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 2.0.0.</entry>
</row>
<row>
<entry><link
linkend="ini.ingres.trace-connect">ingres.trace_connect</link></entry>
<entry>"0"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 1.2.1.</entry>
</row>
<row>
<entry><link linkend="ini.ingres.utf8">ingres.utf8</link></entry>
<entry>"1"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since ingres 2.0.0.</entry>
</row>
</tbody>
</tgroup>
</table>
&ini.php.constants;
</para>
&ini.descriptions.title;
<para>
<variablelist>
<varlistentry xml:id="ini.ingres.allow-persistent">
<term>
<parameter>ingres.allow_persistent</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Specifies whether to allow
<link linkend="features.persistent-connections">persistent connections</link>
to Ingres
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.array-index-start">
<term>
<parameter>ingres.array_index_start</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Specifies, by default, the array returned by <function>ingres_fetch_array</function>
and <function>ingres_fetch_row</function> indexes from 1.
To make the Ingres extension compatible with other database extensions,
set this to 0.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.auto">
<term>
<parameter>ingres.auto</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Enables or disables autocommit emulation. Ingres cannot have multiple cursors
open with autocommit enabled. When enabled, the driver emulates autocommit.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.blob-segment-length">
<term>
<parameter>ingres.blob_segment_length</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Specifies the amount of memory to use when reading BLOB data, in bytes
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.cursor-mode">
<term>
<parameter>ingres.cursor_mode</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Specifies the default mode for cursors opened with ingres_prepare(). Valid values
are <constant>INGRES_CURSOR_UPDATE</constant> or <constant>INGRES_CURSOR_READONLY</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.default-database">
<term>
<parameter>ingres.default_database</parameter>
<type>string</type>
</term>
<listitem>
<para>
Specifies the default database name to use when connecting to the database
server if no other name is specified. Does not apply in
&sqlsafemode;.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.default-password">
<term>
<parameter>ingres.default_password</parameter>
<type>string</type>
</term>
<listitem>
<para>
Specifies the default password to use when connecting to the database
server if no other name is specified. Does not apply in
&sqlsafemode;.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.default-user">
<term>
<parameter>ingres.default_user</parameter>
<type>string</type>
</term>
<listitem>
<para>
Specifies the default user name to use when connecting to the database
server if no other name is specified. Does not apply in
&sqlsafemode;.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.describe">
<term>
<parameter>ingres.describe</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Enables the use of <literal>DESCRIBE INPUT</literal> to determine the expected data types
for queries that use parameters. Available with Ingres 9.1.0 and later.
When disabled, queries that have parameters passed may need to manually
describe the types of those parameters using the <link
linkend="function.ingres-query.types">types</link> parameter in
<function>ingres_query</function>.
</para>
<note>
<para>
Enabling this feature with <function>ingres_query</function> will cause additional
communications traffic between this extension and the server. To
minimize this additional traffic, use <function>ingres_prepare</function> and
<function>ingres_execute</function>.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.fetch-buffer-size">
<term>
<parameter>ingres.fetch_buffer_size</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Specifies the number of pre-fetch rows that <function>ingres_fetch_array</function>,
<function>ingres_fetch_object</function> and
<function>ingres_fetch_row</function> will try and fetch in one fetch operation.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.max-links">
<term>
<parameter>ingres.max_links</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Specifies the maximum number of Ingres sessions allowed per process or thread.
The number of sessions should not exceed the total number of
connected sessions configured within Ingres.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.max-persistent">
<term>
<parameter>ingres.max_persistent</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Specifies the maximum number of persistent Ingres sessions allowed per process or
thread. The number of sessions should not exceed the total
number of connected sessions configured within Ingres.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.reuse-connection">
<term>
<parameter>ingres.reuse_connection</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Reuses an existing active connection if connecting to the same database
with the same user name
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.scrollable">
<term>
<parameter>ingres.scrollable</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Enables support for scrollable cursors. When fetching CLOB or BLOB data, this
should be set to &false;. Available with Ingres 9.2.0 or later.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.trace">
<term>
<parameter>ingres.trace</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Enables simple tracing using <constant>E_NOTICE</constant> messages
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.trace-connect">
<term>
<parameter>ingres.trace_connect</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Prints <constant>E_NOTICE</constant> messages during
<function>ingres_connect</function> or <function>ingres_pconnect</function> calls
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ingres.utf8">
<term>
<parameter>ingres.utf8</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Assumes that strings being passed to National Character column types
(<literal>NVARCHAR</literal> or <literal>NCHAR</literal>) are using UTF8 encoding and converts them to UTF16
for the server
</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
-->