Upgraded phpmyadmin to 4.0.4 (All Languages) - No modifications yet
[openemr.git] / phpmyadmin / doc / html / config.html
blob9646bdfb85c202027781cc45117dc474c46bfb1d
3 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7 <html xmlns="http://www.w3.org/1999/xhtml">
8 <head>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <title>Configuration &mdash; phpMyAdmin 4.0.4 documentation</title>
13 <link rel="stylesheet" href="_static/default.css" type="text/css" />
14 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
16 <script type="text/javascript">
17 var DOCUMENTATION_OPTIONS = {
18 URL_ROOT: '',
19 VERSION: '4.0.4',
20 COLLAPSE_INDEX: false,
21 FILE_SUFFIX: '.html',
22 HAS_SOURCE: true
24 </script>
25 <script type="text/javascript" src="_static/jquery.js"></script>
26 <script type="text/javascript" src="_static/underscore.js"></script>
27 <script type="text/javascript" src="_static/doctools.js"></script>
28 <link rel="copyright" title="Copyright" href="copyright.html" />
29 <link rel="top" title="phpMyAdmin 4.0.4 documentation" href="index.html" />
30 <link rel="next" title="User Guide" href="user.html" />
31 <link rel="prev" title="Installation" href="setup.html" />
32 </head>
33 <body>
34 <div class="related">
35 <h3>Navigation</h3>
36 <ul>
37 <li class="right" style="margin-right: 10px">
38 <a href="genindex.html" title="General Index"
39 accesskey="I">index</a></li>
40 <li class="right" >
41 <a href="user.html" title="User Guide"
42 accesskey="N">next</a> |</li>
43 <li class="right" >
44 <a href="setup.html" title="Installation"
45 accesskey="P">previous</a> |</li>
46 <li><a href="index.html">phpMyAdmin 4.0.4 documentation</a> &raquo;</li>
47 </ul>
48 </div>
50 <div class="document">
51 <div class="documentwrapper">
52 <div class="bodywrapper">
53 <div class="body">
55 <div class="section" id="configuration">
56 <span id="config"></span><span id="index-0"></span><h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h1>
57 <p>Almost all configurable data is placed in <tt class="file docutils literal"><span class="pre">config.inc.php</span></tt>. If this file
58 does not exist, please refer to the <a class="reference internal" href="setup.html#setup"><em>Installation</em></a> section to create one. This
59 file only needs to contain the parameters you want to change from their
60 corresponding default value in <tt class="file docutils literal"><span class="pre">libraries/config.default.php</span></tt>.</p>
61 <p>The parameters which relate to design (like colors) are placed in
62 <tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>. You might also want to create
63 <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
64 your site specific code to be included on start and end of each page.</p>
65 <div class="admonition note">
66 <p class="first admonition-title">Note</p>
67 <p class="last">Some distributions (eg. Debian or Ubuntu) store <tt class="file docutils literal"><span class="pre">config.inc.php</span></tt> in
68 <tt class="docutils literal"><span class="pre">/etc/phpmyadmin</span></tt> instead of within phpMyAdmin sources.</p>
69 </div>
70 <div class="admonition warning">
71 <p class="first admonition-title">Warning</p>
72 <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
73 <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
74 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
75 ensure you choose the option that allows to use the *nix end of line
76 character (<tt class="docutils literal"><span class="pre">\n</span></tt>) in your text editor before saving a script you have
77 modified.</p>
78 </div>
79 <div class="section" id="basic-settings">
80 <h2>Basic settings<a class="headerlink" href="#basic-settings" title="Permalink to this headline"></a></h2>
81 <dl class="option">
82 <dt id="cfg_PmaAbsoluteUri">
83 <tt class="descname">$cfg['PmaAbsoluteUri']</tt><a class="headerlink" href="#cfg_PmaAbsoluteUri" title="Permalink to this definition"></a></dt>
84 <dd><table class="docutils field-list" frame="void" rules="none">
85 <col class="field-name" />
86 <col class="field-body" />
87 <tbody valign="top">
88 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
89 </tr>
90 <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>
91 </tr>
92 </tbody>
93 </table>
94 <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
95 installation&#8217;s directory. E.g.
96 <tt class="docutils literal"><span class="pre">http://www.example.net/path_to_your_phpMyAdmin_directory/</span></tt>. Note also
97 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
98 the trailing slash at the end.</p>
99 <p>Starting with version 2.3.0, it is advisable to try leaving this blank. In
100 most cases phpMyAdmin automatically detects the proper setting. Users of
101 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>
102 (<a class="reference external" href="https://sourceforge.net/p/phpmyadmin/support-requests/795/">more info</a>).</p>
103 <p>A good test is to browse a table, edit a row and save it. There should be
104 an error message if phpMyAdmin is having trouble auto–detecting the correct
105 value. If you get an error that this must be set or if the autodetect code
106 fails to detect your path, please post a bug report on our bug tracker so
107 we can improve the code.</p>
108 <div class="admonition-see-also admonition seealso">
109 <p class="first admonition-title">See also</p>
110 <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>
111 </div>
112 </dd></dl>
114 <dl class="option">
115 <dt id="cfg_PmaNoRelation_DisableWarning">
116 <tt class="descname">$cfg['PmaNoRelation_DisableWarning']</tt><a class="headerlink" href="#cfg_PmaNoRelation_DisableWarning" title="Permalink to this definition"></a></dt>
117 <dd><table class="docutils field-list" frame="void" rules="none">
118 <col class="field-name" />
119 <col class="field-body" />
120 <tbody valign="top">
121 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
122 </tr>
123 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
124 </tr>
125 </tbody>
126 </table>
127 <p>Starting with version 2.3.0 phpMyAdmin offers a lot of features to
128 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>
129 <p>If you tried to set this
130 up and it does not work for you, have a look on the <em class="guilabel">Structure</em> page
131 of one database where you would like to use it. You will find a link
132 that will analyze why those features have been disabled.</p>
133 <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
134 stop this message from appearing.</p>
135 </dd></dl>
137 <dl class="option">
138 <dt id="cfg_SuhosinDisableWarning">
139 <tt class="descname">$cfg['SuhosinDisableWarning']</tt><a class="headerlink" href="#cfg_SuhosinDisableWarning" title="Permalink to this definition"></a></dt>
140 <dd><table class="docutils field-list" frame="void" rules="none">
141 <col class="field-name" />
142 <col class="field-body" />
143 <tbody valign="top">
144 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
145 </tr>
146 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
147 </tr>
148 </tbody>
149 </table>
150 <p>A warning is displayed on the main page if Suhosin is detected.</p>
151 <p>You can set this parameter to <tt class="docutils literal"><span class="pre">true</span></tt> to stop this message from appearing.</p>
152 </dd></dl>
154 <dl class="option">
155 <dt id="cfg_McryptDisableWarning">
156 <tt class="descname">$cfg['McryptDisableWarning']</tt><a class="headerlink" href="#cfg_McryptDisableWarning" title="Permalink to this definition"></a></dt>
157 <dd><table class="docutils field-list" frame="void" rules="none">
158 <col class="field-name" />
159 <col class="field-body" />
160 <tbody valign="top">
161 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
162 </tr>
163 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
164 </tr>
165 </tbody>
166 </table>
167 <p>Disable the default warning that is displayed if mcrypt is missing for
168 cookie authentication.</p>
169 <p>You can set this parameter to <tt class="docutils literal"><span class="pre">true</span></tt> to stop this message from appearing.</p>
170 </dd></dl>
172 <dl class="option">
173 <dt id="cfg_ServerLibraryDifference_DisableWarning">
174 <tt class="descname">$cfg['ServerLibraryDifference_DisableWarning']</tt><a class="headerlink" href="#cfg_ServerLibraryDifference_DisableWarning" title="Permalink to this definition"></a></dt>
175 <dd><table class="docutils field-list" frame="void" rules="none">
176 <col class="field-name" />
177 <col class="field-body" />
178 <tbody valign="top">
179 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
180 </tr>
181 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
182 </tr>
183 </tbody>
184 </table>
185 <p>A warning is displayed on the main page if there is a difference
186 between the MySQL library and server version.</p>
187 <p>You can set this parameter to <tt class="docutils literal"><span class="pre">true</span></tt> to stop this message from appearing.</p>
188 </dd></dl>
190 <dl class="option">
191 <dt id="cfg_ReservedWordDisableWarning">
192 <tt class="descname">$cfg['ReservedWordDisableWarning']</tt><a class="headerlink" href="#cfg_ReservedWordDisableWarning" title="Permalink to this definition"></a></dt>
193 <dd><table class="docutils field-list" frame="void" rules="none">
194 <col class="field-name" />
195 <col class="field-body" />
196 <tbody valign="top">
197 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
198 </tr>
199 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
200 </tr>
201 </tbody>
202 </table>
203 <p>This warning is displayed on the Structure page of a table if one or more
204 column names match with words which are MySQL reserved.</p>
205 <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
206 warning will not longer be displayed</p>
207 </dd></dl>
209 <dl class="option">
210 <dt id="cfg_TranslationWarningThreshold">
211 <tt class="descname">$cfg['TranslationWarningThreshold']</tt><a class="headerlink" href="#cfg_TranslationWarningThreshold" title="Permalink to this definition"></a></dt>
212 <dd><table class="docutils field-list" frame="void" rules="none">
213 <col class="field-name" />
214 <col class="field-body" />
215 <tbody valign="top">
216 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
217 </tr>
218 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">80</td>
219 </tr>
220 </tbody>
221 </table>
222 <p>Show warning about incomplete translations on certain threshold.</p>
223 </dd></dl>
225 </div>
226 <div class="section" id="server-connection-settings">
227 <h2>Server connection settings<a class="headerlink" href="#server-connection-settings" title="Permalink to this headline"></a></h2>
228 <dl class="option">
229 <dt id="cfg_Servers">
230 <tt class="descname">$cfg['Servers']</tt><a class="headerlink" href="#cfg_Servers" title="Permalink to this definition"></a></dt>
231 <dd><table class="docutils field-list" frame="void" rules="none">
232 <col class="field-name" />
233 <col class="field-body" />
234 <tbody valign="top">
235 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td>
236 </tr>
237 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">one server array with settings listed bellow</td>
238 </tr>
239 </tbody>
240 </table>
241 <p>Since version 1.4.2, phpMyAdmin supports the administration of multiple
242 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
243 added which contains the login information for the different servers. The
244 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
245 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>
246 the hostname of the second server, etc. In
247 <tt class="file docutils literal"><span class="pre">libraries/config.default.php</span></tt>, there is only one section for server
248 definition, however you can put as many as you need in
249 <tt class="file docutils literal"><span class="pre">config.inc.php</span></tt>, copy that block or needed parts (you don&#8217;t have to
250 define all settings, just those you need to change).</p>
251 <div class="admonition note">
252 <p class="first admonition-title">Note</p>
253 <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
254 $cfg[&#8216;Servers&#8217;][1]. Do not use $cfg[&#8216;Servers&#8217;][0]. If you want more
255 than one server, just copy following section (including $i
256 incrementation) serveral times. There is no need to define full server
257 array, just define values you need to change.</p>
258 </div>
259 </dd></dl>
261 <dl class="option">
262 <dt id="cfg_Servers_host">
263 <tt class="descname">$cfg['Servers'][$i]['host']</tt><a class="headerlink" href="#cfg_Servers_host" title="Permalink to this definition"></a></dt>
264 <dd><table class="docutils field-list" frame="void" rules="none">
265 <col class="field-name" />
266 <col class="field-body" />
267 <tbody valign="top">
268 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
269 </tr>
270 <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>
271 </tr>
272 </tbody>
273 </table>
274 <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.
275 <tt class="docutils literal"><span class="pre">localhost</span></tt>.</p>
276 <p>Possible values are:</p>
277 <ul class="simple">
278 <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>
279 <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>
280 <li>dot - <tt class="docutils literal"><span class="pre">'.'</span></tt>, i.e., use named pipes on windows systems</li>
281 <li>empty - <tt class="docutils literal"><span class="pre">''</span></tt>, disables this server</li>
282 </ul>
283 </dd></dl>
285 <dl class="option">
286 <dt id="cfg_Servers_port">
287 <tt class="descname">$cfg['Servers'][$i]['port']</tt><a class="headerlink" href="#cfg_Servers_port" title="Permalink to this definition"></a></dt>
288 <dd><table class="docutils field-list" frame="void" rules="none">
289 <col class="field-name" />
290 <col class="field-body" />
291 <tbody valign="top">
292 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
293 </tr>
294 <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>
295 </tr>
296 </tbody>
297 </table>
298 <p>The port-number of your $i-th MySQL-server. Default is 3306 (leave
299 blank).</p>
300 <div class="admonition note">
301 <p class="first admonition-title">Note</p>
302 <p class="last">If you use <tt class="docutils literal"><span class="pre">localhost</span></tt> as the hostname, MySQL ignores this port number
303 and connects with the socket, so if you want to connect to a port
304 different from the default port, use <tt class="docutils literal"><span class="pre">127.0.0.1</span></tt> or the real hostname
305 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>
306 </div>
307 </dd></dl>
309 <dl class="option">
310 <dt id="cfg_Servers_socket">
311 <tt class="descname">$cfg['Servers'][$i]['socket']</tt><a class="headerlink" href="#cfg_Servers_socket" title="Permalink to this definition"></a></dt>
312 <dd><table class="docutils field-list" frame="void" rules="none">
313 <col class="field-name" />
314 <col class="field-body" />
315 <tbody valign="top">
316 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
317 </tr>
318 <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>
319 </tr>
320 </tbody>
321 </table>
322 <p>The path to the socket to use. Leave blank for default. To determine
323 the correct socket, check your MySQL configuration or, using the
324 <strong class="command">mysql</strong> command–line client, issue the <tt class="docutils literal"><span class="pre">status</span></tt> command. Among the
325 resulting information displayed will be the socket used.</p>
326 </dd></dl>
328 <dl class="option">
329 <dt id="cfg_Servers_ssl">
330 <tt class="descname">$cfg['Servers'][$i]['ssl']</tt><a class="headerlink" href="#cfg_Servers_ssl" title="Permalink to this definition"></a></dt>
331 <dd><table class="docutils field-list" frame="void" rules="none">
332 <col class="field-name" />
333 <col class="field-body" />
334 <tbody valign="top">
335 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
336 </tr>
337 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
338 </tr>
339 </tbody>
340 </table>
341 <p>Whether to enable SSL for connection to MySQL server.</p>
342 </dd></dl>
344 <dl class="option">
345 <dt id="cfg_Servers_connect_type">
346 <tt class="descname">$cfg['Servers'][$i]['connect_type']</tt><a class="headerlink" href="#cfg_Servers_connect_type" title="Permalink to this definition"></a></dt>
347 <dd><table class="docutils field-list" frame="void" rules="none">
348 <col class="field-name" />
349 <col class="field-body" />
350 <tbody valign="top">
351 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
352 </tr>
353 <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>
354 </tr>
355 </tbody>
356 </table>
357 <p>What type connection to use with the MySQL server. Your options are
358 <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
359 to be available on all MySQL servers, while sockets are not supported on
360 some platforms. To use the socket mode, your MySQL server must be on the
361 same machine as the Web server.</p>
362 </dd></dl>
364 <dl class="option">
365 <dt id="cfg_Servers_extension">
366 <tt class="descname">$cfg['Servers'][$i]['extension']</tt><a class="headerlink" href="#cfg_Servers_extension" title="Permalink to this definition"></a></dt>
367 <dd><table class="docutils field-list" frame="void" rules="none">
368 <col class="field-name" />
369 <col class="field-body" />
370 <tbody valign="top">
371 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
372 </tr>
373 <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>
374 </tr>
375 </tbody>
376 </table>
377 <p>What php MySQL extension to use for the connection. Valid options are:</p>
378 <dl class="docutils">
379 <dt><tt class="docutils literal"><span class="pre">mysql</span></tt></dt>
380 <dd>The classic MySQL extension.</dd>
381 <dt><tt class="docutils literal"><span class="pre">mysqli</span></tt></dt>
382 <dd>The improved MySQL extension. This extension became available with PHP
383 5.0.0 and is the recommended way to connect to a server running MySQL
384 4.1.x or newer.</dd>
385 </dl>
386 </dd></dl>
388 <dl class="option">
389 <dt id="cfg_Servers_compress">
390 <tt class="descname">$cfg['Servers'][$i]['compress']</tt><a class="headerlink" href="#cfg_Servers_compress" title="Permalink to this definition"></a></dt>
391 <dd><table class="docutils field-list" frame="void" rules="none">
392 <col class="field-name" />
393 <col class="field-body" />
394 <tbody valign="top">
395 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
396 </tr>
397 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
398 </tr>
399 </tbody>
400 </table>
401 <p>Whether to use a compressed protocol for the MySQL server connection
402 or not (experimental).</p>
403 </dd></dl>
405 <span class="target" id="controlhost"></span><dl class="option">
406 <dt id="cfg_Servers_controlhost">
407 <tt class="descname">$cfg['Servers'][$i]['controlhost']</tt><a class="headerlink" href="#cfg_Servers_controlhost" title="Permalink to this definition"></a></dt>
408 <dd><table class="docutils field-list" frame="void" rules="none">
409 <col class="field-name" />
410 <col class="field-body" />
411 <tbody valign="top">
412 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
413 </tr>
414 <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>
415 </tr>
416 </tbody>
417 </table>
418 <p>Permits to use an alternate host to hold the configuration storage
419 data.</p>
420 </dd></dl>
422 <span class="target" id="controluser"></span><dl class="option">
423 <dt id="cfg_Servers_controluser">
424 <tt class="descname">$cfg['Servers'][$i]['controluser']</tt><a class="headerlink" href="#cfg_Servers_controluser" title="Permalink to this definition"></a></dt>
425 <dd><table class="docutils field-list" frame="void" rules="none">
426 <col class="field-name" />
427 <col class="field-body" />
428 <tbody valign="top">
429 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
430 </tr>
431 <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>
432 </tr>
433 </tbody>
434 </table>
435 </dd></dl>
437 <dl class="option">
438 <dt id="cfg_Servers_controlpass">
439 <tt class="descname">$cfg['Servers'][$i]['controlpass']</tt><a class="headerlink" href="#cfg_Servers_controlpass" title="Permalink to this definition"></a></dt>
440 <dd><table class="docutils field-list" frame="void" rules="none">
441 <col class="field-name" />
442 <col class="field-body" />
443 <tbody valign="top">
444 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
445 </tr>
446 <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>
447 </tr>
448 </tbody>
449 </table>
450 <p>This special account is used for 2 distinct purposes: to make possible all
451 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,
452 for a MySQL server running with <tt class="docutils literal"><span class="pre">--skip-show-database</span></tt>, to enable a
453 multi-user installation (<a class="reference internal" href="glossary.html#term-http"><em class="xref std std-term">HTTP</em></a> or cookie
454 authentication mode).</p>
455 <p>When using <a class="reference internal" href="glossary.html#term-http"><em class="xref std std-term">HTTP</em></a> or
456 cookie authentication modes (or &#8216;config&#8217; authentication mode since phpMyAdmin
457 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>
458 privilege on the <em>mysql.user (all columns except &#8220;Password&#8221;)</em>, <em>mysql.db (all
459 columns)</em> and <em>mysql.tables_priv (all columns except &#8220;Grantor&#8221; and
460 &#8220;Timestamp&#8221;)</em> tables. This account is used to check what databases the user
461 will see at login.</p>
462 <p class="versionchanged">
463 <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>
464 <div class="admonition-see-also admonition seealso">
465 <p class="first admonition-title">See also</p>
466 <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>
467 </div>
468 </dd></dl>
470 <dl class="option">
471 <dt id="cfg_Servers_auth_type">
472 <tt class="descname">$cfg['Servers'][$i]['auth_type']</tt><a class="headerlink" href="#cfg_Servers_auth_type" title="Permalink to this definition"></a></dt>
473 <dd><table class="docutils field-list" frame="void" rules="none">
474 <col class="field-name" />
475 <col class="field-body" />
476 <tbody valign="top">
477 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
478 </tr>
479 <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>
480 </tr>
481 </tbody>
482 </table>
483 <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
484 used for this server.</p>
485 <ul class="simple">
486 <li>&#8216;config&#8217; authentication (<tt class="docutils literal"><span class="pre">$auth_type&nbsp;=&nbsp;'config'</span></tt>) is the plain old
487 way: username and password are stored in <tt class="file docutils literal"><span class="pre">config.inc.php</span></tt>.</li>
488 <li>&#8216;cookie&#8217; authentication mode (<tt class="docutils literal"><span class="pre">$auth_type&nbsp;=&nbsp;'cookie'</span></tt>) as
489 introduced in 2.2.3 allows you to log in as any valid MySQL user with
490 the help of cookies. Username and password are stored in cookies
491 during the session and password is deleted when it ends. This can also
492 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>
493 <li>&#8216;http&#8217; authentication (was
494 called &#8216;advanced&#8217; in previous versions and can be written also as
495 &#8216;http&#8217;) (<tt class="docutils literal"><span class="pre">$auth_type&nbsp;=&nbsp;'http';'</span></tt>) as introduced in 1.3.0 allows you to log in as any
496 valid MySQL user via HTTP-Auth.</li>
497 <li>&#8216;signon&#8217; authentication mode (<tt class="docutils literal"><span class="pre">$auth_type&nbsp;=&nbsp;'signon'</span></tt>) as
498 introduced in 2.10.0 allows you to log in from prepared PHP session
499 data or using supplied PHP script. This is useful for implementing
500 single signon from another application. Sample way how to seed session
501 is in signon example: <tt class="file docutils literal"><span class="pre">examples/signon.php</span></tt>. There is also
502 alternative example using OpenID - <tt class="file docutils literal"><span class="pre">examples/openid.php</span></tt> and example
503 for scripts based solution - <tt class="file docutils literal"><span class="pre">examples/signon-script.php</span></tt>. You need
504 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
505 <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
506 <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
507 method.</li>
508 </ul>
509 <div class="admonition-see-also admonition seealso">
510 <p class="first admonition-title">See also</p>
511 <p class="last"><a class="reference internal" href="setup.html#authentication-modes"><em>Using authentication modes</em></a></p>
512 </div>
513 </dd></dl>
515 <span class="target" id="servers-auth-http-realm"></span><dl class="option">
516 <dt id="cfg_Servers_auth_http_realm">
517 <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>
518 <dd><table class="docutils field-list" frame="void" rules="none">
519 <col class="field-name" />
520 <col class="field-body" />
521 <tbody valign="top">
522 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
523 </tr>
524 <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>
525 </tr>
526 </tbody>
527 </table>
528 <p>When using auth_type = <tt class="docutils literal"><span class="pre">http</span></tt>, this field allows to define a custom
529 <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
530 explicitly specified in your configuration, a string combined of
531 &#8220;phpMyAdmin &#8221; 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
532 <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>
533 </dd></dl>
535 <span class="target" id="servers-auth-swekey-config"></span><dl class="option">
536 <dt id="cfg_Servers_auth_swekey_config">
537 <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>
538 <dd><table class="docutils field-list" frame="void" rules="none">
539 <col class="field-name" />
540 <col class="field-body" />
541 <tbody valign="top">
542 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
543 </tr>
544 <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>
545 </tr>
546 </tbody>
547 </table>
548 <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
549 authentication. Leave empty to deactivate this feature.</p>
550 </dd></dl>
552 <span class="target" id="servers-user"></span><dl class="option">
553 <dt id="cfg_Servers_user">
554 <tt class="descname">$cfg['Servers'][$i]['user']</tt><a class="headerlink" href="#cfg_Servers_user" title="Permalink to this definition"></a></dt>
555 <dd><table class="docutils field-list" frame="void" rules="none">
556 <col class="field-name" />
557 <col class="field-body" />
558 <tbody valign="top">
559 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
560 </tr>
561 <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>
562 </tr>
563 </tbody>
564 </table>
565 </dd></dl>
567 <dl class="option">
568 <dt id="cfg_Servers_password">
569 <tt class="descname">$cfg['Servers'][$i]['password']</tt><a class="headerlink" href="#cfg_Servers_password" title="Permalink to this definition"></a></dt>
570 <dd><table class="docutils field-list" frame="void" rules="none">
571 <col class="field-name" />
572 <col class="field-body" />
573 <tbody valign="top">
574 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
575 </tr>
576 <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>
577 </tr>
578 </tbody>
579 </table>
580 <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
581 &#8216;config&#8217;, this is the user/password-pair which phpMyAdmin will use to
582 connect to the MySQL server. This user/password pair is not needed when
583 <a class="reference internal" href="glossary.html#term-http"><em class="xref std std-term">HTTP</em></a> or cookie authentication is used
584 and should be empty.</p>
585 </dd></dl>
587 <span class="target" id="servers-nopassword"></span><dl class="option">
588 <dt id="cfg_Servers_nopassword">
589 <tt class="descname">$cfg['Servers'][$i]['nopassword']</tt><a class="headerlink" href="#cfg_Servers_nopassword" title="Permalink to this definition"></a></dt>
590 <dd><table class="docutils field-list" frame="void" rules="none">
591 <col class="field-name" />
592 <col class="field-body" />
593 <tbody valign="top">
594 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
595 </tr>
596 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
597 </tr>
598 </tbody>
599 </table>
600 <p>Allow attempt to log in without password when a login with password
601 fails. This can be used together with http authentication, when
602 authentication is done some other way and phpMyAdmin gets user name
603 from auth and uses empty password for connecting to MySQL. Password
604 login is still tried first, but as fallback, no password method is
605 tried.</p>
606 </dd></dl>
608 <span class="target" id="servers-only-db"></span><dl class="option">
609 <dt id="cfg_Servers_only_db">
610 <tt class="descname">$cfg['Servers'][$i]['only_db']</tt><a class="headerlink" href="#cfg_Servers_only_db" title="Permalink to this definition"></a></dt>
611 <dd><table class="docutils field-list" frame="void" rules="none">
612 <col class="field-name" />
613 <col class="field-body" />
614 <tbody valign="top">
615 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string or array</td>
616 </tr>
617 <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>
618 </tr>
619 </tbody>
620 </table>
621 <p>If set to a (an array of) database name(s), only this (these)
622 database(s) will be shown to the user. Since phpMyAdmin 2.2.1,
623 this/these database(s) name(s) may contain MySQL wildcards characters
624 (&#8220;_&#8221; and &#8220;%&#8221;): if you want to use literal instances of these
625 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>
626 <p>This setting is an efficient way to lower the server load since the
627 latter does not need to send MySQL requests to build the available
628 database list. But <strong>it does not replace the privileges rules of the
629 MySQL database server</strong>. If set, it just means only these databases
630 will be displayed but <strong>not that all other databases can&#8217;t be used.</strong></p>
631 <p>An example of using more that one database:</p>
632 <div class="highlight-php"><div class="highlight"><pre><span class="x">$cfg[&#39;Servers&#39;][$i][&#39;only_db&#39;] = array(&#39;db1&#39;, &#39;db2&#39;);</span>
633 </pre></div>
634 </div>
635 <p class="versionchanged">
636 <span class="versionmodified">Changed in version 4.0.0: </span>Previous versions permitted to specify the display order of
637 the database names via this directive.</p>
638 </dd></dl>
640 <dl class="option">
641 <dt id="cfg_Servers_hide_db">
642 <tt class="descname">$cfg['Servers'][$i]['hide_db']</tt><a class="headerlink" href="#cfg_Servers_hide_db" title="Permalink to this definition"></a></dt>
643 <dd><table class="docutils field-list" frame="void" rules="none">
644 <col class="field-name" />
645 <col class="field-body" />
646 <tbody valign="top">
647 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
648 </tr>
649 <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>
650 </tr>
651 </tbody>
652 </table>
653 <p>Regular expression for hiding some databases from unprivileged users.
654 This only hides them from listing, but a user is still able to access
655 them (using, for example, the SQL query area). To limit access, use
656 the MySQL privilege system. For example, to hide all databases
657 starting with the letter &#8220;a&#8221;, use</p>
658 <div class="highlight-php"><div class="highlight"><pre><span class="x">$cfg[&#39;Servers&#39;][$i][&#39;hide_db&#39;] = &#39;^a&#39;;</span>
659 </pre></div>
660 </div>
661 <p>and to hide both &#8220;db1&#8221; and &#8220;db2&#8221; use</p>
662 <div class="highlight-php"><div class="highlight"><pre><span class="x">$cfg[&#39;Servers&#39;][$i][&#39;hide_db&#39;] = &#39;^(db1|db2)$&#39;;</span>
663 </pre></div>
664 </div>
665 <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
666 pattern syntax</a> portion
667 of the PHP reference manual.</p>
668 </dd></dl>
670 <dl class="option">
671 <dt id="cfg_Servers_verbose">
672 <tt class="descname">$cfg['Servers'][$i]['verbose']</tt><a class="headerlink" href="#cfg_Servers_verbose" title="Permalink to this definition"></a></dt>
673 <dd><table class="docutils field-list" frame="void" rules="none">
674 <col class="field-name" />
675 <col class="field-body" />
676 <tbody valign="top">
677 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
678 </tr>
679 <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>
680 </tr>
681 </tbody>
682 </table>
683 <p>Only useful when using phpMyAdmin with multiple server entries. If
684 set, this string will be displayed instead of the hostname in the
685 pull-down menu on the main page. This can be useful if you want to
686 show only certain databases on your system, for example. For HTTP
687 auth, all non-US-ASCII characters will be stripped.</p>
688 </dd></dl>
690 <dl class="option">
691 <dt id="cfg_Servers_pmadb">
692 <tt class="descname">$cfg['Servers'][$i]['pmadb']</tt><a class="headerlink" href="#cfg_Servers_pmadb" title="Permalink to this definition"></a></dt>
693 <dd><table class="docutils field-list" frame="void" rules="none">
694 <col class="field-name" />
695 <col class="field-body" />
696 <tbody valign="top">
697 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
698 </tr>
699 <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>
700 </tr>
701 </tbody>
702 </table>
703 <p>The name of the database containing the phpMyAdmin configuration
704 storage.</p>
705 <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
706 this feature, and for a quick way of creating this database and the needed
707 tables.</p>
708 <p>If you are the only user of this phpMyAdmin installation, you can use your
709 current database to store those special tables; in this case, just put your
710 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
711 multi-user installation, set this parameter to the name of your central
712 database containing the phpMyAdmin configuration storage.</p>
713 </dd></dl>
715 <span class="target" id="bookmark"></span><dl class="option">
716 <dt id="cfg_Servers_bookmarktable">
717 <tt class="descname">$cfg['Servers'][$i]['bookmarktable']</tt><a class="headerlink" href="#cfg_Servers_bookmarktable" title="Permalink to this definition"></a></dt>
718 <dd><table class="docutils field-list" frame="void" rules="none">
719 <col class="field-name" />
720 <col class="field-body" />
721 <tbody valign="top">
722 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
723 </tr>
724 <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>
725 </tr>
726 </tbody>
727 </table>
728 <p>Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This
729 can be useful for queries you often run. To allow the usage of this
730 functionality:</p>
731 <ul class="simple">
732 <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>
733 <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>
734 </ul>
735 </dd></dl>
737 <span class="target" id="relation"></span><dl class="option">
738 <dt id="cfg_Servers_relation">
739 <tt class="descname">$cfg['Servers'][$i]['relation']</tt><a class="headerlink" href="#cfg_Servers_relation" title="Permalink to this definition"></a></dt>
740 <dd><table class="docutils field-list" frame="void" rules="none">
741 <col class="field-name" />
742 <col class="field-body" />
743 <tbody valign="top">
744 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
745 </tr>
746 <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>
747 </tr>
748 </tbody>
749 </table>
750 <p>Since release 2.2.4 you can describe, in a special &#8216;relation&#8217; table,
751 which column is a key in another table (a foreign key). phpMyAdmin
752 currently uses this to</p>
753 <ul class="simple">
754 <li>make clickable, when you browse the master table, the data values that
755 point to the foreign table;</li>
756 <li>display in an optional tool-tip the &#8220;display column&#8221; when browsing the
757 master table, if you move the mouse to a column containing a foreign
758 key (use also the &#8216;table_info&#8217; table); (see <a class="reference internal" href="faq.html#faqdisplay"><em>6.7 How can I use the &#8220;display column&#8221; feature?</em></a>)</li>
759 <li>in edit/insert mode, display a drop-down list of possible foreign keys
760 (key value and &#8220;display column&#8221; 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>
761 <li>display links on the table properties page, to check referential
762 integrity (display missing foreign keys) for each described key;</li>
763 <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>
764 <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
765 your database (also uses the table_coords table).</li>
766 </ul>
767 <p>The keys can be numeric or character.</p>
768 <p>To allow the usage of this functionality:</p>
769 <ul class="simple">
770 <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>
771 <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>
772 <li>now as normal user open phpMyAdmin and for each one of your tables
773 where you want to use this feature, click <em class="guilabel">Structure/Relation view/</em>
774 and choose foreign columns.</li>
775 </ul>
776 <div class="admonition note">
777 <p class="first admonition-title">Note</p>
778 <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>.
779 Those columns have been put in future development of the cross-db
780 relations.</p>
781 </div>
782 </dd></dl>
784 <span class="target" id="table-info"></span><dl class="option">
785 <dt id="cfg_Servers_table_info">
786 <tt class="descname">$cfg['Servers'][$i]['table_info']</tt><a class="headerlink" href="#cfg_Servers_table_info" title="Permalink to this definition"></a></dt>
787 <dd><table class="docutils field-list" frame="void" rules="none">
788 <col class="field-name" />
789 <col class="field-body" />
790 <tbody valign="top">
791 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
792 </tr>
793 <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>
794 </tr>
795 </tbody>
796 </table>
797 <p>Since release 2.3.0 you can describe, in a special &#8216;table_info&#8217;
798 table, which column is to be displayed as a tool-tip when moving the
799 cursor over the corresponding key. This configuration variable will
800 hold the name of this special table. To allow the usage of this
801 functionality:</p>
802 <ul class="simple">
803 <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>
804 <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.
805 <tt class="docutils literal"><span class="pre">pma__table_info</span></tt>)</li>
806 <li>then for each table where you want to use this feature, click
807 &#8220;Structure/Relation view/Choose column to display&#8221; to choose the
808 column.</li>
809 </ul>
810 <div class="admonition-see-also admonition seealso">
811 <p class="first admonition-title">See also</p>
812 <p class="last"><a class="reference internal" href="faq.html#faqdisplay"><em>6.7 How can I use the &#8220;display column&#8221; feature?</em></a></p>
813 </div>
814 </dd></dl>
816 <span class="target" id="table-coords"></span><dl class="option">
817 <dt id="cfg_Servers_table_coords">
818 <tt class="descname">$cfg['Servers'][$i]['table_coords']</tt><a class="headerlink" href="#cfg_Servers_table_coords" title="Permalink to this definition"></a></dt>
819 <dd><table class="docutils field-list" frame="void" rules="none">
820 <col class="field-name" />
821 <col class="field-body" />
822 <tbody valign="top">
823 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
824 </tr>
825 <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>
826 </tr>
827 </tbody>
828 </table>
829 </dd></dl>
831 <dl class="option">
832 <dt id="cfg_Servers_pdf_pages">
833 <tt class="descname">$cfg['Servers'][$i]['pdf_pages']</tt><a class="headerlink" href="#cfg_Servers_pdf_pages" title="Permalink to this definition"></a></dt>
834 <dd><table class="docutils field-list" frame="void" rules="none">
835 <col class="field-name" />
836 <col class="field-body" />
837 <tbody valign="top">
838 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
839 </tr>
840 <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>
841 </tr>
842 </tbody>
843 </table>
844 <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
845 showing the relations between your tables. To do this it needs two tables
846 &#8220;pdf_pages&#8221; (storing information about the available <a class="reference internal" href="glossary.html#term-pdf"><em class="xref std std-term">PDF</em></a> pages)
847 and &#8220;table_coords&#8221; (storing coordinates where each table will be placed on
848 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 &#8220;relation&#8221; feature.</p>
849 <p>To allow the usage of this functionality:</p>
850 <ul class="simple">
851 <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>
852 <li>put the correct table names in
853 <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
854 <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>
855 </ul>
856 <div class="admonition-see-also admonition seealso">
857 <p class="first admonition-title">See also</p>
858 <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>
859 </div>
860 </dd></dl>
862 <span class="target" id="col-com"></span><dl class="option">
863 <dt id="cfg_Servers_column_info">
864 <tt class="descname">$cfg['Servers'][$i]['column_info']</tt><a class="headerlink" href="#cfg_Servers_column_info" title="Permalink to this definition"></a></dt>
865 <dd><table class="docutils field-list" frame="void" rules="none">
866 <col class="field-name" />
867 <col class="field-body" />
868 <tbody valign="top">
869 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
870 </tr>
871 <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>
872 </tr>
873 </tbody>
874 </table>
875 <p>This part requires a content update! Since release 2.3.0 you can
876 store comments to describe each column for each table. These will then
877 be shown on the &#8220;printview&#8221;.</p>
878 <p>Starting with release 2.5.0, comments are consequently used on the table
879 property pages and table browse view, showing up as tool-tips above the
880 column name (properties page) or embedded within the header of table in
881 browse view. They can also be shown in a table dump. Please see the
882 relevant configuration directives later on.</p>
883 <p>Also new in release 2.5.0 is a MIME- transformation system which is also
884 based on the following table structure. See <a class="reference internal" href="transformations.html#transformations"><em>Transformations</em></a> for
885 further information. To use the MIME- transformation system, your
886 column_info table has to have the three new columns &#8216;mimetype&#8217;,
887 &#8216;transformation&#8217;, &#8216;transformation_options&#8217;.</p>
888 <p>To allow the usage of this functionality:</p>
889 <ul>
890 <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>
891 </li>
892 <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.
893 <tt class="docutils literal"><span class="pre">pma__column_info</span></tt>)</p>
894 </li>
895 <li><p class="first">to update your PRE-2.5.0 Column_comments Table use this: and
896 remember that the Variable in <tt class="file docutils literal"><span class="pre">config.inc.php</span></tt> has been renamed from
897 <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
898 <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>
899 <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>
900 <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>
901 <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>
902 <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>
903 </pre></div>
904 </div>
905 </li>
906 </ul>
907 </dd></dl>
909 <span class="target" id="history"></span><dl class="option">
910 <dt id="cfg_Servers_history">
911 <tt class="descname">$cfg['Servers'][$i]['history']</tt><a class="headerlink" href="#cfg_Servers_history" title="Permalink to this definition"></a></dt>
912 <dd><table class="docutils field-list" frame="void" rules="none">
913 <col class="field-name" />
914 <col class="field-body" />
915 <tbody valign="top">
916 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
917 </tr>
918 <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>
919 </tr>
920 </tbody>
921 </table>
922 <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
923 queries you entered manually into the phpMyAdmin interface. If you don&#8217;t
924 want to use a table-based history, you can use the JavaScript-based
925 history.</p>
926 <p>Using that, all your history items are deleted when closing the window.
927 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
928 history items you want to have on hold. On every login, this list gets cut
929 to the maximum amount.</p>
930 <p>The query history is only available if JavaScript is enabled in
931 your browser.</p>
932 <p>To allow the usage of this functionality:</p>
933 <ul class="simple">
934 <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>
935 <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.
936 <tt class="docutils literal"><span class="pre">pma__history</span></tt>)</li>
937 </ul>
938 </dd></dl>
940 <span class="target" id="recent"></span><dl class="option">
941 <dt id="cfg_Servers_recent">
942 <tt class="descname">$cfg['Servers'][$i]['recent']</tt><a class="headerlink" href="#cfg_Servers_recent" title="Permalink to this definition"></a></dt>
943 <dd><table class="docutils field-list" frame="void" rules="none">
944 <col class="field-name" />
945 <col class="field-body" />
946 <tbody valign="top">
947 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
948 </tr>
949 <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>
950 </tr>
951 </tbody>
952 </table>
953 <p>Since release 3.5.0 you can show recently used tables in the
954 navigation panel. It helps you to jump across table directly, without
955 the need to select the database, and then select the table. Using
956 <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
957 of recent tables shown. When you select a table from the list, it will jump to
958 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>
959 <p>Without configuring the storage, you can still access the recently used tables,
960 but it will disappear after you logout.</p>
961 <p>To allow the usage of this functionality persistently:</p>
962 <ul class="simple">
963 <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>
964 <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.
965 <tt class="docutils literal"><span class="pre">pma__recent</span></tt>)</li>
966 </ul>
967 </dd></dl>
969 <span class="target" id="table-uiprefs"></span><dl class="option">
970 <dt id="cfg_Servers_table_uiprefs">
971 <tt class="descname">$cfg['Servers'][$i]['table_uiprefs']</tt><a class="headerlink" href="#cfg_Servers_table_uiprefs" title="Permalink to this definition"></a></dt>
972 <dd><table class="docutils field-list" frame="void" rules="none">
973 <col class="field-name" />
974 <col class="field-body" />
975 <tbody valign="top">
976 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
977 </tr>
978 <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>
979 </tr>
980 </tbody>
981 </table>
982 <p>Since release 3.5.0 phpMyAdmin can be configured to remember several
983 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,
984 and column visibility from a database table) for browsing tables. Without
985 configuring the storage, these features still can be used, but the values will
986 disappear after you logout.</p>
987 <p>To allow the usage of these functionality persistently:</p>
988 <ul class="simple">
989 <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>
990 <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.
991 <tt class="docutils literal"><span class="pre">pma__table_uiprefs</span></tt>)</li>
992 </ul>
993 </dd></dl>
995 <span class="target" id="tracking"></span><dl class="option">
996 <dt id="cfg_Servers_tracking">
997 <tt class="descname">$cfg['Servers'][$i]['tracking']</tt><a class="headerlink" href="#cfg_Servers_tracking" title="Permalink to this definition"></a></dt>
998 <dd><table class="docutils field-list" frame="void" rules="none">
999 <col class="field-name" />
1000 <col class="field-body" />
1001 <tbody valign="top">
1002 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
1003 </tr>
1004 <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>
1005 </tr>
1006 </tbody>
1007 </table>
1008 <p>Since release 3.3.x a tracking mechanism is available. It helps you to
1009 track every <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> command which is
1010 executed by phpMyAdmin. The mechanism supports logging of data
1011 manipulation and data definition statements. After enabling it you can
1012 create versions of tables.</p>
1013 <p>The creation of a version has two effects:</p>
1014 <ul class="simple">
1015 <li>phpMyAdmin saves a snapshot of the table, including structure and
1016 indexes.</li>
1017 <li>phpMyAdmin logs all commands which change the structure and/or data of
1018 the table and links these commands with the version number.</li>
1019 </ul>
1020 <p>Of course you can view the tracked changes. On the <em class="guilabel">Tracking</em>
1021 page a complete report is available for every version. For the report you
1022 can use filters, for example you can get a list of statements within a date
1023 range. When you want to filter usernames you can enter * for all names or
1024 you enter a list of names separated by &#8216;,&#8217;. In addition you can export the
1025 (filtered) report to a file or to a temporary database.</p>
1026 <p>To allow the usage of this functionality:</p>
1027 <ul class="simple">
1028 <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>
1029 <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.
1030 <tt class="docutils literal"><span class="pre">pma__tracking</span></tt>)</li>
1031 </ul>
1032 </dd></dl>
1034 <span class="target" id="tracking2"></span><dl class="option">
1035 <dt id="cfg_Servers_tracking_version_auto_create">
1036 <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>
1037 <dd><table class="docutils field-list" frame="void" rules="none">
1038 <col class="field-name" />
1039 <col class="field-body" />
1040 <tbody valign="top">
1041 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1042 </tr>
1043 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
1044 </tr>
1045 </tbody>
1046 </table>
1047 <p>Whether the tracking mechanism creates versions for tables and views
1048 automatically.</p>
1049 <p>If this is set to true and you create a table or view with</p>
1050 <ul class="simple">
1051 <li>CREATE TABLE ...</li>
1052 <li>CREATE VIEW ...</li>
1053 </ul>
1054 <p>and no version exists for it, the mechanism will create a version for
1055 you automatically.</p>
1056 </dd></dl>
1058 <span class="target" id="tracking3"></span><dl class="option">
1059 <dt id="cfg_Servers_tracking_default_statements">
1060 <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>
1061 <dd><table class="docutils field-list" frame="void" rules="none">
1062 <col class="field-name" />
1063 <col class="field-body" />
1064 <tbody valign="top">
1065 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
1066 </tr>
1067 <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>
1068 </tr>
1069 </tbody>
1070 </table>
1071 <p>Defines the list of statements the auto-creation uses for new
1072 versions.</p>
1073 </dd></dl>
1075 <span class="target" id="tracking4"></span><dl class="option">
1076 <dt id="cfg_Servers_tracking_add_drop_view">
1077 <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>
1078 <dd><table class="docutils field-list" frame="void" rules="none">
1079 <col class="field-name" />
1080 <col class="field-body" />
1081 <tbody valign="top">
1082 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1083 </tr>
1084 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
1085 </tr>
1086 </tbody>
1087 </table>
1088 <p>Whether a DROP VIEW IF EXISTS statement will be added as first line to
1089 the log when creating a view.</p>
1090 </dd></dl>
1092 <span class="target" id="tracking5"></span><dl class="option">
1093 <dt id="cfg_Servers_tracking_add_drop_table">
1094 <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>
1095 <dd><table class="docutils field-list" frame="void" rules="none">
1096 <col class="field-name" />
1097 <col class="field-body" />
1098 <tbody valign="top">
1099 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1100 </tr>
1101 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
1102 </tr>
1103 </tbody>
1104 </table>
1105 <p>Whether a DROP TABLE IF EXISTS statement will be added as first line
1106 to the log when creating a table.</p>
1107 </dd></dl>
1109 <span class="target" id="tracking6"></span><dl class="option">
1110 <dt id="cfg_Servers_tracking_add_drop_database">
1111 <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>
1112 <dd><table class="docutils field-list" frame="void" rules="none">
1113 <col class="field-name" />
1114 <col class="field-body" />
1115 <tbody valign="top">
1116 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1117 </tr>
1118 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
1119 </tr>
1120 </tbody>
1121 </table>
1122 <p>Whether a DROP DATABASE IF EXISTS statement will be added as first
1123 line to the log when creating a database.</p>
1124 </dd></dl>
1126 <span class="target" id="userconfig"></span><dl class="option">
1127 <dt id="cfg_Servers_userconfig">
1128 <tt class="descname">$cfg['Servers'][$i]['userconfig']</tt><a class="headerlink" href="#cfg_Servers_userconfig" title="Permalink to this definition"></a></dt>
1129 <dd><table class="docutils field-list" frame="void" rules="none">
1130 <col class="field-name" />
1131 <col class="field-body" />
1132 <tbody valign="top">
1133 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
1134 </tr>
1135 <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>
1136 </tr>
1137 </tbody>
1138 </table>
1139 <p>Since release 3.4.x phpMyAdmin allows users to set most preferences by
1140 themselves and store them in the database.</p>
1141 <p>If you don&#8217;t allow for storing preferences in
1142 <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
1143 phpMyAdmin, but settings will be saved in browser&#8217;s local storage, or, it
1144 is is unavailable, until the end of session.</p>
1145 <p>To allow the usage of this functionality:</p>
1146 <ul class="simple">
1147 <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>
1148 <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>
1149 </ul>
1150 </dd></dl>
1152 <span class="target" id="designer-coords"></span><dl class="option">
1153 <dt id="cfg_Servers_designer_coords">
1154 <tt class="descname">$cfg['Servers'][$i]['designer_coords']</tt><a class="headerlink" href="#cfg_Servers_designer_coords" title="Permalink to this definition"></a></dt>
1155 <dd><table class="docutils field-list" frame="void" rules="none">
1156 <col class="field-name" />
1157 <col class="field-body" />
1158 <tbody valign="top">
1159 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
1160 </tr>
1161 <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>
1162 </tr>
1163 </tbody>
1164 </table>
1165 <p>Since release 2.10.0 a Designer interface is available; it permits to
1166 visually manage the relations.</p>
1167 <p>To allow the usage of this functionality:</p>
1168 <ul class="simple">
1169 <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>
1170 <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>
1171 (e.g. <tt class="docutils literal"><span class="pre">pma__designer_coords</span></tt>)</li>
1172 </ul>
1173 </dd></dl>
1175 <dl class="option">
1176 <dt id="cfg_Servers_MaxTableUiprefs">
1177 <tt class="descname">$cfg['Servers'][$i]['MaxTableUiprefs']</tt><a class="headerlink" href="#cfg_Servers_MaxTableUiprefs" title="Permalink to this definition"></a></dt>
1178 <dd><table class="docutils field-list" frame="void" rules="none">
1179 <col class="field-name" />
1180 <col class="field-body" />
1181 <tbody valign="top">
1182 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
1183 </tr>
1184 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">100</td>
1185 </tr>
1186 </tbody>
1187 </table>
1188 <p>Maximum number of rows saved in
1189 <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>
1190 <p>When tables are dropped or renamed,
1191 <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
1192 (referring to tables which no longer exist). We only keep this number of newest
1193 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
1194 delete older rows.</p>
1195 </dd></dl>
1197 <dl class="option">
1198 <dt id="cfg_Servers_AllowRoot">
1199 <tt class="descname">$cfg['Servers'][$i]['AllowRoot']</tt><a class="headerlink" href="#cfg_Servers_AllowRoot" title="Permalink to this definition"></a></dt>
1200 <dd><table class="docutils field-list" frame="void" rules="none">
1201 <col class="field-name" />
1202 <col class="field-body" />
1203 <tbody valign="top">
1204 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1205 </tr>
1206 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
1207 </tr>
1208 </tbody>
1209 </table>
1210 <p>Whether to allow root access. This is just a shortcut for the
1211 <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>
1212 </dd></dl>
1214 <dl class="option">
1215 <dt id="cfg_Servers_AllowNoPassword">
1216 <tt class="descname">$cfg['Servers'][$i]['AllowNoPassword']</tt><a class="headerlink" href="#cfg_Servers_AllowNoPassword" title="Permalink to this definition"></a></dt>
1217 <dd><table class="docutils field-list" frame="void" rules="none">
1218 <col class="field-name" />
1219 <col class="field-body" />
1220 <tbody valign="top">
1221 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1222 </tr>
1223 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
1224 </tr>
1225 </tbody>
1226 </table>
1227 <p>Whether to allow logins without a password. The default value of
1228 <tt class="docutils literal"><span class="pre">false</span></tt> for this parameter prevents unintended access to a MySQL
1229 server with was left with an empty password for root or on which an
1230 anonymous (blank) user is defined.</p>
1231 </dd></dl>
1233 <span class="target" id="servers-allowdeny-order"></span><dl class="option">
1234 <dt id="cfg_Servers_AllowDeny_order">
1235 <tt class="descname">$cfg['Servers'][$i]['AllowDeny']['order']</tt><a class="headerlink" href="#cfg_Servers_AllowDeny_order" title="Permalink to this definition"></a></dt>
1236 <dd><table class="docutils field-list" frame="void" rules="none">
1237 <col class="field-name" />
1238 <col class="field-body" />
1239 <tbody valign="top">
1240 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
1241 </tr>
1242 <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>
1243 </tr>
1244 </tbody>
1245 </table>
1246 <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>
1247 authorization is disabled.</p>
1248 <p>If your rule order is set to
1249 <tt class="docutils literal"><span class="pre">'deny,allow'</span></tt> then the system applies all deny rules followed by
1250 allow rules. Access is allowed by default. Any client which does not
1251 match a Deny command or does match an Allow command will be allowed
1252 access to the server.</p>
1253 <p>If your rule order is set to <tt class="docutils literal"><span class="pre">'allow,deny'</span></tt>
1254 then the system applies all allow rules followed by deny rules. Access
1255 is denied by default. Any client which does not match an Allow
1256 directive or does match a Deny directive will be denied access to the
1257 server.</p>
1258 <p>If your rule order is set to <tt class="docutils literal"><span class="pre">'explicit'</span></tt>, authorization is
1259 performed in a similar fashion to rule order &#8216;deny,allow&#8217;, with the
1260 added restriction that your host/username combination <strong>must</strong> be
1261 listed in the <em>allow</em> rules, and not listed in the <em>deny</em> rules. This
1262 is the <strong>most</strong> secure means of using Allow/Deny rules, and was
1263 available in Apache by specifying allow and deny rules without setting
1264 any order.</p>
1265 <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
1266 detecting IP address behind proxies.</p>
1267 </dd></dl>
1269 <span class="target" id="servers-allowdeny-rules"></span><dl class="option">
1270 <dt id="cfg_Servers_AllowDeny_rules">
1271 <tt class="descname">$cfg['Servers'][$i]['AllowDeny']['rules']</tt><a class="headerlink" href="#cfg_Servers_AllowDeny_rules" title="Permalink to this definition"></a></dt>
1272 <dd><table class="docutils field-list" frame="void" rules="none">
1273 <col class="field-name" />
1274 <col class="field-body" />
1275 <tbody valign="top">
1276 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array of strings</td>
1277 </tr>
1278 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array()</td>
1279 </tr>
1280 </tbody>
1281 </table>
1282 <p>The general format for the rules is as such:</p>
1283 <div class="highlight-none"><div class="highlight"><pre>&lt;&#39;allow&#39; | &#39;deny&#39;&gt; &lt;username&gt; [from] &lt;ipmask&gt;
1284 </pre></div>
1285 </div>
1286 <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
1287 wildcard in the <em>username</em> field.</p>
1288 <p>There are a few shortcuts you can
1289 use in the <em>ipmask</em> field as well (please note that those containing
1290 SERVER_ADDRESS might not be available on all webservers):</p>
1291 <div class="highlight-none"><div class="highlight"><pre>&#39;all&#39; -&gt; 0.0.0.0/0
1292 &#39;localhost&#39; -&gt; 127.0.0.1/8
1293 &#39;localnetA&#39; -&gt; SERVER_ADDRESS/8
1294 &#39;localnetB&#39; -&gt; SERVER_ADDRESS/16
1295 &#39;localnetC&#39; -&gt; SERVER_ADDRESS/24
1296 </pre></div>
1297 </div>
1298 <p>Having an empty rule list is equivalent to either using <tt class="docutils literal"><span class="pre">'allow</span> <span class="pre">%</span>
1299 <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>
1300 <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
1301 <tt class="docutils literal"><span class="pre">'explicit'</span></tt>.</p>
1302 <p>For the <a class="reference internal" href="glossary.html#term-ip-address"><em class="xref std std-term">IP address</em></a> matching
1303 system, the following work:</p>
1304 <ul class="simple">
1305 <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>
1306 <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>
1307 <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>
1308 </ul>
1309 <p>But the following does not work:</p>
1310 <ul class="simple">
1311 <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>
1312 </ul>
1313 <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>
1314 <ul class="simple">
1315 <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>
1316 <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>
1317 <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>
1318 </ul>
1319 <p>But the following does not work:</p>
1320 <ul class="simple">
1321 <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>
1322 </ul>
1323 </dd></dl>
1325 <dl class="option">
1326 <dt id="cfg_Servers_DisableIS">
1327 <tt class="descname">$cfg['Servers'][$i]['DisableIS']</tt><a class="headerlink" href="#cfg_Servers_DisableIS" title="Permalink to this definition"></a></dt>
1328 <dd><table class="docutils field-list" frame="void" rules="none">
1329 <col class="field-name" />
1330 <col class="field-body" />
1331 <tbody valign="top">
1332 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1333 </tr>
1334 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
1335 </tr>
1336 </tbody>
1337 </table>
1338 <p>Disable using <tt class="docutils literal"><span class="pre">INFORMATION_SCHEMA</span></tt> to retrieve information (use
1339 <tt class="docutils literal"><span class="pre">SHOW</span></tt> commands instead), because of speed issues when many
1340 databases are present. Currently used in some parts of the code, more
1341 to come.</p>
1342 </dd></dl>
1344 <dl class="option">
1345 <dt id="cfg_Servers_ShowDatabasesCommand">
1346 <tt class="descname">$cfg['Servers'][$i]['ShowDatabasesCommand']</tt><a class="headerlink" href="#cfg_Servers_ShowDatabasesCommand" title="Permalink to this definition"></a></dt>
1347 <dd><table class="docutils field-list" frame="void" rules="none">
1348 <col class="field-name" />
1349 <col class="field-body" />
1350 <tbody valign="top">
1351 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
1352 </tr>
1353 <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>
1354 </tr>
1355 </tbody>
1356 </table>
1357 <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>
1358 command used to fetch the name of available databases will probably be too
1359 slow, so it can be replaced by faster commands. You can use <tt class="docutils literal"><span class="pre">#user#</span></tt>
1360 string will be replaced by current user.</p>
1361 <p>When using <tt class="docutils literal"><span class="pre">false</span></tt>, it will disable fetching databases from the server,
1362 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
1363 displayed.</p>
1364 <p>Examples:</p>
1365 <ul class="simple">
1366 <li><tt class="docutils literal"><span class="pre">'SHOW</span> <span class="pre">DATABASES'</span></tt></li>
1367 <li><tt class="docutils literal"><span class="pre">&quot;SHOW</span> <span class="pre">DATABASES</span> <span class="pre">LIKE</span> <span class="pre">'#user#\_%'&quot;</span></tt></li>
1368 <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>
1369 <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>
1370 <li><tt class="docutils literal"><span class="pre">false</span></tt></li>
1371 </ul>
1372 </dd></dl>
1374 <dl class="option">
1375 <dt id="cfg_Servers_SignonScript">
1376 <tt class="descname">$cfg['Servers'][$i]['SignonScript']</tt><a class="headerlink" href="#cfg_Servers_SignonScript" title="Permalink to this definition"></a></dt>
1377 <dd><table class="docutils field-list" frame="void" rules="none">
1378 <col class="field-name" />
1379 <col class="field-body" />
1380 <tbody valign="top">
1381 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
1382 </tr>
1383 <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>
1384 </tr>
1385 </tbody>
1386 </table>
1387 <p>Name of PHP script to be sourced and executed to obtain login
1388 credentials. This is alternative approach to session based single
1389 signon. The script needs to provide function
1390 <tt class="docutils literal"><span class="pre">get_login_credentials</span></tt> which returns list of username and
1391 password, accepting single parameter of existing username (can be
1392 empty). See <tt class="file docutils literal"><span class="pre">examples/signon-script.php</span></tt> for an example.</p>
1393 </dd></dl>
1395 <dl class="option">
1396 <dt id="cfg_Servers_SignonSession">
1397 <tt class="descname">$cfg['Servers'][$i]['SignonSession']</tt><a class="headerlink" href="#cfg_Servers_SignonSession" title="Permalink to this definition"></a></dt>
1398 <dd><table class="docutils field-list" frame="void" rules="none">
1399 <col class="field-name" />
1400 <col class="field-body" />
1401 <tbody valign="top">
1402 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
1403 </tr>
1404 <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>
1405 </tr>
1406 </tbody>
1407 </table>
1408 <p>Name of session which will be used for signon authentication method.
1409 You should use something different than <tt class="docutils literal"><span class="pre">phpMyAdmin</span></tt>, because this
1410 is session which phpMyAdmin uses internally. Takes effect only if
1411 <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>
1412 </dd></dl>
1414 <dl class="option">
1415 <dt id="cfg_Servers_SignonURL">
1416 <tt class="descname">$cfg['Servers'][$i]['SignonURL']</tt><a class="headerlink" href="#cfg_Servers_SignonURL" title="Permalink to this definition"></a></dt>
1417 <dd><table class="docutils field-list" frame="void" rules="none">
1418 <col class="field-name" />
1419 <col class="field-body" />
1420 <tbody valign="top">
1421 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
1422 </tr>
1423 <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>
1424 </tr>
1425 </tbody>
1426 </table>
1427 <p><a class="reference internal" href="glossary.html#term-url"><em class="xref std std-term">URL</em></a> where user will be redirected
1428 to log in for signon authentication method. Should be absolute
1429 including protocol.</p>
1430 </dd></dl>
1432 <dl class="option">
1433 <dt id="cfg_Servers_LogoutURL">
1434 <tt class="descname">$cfg['Servers'][$i]['LogoutURL']</tt><a class="headerlink" href="#cfg_Servers_LogoutURL" title="Permalink to this definition"></a></dt>
1435 <dd><table class="docutils field-list" frame="void" rules="none">
1436 <col class="field-name" />
1437 <col class="field-body" />
1438 <tbody valign="top">
1439 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
1440 </tr>
1441 <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>
1442 </tr>
1443 </tbody>
1444 </table>
1445 <p><a class="reference internal" href="glossary.html#term-url"><em class="xref std std-term">URL</em></a> where user will be redirected
1446 after logout (doesn&#8217;t affect config authentication method). Should be
1447 absolute including protocol.</p>
1448 </dd></dl>
1450 <dl class="option">
1451 <dt id="cfg_Servers_StatusCacheDatabases">
1452 <tt class="descname">$cfg['Servers'][$i]['StatusCacheDatabases']</tt><a class="headerlink" href="#cfg_Servers_StatusCacheDatabases" title="Permalink to this definition"></a></dt>
1453 <dd><table class="docutils field-list" frame="void" rules="none">
1454 <col class="field-name" />
1455 <col class="field-body" />
1456 <tbody valign="top">
1457 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array of strings</td>
1458 </tr>
1459 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array()</td>
1460 </tr>
1461 </tbody>
1462 </table>
1463 <p>Enables caching of <tt class="docutils literal"><span class="pre">TABLE</span> <span class="pre">STATUS</span></tt> outputs for specific databases on
1464 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
1465 may want to cache it). APC is used (if the PHP extension is available,
1466 if not, this setting is ignored silently). You have to provide
1467 <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>
1468 <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
1469 <tt class="docutils literal"><span class="pre">true</span></tt>.</p>
1470 </dd></dl>
1472 <dl class="option">
1473 <dt id="cfg_Servers_StatusCacheLifetime">
1474 <tt class="descname">$cfg['Servers'][$i]['StatusCacheLifetime']</tt><a class="headerlink" href="#cfg_Servers_StatusCacheLifetime" title="Permalink to this definition"></a></dt>
1475 <dd><table class="docutils field-list" frame="void" rules="none">
1476 <col class="field-name" />
1477 <col class="field-body" />
1478 <tbody valign="top">
1479 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
1480 </tr>
1481 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">0</td>
1482 </tr>
1483 </tbody>
1484 </table>
1485 <p>Lifetime in seconds of the <tt class="docutils literal"><span class="pre">TABLE</span> <span class="pre">STATUS</span></tt> cache if
1486 <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>
1487 </dd></dl>
1489 </div>
1490 <div class="section" id="generic-settings">
1491 <h2>Generic settings<a class="headerlink" href="#generic-settings" title="Permalink to this headline"></a></h2>
1492 <dl class="option">
1493 <dt id="cfg_ServerDefault">
1494 <tt class="descname">$cfg['ServerDefault']</tt><a class="headerlink" href="#cfg_ServerDefault" title="Permalink to this definition"></a></dt>
1495 <dd><table class="docutils field-list" frame="void" rules="none">
1496 <col class="field-name" />
1497 <col class="field-body" />
1498 <tbody valign="top">
1499 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
1500 </tr>
1501 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">1</td>
1502 </tr>
1503 </tbody>
1504 </table>
1505 <p>If you have more than one server configured, you can set
1506 <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
1507 server when phpMyAdmin is started, or set it to 0 to be given a list
1508 of servers without logging in.</p>
1509 <p>If you have only one server configured,
1510 <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>
1511 </dd></dl>
1513 <dl class="option">
1514 <dt id="cfg_VersionCheck">
1515 <tt class="descname">$cfg['VersionCheck']</tt><a class="headerlink" href="#cfg_VersionCheck" title="Permalink to this definition"></a></dt>
1516 <dd><table class="docutils field-list" frame="void" rules="none">
1517 <col class="field-name" />
1518 <col class="field-body" />
1519 <tbody valign="top">
1520 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1521 </tr>
1522 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
1523 </tr>
1524 </tbody>
1525 </table>
1526 <p>Enables check for latest versions using javascript on main phpMyAdmin
1527 page.</p>
1528 <div class="admonition note">
1529 <p class="first admonition-title">Note</p>
1530 <p class="last">This setting can be adjusted by your vendor.</p>
1531 </div>
1532 </dd></dl>
1534 <dl class="option">
1535 <dt id="cfg_MaxDbList">
1536 <tt class="descname">$cfg['MaxDbList']</tt><a class="headerlink" href="#cfg_MaxDbList" title="Permalink to this definition"></a></dt>
1537 <dd><table class="docutils field-list" frame="void" rules="none">
1538 <col class="field-name" />
1539 <col class="field-body" />
1540 <tbody valign="top">
1541 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
1542 </tr>
1543 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">100</td>
1544 </tr>
1545 </tbody>
1546 </table>
1547 <p>The maximum number of database names to be displayed in the main panel&#8217;s
1548 database list.</p>
1549 </dd></dl>
1551 <dl class="option">
1552 <dt id="cfg_MaxNavigationItems">
1553 <tt class="descname">$cfg['MaxNavigationItems']</tt><a class="headerlink" href="#cfg_MaxNavigationItems" title="Permalink to this definition"></a></dt>
1554 <dd><table class="docutils field-list" frame="void" rules="none">
1555 <col class="field-name" />
1556 <col class="field-body" />
1557 <tbody valign="top">
1558 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
1559 </tr>
1560 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">25</td>
1561 </tr>
1562 </tbody>
1563 </table>
1564 <p>The number of items that can be displayed on each page of the
1565 navigation tree.</p>
1566 </dd></dl>
1568 <dl class="option">
1569 <dt id="cfg_MaxTableList">
1570 <tt class="descname">$cfg['MaxTableList']</tt><a class="headerlink" href="#cfg_MaxTableList" title="Permalink to this definition"></a></dt>
1571 <dd><table class="docutils field-list" frame="void" rules="none">
1572 <col class="field-name" />
1573 <col class="field-body" />
1574 <tbody valign="top">
1575 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
1576 </tr>
1577 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">250</td>
1578 </tr>
1579 </tbody>
1580 </table>
1581 <p>The maximum number of table names to be displayed in the main panel&#8217;s
1582 list (except on the Export page). This limit is also enforced in the
1583 navigation panel when in Light mode.</p>
1584 </dd></dl>
1586 <dl class="option">
1587 <dt id="cfg_ShowHint">
1588 <tt class="descname">$cfg['ShowHint']</tt><a class="headerlink" href="#cfg_ShowHint" title="Permalink to this definition"></a></dt>
1589 <dd><table class="docutils field-list" frame="void" rules="none">
1590 <col class="field-name" />
1591 <col class="field-body" />
1592 <tbody valign="top">
1593 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1594 </tr>
1595 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
1596 </tr>
1597 </tbody>
1598 </table>
1599 <p>Whether or not to show hints (for example, hints when hovering over
1600 table headers).</p>
1601 </dd></dl>
1603 <dl class="option">
1604 <dt id="cfg_MaxCharactersInDisplayedSQL">
1605 <tt class="descname">$cfg['MaxCharactersInDisplayedSQL']</tt><a class="headerlink" href="#cfg_MaxCharactersInDisplayedSQL" title="Permalink to this definition"></a></dt>
1606 <dd><table class="docutils field-list" frame="void" rules="none">
1607 <col class="field-name" />
1608 <col class="field-body" />
1609 <tbody valign="top">
1610 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
1611 </tr>
1612 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">1000</td>
1613 </tr>
1614 </tbody>
1615 </table>
1616 <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
1617 default limit of 1000 should be correct to avoid the display of tons of
1618 hexadecimal codes that represent BLOBs, but some users have real
1619 <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
1620 query&#8217;s length exceeds this limit, this query is not saved in the history.</p>
1621 </dd></dl>
1623 <dl class="option">
1624 <dt id="cfg_PersistentConnections">
1625 <tt class="descname">$cfg['PersistentConnections']</tt><a class="headerlink" href="#cfg_PersistentConnections" title="Permalink to this definition"></a></dt>
1626 <dd><table class="docutils field-list" frame="void" rules="none">
1627 <col class="field-name" />
1628 <col class="field-body" />
1629 <tbody valign="top">
1630 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1631 </tr>
1632 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
1633 </tr>
1634 </tbody>
1635 </table>
1636 <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
1637 following extensions:</p>
1638 <ul class="simple">
1639 <li>mysql (<a class="reference external" href="http://php.net/manual/en/function.mysql-pconnect.php">mysql_pconnect</a>),</li>
1640 <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>
1641 </ul>
1642 </dd></dl>
1644 <dl class="option">
1645 <dt id="cfg_ForceSSL">
1646 <tt class="descname">$cfg['ForceSSL']</tt><a class="headerlink" href="#cfg_ForceSSL" title="Permalink to this definition"></a></dt>
1647 <dd><table class="docutils field-list" frame="void" rules="none">
1648 <col class="field-name" />
1649 <col class="field-body" />
1650 <tbody valign="top">
1651 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1652 </tr>
1653 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
1654 </tr>
1655 </tbody>
1656 </table>
1657 <p>Whether to force using https while accessing phpMyAdmin.</p>
1658 </dd></dl>
1660 <dl class="option">
1661 <dt id="cfg_ExecTimeLimit">
1662 <tt class="descname">$cfg['ExecTimeLimit']</tt><a class="headerlink" href="#cfg_ExecTimeLimit" title="Permalink to this definition"></a></dt>
1663 <dd><table class="docutils field-list" frame="void" rules="none">
1664 <col class="field-name" />
1665 <col class="field-body" />
1666 <tbody valign="top">
1667 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer [number of seconds]</td>
1668 </tr>
1669 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">300</td>
1670 </tr>
1671 </tbody>
1672 </table>
1673 <p>Set the number of seconds a script is allowed to run. If seconds is
1674 set to zero, no time limit is imposed. This setting is used while
1675 importing/exporting dump files but has
1676 no effect when PHP is running in safe mode.</p>
1677 </dd></dl>
1679 <dl class="option">
1680 <dt id="cfg_SessionSavePath">
1681 <tt class="descname">$cfg['SessionSavePath']</tt><a class="headerlink" href="#cfg_SessionSavePath" title="Permalink to this definition"></a></dt>
1682 <dd><table class="docutils field-list" frame="void" rules="none">
1683 <col class="field-name" />
1684 <col class="field-body" />
1685 <tbody valign="top">
1686 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
1687 </tr>
1688 <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>
1689 </tr>
1690 </tbody>
1691 </table>
1692 <p>Path for storing session data (<a class="reference external" href="http://php.net/session_save_path">session_save_path PHP parameter</a>).</p>
1693 </dd></dl>
1695 <dl class="option">
1696 <dt id="cfg_MemoryLimit">
1697 <tt class="descname">$cfg['MemoryLimit']</tt><a class="headerlink" href="#cfg_MemoryLimit" title="Permalink to this definition"></a></dt>
1698 <dd><table class="docutils field-list" frame="void" rules="none">
1699 <col class="field-name" />
1700 <col class="field-body" />
1701 <tbody valign="top">
1702 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [number of bytes]</td>
1703 </tr>
1704 <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>
1705 </tr>
1706 </tbody>
1707 </table>
1708 <p>Set the number of bytes a script is allowed to allocate. If set to
1709 zero, no limit is imposed.</p>
1710 <p>This setting is used while importing/exporting dump files and at some other
1711 places in phpMyAdmin so you definitely don&#8217;t want to put here a too low
1712 value. It has no effect when PHP is running in safe mode.</p>
1713 <p>You can also use any string as in <tt class="file docutils literal"><span class="pre">php.ini</span></tt>, eg. &#8216;16M&#8217;. Ensure you
1714 don&#8217;t omit the suffix (16 means 16 bytes!)</p>
1715 </dd></dl>
1717 <dl class="option">
1718 <dt id="cfg_SkipLockedTables">
1719 <tt class="descname">$cfg['SkipLockedTables']</tt><a class="headerlink" href="#cfg_SkipLockedTables" title="Permalink to this definition"></a></dt>
1720 <dd><table class="docutils field-list" frame="void" rules="none">
1721 <col class="field-name" />
1722 <col class="field-body" />
1723 <tbody valign="top">
1724 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1725 </tr>
1726 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
1727 </tr>
1728 </tbody>
1729 </table>
1730 <p>Mark used tables and make it possible to show databases with locked
1731 tables (since MySQL 3.23.30).</p>
1732 </dd></dl>
1734 <dl class="option">
1735 <dt id="cfg_ShowSQL">
1736 <tt class="descname">$cfg['ShowSQL']</tt><a class="headerlink" href="#cfg_ShowSQL" title="Permalink to this definition"></a></dt>
1737 <dd><table class="docutils field-list" frame="void" rules="none">
1738 <col class="field-name" />
1739 <col class="field-body" />
1740 <tbody valign="top">
1741 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1742 </tr>
1743 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
1744 </tr>
1745 </tbody>
1746 </table>
1747 <p>Defines whether <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> queries
1748 generated by phpMyAdmin should be displayed or not.</p>
1749 </dd></dl>
1751 <dl class="option">
1752 <dt id="cfg_RetainQueryBox">
1753 <tt class="descname">$cfg['RetainQueryBox']</tt><a class="headerlink" href="#cfg_RetainQueryBox" title="Permalink to this definition"></a></dt>
1754 <dd><table class="docutils field-list" frame="void" rules="none">
1755 <col class="field-name" />
1756 <col class="field-body" />
1757 <tbody valign="top">
1758 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1759 </tr>
1760 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
1761 </tr>
1762 </tbody>
1763 </table>
1764 <p>Defines whether the <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> query box
1765 should be kept displayed after its submission.</p>
1766 </dd></dl>
1768 <dl class="option">
1769 <dt id="cfg_CodemirrorEnable">
1770 <tt class="descname">$cfg['CodemirrorEnable']</tt><a class="headerlink" href="#cfg_CodemirrorEnable" title="Permalink to this definition"></a></dt>
1771 <dd><table class="docutils field-list" frame="void" rules="none">
1772 <col class="field-name" />
1773 <col class="field-body" />
1774 <tbody valign="top">
1775 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1776 </tr>
1777 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
1778 </tr>
1779 </tbody>
1780 </table>
1781 <p>Defines whether to use a Javascript code editor for SQL query boxes.
1782 CodeMirror provides syntax highlighting and line numbers. However,
1783 middle-clicking for pasting the clipboard contents in some Linux
1784 distributions (such as Ubuntu) is not supported by all browsers.</p>
1785 </dd></dl>
1787 <dl class="option">
1788 <dt id="cfg_AllowUserDropDatabase">
1789 <tt class="descname">$cfg['AllowUserDropDatabase']</tt><a class="headerlink" href="#cfg_AllowUserDropDatabase" title="Permalink to this definition"></a></dt>
1790 <dd><table class="docutils field-list" frame="void" rules="none">
1791 <col class="field-name" />
1792 <col class="field-body" />
1793 <tbody valign="top">
1794 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1795 </tr>
1796 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
1797 </tr>
1798 </tbody>
1799 </table>
1800 <p>Defines whether normal users (non-administrator) are allowed to delete
1801 their own database or not. If set as false, the link <em class="guilabel">Drop
1802 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
1803 be rejected. Quite practical for <a class="reference internal" href="glossary.html#term-isp"><em class="xref std std-term">ISP</em></a> &#8216;s with many customers.</p>
1804 <div class="admonition note">
1805 <p class="first admonition-title">Note</p>
1806 <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
1807 as strict as when using MySQL privileges. This is due to nature of
1808 <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> queries which might be quite
1809 complicated. So this choice should be viewed as help to avoid accidental
1810 dropping rather than strict privilege limitation.</p>
1811 </div>
1812 </dd></dl>
1814 <dl class="option">
1815 <dt id="cfg_Confirm">
1816 <tt class="descname">$cfg['Confirm']</tt><a class="headerlink" href="#cfg_Confirm" title="Permalink to this definition"></a></dt>
1817 <dd><table class="docutils field-list" frame="void" rules="none">
1818 <col class="field-name" />
1819 <col class="field-body" />
1820 <tbody valign="top">
1821 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1822 </tr>
1823 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
1824 </tr>
1825 </tbody>
1826 </table>
1827 <p>Whether a warning (&#8220;Are your really sure...&#8221;) should be displayed when
1828 you&#8217;re about to lose data.</p>
1829 </dd></dl>
1831 <dl class="option">
1832 <dt id="cfg_UseDbSearch">
1833 <tt class="descname">$cfg['UseDbSearch']</tt><a class="headerlink" href="#cfg_UseDbSearch" title="Permalink to this definition"></a></dt>
1834 <dd><table class="docutils field-list" frame="void" rules="none">
1835 <col class="field-name" />
1836 <col class="field-body" />
1837 <tbody valign="top">
1838 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1839 </tr>
1840 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
1841 </tr>
1842 </tbody>
1843 </table>
1844 <p>Define whether the &#8220;search string inside database&#8221; is enabled or not.</p>
1845 </dd></dl>
1847 <dl class="option">
1848 <dt id="cfg_IgnoreMultiSubmitErrors">
1849 <tt class="descname">$cfg['IgnoreMultiSubmitErrors']</tt><a class="headerlink" href="#cfg_IgnoreMultiSubmitErrors" title="Permalink to this definition"></a></dt>
1850 <dd><table class="docutils field-list" frame="void" rules="none">
1851 <col class="field-name" />
1852 <col class="field-body" />
1853 <tbody valign="top">
1854 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1855 </tr>
1856 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
1857 </tr>
1858 </tbody>
1859 </table>
1860 <p>Define whether phpMyAdmin will continue executing a multi-query
1861 statement if one of the queries fails. Default is to abort execution.</p>
1862 </dd></dl>
1864 </div>
1865 <div class="section" id="cookie-authentication-options">
1866 <h2>Cookie authentication options<a class="headerlink" href="#cookie-authentication-options" title="Permalink to this headline"></a></h2>
1867 <dl class="option">
1868 <dt id="cfg_blowfish_secret">
1869 <tt class="descname">$cfg['blowfish_secret']</tt><a class="headerlink" href="#cfg_blowfish_secret" title="Permalink to this definition"></a></dt>
1870 <dd><table class="docutils field-list" frame="void" rules="none">
1871 <col class="field-name" />
1872 <col class="field-body" />
1873 <tbody valign="top">
1874 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
1875 </tr>
1876 <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>
1877 </tr>
1878 </tbody>
1879 </table>
1880 <p>The &#8220;cookie&#8221; auth_type uses blowfish algorithm to encrypt the
1881 password. If you are using the &#8220;cookie&#8221; auth_type, enter here a
1882 random passphrase of your choice. It will be used internally by the
1883 blowfish algorithm: you won’t be prompted for this passphrase. There
1884 is no maximum length for this secret.</p>
1885 <p class="versionchanged">
1886 <span class="versionmodified">Changed in version 3.1.0: </span>Since version 3.1.0 phpMyAdmin can generate this on the fly, but it
1887 makes a bit weaker security as this generated secret is stored in
1888 session and furthermore it makes impossible to recall user name from
1889 cookie.</p>
1890 </dd></dl>
1892 <dl class="option">
1893 <dt id="cfg_LoginCookieRecall">
1894 <tt class="descname">$cfg['LoginCookieRecall']</tt><a class="headerlink" href="#cfg_LoginCookieRecall" title="Permalink to this definition"></a></dt>
1895 <dd><table class="docutils field-list" frame="void" rules="none">
1896 <col class="field-name" />
1897 <col class="field-body" />
1898 <tbody valign="top">
1899 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1900 </tr>
1901 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
1902 </tr>
1903 </tbody>
1904 </table>
1905 <p>Define whether the previous login should be recalled or not in cookie
1906 authentication mode.</p>
1907 <p>This is automatically disabled if you do not have
1908 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>
1909 </dd></dl>
1911 <dl class="option">
1912 <dt id="cfg_LoginCookieValidity">
1913 <tt class="descname">$cfg['LoginCookieValidity']</tt><a class="headerlink" href="#cfg_LoginCookieValidity" title="Permalink to this definition"></a></dt>
1914 <dd><table class="docutils field-list" frame="void" rules="none">
1915 <col class="field-name" />
1916 <col class="field-body" />
1917 <tbody valign="top">
1918 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer [number of seconds]</td>
1919 </tr>
1920 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">1440</td>
1921 </tr>
1922 </tbody>
1923 </table>
1924 <p>Define how long a login cookie is valid. Please note that php
1925 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,
1926 the login cookie is also invalidated. So it is a good idea to set
1927 <tt class="docutils literal"><span class="pre">session.gc_maxlifetime</span></tt> at least to the same value of
1928 <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>
1929 </dd></dl>
1931 <dl class="option">
1932 <dt id="cfg_LoginCookieStore">
1933 <tt class="descname">$cfg['LoginCookieStore']</tt><a class="headerlink" href="#cfg_LoginCookieStore" title="Permalink to this definition"></a></dt>
1934 <dd><table class="docutils field-list" frame="void" rules="none">
1935 <col class="field-name" />
1936 <col class="field-body" />
1937 <tbody valign="top">
1938 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer [number of seconds]</td>
1939 </tr>
1940 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">0</td>
1941 </tr>
1942 </tbody>
1943 </table>
1944 <p>Define how long login cookie should be stored in browser. Default 0
1945 means that it will be kept for existing session. This is recommended
1946 for not trusted environments.</p>
1947 </dd></dl>
1949 <dl class="option">
1950 <dt id="cfg_LoginCookieDeleteAll">
1951 <tt class="descname">$cfg['LoginCookieDeleteAll']</tt><a class="headerlink" href="#cfg_LoginCookieDeleteAll" title="Permalink to this definition"></a></dt>
1952 <dd><table class="docutils field-list" frame="void" rules="none">
1953 <col class="field-name" />
1954 <col class="field-body" />
1955 <tbody valign="top">
1956 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1957 </tr>
1958 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
1959 </tr>
1960 </tbody>
1961 </table>
1962 <p>If enabled (default), logout deletes cookies for all servers,
1963 otherwise only for current one. Setting this to false makes it easy to
1964 forget to log out from other server, when you are using more of them.</p>
1965 </dd></dl>
1967 <span class="target" id="allowarbitraryserver"></span><dl class="option">
1968 <dt id="cfg_AllowArbitraryServer">
1969 <tt class="descname">$cfg['AllowArbitraryServer']</tt><a class="headerlink" href="#cfg_AllowArbitraryServer" title="Permalink to this definition"></a></dt>
1970 <dd><table class="docutils field-list" frame="void" rules="none">
1971 <col class="field-name" />
1972 <col class="field-body" />
1973 <tbody valign="top">
1974 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
1975 </tr>
1976 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
1977 </tr>
1978 </tbody>
1979 </table>
1980 <p>If enabled, allows you to log in to arbitrary servers using cookie
1981 authentication.</p>
1982 <div class="admonition note">
1983 <p class="first admonition-title">Note</p>
1984 <p class="last">Please use this carefully, as this may allow users access to MySQL servers
1985 behind the firewall where your <a class="reference internal" href="glossary.html#term-http"><em class="xref std std-term">HTTP</em></a>
1986 server is placed.</p>
1987 </div>
1988 </dd></dl>
1990 </div>
1991 <div class="section" id="navigation-panel-setup">
1992 <h2>Navigation panel setup<a class="headerlink" href="#navigation-panel-setup" title="Permalink to this headline"></a></h2>
1993 <dl class="option">
1994 <dt id="cfg_NavigationTreeEnableGrouping">
1995 <tt class="descname">$cfg['NavigationTreeEnableGrouping']</tt><a class="headerlink" href="#cfg_NavigationTreeEnableGrouping" title="Permalink to this definition"></a></dt>
1996 <dd><table class="docutils field-list" frame="void" rules="none">
1997 <col class="field-name" />
1998 <col class="field-body" />
1999 <tbody valign="top">
2000 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2001 </tr>
2002 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2003 </tr>
2004 </tbody>
2005 </table>
2006 <p>Defines whether to group the databases based on a common prefix
2007 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>
2008 </dd></dl>
2010 <dl class="option">
2011 <dt id="cfg_NavigationTreeDbSeparator">
2012 <tt class="descname">$cfg['NavigationTreeDbSeparator']</tt><a class="headerlink" href="#cfg_NavigationTreeDbSeparator" title="Permalink to this definition"></a></dt>
2013 <dd><table class="docutils field-list" frame="void" rules="none">
2014 <col class="field-name" />
2015 <col class="field-body" />
2016 <tbody valign="top">
2017 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string or array</td>
2018 </tr>
2019 <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>
2020 </tr>
2021 </tbody>
2022 </table>
2023 <p>The string used to separate the parts of the database name when
2024 showing them in a tree. Alternatively you can specify more strings in
2025 an array and all of them will be used as a separator.</p>
2026 </dd></dl>
2028 <dl class="option">
2029 <dt id="cfg_NavigationTreeTableSeparator">
2030 <tt class="descname">$cfg['NavigationTreeTableSeparator']</tt><a class="headerlink" href="#cfg_NavigationTreeTableSeparator" title="Permalink to this definition"></a></dt>
2031 <dd><table class="docutils field-list" frame="void" rules="none">
2032 <col class="field-name" />
2033 <col class="field-body" />
2034 <tbody valign="top">
2035 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string or array</td>
2036 </tr>
2037 <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>
2038 </tr>
2039 </tbody>
2040 </table>
2041 <p>Defines a string to be used to nest table spaces. This means if you have
2042 tables like <tt class="docutils literal"><span class="pre">first__second__third</span></tt> this will be shown as a three-level
2043 hierarchy like: first &gt; second &gt; third. If set to false or empty, the
2044 feature is disabled. NOTE: You should not use this separator at the
2045 beginning or end of a table name or multiple times after another without
2046 any other characters in between.</p>
2047 </dd></dl>
2049 <dl class="option">
2050 <dt id="cfg_NavigationTreeTableLevel">
2051 <tt class="descname">$cfg['NavigationTreeTableLevel']</tt><a class="headerlink" href="#cfg_NavigationTreeTableLevel" title="Permalink to this definition"></a></dt>
2052 <dd><table class="docutils field-list" frame="void" rules="none">
2053 <col class="field-name" />
2054 <col class="field-body" />
2055 <tbody valign="top">
2056 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
2057 </tr>
2058 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">1</td>
2059 </tr>
2060 </tbody>
2061 </table>
2062 <p>Defines how many sublevels should be displayed when splitting up
2063 tables by the above separator.</p>
2064 </dd></dl>
2066 <dl class="option">
2067 <dt id="cfg_NumRecentTables">
2068 <tt class="descname">$cfg['NumRecentTables']</tt><a class="headerlink" href="#cfg_NumRecentTables" title="Permalink to this definition"></a></dt>
2069 <dd><table class="docutils field-list" frame="void" rules="none">
2070 <col class="field-name" />
2071 <col class="field-body" />
2072 <tbody valign="top">
2073 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
2074 </tr>
2075 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">10</td>
2076 </tr>
2077 </tbody>
2078 </table>
2079 <p>The maximum number of recently used tables shown in the navigation
2080 panel. Set this to 0 (zero) to disable the listing of recent tables.</p>
2081 </dd></dl>
2083 <dl class="option">
2084 <dt id="cfg_ShowTooltip">
2085 <tt class="descname">$cfg['ShowTooltip']</tt><a class="headerlink" href="#cfg_ShowTooltip" title="Permalink to this definition"></a></dt>
2086 <dd><table class="docutils field-list" frame="void" rules="none">
2087 <col class="field-name" />
2088 <col class="field-body" />
2089 <tbody valign="top">
2090 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2091 </tr>
2092 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2093 </tr>
2094 </tbody>
2095 </table>
2096 <p>Defines whether to display item comments as tooltips in navigation
2097 panel or not.</p>
2098 </dd></dl>
2100 <dl class="option">
2101 <dt id="cfg_NavigationDisplayLogo">
2102 <tt class="descname">$cfg['NavigationDisplayLogo']</tt><a class="headerlink" href="#cfg_NavigationDisplayLogo" title="Permalink to this definition"></a></dt>
2103 <dd><table class="docutils field-list" frame="void" rules="none">
2104 <col class="field-name" />
2105 <col class="field-body" />
2106 <tbody valign="top">
2107 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2108 </tr>
2109 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2110 </tr>
2111 </tbody>
2112 </table>
2113 <p>Defines whether or not to display the phpMyAdmin logo at the top of
2114 the navigation panel.</p>
2115 </dd></dl>
2117 <dl class="option">
2118 <dt id="cfg_NavigationLogoLink">
2119 <tt class="descname">$cfg['NavigationLogoLink']</tt><a class="headerlink" href="#cfg_NavigationLogoLink" title="Permalink to this definition"></a></dt>
2120 <dd><table class="docutils field-list" frame="void" rules="none">
2121 <col class="field-name" />
2122 <col class="field-body" />
2123 <tbody valign="top">
2124 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
2125 </tr>
2126 <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>
2127 </tr>
2128 </tbody>
2129 </table>
2130 <p>Enter <a class="reference internal" href="glossary.html#term-url"><em class="xref std std-term">URL</em></a> where logo in the
2131 navigation panel will point to. For use especially with self made
2132 theme which changes this.</p>
2133 </dd></dl>
2135 <dl class="option">
2136 <dt id="cfg_NavigationLogoLinkWindow">
2137 <tt class="descname">$cfg['NavigationLogoLinkWindow']</tt><a class="headerlink" href="#cfg_NavigationLogoLinkWindow" title="Permalink to this definition"></a></dt>
2138 <dd><table class="docutils field-list" frame="void" rules="none">
2139 <col class="field-name" />
2140 <col class="field-body" />
2141 <tbody valign="top">
2142 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
2143 </tr>
2144 <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>
2145 </tr>
2146 </tbody>
2147 </table>
2148 <p>Whether to open the linked page in the main window (<tt class="docutils literal"><span class="pre">main</span></tt>) or in a
2149 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
2150 <tt class="docutils literal"><span class="pre">phpmyadmin.net</span></tt>.</p>
2151 </dd></dl>
2153 <dl class="option">
2154 <dt id="cfg_NavigationTreeDisplayItemFilterMinimum">
2155 <tt class="descname">$cfg['NavigationTreeDisplayItemFilterMinimum']</tt><a class="headerlink" href="#cfg_NavigationTreeDisplayItemFilterMinimum" title="Permalink to this definition"></a></dt>
2156 <dd><table class="docutils field-list" frame="void" rules="none">
2157 <col class="field-name" />
2158 <col class="field-body" />
2159 <tbody valign="top">
2160 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
2161 </tr>
2162 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">30</td>
2163 </tr>
2164 </tbody>
2165 </table>
2166 <p>Defines the minimum number of items (tables, views, routines and
2167 events) to display a JavaScript filter box above the list of items in
2168 the navigation tree.</p>
2169 <p>To disable the filter completely some high number can be used (e.g. 9999)</p>
2170 </dd></dl>
2172 <dl class="option">
2173 <dt id="cfg_NavigationTreeDisplayDbFilterMinimum">
2174 <tt class="descname">$cfg['NavigationTreeDisplayDbFilterMinimum']</tt><a class="headerlink" href="#cfg_NavigationTreeDisplayDbFilterMinimum" title="Permalink to this definition"></a></dt>
2175 <dd><table class="docutils field-list" frame="void" rules="none">
2176 <col class="field-name" />
2177 <col class="field-body" />
2178 <tbody valign="top">
2179 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
2180 </tr>
2181 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">30</td>
2182 </tr>
2183 </tbody>
2184 </table>
2185 <p>Defines the minimum number of databases to display a JavaScript filter
2186 box above the list of databases in the navigation tree.</p>
2187 <p>To disable the filter completely some high number can be used
2188 (e.g. 9999)</p>
2189 </dd></dl>
2191 <dl class="option">
2192 <dt id="cfg_NavigationDisplayServers">
2193 <tt class="descname">$cfg['NavigationDisplayServers']</tt><a class="headerlink" href="#cfg_NavigationDisplayServers" title="Permalink to this definition"></a></dt>
2194 <dd><table class="docutils field-list" frame="void" rules="none">
2195 <col class="field-name" />
2196 <col class="field-body" />
2197 <tbody valign="top">
2198 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2199 </tr>
2200 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2201 </tr>
2202 </tbody>
2203 </table>
2204 <p>Defines whether or not to display a server choice at the top of the
2205 navigation panel.</p>
2206 </dd></dl>
2208 <dl class="option">
2209 <dt id="cfg_DisplayServersList">
2210 <tt class="descname">$cfg['DisplayServersList']</tt><a class="headerlink" href="#cfg_DisplayServersList" title="Permalink to this definition"></a></dt>
2211 <dd><table class="docutils field-list" frame="void" rules="none">
2212 <col class="field-name" />
2213 <col class="field-body" />
2214 <tbody valign="top">
2215 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2216 </tr>
2217 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
2218 </tr>
2219 </tbody>
2220 </table>
2221 <p>Defines whether to display this server choice as links instead of in a
2222 drop-down.</p>
2223 </dd></dl>
2225 <dl class="option">
2226 <dt id="cfg_NavigationTreeDefaultTabTable">
2227 <tt class="descname">$cfg['NavigationTreeDefaultTabTable']</tt><a class="headerlink" href="#cfg_NavigationTreeDefaultTabTable" title="Permalink to this definition"></a></dt>
2228 <dd><table class="docutils field-list" frame="void" rules="none">
2229 <col class="field-name" />
2230 <col class="field-body" />
2231 <tbody valign="top">
2232 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
2233 </tr>
2234 <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>
2235 </tr>
2236 </tbody>
2237 </table>
2238 <p>Defines the tab displayed by default when clicking the small icon next
2239 to each table name in the navigation panel. Possible values:</p>
2240 <ul class="simple">
2241 <li><tt class="docutils literal"><span class="pre">tbl_structure.php</span></tt></li>
2242 <li><tt class="docutils literal"><span class="pre">tbl_sql.php</span></tt></li>
2243 <li><tt class="docutils literal"><span class="pre">tbl_select.php</span></tt></li>
2244 <li><tt class="docutils literal"><span class="pre">tbl_change.php</span></tt></li>
2245 <li><tt class="docutils literal"><span class="pre">sql.php</span></tt></li>
2246 </ul>
2247 </dd></dl>
2249 </div>
2250 <div class="section" id="main-panel">
2251 <h2>Main panel<a class="headerlink" href="#main-panel" title="Permalink to this headline"></a></h2>
2252 <dl class="option">
2253 <dt id="cfg_ShowStats">
2254 <tt class="descname">$cfg['ShowStats']</tt><a class="headerlink" href="#cfg_ShowStats" title="Permalink to this definition"></a></dt>
2255 <dd><table class="docutils field-list" frame="void" rules="none">
2256 <col class="field-name" />
2257 <col class="field-body" />
2258 <tbody valign="top">
2259 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2260 </tr>
2261 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2262 </tr>
2263 </tbody>
2264 </table>
2265 <p>Defines whether or not to display space usage and statistics about
2266 databases and tables. Note that statistics requires at least MySQL
2267 3.23.3 and that, at this date, MySQL doesn&#8217;t return such information
2268 for Berkeley DB tables.</p>
2269 </dd></dl>
2271 <dl class="option">
2272 <dt id="cfg_ShowServerInfo">
2273 <tt class="descname">$cfg['ShowServerInfo']</tt><a class="headerlink" href="#cfg_ShowServerInfo" title="Permalink to this definition"></a></dt>
2274 <dd><table class="docutils field-list" frame="void" rules="none">
2275 <col class="field-name" />
2276 <col class="field-body" />
2277 <tbody valign="top">
2278 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2279 </tr>
2280 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2281 </tr>
2282 </tbody>
2283 </table>
2284 <p>Defines whether to display detailed server information on main page.
2285 You can additionally hide more information by using
2286 <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>
2287 </dd></dl>
2289 <dl class="option">
2290 <dt id="cfg_ShowPhpInfo">
2291 <tt class="descname">$cfg['ShowPhpInfo']</tt><a class="headerlink" href="#cfg_ShowPhpInfo" title="Permalink to this definition"></a></dt>
2292 <dd><table class="docutils field-list" frame="void" rules="none">
2293 <col class="field-name" />
2294 <col class="field-body" />
2295 <tbody valign="top">
2296 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2297 </tr>
2298 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
2299 </tr>
2300 </tbody>
2301 </table>
2302 </dd></dl>
2304 <dl class="option">
2305 <dt id="cfg_ShowChgPassword">
2306 <tt class="descname">$cfg['ShowChgPassword']</tt><a class="headerlink" href="#cfg_ShowChgPassword" title="Permalink to this definition"></a></dt>
2307 <dd><table class="docutils field-list" frame="void" rules="none">
2308 <col class="field-name" />
2309 <col class="field-body" />
2310 <tbody valign="top">
2311 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2312 </tr>
2313 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2314 </tr>
2315 </tbody>
2316 </table>
2317 </dd></dl>
2319 <dl class="option">
2320 <dt id="cfg_ShowCreateDb">
2321 <tt class="descname">$cfg['ShowCreateDb']</tt><a class="headerlink" href="#cfg_ShowCreateDb" title="Permalink to this definition"></a></dt>
2322 <dd><table class="docutils field-list" frame="void" rules="none">
2323 <col class="field-name" />
2324 <col class="field-body" />
2325 <tbody valign="top">
2326 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2327 </tr>
2328 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2329 </tr>
2330 </tbody>
2331 </table>
2332 <p>Defines whether to display the <em class="guilabel">PHP information</em> and
2333 <em class="guilabel">Change password</em> links and form for creating database or not at
2334 the starting main (right) frame. This setting does not check MySQL commands
2335 entered directly.</p>
2336 <p>Please note that to block the usage of <tt class="docutils literal"><span class="pre">phpinfo()</span></tt> in scripts, you have to
2337 put this in your <tt class="file docutils literal"><span class="pre">php.ini</span></tt>:</p>
2338 <div class="highlight-ini"><div class="highlight"><pre><span class="na">disable_functions</span> <span class="o">=</span> <span class="s">phpinfo()</span>
2339 </pre></div>
2340 </div>
2341 <p>Also note that enabling the <em class="guilabel">Change password</em> link has no effect
2342 with config authentication mode: because of the hard coded password value
2343 in the configuration file, end users can&#8217;t be allowed to change their
2344 passwords.</p>
2345 </dd></dl>
2347 </div>
2348 <div class="section" id="database-structure">
2349 <h2>Database structure<a class="headerlink" href="#database-structure" title="Permalink to this headline"></a></h2>
2350 <dl class="option">
2351 <dt id="cfg_ShowDbStructureCreation">
2352 <tt class="descname">$cfg['ShowDbStructureCreation']</tt><a class="headerlink" href="#cfg_ShowDbStructureCreation" title="Permalink to this definition"></a></dt>
2353 <dd><table class="docutils field-list" frame="void" rules="none">
2354 <col class="field-name" />
2355 <col class="field-body" />
2356 <tbody valign="top">
2357 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2358 </tr>
2359 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
2360 </tr>
2361 </tbody>
2362 </table>
2363 <p>Defines whether the database structure page (tables list) has a
2364 &#8220;Creation&#8221; column that displays when each table was created.</p>
2365 </dd></dl>
2367 <dl class="option">
2368 <dt id="cfg_ShowDbStructureLastUpdate">
2369 <tt class="descname">$cfg['ShowDbStructureLastUpdate']</tt><a class="headerlink" href="#cfg_ShowDbStructureLastUpdate" title="Permalink to this definition"></a></dt>
2370 <dd><table class="docutils field-list" frame="void" rules="none">
2371 <col class="field-name" />
2372 <col class="field-body" />
2373 <tbody valign="top">
2374 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2375 </tr>
2376 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
2377 </tr>
2378 </tbody>
2379 </table>
2380 <p>Defines whether the database structure page (tables list) has a &#8220;Last
2381 update&#8221; column that displays when each table was last updated.</p>
2382 </dd></dl>
2384 <dl class="option">
2385 <dt id="cfg_ShowDbStructureLastCheck">
2386 <tt class="descname">$cfg['ShowDbStructureLastCheck']</tt><a class="headerlink" href="#cfg_ShowDbStructureLastCheck" title="Permalink to this definition"></a></dt>
2387 <dd><table class="docutils field-list" frame="void" rules="none">
2388 <col class="field-name" />
2389 <col class="field-body" />
2390 <tbody valign="top">
2391 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2392 </tr>
2393 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
2394 </tr>
2395 </tbody>
2396 </table>
2397 <p>Defines whether the database structure page (tables list) has a &#8220;Last
2398 check&#8221; column that displays when each table was last checked.</p>
2399 </dd></dl>
2401 <dl class="option">
2402 <dt id="cfg_HideStructureActions">
2403 <tt class="descname">$cfg['HideStructureActions']</tt><a class="headerlink" href="#cfg_HideStructureActions" title="Permalink to this definition"></a></dt>
2404 <dd><table class="docutils field-list" frame="void" rules="none">
2405 <col class="field-name" />
2406 <col class="field-body" />
2407 <tbody valign="top">
2408 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2409 </tr>
2410 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2411 </tr>
2412 </tbody>
2413 </table>
2414 <p>Defines whether the table structure actions are hidden under a &#8220;More&#8221;
2415 drop-down.</p>
2416 </dd></dl>
2418 </div>
2419 <div class="section" id="browse-mode">
2420 <h2>Browse mode<a class="headerlink" href="#browse-mode" title="Permalink to this headline"></a></h2>
2421 <dl class="option">
2422 <dt id="cfg_NavigationBarIconic">
2423 <tt class="descname">$cfg['NavigationBarIconic']</tt><a class="headerlink" href="#cfg_NavigationBarIconic" title="Permalink to this definition"></a></dt>
2424 <dd><table class="docutils field-list" frame="void" rules="none">
2425 <col class="field-name" />
2426 <col class="field-body" />
2427 <tbody valign="top">
2428 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
2429 </tr>
2430 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2431 </tr>
2432 </tbody>
2433 </table>
2434 <p>Defines whether navigation bar buttons contain text or symbols only. A
2435 value of true displays icons, false displays text and &#8216;both&#8217; displays
2436 both icons and text.</p>
2437 </dd></dl>
2439 <dl class="option">
2440 <dt id="cfg_ShowAll">
2441 <tt class="descname">$cfg['ShowAll']</tt><a class="headerlink" href="#cfg_ShowAll" title="Permalink to this definition"></a></dt>
2442 <dd><table class="docutils field-list" frame="void" rules="none">
2443 <col class="field-name" />
2444 <col class="field-body" />
2445 <tbody valign="top">
2446 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2447 </tr>
2448 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
2449 </tr>
2450 </tbody>
2451 </table>
2452 <p>Defines whether a user should be displayed a &#8220;Show all&#8221; button in
2453 browse mode or not in all cases. By default it is shown only on small
2454 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
2455 performance issues while getting too many rows.</p>
2456 </dd></dl>
2458 <dl class="option">
2459 <dt id="cfg_MaxRows">
2460 <tt class="descname">$cfg['MaxRows']</tt><a class="headerlink" href="#cfg_MaxRows" title="Permalink to this definition"></a></dt>
2461 <dd><table class="docutils field-list" frame="void" rules="none">
2462 <col class="field-name" />
2463 <col class="field-body" />
2464 <tbody valign="top">
2465 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
2466 </tr>
2467 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">30</td>
2468 </tr>
2469 </tbody>
2470 </table>
2471 <p>Number of rows displayed when browsing a result set and no LIMIT
2472 clause is used. If the result set contains more rows, &#8220;Previous&#8221; and
2473 &#8220;Next&#8221; links will be shown.</p>
2474 </dd></dl>
2476 <dl class="option">
2477 <dt id="cfg_Order">
2478 <tt class="descname">$cfg['Order']</tt><a class="headerlink" href="#cfg_Order" title="Permalink to this definition"></a></dt>
2479 <dd><table class="docutils field-list" frame="void" rules="none">
2480 <col class="field-name" />
2481 <col class="field-body" />
2482 <tbody valign="top">
2483 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
2484 </tr>
2485 <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>
2486 </tr>
2487 </tbody>
2488 </table>
2489 <p>Defines whether columns are displayed in ascending (<tt class="docutils literal"><span class="pre">ASC</span></tt>) order, in
2490 descending (<tt class="docutils literal"><span class="pre">DESC</span></tt>) order or in a &#8220;smart&#8221; (<tt class="docutils literal"><span class="pre">SMART</span></tt>) order - I.E.
2491 descending order for columns of type TIME, DATE, DATETIME and
2492 TIMESTAMP, ascending order else- by default.</p>
2493 </dd></dl>
2495 <dl class="option">
2496 <dt id="cfg_DisplayBinaryAsHex">
2497 <tt class="descname">$cfg['DisplayBinaryAsHex']</tt><a class="headerlink" href="#cfg_DisplayBinaryAsHex" title="Permalink to this definition"></a></dt>
2498 <dd><table class="docutils field-list" frame="void" rules="none">
2499 <col class="field-name" />
2500 <col class="field-body" />
2501 <tbody valign="top">
2502 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2503 </tr>
2504 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2505 </tr>
2506 </tbody>
2507 </table>
2508 <p>Defines whether the &#8220;Show binary contents as HEX&#8221; browse option is
2509 ticked by default.</p>
2510 </dd></dl>
2512 <dl class="option">
2513 <dt id="cfg_GridEditing">
2514 <tt class="descname">$cfg['GridEditing']</tt><a class="headerlink" href="#cfg_GridEditing" title="Permalink to this definition"></a></dt>
2515 <dd><table class="docutils field-list" frame="void" rules="none">
2516 <col class="field-name" />
2517 <col class="field-body" />
2518 <tbody valign="top">
2519 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
2520 </tr>
2521 <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>
2522 </tr>
2523 </tbody>
2524 </table>
2525 <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
2526 editing. Can be deactived with the <tt class="docutils literal"><span class="pre">disabled</span></tt> value.</p>
2527 </dd></dl>
2529 <dl class="option">
2530 <dt id="cfg_SaveCellsAtOnce">
2531 <tt class="descname">$cfg['SaveCellsAtOnce']</tt><a class="headerlink" href="#cfg_SaveCellsAtOnce" title="Permalink to this definition"></a></dt>
2532 <dd><table class="docutils field-list" frame="void" rules="none">
2533 <col class="field-name" />
2534 <col class="field-body" />
2535 <tbody valign="top">
2536 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2537 </tr>
2538 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
2539 </tr>
2540 </tbody>
2541 </table>
2542 <p>Defines whether or not to save all edited cells at once for grid
2543 editing.</p>
2544 </dd></dl>
2546 </div>
2547 <div class="section" id="editing-mode">
2548 <h2>Editing mode<a class="headerlink" href="#editing-mode" title="Permalink to this headline"></a></h2>
2549 <dl class="option">
2550 <dt id="cfg_ProtectBinary">
2551 <tt class="descname">$cfg['ProtectBinary']</tt><a class="headerlink" href="#cfg_ProtectBinary" title="Permalink to this definition"></a></dt>
2552 <dd><table class="docutils field-list" frame="void" rules="none">
2553 <col class="field-name" />
2554 <col class="field-body" />
2555 <tbody valign="top">
2556 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean or string</td>
2557 </tr>
2558 <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>
2559 </tr>
2560 </tbody>
2561 </table>
2562 <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
2563 editing when browsing a table&#8217;s content. Valid values are:</p>
2564 <ul class="simple">
2565 <li><tt class="docutils literal"><span class="pre">false</span></tt> to allow editing of all columns;</li>
2566 <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>
2567 <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
2568 opposite of <tt class="docutils literal"><span class="pre">'blob'</span></tt>);</li>
2569 <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>
2570 </ul>
2571 </dd></dl>
2573 <dl class="option">
2574 <dt id="cfg_ShowFunctionFields">
2575 <tt class="descname">$cfg['ShowFunctionFields']</tt><a class="headerlink" href="#cfg_ShowFunctionFields" title="Permalink to this definition"></a></dt>
2576 <dd><table class="docutils field-list" frame="void" rules="none">
2577 <col class="field-name" />
2578 <col class="field-body" />
2579 <tbody valign="top">
2580 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2581 </tr>
2582 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2583 </tr>
2584 </tbody>
2585 </table>
2586 <p>Defines whether or not MySQL functions fields should be initially
2587 displayed in edit/insert mode. Since version 2.10, the user can toggle
2588 this setting from the interface.</p>
2589 </dd></dl>
2591 <dl class="option">
2592 <dt id="cfg_ShowFieldTypesInDataEditView">
2593 <tt class="descname">$cfg['ShowFieldTypesInDataEditView']</tt><a class="headerlink" href="#cfg_ShowFieldTypesInDataEditView" title="Permalink to this definition"></a></dt>
2594 <dd><table class="docutils field-list" frame="void" rules="none">
2595 <col class="field-name" />
2596 <col class="field-body" />
2597 <tbody valign="top">
2598 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2599 </tr>
2600 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2601 </tr>
2602 </tbody>
2603 </table>
2604 <p>Defines whether or not type fields should be initially displayed in
2605 edit/insert mode. The user can toggle this setting from the interface.</p>
2606 </dd></dl>
2608 <dl class="option">
2609 <dt id="cfg_InsertRows">
2610 <tt class="descname">$cfg['InsertRows']</tt><a class="headerlink" href="#cfg_InsertRows" title="Permalink to this definition"></a></dt>
2611 <dd><table class="docutils field-list" frame="void" rules="none">
2612 <col class="field-name" />
2613 <col class="field-body" />
2614 <tbody valign="top">
2615 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
2616 </tr>
2617 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">2</td>
2618 </tr>
2619 </tbody>
2620 </table>
2621 <p>Defines the maximum number of concurrent entries for the Insert page.</p>
2622 </dd></dl>
2624 <dl class="option">
2625 <dt id="cfg_ForeignKeyMaxLimit">
2626 <tt class="descname">$cfg['ForeignKeyMaxLimit']</tt><a class="headerlink" href="#cfg_ForeignKeyMaxLimit" title="Permalink to this definition"></a></dt>
2627 <dd><table class="docutils field-list" frame="void" rules="none">
2628 <col class="field-name" />
2629 <col class="field-body" />
2630 <tbody valign="top">
2631 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
2632 </tr>
2633 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">100</td>
2634 </tr>
2635 </tbody>
2636 </table>
2637 <p>If there are fewer items than this in the set of foreign keys, then a
2638 drop-down box of foreign keys is presented, in the style described by
2639 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>
2640 </dd></dl>
2642 <dl class="option">
2643 <dt id="cfg_ForeignKeyDropdownOrder">
2644 <tt class="descname">$cfg['ForeignKeyDropdownOrder']</tt><a class="headerlink" href="#cfg_ForeignKeyDropdownOrder" title="Permalink to this definition"></a></dt>
2645 <dd><table class="docutils field-list" frame="void" rules="none">
2646 <col class="field-name" />
2647 <col class="field-body" />
2648 <tbody valign="top">
2649 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td>
2650 </tr>
2651 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array(&#8216;content-id&#8217;, &#8216;id-content&#8217;)</td>
2652 </tr>
2653 </tbody>
2654 </table>
2655 <p>For the foreign key drop-down fields, there are several methods of
2656 display, offering both the key and value data. The contents of the
2657 array should be one or both of the following strings: <tt class="docutils literal"><span class="pre">content-id</span></tt>,
2658 <tt class="docutils literal"><span class="pre">id-content</span></tt>.</p>
2659 </dd></dl>
2661 </div>
2662 <div class="section" id="export-and-import-settings">
2663 <h2>Export and import settings<a class="headerlink" href="#export-and-import-settings" title="Permalink to this headline"></a></h2>
2664 <dl class="option">
2665 <dt id="cfg_ZipDump">
2666 <tt class="descname">$cfg['ZipDump']</tt><a class="headerlink" href="#cfg_ZipDump" title="Permalink to this definition"></a></dt>
2667 <dd><table class="docutils field-list" frame="void" rules="none">
2668 <col class="field-name" />
2669 <col class="field-body" />
2670 <tbody valign="top">
2671 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2672 </tr>
2673 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2674 </tr>
2675 </tbody>
2676 </table>
2677 </dd></dl>
2679 <dl class="option">
2680 <dt id="cfg_GZipDump">
2681 <tt class="descname">$cfg['GZipDump']</tt><a class="headerlink" href="#cfg_GZipDump" title="Permalink to this definition"></a></dt>
2682 <dd><table class="docutils field-list" frame="void" rules="none">
2683 <col class="field-name" />
2684 <col class="field-body" />
2685 <tbody valign="top">
2686 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2687 </tr>
2688 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2689 </tr>
2690 </tbody>
2691 </table>
2692 </dd></dl>
2694 <dl class="option">
2695 <dt id="cfg_BZipDump">
2696 <tt class="descname">$cfg['BZipDump']</tt><a class="headerlink" href="#cfg_BZipDump" title="Permalink to this definition"></a></dt>
2697 <dd><table class="docutils field-list" frame="void" rules="none">
2698 <col class="field-name" />
2699 <col class="field-body" />
2700 <tbody valign="top">
2701 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2702 </tr>
2703 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2704 </tr>
2705 </tbody>
2706 </table>
2707 <p>Defines whether to allow the use of zip/GZip/BZip2 compression when
2708 creating a dump file</p>
2709 </dd></dl>
2711 <dl class="option">
2712 <dt id="cfg_CompressOnFly">
2713 <tt class="descname">$cfg['CompressOnFly']</tt><a class="headerlink" href="#cfg_CompressOnFly" title="Permalink to this definition"></a></dt>
2714 <dd><table class="docutils field-list" frame="void" rules="none">
2715 <col class="field-name" />
2716 <col class="field-body" />
2717 <tbody valign="top">
2718 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
2719 </tr>
2720 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
2721 </tr>
2722 </tbody>
2723 </table>
2724 <p>Defines whether to allow on the fly compression for GZip/BZip2
2725 compressed exports. This doesn&#8217;t affect smaller dumps and allows users
2726 to create larger dumps that won&#8217;t otherwise fit in memory due to php
2727 memory limit. Produced files contain more GZip/BZip2 headers, but all
2728 normal programs handle this correctly.</p>
2729 </dd></dl>
2731 <dl class="option">
2732 <dt id="cfg_Export">
2733 <tt class="descname">$cfg['Export']</tt><a class="headerlink" href="#cfg_Export" title="Permalink to this definition"></a></dt>
2734 <dd><table class="docutils field-list" frame="void" rules="none">
2735 <col class="field-name" />
2736 <col class="field-body" />
2737 <tbody valign="top">
2738 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td>
2739 </tr>
2740 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array(...)</td>
2741 </tr>
2742 </tbody>
2743 </table>
2744 <p>In this array are defined default parameters for export, names of
2745 items are similar to texts seen on export page, so you can easily
2746 identify what they mean.</p>
2747 </dd></dl>
2749 <dl class="option">
2750 <dt id="cfg_Export_method">
2751 <tt class="descname">$cfg['Export']['method']</tt><a class="headerlink" href="#cfg_Export_method" title="Permalink to this definition"></a></dt>
2752 <dd><table class="docutils field-list" frame="void" rules="none">
2753 <col class="field-name" />
2754 <col class="field-body" />
2755 <tbody valign="top">
2756 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
2757 </tr>
2758 <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>
2759 </tr>
2760 </tbody>
2761 </table>
2762 <p>Defines how the export form is displayed when it loads. Valid values
2763 are:</p>
2764 <ul class="simple">
2765 <li><tt class="docutils literal"><span class="pre">quick</span></tt> to display the minimum number of options to configure</li>
2766 <li><tt class="docutils literal"><span class="pre">custom</span></tt> to display every available option to configure</li>
2767 <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
2768 of using quick export</li>
2769 </ul>
2770 </dd></dl>
2772 <dl class="option">
2773 <dt id="cfg_Import">
2774 <tt class="descname">$cfg['Import']</tt><a class="headerlink" href="#cfg_Import" title="Permalink to this definition"></a></dt>
2775 <dd><table class="docutils field-list" frame="void" rules="none">
2776 <col class="field-name" />
2777 <col class="field-body" />
2778 <tbody valign="top">
2779 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td>
2780 </tr>
2781 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array(...)</td>
2782 </tr>
2783 </tbody>
2784 </table>
2785 <p>In this array are defined default parameters for import, names of
2786 items are similar to texts seen on import page, so you can easily
2787 identify what they mean.</p>
2788 </dd></dl>
2790 </div>
2791 <div class="section" id="tabs-display-settings">
2792 <h2>Tabs display settings<a class="headerlink" href="#tabs-display-settings" title="Permalink to this headline"></a></h2>
2793 <dl class="option">
2794 <dt id="cfg_PropertiesIconic">
2795 <tt class="descname">$cfg['PropertiesIconic']</tt><a class="headerlink" href="#cfg_PropertiesIconic" title="Permalink to this definition"></a></dt>
2796 <dd><table class="docutils field-list" frame="void" rules="none">
2797 <col class="field-name" />
2798 <col class="field-body" />
2799 <tbody valign="top">
2800 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
2801 </tr>
2802 <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>
2803 </tr>
2804 </tbody>
2805 </table>
2806 <p>If set to <tt class="docutils literal"><span class="pre">true</span></tt>, will display icons instead of text for db and table
2807 properties links (like <em class="guilabel">Browse</em>, <em class="guilabel">Select</em>,
2808 <em class="guilabel">Insert</em>, ...) and for the menu tabs. Can be set to <tt class="docutils literal"><span class="pre">'both'</span></tt>
2809 if you want icons AND text. When set to <tt class="docutils literal"><span class="pre">false</span></tt>, will only show text.</p>
2810 </dd></dl>
2812 <dl class="option">
2813 <dt id="cfg_PropertiesNumColumns">
2814 <tt class="descname">$cfg['PropertiesNumColumns']</tt><a class="headerlink" href="#cfg_PropertiesNumColumns" title="Permalink to this definition"></a></dt>
2815 <dd><table class="docutils field-list" frame="void" rules="none">
2816 <col class="field-name" />
2817 <col class="field-body" />
2818 <tbody valign="top">
2819 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
2820 </tr>
2821 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">1</td>
2822 </tr>
2823 </tbody>
2824 </table>
2825 <p>How many columns will be utilized to display the tables on the database
2826 property view? When setting this to a value larger than 1, the type of the
2827 database will be omitted for more display space.</p>
2828 </dd></dl>
2830 <dl class="option">
2831 <dt id="cfg_DefaultTabServer">
2832 <tt class="descname">$cfg['DefaultTabServer']</tt><a class="headerlink" href="#cfg_DefaultTabServer" title="Permalink to this definition"></a></dt>
2833 <dd><table class="docutils field-list" frame="void" rules="none">
2834 <col class="field-name" />
2835 <col class="field-body" />
2836 <tbody valign="top">
2837 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
2838 </tr>
2839 <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>
2840 </tr>
2841 </tbody>
2842 </table>
2843 <p>Defines the tab displayed by default on server view. Possible values:</p>
2844 <ul class="simple">
2845 <li><tt class="docutils literal"><span class="pre">main.php</span></tt> (recommended for multi-user setups)</li>
2846 <li><tt class="docutils literal"><span class="pre">server_databases.php</span></tt>,</li>
2847 <li><tt class="docutils literal"><span class="pre">server_status.php</span></tt></li>
2848 <li><tt class="docutils literal"><span class="pre">server_variables.php</span></tt></li>
2849 <li><tt class="docutils literal"><span class="pre">server_privileges.php</span></tt></li>
2850 </ul>
2851 </dd></dl>
2853 <dl class="option">
2854 <dt id="cfg_DefaultTabDatabase">
2855 <tt class="descname">$cfg['DefaultTabDatabase']</tt><a class="headerlink" href="#cfg_DefaultTabDatabase" title="Permalink to this definition"></a></dt>
2856 <dd><table class="docutils field-list" frame="void" rules="none">
2857 <col class="field-name" />
2858 <col class="field-body" />
2859 <tbody valign="top">
2860 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
2861 </tr>
2862 <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>
2863 </tr>
2864 </tbody>
2865 </table>
2866 <p>Defines the tab displayed by default on database view. Possible
2867 values:</p>
2868 <ul class="simple">
2869 <li><tt class="docutils literal"><span class="pre">db_structure.php</span></tt></li>
2870 <li><tt class="docutils literal"><span class="pre">db_sql.php</span></tt></li>
2871 <li><tt class="docutils literal"><span class="pre">db_search.php</span></tt>.</li>
2872 </ul>
2873 </dd></dl>
2875 <dl class="option">
2876 <dt id="cfg_DefaultTabTable">
2877 <tt class="descname">$cfg['DefaultTabTable']</tt><a class="headerlink" href="#cfg_DefaultTabTable" title="Permalink to this definition"></a></dt>
2878 <dd><table class="docutils field-list" frame="void" rules="none">
2879 <col class="field-name" />
2880 <col class="field-body" />
2881 <tbody valign="top">
2882 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
2883 </tr>
2884 <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>
2885 </tr>
2886 </tbody>
2887 </table>
2888 <p>Defines the tab displayed by default on table view. Possible values:</p>
2889 <ul class="simple">
2890 <li><tt class="docutils literal"><span class="pre">tbl_structure.php</span></tt></li>
2891 <li><tt class="docutils literal"><span class="pre">tbl_sql.php</span></tt></li>
2892 <li><tt class="docutils literal"><span class="pre">tbl_select.php</span></tt></li>
2893 <li><tt class="docutils literal"><span class="pre">tbl_change.php</span></tt></li>
2894 <li><tt class="docutils literal"><span class="pre">sql.php</span></tt></li>
2895 </ul>
2896 </dd></dl>
2898 </div>
2899 <div class="section" id="documentation">
2900 <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline"></a></h2>
2901 <dl class="option">
2902 <dt id="cfg_MySQLManualBase">
2903 <tt class="descname">$cfg['MySQLManualBase']</tt><a class="headerlink" href="#cfg_MySQLManualBase" title="Permalink to this definition"></a></dt>
2904 <dd><table class="docutils field-list" frame="void" rules="none">
2905 <col class="field-name" />
2906 <col class="field-body" />
2907 <tbody valign="top">
2908 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
2909 </tr>
2910 <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>
2911 </tr>
2912 </tbody>
2913 </table>
2914 <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
2915 the MySQL documentation (type depends on
2916 <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
2917 generated.</p>
2918 <p>See <a class="reference external" href="http://dev.mysql.com/doc/">MySQL Documentation page</a> for more
2919 information about MySQL manuals and their types.</p>
2920 </dd></dl>
2922 <dl class="option">
2923 <dt id="cfg_MySQLManualType">
2924 <tt class="descname">$cfg['MySQLManualType']</tt><a class="headerlink" href="#cfg_MySQLManualType" title="Permalink to this definition"></a></dt>
2925 <dd><table class="docutils field-list" frame="void" rules="none">
2926 <col class="field-name" />
2927 <col class="field-body" />
2928 <tbody valign="top">
2929 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
2930 </tr>
2931 <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>
2932 </tr>
2933 </tbody>
2934 </table>
2935 <p>Type of MySQL documentation:</p>
2936 <ul class="simple">
2937 <li>viewable - &#8220;viewable online&#8221;, current one used on MySQL website</li>
2938 <li>searchable - &#8220;Searchable, with user comments&#8221;</li>
2939 <li>chapters - &#8220;HTML, one page per chapter&#8221;</li>
2940 <li>big - &#8220;HTML, all on one page&#8221;</li>
2941 <li>none - do not show documentation links</li>
2942 </ul>
2943 </dd></dl>
2945 </div>
2946 <div class="section" id="languages">
2947 <h2>Languages<a class="headerlink" href="#languages" title="Permalink to this headline"></a></h2>
2948 <dl class="option">
2949 <dt id="cfg_DefaultLang">
2950 <tt class="descname">$cfg['DefaultLang']</tt><a class="headerlink" href="#cfg_DefaultLang" title="Permalink to this definition"></a></dt>
2951 <dd><table class="docutils field-list" frame="void" rules="none">
2952 <col class="field-name" />
2953 <col class="field-body" />
2954 <tbody valign="top">
2955 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
2956 </tr>
2957 <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>
2958 </tr>
2959 </tbody>
2960 </table>
2961 <p>Defines the default language to use, if not browser-defined or user-
2962 defined. The corresponding language file needs to be in
2963 locale/<em>code</em>/LC_MESSAGES/phpmyadmin.mo.</p>
2964 </dd></dl>
2966 <dl class="option">
2967 <dt id="cfg_DefaultConnectionCollation">
2968 <tt class="descname">$cfg['DefaultConnectionCollation']</tt><a class="headerlink" href="#cfg_DefaultConnectionCollation" title="Permalink to this definition"></a></dt>
2969 <dd><table class="docutils field-list" frame="void" rules="none">
2970 <col class="field-name" />
2971 <col class="field-body" />
2972 <tbody valign="top">
2973 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
2974 </tr>
2975 <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>
2976 </tr>
2977 </tbody>
2978 </table>
2979 <p>Defines the default connection collation to use, if not user-defined.
2980 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
2981 ignored when connected to Drizzle server.</p>
2982 </dd></dl>
2984 <dl class="option">
2985 <dt id="cfg_Lang">
2986 <tt class="descname">$cfg['Lang']</tt><a class="headerlink" href="#cfg_Lang" title="Permalink to this definition"></a></dt>
2987 <dd><table class="docutils field-list" frame="void" rules="none">
2988 <col class="field-name" />
2989 <col class="field-body" />
2990 <tbody valign="top">
2991 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
2992 </tr>
2993 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">not set</td>
2994 </tr>
2995 </tbody>
2996 </table>
2997 <p>Force language to use. The corresponding language file needs to be in
2998 locale/<em>code</em>/LC_MESSAGES/phpmyadmin.mo.</p>
2999 </dd></dl>
3001 <dl class="option">
3002 <dt id="cfg_FilterLanguages">
3003 <tt class="descname">$cfg['FilterLanguages']</tt><a class="headerlink" href="#cfg_FilterLanguages" title="Permalink to this definition"></a></dt>
3004 <dd><table class="docutils field-list" frame="void" rules="none">
3005 <col class="field-name" />
3006 <col class="field-body" />
3007 <tbody valign="top">
3008 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
3009 </tr>
3010 <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>
3011 </tr>
3012 </tbody>
3013 </table>
3014 <p>Limit list of available languages to those matching the given regular
3015 expression. For example if you want only Czech and English, you should
3016 set filter to <tt class="docutils literal"><span class="pre">'^(cs|en)'</span></tt>.</p>
3017 </dd></dl>
3019 <dl class="option">
3020 <dt id="cfg_RecodingEngine">
3021 <tt class="descname">$cfg['RecodingEngine']</tt><a class="headerlink" href="#cfg_RecodingEngine" title="Permalink to this definition"></a></dt>
3022 <dd><table class="docutils field-list" frame="void" rules="none">
3023 <col class="field-name" />
3024 <col class="field-body" />
3025 <tbody valign="top">
3026 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
3027 </tr>
3028 <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>
3029 </tr>
3030 </tbody>
3031 </table>
3032 <p>You can select here which functions will be used for character set
3033 conversion. Possible values are:</p>
3034 <ul class="simple">
3035 <li>auto - automatically use available one (first is tested iconv, then
3036 recode)</li>
3037 <li>iconv - use iconv or libiconv functions</li>
3038 <li>recode - use recode_string function</li>
3039 <li>none - disable encoding conversion</li>
3040 </ul>
3041 <p>Enabled charset conversion activates a pull-down menu in the Export
3042 and Import pages, to choose the character set when exporting a file.
3043 The default value in this menu comes from
3044 <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>
3045 </dd></dl>
3047 <dl class="option">
3048 <dt id="cfg_IconvExtraParams">
3049 <tt class="descname">$cfg['IconvExtraParams']</tt><a class="headerlink" href="#cfg_IconvExtraParams" title="Permalink to this definition"></a></dt>
3050 <dd><table class="docutils field-list" frame="void" rules="none">
3051 <col class="field-name" />
3052 <col class="field-body" />
3053 <tbody valign="top">
3054 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
3055 </tr>
3056 <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>
3057 </tr>
3058 </tbody>
3059 </table>
3060 <p>Specify some parameters for iconv used in charset conversion. See
3061 <a class="reference external" href="http://www.gnu.org/software/libiconv/documentation/libiconv/iconv_open.3.html">iconv documentation</a> for details. By default
3062 <tt class="docutils literal"><span class="pre">//TRANSLIT</span></tt> is used, so that invalid characters will be
3063 transliterated.</p>
3064 </dd></dl>
3066 <dl class="option">
3067 <dt id="cfg_AvailableCharsets">
3068 <tt class="descname">$cfg['AvailableCharsets']</tt><a class="headerlink" href="#cfg_AvailableCharsets" title="Permalink to this definition"></a></dt>
3069 <dd><table class="docutils field-list" frame="void" rules="none">
3070 <col class="field-name" />
3071 <col class="field-body" />
3072 <tbody valign="top">
3073 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td>
3074 </tr>
3075 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array(..._</td>
3076 </tr>
3077 </tbody>
3078 </table>
3079 <p>Available character sets for MySQL conversion. You can add your own
3080 (any of supported by recode/iconv) or remove these which you don&#8217;t
3081 use. Character sets will be shown in same order as here listed, so if
3082 you frequently use some of these move them to the top.</p>
3083 </dd></dl>
3085 </div>
3086 <div class="section" id="web-server-settings">
3087 <h2>Web server settings<a class="headerlink" href="#web-server-settings" title="Permalink to this headline"></a></h2>
3088 <dl class="option">
3089 <dt id="cfg_OBGzip">
3090 <tt class="descname">$cfg['OBGzip']</tt><a class="headerlink" href="#cfg_OBGzip" title="Permalink to this definition"></a></dt>
3091 <dd><table class="docutils field-list" frame="void" rules="none">
3092 <col class="field-name" />
3093 <col class="field-body" />
3094 <tbody valign="top">
3095 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string/boolean</td>
3096 </tr>
3097 <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>
3098 </tr>
3099 </tbody>
3100 </table>
3101 <p>Defines whether to use GZip output buffering for increased speed in
3102 <a class="reference internal" href="glossary.html#term-http"><em class="xref std std-term">HTTP</em></a> transfers. Set to
3103 true/false for enabling/disabling. When set to &#8216;auto&#8217; (string),
3104 phpMyAdmin tries to enable output buffering and will automatically
3105 disable it if your browser has some problems with buffering. IE6 with
3106 a certain patch is known to cause data corruption when having enabled
3107 buffering.</p>
3108 </dd></dl>
3110 <dl class="option">
3111 <dt id="cfg_TrustedProxies">
3112 <tt class="descname">$cfg['TrustedProxies']</tt><a class="headerlink" href="#cfg_TrustedProxies" title="Permalink to this definition"></a></dt>
3113 <dd><table class="docutils field-list" frame="void" rules="none">
3114 <col class="field-name" />
3115 <col class="field-body" />
3116 <tbody valign="top">
3117 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td>
3118 </tr>
3119 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array()</td>
3120 </tr>
3121 </tbody>
3122 </table>
3123 <p>Lists proxies and HTTP headers which are trusted for
3124 <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
3125 default empty, you need to fill in some trusted proxy servers if you
3126 want to use rules for IP addresses behind proxy.</p>
3127 <p>The following example specifies that phpMyAdmin should trust a
3128 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
3129 1.2.3.4:</p>
3130 <div class="highlight-php"><div class="highlight"><pre><span class="x">$cfg[&#39;TrustedProxies&#39;] = array(&#39;1.2.3.4&#39; =&gt; &#39;HTTP_X_FORWARDED_FOR&#39;);</span>
3131 </pre></div>
3132 </div>
3133 <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
3134 client&#8217;s IP address as usual.</p>
3135 </dd></dl>
3137 <dl class="option">
3138 <dt id="cfg_GD2Available">
3139 <tt class="descname">$cfg['GD2Available']</tt><a class="headerlink" href="#cfg_GD2Available" title="Permalink to this definition"></a></dt>
3140 <dd><table class="docutils field-list" frame="void" rules="none">
3141 <col class="field-name" />
3142 <col class="field-body" />
3143 <tbody valign="top">
3144 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
3145 </tr>
3146 <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>
3147 </tr>
3148 </tbody>
3149 </table>
3150 <p>Specifies whether GD &gt;= 2 is available. If yes it can be used for MIME
3151 transformations. Possible values are:</p>
3152 <ul class="simple">
3153 <li>auto - automatically detect</li>
3154 <li>yes - GD 2 functions can be used</li>
3155 <li>no - GD 2 function cannot be used</li>
3156 </ul>
3157 </dd></dl>
3159 <dl class="option">
3160 <dt id="cfg_CheckConfigurationPermissions">
3161 <tt class="descname">$cfg['CheckConfigurationPermissions']</tt><a class="headerlink" href="#cfg_CheckConfigurationPermissions" title="Permalink to this definition"></a></dt>
3162 <dd><table class="docutils field-list" frame="void" rules="none">
3163 <col class="field-name" />
3164 <col class="field-body" />
3165 <tbody valign="top">
3166 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
3167 </tr>
3168 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
3169 </tr>
3170 </tbody>
3171 </table>
3172 <p>We normally check the permissions on the configuration file to ensure
3173 it&#8217;s not world writable. However, phpMyAdmin could be installed on a
3174 NTFS filesystem mounted on a non-Windows server, in which case the
3175 permissions seems wrong but in fact cannot be detected. In this case a
3176 sysadmin would set this parameter to <tt class="docutils literal"><span class="pre">false</span></tt>.</p>
3177 </dd></dl>
3179 <dl class="option">
3180 <dt id="cfg_LinkLengthLimit">
3181 <tt class="descname">$cfg['LinkLengthLimit']</tt><a class="headerlink" href="#cfg_LinkLengthLimit" title="Permalink to this definition"></a></dt>
3182 <dd><table class="docutils field-list" frame="void" rules="none">
3183 <col class="field-name" />
3184 <col class="field-body" />
3185 <tbody valign="top">
3186 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
3187 </tr>
3188 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">1000</td>
3189 </tr>
3190 </tbody>
3191 </table>
3192 <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
3193 limit, it is replaced by form with button. This is required as some web
3194 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>
3195 </dd></dl>
3197 <dl class="option">
3198 <dt id="cfg_CSPAllow">
3199 <tt class="descname">$cfg['CSPAllow']</tt><a class="headerlink" href="#cfg_CSPAllow" title="Permalink to this definition"></a></dt>
3200 <dd><table class="docutils field-list" frame="void" rules="none">
3201 <col class="field-name" />
3202 <col class="field-body" />
3203 <tbody valign="top">
3204 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
3205 </tr>
3206 <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>
3207 </tr>
3208 </tbody>
3209 </table>
3210 <p>Additional string to include in allowed script sources in Content Security
3211 Policy header.</p>
3212 <p>This can be useful when you want to include some external javascript files
3213 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
3214 would be normally not allowed by Content Security Policy.</p>
3215 </dd></dl>
3217 <dl class="option">
3218 <dt id="cfg_DisableMultiTableMaintenance">
3219 <tt class="descname">$cfg['DisableMultiTableMaintenance']</tt><a class="headerlink" href="#cfg_DisableMultiTableMaintenance" title="Permalink to this definition"></a></dt>
3220 <dd><table class="docutils field-list" frame="void" rules="none">
3221 <col class="field-name" />
3222 <col class="field-body" />
3223 <tbody valign="top">
3224 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
3225 </tr>
3226 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
3227 </tr>
3228 </tbody>
3229 </table>
3230 <p>In the database Structure page, it&#8217;s possible to mark some tables then
3231 choose an operation like optimizing for many tables. This can slow
3232 down a server; therefore, setting this to <tt class="docutils literal"><span class="pre">true</span></tt> prevents this kind
3233 of multiple maintenance operation.</p>
3234 </dd></dl>
3236 </div>
3237 <div class="section" id="theme-settings">
3238 <h2>Theme settings<a class="headerlink" href="#theme-settings" title="Permalink to this headline"></a></h2>
3239 <dl class="option">
3240 <dt id="cfg_NaviWidth">
3241 <tt class="descname">$cfg['NaviWidth']</tt><a class="headerlink" href="#cfg_NaviWidth" title="Permalink to this definition"></a></dt>
3242 <dd><table class="docutils field-list" frame="void" rules="none">
3243 <col class="field-name" />
3244 <col class="field-body" />
3245 <tbody valign="top">
3246 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
3247 </tr>
3248 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
3249 </tr>
3250 </tbody>
3251 </table>
3252 <p>Navigation panel width in pixels. See
3253 <tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p>
3254 </dd></dl>
3256 <dl class="option">
3257 <dt id="cfg_NaviBackground">
3258 <tt class="descname">$cfg['NaviBackground']</tt><a class="headerlink" href="#cfg_NaviBackground" title="Permalink to this definition"></a></dt>
3259 <dd><table class="docutils field-list" frame="void" rules="none">
3260 <col class="field-name" />
3261 <col class="field-body" />
3262 <tbody valign="top">
3263 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color for background]</td>
3264 </tr>
3265 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
3266 </tr>
3267 </tbody>
3268 </table>
3269 </dd></dl>
3271 <dl class="option">
3272 <dt id="cfg_MainBackground">
3273 <tt class="descname">$cfg['MainBackground']</tt><a class="headerlink" href="#cfg_MainBackground" title="Permalink to this definition"></a></dt>
3274 <dd><table class="docutils field-list" frame="void" rules="none">
3275 <col class="field-name" />
3276 <col class="field-body" />
3277 <tbody valign="top">
3278 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color for background]</td>
3279 </tr>
3280 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
3281 </tr>
3282 </tbody>
3283 </table>
3284 <p>The background styles used for both the frames. See
3285 <tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p>
3286 </dd></dl>
3288 <dl class="option">
3289 <dt id="cfg_NaviPointerBackground">
3290 <tt class="descname">$cfg['NaviPointerBackground']</tt><a class="headerlink" href="#cfg_NaviPointerBackground" title="Permalink to this definition"></a></dt>
3291 <dd><table class="docutils field-list" frame="void" rules="none">
3292 <col class="field-name" />
3293 <col class="field-body" />
3294 <tbody valign="top">
3295 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color for background]</td>
3296 </tr>
3297 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
3298 </tr>
3299 </tbody>
3300 </table>
3301 </dd></dl>
3303 <dl class="option">
3304 <dt id="cfg_NaviPointerColor">
3305 <tt class="descname">$cfg['NaviPointerColor']</tt><a class="headerlink" href="#cfg_NaviPointerColor" title="Permalink to this definition"></a></dt>
3306 <dd><table class="docutils field-list" frame="void" rules="none">
3307 <col class="field-name" />
3308 <col class="field-body" />
3309 <tbody valign="top">
3310 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color]</td>
3311 </tr>
3312 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
3313 </tr>
3314 </tbody>
3315 </table>
3316 <p>The style used for the pointer in the navi frame. See
3317 <tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p>
3318 </dd></dl>
3320 <dl class="option">
3321 <dt id="cfg_Border">
3322 <tt class="descname">$cfg['Border']</tt><a class="headerlink" href="#cfg_Border" title="Permalink to this definition"></a></dt>
3323 <dd><table class="docutils field-list" frame="void" rules="none">
3324 <col class="field-name" />
3325 <col class="field-body" />
3326 <tbody valign="top">
3327 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
3328 </tr>
3329 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
3330 </tr>
3331 </tbody>
3332 </table>
3333 <p>The size of a table&#8217;s border. See <tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p>
3334 </dd></dl>
3336 <dl class="option">
3337 <dt id="cfg_ThBackground">
3338 <tt class="descname">$cfg['ThBackground']</tt><a class="headerlink" href="#cfg_ThBackground" title="Permalink to this definition"></a></dt>
3339 <dd><table class="docutils field-list" frame="void" rules="none">
3340 <col class="field-name" />
3341 <col class="field-body" />
3342 <tbody valign="top">
3343 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color for background]</td>
3344 </tr>
3345 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
3346 </tr>
3347 </tbody>
3348 </table>
3349 </dd></dl>
3351 <dl class="option">
3352 <dt id="cfg_ThColor">
3353 <tt class="descname">$cfg['ThColor']</tt><a class="headerlink" href="#cfg_ThColor" title="Permalink to this definition"></a></dt>
3354 <dd><table class="docutils field-list" frame="void" rules="none">
3355 <col class="field-name" />
3356 <col class="field-body" />
3357 <tbody valign="top">
3358 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color]</td>
3359 </tr>
3360 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
3361 </tr>
3362 </tbody>
3363 </table>
3364 <p>The style used for table headers. See
3365 <tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p>
3366 </dd></dl>
3368 <span class="target" id="cfg-bgcolorone"></span><dl class="option">
3369 <dt id="cfg_BgOne">
3370 <tt class="descname">$cfg['BgOne']</tt><a class="headerlink" href="#cfg_BgOne" title="Permalink to this definition"></a></dt>
3371 <dd><table class="docutils field-list" frame="void" rules="none">
3372 <col class="field-name" />
3373 <col class="field-body" />
3374 <tbody valign="top">
3375 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color]</td>
3376 </tr>
3377 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
3378 </tr>
3379 </tbody>
3380 </table>
3381 <p>The color (HTML) #1 for table rows. See
3382 <tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p>
3383 </dd></dl>
3385 <span class="target" id="cfg-bgcolortwo"></span><dl class="option">
3386 <dt id="cfg_BgTwo">
3387 <tt class="descname">$cfg['BgTwo']</tt><a class="headerlink" href="#cfg_BgTwo" title="Permalink to this definition"></a></dt>
3388 <dd><table class="docutils field-list" frame="void" rules="none">
3389 <col class="field-name" />
3390 <col class="field-body" />
3391 <tbody valign="top">
3392 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color]</td>
3393 </tr>
3394 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
3395 </tr>
3396 </tbody>
3397 </table>
3398 <p>The color (HTML) #2 for table rows. See
3399 <tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p>
3400 </dd></dl>
3402 <dl class="option">
3403 <dt id="cfg_BrowsePointerBackground">
3404 <tt class="descname">$cfg['BrowsePointerBackground']</tt><a class="headerlink" href="#cfg_BrowsePointerBackground" title="Permalink to this definition"></a></dt>
3405 <dd><table class="docutils field-list" frame="void" rules="none">
3406 <col class="field-name" />
3407 <col class="field-body" />
3408 <tbody valign="top">
3409 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color]</td>
3410 </tr>
3411 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
3412 </tr>
3413 </tbody>
3414 </table>
3415 </dd></dl>
3417 <dl class="option">
3418 <dt id="cfg_BrowsePointerColor">
3419 <tt class="descname">$cfg['BrowsePointerColor']</tt><a class="headerlink" href="#cfg_BrowsePointerColor" title="Permalink to this definition"></a></dt>
3420 <dd><table class="docutils field-list" frame="void" rules="none">
3421 <col class="field-name" />
3422 <col class="field-body" />
3423 <tbody valign="top">
3424 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color]</td>
3425 </tr>
3426 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
3427 </tr>
3428 </tbody>
3429 </table>
3430 </dd></dl>
3432 <dl class="option">
3433 <dt id="cfg_BrowseMarkerBackground">
3434 <tt class="descname">$cfg['BrowseMarkerBackground']</tt><a class="headerlink" href="#cfg_BrowseMarkerBackground" title="Permalink to this definition"></a></dt>
3435 <dd><table class="docutils field-list" frame="void" rules="none">
3436 <col class="field-name" />
3437 <col class="field-body" />
3438 <tbody valign="top">
3439 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color]</td>
3440 </tr>
3441 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
3442 </tr>
3443 </tbody>
3444 </table>
3445 </dd></dl>
3447 <dl class="option">
3448 <dt id="cfg_BrowseMarkerColor">
3449 <tt class="descname">$cfg['BrowseMarkerColor']</tt><a class="headerlink" href="#cfg_BrowseMarkerColor" title="Permalink to this definition"></a></dt>
3450 <dd><table class="docutils field-list" frame="void" rules="none">
3451 <col class="field-name" />
3452 <col class="field-body" />
3453 <tbody valign="top">
3454 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string [CSS color]</td>
3455 </tr>
3456 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
3457 </tr>
3458 </tbody>
3459 </table>
3460 <p>The colors (HTML) uses for the pointer and the marker in browse mode.
3461 The former feature highlights the row over which your mouse is passing
3462 and the latter lets you visually mark/unmark rows by clicking on the
3463 corresponding checkbox. Highlighting / marking a column is done by
3464 hovering over / clicking the column&#8217;s header (outside of the text).
3465 See <tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p>
3466 </dd></dl>
3468 <dl class="option">
3469 <dt id="cfg_FontFamily">
3470 <tt class="descname">$cfg['FontFamily']</tt><a class="headerlink" href="#cfg_FontFamily" title="Permalink to this definition"></a></dt>
3471 <dd><table class="docutils field-list" frame="void" rules="none">
3472 <col class="field-name" />
3473 <col class="field-body" />
3474 <tbody valign="top">
3475 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
3476 </tr>
3477 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
3478 </tr>
3479 </tbody>
3480 </table>
3481 <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>
3482 <span class="pre">serif</span></tt>. See <tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p>
3483 </dd></dl>
3485 <dl class="option">
3486 <dt id="cfg_FontFamilyFixed">
3487 <tt class="descname">$cfg['FontFamilyFixed']</tt><a class="headerlink" href="#cfg_FontFamilyFixed" title="Permalink to this definition"></a></dt>
3488 <dd><table class="docutils field-list" frame="void" rules="none">
3489 <col class="field-name" />
3490 <col class="field-body" />
3491 <tbody valign="top">
3492 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
3493 </tr>
3494 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
3495 </tr>
3496 </tbody>
3497 </table>
3498 <p>You put here a valid CSS font family value, for example <tt class="docutils literal"><span class="pre">monospace</span></tt>.
3499 This one is used in textarea. See <tt class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></tt>.</p>
3500 </dd></dl>
3502 </div>
3503 <div class="section" id="design-customization">
3504 <h2>Design customization<a class="headerlink" href="#design-customization" title="Permalink to this headline"></a></h2>
3505 <dl class="option">
3506 <dt id="cfg_NavigationTreePointerEnable">
3507 <tt class="descname">$cfg['NavigationTreePointerEnable']</tt><a class="headerlink" href="#cfg_NavigationTreePointerEnable" title="Permalink to this definition"></a></dt>
3508 <dd><table class="docutils field-list" frame="void" rules="none">
3509 <col class="field-name" />
3510 <col class="field-body" />
3511 <tbody valign="top">
3512 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
3513 </tr>
3514 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
3515 </tr>
3516 </tbody>
3517 </table>
3518 <p>A value of <tt class="docutils literal"><span class="pre">true</span></tt> activates the navi pointer.</p>
3519 </dd></dl>
3521 <dl class="option">
3522 <dt id="cfg_BrowsePointerEnable">
3523 <tt class="descname">$cfg['BrowsePointerEnable']</tt><a class="headerlink" href="#cfg_BrowsePointerEnable" title="Permalink to this definition"></a></dt>
3524 <dd><table class="docutils field-list" frame="void" rules="none">
3525 <col class="field-name" />
3526 <col class="field-body" />
3527 <tbody valign="top">
3528 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
3529 </tr>
3530 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
3531 </tr>
3532 </tbody>
3533 </table>
3534 <p>Whether to activate the browse pointer or not.</p>
3535 </dd></dl>
3537 <dl class="option">
3538 <dt id="cfg_BrowseMarkerEnable">
3539 <tt class="descname">$cfg['BrowseMarkerEnable']</tt><a class="headerlink" href="#cfg_BrowseMarkerEnable" title="Permalink to this definition"></a></dt>
3540 <dd><table class="docutils field-list" frame="void" rules="none">
3541 <col class="field-name" />
3542 <col class="field-body" />
3543 <tbody valign="top">
3544 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
3545 </tr>
3546 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
3547 </tr>
3548 </tbody>
3549 </table>
3550 <p>Whether to activate the browse marker or not.</p>
3551 </dd></dl>
3553 <dl class="option">
3554 <dt id="cfg_LimitChars">
3555 <tt class="descname">$cfg['LimitChars']</tt><a class="headerlink" href="#cfg_LimitChars" title="Permalink to this definition"></a></dt>
3556 <dd><table class="docutils field-list" frame="void" rules="none">
3557 <col class="field-name" />
3558 <col class="field-body" />
3559 <tbody valign="top">
3560 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
3561 </tr>
3562 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">50</td>
3563 </tr>
3564 </tbody>
3565 </table>
3566 <p>Maximum number of characters shown in any non-numeric field on browse
3567 view. Can be turned off by a toggle button on the browse page.</p>
3568 </dd></dl>
3570 <dl class="option">
3571 <dt id="cfg_RowActionLinks">
3572 <tt class="descname">$cfg['RowActionLinks']</tt><a class="headerlink" href="#cfg_RowActionLinks" title="Permalink to this definition"></a></dt>
3573 <dd><table class="docutils field-list" frame="void" rules="none">
3574 <col class="field-name" />
3575 <col class="field-body" />
3576 <tbody valign="top">
3577 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
3578 </tr>
3579 <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>
3580 </tr>
3581 </tbody>
3582 </table>
3583 <p>Defines the place where table row links (Edit, Copy, Delete) would be
3584 put when tables contents are displayed (you may have them displayed at
3585 the left side, right side, both sides or nowhere). &#8220;left&#8221; and &#8220;right&#8221;
3586 are parsed as &#8220;top&#8221; and &#8220;bottom&#8221; with vertical display mode.</p>
3587 </dd></dl>
3589 <dl class="option">
3590 <dt id="cfg_DefaultDisplay">
3591 <tt class="descname">$cfg['DefaultDisplay']</tt><a class="headerlink" href="#cfg_DefaultDisplay" title="Permalink to this definition"></a></dt>
3592 <dd><table class="docutils field-list" frame="void" rules="none">
3593 <col class="field-name" />
3594 <col class="field-body" />
3595 <tbody valign="top">
3596 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
3597 </tr>
3598 <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>
3599 </tr>
3600 </tbody>
3601 </table>
3602 <p>There are 3 display modes: horizontal, horizontalflipped and vertical.
3603 Define which one is displayed by default. The first mode displays each
3604 row on a horizontal line, the second rotates the headers by 90
3605 degrees, so you can use descriptive headers even though columns only
3606 contain small values and still print them out. The vertical mode sorts
3607 each row on a vertical lineup.</p>
3608 </dd></dl>
3610 <dl class="option">
3611 <dt id="cfg_RememberSorting">
3612 <tt class="descname">$cfg['RememberSorting']</tt><a class="headerlink" href="#cfg_RememberSorting" title="Permalink to this definition"></a></dt>
3613 <dd><table class="docutils field-list" frame="void" rules="none">
3614 <col class="field-name" />
3615 <col class="field-body" />
3616 <tbody valign="top">
3617 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
3618 </tr>
3619 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
3620 </tr>
3621 </tbody>
3622 </table>
3623 <p>If enabled, remember the sorting of each table when browsing them.</p>
3624 </dd></dl>
3626 <dl class="option">
3627 <dt id="cfg_HeaderFlipType">
3628 <tt class="descname">$cfg['HeaderFlipType']</tt><a class="headerlink" href="#cfg_HeaderFlipType" title="Permalink to this definition"></a></dt>
3629 <dd><table class="docutils field-list" frame="void" rules="none">
3630 <col class="field-name" />
3631 <col class="field-body" />
3632 <tbody valign="top">
3633 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
3634 </tr>
3635 <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>
3636 </tr>
3637 </tbody>
3638 </table>
3639 <p>The HeaderFlipType can be set to &#8216;auto&#8217;, &#8216;css&#8217; or &#8216;fake&#8217;. When using
3640 &#8216;css&#8217; the rotation of the header for horizontalflipped is done via
3641 CSS. The CSS transformation currently works only in Internet
3642 Explorer.If set to &#8216;fake&#8217; PHP does the transformation for you, but of
3643 course this does not look as good as CSS. The &#8216;auto&#8217; option enables
3644 CSS transformation when browser supports it and use PHP based one
3645 otherwise.</p>
3646 </dd></dl>
3648 <dl class="option">
3649 <dt id="cfg_ShowBrowseComments">
3650 <tt class="descname">$cfg['ShowBrowseComments']</tt><a class="headerlink" href="#cfg_ShowBrowseComments" title="Permalink to this definition"></a></dt>
3651 <dd><table class="docutils field-list" frame="void" rules="none">
3652 <col class="field-name" />
3653 <col class="field-body" />
3654 <tbody valign="top">
3655 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
3656 </tr>
3657 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
3658 </tr>
3659 </tbody>
3660 </table>
3661 </dd></dl>
3663 <dl class="option">
3664 <dt id="cfg_ShowPropertyComments">
3665 <tt class="descname">$cfg['ShowPropertyComments']</tt><a class="headerlink" href="#cfg_ShowPropertyComments" title="Permalink to this definition"></a></dt>
3666 <dd><table class="docutils field-list" frame="void" rules="none">
3667 <col class="field-name" />
3668 <col class="field-body" />
3669 <tbody valign="top">
3670 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
3671 </tr>
3672 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
3673 </tr>
3674 </tbody>
3675 </table>
3676 <p>By setting the corresponding variable to <tt class="docutils literal"><span class="pre">true</span></tt> you can enable the
3677 display of column comments in Browse or Property display. In browse
3678 mode, the comments are shown inside the header. In property mode,
3679 comments are displayed using a CSS-formatted dashed-line below the
3680 name of the column. The comment is shown as a tool-tip for that
3681 column.</p>
3682 </dd></dl>
3684 </div>
3685 <div class="section" id="text-fields">
3686 <h2>Text fields<a class="headerlink" href="#text-fields" title="Permalink to this headline"></a></h2>
3687 <dl class="option">
3688 <dt id="cfg_CharEditing">
3689 <tt class="descname">$cfg['CharEditing']</tt><a class="headerlink" href="#cfg_CharEditing" title="Permalink to this definition"></a></dt>
3690 <dd><table class="docutils field-list" frame="void" rules="none">
3691 <col class="field-name" />
3692 <col class="field-body" />
3693 <tbody valign="top">
3694 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
3695 </tr>
3696 <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>
3697 </tr>
3698 </tbody>
3699 </table>
3700 <p>Defines which type of editing controls should be used for CHAR and
3701 VARCHAR columns. Possible values are:</p>
3702 <ul class="simple">
3703 <li>input - this allows to limit size of text to size of columns in MySQL,
3704 but has problems with newlines in columns</li>
3705 <li>textarea - no problems with newlines in columns, but also no length
3706 limitations</li>
3707 </ul>
3708 </dd></dl>
3710 <dl class="option">
3711 <dt id="cfg_MinSizeForInputField">
3712 <tt class="descname">$cfg['MinSizeForInputField']</tt><a class="headerlink" href="#cfg_MinSizeForInputField" title="Permalink to this definition"></a></dt>
3713 <dd><table class="docutils field-list" frame="void" rules="none">
3714 <col class="field-name" />
3715 <col class="field-body" />
3716 <tbody valign="top">
3717 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
3718 </tr>
3719 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">4</td>
3720 </tr>
3721 </tbody>
3722 </table>
3723 <p>Defines the minimum size for input fields generated for CHAR and
3724 VARCHAR columns.</p>
3725 </dd></dl>
3727 <dl class="option">
3728 <dt id="cfg_MaxSizeForInputField">
3729 <tt class="descname">$cfg['MaxSizeForInputField']</tt><a class="headerlink" href="#cfg_MaxSizeForInputField" title="Permalink to this definition"></a></dt>
3730 <dd><table class="docutils field-list" frame="void" rules="none">
3731 <col class="field-name" />
3732 <col class="field-body" />
3733 <tbody valign="top">
3734 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
3735 </tr>
3736 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">60</td>
3737 </tr>
3738 </tbody>
3739 </table>
3740 <p>Defines the maximum size for input fields generated for CHAR and
3741 VARCHAR columns.</p>
3742 </dd></dl>
3744 <dl class="option">
3745 <dt id="cfg_TextareaCols">
3746 <tt class="descname">$cfg['TextareaCols']</tt><a class="headerlink" href="#cfg_TextareaCols" title="Permalink to this definition"></a></dt>
3747 <dd><table class="docutils field-list" frame="void" rules="none">
3748 <col class="field-name" />
3749 <col class="field-body" />
3750 <tbody valign="top">
3751 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
3752 </tr>
3753 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">40</td>
3754 </tr>
3755 </tbody>
3756 </table>
3757 </dd></dl>
3759 <dl class="option">
3760 <dt id="cfg_TextareaRows">
3761 <tt class="descname">$cfg['TextareaRows']</tt><a class="headerlink" href="#cfg_TextareaRows" title="Permalink to this definition"></a></dt>
3762 <dd><table class="docutils field-list" frame="void" rules="none">
3763 <col class="field-name" />
3764 <col class="field-body" />
3765 <tbody valign="top">
3766 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
3767 </tr>
3768 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">15</td>
3769 </tr>
3770 </tbody>
3771 </table>
3772 </dd></dl>
3774 <dl class="option">
3775 <dt id="cfg_CharTextareaCols">
3776 <tt class="descname">$cfg['CharTextareaCols']</tt><a class="headerlink" href="#cfg_CharTextareaCols" title="Permalink to this definition"></a></dt>
3777 <dd><table class="docutils field-list" frame="void" rules="none">
3778 <col class="field-name" />
3779 <col class="field-body" />
3780 <tbody valign="top">
3781 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
3782 </tr>
3783 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">40</td>
3784 </tr>
3785 </tbody>
3786 </table>
3787 </dd></dl>
3789 <dl class="option">
3790 <dt id="cfg_CharTextareaRows">
3791 <tt class="descname">$cfg['CharTextareaRows']</tt><a class="headerlink" href="#cfg_CharTextareaRows" title="Permalink to this definition"></a></dt>
3792 <dd><table class="docutils field-list" frame="void" rules="none">
3793 <col class="field-name" />
3794 <col class="field-body" />
3795 <tbody valign="top">
3796 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
3797 </tr>
3798 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">2</td>
3799 </tr>
3800 </tbody>
3801 </table>
3802 <p>Number of columns and rows for the textareas. This value will be
3803 emphasized (*2) for <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> query
3804 textareas and (*1.25) for <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a>
3805 textareas inside the query window.</p>
3806 <p>The Char* values are used for CHAR
3807 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>
3808 </dd></dl>
3810 <dl class="option">
3811 <dt id="cfg_LongtextDoubleTextarea">
3812 <tt class="descname">$cfg['LongtextDoubleTextarea']</tt><a class="headerlink" href="#cfg_LongtextDoubleTextarea" title="Permalink to this definition"></a></dt>
3813 <dd><table class="docutils field-list" frame="void" rules="none">
3814 <col class="field-name" />
3815 <col class="field-body" />
3816 <tbody valign="top">
3817 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
3818 </tr>
3819 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
3820 </tr>
3821 </tbody>
3822 </table>
3823 <p>Defines whether textarea for LONGTEXT columns should have double size.</p>
3824 </dd></dl>
3826 <dl class="option">
3827 <dt id="cfg_TextareaAutoSelect">
3828 <tt class="descname">$cfg['TextareaAutoSelect']</tt><a class="headerlink" href="#cfg_TextareaAutoSelect" title="Permalink to this definition"></a></dt>
3829 <dd><table class="docutils field-list" frame="void" rules="none">
3830 <col class="field-name" />
3831 <col class="field-body" />
3832 <tbody valign="top">
3833 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
3834 </tr>
3835 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
3836 </tr>
3837 </tbody>
3838 </table>
3839 <p>Defines if the whole textarea of the query box will be selected on
3840 click.</p>
3841 </dd></dl>
3843 </div>
3844 <div class="section" id="sql-query-box-settings">
3845 <h2>SQL query box settings<a class="headerlink" href="#sql-query-box-settings" title="Permalink to this headline"></a></h2>
3846 <dl class="option">
3847 <dt id="cfg_SQLQuery_Edit">
3848 <tt class="descname">$cfg['SQLQuery']['Edit']</tt><a class="headerlink" href="#cfg_SQLQuery_Edit" title="Permalink to this definition"></a></dt>
3849 <dd><table class="docutils field-list" frame="void" rules="none">
3850 <col class="field-name" />
3851 <col class="field-body" />
3852 <tbody valign="top">
3853 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
3854 </tr>
3855 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
3856 </tr>
3857 </tbody>
3858 </table>
3859 <p>Whether to display an edit link to change a query in any SQL Query
3860 box.</p>
3861 </dd></dl>
3863 <dl class="option">
3864 <dt id="cfg_SQLQuery_Explain">
3865 <tt class="descname">$cfg['SQLQuery']['Explain']</tt><a class="headerlink" href="#cfg_SQLQuery_Explain" title="Permalink to this definition"></a></dt>
3866 <dd><table class="docutils field-list" frame="void" rules="none">
3867 <col class="field-name" />
3868 <col class="field-body" />
3869 <tbody valign="top">
3870 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
3871 </tr>
3872 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
3873 </tr>
3874 </tbody>
3875 </table>
3876 <p>Whether to display a link to explain a SELECT query in any SQL Query
3877 box.</p>
3878 </dd></dl>
3880 <dl class="option">
3881 <dt id="cfg_SQLQuery_ShowAsPHP">
3882 <tt class="descname">$cfg['SQLQuery']['ShowAsPHP']</tt><a class="headerlink" href="#cfg_SQLQuery_ShowAsPHP" title="Permalink to this definition"></a></dt>
3883 <dd><table class="docutils field-list" frame="void" rules="none">
3884 <col class="field-name" />
3885 <col class="field-body" />
3886 <tbody valign="top">
3887 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
3888 </tr>
3889 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
3890 </tr>
3891 </tbody>
3892 </table>
3893 <p>Whether to display a link to wrap a query in PHP code in any SQL Query
3894 box.</p>
3895 </dd></dl>
3897 <dl class="option">
3898 <dt id="cfg_SQLQuery_Validate">
3899 <tt class="descname">$cfg['SQLQuery']['Validate']</tt><a class="headerlink" href="#cfg_SQLQuery_Validate" title="Permalink to this definition"></a></dt>
3900 <dd><table class="docutils field-list" frame="void" rules="none">
3901 <col class="field-name" />
3902 <col class="field-body" />
3903 <tbody valign="top">
3904 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
3905 </tr>
3906 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
3907 </tr>
3908 </tbody>
3909 </table>
3910 <p>Whether to display a link to validate a query in any SQL Query box.</p>
3911 <div class="admonition-see-also admonition seealso">
3912 <p class="first admonition-title">See also</p>
3913 <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>
3914 </div>
3915 </dd></dl>
3917 <dl class="option">
3918 <dt id="cfg_SQLQuery_Refresh">
3919 <tt class="descname">$cfg['SQLQuery']['Refresh']</tt><a class="headerlink" href="#cfg_SQLQuery_Refresh" title="Permalink to this definition"></a></dt>
3920 <dd><table class="docutils field-list" frame="void" rules="none">
3921 <col class="field-name" />
3922 <col class="field-body" />
3923 <tbody valign="top">
3924 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
3925 </tr>
3926 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
3927 </tr>
3928 </tbody>
3929 </table>
3930 <p>Whether to display a link to refresh a query in any SQL Query box.</p>
3931 </dd></dl>
3933 </div>
3934 <div class="section" id="web-server-upload-save-import-directories">
3935 <h2>Web server upload/save/import directories<a class="headerlink" href="#web-server-upload-save-import-directories" title="Permalink to this headline"></a></h2>
3936 <dl class="option">
3937 <dt id="cfg_UploadDir">
3938 <tt class="descname">$cfg['UploadDir']</tt><a class="headerlink" href="#cfg_UploadDir" title="Permalink to this definition"></a></dt>
3939 <dd><table class="docutils field-list" frame="void" rules="none">
3940 <col class="field-name" />
3941 <col class="field-body" />
3942 <tbody valign="top">
3943 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
3944 </tr>
3945 <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>
3946 </tr>
3947 </tbody>
3948 </table>
3949 <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
3950 other means than phpMyAdmin (for example, ftp). Those files are available
3951 under a drop-down box when you click the database or table name, then the
3952 Import tab.</p>
3953 <p>If
3954 you want different directory for each user, %u will be replaced with
3955 username.</p>
3956 <p>Please note that the file names must have the suffix &#8221;.sql&#8221;
3957 (or &#8221;.sql.bz2&#8221; or &#8221;.sql.gz&#8221; if support for compressed formats is
3958 enabled).</p>
3959 <p>This feature is useful when your file is too big to be
3960 uploaded via <a class="reference internal" href="glossary.html#term-http"><em class="xref std std-term">HTTP</em></a>, or when file
3961 uploads are disabled in PHP.</p>
3962 <div class="admonition note">
3963 <p class="first admonition-title">Note</p>
3964 <p class="last">If PHP is running in safe mode, this directory must be owned by the same
3965 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
3966 alternatives.</p>
3967 </div>
3968 </dd></dl>
3970 <dl class="option">
3971 <dt id="cfg_SaveDir">
3972 <tt class="descname">$cfg['SaveDir']</tt><a class="headerlink" href="#cfg_SaveDir" title="Permalink to this definition"></a></dt>
3973 <dd><table class="docutils field-list" frame="void" rules="none">
3974 <col class="field-name" />
3975 <col class="field-body" />
3976 <tbody valign="top">
3977 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
3978 </tr>
3979 <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>
3980 </tr>
3981 </tbody>
3982 </table>
3983 <p>The name of the directory where dumps can be saved.</p>
3984 <p>If you want different directory for each user, %u will be replaced with
3985 username.</p>
3986 <p>Please note that the directory must exist and has to be writable for
3987 the user running webserver.</p>
3988 <div class="admonition note">
3989 <p class="first admonition-title">Note</p>
3990 <p class="last">If PHP is running in safe mode, this directory must be owned by the same
3991 user as the owner of the phpMyAdmin scripts.</p>
3992 </div>
3993 </dd></dl>
3995 <dl class="option">
3996 <dt id="cfg_TempDir">
3997 <tt class="descname">$cfg['TempDir']</tt><a class="headerlink" href="#cfg_TempDir" title="Permalink to this definition"></a></dt>
3998 <dd><table class="docutils field-list" frame="void" rules="none">
3999 <col class="field-name" />
4000 <col class="field-body" />
4001 <tbody valign="top">
4002 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
4003 </tr>
4004 <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>
4005 </tr>
4006 </tbody>
4007 </table>
4008 <p>The name of the directory where temporary files can be stored.</p>
4009 <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
4010 work around limitations of <tt class="docutils literal"><span class="pre">open_basedir</span></tt> for uploaded files, see
4011 <a class="reference internal" href="faq.html#faq1-11"><em>1.11 I get an &#8216;open_basedir restriction&#8217; while uploading a file from the query box.</em></a>.</p>
4012 <p>If the directory where phpMyAdmin is installed is
4013 subject to an <tt class="docutils literal"><span class="pre">open_basedir</span></tt> restriction, you need to create a
4014 temporary directory in some directory accessible by the web server.
4015 However for security reasons, this directory should be outside the
4016 tree published by webserver. If you cannot avoid having this directory
4017 published by webserver, place at least an empty <tt class="file docutils literal"><span class="pre">index.html</span></tt> file
4018 there, so that directory listing is not possible.</p>
4019 <p>This directory should have as strict permissions as possible as the only
4020 user required to access this directory is the one who runs the webserver.
4021 If you have root privileges, simply make this user owner of this directory
4022 and make it accessible only by it:</p>
4023 <div class="highlight-sh"><div class="highlight"><pre>chown www-data:www-data tmp
4024 chmod 700 tmp
4025 </pre></div>
4026 </div>
4027 <p>If you cannot change owner of the directory, you can achieve a similar
4028 setup using <a class="reference internal" href="glossary.html#term-acl"><em class="xref std std-term">ACL</em></a>:</p>
4029 <div class="highlight-sh"><div class="highlight"><pre>chmod 700 tmp
4030 setfacl -m <span class="s2">&quot;g:www-data:rwx&quot;</span> tmp
4031 setfacl -d -m <span class="s2">&quot;g:www-data:rwx&quot;</span> tmp
4032 </pre></div>
4033 </div>
4034 <p>If neither of above works for you, you can still make the directory
4035 <strong class="command">chmod 777</strong>, but it might impose risk of other users on system
4036 reading and writing data in this directory.</p>
4037 </dd></dl>
4039 </div>
4040 <div class="section" id="various-display-setting">
4041 <h2>Various display setting<a class="headerlink" href="#various-display-setting" title="Permalink to this headline"></a></h2>
4042 <dl class="option">
4043 <dt id="cfg_ShowDisplayDirection">
4044 <tt class="descname">$cfg['ShowDisplayDirection']</tt><a class="headerlink" href="#cfg_ShowDisplayDirection" title="Permalink to this definition"></a></dt>
4045 <dd><table class="docutils field-list" frame="void" rules="none">
4046 <col class="field-name" />
4047 <col class="field-body" />
4048 <tbody valign="top">
4049 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
4050 </tr>
4051 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
4052 </tr>
4053 </tbody>
4054 </table>
4055 <p>Defines whether or not type display direction option is shown when
4056 browsing a table.</p>
4057 </dd></dl>
4059 <dl class="option">
4060 <dt id="cfg_RepeatCells">
4061 <tt class="descname">$cfg['RepeatCells']</tt><a class="headerlink" href="#cfg_RepeatCells" title="Permalink to this definition"></a></dt>
4062 <dd><table class="docutils field-list" frame="void" rules="none">
4063 <col class="field-name" />
4064 <col class="field-body" />
4065 <tbody valign="top">
4066 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
4067 </tr>
4068 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">100</td>
4069 </tr>
4070 </tbody>
4071 </table>
4072 <p>Repeat the headers every X cells, or 0 to deactivate.</p>
4073 </dd></dl>
4075 <dl class="option">
4076 <dt id="cfg_EditInWindow">
4077 <tt class="descname">$cfg['EditInWindow']</tt><a class="headerlink" href="#cfg_EditInWindow" title="Permalink to this definition"></a></dt>
4078 <dd><table class="docutils field-list" frame="void" rules="none">
4079 <col class="field-name" />
4080 <col class="field-body" />
4081 <tbody valign="top">
4082 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
4083 </tr>
4084 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
4085 </tr>
4086 </tbody>
4087 </table>
4088 </dd></dl>
4090 <dl class="option">
4091 <dt id="cfg_QueryWindowWidth">
4092 <tt class="descname">$cfg['QueryWindowWidth']</tt><a class="headerlink" href="#cfg_QueryWindowWidth" title="Permalink to this definition"></a></dt>
4093 <dd><table class="docutils field-list" frame="void" rules="none">
4094 <col class="field-name" />
4095 <col class="field-body" />
4096 <tbody valign="top">
4097 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
4098 </tr>
4099 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">550</td>
4100 </tr>
4101 </tbody>
4102 </table>
4103 </dd></dl>
4105 <dl class="option">
4106 <dt id="cfg_QueryWindowHeight">
4107 <tt class="descname">$cfg['QueryWindowHeight']</tt><a class="headerlink" href="#cfg_QueryWindowHeight" title="Permalink to this definition"></a></dt>
4108 <dd><table class="docutils field-list" frame="void" rules="none">
4109 <col class="field-name" />
4110 <col class="field-body" />
4111 <tbody valign="top">
4112 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
4113 </tr>
4114 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">310</td>
4115 </tr>
4116 </tbody>
4117 </table>
4118 </dd></dl>
4120 <dl class="option">
4121 <dt id="cfg_QueryHistoryDB">
4122 <tt class="descname">$cfg['QueryHistoryDB']</tt><a class="headerlink" href="#cfg_QueryHistoryDB" title="Permalink to this definition"></a></dt>
4123 <dd><table class="docutils field-list" frame="void" rules="none">
4124 <col class="field-name" />
4125 <col class="field-body" />
4126 <tbody valign="top">
4127 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
4128 </tr>
4129 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
4130 </tr>
4131 </tbody>
4132 </table>
4133 </dd></dl>
4135 <dl class="option">
4136 <dt id="cfg_QueryWindowDefTab">
4137 <tt class="descname">$cfg['QueryWindowDefTab']</tt><a class="headerlink" href="#cfg_QueryWindowDefTab" title="Permalink to this definition"></a></dt>
4138 <dd><table class="docutils field-list" frame="void" rules="none">
4139 <col class="field-name" />
4140 <col class="field-body" />
4141 <tbody valign="top">
4142 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
4143 </tr>
4144 <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>
4145 </tr>
4146 </tbody>
4147 </table>
4148 </dd></dl>
4150 <dl class="option">
4151 <dt id="cfg_QueryHistoryMax">
4152 <tt class="descname">$cfg['QueryHistoryMax']</tt><a class="headerlink" href="#cfg_QueryHistoryMax" title="Permalink to this definition"></a></dt>
4153 <dd><table class="docutils field-list" frame="void" rules="none">
4154 <col class="field-name" />
4155 <col class="field-body" />
4156 <tbody valign="top">
4157 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
4158 </tr>
4159 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">25</td>
4160 </tr>
4161 </tbody>
4162 </table>
4163 <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
4164 icon is always displayed in the navigation panel. If JavaScript is enabled
4165 in your browser, a click on this opens a distinct query window, which is a
4166 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
4167 changes to display a query box.</p>
4168 <p>The size of this query window can be customized with
4169 <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
4170 <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
4171 pixels. Note that normally, those parameters will be modified in
4172 <tt class="file docutils literal"><span class="pre">layout.inc.php`</span></tt> for the theme you are using.</p>
4173 <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]
4174 from the results page (in the <em class="guilabel">Showing Rows</em> section) opens the
4175 query window and puts the current query inside it. If set to false,
4176 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
4177 in the right panel&#8217;s query box.</p>
4178 <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
4179 Queries are logged to a table, which has to be created by you (see
4180 <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
4181 queries will be appended to the form, but only as long as your window is
4182 opened they remain saved.</p>
4183 <p>When using the JavaScript based query window, it will always get updated
4184 when you click on a new table/db to browse and will focus if you click on
4185 <em class="guilabel">Edit SQL</em> after using a query. You can suppress updating the
4186 query window by checking the box <em class="guilabel">Do not overwrite this query
4187 from outside the window</em> below the query textarea. Then you can browse
4188 tables/databases in the background without losing the contents of the
4189 textarea, so this is especially useful when composing a query with tables
4190 you first have to look in. The checkbox will get automatically checked
4191 whenever you change the contents of the textarea. Please uncheck the button
4192 whenever you definitely want the query window to get updated even though
4193 you have made alterations.</p>
4194 <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
4195 specify the amount of saved history items using
4196 <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>
4197 <p>The query window also has a custom tabbed look to group the features.
4198 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
4199 specify the default tab to be used when opening the query window. It can be
4200 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>
4201 </dd></dl>
4203 <dl class="option">
4204 <dt id="cfg_BrowseMIME">
4205 <tt class="descname">$cfg['BrowseMIME']</tt><a class="headerlink" href="#cfg_BrowseMIME" title="Permalink to this definition"></a></dt>
4206 <dd><table class="docutils field-list" frame="void" rules="none">
4207 <col class="field-name" />
4208 <col class="field-body" />
4209 <tbody valign="top">
4210 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
4211 </tr>
4212 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
4213 </tr>
4214 </tbody>
4215 </table>
4216 <p>Enable <a class="reference internal" href="transformations.html#transformations"><em>Transformations</em></a>.</p>
4217 </dd></dl>
4219 <dl class="option">
4220 <dt id="cfg_MaxExactCount">
4221 <tt class="descname">$cfg['MaxExactCount']</tt><a class="headerlink" href="#cfg_MaxExactCount" title="Permalink to this definition"></a></dt>
4222 <dd><table class="docutils field-list" frame="void" rules="none">
4223 <col class="field-name" />
4224 <col class="field-body" />
4225 <tbody valign="top">
4226 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
4227 </tr>
4228 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">0</td>
4229 </tr>
4230 </tbody>
4231 </table>
4232 <p>For InnoDB tables, determines for how large tables phpMyAdmin should
4233 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
4234 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,
4235 <tt class="docutils literal"><span class="pre">SELECT</span> <span class="pre">COUNT</span></tt> will be used, otherwise the approximate count will be
4236 used.</p>
4237 </dd></dl>
4239 <dl class="option">
4240 <dt id="cfg_MaxExactCountViews">
4241 <tt class="descname">$cfg['MaxExactCountViews']</tt><a class="headerlink" href="#cfg_MaxExactCountViews" title="Permalink to this definition"></a></dt>
4242 <dd><table class="docutils field-list" frame="void" rules="none">
4243 <col class="field-name" />
4244 <col class="field-body" />
4245 <tbody valign="top">
4246 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td>
4247 </tr>
4248 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">0</td>
4249 </tr>
4250 </tbody>
4251 </table>
4252 <p>For VIEWs, since obtaining the exact count could have an impact on
4253 performance, this value is the maximum to be displayed, using a
4254 <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
4255 counting.</p>
4256 </dd></dl>
4258 <dl class="option">
4259 <dt id="cfg_NaturalOrder">
4260 <tt class="descname">$cfg['NaturalOrder']</tt><a class="headerlink" href="#cfg_NaturalOrder" title="Permalink to this definition"></a></dt>
4261 <dd><table class="docutils field-list" frame="void" rules="none">
4262 <col class="field-name" />
4263 <col class="field-body" />
4264 <tbody valign="top">
4265 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
4266 </tr>
4267 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
4268 </tr>
4269 </tbody>
4270 </table>
4271 <p>Sorts database and table names according to natural order (for
4272 example, t1, t2, t10). Currently implemented in the navigation panel
4273 and in Database view, for the table list.</p>
4274 </dd></dl>
4276 <dl class="option">
4277 <dt id="cfg_InitialSlidersState">
4278 <tt class="descname">$cfg['InitialSlidersState']</tt><a class="headerlink" href="#cfg_InitialSlidersState" title="Permalink to this definition"></a></dt>
4279 <dd><table class="docutils field-list" frame="void" rules="none">
4280 <col class="field-name" />
4281 <col class="field-body" />
4282 <tbody valign="top">
4283 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
4284 </tr>
4285 <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>
4286 </tr>
4287 </tbody>
4288 </table>
4289 <p>If set to <tt class="docutils literal"><span class="pre">'closed'</span></tt>, the visual sliders are initially in a closed
4290 state. A value of <tt class="docutils literal"><span class="pre">'open'</span></tt> does the reverse. To completely disable
4291 all visual sliders, use <tt class="docutils literal"><span class="pre">'disabled'</span></tt>.</p>
4292 </dd></dl>
4294 <dl class="option">
4295 <dt id="cfg_UserprefsDisallow">
4296 <tt class="descname">$cfg['UserprefsDisallow']</tt><a class="headerlink" href="#cfg_UserprefsDisallow" title="Permalink to this definition"></a></dt>
4297 <dd><table class="docutils field-list" frame="void" rules="none">
4298 <col class="field-name" />
4299 <col class="field-body" />
4300 <tbody valign="top">
4301 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td>
4302 </tr>
4303 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array()</td>
4304 </tr>
4305 </tbody>
4306 </table>
4307 <p>Contains names of configuration options (keys in <tt class="docutils literal"><span class="pre">$cfg</span></tt> array) that
4308 users can&#8217;t set through user preferences. For possible values, refer
4309 to <tt class="file docutils literal"><span class="pre">libraries/config/user_preferences.forms.php</span></tt>.</p>
4310 </dd></dl>
4312 <dl class="option">
4313 <dt id="cfg_UserprefsDeveloperTab">
4314 <tt class="descname">$cfg['UserprefsDeveloperTab']</tt><a class="headerlink" href="#cfg_UserprefsDeveloperTab" title="Permalink to this definition"></a></dt>
4315 <dd><table class="docutils field-list" frame="void" rules="none">
4316 <col class="field-name" />
4317 <col class="field-body" />
4318 <tbody valign="top">
4319 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
4320 </tr>
4321 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
4322 </tr>
4323 </tbody>
4324 </table>
4325 <p>Activates in the user preferences a tab containing options for
4326 developers of phpMyAdmin.</p>
4327 </dd></dl>
4329 </div>
4330 <div class="section" id="page-titles">
4331 <h2>Page titles<a class="headerlink" href="#page-titles" title="Permalink to this headline"></a></h2>
4332 <dl class="option">
4333 <dt id="cfg_TitleTable">
4334 <tt class="descname">$cfg['TitleTable']</tt><a class="headerlink" href="#cfg_TitleTable" title="Permalink to this definition"></a></dt>
4335 <dd><table class="docutils field-list" frame="void" rules="none">
4336 <col class="field-name" />
4337 <col class="field-body" />
4338 <tbody valign="top">
4339 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
4340 </tr>
4341 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'&#64;HTTP_HOST&#64;</span> <span class="pre">/</span> <span class="pre">&#64;VSERVER&#64;</span> <span class="pre">/</span> <span class="pre">&#64;DATABASE&#64;</span> <span class="pre">/</span> <span class="pre">&#64;TABLE&#64;</span> <span class="pre">|</span> <span class="pre">&#64;PHPMYADMIN&#64;'</span></tt></td>
4342 </tr>
4343 </tbody>
4344 </table>
4345 </dd></dl>
4347 <dl class="option">
4348 <dt id="cfg_TitleDatabase">
4349 <tt class="descname">$cfg['TitleDatabase']</tt><a class="headerlink" href="#cfg_TitleDatabase" title="Permalink to this definition"></a></dt>
4350 <dd><table class="docutils field-list" frame="void" rules="none">
4351 <col class="field-name" />
4352 <col class="field-body" />
4353 <tbody valign="top">
4354 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
4355 </tr>
4356 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'&#64;HTTP_HOST&#64;</span> <span class="pre">/</span> <span class="pre">&#64;VSERVER&#64;</span> <span class="pre">/</span> <span class="pre">&#64;DATABASE&#64;</span> <span class="pre">|</span> <span class="pre">&#64;PHPMYADMIN&#64;'</span></tt></td>
4357 </tr>
4358 </tbody>
4359 </table>
4360 </dd></dl>
4362 <dl class="option">
4363 <dt id="cfg_TitleServer">
4364 <tt class="descname">$cfg['TitleServer']</tt><a class="headerlink" href="#cfg_TitleServer" title="Permalink to this definition"></a></dt>
4365 <dd><table class="docutils field-list" frame="void" rules="none">
4366 <col class="field-name" />
4367 <col class="field-body" />
4368 <tbody valign="top">
4369 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
4370 </tr>
4371 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'&#64;HTTP_HOST&#64;</span> <span class="pre">/</span> <span class="pre">&#64;VSERVER&#64;</span> <span class="pre">|</span> <span class="pre">&#64;PHPMYADMIN&#64;'</span></tt></td>
4372 </tr>
4373 </tbody>
4374 </table>
4375 </dd></dl>
4377 <dl class="option">
4378 <dt id="cfg_TitleDefault">
4379 <tt class="descname">$cfg['TitleDefault']</tt><a class="headerlink" href="#cfg_TitleDefault" title="Permalink to this definition"></a></dt>
4380 <dd><table class="docutils field-list" frame="void" rules="none">
4381 <col class="field-name" />
4382 <col class="field-body" />
4383 <tbody valign="top">
4384 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
4385 </tr>
4386 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><tt class="docutils literal"><span class="pre">'&#64;HTTP_HOST&#64;</span> <span class="pre">|</span> <span class="pre">&#64;PHPMYADMIN&#64;'</span></tt></td>
4387 </tr>
4388 </tbody>
4389 </table>
4390 <p>Allows you to specify window&#8217;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>
4391 </dd></dl>
4393 </div>
4394 <div class="section" id="theme-manager-settings">
4395 <h2>Theme manager settings<a class="headerlink" href="#theme-manager-settings" title="Permalink to this headline"></a></h2>
4396 <dl class="option">
4397 <dt id="cfg_ThemePath">
4398 <tt class="descname">$cfg['ThemePath']</tt><a class="headerlink" href="#cfg_ThemePath" title="Permalink to this definition"></a></dt>
4399 <dd><table class="docutils field-list" frame="void" rules="none">
4400 <col class="field-name" />
4401 <col class="field-body" />
4402 <tbody valign="top">
4403 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
4404 </tr>
4405 <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>
4406 </tr>
4407 </tbody>
4408 </table>
4409 <p>If theme manager is active, use this as the path of the subdirectory
4410 containing all the themes.</p>
4411 </dd></dl>
4413 <dl class="option">
4414 <dt id="cfg_ThemeManager">
4415 <tt class="descname">$cfg['ThemeManager']</tt><a class="headerlink" href="#cfg_ThemeManager" title="Permalink to this definition"></a></dt>
4416 <dd><table class="docutils field-list" frame="void" rules="none">
4417 <col class="field-name" />
4418 <col class="field-body" />
4419 <tbody valign="top">
4420 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
4421 </tr>
4422 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">true</td>
4423 </tr>
4424 </tbody>
4425 </table>
4426 <p>Enables user-selectable themes. See <a class="reference internal" href="faq.html#faqthemes"><em>2.7 Using and creating themes</em></a>.</p>
4427 </dd></dl>
4429 <dl class="option">
4430 <dt id="cfg_ThemeDefault">
4431 <tt class="descname">$cfg['ThemeDefault']</tt><a class="headerlink" href="#cfg_ThemeDefault" title="Permalink to this definition"></a></dt>
4432 <dd><table class="docutils field-list" frame="void" rules="none">
4433 <col class="field-name" />
4434 <col class="field-body" />
4435 <tbody valign="top">
4436 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
4437 </tr>
4438 <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>
4439 </tr>
4440 </tbody>
4441 </table>
4442 <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>
4443 </dd></dl>
4445 <dl class="option">
4446 <dt id="cfg_ThemePerServer">
4447 <tt class="descname">$cfg['ThemePerServer']</tt><a class="headerlink" href="#cfg_ThemePerServer" title="Permalink to this definition"></a></dt>
4448 <dd><table class="docutils field-list" frame="void" rules="none">
4449 <col class="field-name" />
4450 <col class="field-body" />
4451 <tbody valign="top">
4452 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
4453 </tr>
4454 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
4455 </tr>
4456 </tbody>
4457 </table>
4458 <p>Whether to allow different theme for each server.</p>
4459 </dd></dl>
4461 </div>
4462 <div class="section" id="default-queries">
4463 <h2>Default queries<a class="headerlink" href="#default-queries" title="Permalink to this headline"></a></h2>
4464 <dl class="option">
4465 <dt id="cfg_DefaultQueryTable">
4466 <tt class="descname">$cfg['DefaultQueryTable']</tt><a class="headerlink" href="#cfg_DefaultQueryTable" title="Permalink to this definition"></a></dt>
4467 <dd><table class="docutils field-list" frame="void" rules="none">
4468 <col class="field-name" />
4469 <col class="field-body" />
4470 <tbody valign="top">
4471 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
4472 </tr>
4473 <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">&#64;TABLE&#64;</span> <span class="pre">WHERE</span> <span class="pre">1'</span></tt></td>
4474 </tr>
4475 </tbody>
4476 </table>
4477 </dd></dl>
4479 <dl class="option">
4480 <dt id="cfg_DefaultQueryDatabase">
4481 <tt class="descname">$cfg['DefaultQueryDatabase']</tt><a class="headerlink" href="#cfg_DefaultQueryDatabase" title="Permalink to this definition"></a></dt>
4482 <dd><table class="docutils field-list" frame="void" rules="none">
4483 <col class="field-name" />
4484 <col class="field-body" />
4485 <tbody valign="top">
4486 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
4487 </tr>
4488 <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>
4489 </tr>
4490 </tbody>
4491 </table>
4492 <p>Default queries that will be displayed in query boxes when user didn&#8217;t
4493 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>
4494 </dd></dl>
4496 </div>
4497 <div class="section" id="sql-parser-settings">
4498 <h2>SQL parser settings<a class="headerlink" href="#sql-parser-settings" title="Permalink to this headline"></a></h2>
4499 <dl class="option">
4500 <dt id="cfg_SQP_fmtType">
4501 <tt class="descname">$cfg['SQP']['fmtType']</tt><a class="headerlink" href="#cfg_SQP_fmtType" title="Permalink to this definition"></a></dt>
4502 <dd><table class="docutils field-list" frame="void" rules="none">
4503 <col class="field-name" />
4504 <col class="field-body" />
4505 <tbody valign="top">
4506 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
4507 </tr>
4508 <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>
4509 </tr>
4510 </tbody>
4511 </table>
4512 <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
4513 is to pretty-print <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> queries. By
4514 default we use HTML to format the query, but you can disable this by
4515 setting this variable to <tt class="docutils literal"><span class="pre">'none'</span></tt>.</p>
4516 <p>Available options:</p>
4517 <ul class="simple">
4518 <li><tt class="docutils literal"><span class="pre">'html'</span></tt></li>
4519 <li><tt class="docutils literal"><span class="pre">'none'</span></tt></li>
4520 </ul>
4521 </dd></dl>
4523 <span class="target" id="cfg-sqp"></span><dl class="option">
4524 <dt id="cfg_SQP_fmtInd">
4525 <tt class="descname">$cfg['SQP']['fmtInd']</tt><a class="headerlink" href="#cfg_SQP_fmtInd" title="Permalink to this definition"></a></dt>
4526 <dd><table class="docutils field-list" frame="void" rules="none">
4527 <col class="field-name" />
4528 <col class="field-body" />
4529 <tbody valign="top">
4530 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">float</td>
4531 </tr>
4532 <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>
4533 </tr>
4534 </tbody>
4535 </table>
4536 </dd></dl>
4538 <dl class="option">
4539 <dt id="cfg_SQP_fmtIndUnit">
4540 <tt class="descname">$cfg['SQP']['fmtIndUnit']</tt><a class="headerlink" href="#cfg_SQP_fmtIndUnit" title="Permalink to this definition"></a></dt>
4541 <dd><table class="docutils field-list" frame="void" rules="none">
4542 <col class="field-name" />
4543 <col class="field-body" />
4544 <tbody valign="top">
4545 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
4546 </tr>
4547 <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>
4548 </tr>
4549 </tbody>
4550 </table>
4551 <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,
4552 under some cases the part of a query inside a bracket is indented. By
4553 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
4554 of this indent.</p>
4555 <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
4556 specifies the units of the indent amount that you specified. This is used
4557 via stylesheets.</p>
4558 <p>You can use any HTML unit, for example:</p>
4559 <ul class="simple">
4560 <li><tt class="docutils literal"><span class="pre">'em'</span></tt></li>
4561 <li><tt class="docutils literal"><span class="pre">'ex'</span></tt></li>
4562 <li><tt class="docutils literal"><span class="pre">'pt'</span></tt></li>
4563 <li><tt class="docutils literal"><span class="pre">'px'</span></tt></li>
4564 </ul>
4565 </dd></dl>
4567 <dl class="option">
4568 <dt id="cfg_SQP_fmtColor">
4569 <tt class="descname">$cfg['SQP']['fmtColor']</tt><a class="headerlink" href="#cfg_SQP_fmtColor" title="Permalink to this definition"></a></dt>
4570 <dd><table class="docutils field-list" frame="void" rules="none">
4571 <col class="field-name" />
4572 <col class="field-body" />
4573 <tbody valign="top">
4574 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array of string tuples</td>
4575 </tr>
4576 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"></td>
4577 </tr>
4578 </tbody>
4579 </table>
4580 <p>This array is used to define the colours for each type of element of
4581 the pretty-printed <a class="reference internal" href="glossary.html#term-sql"><em class="xref std std-term">SQL</em></a> queries.
4582 The tuple format is <em>class</em> =&gt; [<em>HTML colour code</em> | <em>empty string</em>]</p>
4583 <p>If you specify an empty string for the color of a class, it is ignored
4584 in creating the stylesheet. You should not alter the class names, only
4585 the colour strings.</p>
4586 <p><strong>Class name key:</strong></p>
4587 <dl class="docutils">
4588 <dt>comment</dt>
4589 <dd>Applies to all comment sub-classes</dd>
4590 <dt>comment_mysql</dt>
4591 <dd>Comments as <tt class="docutils literal"><span class="pre">&quot;#...\n&quot;</span></tt></dd>
4592 <dt>comment_ansi</dt>
4593 <dd>Comments as <tt class="docutils literal"><span class="pre">&quot;--</span> <span class="pre">...\n&quot;</span></tt></dd>
4594 <dt>comment_c</dt>
4595 <dd>Comments as <tt class="docutils literal"><span class="pre">&quot;/*...*/&quot;</span></tt></dd>
4596 <dt>digit</dt>
4597 <dd>Applies to all digit sub-classes</dd>
4598 <dt>digit_hex</dt>
4599 <dd>Hexadecimal numbers</dd>
4600 <dt>digit_integer</dt>
4601 <dd>Integer numbers</dd>
4602 <dt>digit_float</dt>
4603 <dd>Floating point numbers</dd>
4604 <dt>punct</dt>
4605 <dd>Applies to all punctuation sub-classes</dd>
4606 <dt>punct_bracket_open_round</dt>
4607 <dd>Opening brackets <tt class="docutils literal"><span class="pre">&quot;(&quot;</span></tt></dd>
4608 <dt>punct_bracket_close_round</dt>
4609 <dd>Closing brackets <tt class="docutils literal"><span class="pre">&quot;)&quot;</span></tt></dd>
4610 <dt>punct_listsep</dt>
4611 <dd>List item Separator <tt class="docutils literal"><span class="pre">&quot;,&quot;</span></tt></dd>
4612 <dt>punct_qualifier</dt>
4613 <dd>Table/Column Qualifier <tt class="docutils literal"><span class="pre">&quot;.&quot;</span></tt></dd>
4614 <dt>punct_queryend</dt>
4615 <dd>End of query marker <tt class="docutils literal"><span class="pre">&quot;;&quot;</span></tt></dd>
4616 <dt>alpha</dt>
4617 <dd>Applies to all alphabetic classes</dd>
4618 <dt>alpha_columnType</dt>
4619 <dd>Identifiers matching a column type</dd>
4620 <dt>alpha_columnAttrib</dt>
4621 <dd>Identifiers matching a database/table/column attribute</dd>
4622 <dt>alpha_functionName</dt>
4623 <dd>Identifiers matching a MySQL function name</dd>
4624 <dt>alpha_reservedWord</dt>
4625 <dd>Identifiers matching any other reserved word</dd>
4626 <dt>alpha_variable</dt>
4627 <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">&quot;&#64;foo&quot;</span></tt></dd>
4628 <dt>alpha_identifier</dt>
4629 <dd>All other identifiers</dd>
4630 <dt>quote</dt>
4631 <dd>Applies to all quotation mark classes</dd>
4632 <dt>quote_double</dt>
4633 <dd>Double quotes <tt class="docutils literal"><span class="pre">&quot;</span></tt></dd>
4634 <dt>quote_single</dt>
4635 <dd>Single quotes <tt class="docutils literal"><span class="pre">'</span></tt></dd>
4636 <dt>quote_backtick</dt>
4637 <dd>Backtick quotes <tt class="docutils literal"><span class="pre">`</span></tt></dd>
4638 </dl>
4639 </dd></dl>
4641 </div>
4642 <div class="section" id="sql-validator-settings">
4643 <h2>SQL validator settings<a class="headerlink" href="#sql-validator-settings" title="Permalink to this headline"></a></h2>
4644 <dl class="option">
4645 <dt id="cfg_SQLValidator">
4646 <tt class="descname">$cfg['SQLValidator']</tt><a class="headerlink" href="#cfg_SQLValidator" title="Permalink to this definition"></a></dt>
4647 <dd><table class="docutils field-list" frame="void" rules="none">
4648 <col class="field-name" />
4649 <col class="field-body" />
4650 <tbody valign="top">
4651 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td>
4652 </tr>
4653 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array(...)</td>
4654 </tr>
4655 </tbody>
4656 </table>
4657 </dd></dl>
4659 <dl class="option">
4660 <dt id="cfg_SQLValidator_use">
4661 <tt class="descname">$cfg['SQLValidator']['use']</tt><a class="headerlink" href="#cfg_SQLValidator_use" title="Permalink to this definition"></a></dt>
4662 <dd><table class="docutils field-list" frame="void" rules="none">
4663 <col class="field-name" />
4664 <col class="field-body" />
4665 <tbody valign="top">
4666 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
4667 </tr>
4668 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
4669 </tr>
4670 </tbody>
4671 </table>
4672 <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
4673 published on <a class="reference external" href="http://developers.slashdot.org/article.pl?sid=02/02/19/1720246">Slashdot</a>. For
4674 help in setting up your system to use the service, see the
4675 <a class="reference internal" href="faq.html#faqsqlvalidator"><em>6.14 How do I set up the SQL Validator?</em></a>.</p>
4676 </dd></dl>
4678 <dl class="option">
4679 <dt id="cfg_SQLValidator_username">
4680 <tt class="descname">$cfg['SQLValidator']['username']</tt><a class="headerlink" href="#cfg_SQLValidator_username" title="Permalink to this definition"></a></dt>
4681 <dd><table class="docutils field-list" frame="void" rules="none">
4682 <col class="field-name" />
4683 <col class="field-body" />
4684 <tbody valign="top">
4685 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
4686 </tr>
4687 <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>
4688 </tr>
4689 </tbody>
4690 </table>
4691 </dd></dl>
4693 <dl class="option">
4694 <dt id="cfg_SQLValidator_password">
4695 <tt class="descname">$cfg['SQLValidator']['password']</tt><a class="headerlink" href="#cfg_SQLValidator_password" title="Permalink to this definition"></a></dt>
4696 <dd><table class="docutils field-list" frame="void" rules="none">
4697 <col class="field-name" />
4698 <col class="field-body" />
4699 <tbody valign="top">
4700 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td>
4701 </tr>
4702 <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>
4703 </tr>
4704 </tbody>
4705 </table>
4706 <p>The SOAP service allows you to log in with <tt class="docutils literal"><span class="pre">anonymous</span></tt> and any password,
4707 so we use those by default. Instead, if you have an account with them, you
4708 can put your login details here, and it will be used in place of the
4709 anonymous login.</p>
4710 </dd></dl>
4712 </div>
4713 <div class="section" id="mysql-settings">
4714 <h2>MySQL settings<a class="headerlink" href="#mysql-settings" title="Permalink to this headline"></a></h2>
4715 <dl class="option">
4716 <dt id="cfg_DefaultFunctions">
4717 <tt class="descname">$cfg['DefaultFunctions']</tt><a class="headerlink" href="#cfg_DefaultFunctions" title="Permalink to this definition"></a></dt>
4718 <dd><table class="docutils field-list" frame="void" rules="none">
4719 <col class="field-name" />
4720 <col class="field-body" />
4721 <tbody valign="top">
4722 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td>
4723 </tr>
4724 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array(...)</td>
4725 </tr>
4726 </tbody>
4727 </table>
4728 <p>Functions selected by default when inserting/changing row, Functions
4729 are defined for meta types as (FUNC_NUMBER, FUNC_DATE, FUNC_CHAR,
4730 FUNC_SPATIAL, FUNC_UUID) and for <tt class="docutils literal"><span class="pre">first_timestamp</span></tt>, which is used
4731 for first timestamp column in table.</p>
4732 </dd></dl>
4734 </div>
4735 <div class="section" id="developer">
4736 <h2>Developer<a class="headerlink" href="#developer" title="Permalink to this headline"></a></h2>
4737 <div class="admonition warning">
4738 <p class="first admonition-title">Warning</p>
4739 <p class="last">These settings might have huge effect on performance or security.</p>
4740 </div>
4741 <dl class="option">
4742 <dt id="cfg_DBG">
4743 <tt class="descname">$cfg['DBG']</tt><a class="headerlink" href="#cfg_DBG" title="Permalink to this definition"></a></dt>
4744 <dd><table class="docutils field-list" frame="void" rules="none">
4745 <col class="field-name" />
4746 <col class="field-body" />
4747 <tbody valign="top">
4748 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td>
4749 </tr>
4750 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">array(...)</td>
4751 </tr>
4752 </tbody>
4753 </table>
4754 </dd></dl>
4756 <dl class="option">
4757 <dt id="cfg_DBG_sql">
4758 <tt class="descname">$cfg['DBG']['sql']</tt><a class="headerlink" href="#cfg_DBG_sql" title="Permalink to this definition"></a></dt>
4759 <dd><table class="docutils field-list" frame="void" rules="none">
4760 <col class="field-name" />
4761 <col class="field-body" />
4762 <tbody valign="top">
4763 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
4764 </tr>
4765 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
4766 </tr>
4767 </tbody>
4768 </table>
4769 <p>Enable logging queries and execution times to be
4770 displayed in the bottom of main page (right frame).</p>
4771 </dd></dl>
4773 <dl class="option">
4774 <dt id="cfg_Error_Handler_display">
4775 <tt class="descname">$cfg['Error_Handler']['display']</tt><a class="headerlink" href="#cfg_Error_Handler_display" title="Permalink to this definition"></a></dt>
4776 <dd><table class="docutils field-list" frame="void" rules="none">
4777 <col class="field-name" />
4778 <col class="field-body" />
4779 <tbody valign="top">
4780 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
4781 </tr>
4782 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
4783 </tr>
4784 </tbody>
4785 </table>
4786 <p>Whether to display errors from PHP or not.</p>
4787 </dd></dl>
4789 <dl class="option">
4790 <dt id="cfg_Error_Handler_gather">
4791 <tt class="descname">$cfg['Error_Handler']['gather']</tt><a class="headerlink" href="#cfg_Error_Handler_gather" title="Permalink to this definition"></a></dt>
4792 <dd><table class="docutils field-list" frame="void" rules="none">
4793 <col class="field-name" />
4794 <col class="field-body" />
4795 <tbody valign="top">
4796 <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
4797 </tr>
4798 <tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td>
4799 </tr>
4800 </tbody>
4801 </table>
4802 <p>Whether to gather errors from PHP or not.</p>
4803 </dd></dl>
4805 </div>
4806 </div>
4809 </div>
4810 </div>
4811 </div>
4812 <div class="sphinxsidebar">
4813 <div class="sphinxsidebarwrapper">
4814 <h3><a href="index.html">Table Of Contents</a></h3>
4815 <ul>
4816 <li><a class="reference internal" href="#">Configuration</a><ul>
4817 <li><a class="reference internal" href="#basic-settings">Basic settings</a></li>
4818 <li><a class="reference internal" href="#server-connection-settings">Server connection settings</a></li>
4819 <li><a class="reference internal" href="#generic-settings">Generic settings</a></li>
4820 <li><a class="reference internal" href="#cookie-authentication-options">Cookie authentication options</a></li>
4821 <li><a class="reference internal" href="#navigation-panel-setup">Navigation panel setup</a></li>
4822 <li><a class="reference internal" href="#main-panel">Main panel</a></li>
4823 <li><a class="reference internal" href="#database-structure">Database structure</a></li>
4824 <li><a class="reference internal" href="#browse-mode">Browse mode</a></li>
4825 <li><a class="reference internal" href="#editing-mode">Editing mode</a></li>
4826 <li><a class="reference internal" href="#export-and-import-settings">Export and import settings</a></li>
4827 <li><a class="reference internal" href="#tabs-display-settings">Tabs display settings</a></li>
4828 <li><a class="reference internal" href="#documentation">Documentation</a></li>
4829 <li><a class="reference internal" href="#languages">Languages</a></li>
4830 <li><a class="reference internal" href="#web-server-settings">Web server settings</a></li>
4831 <li><a class="reference internal" href="#theme-settings">Theme settings</a></li>
4832 <li><a class="reference internal" href="#design-customization">Design customization</a></li>
4833 <li><a class="reference internal" href="#text-fields">Text fields</a></li>
4834 <li><a class="reference internal" href="#sql-query-box-settings">SQL query box settings</a></li>
4835 <li><a class="reference internal" href="#web-server-upload-save-import-directories">Web server upload/save/import directories</a></li>
4836 <li><a class="reference internal" href="#various-display-setting">Various display setting</a></li>
4837 <li><a class="reference internal" href="#page-titles">Page titles</a></li>
4838 <li><a class="reference internal" href="#theme-manager-settings">Theme manager settings</a></li>
4839 <li><a class="reference internal" href="#default-queries">Default queries</a></li>
4840 <li><a class="reference internal" href="#sql-parser-settings">SQL parser settings</a></li>
4841 <li><a class="reference internal" href="#sql-validator-settings">SQL validator settings</a></li>
4842 <li><a class="reference internal" href="#mysql-settings">MySQL settings</a></li>
4843 <li><a class="reference internal" href="#developer">Developer</a></li>
4844 </ul>
4845 </li>
4846 </ul>
4848 <h4>Previous topic</h4>
4849 <p class="topless"><a href="setup.html"
4850 title="previous chapter">Installation</a></p>
4851 <h4>Next topic</h4>
4852 <p class="topless"><a href="user.html"
4853 title="next chapter">User Guide</a></p>
4854 <h3>This Page</h3>
4855 <ul class="this-page-menu">
4856 <li><a href="_sources/config.txt"
4857 rel="nofollow">Show Source</a></li>
4858 </ul>
4859 <div id="searchbox" style="display: none">
4860 <h3>Quick search</h3>
4861 <form class="search" action="search.html" method="get">
4862 <input type="text" name="q" />
4863 <input type="submit" value="Go" />
4864 <input type="hidden" name="check_keywords" value="yes" />
4865 <input type="hidden" name="area" value="default" />
4866 </form>
4867 <p class="searchtip" style="font-size: 90%">
4868 Enter search terms or a module, class or function name.
4869 </p>
4870 </div>
4871 <script type="text/javascript">$('#searchbox').show(0);</script>
4872 </div>
4873 </div>
4874 <div class="clearer"></div>
4875 </div>
4876 <div class="related">
4877 <h3>Navigation</h3>
4878 <ul>
4879 <li class="right" style="margin-right: 10px">
4880 <a href="genindex.html" title="General Index"
4881 >index</a></li>
4882 <li class="right" >
4883 <a href="user.html" title="User Guide"
4884 >next</a> |</li>
4885 <li class="right" >
4886 <a href="setup.html" title="Installation"
4887 >previous</a> |</li>
4888 <li><a href="index.html">phpMyAdmin 4.0.4 documentation</a> &raquo;</li>
4889 </ul>
4890 </div>
4891 <div class="footer">
4892 &copy; <a href="copyright.html">Copyright</a> 2012 - 2013, The phpMyAdmin devel team.
4893 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
4894 </div>
4895 </body>
4896 </html>