dbs Sun Sep 25 10:41:47 2005 EDT
Modified files:
/phpdoc/en/reference/ibm_db2/functions db2-client-info.xml
db2-server-info.xml
Log:
Flesh out db2_server_info().
Declare correct number of columns in db2_client_info.
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-client-info.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-client-info.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-client-info.xml:1.1
phpdoc/en/reference/ibm_db2/functions/db2-client-info.xml:1.2
--- phpdoc/en/reference/ibm_db2/functions/db2-client-info.xml:1.1 Sun Sep
25 09:50:52 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-client-info.xml Sun Sep 25
10:41:47 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc.
-->
<refentry id="function.db2-client-info">
<refnamediv>
@@ -19,7 +19,7 @@
the DB2 client properties:
<table>
<title>DB2 client properties</title>
- <tgroup cols="2">
+ <tgroup cols="3">
<thead>
<row>
<entry>Property name</entry>
@@ -30,12 +30,12 @@
<tbody>
<row>
<entry>APPL_CODEPAGE</entry>
- <entry>Unsigned 32-bit integer</entry>
+ <entry>int</entry>
<entry>The application code page.</entry>
</row>
<row>
<entry>CONN_CODEPAGE</entry>
- <entry>Unsigned 32-bit integer</entry>
+ <entry>int</entry>
<entry>The code page for the current connection.</entry>
</row>
<row>
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-server-info.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-server-info.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-server-info.xml:1.1
phpdoc/en/reference/ibm_db2/functions/db2-server-info.xml:1.2
--- phpdoc/en/reference/ibm_db2/functions/db2-server-info.xml:1.1 Sun Sep
25 09:50:52 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-server-info.xml Sun Sep 25
10:41:47 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc.
-->
<refentry id="function.db2-server-info">
<refnamediv>
@@ -13,7 +13,245 @@
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
- &warn.undocumented.func;
+ <para>
+ 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 DB2 client properties:
+ <table>
+ <title>DB2 server properties</title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Property name</entry>
+ <entry>Return type</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>DBMS_NAME</entry>
+ <entry>string</entry>
+ <entry>The name of the database server to which you are
+ connected.</entry>
+ </row>
+ <row>
+ <entry>DBMS_VER</entry>
+ <entry>string</entry>
+ <entry>The version of the database server, in the form of a string
+ "MM.mm.rrrr" where <varname>MM</varname> is the major version,
+ <varname>mm</varname> is the minor version,
+ and <varname>uuuu</varname> is the update. For example, "08.02.0001"
+ represents major version 8, minor version 2, update 1.
+ </entry>
+ </row>
+ <row>
+ <entry>DB_CODEPAGE</entry>
+ <entry>int</entry>
+ <entry>The code page of the database to which you are connected.</entry>
+ </row>
+ <row>
+ <entry>DB_NAME</entry>
+ <entry>string</entry>
+ <entry>The name of the database to which you are connected.</entry>
+ </row>
+ <row>
+ <entry>DFT_ISOLATION</entry>
+ <entry>string</entry>
+ <entry>The default transaction isolation level supported by the
+ server:
+ <variablelist>
+ <varlistentry>
+ <term>UR</term>
+ <listitem>
+ <para>
+ Uncommitted read: changes are immediately visible by all
+ concurrent transactions.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>CS</term>
+ <listitem>
+ <para>
+ Cursor staability: a row read by one transaction can be altered and
+ committed by a second concurrent transaction.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>RS</term>
+ <listitem>
+ <para>
+ Read stability: a transaction can add or remove rows matching a
+ search condition or a pending transaction.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>RR</term>
+ <listitem>
+ <para>
+ Repeatable read: data affected by pending transaction is not
+ available to other transactions.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>NC</term>
+ <listitem>
+ <para>
+ No commit: any changes are visible at the end of a successful
+ operation. Explicit commits and rollbacks are not allowed.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </entry>
+ </row>
+ <row>
+ <entry>IDENTIFIER_QUOTE_CHAR</entry>
+ <entry>string</entry>
+ <entry>The character used to delimit an identifier.</entry>
+ </row>
+ <row>
+ <entry>INST_NAME</entry>
+ <entry>string</entry>
+ <entry>The real hostname for the database server.</entry>
+ </row>
+ <row>
+ <entry>ISOLATION_OPTION</entry>
+ <entry>array</entry>
+ <entry>An array of the isolation options supported by the
+ database server. The isolation options are described in
+ the DFT_ISOLATION property.</entry>
+ </row>
+ <row>
+ <entry>KEYWORDS</entry>
+ <entry>array</entry>
+ <entry>An array of the keywords reserved by the database
+ server.</entry>
+ </row>
+ <row>
+ <entry>LIKE_ESCAPE_CLAUSE</entry>
+ <entry>bool</entry>
+ <entry>&true; if the database server supports the
+ use of <literal>%</literal> and <literal>_</literal> wildcard
+ characters. &false; if the database server does not
+ support these wildcard characters.</entry>
+ </row>
+ <row>
+ <entry>MAX_COL_NAME_LEN</entry>
+ <entry>int</entry>
+ <entry>Maximum length of a column name supported by the database
+ server, expressed in bytes.</entry>
+ </row>
+ <row>
+ <entry>MAX_IDENTIFIER_LEN</entry>
+ <entry>int</entry>
+ <entry>Maximum length of an SQL identifier supported by the database
+ server, expressed in characters.</entry>
+ </row>
+ <row>
+ <entry>MAX_INDEX_SIZE</entry>
+ <entry>Maximum size of columns combined in an index supported by the
+ database server, expressed in bytes.</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>MAX_PROC_NAME_LEN</entry>
+ <entry>int</entry>
+ <entry>Maximum length of a procedure name supported by the database
+ server, expressed in bytes.</entry>
+ </row>
+ <row>
+ <entry>MAX_ROW_SIZE</entry>
+ <entry>int</entry>
+ <entry>Maximum length of a row in a base table supported by the
+ database server, expressed in bytes.</entry>
+ </row>
+ <row>
+ <entry>MAX_SCHEMA_NAME_LEN</entry>
+ <entry>int</entry>
+ <entry>Maximum length of a schema name supported by the database
+ server, expressed in bytes.</entry>
+ </row>
+ <row>
+ <entry>MAX_STATEMENT_LEN</entry>
+ <entry>int</entry>
+ <entry>Maximum length of an SQL statement supported by the database
+ server, expressed in bytes.</entry>
+ </row>
+ <row>
+ <entry>MAX_TABLE_NAME_LEN</entry>
+ <entry>int</entry>
+ <entry>Maximum length of a table name supported by the database
+ server, expressed in bytes.</entry>
+ </row>
+ <row>
+ <entry>NON_NULLABLE_COLUMNS</entry>
+ <entry>bool</entry>
+ <entry>&true; if the database server supports columns that can be
+ defined as NOT NULL, &false; if the database server does not support
+ columns defined as NOT NULL.</entry>
+ </row>
+ <row>
+ <entry>PROCEDURES</entry>
+ <entry>bool</entry>
+ <entry>&true; if the database server supports the use of the CALL
+ statement to call stored procedures, &false; if the database
+ server does not support the CALL statement.</entry>
+ </row>
+ <row>
+ <entry>SPECIAL_CHARS</entry>
+ <entry>string</entry>
+ <entry>A string containing all of the characters other than
+ a-Z, 0-9, and underscore that can be used in an identifier name.</entry>
+ </row>
+ <row>
+ <entry>SQL_CONFORMANCE</entry>
+ <entry>string</entry>
+ <entry>The level of conformance to the ANSI/ISO SQL-92 specification
+ offered by the database server:
+ <variablelist>
+ <varlistentry>
+ <term>ENTRY</term>
+ <listitem>
+ <para>
+ Entry-level SQL-92 compliance.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>FIPS127</term>
+ <listitem>
+ <para>
+ FIPS-127-2 transitional compliance.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>FULL</term>
+ <listitem>
+ <para>
+ Full level SQL-92 compliance.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>INTERMEDIATE</term>
+ <listitem>
+ <para>
+ Intermediate level SQL-92 compliance.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
</refsect1>
<refsect1 role="parameters">
@@ -24,7 +262,7 @@
<term><parameter>connection</parameter></term>
<listitem>
<para>
- Its description
+ Specifies an active DB2 client connection.
</para>
</listitem>
</varlistentry>
@@ -34,8 +272,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- What the function returns, first on success, then on failure. See
- also the &return.success; entity
+ Returns an object on a successful call. Returns &false; on failure.
</para>
</refsect1>
@@ -106,17 +343,14 @@
-->
- <!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
- <member><function></function></member>
- <member>Or <link linkend="somethingelse">something else</link></member>
+ <member><function>db2_client_info</function></member>
</simplelist>
</para>
</refsect1>
- -->
</refentry>
