database.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 <!ENTITY % BOOK_ENTITIES SYSTEM "Admin_Guide.ent">
]>
<section id="admin.config.database">
	<title>Database</title>

	<para>The database settings must be set in order for the package
		to work properly. These settings should be provided to you by your
		system administrator or your hosting company.
	</para>

	<variablelist>
		<varlistentry>
			<term>$g_hostname</term>
			<listitem>
				<para>Host name or connection string for Database server. The
					default value is localhost. For MySql, this should be hostname or
					hostname:port (e.g. localhost:3306).
				</para>
			</listitem>
		</varlistentry>
		<varlistentry>
			<term>$g_db_username</term>
			<listitem>
				<para>User name to use for connecting to the database. The user
					needs to have read/write access to the MantisBT database. The default
					user name is &quot;root&quot;.
				</para>
			</listitem>
		</varlistentry>
		<varlistentry>
			<term>$g_db_password</term>
			<listitem>
				<para>Password for the specified user name. The default password
					is empty.
				</para>
			</listitem>
		</varlistentry>
		<varlistentry>
			<term>$g_database_name</term>
			<listitem>
				<para>Name of database that contains MantisBT tables.  The default name is 'bugtracker'.</para>
			</listitem>
		</varlistentry>
		<varlistentry>
			<term>$g_db_type</term>
			<listitem>
				<para>The supported database types are listed in the table
					below.
				</para>
				<para>The PHP extension corresponding to the selected type
					must be enabled (see also <xref linkend="admin.install.requirements.software.versions"/>).
				</para>

				<informaltable>
					<tgroup cols="4">
						<thead>
							<row>
								<entry>RDBMS</entry>
								<entry>db_type (ADOdb)</entry>
								<entry>PHP extension</entry>
								<entry>Comments</entry>
							</row>
						</thead>
						<tbody>
							<row>
								<entry morerows="1" valign="middle">MySQL</entry>
								<entry>mysqli</entry>
								<entry>mysqli</entry>
								<entry>default</entry>
							</row>
							<row>
								<entry>mysql</entry>
								<entry>mysql</entry>
								<entry>Deprecated as of PHP 5.5.0</entry>
							</row>
							<row>
								<entry>PostgreSQL</entry>
								<entry>pgsql</entry>
								<entry>pgsql</entry>
								<entry/>
							</row>
							<row>
								<entry>MS SQL Server</entry>
								<entry>mssqlnative</entry>
								<entry>sqlsrv</entry>
								<entry/>
							</row>
							<row>
								<entry>Oracle</entry>
								<entry>oci8</entry>
								<entry>oci8</entry>
								<entry/>
							</row>
						</tbody>
					</tgroup>
				</informaltable>

			</listitem>
		</varlistentry>
	</variablelist>

	<para>MantisBT allows administrators to configure a prefix and a suffix for
		its tables. This is enables multiple MantisBT installation in the same
		database or schema.
	</para>

	<warning>
		<para>Use of long strings for these configuration options may cause
			issues on RDBMS restricting the size of its identifiers, such as
			Oracle (which imposed a maximum size of 30 characters until version
			12.1; starting with 12cR2 this
			<ulink url="http://docs.oracle.com/database/122/SQLRF/Database-Object-Names-and-Qualifiers.htm#SQLRF51129">
				limit has been increased to 128</ulink>).
		</para>
	</warning>

	<variablelist>
		<varlistentry>
			<term>$g_db_table_prefix</term>
			<listitem>
				<para>Specifies the prefix to be used for all table names.
					The default value is 'mantis'.
				</para>
				<para>The prefix can be used to help make sure table names are unique.
					This is useful for users who are limited to a single database
					or schema.
				</para>
			</listitem>
		</varlistentry>

		<varlistentry>
			<term>$g_db_table_suffix</term>
			<listitem>
				<para>Specifies the prefix to be appended to all table names.
					The default value is 'table'.
				</para>
				<para>The suffix can be used to help make sure table names are unique.
					This is useful for users who are limited to one database.
				</para>
			</listitem>
		</varlistentry>

		<varlistentry>
			<term>$g_db_table_plugin_prefix</term>
			<listitem>
				<para>Specifies the prefix to be used to differentiate tables
					belonging to a plugin's schema from MantisBT's base tables.
					The default value is 'plugin'.
				</para>
				<para>Plugin table names are built using the plugin's
					<emphasis>basename</emphasis>, e.g. for a table named 'foo'
					in the 'Example' plugin (with default values for prefixes
					and suffix), the physical table name would be
					<literal>mantis_plugin_Example_foo_table</literal>.
				</para>
			</listitem>
		</varlistentry>
	</variablelist>

</section>