diff options
Diffstat (limited to 'hugo/doc/html/config.html')
| -rw-r--r-- | hugo/doc/html/config.html | 4912 |
1 files changed, 4912 insertions, 0 deletions
diff --git a/hugo/doc/html/config.html b/hugo/doc/html/config.html new file mode 100644 index 0000000..db48518 --- /dev/null +++ b/hugo/doc/html/config.html @@ -0,0 +1,4912 @@ + + +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + + +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>Configuration — phpMyAdmin 4.0.7 documentation</title> + + <link rel="stylesheet" href="_static/default.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '', + VERSION: '4.0.7', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/underscore.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + <link rel="copyright" title="Copyright" href="copyright.html" /> + <link rel="top" title="phpMyAdmin 4.0.7 documentation" href="index.html" /> + <link rel="next" title="User Guide" href="user.html" /> + <link rel="prev" title="Installation" href="setup.html" /> + </head> + <body> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="user.html" title="User Guide" + accesskey="N">next</a> |</li> + <li class="right" > + <a href="setup.html" title="Installation" + accesskey="P">previous</a> |</li> + <li><a href="index.html">phpMyAdmin 4.0.7 documentation</a> »</li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <div class="section" id="configuration"> +<span id="config"></span><span id="index-0"></span><h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1> +<p>Almost all configurable data is placed in <tt class="file docutils literal"><span class="pre">config.inc.php</span></tt>. If this file +does not exist, please refer to the <a class="reference internal" href="setup.html#setup"><em>Installation</em></a> section to create one. This +file only needs to contain the parameters you want to change from their +corresponding default value in <tt class="file docutils literal"><span class="pre">libraries/config.default.php</span></tt>.</p> +<p>The parameters which relate to design (like colors) are placed in +<tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>. You might also want to create +<tt class="file docutils literal"><span class="pre">config.footer.inc.php</span></tt> and <tt class="file docutils literal"><span class="pre">config.header.inc.php</span></tt> files to add +your site specific code to be included on start and end of each page.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">Some distributions (eg. Debian or Ubuntu) store <tt class="file docutils literal"><span class="pre">config.inc.php</span></tt> in +<tt class="docutils literal"><span class="pre">/etc/phpmyadmin</span></tt> instead of within phpMyAdmin sources.</p> +</div> +<div class="admonition warning"> +<p class="first admonition-title">Warning</p> +<p class="last"><a class="reference internal" href="glossary.html#term-mac"><em class="xref std std-term">Mac</em></a> users should note that if you are on a version before +<a class="reference internal" href="glossary.html#term-mac-os-x"><em class="xref std std-term">Mac OS X</em></a>, PHP does not seem to +like <a class="reference internal" href="glossary.html#term-mac"><em class="xref std std-term">Mac</em></a> end of lines character (<tt class="docutils literal"><span class="pre">\r</span></tt>). So +ensure you choose the option that allows to use the *nix end of line +character (<tt class="docutils literal"><span class="pre">\n</span></tt>) in your text editor before saving a script you have +modified.</p> +</div> +<div class="section" id="basic-settings"> +<h2>Basic settings<a class="headerlink" href="#basic-settings" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_PmaAbsoluteUri"> +<tt class="descname">$cfg['PmaAbsoluteUri']</tt><a class="headerlink" href="#cfg_PmaAbsoluteUri" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Sets here the complete <a class="reference internal" href="glossary.html#term-url"><em class="xref std std-term">URL</em></a> (with full path) to your phpMyAdmin +installation’s directory. E.g. +<tt class="docutils literal"><span class="pre">http://www.example.net/path_to_your_phpMyAdmin_directory/</span></tt>. Note also +that the <a class="reference internal" href="glossary.html#term-url"><em class="xref std std-term">URL</em></a> on some web servers are case–sensitive. Don’t forget +the trailing slash at the end.</p> +<p>Starting with version 2.3.0, it is advisable to try leaving this blank. In +most cases phpMyAdmin automatically detects the proper setting. Users of +port forwarding will need to set <span class="target" id="index-1"></span><a class="reference internal" href="#cfg_PmaAbsoluteUri"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['PmaAbsoluteUri']</span></tt></a> +(<a class="reference external" href="https://sourceforge.net/p/phpmyadmin/support-requests/795/">more info</a>).</p> +<p>A good test is to browse a table, edit a row and save it. There should be +an error message if phpMyAdmin is having trouble auto–detecting the correct +value. If you get an error that this must be set or if the autodetect code +fails to detect your path, please post a bug report on our bug tracker so +we can improve the code.</p> +<div class="admonition-see-also admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><a class="reference internal" href="faq.html#faq1-40"><em>1.40 When accessing phpMyAdmin via an Apache reverse proxy, cookie login does not work.</em></a></p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_PmaNoRelation_DisableWarning"> +<tt class="descname">$cfg['PmaNoRelation_DisableWarning']</tt><a class="headerlink" href="#cfg_PmaNoRelation_DisableWarning" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Starting with version 2.3.0 phpMyAdmin offers a lot of features to +work with master / foreign – tables (see <span class="target" id="index-2"></span><a class="reference internal" href="#cfg_Servers_pmadb"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></tt></a>).</p> +<p>If you tried to set this +up and it does not work for you, have a look on the <em class="guilabel">Structure</em> page +of one database where you would like to use it. You will find a link +that will analyze why those features have been disabled.</p> +<p>If you do not want to use those features set this variable to <tt class="docutils literal"><span class="pre">true</span></tt> to +stop this message from appearing.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_SuhosinDisableWarning"> +<tt class="descname">$cfg['SuhosinDisableWarning']</tt><a class="headerlink" href="#cfg_SuhosinDisableWarning" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>A warning is displayed on the main page if Suhosin is detected.</p> +<p>You can set this parameter to <tt class="docutils literal"><span class="pre">true</span></tt> to stop this message from appearing.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_McryptDisableWarning"> +<tt class="descname">$cfg['McryptDisableWarning']</tt><a class="headerlink" href="#cfg_McryptDisableWarning" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Disable the default warning that is displayed if mcrypt is missing for +cookie authentication.</p> +<p>You can set this parameter to <tt class="docutils literal"><span class="pre">true</span></tt> to stop this message from appearing.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ServerLibraryDifference_DisableWarning"> +<tt class="descname">$cfg['ServerLibraryDifference_DisableWarning']</tt><a class="headerlink" href="#cfg_ServerLibraryDifference_DisableWarning" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>A warning is displayed on the main page if there is a difference +between the MySQL library and server version.</p> +<p>You can set this parameter to <tt class="docutils literal"><span class="pre">true</span></tt> to stop this message from appearing.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ReservedWordDisableWarning"> +<tt class="descname">$cfg['ReservedWordDisableWarning']</tt><a class="headerlink" href="#cfg_ReservedWordDisableWarning" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>This warning is displayed on the Structure page of a table if one or more +column names match with words which are MySQL reserved.</p> +<p>If you want to turn off this warning, you can set it to <tt class="docutils literal"><span class="pre">true</span></tt> and +warning will not longer be displayed</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_TranslationWarningThreshold"> +<tt class="descname">$cfg['TranslationWarningThreshold']</tt><a class="headerlink" href="#cfg_TranslationWarningThreshold" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">80</td> +</tr> +</tbody> +</table> +<p>Show warning about incomplete translations on certain threshold.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_AllowThirdPartyFraming"> +<tt class="descname">$cfg['AllowThirdPartyFraming']</tt><a class="headerlink" href="#cfg_AllowThirdPartyFraming" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Setting this to <tt class="docutils literal"><span class="pre">true</span></tt> allows phpMyAdmin to be included inside a frame, +and is a potential security hole allowing cross-frame scripting attacks or +clickjacking.</p> +</dd></dl> + +</div> +<div class="section" id="server-connection-settings"> +<h2>Server connection settings<a class="headerlink" href="#server-connection-settings" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_Servers"> +<tt class="descname">$cfg['Servers']</tt><a class="headerlink" href="#cfg_Servers" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">one server array with settings listed bellow</td> +</tr> +</tbody> +</table> +<p>Since version 1.4.2, phpMyAdmin supports the administration of multiple +MySQL servers. Therefore, a <span class="target" id="index-3"></span><a class="reference internal" href="#cfg_Servers"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers']</span></tt></a>-array has been +added which contains the login information for the different servers. The +first <span class="target" id="index-4"></span><a class="reference internal" href="#cfg_Servers_host"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['host']</span></tt></a> contains the hostname of +the first server, the second <span class="target" id="index-5"></span><a class="reference internal" href="#cfg_Servers_host"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['host']</span></tt></a> +the hostname of the second server, etc. In +<tt class="file docutils literal"><span class="pre">libraries/config.default.php</span></tt>, there is only one section for server +definition, however you can put as many as you need in +<tt class="file docutils literal"><span class="pre">config.inc.php</span></tt>, copy that block or needed parts (you don’t have to +define all settings, just those you need to change).</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">The <span class="target" id="index-6"></span><a class="reference internal" href="#cfg_Servers"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers']</span></tt></a> array starts with +$cfg[‘Servers’][1]. Do not use $cfg[‘Servers’][0]. If you want more +than one server, just copy following section (including $i +incrementation) serveral times. There is no need to define full server +array, just define values you need to change.</p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_host"> +<tt class="descname">$cfg['Servers'][$i]['host']</tt><a class="headerlink" href="#cfg_Servers_host" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'localhost'</span></tt></td> +</tr> +</tbody> +</table> +<p>The hostname or <a class="reference internal" href="glossary.html#term-ip"><em class="xref std std-term">IP</em></a> address of your $i-th MySQL-server. E.g. +<tt class="docutils literal"><span class="pre">localhost</span></tt>.</p> +<p>Possible values are:</p> +<ul class="simple"> +<li>hostname, e.g., <tt class="docutils literal"><span class="pre">'localhost'</span></tt> or <tt class="docutils literal"><span class="pre">'mydb.example.org'</span></tt></li> +<li>IP address, e.g., <tt class="docutils literal"><span class="pre">'127.0.0.1'</span></tt> or <tt class="docutils literal"><span class="pre">'192.168.10.1'</span></tt></li> +<li>dot - <tt class="docutils literal"><span class="pre">'.'</span></tt>, i.e., use named pipes on windows systems</li> +<li>empty - <tt class="docutils literal"><span class="pre">''</span></tt>, disables this server</li> +</ul> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_port"> +<tt class="descname">$cfg['Servers'][$i]['port']</tt><a class="headerlink" href="#cfg_Servers_port" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>The port-number of your $i-th MySQL-server. Default is 3306 (leave +blank).</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">If you use <tt class="docutils literal"><span class="pre">localhost</span></tt> as the hostname, MySQL ignores this port number +and connects with the socket, so if you want to connect to a port +different from the default port, use <tt class="docutils literal"><span class="pre">127.0.0.1</span></tt> or the real hostname +in <span class="target" id="index-7"></span><a class="reference internal" href="#cfg_Servers_host"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['host']</span></tt></a>.</p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_socket"> +<tt class="descname">$cfg['Servers'][$i]['socket']</tt><a class="headerlink" href="#cfg_Servers_socket" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>The path to the socket to use. Leave blank for default. To determine +the correct socket, check your MySQL configuration or, using the +<strong class="command">mysql</strong> command–line client, issue the <tt class="docutils literal"><span class="pre">status</span></tt> command. Among the +resulting information displayed will be the socket used.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_ssl"> +<tt class="descname">$cfg['Servers'][$i]['ssl']</tt><a class="headerlink" href="#cfg_Servers_ssl" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Whether to enable SSL for connection to MySQL server.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_connect_type"> +<tt class="descname">$cfg['Servers'][$i]['connect_type']</tt><a class="headerlink" href="#cfg_Servers_connect_type" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'tcp'</span></tt></td> +</tr> +</tbody> +</table> +<p>What type connection to use with the MySQL server. Your options are +<tt class="docutils literal"><span class="pre">'socket'</span></tt> and <tt class="docutils literal"><span class="pre">'tcp'</span></tt>. It defaults to tcp as that is nearly guaranteed +to be available on all MySQL servers, while sockets are not supported on +some platforms. To use the socket mode, your MySQL server must be on the +same machine as the Web server.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_extension"> +<tt class="descname">$cfg['Servers'][$i]['extension']</tt><a class="headerlink" href="#cfg_Servers_extension" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'mysqli'</span></tt></td> +</tr> +</tbody> +</table> +<p>What php MySQL extension to use for the connection. Valid options are:</p> +<dl class="docutils"> +<dt><tt class="docutils literal"><span class="pre">mysql</span></tt></dt> +<dd>The classic MySQL extension.</dd> +<dt><tt class="docutils literal"><span class="pre">mysqli</span></tt></dt> +<dd>The improved MySQL extension. This extension became available with PHP +5.0.0 and is the recommended way to connect to a server running MySQL +4.1.x or newer.</dd> +</dl> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_compress"> +<tt class="descname">$cfg['Servers'][$i]['compress']</tt><a class="headerlink" href="#cfg_Servers_compress" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Whether to use a compressed protocol for the MySQL server connection +or not (experimental).</p> +</dd></dl> + +<span class="target" id="controlhost"></span><dl class="option"> +<dt id="cfg_Servers_controlhost"> +<tt class="descname">$cfg['Servers'][$i]['controlhost']</tt><a class="headerlink" href="#cfg_Servers_controlhost" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Permits to use an alternate host to hold the configuration storage +data.</p> +</dd></dl> + +<span class="target" id="controluser"></span><dl class="option"> +<dt id="cfg_Servers_controluser"> +<tt class="descname">$cfg['Servers'][$i]['controluser']</tt><a class="headerlink" href="#cfg_Servers_controluser" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_controlpass"> +<tt class="descname">$cfg['Servers'][$i]['controlpass']</tt><a class="headerlink" href="#cfg_Servers_controlpass" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>This special account is used for 2 distinct purposes: to make possible all +relational features (see <span class="target" id="index-8"></span><a class="reference internal" href="#cfg_Servers_pmadb"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></tt></a>) and, +for a MySQL server running with <tt class="docutils literal"><span class="pre">--skip-show-database</span></tt>, to enable a +multi-user installation (<a class="reference internal" href="glossary.html#term-http"><em class="xref std std-term">HTTP</em></a> or cookie +authentication mode).</p> +<p>When using <a class="reference internal" href="glossary.html#term-http"><em class="xref std std-term">HTTP</em></a> or +cookie authentication modes (or ‘config’ authentication mode since phpMyAdmin +2.2.1), you need to supply the details of a MySQL account that has <tt class="docutils literal"><span class="pre">SELECT</span></tt> +privilege on the <em>mysql.user (all columns except “Password”)</em>, <em>mysql.db (all +columns)</em> and <em>mysql.tables_priv (all columns except “Grantor” and +“Timestamp”)</em> tables. This account is used to check what databases the user +will see at login.</p> +<p class="versionchanged"> +<span class="versionmodified">Changed in version 2.2.5: </span>those were called <tt class="docutils literal"><span class="pre">stduser</span></tt> and <tt class="docutils literal"><span class="pre">stdpass</span></tt></p> +<div class="admonition-see-also admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><a class="reference internal" href="setup.html#setup"><em>Installation</em></a>, <a class="reference internal" href="setup.html#authentication-modes"><em>Using authentication modes</em></a></p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_auth_type"> +<tt class="descname">$cfg['Servers'][$i]['auth_type']</tt><a class="headerlink" href="#cfg_Servers_auth_type" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'cookie'</span></tt></td> +</tr> +</tbody> +</table> +<p>Whether config or cookie or <a class="reference internal" href="glossary.html#term-http"><em class="xref std std-term">HTTP</em></a> or signon authentication should be +used for this server.</p> +<ul class="simple"> +<li>‘config’ authentication (<tt class="docutils literal"><span class="pre">$auth_type = 'config'</span></tt>) is the plain old +way: username and password are stored in <tt class="file docutils literal"><span class="pre">config.inc.php</span></tt>.</li> +<li>‘cookie’ authentication mode (<tt class="docutils literal"><span class="pre">$auth_type = 'cookie'</span></tt>) as +introduced in 2.2.3 allows you to log in as any valid MySQL user with +the help of cookies. Username and password are stored in cookies +during the session and password is deleted when it ends. This can also +allow you to log in in arbitrary server if <span class="target" id="index-9"></span><a class="reference internal" href="#cfg_AllowArbitraryServer"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['AllowArbitraryServer']</span></tt></a> enabled.</li> +<li>‘http’ authentication (was +called ‘advanced’ in previous versions and can be written also as +‘http’) (<tt class="docutils literal"><span class="pre">$auth_type = 'http';'</span></tt>) as introduced in 1.3.0 allows you to log in as any +valid MySQL user via HTTP-Auth.</li> +<li>‘signon’ authentication mode (<tt class="docutils literal"><span class="pre">$auth_type = 'signon'</span></tt>) as +introduced in 2.10.0 allows you to log in from prepared PHP session +data or using supplied PHP script. This is useful for implementing +single signon from another application. Sample way how to seed session +is in signon example: <tt class="file docutils literal"><span class="pre">examples/signon.php</span></tt>. There is also +alternative example using OpenID - <tt class="file docutils literal"><span class="pre">examples/openid.php</span></tt> and example +for scripts based solution - <tt class="file docutils literal"><span class="pre">examples/signon-script.php</span></tt>. You need +to configure <span class="target" id="index-10"></span><a class="reference internal" href="#cfg_Servers_SignonSession"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['SignonSession']</span></tt></a> or +<span class="target" id="index-11"></span><a class="reference internal" href="#cfg_Servers_SignonScript"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['SignonScript']</span></tt></a> and +<span class="target" id="index-12"></span><a class="reference internal" href="#cfg_Servers_SignonURL"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['SignonURL']</span></tt></a> to use this authentication +method.</li> +</ul> +<div class="admonition-see-also admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><a class="reference internal" href="setup.html#authentication-modes"><em>Using authentication modes</em></a></p> +</div> +</dd></dl> + +<span class="target" id="servers-auth-http-realm"></span><dl class="option"> +<dt id="cfg_Servers_auth_http_realm"> +<tt class="descname">$cfg['Servers'][$i]['auth_http_realm']</tt><a class="headerlink" href="#cfg_Servers_auth_http_realm" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>When using auth_type = <tt class="docutils literal"><span class="pre">http</span></tt>, this field allows to define a custom +<a class="reference internal" href="glossary.html#term-http"><em class="xref std std-term">HTTP</em></a> Basic Auth Realm which will be displayed to the user. If not +explicitly specified in your configuration, a string combined of +“phpMyAdmin ” and either <span class="target" id="index-13"></span><a class="reference internal" href="#cfg_Servers_verbose"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['verbose']</span></tt></a> or +<span class="target" id="index-14"></span><a class="reference internal" href="#cfg_Servers_host"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['host']</span></tt></a> will be used.</p> +</dd></dl> + +<span class="target" id="servers-auth-swekey-config"></span><dl class="option"> +<dt id="cfg_Servers_auth_swekey_config"> +<tt class="descname">$cfg['Servers'][$i]['auth_swekey_config']</tt><a class="headerlink" href="#cfg_Servers_auth_swekey_config" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>The name of the file containing <a class="reference internal" href="setup.html#swekey"><em>Swekey authentication mode</em></a> ids and login names for hardware +authentication. Leave empty to deactivate this feature.</p> +</dd></dl> + +<span class="target" id="servers-user"></span><dl class="option"> +<dt id="cfg_Servers_user"> +<tt class="descname">$cfg['Servers'][$i]['user']</tt><a class="headerlink" href="#cfg_Servers_user" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'root'</span></tt></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_password"> +<tt class="descname">$cfg['Servers'][$i]['password']</tt><a class="headerlink" href="#cfg_Servers_password" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>When using <span class="target" id="index-15"></span><a class="reference internal" href="#cfg_Servers_auth_type"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['auth_type']</span></tt></a> set to +‘config’, this is the user/password-pair which phpMyAdmin will use to +connect to the MySQL server. This user/password pair is not needed when +<a class="reference internal" href="glossary.html#term-http"><em class="xref std std-term">HTTP</em></a> or cookie authentication is used +and should be empty.</p> +</dd></dl> + +<span class="target" id="servers-nopassword"></span><dl class="option"> +<dt id="cfg_Servers_nopassword"> +<tt class="descname">$cfg['Servers'][$i]['nopassword']</tt><a class="headerlink" href="#cfg_Servers_nopassword" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Allow attempt to log in without password when a login with password +fails. This can be used together with http authentication, when +authentication is done some other way and phpMyAdmin gets user name +from auth and uses empty password for connecting to MySQL. Password +login is still tried first, but as fallback, no password method is +tried.</p> +</dd></dl> + +<span class="target" id="servers-only-db"></span><dl class="option"> +<dt id="cfg_Servers_only_db"> +<tt class="descname">$cfg['Servers'][$i]['only_db']</tt><a class="headerlink" href="#cfg_Servers_only_db" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string or array</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>If set to a (an array of) database name(s), only this (these) +database(s) will be shown to the user. Since phpMyAdmin 2.2.1, +this/these database(s) name(s) may contain MySQL wildcards characters +(“_” and “%”): if you want to use literal instances of these +characters, escape them (I.E. use <tt class="docutils literal"><span class="pre">'my\_db'</span></tt> and not <tt class="docutils literal"><span class="pre">'my_db'</span></tt>).</p> +<p>This setting is an efficient way to lower the server load since the +latter does not need to send MySQL requests to build the available +database list. But <strong>it does not replace the privileges rules of the +MySQL database server</strong>. If set, it just means only these databases +will be displayed but <strong>not that all other databases can’t be used.</strong></p> +<p>An example of using more that one database:</p> +<div class="highlight-php"><div class="highlight"><pre><span class="x">$cfg['Servers'][$i]['only_db'] = array('db1', 'db2');</span> +</pre></div> +</div> +<p class="versionchanged"> +<span class="versionmodified">Changed in version 4.0.0: </span>Previous versions permitted to specify the display order of +the database names via this directive.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_hide_db"> +<tt class="descname">$cfg['Servers'][$i]['hide_db']</tt><a class="headerlink" href="#cfg_Servers_hide_db" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Regular expression for hiding some databases from unprivileged users. +This only hides them from listing, but a user is still able to access +them (using, for example, the SQL query area). To limit access, use +the MySQL privilege system. For example, to hide all databases +starting with the letter “a”, use</p> +<div class="highlight-php"><div class="highlight"><pre><span class="x">$cfg['Servers'][$i]['hide_db'] = '^a';</span> +</pre></div> +</div> +<p>and to hide both “db1” and “db2” use</p> +<div class="highlight-php"><div class="highlight"><pre><span class="x">$cfg['Servers'][$i]['hide_db'] = '^(db1|db2)$';</span> +</pre></div> +</div> +<p>More information on regular expressions can be found in the <a class="reference external" href="http://php.net/manual/en/reference.pcre.pattern.syntax.php">PCRE +pattern syntax</a> portion +of the PHP reference manual.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_verbose"> +<tt class="descname">$cfg['Servers'][$i]['verbose']</tt><a class="headerlink" href="#cfg_Servers_verbose" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Only useful when using phpMyAdmin with multiple server entries. If +set, this string will be displayed instead of the hostname in the +pull-down menu on the main page. This can be useful if you want to +show only certain databases on your system, for example. For HTTP +auth, all non-US-ASCII characters will be stripped.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_pmadb"> +<tt class="descname">$cfg['Servers'][$i]['pmadb']</tt><a class="headerlink" href="#cfg_Servers_pmadb" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>The name of the database containing the phpMyAdmin configuration +storage.</p> +<p>See the <a class="reference internal" href="setup.html#linked-tables"><em>phpMyAdmin configuration storage</em></a> section in this document to see the benefits of +this feature, and for a quick way of creating this database and the needed +tables.</p> +<p>If you are the only user of this phpMyAdmin installation, you can use your +current database to store those special tables; in this case, just put your +current database name in <span class="target" id="index-16"></span><a class="reference internal" href="#cfg_Servers_pmadb"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></tt></a>. For a +multi-user installation, set this parameter to the name of your central +database containing the phpMyAdmin configuration storage.</p> +</dd></dl> + +<span class="target" id="bookmark"></span><dl class="option"> +<dt id="cfg_Servers_bookmarktable"> +<tt class="descname">$cfg['Servers'][$i]['bookmarktable']</tt><a class="headerlink" href="#cfg_Servers_bookmarktable" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This +can be useful for queries you often run. To allow the usage of this +functionality:</p> +<ul class="simple"> +<li>set up <span class="target" id="index-17"></span><a class="reference internal" href="#cfg_Servers_pmadb"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></tt></a> and the phpMyAdmin configuration storage</li> +<li>enter the table name in <span class="target" id="index-18"></span><a class="reference internal" href="#cfg_Servers_bookmarktable"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['bookmarktable']</span></tt></a></li> +</ul> +</dd></dl> + +<span class="target" id="relation"></span><dl class="option"> +<dt id="cfg_Servers_relation"> +<tt class="descname">$cfg['Servers'][$i]['relation']</tt><a class="headerlink" href="#cfg_Servers_relation" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Since release 2.2.4 you can describe, in a special ‘relation’ table, +which column is a key in another table (a foreign key). phpMyAdmin +currently uses this to</p> +<ul class="simple"> +<li>make clickable, when you browse the master table, the data values that +point to the foreign table;</li> +<li>display in an optional tool-tip the “display column” when browsing the +master table, if you move the mouse to a column containing a foreign +key (use also the ‘table_info’ table); (see <a class="reference internal" href="faq.html#faqdisplay"><em>6.7 How can I use the “display column” feature?</em></a>)</li> +<li>in edit/insert mode, display a drop-down list of possible foreign keys +(key value and “display column” are shown) (see <a class="reference internal" href="faq.html#faq6-21"><em>6.21 In edit/insert mode, how can I see a list of possible values for a column, based on some foreign table?</em></a>)</li> +<li>display links on the table properties page, to check referential +integrity (display missing foreign keys) for each described key;</li> +<li>in query-by-example, create automatic joins (see <a class="reference internal" href="faq.html#faq6-6"><em>6.6 How can I use the relation table in Query-by-example?</em></a>)</li> +<li>enable you to get a <a class="reference internal" href="glossary.html#term-pdf"><em class="xref std std-term">PDF</em></a> schema of +your database (also uses the table_coords table).</li> +</ul> +<p>The keys can be numeric or character.</p> +<p>To allow the usage of this functionality:</p> +<ul class="simple"> +<li>set up <span class="target" id="index-19"></span><a class="reference internal" href="#cfg_Servers_pmadb"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></tt></a> and the phpMyAdmin configuration storage</li> +<li>put the relation table name in <span class="target" id="index-20"></span><a class="reference internal" href="#cfg_Servers_relation"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['relation']</span></tt></a></li> +<li>now as normal user open phpMyAdmin and for each one of your tables +where you want to use this feature, click <em class="guilabel">Structure/Relation view/</em> +and choose foreign columns.</li> +</ul> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">In the current version, <tt class="docutils literal"><span class="pre">master_db</span></tt> must be the same as <tt class="docutils literal"><span class="pre">foreign_db</span></tt>. +Those columns have been put in future development of the cross-db +relations.</p> +</div> +</dd></dl> + +<span class="target" id="table-info"></span><dl class="option"> +<dt id="cfg_Servers_table_info"> +<tt class="descname">$cfg['Servers'][$i]['table_info']</tt><a class="headerlink" href="#cfg_Servers_table_info" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Since release 2.3.0 you can describe, in a special ‘table_info’ +table, which column is to be displayed as a tool-tip when moving the +cursor over the corresponding key. This configuration variable will +hold the name of this special table. To allow the usage of this +functionality:</p> +<ul class="simple"> +<li>set up <span class="target" id="index-21"></span><a class="reference internal" href="#cfg_Servers_pmadb"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></tt></a> and the phpMyAdmin configuration storage</li> +<li>put the table name in <span class="target" id="index-22"></span><a class="reference internal" href="#cfg_Servers_table_info"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['table_info']</span></tt></a> (e.g. +<tt class="docutils literal"><span class="pre">pma__table_info</span></tt>)</li> +<li>then for each table where you want to use this feature, click +“Structure/Relation view/Choose column to display” to choose the +column.</li> +</ul> +<div class="admonition-see-also admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><a class="reference internal" href="faq.html#faqdisplay"><em>6.7 How can I use the “display column” feature?</em></a></p> +</div> +</dd></dl> + +<span class="target" id="table-coords"></span><dl class="option"> +<dt id="cfg_Servers_table_coords"> +<tt class="descname">$cfg['Servers'][$i]['table_coords']</tt><a class="headerlink" href="#cfg_Servers_table_coords" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_pdf_pages"> +<tt class="descname">$cfg['Servers'][$i]['pdf_pages']</tt><a class="headerlink" href="#cfg_Servers_pdf_pages" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Since release 2.3.0 you can have phpMyAdmin create <a class="reference internal" href="glossary.html#term-pdf"><em class="xref std std-term">PDF</em></a> pages +showing the relations between your tables. To do this it needs two tables +“pdf_pages” (storing information about the available <a class="reference internal" href="glossary.html#term-pdf"><em class="xref std std-term">PDF</em></a> pages) +and “table_coords” (storing coordinates where each table will be placed on +a <a class="reference internal" href="glossary.html#term-pdf"><em class="xref std std-term">PDF</em></a> schema output). You must be using the “relation” feature.</p> +<p>To allow the usage of this functionality:</p> +<ul class="simple"> +<li>set up <span class="target" id="index-23"></span><a class="reference internal" href="#cfg_Servers_pmadb"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></tt></a> and the phpMyAdmin configuration storage</li> +<li>put the correct table names in +<span class="target" id="index-24"></span><a class="reference internal" href="#cfg_Servers_table_coords"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['table_coords']</span></tt></a> and +<span class="target" id="index-25"></span><a class="reference internal" href="#cfg_Servers_pdf_pages"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pdf_pages']</span></tt></a></li> +</ul> +<div class="admonition-see-also admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><a class="reference internal" href="faq.html#faqpdf"><em>6.8 How can I produce a PDF schema of my database?</em></a>.</p> +</div> +</dd></dl> + +<span class="target" id="col-com"></span><dl class="option"> +<dt id="cfg_Servers_column_info"> +<tt class="descname">$cfg['Servers'][$i]['column_info']</tt><a class="headerlink" href="#cfg_Servers_column_info" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>This part requires a content update! Since release 2.3.0 you can +store comments to describe each column for each table. These will then +be shown on the “printview”.</p> +<p>Starting with release 2.5.0, comments are consequently used on the table +property pages and table browse view, showing up as tool-tips above the +column name (properties page) or embedded within the header of table in +browse view. They can also be shown in a table dump. Please see the +relevant configuration directives later on.</p> +<p>Also new in release 2.5.0 is a MIME- transformation system which is also +based on the following table structure. See <a class="reference internal" href="transformations.html#transformations"><em>Transformations</em></a> for +further information. To use the MIME- transformation system, your +column_info table has to have the three new columns ‘mimetype’, +‘transformation’, ‘transformation_options’.</p> +<p>To allow the usage of this functionality:</p> +<ul> +<li><p class="first">set up <span class="target" id="index-26"></span><a class="reference internal" href="#cfg_Servers_pmadb"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></tt></a> and the phpMyAdmin configuration storage</p> +</li> +<li><p class="first">put the table name in <span class="target" id="index-27"></span><a class="reference internal" href="#cfg_Servers_column_info"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['column_info']</span></tt></a> (e.g. +<tt class="docutils literal"><span class="pre">pma__column_info</span></tt>)</p> +</li> +<li><p class="first">to update your PRE-2.5.0 Column_comments Table use this: and +remember that the Variable in <tt class="file docutils literal"><span class="pre">config.inc.php</span></tt> has been renamed from +<span class="target" id="index-28"></span><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['column_comments']</span></tt> to +<span class="target" id="index-29"></span><a class="reference internal" href="#cfg_Servers_column_info"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['column_info']</span></tt></a></p> +<div class="highlight-mysql"><div class="highlight"><pre><span class="k">ALTER</span> <span class="k">TABLE</span> <span class="ss">`pma__column_comments`</span> +<span class="k">ADD</span> <span class="ss">`mimetype`</span> <span class="kt">VARCHAR</span><span class="p">(</span> <span class="mi">255</span> <span class="p">)</span> <span class="k">NOT</span> <span class="no">NULL</span><span class="p">,</span> +<span class="k">ADD</span> <span class="ss">`transformation`</span> <span class="kt">VARCHAR</span><span class="p">(</span> <span class="mi">255</span> <span class="p">)</span> <span class="k">NOT</span> <span class="no">NULL</span><span class="p">,</span> +<span class="k">ADD</span> <span class="ss">`transformation_options`</span> <span class="kt">VARCHAR</span><span class="p">(</span> <span class="mi">255</span> <span class="p">)</span> <span class="k">NOT</span> <span class="no">NULL</span><span class="p">;</span> +</pre></div> +</div> +</li> +</ul> +</dd></dl> + +<span class="target" id="history"></span><dl class="option"> +<dt id="cfg_Servers_history"> +<tt class="descname">$cfg['Servers'][$i]['history']</tt><a class="headerlink" href="#cfg_Servers_history" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Since release 2.5.0 you can store your <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> history, which means all +queries you entered manually into the phpMyAdmin interface. If you don’t +want to use a table-based history, you can use the JavaScript-based +history.</p> +<p>Using that, all your history items are deleted when closing the window. +Using <span class="target" id="index-30"></span><a class="reference internal" href="#cfg_QueryHistoryMax"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['QueryHistoryMax']</span></tt></a> you can specify an amount of +history items you want to have on hold. On every login, this list gets cut +to the maximum amount.</p> +<p>The query history is only available if JavaScript is enabled in +your browser.</p> +<p>To allow the usage of this functionality:</p> +<ul class="simple"> +<li>set up <span class="target" id="index-31"></span><a class="reference internal" href="#cfg_Servers_pmadb"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></tt></a> and the phpMyAdmin configuration storage</li> +<li>put the table name in <span class="target" id="index-32"></span><a class="reference internal" href="#cfg_Servers_history"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['history']</span></tt></a> (e.g. +<tt class="docutils literal"><span class="pre">pma__history</span></tt>)</li> +</ul> +</dd></dl> + +<span class="target" id="recent"></span><dl class="option"> +<dt id="cfg_Servers_recent"> +<tt class="descname">$cfg['Servers'][$i]['recent']</tt><a class="headerlink" href="#cfg_Servers_recent" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Since release 3.5.0 you can show recently used tables in the +navigation panel. It helps you to jump across table directly, without +the need to select the database, and then select the table. Using +<span class="target" id="index-33"></span><a class="reference internal" href="#cfg_NumRecentTables"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['NumRecentTables']</span></tt></a> you can configure the maximum number +of recent tables shown. When you select a table from the list, it will jump to +the page specified in <span class="target" id="index-34"></span><a class="reference internal" href="#cfg_NavigationTreeDefaultTabTable"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['NavigationTreeDefaultTabTable']</span></tt></a>.</p> +<p>Without configuring the storage, you can still access the recently used tables, +but it will disappear after you logout.</p> +<p>To allow the usage of this functionality persistently:</p> +<ul class="simple"> +<li>set up <span class="target" id="index-35"></span><a class="reference internal" href="#cfg_Servers_pmadb"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></tt></a> and the phpMyAdmin configuration storage</li> +<li>put the table name in <span class="target" id="index-36"></span><a class="reference internal" href="#cfg_Servers_recent"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['recent']</span></tt></a> (e.g. +<tt class="docutils literal"><span class="pre">pma__recent</span></tt>)</li> +</ul> +</dd></dl> + +<span class="target" id="table-uiprefs"></span><dl class="option"> +<dt id="cfg_Servers_table_uiprefs"> +<tt class="descname">$cfg['Servers'][$i]['table_uiprefs']</tt><a class="headerlink" href="#cfg_Servers_table_uiprefs" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Since release 3.5.0 phpMyAdmin can be configured to remember several +things (sorted column <span class="target" id="index-37"></span><a class="reference internal" href="#cfg_RememberSorting"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['RememberSorting']</span></tt></a>, column order, +and column visibility from a database table) for browsing tables. Without +configuring the storage, these features still can be used, but the values will +disappear after you logout.</p> +<p>To allow the usage of these functionality persistently:</p> +<ul class="simple"> +<li>set up <span class="target" id="index-38"></span><a class="reference internal" href="#cfg_Servers_pmadb"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></tt></a> and the phpMyAdmin configuration storage</li> +<li>put the table name in <span class="target" id="index-39"></span><a class="reference internal" href="#cfg_Servers_table_uiprefs"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['table_uiprefs']</span></tt></a> (e.g. +<tt class="docutils literal"><span class="pre">pma__table_uiprefs</span></tt>)</li> +</ul> +</dd></dl> + +<span class="target" id="tracking"></span><dl class="option"> +<dt id="cfg_Servers_tracking"> +<tt class="descname">$cfg['Servers'][$i]['tracking']</tt><a class="headerlink" href="#cfg_Servers_tracking" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Since release 3.3.x a tracking mechanism is available. It helps you to +track every <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> command which is +executed by phpMyAdmin. The mechanism supports logging of data +manipulation and data definition statements. After enabling it you can +create versions of tables.</p> +<p>The creation of a version has two effects:</p> +<ul class="simple"> +<li>phpMyAdmin saves a snapshot of the table, including structure and +indexes.</li> +<li>phpMyAdmin logs all commands which change the structure and/or data of +the table and links these commands with the version number.</li> +</ul> +<p>Of course you can view the tracked changes. On the <em class="guilabel">Tracking</em> +page a complete report is available for every version. For the report you +can use filters, for example you can get a list of statements within a date +range. When you want to filter usernames you can enter * for all names or +you enter a list of names separated by ‘,’. In addition you can export the +(filtered) report to a file or to a temporary database.</p> +<p>To allow the usage of this functionality:</p> +<ul class="simple"> +<li>set up <span class="target" id="index-40"></span><a class="reference internal" href="#cfg_Servers_pmadb"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></tt></a> and the phpMyAdmin configuration storage</li> +<li>put the table name in <span class="target" id="index-41"></span><a class="reference internal" href="#cfg_Servers_tracking"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['tracking']</span></tt></a> (e.g. +<tt class="docutils literal"><span class="pre">pma__tracking</span></tt>)</li> +</ul> +</dd></dl> + +<span class="target" id="tracking2"></span><dl class="option"> +<dt id="cfg_Servers_tracking_version_auto_create"> +<tt class="descname">$cfg['Servers'][$i]['tracking_version_auto_create']</tt><a class="headerlink" href="#cfg_Servers_tracking_version_auto_create" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Whether the tracking mechanism creates versions for tables and views +automatically.</p> +<p>If this is set to true and you create a table or view with</p> +<ul class="simple"> +<li>CREATE TABLE ...</li> +<li>CREATE VIEW ...</li> +</ul> +<p>and no version exists for it, the mechanism will create a version for +you automatically.</p> +</dd></dl> + +<span class="target" id="tracking3"></span><dl class="option"> +<dt id="cfg_Servers_tracking_default_statements"> +<tt class="descname">$cfg['Servers'][$i]['tracking_default_statements']</tt><a class="headerlink" href="#cfg_Servers_tracking_default_statements" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'CREATE</span> <span class="pre">TABLE,ALTER</span> <span class="pre">TABLE,DROP</span> <span class="pre">TABLE,RENAME</span> <span class="pre">TABLE,CREATE</span> <span class="pre">INDEX,DROP</span> <span class="pre">INDEX,INSERT,UPDATE,DELETE,TRUNCATE,REPLACE,CREATE</span> <span class="pre">VIEW,ALTER</span> <span class="pre">VIEW,DROP</span> <span class="pre">VIEW,CREATE</span> <span class="pre">DATABASE,ALTER</span> <span class="pre">DATABASE,DROP</span> <span class="pre">DATABASE'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines the list of statements the auto-creation uses for new +versions.</p> +</dd></dl> + +<span class="target" id="tracking4"></span><dl class="option"> +<dt id="cfg_Servers_tracking_add_drop_view"> +<tt class="descname">$cfg['Servers'][$i]['tracking_add_drop_view']</tt><a class="headerlink" href="#cfg_Servers_tracking_add_drop_view" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Whether a DROP VIEW IF EXISTS statement will be added as first line to +the log when creating a view.</p> +</dd></dl> + +<span class="target" id="tracking5"></span><dl class="option"> +<dt id="cfg_Servers_tracking_add_drop_table"> +<tt class="descname">$cfg['Servers'][$i]['tracking_add_drop_table']</tt><a class="headerlink" href="#cfg_Servers_tracking_add_drop_table" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Whether a DROP TABLE IF EXISTS statement will be added as first line +to the log when creating a table.</p> +</dd></dl> + +<span class="target" id="tracking6"></span><dl class="option"> +<dt id="cfg_Servers_tracking_add_drop_database"> +<tt class="descname">$cfg['Servers'][$i]['tracking_add_drop_database']</tt><a class="headerlink" href="#cfg_Servers_tracking_add_drop_database" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Whether a DROP DATABASE IF EXISTS statement will be added as first +line to the log when creating a database.</p> +</dd></dl> + +<span class="target" id="userconfig"></span><dl class="option"> +<dt id="cfg_Servers_userconfig"> +<tt class="descname">$cfg['Servers'][$i]['userconfig']</tt><a class="headerlink" href="#cfg_Servers_userconfig" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Since release 3.4.x phpMyAdmin allows users to set most preferences by +themselves and store them in the database.</p> +<p>If you don’t allow for storing preferences in +<span class="target" id="index-42"></span><a class="reference internal" href="#cfg_Servers_pmadb"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></tt></a>, users can still personalize +phpMyAdmin, but settings will be saved in browser’s local storage, or, it +is is unavailable, until the end of session.</p> +<p>To allow the usage of this functionality:</p> +<ul class="simple"> +<li>set up <span class="target" id="index-43"></span><a class="reference internal" href="#cfg_Servers_pmadb"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></tt></a> and the phpMyAdmin configuration storage</li> +<li>put the table name in <span class="target" id="index-44"></span><a class="reference internal" href="#cfg_Servers_userconfig"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['userconfig']</span></tt></a></li> +</ul> +</dd></dl> + +<span class="target" id="designer-coords"></span><dl class="option"> +<dt id="cfg_Servers_designer_coords"> +<tt class="descname">$cfg['Servers'][$i]['designer_coords']</tt><a class="headerlink" href="#cfg_Servers_designer_coords" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Since release 2.10.0 a Designer interface is available; it permits to +visually manage the relations.</p> +<p>To allow the usage of this functionality:</p> +<ul class="simple"> +<li>set up <span class="target" id="index-45"></span><a class="reference internal" href="#cfg_Servers_pmadb"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></tt></a> and the phpMyAdmin configuration storage</li> +<li>put the table name in <span class="target" id="index-46"></span><a class="reference internal" href="#cfg_Servers_designer_coords"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['designer_coords']</span></tt></a> +(e.g. <tt class="docutils literal"><span class="pre">pma__designer_coords</span></tt>)</li> +</ul> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_MaxTableUiprefs"> +<tt class="descname">$cfg['Servers'][$i]['MaxTableUiprefs']</tt><a class="headerlink" href="#cfg_Servers_MaxTableUiprefs" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">100</td> +</tr> +</tbody> +</table> +<p>Maximum number of rows saved in +<span class="target" id="index-47"></span><a class="reference internal" href="#cfg_Servers_table_uiprefs"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['table_uiprefs']</span></tt></a> table.</p> +<p>When tables are dropped or renamed, +<span class="target" id="index-48"></span><a class="reference internal" href="#cfg_Servers_table_uiprefs"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['table_uiprefs']</span></tt></a> may contain invalid data +(referring to tables which no longer exist). We only keep this number of newest +rows in <span class="target" id="index-49"></span><a class="reference internal" href="#cfg_Servers_table_uiprefs"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['table_uiprefs']</span></tt></a> and automatically +delete older rows.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_AllowRoot"> +<tt class="descname">$cfg['Servers'][$i]['AllowRoot']</tt><a class="headerlink" href="#cfg_Servers_AllowRoot" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Whether to allow root access. This is just a shortcut for the +<span class="target" id="index-50"></span><a class="reference internal" href="#cfg_Servers_AllowDeny_rules"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['AllowDeny']['rules']</span></tt></a> below.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_AllowNoPassword"> +<tt class="descname">$cfg['Servers'][$i]['AllowNoPassword']</tt><a class="headerlink" href="#cfg_Servers_AllowNoPassword" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Whether to allow logins without a password. The default value of +<tt class="docutils literal"><span class="pre">false</span></tt> for this parameter prevents unintended access to a MySQL +server with was left with an empty password for root or on which an +anonymous (blank) user is defined.</p> +</dd></dl> + +<span class="target" id="servers-allowdeny-order"></span><dl class="option"> +<dt id="cfg_Servers_AllowDeny_order"> +<tt class="descname">$cfg['Servers'][$i]['AllowDeny']['order']</tt><a class="headerlink" href="#cfg_Servers_AllowDeny_order" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>If your rule order is empty, then <a class="reference internal" href="glossary.html#term-ip"><em class="xref std std-term">IP</em></a> +authorization is disabled.</p> +<p>If your rule order is set to +<tt class="docutils literal"><span class="pre">'deny,allow'</span></tt> then the system applies all deny rules followed by +allow rules. Access is allowed by default. Any client which does not +match a Deny command or does match an Allow command will be allowed +access to the server.</p> +<p>If your rule order is set to <tt class="docutils literal"><span class="pre">'allow,deny'</span></tt> +then the system applies all allow rules followed by deny rules. Access +is denied by default. Any client which does not match an Allow +directive or does match a Deny directive will be denied access to the +server.</p> +<p>If your rule order is set to <tt class="docutils literal"><span class="pre">'explicit'</span></tt>, authorization is +performed in a similar fashion to rule order ‘deny,allow’, with the +added restriction that your host/username combination <strong>must</strong> be +listed in the <em>allow</em> rules, and not listed in the <em>deny</em> rules. This +is the <strong>most</strong> secure means of using Allow/Deny rules, and was +available in Apache by specifying allow and deny rules without setting +any order.</p> +<p>Please also see <span class="target" id="index-51"></span><a class="reference internal" href="#cfg_TrustedProxies"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['TrustedProxies']</span></tt></a> for +detecting IP address behind proxies.</p> +</dd></dl> + +<span class="target" id="servers-allowdeny-rules"></span><dl class="option"> +<dt id="cfg_Servers_AllowDeny_rules"> +<tt class="descname">$cfg['Servers'][$i]['AllowDeny']['rules']</tt><a class="headerlink" href="#cfg_Servers_AllowDeny_rules" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array of strings</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array()</td> +</tr> +</tbody> +</table> +<p>The general format for the rules is as such:</p> +<div class="highlight-none"><div class="highlight"><pre><'allow' | 'deny'> <username> [from] <ipmask> +</pre></div> +</div> +<p>If you wish to match all users, it is possible to use a <tt class="docutils literal"><span class="pre">'%'</span></tt> as a +wildcard in the <em>username</em> field.</p> +<p>There are a few shortcuts you can +use in the <em>ipmask</em> field as well (please note that those containing +SERVER_ADDRESS might not be available on all webservers):</p> +<div class="highlight-none"><div class="highlight"><pre>'all' -> 0.0.0.0/0 +'localhost' -> 127.0.0.1/8 +'localnetA' -> SERVER_ADDRESS/8 +'localnetB' -> SERVER_ADDRESS/16 +'localnetC' -> SERVER_ADDRESS/24 +</pre></div> +</div> +<p>Having an empty rule list is equivalent to either using <tt class="docutils literal"><span class="pre">'allow</span> <span class="pre">%</span> +<span class="pre">from</span> <span class="pre">all'</span></tt> if your rule order is set to <tt class="docutils literal"><span class="pre">'deny,allow'</span></tt> or <tt class="docutils literal"><span class="pre">'deny</span> <span class="pre">%</span> +<span class="pre">from</span> <span class="pre">all'</span></tt> if your rule order is set to <tt class="docutils literal"><span class="pre">'allow,deny'</span></tt> or +<tt class="docutils literal"><span class="pre">'explicit'</span></tt>.</p> +<p>For the <a class="reference internal" href="glossary.html#term-ip-address"><em class="xref std std-term">IP address</em></a> matching +system, the following work:</p> +<ul class="simple"> +<li><tt class="docutils literal"><span class="pre">xxx.xxx.xxx.xxx</span></tt> (an exact <a class="reference internal" href="glossary.html#term-ip-address"><em class="xref std std-term">IP address</em></a>)</li> +<li><tt class="docutils literal"><span class="pre">xxx.xxx.xxx.[yyy-zzz]</span></tt> (an <a class="reference internal" href="glossary.html#term-ip-address"><em class="xref std std-term">IP address</em></a> range)</li> +<li><tt class="docutils literal"><span class="pre">xxx.xxx.xxx.xxx/nn</span></tt> (CIDR, Classless Inter-Domain Routing type <a class="reference internal" href="glossary.html#term-ip"><em class="xref std std-term">IP</em></a> addresses)</li> +</ul> +<p>But the following does not work:</p> +<ul class="simple"> +<li><tt class="docutils literal"><span class="pre">xxx.xxx.xxx.xx[yyy-zzz]</span></tt> (partial <a class="reference internal" href="glossary.html#term-ip"><em class="xref std std-term">IP</em></a> address range)</li> +</ul> +<p>For <a class="reference internal" href="glossary.html#term-ipv6"><em class="xref std std-term">IPv6</em></a> addresses, the following work:</p> +<ul class="simple"> +<li><tt class="docutils literal"><span class="pre">xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx</span></tt> (an exact <a class="reference internal" href="glossary.html#term-ipv6"><em class="xref std std-term">IPv6</em></a> address)</li> +<li><tt class="docutils literal"><span class="pre">xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:[yyyy-zzzz]</span></tt> (an <a class="reference internal" href="glossary.html#term-ipv6"><em class="xref std std-term">IPv6</em></a> address range)</li> +<li><tt class="docutils literal"><span class="pre">xxxx:xxxx:xxxx:xxxx/nn</span></tt> (CIDR, Classless Inter-Domain Routing type <a class="reference internal" href="glossary.html#term-ipv6"><em class="xref std std-term">IPv6</em></a> addresses)</li> +</ul> +<p>But the following does not work:</p> +<ul class="simple"> +<li><tt class="docutils literal"><span class="pre">xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xx[yyy-zzz]</span></tt> (partial <a class="reference internal" href="glossary.html#term-ipv6"><em class="xref std std-term">IPv6</em></a> address range)</li> +</ul> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_DisableIS"> +<tt class="descname">$cfg['Servers'][$i]['DisableIS']</tt><a class="headerlink" href="#cfg_Servers_DisableIS" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Disable using <tt class="docutils literal"><span class="pre">INFORMATION_SCHEMA</span></tt> to retrieve information (use +<tt class="docutils literal"><span class="pre">SHOW</span></tt> commands instead), because of speed issues when many +databases are present. Currently used in some parts of the code, more +to come.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_ShowDatabasesCommand"> +<tt class="descname">$cfg['Servers'][$i]['ShowDatabasesCommand']</tt><a class="headerlink" href="#cfg_Servers_ShowDatabasesCommand" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'SHOW</span> <span class="pre">DATABASES'</span></tt></td> +</tr> +</tbody> +</table> +<p>On a server with a huge number of databases, the default <tt class="docutils literal"><span class="pre">SHOW</span> <span class="pre">DATABASES</span></tt> +command used to fetch the name of available databases will probably be too +slow, so it can be replaced by faster commands. You can use <tt class="docutils literal"><span class="pre">#user#</span></tt> +string will be replaced by current user.</p> +<p>When using <tt class="docutils literal"><span class="pre">false</span></tt>, it will disable fetching databases from the server, +only databases in <span class="target" id="index-52"></span><a class="reference internal" href="#cfg_Servers_only_db"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['only_db']</span></tt></a> will be +displayed.</p> +<p>Examples:</p> +<ul class="simple"> +<li><tt class="docutils literal"><span class="pre">'SHOW</span> <span class="pre">DATABASES'</span></tt></li> +<li><tt class="docutils literal"><span class="pre">"SHOW</span> <span class="pre">DATABASES</span> <span class="pre">LIKE</span> <span class="pre">'#user#\_%'"</span></tt></li> +<li><tt class="docutils literal"><span class="pre">'SELECT</span> <span class="pre">DISTINCT</span> <span class="pre">TABLE_SCHEMA</span> <span class="pre">FROM</span> <span class="pre">information_schema.SCHEMA_PRIVILEGES'</span></tt></li> +<li><tt class="docutils literal"><span class="pre">'SELECT</span> <span class="pre">SCHEMA_NAME</span> <span class="pre">FROM</span> <span class="pre">information_schema.SCHEMATA'</span></tt></li> +<li><tt class="docutils literal"><span class="pre">false</span></tt></li> +</ul> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_SignonScript"> +<tt class="descname">$cfg['Servers'][$i]['SignonScript']</tt><a class="headerlink" href="#cfg_Servers_SignonScript" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Name of PHP script to be sourced and executed to obtain login +credentials. This is alternative approach to session based single +signon. The script needs to provide function +<tt class="docutils literal"><span class="pre">get_login_credentials</span></tt> which returns list of username and +password, accepting single parameter of existing username (can be +empty). See <tt class="file docutils literal"><span class="pre">examples/signon-script.php</span></tt> for an example.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_SignonSession"> +<tt class="descname">$cfg['Servers'][$i]['SignonSession']</tt><a class="headerlink" href="#cfg_Servers_SignonSession" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Name of session which will be used for signon authentication method. +You should use something different than <tt class="docutils literal"><span class="pre">phpMyAdmin</span></tt>, because this +is session which phpMyAdmin uses internally. Takes effect only if +<span class="target" id="index-53"></span><a class="reference internal" href="#cfg_Servers_SignonScript"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['SignonScript']</span></tt></a> is not configured.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_SignonURL"> +<tt class="descname">$cfg['Servers'][$i]['SignonURL']</tt><a class="headerlink" href="#cfg_Servers_SignonURL" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p><a class="reference internal" href="glossary.html#term-url"><em class="xref std std-term">URL</em></a> where user will be redirected +to log in for signon authentication method. Should be absolute +including protocol.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_LogoutURL"> +<tt class="descname">$cfg['Servers'][$i]['LogoutURL']</tt><a class="headerlink" href="#cfg_Servers_LogoutURL" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p><a class="reference internal" href="glossary.html#term-url"><em class="xref std std-term">URL</em></a> where user will be redirected +after logout (doesn’t affect config authentication method). Should be +absolute including protocol.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_StatusCacheDatabases"> +<tt class="descname">$cfg['Servers'][$i]['StatusCacheDatabases']</tt><a class="headerlink" href="#cfg_Servers_StatusCacheDatabases" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array of strings</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array()</td> +</tr> +</tbody> +</table> +<p>Enables caching of <tt class="docutils literal"><span class="pre">TABLE</span> <span class="pre">STATUS</span></tt> outputs for specific databases on +this server (in some cases <tt class="docutils literal"><span class="pre">TABLE</span> <span class="pre">STATUS</span></tt> can be very slow, so you +may want to cache it). APC is used (if the PHP extension is available, +if not, this setting is ignored silently). You have to provide +<span class="target" id="index-54"></span><a class="reference internal" href="#cfg_Servers_StatusCacheLifetime"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['StatusCacheLifetime']</span></tt></a>.</p> +<p>Takes effect only if <span class="target" id="index-55"></span><a class="reference internal" href="#cfg_Servers_DisableIS"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['DisableIS']</span></tt></a> is +<tt class="docutils literal"><span class="pre">true</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_StatusCacheLifetime"> +<tt class="descname">$cfg['Servers'][$i]['StatusCacheLifetime']</tt><a class="headerlink" href="#cfg_Servers_StatusCacheLifetime" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">0</td> +</tr> +</tbody> +</table> +<p>Lifetime in seconds of the <tt class="docutils literal"><span class="pre">TABLE</span> <span class="pre">STATUS</span></tt> cache if +<span class="target" id="index-56"></span><a class="reference internal" href="#cfg_Servers_StatusCacheDatabases"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['StatusCacheDatabases']</span></tt></a> is used.</p> +</dd></dl> + +</div> +<div class="section" id="generic-settings"> +<h2>Generic settings<a class="headerlink" href="#generic-settings" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_ServerDefault"> +<tt class="descname">$cfg['ServerDefault']</tt><a class="headerlink" href="#cfg_ServerDefault" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">1</td> +</tr> +</tbody> +</table> +<p>If you have more than one server configured, you can set +<span class="target" id="index-57"></span><a class="reference internal" href="#cfg_ServerDefault"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['ServerDefault']</span></tt></a> to any one of them to autoconnect to that +server when phpMyAdmin is started, or set it to 0 to be given a list +of servers without logging in.</p> +<p>If you have only one server configured, +<span class="target" id="index-58"></span><a class="reference internal" href="#cfg_ServerDefault"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['ServerDefault']</span></tt></a> MUST be set to that server.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_VersionCheck"> +<tt class="descname">$cfg['VersionCheck']</tt><a class="headerlink" href="#cfg_VersionCheck" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Enables check for latest versions using javascript on main phpMyAdmin +page.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">This setting can be adjusted by your vendor.</p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_MaxDbList"> +<tt class="descname">$cfg['MaxDbList']</tt><a class="headerlink" href="#cfg_MaxDbList" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">100</td> +</tr> +</tbody> +</table> +<p>The maximum number of database names to be displayed in the main panel’s +database list.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_MaxNavigationItems"> +<tt class="descname">$cfg['MaxNavigationItems']</tt><a class="headerlink" href="#cfg_MaxNavigationItems" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">250</td> +</tr> +</tbody> +</table> +<p>The number of items that can be displayed on each page of the +navigation tree.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_MaxTableList"> +<tt class="descname">$cfg['MaxTableList']</tt><a class="headerlink" href="#cfg_MaxTableList" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">250</td> +</tr> +</tbody> +</table> +<p>The maximum number of table names to be displayed in the main panel’s +list (except on the Export page). This limit is also enforced in the +navigation panel when in Light mode.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ShowHint"> +<tt class="descname">$cfg['ShowHint']</tt><a class="headerlink" href="#cfg_ShowHint" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Whether or not to show hints (for example, hints when hovering over +table headers).</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_MaxCharactersInDisplayedSQL"> +<tt class="descname">$cfg['MaxCharactersInDisplayedSQL']</tt><a class="headerlink" href="#cfg_MaxCharactersInDisplayedSQL" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">1000</td> +</tr> +</tbody> +</table> +<p>The maximum number of characters when a <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> query is displayed. The +default limit of 1000 should be correct to avoid the display of tons of +hexadecimal codes that represent BLOBs, but some users have real +<a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> queries that are longer than 1000 characters. Also, if a +query’s length exceeds this limit, this query is not saved in the history.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_PersistentConnections"> +<tt class="descname">$cfg['PersistentConnections']</tt><a class="headerlink" href="#cfg_PersistentConnections" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Whether <a class="reference external" href="http://php.net/manual/en/features.persistent-connections.php">persistent connections</a> should be used or not. Works with +following extensions:</p> +<ul class="simple"> +<li>mysql (<a class="reference external" href="http://php.net/manual/en/function.mysql-pconnect.php">mysql_pconnect</a>),</li> +<li>mysqli (requires PHP 5.3.0 or newer, <a class="reference external" href="http://php.net/manual/en/mysqli.persistconns.php">more information</a>).</li> +</ul> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ForceSSL"> +<tt class="descname">$cfg['ForceSSL']</tt><a class="headerlink" href="#cfg_ForceSSL" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Whether to force using https while accessing phpMyAdmin.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ExecTimeLimit"> +<tt class="descname">$cfg['ExecTimeLimit']</tt><a class="headerlink" href="#cfg_ExecTimeLimit" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer [number of seconds]</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">300</td> +</tr> +</tbody> +</table> +<p>Set the number of seconds a script is allowed to run. If seconds is +set to zero, no time limit is imposed. This setting is used while +importing/exporting dump files but has +no effect when PHP is running in safe mode.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_SessionSavePath"> +<tt class="descname">$cfg['SessionSavePath']</tt><a class="headerlink" href="#cfg_SessionSavePath" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Path for storing session data (<a class="reference external" href="http://php.net/session_save_path">session_save_path PHP parameter</a>).</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_MemoryLimit"> +<tt class="descname">$cfg['MemoryLimit']</tt><a class="headerlink" href="#cfg_MemoryLimit" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [number of bytes]</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'0'</span></tt></td> +</tr> +</tbody> +</table> +<p>Set the number of bytes a script is allowed to allocate. If set to +zero, no limit is imposed.</p> +<p>This setting is used while importing/exporting dump files and at some other +places in phpMyAdmin so you definitely don’t want to put here a too low +value. It has no effect when PHP is running in safe mode.</p> +<p>You can also use any string as in <tt class="file docutils literal"><span class="pre">php.ini</span></tt>, eg. ‘16M’. Ensure you +don’t omit the suffix (16 means 16 bytes!)</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_SkipLockedTables"> +<tt class="descname">$cfg['SkipLockedTables']</tt><a class="headerlink" href="#cfg_SkipLockedTables" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Mark used tables and make it possible to show databases with locked +tables (since MySQL 3.23.30).</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ShowSQL"> +<tt class="descname">$cfg['ShowSQL']</tt><a class="headerlink" href="#cfg_ShowSQL" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Defines whether <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> queries +generated by phpMyAdmin should be displayed or not.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_RetainQueryBox"> +<tt class="descname">$cfg['RetainQueryBox']</tt><a class="headerlink" href="#cfg_RetainQueryBox" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Defines whether the <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> query box +should be kept displayed after its submission.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_CodemirrorEnable"> +<tt class="descname">$cfg['CodemirrorEnable']</tt><a class="headerlink" href="#cfg_CodemirrorEnable" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Defines whether to use a Javascript code editor for SQL query boxes. +CodeMirror provides syntax highlighting and line numbers. However, +middle-clicking for pasting the clipboard contents in some Linux +distributions (such as Ubuntu) is not supported by all browsers.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_AllowUserDropDatabase"> +<tt class="descname">$cfg['AllowUserDropDatabase']</tt><a class="headerlink" href="#cfg_AllowUserDropDatabase" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Defines whether normal users (non-administrator) are allowed to delete +their own database or not. If set as false, the link <em class="guilabel">Drop +Database</em> will not be shown, and even a <tt class="docutils literal"><span class="pre">DROP</span> <span class="pre">DATABASE</span> <span class="pre">mydatabase</span></tt> will +be rejected. Quite practical for <a class="reference internal" href="glossary.html#term-isp"><em class="xref std std-term">ISP</em></a> ‘s with many customers.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">This limitation of <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> queries is not +as strict as when using MySQL privileges. This is due to nature of +<a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> queries which might be quite +complicated. So this choice should be viewed as help to avoid accidental +dropping rather than strict privilege limitation.</p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Confirm"> +<tt class="descname">$cfg['Confirm']</tt><a class="headerlink" href="#cfg_Confirm" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Whether a warning (“Are your really sure...”) should be displayed when +you’re about to lose data.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_UseDbSearch"> +<tt class="descname">$cfg['UseDbSearch']</tt><a class="headerlink" href="#cfg_UseDbSearch" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Define whether the “search string inside database” is enabled or not.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_IgnoreMultiSubmitErrors"> +<tt class="descname">$cfg['IgnoreMultiSubmitErrors']</tt><a class="headerlink" href="#cfg_IgnoreMultiSubmitErrors" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Define whether phpMyAdmin will continue executing a multi-query +statement if one of the queries fails. Default is to abort execution.</p> +</dd></dl> + +</div> +<div class="section" id="cookie-authentication-options"> +<h2>Cookie authentication options<a class="headerlink" href="#cookie-authentication-options" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_blowfish_secret"> +<tt class="descname">$cfg['blowfish_secret']</tt><a class="headerlink" href="#cfg_blowfish_secret" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>The “cookie” auth_type uses blowfish algorithm to encrypt the +password. If you are using the “cookie” auth_type, enter here a +random passphrase of your choice. It will be used internally by the +blowfish algorithm: you won’t be prompted for this passphrase. There +is no maximum length for this secret.</p> +<p class="versionchanged"> +<span class="versionmodified">Changed in version 3.1.0: </span>Since version 3.1.0 phpMyAdmin can generate this on the fly, but it +makes a bit weaker security as this generated secret is stored in +session and furthermore it makes impossible to recall user name from +cookie.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_LoginCookieRecall"> +<tt class="descname">$cfg['LoginCookieRecall']</tt><a class="headerlink" href="#cfg_LoginCookieRecall" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Define whether the previous login should be recalled or not in cookie +authentication mode.</p> +<p>This is automatically disabled if you do not have +configured <span class="target" id="index-59"></span><a class="reference internal" href="#cfg_blowfish_secret"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['blowfish_secret']</span></tt></a>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_LoginCookieValidity"> +<tt class="descname">$cfg['LoginCookieValidity']</tt><a class="headerlink" href="#cfg_LoginCookieValidity" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer [number of seconds]</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">1440</td> +</tr> +</tbody> +</table> +<p>Define how long a login cookie is valid. Please note that php +configuration option <a class="reference external" href="http://php.net/manual/en/session.configuration.php#ini.session.gc-maxlifetime">session.gc_maxlifetime</a> might limit session validity and if the session is lost, +the login cookie is also invalidated. So it is a good idea to set +<tt class="docutils literal"><span class="pre">session.gc_maxlifetime</span></tt> at least to the same value of +<span class="target" id="index-60"></span><a class="reference internal" href="#cfg_LoginCookieValidity"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['LoginCookieValidity']</span></tt></a>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_LoginCookieStore"> +<tt class="descname">$cfg['LoginCookieStore']</tt><a class="headerlink" href="#cfg_LoginCookieStore" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer [number of seconds]</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">0</td> +</tr> +</tbody> +</table> +<p>Define how long login cookie should be stored in browser. Default 0 +means that it will be kept for existing session. This is recommended +for not trusted environments.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_LoginCookieDeleteAll"> +<tt class="descname">$cfg['LoginCookieDeleteAll']</tt><a class="headerlink" href="#cfg_LoginCookieDeleteAll" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>If enabled (default), logout deletes cookies for all servers, +otherwise only for current one. Setting this to false makes it easy to +forget to log out from other server, when you are using more of them.</p> +</dd></dl> + +<span class="target" id="allowarbitraryserver"></span><dl class="option"> +<dt id="cfg_AllowArbitraryServer"> +<tt class="descname">$cfg['AllowArbitraryServer']</tt><a class="headerlink" href="#cfg_AllowArbitraryServer" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>If enabled, allows you to log in to arbitrary servers using cookie +authentication.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">Please use this carefully, as this may allow users access to MySQL servers +behind the firewall where your <a class="reference internal" href="glossary.html#term-http"><em class="xref std std-term">HTTP</em></a> +server is placed.</p> +</div> +</dd></dl> + +</div> +<div class="section" id="navigation-panel-setup"> +<h2>Navigation panel setup<a class="headerlink" href="#navigation-panel-setup" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_NavigationTreeEnableGrouping"> +<tt class="descname">$cfg['NavigationTreeEnableGrouping']</tt><a class="headerlink" href="#cfg_NavigationTreeEnableGrouping" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Defines whether to group the databases based on a common prefix +in their name <span class="target" id="index-61"></span><a class="reference internal" href="#cfg_NavigationTreeDbSeparator"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['NavigationTreeDbSeparator']</span></tt></a>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_NavigationTreeDbSeparator"> +<tt class="descname">$cfg['NavigationTreeDbSeparator']</tt><a class="headerlink" href="#cfg_NavigationTreeDbSeparator" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string or array</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'_'</span></tt></td> +</tr> +</tbody> +</table> +<p>The string used to separate the parts of the database name when +showing them in a tree. Alternatively you can specify more strings in +an array and all of them will be used as a separator.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_NavigationTreeTableSeparator"> +<tt class="descname">$cfg['NavigationTreeTableSeparator']</tt><a class="headerlink" href="#cfg_NavigationTreeTableSeparator" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string or array</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'__'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines a string to be used to nest table spaces. This means if you have +tables like <tt class="docutils literal"><span class="pre">first__second__third</span></tt> this will be shown as a three-level +hierarchy like: first > second > third. If set to false or empty, the +feature is disabled. NOTE: You should not use this separator at the +beginning or end of a table name or multiple times after another without +any other characters in between.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_NavigationTreeTableLevel"> +<tt class="descname">$cfg['NavigationTreeTableLevel']</tt><a class="headerlink" href="#cfg_NavigationTreeTableLevel" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">1</td> +</tr> +</tbody> +</table> +<p>Defines how many sublevels should be displayed when splitting up +tables by the above separator.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_NumRecentTables"> +<tt class="descname">$cfg['NumRecentTables']</tt><a class="headerlink" href="#cfg_NumRecentTables" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">10</td> +</tr> +</tbody> +</table> +<p>The maximum number of recently used tables shown in the navigation +panel. Set this to 0 (zero) to disable the listing of recent tables.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_NavigationDisplayLogo"> +<tt class="descname">$cfg['NavigationDisplayLogo']</tt><a class="headerlink" href="#cfg_NavigationDisplayLogo" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Defines whether or not to display the phpMyAdmin logo at the top of +the navigation panel.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_NavigationLogoLink"> +<tt class="descname">$cfg['NavigationLogoLink']</tt><a class="headerlink" href="#cfg_NavigationLogoLink" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'index.php'</span></tt></td> +</tr> +</tbody> +</table> +<p>Enter <a class="reference internal" href="glossary.html#term-url"><em class="xref std std-term">URL</em></a> where logo in the +navigation panel will point to. For use especially with self made +theme which changes this.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_NavigationLogoLinkWindow"> +<tt class="descname">$cfg['NavigationLogoLinkWindow']</tt><a class="headerlink" href="#cfg_NavigationLogoLinkWindow" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'main'</span></tt></td> +</tr> +</tbody> +</table> +<p>Whether to open the linked page in the main window (<tt class="docutils literal"><span class="pre">main</span></tt>) or in a +new one (<tt class="docutils literal"><span class="pre">new</span></tt>). Note: use <tt class="docutils literal"><span class="pre">new</span></tt> if you are linking to +<tt class="docutils literal"><span class="pre">phpmyadmin.net</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_NavigationTreeDisplayItemFilterMinimum"> +<tt class="descname">$cfg['NavigationTreeDisplayItemFilterMinimum']</tt><a class="headerlink" href="#cfg_NavigationTreeDisplayItemFilterMinimum" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">30</td> +</tr> +</tbody> +</table> +<p>Defines the minimum number of items (tables, views, routines and +events) to display a JavaScript filter box above the list of items in +the navigation tree.</p> +<p>To disable the filter completely some high number can be used (e.g. 9999)</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_NavigationTreeDisplayDbFilterMinimum"> +<tt class="descname">$cfg['NavigationTreeDisplayDbFilterMinimum']</tt><a class="headerlink" href="#cfg_NavigationTreeDisplayDbFilterMinimum" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">30</td> +</tr> +</tbody> +</table> +<p>Defines the minimum number of databases to display a JavaScript filter +box above the list of databases in the navigation tree.</p> +<p>To disable the filter completely some high number can be used +(e.g. 9999)</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_NavigationDisplayServers"> +<tt class="descname">$cfg['NavigationDisplayServers']</tt><a class="headerlink" href="#cfg_NavigationDisplayServers" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Defines whether or not to display a server choice at the top of the +navigation panel.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_DisplayServersList"> +<tt class="descname">$cfg['DisplayServersList']</tt><a class="headerlink" href="#cfg_DisplayServersList" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Defines whether to display this server choice as links instead of in a +drop-down.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_NavigationTreeDefaultTabTable"> +<tt class="descname">$cfg['NavigationTreeDefaultTabTable']</tt><a class="headerlink" href="#cfg_NavigationTreeDefaultTabTable" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'tbl_structure.php'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines the tab displayed by default when clicking the small icon next +to each table name in the navigation panel. Possible values:</p> +<ul class="simple"> +<li><tt class="docutils literal"><span class="pre">tbl_structure.php</span></tt></li> +<li><tt class="docutils literal"><span class="pre">tbl_sql.php</span></tt></li> +<li><tt class="docutils literal"><span class="pre">tbl_select.php</span></tt></li> +<li><tt class="docutils literal"><span class="pre">tbl_change.php</span></tt></li> +<li><tt class="docutils literal"><span class="pre">sql.php</span></tt></li> +</ul> +</dd></dl> + +</div> +<div class="section" id="main-panel"> +<h2>Main panel<a class="headerlink" href="#main-panel" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_ShowStats"> +<tt class="descname">$cfg['ShowStats']</tt><a class="headerlink" href="#cfg_ShowStats" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Defines whether or not to display space usage and statistics about +databases and tables. Note that statistics requires at least MySQL +3.23.3 and that, at this date, MySQL doesn’t return such information +for Berkeley DB tables.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ShowServerInfo"> +<tt class="descname">$cfg['ShowServerInfo']</tt><a class="headerlink" href="#cfg_ShowServerInfo" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Defines whether to display detailed server information on main page. +You can additionally hide more information by using +<span class="target" id="index-62"></span><a class="reference internal" href="#cfg_Servers_verbose"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['verbose']</span></tt></a>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ShowPhpInfo"> +<tt class="descname">$cfg['ShowPhpInfo']</tt><a class="headerlink" href="#cfg_ShowPhpInfo" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ShowChgPassword"> +<tt class="descname">$cfg['ShowChgPassword']</tt><a class="headerlink" href="#cfg_ShowChgPassword" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ShowCreateDb"> +<tt class="descname">$cfg['ShowCreateDb']</tt><a class="headerlink" href="#cfg_ShowCreateDb" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Defines whether to display the <em class="guilabel">PHP information</em> and +<em class="guilabel">Change password</em> links and form for creating database or not at +the starting main (right) frame. This setting does not check MySQL commands +entered directly.</p> +<p>Please note that to block the usage of <tt class="docutils literal"><span class="pre">phpinfo()</span></tt> in scripts, you have to +put this in your <tt class="file docutils literal"><span class="pre">php.ini</span></tt>:</p> +<div class="highlight-ini"><div class="highlight"><pre><span class="na">disable_functions</span> <span class="o">=</span> <span class="s">phpinfo()</span> +</pre></div> +</div> +<p>Also note that enabling the <em class="guilabel">Change password</em> link has no effect +with config authentication mode: because of the hard coded password value +in the configuration file, end users can’t be allowed to change their +passwords.</p> +</dd></dl> + +</div> +<div class="section" id="database-structure"> +<h2>Database structure<a class="headerlink" href="#database-structure" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_ShowDbStructureCreation"> +<tt class="descname">$cfg['ShowDbStructureCreation']</tt><a class="headerlink" href="#cfg_ShowDbStructureCreation" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Defines whether the database structure page (tables list) has a +“Creation” column that displays when each table was created.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ShowDbStructureLastUpdate"> +<tt class="descname">$cfg['ShowDbStructureLastUpdate']</tt><a class="headerlink" href="#cfg_ShowDbStructureLastUpdate" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Defines whether the database structure page (tables list) has a “Last +update” column that displays when each table was last updated.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ShowDbStructureLastCheck"> +<tt class="descname">$cfg['ShowDbStructureLastCheck']</tt><a class="headerlink" href="#cfg_ShowDbStructureLastCheck" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Defines whether the database structure page (tables list) has a “Last +check” column that displays when each table was last checked.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_HideStructureActions"> +<tt class="descname">$cfg['HideStructureActions']</tt><a class="headerlink" href="#cfg_HideStructureActions" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Defines whether the table structure actions are hidden under a “More” +drop-down.</p> +</dd></dl> + +</div> +<div class="section" id="browse-mode"> +<h2>Browse mode<a class="headerlink" href="#browse-mode" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_TableNavigationLinksMode"> +<tt class="descname">$cfg['TableNavigationLinksMode']</tt><a class="headerlink" href="#cfg_TableNavigationLinksMode" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'icons'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines whether the table navigation links contain <tt class="docutils literal"><span class="pre">'icons'</span></tt>, <tt class="docutils literal"><span class="pre">'text'</span></tt> +or <tt class="docutils literal"><span class="pre">'both'</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ShowAll"> +<tt class="descname">$cfg['ShowAll']</tt><a class="headerlink" href="#cfg_ShowAll" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Defines whether a user should be displayed a “Show all” button in +browse mode or not in all cases. By default it is shown only on small +tables (less than 5 × <span class="target" id="index-63"></span><a class="reference internal" href="#cfg_MaxRows"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['MaxRows']</span></tt></a> rows) to avoid +performance issues while getting too many rows.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_MaxRows"> +<tt class="descname">$cfg['MaxRows']</tt><a class="headerlink" href="#cfg_MaxRows" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">30</td> +</tr> +</tbody> +</table> +<p>Number of rows displayed when browsing a result set and no LIMIT +clause is used. If the result set contains more rows, “Previous” and +“Next” links will be shown.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Order"> +<tt class="descname">$cfg['Order']</tt><a class="headerlink" href="#cfg_Order" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'SMART'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines whether columns are displayed in ascending (<tt class="docutils literal"><span class="pre">ASC</span></tt>) order, in +descending (<tt class="docutils literal"><span class="pre">DESC</span></tt>) order or in a “smart” (<tt class="docutils literal"><span class="pre">SMART</span></tt>) order - I.E. +descending order for columns of type TIME, DATE, DATETIME and +TIMESTAMP, ascending order else- by default.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_DisplayBinaryAsHex"> +<tt class="descname">$cfg['DisplayBinaryAsHex']</tt><a class="headerlink" href="#cfg_DisplayBinaryAsHex" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Defines whether the “Show binary contents as HEX” browse option is +ticked by default.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_GridEditing"> +<tt class="descname">$cfg['GridEditing']</tt><a class="headerlink" href="#cfg_GridEditing" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'double-click'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines which action (<tt class="docutils literal"><span class="pre">double-click</span></tt> or <tt class="docutils literal"><span class="pre">click</span></tt>) triggers grid +editing. Can be deactived with the <tt class="docutils literal"><span class="pre">disabled</span></tt> value.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_SaveCellsAtOnce"> +<tt class="descname">$cfg['SaveCellsAtOnce']</tt><a class="headerlink" href="#cfg_SaveCellsAtOnce" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Defines whether or not to save all edited cells at once for grid +editing.</p> +</dd></dl> + +</div> +<div class="section" id="editing-mode"> +<h2>Editing mode<a class="headerlink" href="#editing-mode" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_ProtectBinary"> +<tt class="descname">$cfg['ProtectBinary']</tt><a class="headerlink" href="#cfg_ProtectBinary" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean or string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'blob'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines whether <tt class="docutils literal"><span class="pre">BLOB</span></tt> or <tt class="docutils literal"><span class="pre">BINARY</span></tt> columns are protected from +editing when browsing a table’s content. Valid values are:</p> +<ul class="simple"> +<li><tt class="docutils literal"><span class="pre">false</span></tt> to allow editing of all columns;</li> +<li><tt class="docutils literal"><span class="pre">'blob'</span></tt> to allow editing of all columns except <tt class="docutils literal"><span class="pre">BLOBS</span></tt>;</li> +<li><tt class="docutils literal"><span class="pre">'noblob'</span></tt> to disallow editing of all columns except <tt class="docutils literal"><span class="pre">BLOBS</span></tt> (the +opposite of <tt class="docutils literal"><span class="pre">'blob'</span></tt>);</li> +<li><tt class="docutils literal"><span class="pre">'all'</span></tt> to disallow editing of all <tt class="docutils literal"><span class="pre">BINARY</span></tt> or <tt class="docutils literal"><span class="pre">BLOB</span></tt> columns.</li> +</ul> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ShowFunctionFields"> +<tt class="descname">$cfg['ShowFunctionFields']</tt><a class="headerlink" href="#cfg_ShowFunctionFields" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Defines whether or not MySQL functions fields should be initially +displayed in edit/insert mode. Since version 2.10, the user can toggle +this setting from the interface.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ShowFieldTypesInDataEditView"> +<tt class="descname">$cfg['ShowFieldTypesInDataEditView']</tt><a class="headerlink" href="#cfg_ShowFieldTypesInDataEditView" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Defines whether or not type fields should be initially displayed in +edit/insert mode. The user can toggle this setting from the interface.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_InsertRows"> +<tt class="descname">$cfg['InsertRows']</tt><a class="headerlink" href="#cfg_InsertRows" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">2</td> +</tr> +</tbody> +</table> +<p>Defines the maximum number of concurrent entries for the Insert page.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ForeignKeyMaxLimit"> +<tt class="descname">$cfg['ForeignKeyMaxLimit']</tt><a class="headerlink" href="#cfg_ForeignKeyMaxLimit" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">100</td> +</tr> +</tbody> +</table> +<p>If there are fewer items than this in the set of foreign keys, then a +drop-down box of foreign keys is presented, in the style described by +the <span class="target" id="index-64"></span><a class="reference internal" href="#cfg_ForeignKeyDropdownOrder"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['ForeignKeyDropdownOrder']</span></tt></a> setting.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ForeignKeyDropdownOrder"> +<tt class="descname">$cfg['ForeignKeyDropdownOrder']</tt><a class="headerlink" href="#cfg_ForeignKeyDropdownOrder" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array(‘content-id’, ‘id-content’)</td> +</tr> +</tbody> +</table> +<p>For the foreign key drop-down fields, there are several methods of +display, offering both the key and value data. The contents of the +array should be one or both of the following strings: <tt class="docutils literal"><span class="pre">content-id</span></tt>, +<tt class="docutils literal"><span class="pre">id-content</span></tt>.</p> +</dd></dl> + +</div> +<div class="section" id="export-and-import-settings"> +<h2>Export and import settings<a class="headerlink" href="#export-and-import-settings" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_ZipDump"> +<tt class="descname">$cfg['ZipDump']</tt><a class="headerlink" href="#cfg_ZipDump" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_GZipDump"> +<tt class="descname">$cfg['GZipDump']</tt><a class="headerlink" href="#cfg_GZipDump" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_BZipDump"> +<tt class="descname">$cfg['BZipDump']</tt><a class="headerlink" href="#cfg_BZipDump" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Defines whether to allow the use of zip/GZip/BZip2 compression when +creating a dump file</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_CompressOnFly"> +<tt class="descname">$cfg['CompressOnFly']</tt><a class="headerlink" href="#cfg_CompressOnFly" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Defines whether to allow on the fly compression for GZip/BZip2 +compressed exports. This doesn’t affect smaller dumps and allows users +to create larger dumps that won’t otherwise fit in memory due to php +memory limit. Produced files contain more GZip/BZip2 headers, but all +normal programs handle this correctly.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Export"> +<tt class="descname">$cfg['Export']</tt><a class="headerlink" href="#cfg_Export" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array(...)</td> +</tr> +</tbody> +</table> +<p>In this array are defined default parameters for export, names of +items are similar to texts seen on export page, so you can easily +identify what they mean.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Export_method"> +<tt class="descname">$cfg['Export']['method']</tt><a class="headerlink" href="#cfg_Export_method" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'quick'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines how the export form is displayed when it loads. Valid values +are:</p> +<ul class="simple"> +<li><tt class="docutils literal"><span class="pre">quick</span></tt> to display the minimum number of options to configure</li> +<li><tt class="docutils literal"><span class="pre">custom</span></tt> to display every available option to configure</li> +<li><tt class="docutils literal"><span class="pre">custom-no-form</span></tt> same as <tt class="docutils literal"><span class="pre">custom</span></tt> but does not display the option +of using quick export</li> +</ul> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Import"> +<tt class="descname">$cfg['Import']</tt><a class="headerlink" href="#cfg_Import" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array(...)</td> +</tr> +</tbody> +</table> +<p>In this array are defined default parameters for import, names of +items are similar to texts seen on import page, so you can easily +identify what they mean.</p> +</dd></dl> + +</div> +<div class="section" id="tabs-display-settings"> +<h2>Tabs display settings<a class="headerlink" href="#tabs-display-settings" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_TabsMode"> +<tt class="descname">$cfg['TabsMode']</tt><a class="headerlink" href="#cfg_TabsMode" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'both'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines whether the menu tabs contain <tt class="docutils literal"><span class="pre">'icons'</span></tt>, <tt class="docutils literal"><span class="pre">'text'</span></tt> or <tt class="docutils literal"><span class="pre">'both'</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ActionLinksMode"> +<tt class="descname">$cfg['ActionLinksMode']</tt><a class="headerlink" href="#cfg_ActionLinksMode" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'both'</span></tt></td> +</tr> +</tbody> +</table> +<p>If set to <tt class="docutils literal"><span class="pre">icons</span></tt>, will display icons instead of text for db and table +properties links (like <em class="guilabel">Browse</em>, <em class="guilabel">Select</em>, +<em class="guilabel">Insert</em>, ...). Can be set to <tt class="docutils literal"><span class="pre">'both'</span></tt> +if you want icons AND text. When set to <tt class="docutils literal"><span class="pre">text</span></tt>, will only show text.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_PropertiesNumColumns"> +<tt class="descname">$cfg['PropertiesNumColumns']</tt><a class="headerlink" href="#cfg_PropertiesNumColumns" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">1</td> +</tr> +</tbody> +</table> +<p>How many columns will be utilized to display the tables on the database +property view? When setting this to a value larger than 1, the type of the +database will be omitted for more display space.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_DefaultTabServer"> +<tt class="descname">$cfg['DefaultTabServer']</tt><a class="headerlink" href="#cfg_DefaultTabServer" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'index.php'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines the tab displayed by default on server view. Possible values:</p> +<ul class="simple"> +<li><tt class="docutils literal"><span class="pre">main.php</span></tt> (recommended for multi-user setups)</li> +<li><tt class="docutils literal"><span class="pre">server_databases.php</span></tt>,</li> +<li><tt class="docutils literal"><span class="pre">server_status.php</span></tt></li> +<li><tt class="docutils literal"><span class="pre">server_variables.php</span></tt></li> +<li><tt class="docutils literal"><span class="pre">server_privileges.php</span></tt></li> +</ul> +</dd></dl> + +<dl class="option"> +<dt id="cfg_DefaultTabDatabase"> +<tt class="descname">$cfg['DefaultTabDatabase']</tt><a class="headerlink" href="#cfg_DefaultTabDatabase" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'db_structure.php'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines the tab displayed by default on database view. Possible +values:</p> +<ul class="simple"> +<li><tt class="docutils literal"><span class="pre">db_structure.php</span></tt></li> +<li><tt class="docutils literal"><span class="pre">db_sql.php</span></tt></li> +<li><tt class="docutils literal"><span class="pre">db_search.php</span></tt>.</li> +</ul> +</dd></dl> + +<dl class="option"> +<dt id="cfg_DefaultTabTable"> +<tt class="descname">$cfg['DefaultTabTable']</tt><a class="headerlink" href="#cfg_DefaultTabTable" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'sql.php'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines the tab displayed by default on table view. Possible values:</p> +<ul class="simple"> +<li><tt class="docutils literal"><span class="pre">tbl_structure.php</span></tt></li> +<li><tt class="docutils literal"><span class="pre">tbl_sql.php</span></tt></li> +<li><tt class="docutils literal"><span class="pre">tbl_select.php</span></tt></li> +<li><tt class="docutils literal"><span class="pre">tbl_change.php</span></tt></li> +<li><tt class="docutils literal"><span class="pre">sql.php</span></tt></li> +</ul> +</dd></dl> + +</div> +<div class="section" id="documentation"> +<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_MySQLManualBase"> +<tt class="descname">$cfg['MySQLManualBase']</tt><a class="headerlink" href="#cfg_MySQLManualBase" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'http://dev.mysql.com/doc/refman'</span></tt></td> +</tr> +</tbody> +</table> +<p>If set to an <a class="reference internal" href="glossary.html#term-url"><em class="xref std std-term">URL</em></a> which points to +the MySQL documentation (type depends on +<span class="target" id="index-65"></span><a class="reference internal" href="#cfg_MySQLManualType"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['MySQLManualType']</span></tt></a>), appropriate help links are +generated.</p> +<p>See <a class="reference external" href="http://dev.mysql.com/doc/">MySQL Documentation page</a> for more +information about MySQL manuals and their types.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_MySQLManualType"> +<tt class="descname">$cfg['MySQLManualType']</tt><a class="headerlink" href="#cfg_MySQLManualType" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'viewable'</span></tt></td> +</tr> +</tbody> +</table> +<p>Type of MySQL documentation:</p> +<ul class="simple"> +<li>viewable - “viewable online”, current one used on MySQL website</li> +<li>searchable - “Searchable, with user comments”</li> +<li>chapters - “HTML, one page per chapter”</li> +<li>big - “HTML, all on one page”</li> +<li>none - do not show documentation links</li> +</ul> +</dd></dl> + +</div> +<div class="section" id="languages"> +<h2>Languages<a class="headerlink" href="#languages" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_DefaultLang"> +<tt class="descname">$cfg['DefaultLang']</tt><a class="headerlink" href="#cfg_DefaultLang" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'en'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines the default language to use, if not browser-defined or user- +defined. The corresponding language file needs to be in +locale/<em>code</em>/LC_MESSAGES/phpmyadmin.mo.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_DefaultConnectionCollation"> +<tt class="descname">$cfg['DefaultConnectionCollation']</tt><a class="headerlink" href="#cfg_DefaultConnectionCollation" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'utf8_general_ci'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines the default connection collation to use, if not user-defined. +See the <a class="reference external" href="http://dev.mysql.com/doc/mysql/en/charset-charsets.html">MySQL documentation</a> for list of possible values. This setting is +ignored when connected to Drizzle server.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Lang"> +<tt class="descname">$cfg['Lang']</tt><a class="headerlink" href="#cfg_Lang" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">not set</td> +</tr> +</tbody> +</table> +<p>Force language to use. The corresponding language file needs to be in +locale/<em>code</em>/LC_MESSAGES/phpmyadmin.mo.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_FilterLanguages"> +<tt class="descname">$cfg['FilterLanguages']</tt><a class="headerlink" href="#cfg_FilterLanguages" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Limit list of available languages to those matching the given regular +expression. For example if you want only Czech and English, you should +set filter to <tt class="docutils literal"><span class="pre">'^(cs|en)'</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_RecodingEngine"> +<tt class="descname">$cfg['RecodingEngine']</tt><a class="headerlink" href="#cfg_RecodingEngine" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'auto'</span></tt></td> +</tr> +</tbody> +</table> +<p>You can select here which functions will be used for character set +conversion. Possible values are:</p> +<ul class="simple"> +<li>auto - automatically use available one (first is tested iconv, then +recode)</li> +<li>iconv - use iconv or libiconv functions</li> +<li>recode - use recode_string function</li> +<li>none - disable encoding conversion</li> +</ul> +<p>Enabled charset conversion activates a pull-down menu in the Export +and Import pages, to choose the character set when exporting a file. +The default value in this menu comes from +<span class="target" id="index-66"></span><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Export']['charset']</span></tt> and <span class="target" id="index-67"></span><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Import']['charset']</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_IconvExtraParams"> +<tt class="descname">$cfg['IconvExtraParams']</tt><a class="headerlink" href="#cfg_IconvExtraParams" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'//TRANSLIT'</span></tt></td> +</tr> +</tbody> +</table> +<p>Specify some parameters for iconv used in charset conversion. See +<a class="reference external" href="http://www.gnu.org/software/libiconv/documentation/libiconv/iconv_open.3.html">iconv documentation</a> for details. By default +<tt class="docutils literal"><span class="pre">//TRANSLIT</span></tt> is used, so that invalid characters will be +transliterated.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_AvailableCharsets"> +<tt class="descname">$cfg['AvailableCharsets']</tt><a class="headerlink" href="#cfg_AvailableCharsets" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array(..._</td> +</tr> +</tbody> +</table> +<p>Available character sets for MySQL conversion. You can add your own +(any of supported by recode/iconv) or remove these which you don’t +use. Character sets will be shown in same order as here listed, so if +you frequently use some of these move them to the top.</p> +</dd></dl> + +</div> +<div class="section" id="web-server-settings"> +<h2>Web server settings<a class="headerlink" href="#web-server-settings" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_OBGzip"> +<tt class="descname">$cfg['OBGzip']</tt><a class="headerlink" href="#cfg_OBGzip" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string/boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'auto'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines whether to use GZip output buffering for increased speed in +<a class="reference internal" href="glossary.html#term-http"><em class="xref std std-term">HTTP</em></a> transfers. Set to +true/false for enabling/disabling. When set to ‘auto’ (string), +phpMyAdmin tries to enable output buffering and will automatically +disable it if your browser has some problems with buffering. IE6 with +a certain patch is known to cause data corruption when having enabled +buffering.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_TrustedProxies"> +<tt class="descname">$cfg['TrustedProxies']</tt><a class="headerlink" href="#cfg_TrustedProxies" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array()</td> +</tr> +</tbody> +</table> +<p>Lists proxies and HTTP headers which are trusted for +<span class="target" id="index-68"></span><a class="reference internal" href="#cfg_Servers_AllowDeny_order"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['AllowDeny']['order']</span></tt></a>. This list is by +default empty, you need to fill in some trusted proxy servers if you +want to use rules for IP addresses behind proxy.</p> +<p>The following example specifies that phpMyAdmin should trust a +HTTP_X_FORWARDED_FOR (<tt class="docutils literal"><span class="pre">X</span> <span class="pre">-Forwarded-For</span></tt>) header coming from the proxy +1.2.3.4:</p> +<div class="highlight-php"><div class="highlight"><pre><span class="x">$cfg['TrustedProxies'] = array('1.2.3.4' => 'HTTP_X_FORWARDED_FOR');</span> +</pre></div> +</div> +<p>The <span class="target" id="index-69"></span><a class="reference internal" href="#cfg_Servers_AllowDeny_rules"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['AllowDeny']['rules']</span></tt></a> directive uses the +client’s IP address as usual.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_GD2Available"> +<tt class="descname">$cfg['GD2Available']</tt><a class="headerlink" href="#cfg_GD2Available" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'auto'</span></tt></td> +</tr> +</tbody> +</table> +<p>Specifies whether GD >= 2 is available. If yes it can be used for MIME +transformations. Possible values are:</p> +<ul class="simple"> +<li>auto - automatically detect</li> +<li>yes - GD 2 functions can be used</li> +<li>no - GD 2 function cannot be used</li> +</ul> +</dd></dl> + +<dl class="option"> +<dt id="cfg_CheckConfigurationPermissions"> +<tt class="descname">$cfg['CheckConfigurationPermissions']</tt><a class="headerlink" href="#cfg_CheckConfigurationPermissions" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>We normally check the permissions on the configuration file to ensure +it’s not world writable. However, phpMyAdmin could be installed on a +NTFS filesystem mounted on a non-Windows server, in which case the +permissions seems wrong but in fact cannot be detected. In this case a +sysadmin would set this parameter to <tt class="docutils literal"><span class="pre">false</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_LinkLengthLimit"> +<tt class="descname">$cfg['LinkLengthLimit']</tt><a class="headerlink" href="#cfg_LinkLengthLimit" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">1000</td> +</tr> +</tbody> +</table> +<p>Limit for length of <a class="reference internal" href="glossary.html#term-url"><em class="xref std std-term">URL</em></a> in links. When length would be above this +limit, it is replaced by form with button. This is required as some web +servers (<a class="reference internal" href="glossary.html#term-iis"><em class="xref std std-term">IIS</em></a>) have problems with long <a class="reference internal" href="glossary.html#term-url"><em class="xref std std-term">URL</em></a> .</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_CSPAllow"> +<tt class="descname">$cfg['CSPAllow']</tt><a class="headerlink" href="#cfg_CSPAllow" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Additional string to include in allowed script sources in Content Security +Policy header.</p> +<p>This can be useful when you want to include some external javascript files +in <tt class="file docutils literal"><span class="pre">config.footer.inc.php</span></tt> or <tt class="file docutils literal"><span class="pre">config.header.inc.php</span></tt>, which +would be normally not allowed by Content Security Policy.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_DisableMultiTableMaintenance"> +<tt class="descname">$cfg['DisableMultiTableMaintenance']</tt><a class="headerlink" href="#cfg_DisableMultiTableMaintenance" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>In the database Structure page, it’s possible to mark some tables then +choose an operation like optimizing for many tables. This can slow +down a server; therefore, setting this to <tt class="docutils literal"><span class="pre">true</span></tt> prevents this kind +of multiple maintenance operation.</p> +</dd></dl> + +</div> +<div class="section" id="theme-settings"> +<h2>Theme settings<a class="headerlink" href="#theme-settings" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_NaviWidth"> +<tt class="descname">$cfg['NaviWidth']</tt><a class="headerlink" href="#cfg_NaviWidth" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<p>Navigation panel width in pixels. See +<tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_NaviBackground"> +<tt class="descname">$cfg['NaviBackground']</tt><a class="headerlink" href="#cfg_NaviBackground" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color for background]</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_MainBackground"> +<tt class="descname">$cfg['MainBackground']</tt><a class="headerlink" href="#cfg_MainBackground" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color for background]</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<p>The background styles used for both the frames. See +<tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_NaviPointerBackground"> +<tt class="descname">$cfg['NaviPointerBackground']</tt><a class="headerlink" href="#cfg_NaviPointerBackground" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color for background]</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_NaviPointerColor"> +<tt class="descname">$cfg['NaviPointerColor']</tt><a class="headerlink" href="#cfg_NaviPointerColor" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color]</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<p>The style used for the pointer in the navi frame. See +<tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Border"> +<tt class="descname">$cfg['Border']</tt><a class="headerlink" href="#cfg_Border" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<p>The size of a table’s border. See <tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ThBackground"> +<tt class="descname">$cfg['ThBackground']</tt><a class="headerlink" href="#cfg_ThBackground" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color for background]</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ThColor"> +<tt class="descname">$cfg['ThColor']</tt><a class="headerlink" href="#cfg_ThColor" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color]</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<p>The style used for table headers. See +<tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p> +</dd></dl> + +<span class="target" id="cfg-bgcolorone"></span><dl class="option"> +<dt id="cfg_BgOne"> +<tt class="descname">$cfg['BgOne']</tt><a class="headerlink" href="#cfg_BgOne" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color]</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<p>The color (HTML) #1 for table rows. See +<tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p> +</dd></dl> + +<span class="target" id="cfg-bgcolortwo"></span><dl class="option"> +<dt id="cfg_BgTwo"> +<tt class="descname">$cfg['BgTwo']</tt><a class="headerlink" href="#cfg_BgTwo" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color]</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<p>The color (HTML) #2 for table rows. See +<tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_BrowsePointerBackground"> +<tt class="descname">$cfg['BrowsePointerBackground']</tt><a class="headerlink" href="#cfg_BrowsePointerBackground" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color]</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_BrowsePointerColor"> +<tt class="descname">$cfg['BrowsePointerColor']</tt><a class="headerlink" href="#cfg_BrowsePointerColor" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color]</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_BrowseMarkerBackground"> +<tt class="descname">$cfg['BrowseMarkerBackground']</tt><a class="headerlink" href="#cfg_BrowseMarkerBackground" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color]</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_BrowseMarkerColor"> +<tt class="descname">$cfg['BrowseMarkerColor']</tt><a class="headerlink" href="#cfg_BrowseMarkerColor" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color]</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<p>The colors (HTML) uses for the pointer and the marker in browse mode. +The former feature highlights the row over which your mouse is passing +and the latter lets you visually mark/unmark rows by clicking on the +corresponding checkbox. Highlighting / marking a column is done by +hovering over / clicking the column’s header (outside of the text). +See <tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_FontFamily"> +<tt class="descname">$cfg['FontFamily']</tt><a class="headerlink" href="#cfg_FontFamily" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<p>You put here a valid CSS font family value, for example <tt class="docutils literal"><span class="pre">arial,</span> <span class="pre">sans-</span> +<span class="pre">serif</span></tt>. See <tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_FontFamilyFixed"> +<tt class="descname">$cfg['FontFamilyFixed']</tt><a class="headerlink" href="#cfg_FontFamilyFixed" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<p>You put here a valid CSS font family value, for example <tt class="docutils literal"><span class="pre">monospace</span></tt>. +This one is used in textarea. See <tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p> +</dd></dl> + +</div> +<div class="section" id="design-customization"> +<h2>Design customization<a class="headerlink" href="#design-customization" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_NavigationTreePointerEnable"> +<tt class="descname">$cfg['NavigationTreePointerEnable']</tt><a class="headerlink" href="#cfg_NavigationTreePointerEnable" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>A value of <tt class="docutils literal"><span class="pre">true</span></tt> activates the navi pointer.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_BrowsePointerEnable"> +<tt class="descname">$cfg['BrowsePointerEnable']</tt><a class="headerlink" href="#cfg_BrowsePointerEnable" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Whether to activate the browse pointer or not.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_BrowseMarkerEnable"> +<tt class="descname">$cfg['BrowseMarkerEnable']</tt><a class="headerlink" href="#cfg_BrowseMarkerEnable" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Whether to activate the browse marker or not.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_LimitChars"> +<tt class="descname">$cfg['LimitChars']</tt><a class="headerlink" href="#cfg_LimitChars" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">50</td> +</tr> +</tbody> +</table> +<p>Maximum number of characters shown in any non-numeric field on browse +view. Can be turned off by a toggle button on the browse page.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_RowActionLinks"> +<tt class="descname">$cfg['RowActionLinks']</tt><a class="headerlink" href="#cfg_RowActionLinks" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'left'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines the place where table row links (Edit, Copy, Delete) would be +put when tables contents are displayed (you may have them displayed at +the left side, right side, both sides or nowhere). “left” and “right” +are parsed as “top” and “bottom” with vertical display mode.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_DefaultDisplay"> +<tt class="descname">$cfg['DefaultDisplay']</tt><a class="headerlink" href="#cfg_DefaultDisplay" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'horizonta'</span></tt></td> +</tr> +</tbody> +</table> +<p>There are 3 display modes: horizontal, horizontalflipped and vertical. +Define which one is displayed by default. The first mode displays each +row on a horizontal line, the second rotates the headers by 90 +degrees, so you can use descriptive headers even though columns only +contain small values and still print them out. The vertical mode sorts +each row on a vertical lineup.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_RememberSorting"> +<tt class="descname">$cfg['RememberSorting']</tt><a class="headerlink" href="#cfg_RememberSorting" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>If enabled, remember the sorting of each table when browsing them.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_HeaderFlipType"> +<tt class="descname">$cfg['HeaderFlipType']</tt><a class="headerlink" href="#cfg_HeaderFlipType" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'auto'</span></tt></td> +</tr> +</tbody> +</table> +<p>The HeaderFlipType can be set to ‘auto’, ‘css’ or ‘fake’. When using +‘css’ the rotation of the header for horizontalflipped is done via +CSS. The CSS transformation currently works only in Internet +Explorer.If set to ‘fake’ PHP does the transformation for you, but of +course this does not look as good as CSS. The ‘auto’ option enables +CSS transformation when browser supports it and use PHP based one +otherwise.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ShowBrowseComments"> +<tt class="descname">$cfg['ShowBrowseComments']</tt><a class="headerlink" href="#cfg_ShowBrowseComments" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ShowPropertyComments"> +<tt class="descname">$cfg['ShowPropertyComments']</tt><a class="headerlink" href="#cfg_ShowPropertyComments" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>By setting the corresponding variable to <tt class="docutils literal"><span class="pre">true</span></tt> you can enable the +display of column comments in Browse or Property display. In browse +mode, the comments are shown inside the header. In property mode, +comments are displayed using a CSS-formatted dashed-line below the +name of the column. The comment is shown as a tool-tip for that +column.</p> +</dd></dl> + +</div> +<div class="section" id="text-fields"> +<h2>Text fields<a class="headerlink" href="#text-fields" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_CharEditing"> +<tt class="descname">$cfg['CharEditing']</tt><a class="headerlink" href="#cfg_CharEditing" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'input'</span></tt></td> +</tr> +</tbody> +</table> +<p>Defines which type of editing controls should be used for CHAR and +VARCHAR columns. Possible values are:</p> +<ul class="simple"> +<li>input - this allows to limit size of text to size of columns in MySQL, +but has problems with newlines in columns</li> +<li>textarea - no problems with newlines in columns, but also no length +limitations</li> +</ul> +</dd></dl> + +<dl class="option"> +<dt id="cfg_MinSizeForInputField"> +<tt class="descname">$cfg['MinSizeForInputField']</tt><a class="headerlink" href="#cfg_MinSizeForInputField" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">4</td> +</tr> +</tbody> +</table> +<p>Defines the minimum size for input fields generated for CHAR and +VARCHAR columns.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_MaxSizeForInputField"> +<tt class="descname">$cfg['MaxSizeForInputField']</tt><a class="headerlink" href="#cfg_MaxSizeForInputField" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">60</td> +</tr> +</tbody> +</table> +<p>Defines the maximum size for input fields generated for CHAR and +VARCHAR columns.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_TextareaCols"> +<tt class="descname">$cfg['TextareaCols']</tt><a class="headerlink" href="#cfg_TextareaCols" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">40</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_TextareaRows"> +<tt class="descname">$cfg['TextareaRows']</tt><a class="headerlink" href="#cfg_TextareaRows" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">15</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_CharTextareaCols"> +<tt class="descname">$cfg['CharTextareaCols']</tt><a class="headerlink" href="#cfg_CharTextareaCols" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">40</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_CharTextareaRows"> +<tt class="descname">$cfg['CharTextareaRows']</tt><a class="headerlink" href="#cfg_CharTextareaRows" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">2</td> +</tr> +</tbody> +</table> +<p>Number of columns and rows for the textareas. This value will be +emphasized (*2) for <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> query +textareas and (*1.25) for <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> +textareas inside the query window.</p> +<p>The Char* values are used for CHAR +and VARCHAR editing (if configured via <span class="target" id="index-70"></span><a class="reference internal" href="#cfg_CharEditing"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['CharEditing']</span></tt></a>).</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_LongtextDoubleTextarea"> +<tt class="descname">$cfg['LongtextDoubleTextarea']</tt><a class="headerlink" href="#cfg_LongtextDoubleTextarea" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Defines whether textarea for LONGTEXT columns should have double size.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_TextareaAutoSelect"> +<tt class="descname">$cfg['TextareaAutoSelect']</tt><a class="headerlink" href="#cfg_TextareaAutoSelect" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Defines if the whole textarea of the query box will be selected on +click.</p> +</dd></dl> + +</div> +<div class="section" id="sql-query-box-settings"> +<h2>SQL query box settings<a class="headerlink" href="#sql-query-box-settings" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_SQLQuery_Edit"> +<tt class="descname">$cfg['SQLQuery']['Edit']</tt><a class="headerlink" href="#cfg_SQLQuery_Edit" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Whether to display an edit link to change a query in any SQL Query +box.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_SQLQuery_Explain"> +<tt class="descname">$cfg['SQLQuery']['Explain']</tt><a class="headerlink" href="#cfg_SQLQuery_Explain" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Whether to display a link to explain a SELECT query in any SQL Query +box.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_SQLQuery_ShowAsPHP"> +<tt class="descname">$cfg['SQLQuery']['ShowAsPHP']</tt><a class="headerlink" href="#cfg_SQLQuery_ShowAsPHP" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Whether to display a link to wrap a query in PHP code in any SQL Query +box.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_SQLQuery_Validate"> +<tt class="descname">$cfg['SQLQuery']['Validate']</tt><a class="headerlink" href="#cfg_SQLQuery_Validate" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Whether to display a link to validate a query in any SQL Query box.</p> +<div class="admonition-see-also admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><span class="target" id="index-71"></span><a class="reference internal" href="#cfg_SQLValidator"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['SQLValidator']</span></tt></a></p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_SQLQuery_Refresh"> +<tt class="descname">$cfg['SQLQuery']['Refresh']</tt><a class="headerlink" href="#cfg_SQLQuery_Refresh" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Whether to display a link to refresh a query in any SQL Query box.</p> +</dd></dl> + +</div> +<div class="section" id="web-server-upload-save-import-directories"> +<h2>Web server upload/save/import directories<a class="headerlink" href="#web-server-upload-save-import-directories" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_UploadDir"> +<tt class="descname">$cfg['UploadDir']</tt><a class="headerlink" href="#cfg_UploadDir" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>The name of the directory where <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> files have been uploaded by +other means than phpMyAdmin (for example, ftp). Those files are available +under a drop-down box when you click the database or table name, then the +Import tab.</p> +<p>If +you want different directory for each user, %u will be replaced with +username.</p> +<p>Please note that the file names must have the suffix ”.sql” +(or ”.sql.bz2” or ”.sql.gz” if support for compressed formats is +enabled).</p> +<p>This feature is useful when your file is too big to be +uploaded via <a class="reference internal" href="glossary.html#term-http"><em class="xref std std-term">HTTP</em></a>, or when file +uploads are disabled in PHP.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">If PHP is running in safe mode, this directory must be owned by the same +user as the owner of the phpMyAdmin scripts. See also <a class="reference internal" href="faq.html#faq1-16"><em>1.16 I cannot upload big dump files (memory, HTTP or timeout problems).</em></a> for +alternatives.</p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_SaveDir"> +<tt class="descname">$cfg['SaveDir']</tt><a class="headerlink" href="#cfg_SaveDir" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>The name of the directory where dumps can be saved.</p> +<p>If you want different directory for each user, %u will be replaced with +username.</p> +<p>Please note that the directory must exist and has to be writable for +the user running webserver.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">If PHP is running in safe mode, this directory must be owned by the same +user as the owner of the phpMyAdmin scripts.</p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_TempDir"> +<tt class="descname">$cfg['TempDir']</tt><a class="headerlink" href="#cfg_TempDir" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>The name of the directory where temporary files can be stored.</p> +<p>This is needed for importing ESRI Shapefiles, see <a class="reference internal" href="faq.html#faq6-30"><em>6.30 Import: How can I import ESRI Shapefiles</em></a> and to +work around limitations of <tt class="docutils literal"><span class="pre">open_basedir</span></tt> for uploaded files, see +<a class="reference internal" href="faq.html#faq1-11"><em>1.11 I get an ‘open_basedir restriction’ while uploading a file from the query box.</em></a>.</p> +<p>If the directory where phpMyAdmin is installed is +subject to an <tt class="docutils literal"><span class="pre">open_basedir</span></tt> restriction, you need to create a +temporary directory in some directory accessible by the web server. +However for security reasons, this directory should be outside the +tree published by webserver. If you cannot avoid having this directory +published by webserver, place at least an empty <tt class="file docutils literal"><span class="pre">index.html</span></tt> file +there, so that directory listing is not possible.</p> +<p>This directory should have as strict permissions as possible as the only +user required to access this directory is the one who runs the webserver. +If you have root privileges, simply make this user owner of this directory +and make it accessible only by it:</p> +<div class="highlight-sh"><div class="highlight"><pre>chown www-data:www-data tmp +chmod 700 tmp +</pre></div> +</div> +<p>If you cannot change owner of the directory, you can achieve a similar +setup using <a class="reference internal" href="glossary.html#term-acl"><em class="xref std std-term">ACL</em></a>:</p> +<div class="highlight-sh"><div class="highlight"><pre>chmod 700 tmp +setfacl -m <span class="s2">"g:www-data:rwx"</span> tmp +setfacl -d -m <span class="s2">"g:www-data:rwx"</span> tmp +</pre></div> +</div> +<p>If neither of above works for you, you can still make the directory +<strong class="command">chmod 777</strong>, but it might impose risk of other users on system +reading and writing data in this directory.</p> +</dd></dl> + +</div> +<div class="section" id="various-display-setting"> +<h2>Various display setting<a class="headerlink" href="#various-display-setting" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_ShowDisplayDirection"> +<tt class="descname">$cfg['ShowDisplayDirection']</tt><a class="headerlink" href="#cfg_ShowDisplayDirection" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Defines whether or not type display direction option is shown when +browsing a table.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_RepeatCells"> +<tt class="descname">$cfg['RepeatCells']</tt><a class="headerlink" href="#cfg_RepeatCells" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">100</td> +</tr> +</tbody> +</table> +<p>Repeat the headers every X cells, or 0 to deactivate.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_EditInWindow"> +<tt class="descname">$cfg['EditInWindow']</tt><a class="headerlink" href="#cfg_EditInWindow" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_QueryWindowWidth"> +<tt class="descname">$cfg['QueryWindowWidth']</tt><a class="headerlink" href="#cfg_QueryWindowWidth" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">550</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_QueryWindowHeight"> +<tt class="descname">$cfg['QueryWindowHeight']</tt><a class="headerlink" href="#cfg_QueryWindowHeight" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">310</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_QueryHistoryDB"> +<tt class="descname">$cfg['QueryHistoryDB']</tt><a class="headerlink" href="#cfg_QueryHistoryDB" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_QueryWindowDefTab"> +<tt class="descname">$cfg['QueryWindowDefTab']</tt><a class="headerlink" href="#cfg_QueryWindowDefTab" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'sql'</span></tt></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_QueryHistoryMax"> +<tt class="descname">$cfg['QueryHistoryMax']</tt><a class="headerlink" href="#cfg_QueryHistoryMax" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">25</td> +</tr> +</tbody> +</table> +<p>All those variables affect the query window feature. A <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> link or +icon is always displayed in the navigation panel. If JavaScript is enabled +in your browser, a click on this opens a distinct query window, which is a +direct interface to enter <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> queries. Otherwise, the right panel +changes to display a query box.</p> +<p>The size of this query window can be customized with +<span class="target" id="index-72"></span><a class="reference internal" href="#cfg_QueryWindowWidth"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['QueryWindowWidth']</span></tt></a> and +<span class="target" id="index-73"></span><a class="reference internal" href="#cfg_QueryWindowHeight"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['QueryWindowHeight']</span></tt></a> - both integers for the size in +pixels. Note that normally, those parameters will be modified in +<tt class="file docutils literal"><span class="pre">layout.inc.php`</span></tt> for the theme you are using.</p> +<p>If <span class="target" id="index-74"></span><a class="reference internal" href="#cfg_EditInWindow"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['EditInWindow']</span></tt></a> is set to true, a click on [Edit] +from the results page (in the <em class="guilabel">Showing Rows</em> section) opens the +query window and puts the current query inside it. If set to false, +clicking on the link puts the <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> query +in the right panel’s query box.</p> +<p>If <span class="target" id="index-75"></span><a class="reference internal" href="#cfg_QueryHistoryDB"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['QueryHistoryDB']</span></tt></a> is set to <tt class="docutils literal"><span class="pre">true</span></tt>, all your +Queries are logged to a table, which has to be created by you (see +<span class="target" id="index-76"></span><a class="reference internal" href="#cfg_Servers_history"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['history']</span></tt></a>). If set to false, all your +queries will be appended to the form, but only as long as your window is +opened they remain saved.</p> +<p>When using the JavaScript based query window, it will always get updated +when you click on a new table/db to browse and will focus if you click on +<em class="guilabel">Edit SQL</em> after using a query. You can suppress updating the +query window by checking the box <em class="guilabel">Do not overwrite this query +from outside the window</em> below the query textarea. Then you can browse +tables/databases in the background without losing the contents of the +textarea, so this is especially useful when composing a query with tables +you first have to look in. The checkbox will get automatically checked +whenever you change the contents of the textarea. Please uncheck the button +whenever you definitely want the query window to get updated even though +you have made alterations.</p> +<p>If <span class="target" id="index-77"></span><a class="reference internal" href="#cfg_QueryHistoryDB"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['QueryHistoryDB']</span></tt></a> is set to <tt class="docutils literal"><span class="pre">true</span></tt> you can +specify the amount of saved history items using +<span class="target" id="index-78"></span><a class="reference internal" href="#cfg_QueryHistoryMax"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['QueryHistoryMax']</span></tt></a>.</p> +<p>The query window also has a custom tabbed look to group the features. +Using the variable <span class="target" id="index-79"></span><a class="reference internal" href="#cfg_QueryWindowDefTab"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['QueryWindowDefTab']</span></tt></a> you can +specify the default tab to be used when opening the query window. It can be +set to either <tt class="docutils literal"><span class="pre">sql</span></tt>, <tt class="docutils literal"><span class="pre">files</span></tt>, <tt class="docutils literal"><span class="pre">history</span></tt> or <tt class="docutils literal"><span class="pre">full</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_BrowseMIME"> +<tt class="descname">$cfg['BrowseMIME']</tt><a class="headerlink" href="#cfg_BrowseMIME" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Enable <a class="reference internal" href="transformations.html#transformations"><em>Transformations</em></a>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_MaxExactCount"> +<tt class="descname">$cfg['MaxExactCount']</tt><a class="headerlink" href="#cfg_MaxExactCount" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">0</td> +</tr> +</tbody> +</table> +<p>For InnoDB tables, determines for how large tables phpMyAdmin should +get the exact row count using <tt class="docutils literal"><span class="pre">SELECT</span> <span class="pre">COUNT</span></tt>. If the approximate row +count as returned by <tt class="docutils literal"><span class="pre">SHOW</span> <span class="pre">TABLE</span> <span class="pre">STATUS</span></tt> is smaller than this value, +<tt class="docutils literal"><span class="pre">SELECT</span> <span class="pre">COUNT</span></tt> will be used, otherwise the approximate count will be +used.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_MaxExactCountViews"> +<tt class="descname">$cfg['MaxExactCountViews']</tt><a class="headerlink" href="#cfg_MaxExactCountViews" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">0</td> +</tr> +</tbody> +</table> +<p>For VIEWs, since obtaining the exact count could have an impact on +performance, this value is the maximum to be displayed, using a +<tt class="docutils literal"><span class="pre">SELECT</span> <span class="pre">COUNT</span> <span class="pre">...</span> <span class="pre">LIMIT</span></tt>. Setting this to 0 bypasses any row +counting.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_NaturalOrder"> +<tt class="descname">$cfg['NaturalOrder']</tt><a class="headerlink" href="#cfg_NaturalOrder" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Sorts database and table names according to natural order (for +example, t1, t2, t10). Currently implemented in the navigation panel +and in Database view, for the table list.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_InitialSlidersState"> +<tt class="descname">$cfg['InitialSlidersState']</tt><a class="headerlink" href="#cfg_InitialSlidersState" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'closed'</span></tt></td> +</tr> +</tbody> +</table> +<p>If set to <tt class="docutils literal"><span class="pre">'closed'</span></tt>, the visual sliders are initially in a closed +state. A value of <tt class="docutils literal"><span class="pre">'open'</span></tt> does the reverse. To completely disable +all visual sliders, use <tt class="docutils literal"><span class="pre">'disabled'</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_UserprefsDisallow"> +<tt class="descname">$cfg['UserprefsDisallow']</tt><a class="headerlink" href="#cfg_UserprefsDisallow" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array()</td> +</tr> +</tbody> +</table> +<p>Contains names of configuration options (keys in <tt class="docutils literal"><span class="pre">$cfg</span></tt> array) that +users can’t set through user preferences. For possible values, refer +to <tt class="file docutils literal"><span class="pre">libraries/config/user_preferences.forms.php</span></tt>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_UserprefsDeveloperTab"> +<tt class="descname">$cfg['UserprefsDeveloperTab']</tt><a class="headerlink" href="#cfg_UserprefsDeveloperTab" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Activates in the user preferences a tab containing options for +developers of phpMyAdmin.</p> +</dd></dl> + +</div> +<div class="section" id="page-titles"> +<h2>Page titles<a class="headerlink" href="#page-titles" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_TitleTable"> +<tt class="descname">$cfg['TitleTable']</tt><a class="headerlink" href="#cfg_TitleTable" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'@HTTP_HOST@</span> <span class="pre">/</span> <span class="pre">@VSERVER@</span> <span class="pre">/</span> <span class="pre">@DATABASE@</span> <span class="pre">/</span> <span class="pre">@TABLE@</span> <span class="pre">|</span> <span class="pre">@PHPMYADMIN@'</span></tt></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_TitleDatabase"> +<tt class="descname">$cfg['TitleDatabase']</tt><a class="headerlink" href="#cfg_TitleDatabase" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'@HTTP_HOST@</span> <span class="pre">/</span> <span class="pre">@VSERVER@</span> <span class="pre">/</span> <span class="pre">@DATABASE@</span> <span class="pre">|</span> <span class="pre">@PHPMYADMIN@'</span></tt></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_TitleServer"> +<tt class="descname">$cfg['TitleServer']</tt><a class="headerlink" href="#cfg_TitleServer" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'@HTTP_HOST@</span> <span class="pre">/</span> <span class="pre">@VSERVER@</span> <span class="pre">|</span> <span class="pre">@PHPMYADMIN@'</span></tt></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_TitleDefault"> +<tt class="descname">$cfg['TitleDefault']</tt><a class="headerlink" href="#cfg_TitleDefault" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'@HTTP_HOST@</span> <span class="pre">|</span> <span class="pre">@PHPMYADMIN@'</span></tt></td> +</tr> +</tbody> +</table> +<p>Allows you to specify window’s title bar. You can use <a class="reference internal" href="faq.html#faq6-27"><em>6.27 What format strings can I use?</em></a>.</p> +</dd></dl> + +</div> +<div class="section" id="theme-manager-settings"> +<h2>Theme manager settings<a class="headerlink" href="#theme-manager-settings" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_ThemePath"> +<tt class="descname">$cfg['ThemePath']</tt><a class="headerlink" href="#cfg_ThemePath" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'./themes'</span></tt></td> +</tr> +</tbody> +</table> +<p>If theme manager is active, use this as the path of the subdirectory +containing all the themes.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ThemeManager"> +<tt class="descname">$cfg['ThemeManager']</tt><a class="headerlink" href="#cfg_ThemeManager" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td> +</tr> +</tbody> +</table> +<p>Enables user-selectable themes. See <a class="reference internal" href="faq.html#faqthemes"><em>2.7 Using and creating themes</em></a>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ThemeDefault"> +<tt class="descname">$cfg['ThemeDefault']</tt><a class="headerlink" href="#cfg_ThemeDefault" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'pmahomme'</span></tt></td> +</tr> +</tbody> +</table> +<p>The default theme (a subdirectory under <span class="target" id="index-80"></span><a class="reference internal" href="#cfg_ThemePath"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['ThemePath']</span></tt></a>).</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ThemePerServer"> +<tt class="descname">$cfg['ThemePerServer']</tt><a class="headerlink" href="#cfg_ThemePerServer" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Whether to allow different theme for each server.</p> +</dd></dl> + +</div> +<div class="section" id="default-queries"> +<h2>Default queries<a class="headerlink" href="#default-queries" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_DefaultQueryTable"> +<tt class="descname">$cfg['DefaultQueryTable']</tt><a class="headerlink" href="#cfg_DefaultQueryTable" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'SELECT</span> <span class="pre">*</span> <span class="pre">FROM</span> <span class="pre">@TABLE@</span> <span class="pre">WHERE</span> <span class="pre">1'</span></tt></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_DefaultQueryDatabase"> +<tt class="descname">$cfg['DefaultQueryDatabase']</tt><a class="headerlink" href="#cfg_DefaultQueryDatabase" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>Default queries that will be displayed in query boxes when user didn’t +specify any. You can use standard <a class="reference internal" href="faq.html#faq6-27"><em>6.27 What format strings can I use?</em></a>.</p> +</dd></dl> + +</div> +<div class="section" id="sql-parser-settings"> +<h2>SQL parser settings<a class="headerlink" href="#sql-parser-settings" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_SQP_fmtType"> +<tt class="descname">$cfg['SQP']['fmtType']</tt><a class="headerlink" href="#cfg_SQP_fmtType" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'html'</span></tt></td> +</tr> +</tbody> +</table> +<p>The main use of the new <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> Parser +is to pretty-print <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> queries. By +default we use HTML to format the query, but you can disable this by +setting this variable to <tt class="docutils literal"><span class="pre">'none'</span></tt>.</p> +<p>Available options:</p> +<ul class="simple"> +<li><tt class="docutils literal"><span class="pre">'html'</span></tt></li> +<li><tt class="docutils literal"><span class="pre">'none'</span></tt></li> +</ul> +</dd></dl> + +<span class="target" id="cfg-sqp"></span><dl class="option"> +<dt id="cfg_SQP_fmtInd"> +<tt class="descname">$cfg['SQP']['fmtInd']</tt><a class="headerlink" href="#cfg_SQP_fmtInd" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">float</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'1'</span></tt></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_SQP_fmtIndUnit"> +<tt class="descname">$cfg['SQP']['fmtIndUnit']</tt><a class="headerlink" href="#cfg_SQP_fmtIndUnit" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'em'</span></tt></td> +</tr> +</tbody> +</table> +<p>For the pretty-printing of <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> queries, +under some cases the part of a query inside a bracket is indented. By +changing <span class="target" id="index-81"></span><a class="reference internal" href="#cfg_SQP_fmtInd"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['SQP']['fmtInd']</span></tt></a> you can change the amount +of this indent.</p> +<p>Related in purpose is <span class="target" id="index-82"></span><a class="reference internal" href="#cfg_SQP_fmtIndUnit"><tt class="xref config config-option docutils literal"><span class="pre">$cfg['SQP']['fmtIndUnit']</span></tt></a> which +specifies the units of the indent amount that you specified. This is used +via stylesheets.</p> +<p>You can use any HTML unit, for example:</p> +<ul class="simple"> +<li><tt class="docutils literal"><span class="pre">'em'</span></tt></li> +<li><tt class="docutils literal"><span class="pre">'ex'</span></tt></li> +<li><tt class="docutils literal"><span class="pre">'pt'</span></tt></li> +<li><tt class="docutils literal"><span class="pre">'px'</span></tt></li> +</ul> +</dd></dl> + +<dl class="option"> +<dt id="cfg_SQP_fmtColor"> +<tt class="descname">$cfg['SQP']['fmtColor']</tt><a class="headerlink" href="#cfg_SQP_fmtColor" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array of string tuples</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td> +</tr> +</tbody> +</table> +<p>This array is used to define the colours for each type of element of +the pretty-printed <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> queries. +The tuple format is <em>class</em> => [<em>HTML colour code</em> | <em>empty string</em>]</p> +<p>If you specify an empty string for the color of a class, it is ignored +in creating the stylesheet. You should not alter the class names, only +the colour strings.</p> +<p><strong>Class name key:</strong></p> +<dl class="docutils"> +<dt>comment</dt> +<dd>Applies to all comment sub-classes</dd> +<dt>comment_mysql</dt> +<dd>Comments as <tt class="docutils literal"><span class="pre">"#...\n"</span></tt></dd> +<dt>comment_ansi</dt> +<dd>Comments as <tt class="docutils literal"><span class="pre">"--</span> <span class="pre">...\n"</span></tt></dd> +<dt>comment_c</dt> +<dd>Comments as <tt class="docutils literal"><span class="pre">"/*...*/"</span></tt></dd> +<dt>digit</dt> +<dd>Applies to all digit sub-classes</dd> +<dt>digit_hex</dt> +<dd>Hexadecimal numbers</dd> +<dt>digit_integer</dt> +<dd>Integer numbers</dd> +<dt>digit_float</dt> +<dd>Floating point numbers</dd> +<dt>punct</dt> +<dd>Applies to all punctuation sub-classes</dd> +<dt>punct_bracket_open_round</dt> +<dd>Opening brackets <tt class="docutils literal"><span class="pre">"("</span></tt></dd> +<dt>punct_bracket_close_round</dt> +<dd>Closing brackets <tt class="docutils literal"><span class="pre">")"</span></tt></dd> +<dt>punct_listsep</dt> +<dd>List item Separator <tt class="docutils literal"><span class="pre">","</span></tt></dd> +<dt>punct_qualifier</dt> +<dd>Table/Column Qualifier <tt class="docutils literal"><span class="pre">"."</span></tt></dd> +<dt>punct_queryend</dt> +<dd>End of query marker <tt class="docutils literal"><span class="pre">";"</span></tt></dd> +<dt>alpha</dt> +<dd>Applies to all alphabetic classes</dd> +<dt>alpha_columnType</dt> +<dd>Identifiers matching a column type</dd> +<dt>alpha_columnAttrib</dt> +<dd>Identifiers matching a database/table/column attribute</dd> +<dt>alpha_functionName</dt> +<dd>Identifiers matching a MySQL function name</dd> +<dt>alpha_reservedWord</dt> +<dd>Identifiers matching any other reserved word</dd> +<dt>alpha_variable</dt> +<dd>Identifiers matching a <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> variable <tt class="docutils literal"><span class="pre">"@foo"</span></tt></dd> +<dt>alpha_identifier</dt> +<dd>All other identifiers</dd> +<dt>quote</dt> +<dd>Applies to all quotation mark classes</dd> +<dt>quote_double</dt> +<dd>Double quotes <tt class="docutils literal"><span class="pre">"</span></tt></dd> +<dt>quote_single</dt> +<dd>Single quotes <tt class="docutils literal"><span class="pre">'</span></tt></dd> +<dt>quote_backtick</dt> +<dd>Backtick quotes <tt class="docutils literal"><span class="pre">`</span></tt></dd> +</dl> +</dd></dl> + +</div> +<div class="section" id="sql-validator-settings"> +<h2>SQL validator settings<a class="headerlink" href="#sql-validator-settings" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_SQLValidator"> +<tt class="descname">$cfg['SQLValidator']</tt><a class="headerlink" href="#cfg_SQLValidator" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array(...)</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_SQLValidator_use"> +<tt class="descname">$cfg['SQLValidator']['use']</tt><a class="headerlink" href="#cfg_SQLValidator_use" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>phpMyAdmin now supports use of the <a class="reference external" href="http://developer.mimer.com/validator/index.htm">Mimer SQL Validator</a> service, as originally +published on <a class="reference external" href="http://developers.slashdot.org/article.pl?sid=02/02/19/1720246">Slashdot</a>. For +help in setting up your system to use the service, see the +<a class="reference internal" href="faq.html#faqsqlvalidator"><em>6.14 How do I set up the SQL Validator?</em></a>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_SQLValidator_username"> +<tt class="descname">$cfg['SQLValidator']['username']</tt><a class="headerlink" href="#cfg_SQLValidator_username" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_SQLValidator_password"> +<tt class="descname">$cfg['SQLValidator']['password']</tt><a class="headerlink" href="#cfg_SQLValidator_password" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">''</span></tt></td> +</tr> +</tbody> +</table> +<p>The SOAP service allows you to log in with <tt class="docutils literal"><span class="pre">anonymous</span></tt> and any password, +so we use those by default. Instead, if you have an account with them, you +can put your login details here, and it will be used in place of the +anonymous login.</p> +</dd></dl> + +</div> +<div class="section" id="mysql-settings"> +<h2>MySQL settings<a class="headerlink" href="#mysql-settings" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_DefaultFunctions"> +<tt class="descname">$cfg['DefaultFunctions']</tt><a class="headerlink" href="#cfg_DefaultFunctions" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array(...)</td> +</tr> +</tbody> +</table> +<p>Functions selected by default when inserting/changing row, Functions +are defined for meta types as (FUNC_NUMBER, FUNC_DATE, FUNC_CHAR, +FUNC_SPATIAL, FUNC_UUID) and for <tt class="docutils literal"><span class="pre">first_timestamp</span></tt>, which is used +for first timestamp column in table.</p> +</dd></dl> + +</div> +<div class="section" id="developer"> +<h2>Developer<a class="headerlink" href="#developer" title="Permalink to this headline">¶</a></h2> +<div class="admonition warning"> +<p class="first admonition-title">Warning</p> +<p class="last">These settings might have huge effect on performance or security.</p> +</div> +<dl class="option"> +<dt id="cfg_DBG"> +<tt class="descname">$cfg['DBG']</tt><a class="headerlink" href="#cfg_DBG" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array(...)</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="option"> +<dt id="cfg_DBG_sql"> +<tt class="descname">$cfg['DBG']['sql']</tt><a class="headerlink" href="#cfg_DBG_sql" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Enable logging queries and execution times to be +displayed in the bottom of main page (right frame).</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Error_Handler_display"> +<tt class="descname">$cfg['Error_Handler']['display']</tt><a class="headerlink" href="#cfg_Error_Handler_display" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Whether to display errors from PHP or not.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Error_Handler_gather"> +<tt class="descname">$cfg['Error_Handler']['gather']</tt><a class="headerlink" href="#cfg_Error_Handler_gather" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Whether to gather errors from PHP or not.</p> +</dd></dl> + +</div> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar"> + <div class="sphinxsidebarwrapper"> + <h3><a href="index.html">Table Of Contents</a></h3> + <ul> +<li><a class="reference internal" href="#">Configuration</a><ul> +<li><a class="reference internal" href="#basic-settings">Basic settings</a></li> +<li><a class="reference internal" href="#server-connection-settings">Server connection settings</a></li> +<li><a class="reference internal" href="#generic-settings">Generic settings</a></li> +<li><a class="reference internal" href="#cookie-authentication-options">Cookie authentication options</a></li> +<li><a class="reference internal" href="#navigation-panel-setup">Navigation panel setup</a></li> +<li><a class="reference internal" href="#main-panel">Main panel</a></li> +<li><a class="reference internal" href="#database-structure">Database structure</a></li> +<li><a class="reference internal" href="#browse-mode">Browse mode</a></li> +<li><a class="reference internal" href="#editing-mode">Editing mode</a></li> +<li><a class="reference internal" href="#export-and-import-settings">Export and import settings</a></li> +<li><a class="reference internal" href="#tabs-display-settings">Tabs display settings</a></li> +<li><a class="reference internal" href="#documentation">Documentation</a></li> +<li><a class="reference internal" href="#languages">Languages</a></li> +<li><a class="reference internal" href="#web-server-settings">Web server settings</a></li> +<li><a class="reference internal" href="#theme-settings">Theme settings</a></li> +<li><a class="reference internal" href="#design-customization">Design customization</a></li> +<li><a class="reference internal" href="#text-fields">Text fields</a></li> +<li><a class="reference internal" href="#sql-query-box-settings">SQL query box settings</a></li> +<li><a class="reference internal" href="#web-server-upload-save-import-directories">Web server upload/save/import directories</a></li> +<li><a class="reference internal" href="#various-display-setting">Various display setting</a></li> +<li><a class="reference internal" href="#page-titles">Page titles</a></li> +<li><a class="reference internal" href="#theme-manager-settings">Theme manager settings</a></li> +<li><a class="reference internal" href="#default-queries">Default queries</a></li> +<li><a class="reference internal" href="#sql-parser-settings">SQL parser settings</a></li> +<li><a class="reference internal" href="#sql-validator-settings">SQL validator settings</a></li> +<li><a class="reference internal" href="#mysql-settings">MySQL settings</a></li> +<li><a class="reference internal" href="#developer">Developer</a></li> +</ul> +</li> +</ul> + + <h4>Previous topic</h4> + <p class="topless"><a href="setup.html" + title="previous chapter">Installation</a></p> + <h4>Next topic</h4> + <p class="topless"><a href="user.html" + title="next chapter">User Guide</a></p> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="_sources/config.txt" + rel="nofollow">Show Source</a></li> + </ul> +<div id="searchbox" style="display: none"> + <h3>Quick search</h3> + <form class="search" action="search.html" method="get"> + <input type="text" name="q" /> + <input type="submit" value="Go" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> + <p class="searchtip" style="font-size: 90%"> + Enter search terms or a module, class or function name. + </p> +</div> +<script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="genindex.html" title="General Index" + >index</a></li> + <li class="right" > + <a href="user.html" title="User Guide" + >next</a> |</li> + <li class="right" > + <a href="setup.html" title="Installation" + >previous</a> |</li> + <li><a href="index.html">phpMyAdmin 4.0.7 documentation</a> »</li> + </ul> + </div> + <div class="footer"> + © <a href="copyright.html">Copyright</a> 2012 - 2013, The phpMyAdmin devel team. + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. + </div> + </body> +</html>
\ No newline at end of file |