<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Runtime Configuration</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ingres.installation.html">Installation</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ingres.resources.html">Resource Types</a></div>
<div class="up"><a href="ingres.setup.html">Installing/Configuring</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="ingres.configuration" class="section">
<h2 class="title">Runtime Configuration</h2>
<p class="simpara">
The behaviour of these functions is affected by settings in <var class="filename">php.ini</var>.
</p>
<p class="para">
<table class="doctable table">
<caption><strong>Ingres configuration options</strong></caption>
<thead>
<tr>
<th>Name</th>
<th>Default</th>
<th>Changeable</th>
<th>Changelog</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td><a href="ingres.configuration.html#ini.ingres.allow-persistent" class="link">ingres.allow_persistent</a></td>
<td>"1"</td>
<td>PHP_INI_SYSTEM</td>
<td>Available since ingres 1.0.0</td>
</tr>
<tr>
<td><a href="ingres.configuration.html#ini.ingres.array-index-start" class="link">ingres.array_index_start</a></td>
<td>"1"</td>
<td>PHP_INI_ALL</td>
<td>Available since ingres 1.4.0.</td>
</tr>
<tr>
<td><a href="ingres.configuration.html#ini.ingres.auto" class="link">ingres.auto</a></td>
<td>"1"</td>
<td>PHP_INI_ALL</td>
<td>Available since ingres 2.0.0.</td>
</tr>
<tr>
<td><a href="ingres.configuration.html#ini.ingres.blob-segment-length" class="link">ingres.blob_segment_length</a></td>
<td>"4096"</td>
<td>PHP_INI_ALL</td>
<td>Available since ingres 1.2.0.</td>
</tr>
<tr>
<td><a href="ingres.configuration.html#ini.ingres.cursor-mode" class="link">ingres.cursor_mode</a></td>
<td>"0"</td>
<td>PHP_INI_ALL</td>
<td>Available since ingres 1.1.0.</td>
</tr>
<tr>
<td><a href="ingres.configuration.html#ini.ingres.default-database" class="link">ingres.default_database</a></td>
<td>NULL</td>
<td>PHP_INI_ALL</td>
<td>Available since ingres 1.0.0</td>
</tr>
<tr>
<td><a href="ingres.configuration.html#ini.ingres.default-password" class="link">ingres.default_password</a></td>
<td>NULL</td>
<td>PHP_INI_ALL</td>
<td>Available since ingres 1.0.0</td>
</tr>
<tr>
<td><a href="ingres.configuration.html#ini.ingres.default-user" class="link">ingres.default_user</a></td>
<td>NULL</td>
<td>PHP_INI_ALL</td>
<td>Available since ingres 1.0.0</td>
</tr>
<tr>
<td><a href="ingres.configuration.html#ini.ingres.describe" class="link">ingres.describe</a></td>
<td>1</td>
<td>PHP_INI_ALL</td>
<td>Available since ingres 2.1.0</td>
</tr>
<tr>
<td><a href="ingres.configuration.html#ini.ingres.fetch-buffer-size" class="link">ingres.fetch_buffer_size</a></td>
<td>100</td>
<td>PHP_INI_ALL</td>
<td>Available since ingres 2.1.0</td>
</tr>
<tr>
<td><a href="ingres.configuration.html#ini.ingres.max-links" class="link">ingres.max_links</a></td>
<td>"-1"</td>
<td>PHP_INI_SYSTEM</td>
<td>Available since ingres 1.0.0</td>
</tr>
<tr>
<td><a href="ingres.configuration.html#ini.ingres.max-persistent" class="link">ingres.max_persistent</a></td>
<td>"-1"</td>
<td>PHP_INI_SYSTEM</td>
<td>Available since ingres 1.0.0</td>
</tr>
<tr>
<td><a href="ingres.configuration.html#ini.ingres.reuse-connection" class="link">ingres.reuse_connection</a></td>
<td>"1"</td>
<td>PHP_INI_ALL</td>
<td>Available since ingres 2.0.0</td>
</tr>
<tr>
<td><a href="ingres.configuration.html#ini.ingres.scrollable" class="link">ingres.scrollable</a></td>
<td>"1"</td>
<td>PHP_INI_ALL</td>
<td>Available since ingres 2.0.0.</td>
</tr>
<tr>
<td><a href="ingres.configuration.html#ini.ingres.trace" class="link">ingres.trace</a></td>
<td>"0"</td>
<td>PHP_INI_ALL</td>
<td>Available since ingres 2.0.0.</td>
</tr>
<tr>
<td><a href="ingres.configuration.html#ini.ingres.trace-connect" class="link">ingres.trace_connect</a></td>
<td>"0"</td>
<td>PHP_INI_ALL</td>
<td>Available since ingres 1.2.1.</td>
</tr>
<tr>
<td><a href="ingres.configuration.html#ini.ingres.utf8" class="link">ingres.utf8</a></td>
<td>"1"</td>
<td>PHP_INI_ALL</td>
<td>Available since ingres 2.0.0.</td>
</tr>
</tbody>
</table>
For further details and definitions of the
PHP_INI_* modes, see the <a href="configuration.changes.modes.html" class="xref">Where a configuration setting may be set</a>.
</p>
<p class="para">Here's a short explanation of
the configuration directives.</p>
<p class="para">
<dl>
<dt id="ini.ingres.allow-persistent">
<span class="term">
<em><code class="parameter">ingres.allow_persistent</code></em>
<span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span>
</span>
<dd>
<p class="para">
Specifies whether to allow
<a href="features.persistent-connections.html" class="link">persistent connections</a>
to Ingres
</p>
</dd>
</dt>
<dt id="ini.ingres.array-index-start">
<span class="term">
<em><code class="parameter">ingres.array_index_start</code></em>
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
</span>
<dd>
<p class="para">
Specifies the start value for an integer key for arrays
generated by <span class="function"><a href="function.ingres-fetch-row.html" class="function">ingres_fetch_row()</a></span> or
<span class="function"><a href="function.ingres-fetch-array.html" class="function">ingres_fetch_array()</a></span>. By default
<em><code class="parameter">ingres.array_index_start</code></em> is set to 1. If you wish
to make the ingres extension behave like other database extensions set
this configuration option to 0.
</p>
</dd>
</dt>
<dt id="ini.ingres.auto">
<span class="term">
<em><code class="parameter">ingres.auto</code></em>
<span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span>
</span>
<dd>
<p class="para">
Enables or disables autocommit emulation. Ingres cannot have multiple cursors
open with autocommit enabled. When enabled, the driver emulates autocommit.
</p>
</dd>
</dt>
<dt id="ini.ingres.blob-segment-length">
<span class="term">
<em><code class="parameter">ingres.blob_segment_length</code></em>
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
</span>
<dd>
<p class="para">
Specifies the amount of memory to use when reading BLOB data, in bytes
</p>
</dd>
</dt>
<dt id="ini.ingres.cursor-mode">
<span class="term">
<em><code class="parameter">ingres.cursor_mode</code></em>
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
</span>
<dd>
<p class="para">
Specifies the default mode for cursors opened with ingres_prepare(). Valid values
are <strong><code>INGRES_CURSOR_UPDATE</code></strong> or <strong><code>INGRES_CURSOR_READONLY</code></strong>.
</p>
</dd>
</dt>
<dt id="ini.ingres.default-database">
<span class="term">
<em><code class="parameter">ingres.default_database</code></em>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</span>
<dd>
<p class="para">
Specifies the default database name to use when connecting to the database
server if no other name is specified. Does not apply in
<a href="ini.core.html#ini.sql.safe-mode" class="link">SQL safe mode</a>.
</p>
</dd>
</dt>
<dt id="ini.ingres.default-password">
<span class="term">
<em><code class="parameter">ingres.default_password</code></em>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</span>
<dd>
<p class="para">
Specifies the default password to use when connecting to the database
server if no other name is specified. Does not apply in
<a href="ini.core.html#ini.sql.safe-mode" class="link">SQL safe mode</a>.
</p>
</dd>
</dt>
<dt id="ini.ingres.default-user">
<span class="term">
<em><code class="parameter">ingres.default_user</code></em>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</span>
<dd>
<p class="para">
Specifies the default user name to use when connecting to the database
server if no other name is specified. Does not apply in
<a href="ini.core.html#ini.sql.safe-mode" class="link">SQL safe mode</a>.
</p>
</dd>
</dt>
<dt id="ini.ingres.describe">
<span class="term">
<em><code class="parameter">ingres.describe</code></em>
<span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span>
</span>
<dd>
<p class="para">
Enables the use of <em>DESCRIBE INPUT</em> 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 <a href="function.ingres-query.html#function.ingres-query.types" class="link">types</a> parameter in
<span class="function"><a href="function.ingres-query.html" class="function">ingres_query()</a></span>.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Enabling this feature with <span class="function"><a href="function.ingres-query.html" class="function">ingres_query()</a></span> will cause additional
communications traffic between this extension and the server. To
minimize this additional traffic, use <span class="function"><a href="function.ingres-prepare.html" class="function">ingres_prepare()</a></span> and
<span class="function"><a href="function.ingres-execute.html" class="function">ingres_execute()</a></span>.
</p>
</p></blockquote>
</dd>
</dt>
<dt id="ini.ingres.fetch-buffer-size">
<span class="term">
<em><code class="parameter">ingres.fetch_buffer_size</code></em>
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
</span>
<dd>
<p class="para">
Specifies the number of pre-fetch rows that <span class="function"><a href="function.ingres-fetch-array.html" class="function">ingres_fetch_array()</a></span>,
<span class="function"><a href="function.ingres-fetch-object.html" class="function">ingres_fetch_object()</a></span> and
<span class="function"><a href="function.ingres-fetch-row.html" class="function">ingres_fetch_row()</a></span> will try and fetch in one fetch operation.
</p>
</dd>
</dt>
<dt id="ini.ingres.max-links">
<span class="term">
<em><code class="parameter">ingres.max_links</code></em>
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
</span>
<dd>
<p class="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.
</p>
</dd>
</dt>
<dt id="ini.ingres.max-persistent">
<span class="term">
<em><code class="parameter">ingres.max_persistent</code></em>
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
</span>
<dd>
<p class="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.
</p>
</dd>
</dt>
<dt id="ini.ingres.reuse-connection">
<span class="term">
<em><code class="parameter">ingres.reuse_connection</code></em>
<span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span>
</span>
<dd>
<p class="para">
Reuses an existing active connection if connecting to the same database
with the same user name
</p>
</dd>
</dt>
<dt id="ini.ingres.scrollable">
<span class="term">
<em><code class="parameter">ingres.scrollable</code></em>
<span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span>
</span>
<dd>
<p class="para">
Enables support for scrollable cursors. When fetching CLOB or BLOB data, this
should be set to <strong><code>FALSE</code></strong>. Available with Ingres 9.2.0 or later.
</p>
</dd>
</dt>
<dt id="ini.ingres.trace">
<span class="term">
<em><code class="parameter">ingres.trace</code></em>
<span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span>
</span>
<dd>
<p class="para">
Enables simple tracing using <strong><code>E_NOTICE</code></strong> messages
</p>
</dd>
</dt>
<dt id="ini.ingres.trace-connect">
<span class="term">
<em><code class="parameter">ingres.trace_connect</code></em>
<span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span>
</span>
<dd>
<p class="para">
Prints <strong><code>E_NOTICE</code></strong> messages during
<span class="function"><a href="function.ingres-connect.html" class="function">ingres_connect()</a></span> or <span class="function"><a href="function.ingres-pconnect.html" class="function">ingres_pconnect()</a></span> calls
</p>
</dd>
</dt>
<dt id="ini.ingres.utf8">
<span class="term">
<em><code class="parameter">ingres.utf8</code></em>
<span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span>
</span>
<dd>
<p class="para">
Assumes that strings being passed to National Character column types
(<em>NVARCHAR</em> or <em>NCHAR</em>) are using UTF8 encoding and converts them to UTF16
for the server
</p>
</dd>
</dt>
</dl>
</p>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ingres.installation.html">Installation</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ingres.resources.html">Resource Types</a></div>
<div class="up"><a href="ingres.setup.html">Installing/Configuring</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
