Documentation: revised database types

mantisbt · May 21, 2013 · cadf5fd · cadf5fd
1 parent 7c2273d
commit cadf5fd
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 12 deletions.
diff --git a/config_defaults_inc.php b/config_defaults_inc.php
@@ -69,9 +69,18 @@
 	$g_db_schema			= '';
 
 	/**
-	 * Defines the database type. The supported default is 'mysql'.
-	 * Supported types: 'mysql' or 'mysqli' for MySQL, 'pgsql' for PostgreSQL,
-	 * 'odbc_mssql', 'mssql' for MS SQL Server, 'oci8' for Oracle, and 'db2' for DB2.
+	 * Defines the database type. Supported types are listed below;
+	 * the corresponding PHP extension must be enabled.
+	 *
+	 * RDBMS           db_type       PHP ext   Comments
+	 * -----           -------       -------   --------
+	 * MySQL           mysql         mysql     default
+	 *                 mysqli        mysqli
+	 * PostgreSQL      pgsql         pgsql
+	 * MS SQL Server   mssqlnative   sqlsrv    experimental
+	 * Oracle          oci8          oci8      experimental
+	 * DB2             db2           ibm-db2   experimental
+	 *
 	 * @global string $g_db_type
 	 */
 	$g_db_type				= 'mysql';

diff --git a/docbook/administration_guide/en/configuration.sgml b/docbook/administration_guide/en/configuration.sgml
@@ -49,11 +49,63 @@
             <varlistentry>
                 <term>$g_db_type</term>
                 <listitem>
-                    <para>The supported database types include: 'mysql' or 'mysqli' for MySQL,
-		    'pgsql' for PostgreSQL, 'mssql' for MS SQL Server, 'oci8' for Oracle,
-		    and 'db2' for DB2.  It is important to make sure that the PHP extension
-		    corresponding to the database type is enabled.
-                    </para>
+					<para>The supported database types are listed in the table
+						below.
+					</para>
+					<para>The PHP extension corresponding to the selected type
+						must be enabled.
+					</para>
+
+					<informaltable>
+						<tgroup cols="4">
+							<thead>
+								<row>
+									<entry>RDBMS</entry>
+									<entry>db_type</entry>
+									<entry>PHP extension</entry>
+									<entry>Comments</entry>
+								</row>
+							</thead>
+							<tbody>
+								<row>
+									<entry morerows='1' valign='middle'>MySQL</entry>
+									<entry>mysql</entry>
+									<entry>mysql</entry>
+									<entry>default</entry>
+								</row>
+								<row>
+									<entry>mysqli</entry>
+									<entry>mysqli</entry>
+									<entry></entry>
+								</row>
+								<row>
+									<entry>PostgreSQL</entry>
+									<entry>pgsql</entry>
+									<entry>pgsql</entry>
+									<entry></entry>
+								</row>
+								<row>
+									<entry>IBM DB2</entry>
+									<entry>db2</entry>
+									<entry>db2</entry>
+									<entry>experimental</entry>
+								</row>
+								<row>
+									<entry>MS SQL Server</entry>
+									<entry>mssqlnative</entry>
+									<entry>sqlsrv</entry>
+									<entry>experimental</entry>
+								</row>
+								<row>
+									<entry>Oracle</entry>
+									<entry>oci8</entry>
+									<entry>oci8</entry>
+									<entry>experimental</entry>
+								</row>
+							</tbody>
+						</tgroup>
+					</informaltable>
+
                 </listitem>
             </varlistentry>
         </variablelist>

diff --git a/docbook/administration_guide/en/installation.sgml b/docbook/administration_guide/en/installation.sgml
@@ -163,10 +163,10 @@
 						<itemizedlist>
 							<listitem><para><emphasis>mandatory</emphasis>:
 								the extension for the RDBMS being used (
-									mysqli,
+									mysql/mysqli,
 									pgsql,
 									oci8,
-									mssql/sqlsrv,
+									sqlsrv,
 									ibm-db2
 								)
 							</para></listitem>
@@ -201,7 +201,7 @@
 								(UTF8) strings processing. Required if the admin
 								needs to list the SQL queries generated by
 								MantisBT (see <emphasis>$g_show_queries_list</emphasis>
-								in <xref linkend="admin.config.misc" />).
+								in <xref linkend="admin.config.misc">).
 							</para></listitem>
 
 						</itemizedlist>
@@ -247,7 +247,7 @@
 								<entry>MySQL</entry>
 								<entry>4.1.x</entry>
 								<entry>5.0.x or above</entry>
-								<entry>PHP extension: mysqli</entry>
+								<entry>PHP extension: mysql/mysqli</entry>
 							</row>
 							<row>
 								<entry>PostgreSQL</entry>