<!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>Returns an object with properties that describe the DB2 database server</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.db2-rollback.html">db2_rollback</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.db2-set-option.html">db2_set_option</a></div>
<div class="up"><a href="ref.ibm-db2.html">IBM DB2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.db2-server-info" class="refentry">
<div class="refnamediv">
<h1 class="refname">db2_server_info</h1>
<p class="verinfo">(PECL ibm_db2 >= 1.1.1)</p><p class="refpurpose"><span class="refname">db2_server_info</span> — <span class="dc-title">Returns an object with properties that describe the DB2 database server</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.db2-server-info-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><strong>db2_server_info</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$connection</code></span>
)</div>
<p class="para rdfs-comment">
This function returns an object with read-only properties that return
information about the IBM DB2, Cloudscape, or Apache Derby database server.
The following table lists the database server properties:
<table class="doctable table">
<caption><strong>Database server properties</strong></caption>
<thead>
<tr>
<th>Property name</th>
<th>Return type</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>DBMS_NAME</td>
<td>string</td>
<td>The name of the database server to which you are
connected. For DB2 servers this is a combination of
<em>DB2</em> followed by the operating system on which
the database server is running.</td>
</tr>
<tr>
<td>DBMS_VER</td>
<td>string</td>
<td>The version of the database server, in the form of a string
"MM.mm.uuuu" where <var class="varname"><var class="varname">MM</var></var> is the major version,
<var class="varname"><var class="varname">mm</var></var> is the minor version,
and <var class="varname"><var class="varname">uuuu</var></var> is the update. For example, "08.02.0001"
represents major version 8, minor version 2, update 1.
</td>
</tr>
<tr>
<td>DB_CODEPAGE</td>
<td>int</td>
<td>The code page of the database to which you are connected.</td>
</tr>
<tr>
<td>DB_NAME</td>
<td>string</td>
<td>The name of the database to which you are connected.</td>
</tr>
<tr>
<td>DFT_ISOLATION</td>
<td>string</td>
<td>
<p class="para">The default transaction isolation level supported by the
server:
<dl>
<dt>
<span class="term">UR</span>
<dd>
<p class="para">
Uncommitted read: changes are immediately visible by all
concurrent transactions.
</p>
</dd>
</dt>
<dt>
<span class="term">CS</span>
<dd>
<p class="para">
Cursor stability: a row read by one transaction can be altered and
committed by a second concurrent transaction.
</p>
</dd>
</dt>
<dt>
<span class="term">RS</span>
<dd>
<p class="para">
Read stability: a transaction can add or remove rows matching a
search condition or a pending transaction.
</p>
</dd>
</dt>
<dt>
<span class="term">RR</span>
<dd>
<p class="para">
Repeatable read: data affected by pending transaction is not
available to other transactions.
</p>
</dd>
</dt>
<dt>
<span class="term">NC</span>
<dd>
<p class="para">
No commit: any changes are visible at the end of a successful
operation. Explicit commits and rollbacks are not allowed.
</p>
</dd>
</dt>
</dl>
</p>
</td>
</tr>
<tr>
<td>IDENTIFIER_QUOTE_CHAR</td>
<td>string</td>
<td>The character used to delimit an identifier.</td>
</tr>
<tr>
<td>INST_NAME</td>
<td>string</td>
<td>The instance on the database server that contains the
database.</td>
</tr>
<tr>
<td>ISOLATION_OPTION</td>
<td>array</td>
<td>An array of the isolation options supported by the
database server. The isolation options are described in
the DFT_ISOLATION property.</td>
</tr>
<tr>
<td>KEYWORDS</td>
<td>array</td>
<td>An array of the keywords reserved by the database
server.</td>
</tr>
<tr>
<td>LIKE_ESCAPE_CLAUSE</td>
<td>bool</td>
<td><strong><code>TRUE</code></strong> if the database server supports the
use of <em>%</em> and <em>_</em> wildcard
characters. <strong><code>FALSE</code></strong> if the database server does not
support these wildcard characters.</td>
</tr>
<tr>
<td>MAX_COL_NAME_LEN</td>
<td>int</td>
<td>Maximum length of a column name supported by the database
server, expressed in bytes.</td>
</tr>
<tr>
<td>MAX_IDENTIFIER_LEN</td>
<td>int</td>
<td>Maximum length of an SQL identifier supported by the database
server, expressed in characters.</td>
</tr>
<tr>
<td>MAX_INDEX_SIZE</td>
<td>int</td>
<td>Maximum size of columns combined in an index supported by the
database server, expressed in bytes.</td>
</tr>
<tr>
<td>MAX_PROC_NAME_LEN</td>
<td>int</td>
<td>Maximum length of a procedure name supported by the database
server, expressed in bytes.</td>
</tr>
<tr>
<td>MAX_ROW_SIZE</td>
<td>int</td>
<td>Maximum length of a row in a base table supported by the
database server, expressed in bytes.</td>
</tr>
<tr>
<td>MAX_SCHEMA_NAME_LEN</td>
<td>int</td>
<td>Maximum length of a schema name supported by the database
server, expressed in bytes.</td>
</tr>
<tr>
<td>MAX_STATEMENT_LEN</td>
<td>int</td>
<td>Maximum length of an SQL statement supported by the database
server, expressed in bytes.</td>
</tr>
<tr>
<td>MAX_TABLE_NAME_LEN</td>
<td>int</td>
<td>Maximum length of a table name supported by the database
server, expressed in bytes.</td>
</tr>
<tr>
<td>NON_NULLABLE_COLUMNS</td>
<td>bool</td>
<td><strong><code>TRUE</code></strong> if the database server supports columns that can be
defined as NOT NULL, <strong><code>FALSE</code></strong> if the database server does not support
columns defined as NOT NULL.</td>
</tr>
<tr>
<td>PROCEDURES</td>
<td>bool</td>
<td><strong><code>TRUE</code></strong> if the database server supports the use of the CALL
statement to call stored procedures, <strong><code>FALSE</code></strong> if the database
server does not support the CALL statement.</td>
</tr>
<tr>
<td>SPECIAL_CHARS</td>
<td>string</td>
<td>A string containing all of the characters other than
a-Z, 0-9, and underscore that can be used in an identifier name.</td>
</tr>
<tr>
<td>SQL_CONFORMANCE</td>
<td>string</td>
<td>
<p class="para">The level of conformance to the ANSI/ISO SQL-92 specification
offered by the database server:
<dl>
<dt>
<span class="term">ENTRY</span>
<dd>
<p class="para">
Entry-level SQL-92 compliance.
</p>
</dd>
</dt>
<dt>
<span class="term">FIPS127</span>
<dd>
<p class="para">
FIPS-127-2 transitional compliance.
</p>
</dd>
</dt>
<dt>
<span class="term">FULL</span>
<dd>
<p class="para">
Full level SQL-92 compliance.
</p>
</dd>
</dt>
<dt>
<span class="term">INTERMEDIATE</span>
<dd>
<p class="para">
Intermediate level SQL-92 compliance.
</p>
</dd>
</dt>
</dl>
</p>
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.db2-server-info-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">connection</code></em></span>
<dd>
<p class="para">
Specifies an active DB2 client connection.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.db2-server-info-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an object on a successful call. Returns <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.db2-server-info-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-1183">
<p><strong>Example #1 A <span class="function"><strong>db2_server_info()</strong></span> example</strong></p>
<div class="example-contents"><p>
To retrieve information about the server, you must pass a valid
database connection resource to <span class="function"><strong>db2_server_info()</strong></span>.
</p></div>
<div class="example-contents"><div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'sample'</span><span style="color: #007700">, </span><span style="color: #DD0000">'db2inst1'</span><span style="color: #007700">, </span><span style="color: #DD0000">'ibmdb2'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$server </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_server_info</span><span style="color: #007700">( </span><span style="color: #0000BB">$conn </span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$server</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"DBMS_NAME: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">DBMS_NAME </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"DBMS_VER: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">DBMS_VER </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"DB_CODEPAGE: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">DB_CODEPAGE </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"DB_NAME: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">DB_NAME </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"INST_NAME: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">INST_NAME </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"SPECIAL_CHARS: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">SPECIAL_CHARS </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"KEYWORDS: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">sizeof</span><span style="color: #007700">(</span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">KEYWORDS</span><span style="color: #007700">) );<br /> echo </span><span style="color: #DD0000">"DFT_ISOLATION: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">DFT_ISOLATION </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"ISOLATION_OPTION: "</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$il </span><span style="color: #007700">= </span><span style="color: #DD0000">''</span><span style="color: #007700">;<br /> foreach( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">ISOLATION_OPTION </span><span style="color: #007700">as </span><span style="color: #0000BB">$opt </span><span style="color: #007700">)<br /> {<br /> </span><span style="color: #0000BB">$il </span><span style="color: #007700">.= </span><span style="color: #0000BB">$opt</span><span style="color: #007700">.</span><span style="color: #DD0000">" "</span><span style="color: #007700">;<br /> }<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$il </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"SQL_CONFORMANCE: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">SQL_CONFORMANCE </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"PROCEDURES: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">PROCEDURES </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"IDENTIFIER_QUOTE_CHAR: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">IDENTIFIER_QUOTE_CHAR </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"LIKE_ESCAPE_CLAUSE: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">LIKE_ESCAPE_CLAUSE </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"MAX_COL_NAME_LEN: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">MAX_COL_NAME_LEN </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"MAX_ROW_SIZE: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">MAX_ROW_SIZE </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"MAX_IDENTIFIER_LEN: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">MAX_IDENTIFIER_LEN </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"MAX_INDEX_SIZE: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">MAX_INDEX_SIZE </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"MAX_PROC_NAME_LEN: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">MAX_PROC_NAME_LEN </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"MAX_SCHEMA_NAME_LEN: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">MAX_SCHEMA_NAME_LEN </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"MAX_STATEMENT_LEN: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">MAX_STATEMENT_LEN </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"MAX_TABLE_NAME_LEN: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">MAX_TABLE_NAME_LEN </span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"NON_NULLABLE_COLUMNS: "</span><span style="color: #007700">; </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$server</span><span style="color: #007700">-></span><span style="color: #0000BB">NON_NULLABLE_COLUMNS </span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">db2_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div></div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen"><div class="cdata"><pre>DBMS_NAME: string(9) "DB2/LINUX"
DBMS_VER: string(10) "08.02.0000"
DB_CODEPAGE: int(1208)
DB_NAME: string(6) "SAMPLE"
INST_NAME: string(8) "db2inst1"
SPECIAL_CHARS: string(2) "@#"
KEYWORDS: int(179)
DFT_ISOLATION: string(2) "CS"
ISOLATION_OPTION: string(12) "UR CS RS RR "
SQL_CONFORMANCE: string(7) "FIPS127"
PROCEDURES: bool(true)
IDENTIFIER_QUOTE_CHAR: string(1) """
LIKE_ESCAPE_CLAUSE: bool(true)
MAX_COL_NAME_LEN: int(30)
MAX_ROW_SIZE: int(32677)
MAX_IDENTIFIER_LEN: int(18)
MAX_INDEX_SIZE: int(1024)
MAX_PROC_NAME_LEN: int(128)
MAX_SCHEMA_NAME_LEN: int(30)
MAX_STATEMENT_LEN: int(2097152)
MAX_TABLE_NAME_LEN: int(128)
NON_NULLABLE_COLUMNS: bool(true)</pre></div></div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.db2-server-info-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.db2-client-info.html" class="function" rel="rdfs-seeAlso">db2_client_info()</a> - Returns an object with properties that describe the DB2 database client</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.db2-rollback.html">db2_rollback</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.db2-set-option.html">db2_set_option</a></div>
<div class="up"><a href="ref.ibm-db2.html">IBM DB2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
