Translated using Weblate.
[phpmyadmin.git] / Documentation.html
blob984c53ba087c668acb54fda7896a96e158d87be9
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <!--
4 vim: expandtab ts=4 sw=4 sts=4 tw=78
5 -->
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US"
7 version="-//W3C//DTD XHTML 1.1//EN" dir="ltr">
8 <head>
9 <link rel="icon" href="./favicon.ico" type="image/x-icon" />
10 <link rel="shortcut icon" href="./favicon.ico" type="image/x-icon" />
11 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
12 <title>phpMyAdmin 4.0.0-dev - Documentation</title>
13 <link rel="stylesheet" type="text/css" href="docs.css" />
14 </head>
16 <body id="top">
17 <div id="header">
18 <h1>
19 <a href="http://www.phpmyadmin.net/">php<span class="myadmin">MyAdmin</span></a>
20 4.0.0-dev
21 Documentation
22 </h1>
23 </div>
25 <!-- TOP MENU -->
26 <ul class="header">
27 <li><a href="Documentation.html#top">Top</a></li>
28 <li><a href="Documentation.html#require">Requirements</a></li>
29 <li><a href="Documentation.html#intro">Introduction</a></li>
30 <li><a href="Documentation.html#setup">Installation</a></li>
31 <li><a href="Documentation.html#setup_script">Setup script</a></li>
32 <li><a href="Documentation.html#config">Configuration</a></li>
33 <li><a href="Documentation.html#transformations">Transformations</a></li>
34 <li><a href="Documentation.html#faq"><abbr title="Frequently Asked Questions"> FAQ</abbr></a></li>
35 <li><a href="Documentation.html#developers">Developers</a></li>
36 <li><a href="Documentation.html#copyright">Copyright</a></li>
37 <li><a href="Documentation.html#credits">Credits</a></li>
38 <li><a href="Documentation.html#glossary">Glossary</a></li>
39 </ul>
41 <div id="body">
43 <ul><li><a href="http://www.phpmyadmin.net/">
44 phpMyAdmin homepage</a></li>
45 <li><a href="https://sourceforge.net/projects/phpmyadmin/">
46 SourceForge phpMyAdmin project page</a></li>
47 <li><a href="http://wiki.phpmyadmin.net">
48 Official phpMyAdmin wiki</a></li>
49 <li><a href="https://github.com/phpmyadmin">
50 Git repositories on Github</a></li>
51 <li>Local documents:
52 <ul><li>Version history: <a href="changelog.php">ChangeLog</a></li>
53 <li>License: <a href="license.php">LICENSE</a></li>
54 </ul>
55 </li>
56 </ul>
58 <!-- REQUIREMENTS -->
59 <h2 id="require">Requirements</h2>
61 <ul><li><b>PHP</b>
62 <ul><li>You need PHP 5.2.0 or newer, with <tt>session</tt> support
63 (<a href="#faq1_31">see
64 <abbr title="Frequently Asked Questions">FAQ</abbr> 1.31</a>)
65 , the Standard PHP Library (SPL) extension and JSON support.
66 </li>
67 <li>To support uploading of ZIP files, you need the PHP <tt>zip</tt> extension.</li>
68 <li>For proper support of multibyte strings (eg. UTF-8, which is
69 currently the default), you should install the mbstring and ctype
70 extensions.
71 </li>
72 <li>You need GD2 support in PHP to display inline
73 thumbnails of JPEGs (&quot;image/jpeg: inline&quot;) with their
74 original aspect ratio</li>
75 <li>When using the &quot;cookie&quot;
76 <a href="#authentication_modes">authentication method</a>, the
77 <a href="http://www.php.net/mcrypt"><tt>mcrypt</tt></a> extension
78 is strongly suggested for most users and is <b>required</b> for
79 64&#8211;bit machines. Not using mcrypt will cause phpMyAdmin to
80 load pages significantly slower.
81 </li>
82 <li>To support upload progress bars, see <a href="#faq2_9">
83 <abbr title="Frequently Asked Questions">FAQ</abbr> 2.9</a>.</li>
84 <li>To support XML and Open Document Spreadsheet importing,
85 you need PHP 5.2.17 or newer and the
86 <a href="http://www.php.net/libxml"><tt>libxml</tt></a> extension.</li>
87 </ul>
88 </li>
89 <li><b>MySQL</b> 5.0 or newer (<a href="#faq1_17">details</a>);</li>
90 <li><b>Web browser</b> with cookies enabled.</li>
91 </ul>
93 <!-- INTRODUCTION -->
94 <h2 id="intro">Introduction</h2>
96 <p> phpMyAdmin can manage a whole MySQL server (needs a super-user) as well as
97 a single database. To accomplish the latter you'll need a properly set up
98 MySQL user who can read/write only the desired database. It's up to you to
99 look up the appropriate part in the MySQL manual.
100 </p>
102 <h3>Currently phpMyAdmin can:</h3>
104 <ul><li>browse and drop databases, tables, views, columns and indexes</li>
105 <li>create, copy, drop, rename and alter databases, tables, columns and
106 indexes</li>
107 <li>maintenance server, databases and tables, with proposals on server
108 configuration</li>
109 <li>execute, edit and bookmark any
110 <abbr title="structured query language">SQL</abbr>-statement, even
111 batch-queries</li>
112 <li>load text files into tables</li>
113 <li>create<a href="#footnote_1"><sup>1</sup></a> and read dumps of tables
114 </li>
115 <li>export<a href="#footnote_1"><sup>1</sup></a> data to various formats:
116 <abbr title="Comma Separated Values">CSV</abbr>,
117 <abbr title="Extensible Markup Language">XML</abbr>,
118 <abbr title="Portable Document Format">PDF</abbr>,
119 <abbr title="International Standards Organisation">ISO</abbr>/<abbr
120 title="International Electrotechnical Commission">IEC</abbr> 26300 -
121 OpenDocument Text and Spreadsheet,
122 <abbr title="Microsoft Word 2000">Word</abbr>,
123 and L<sup>A</sup>T<sub><big>E</big></sub>X formats
124 </li>
125 <li>import data and MySQL structures from OpenDocument spreadsheets, as well as <abbr title="Extensible Markup Language">XML</abbr>, <abbr title="Comma Separated Values">CSV</abbr>, and <abbr title="Server Query Language">SQL</abbr> files</li>
126 <li>administer multiple servers</li>
127 <li>manage MySQL users and privileges</li>
128 <li>check referential integrity in MyISAM tables</li>
129 <li>using Query-by-example (QBE), create complex queries automatically
130 connecting required tables</li>
131 <li>create <abbr title="Portable Document Format">PDF</abbr> graphics of
132 your Database layout</li>
133 <li>search globally in a database or a subset of it</li>
134 <li>transform stored data into any format using a set of predefined
135 functions, like displaying BLOB-data as image or download-link
136 </li>
137 <li>track changes on databases, tables and views</li>
138 <li>support InnoDB tables and foreign keys <a href="#faq3_6">(see
139 <abbr title="Frequently Asked Questions">FAQ</abbr> 3.6)</a></li>
140 <li>support mysqli, the improved MySQL extension <a href="#faq1_17">
141 (see <abbr title="Frequently Asked Questions">FAQ</abbr> 1.17)</a></li>
142 <li>create, edit, call, export and drop stored procedures and functions</li>
143 <li>create, edit, export and drop events and triggers</li>
144 <li>communicate in <a href="http://www.phpmyadmin.net/home_page/translations.php">62 different languages</a>
145 </li>
146 <li>synchronize two databases residing on the same as well as remote servers
147 <a href="#faq9_1">(see <abbr title="Frequently Asked Questions">FAQ</abbr> 9.1)</a>
148 </li>
150 </ul>
152 <h4>A word about users:</h4>
153 <p> Many people have difficulty
154 understanding the concept of user management with regards to phpMyAdmin. When
155 a user logs in to phpMyAdmin, that username and password are passed directly
156 to MySQL. phpMyAdmin does no account management on its own (other than
157 allowing one to manipulate the MySQL user account information); all users
158 must be valid MySQL users.</p>
160 <p class="footnote" id="footnote_1">
161 <sup>1)</sup> phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats)
162 dumps and <abbr title="comma separated values">CSV</abbr> exports if you use
163 PHP with Zlib support (<tt>--with-zlib</tt>) and/or Bzip2 support
164 (<tt>--with-bz2</tt>). Proper support may also need changes in
165 <tt>php.ini</tt>.</p>
167 <!-- INSTALLATION -->
168 <h2 id="setup">Installation</h2>
170 <ol><li><a href="#quick_install">Quick Install</a></li>
171 <li><a href="#setup_script">Setup script usage</a></li>
172 <li><a href="#linked-tables">phpMyAdmin configuration storage</a></li>
173 <li><a href="#upgrading">Upgrading from an older version</a></li>
174 <li><a href="#authentication_modes">Using authentication modes</a></li>
175 </ol>
177 <p class="important">
178 phpMyAdmin does not apply any special security methods to the MySQL database
179 server. It is still the system administrator's job to grant permissions on
180 the MySQL databases properly. phpMyAdmin's &quot;Privileges&quot; page can
181 be used for this.
182 </p>
184 <p class="important">
185 Warning for <acronym title="Apple Macintosh">Mac</acronym> users:<br />
186 if you are on a <acronym title="Apple Macintosh">Mac</acronym>
187 <abbr title="operating system">OS</abbr> version before
188 <abbr title="operating system">OS</abbr> X, StuffIt unstuffs with
189 <acronym title="Apple Macintosh">Mac</acronym> formats.<br />
190 So you'll have to resave as in BBEdit to Unix style ALL phpMyAdmin scripts
191 before uploading them to your server, as PHP seems not to like
192 <acronym title="Apple Macintosh">Mac</acronym>-style end of lines character
193 (&quot;<tt>\r</tt>&quot;).</p>
195 <h3 id="quick_install">Quick Install</h3>
196 <ol><li>Choose an appropriate distribution kit from the phpmyadmin.net
197 Downloads page. Some kits contain only the English messages,
198 others contain all languages in UTF-8 format (this should be fine
199 in most situations), others contain all
200 languages and all character sets. We'll assume you chose a kit whose
201 name looks like <tt>phpMyAdmin-x.x.x-all-languages.tar.gz</tt>.
202 </li>
203 <li>Untar or unzip the distribution (be sure to unzip the subdirectories):
204 <tt>tar -xzvf phpMyAdmin_x.x.x-all-languages.tar.gz</tt> in your webserver's
205 document root. If you don't have direct access to your document root,
206 put the files in a directory on your local machine, and, after step 4,
207 transfer the directory on your web server using, for example, ftp.</li>
208 <li>Ensure that all the scripts have the appropriate owner (if PHP is
209 running in safe mode, having some scripts with an owner different
210 from the owner of other scripts will be a
211 problem). See <a href="#faq4_2">
212 <abbr title="Frequently Asked Questions">FAQ</abbr> 4.2</a> and
213 <a href="#faq1_26"><abbr title="Frequently Asked Questions">FAQ</abbr>
214 1.26</a> for suggestions.</li>
215 <li>Now you must configure your installation. There are two methods that
216 can be used. Traditionally, users have hand-edited a copy of
217 <tt>config.inc.php</tt>, but now a wizard-style setup script is
218 provided for those who prefer a graphical installation. Creating a
219 <tt>config.inc.php</tt> is still a quick way to get started and needed for some advanced features.
220 <ul><li>To manually create the file, simply use your text editor to
221 create the file <tt>config.inc.php</tt> (you can copy
222 <tt>config.sample.inc.php</tt> to get minimal configuration
223 file) in the main (top-level) phpMyAdmin directory (the one
224 that contains <tt>index.php</tt>). phpMyAdmin first loads
225 <tt>libraries/config.default.php</tt> and then overrides those
226 values with anything found in <tt>config.inc.php</tt>. If the
227 default value is okay for a particular setting, there is no
228 need to include it in <tt>config.inc.php</tt>. You'll need a
229 few directives to get going, a simple configuration may look
230 like this:
231 <pre>
232 &lt;?php
233 $cfg['blowfish_secret'] = 'ba17c1ec07d65003'; // use here a value of your choice
235 $i=0;
236 $i++;
237 $cfg['Servers'][$i]['auth_type'] = 'cookie';
238 ?&gt;
239 </pre>
240 Or, if you prefer to not be prompted every time you log in:
241 <pre>
242 &lt;?php
244 $i=0;
245 $i++;
246 $cfg['Servers'][$i]['user'] = 'root';
247 $cfg['Servers'][$i]['password'] = 'cbb74bc'; // use here your password
248 $cfg['Servers'][$i]['auth_type'] = 'config';
249 ?&gt;
250 </pre>
251 For a full explanation of possible configuration values, see the
252 <a href="#config">Configuration Section</a> of this document.</li>
253 <li id="setup_script">Instead of manually editing
254 <tt>config.inc.php</tt>, you can use the
255 <a href="setup/">Setup Script</a>. First you must
256 manually create a folder <tt>config</tt> in the phpMyAdmin
257 directory. This is a security measure. On a Linux/Unix system you
258 can use the following commands:
259 <pre>
260 cd phpMyAdmin
261 mkdir config # create directory for saving
262 chmod o+rw config # give it world writable permissions
263 </pre>
264 And to edit an existing configuration, copy it over first:
265 <pre>
266 cp config.inc.php config/ # copy current configuration for editing
267 chmod o+w config/config.inc.php # give it world writable permissions
268 </pre>
269 On other platforms, simply create the folder and ensure that your
270 web server has read and write access to it. <a href="#faq1_26">FAQ
271 1.26</a> can help with this.<br /><br />
273 Next, open <tt><a href="setup/">setup/</a>
274 </tt>in your browser. Note that <strong>changes are not saved to
275 disk until explicitly choose <tt>Save</tt></strong> from the
276 <i>Configuration</i> area of the screen. Normally the script saves
277 the new config.inc.php to the <tt>config/</tt> directory, but if
278 the webserver does not have the proper permissions you may see the
279 error "Cannot load or save configuration." Ensure that the <tt>
280 config/</tt> directory exists and has the proper permissions -
281 or use the <tt>Download</tt> link to save the config file locally
282 and upload (via FTP or some similar means) to the proper location.<br /><br />
284 Once the file has been saved, it must be moved out of the <tt>
285 config/</tt> directory and the permissions must be reset, again
286 as a security measure:
287 <pre>
288 mv config/config.inc.php . # move file to current directory
289 chmod o-rw config.inc.php # remove world read and write permissions
290 rm -rf config # remove not needed directory
291 </pre>
292 Now the file is ready to be used. You can choose to review or edit
293 the file with your favorite editor, if you prefer to set some
294 advanced options which the setup script does not provide.</li></ul></li>
295 <li>If you are using the
296 <tt>auth_type</tt> &quot;config&quot;, it is suggested that you
297 protect the phpMyAdmin installation directory because using
298 config does not require a user to
299 enter a password to access the phpMyAdmin installation. Use of an alternate
300 authentication method is recommended, for example with
301 HTTP&#8211;AUTH in a <a href="#glossary"><i>.htaccess</i></a> file or switch to using
302 <tt>auth_type</tt> cookie or http. See the
303 <a href="#faqmultiuser"> multi&#8211;user sub&#8211;section</a> of this
304 <abbr title="Frequently Asked Questions">FAQ</abbr> for additional
305 information, especially <a href="#faq4_4">
306 <abbr title="Frequently Asked Questions">FAQ</abbr> 4.4</a>.</li>
307 <li>Open the <a href="index.php">main phpMyAdmin directory</a>
308 in your browser. phpMyAdmin should now display a welcome screen
309 and your databases, or a login dialog if using
310 <abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie
311 authentication mode.</li>
312 <li>You should deny access to the <tt>./libraries</tt> and
313 <tt>./setup/lib</tt> subfolders in your webserver configuration. For
314 Apache you can use supplied <a href="#glossary"><i>.htaccess</i></a> file in that folder, for other
315 webservers, you should configure this yourself. Such configuration
316 prevents from possible path exposure and cross side scripting
317 vulnerabilities that might happen to be found in that code.</li>
318 <li>
319 It is generally good idea to protect public phpMyAdmin installation
320 against access by robots as they usually can not do anything good
321 there. You can do this using <code>robots.txt</code> file in root of
322 your webserver or limit access by web server configuration, see
323 <a href="#faq1_42"><abbr title="Frequently Asked Questions">FAQ</abbr> 1.42</a>.
324 </li>
325 </ol>
327 <h3 id="linked-tables">phpMyAdmin configuration storage</h3>
329 <p> For a whole set of new features (bookmarks, comments,
330 <abbr title="structured query language">SQL</abbr>-history,
331 tracking mechanism,
332 <abbr title="Portable Document Format">PDF</abbr>-generation, column contents
333 transformation, etc.) you need to create a set of special tables. Those
334 tables can be located in your own database, or in a central database for a
335 multi-user installation (this database would then be accessed by the
336 controluser, so no other user should have rights to it).</p>
338 <p> Please look at your <tt>./examples/</tt> directory, where you should find a
339 file called <i>create_tables.sql</i>. (If you are using a Windows server, pay
340 special attention to <a href="#faq1_23">
341 <abbr title="Frequently Asked Questions">FAQ</abbr> 1.23</a>).</p>
343 <p> If you already had this infrastructure and upgraded to MySQL 4.1.2
344 or newer, please use <i>./examples/upgrade_tables_mysql_4_1_2+.sql</i>
345 and then create new tables by importing <i>./examples/create_tables.sql</i>.</p>
347 <p> You can use your phpMyAdmin to create the tables for you. Please be aware
348 that you may need special (administrator) privileges to create the database
349 and tables, and that the script may need some tuning, depending on the
350 database name.</p>
352 <p> After having imported the <i>./examples/create_tables.sql</i> file, you
353 should specify the table names in your <i>./config.inc.php</i> file. The
354 directives used for that can be found in the <a href="#config">Configuration
355 section</a>. You will also need to have a controluser with the proper rights
356 to those tables (see section <a href="#authentication_modes">Using
357 authentication modes</a> below).</p>
359 <h3 id="upgrading">Upgrading from an older version</h3>
361 <p> Simply copy <i>./config.inc.php</i> from your previous installation into the newly
362 unpacked one. Configuration files from old versions may
363 require some tweaking as some options have been changed or removed; in
364 particular, the definition of <tt>$cfg['AttributeTypes']</tt> has changed
365 so you better remove it from your file and just use the default one.
366 For compatibility with PHP 6, remove a <tt>set_magic_quotes_runtime(0);</tt>
367 statement that you might find near the end of your configuration file.</p>
369 <p> You should <strong>not</strong> copy <tt>libraries/config.default.php</tt>
370 over <tt>config.inc.php</tt> because the default configuration file
371 is version-specific.</p>
373 <p> If you have upgraded your MySQL server from a version previous to 4.1.2 to
374 version 5.x or newer and if you use the phpMyAdmin configuration storage,
375 you should run the <abbr title="structured query language">SQL</abbr> script
376 found in <tt>examples/upgrade_tables_mysql_4_1_2+.sql</tt>.</p>
378 <h3 id="authentication_modes">Using authentication modes</h3>
380 <ul><li><abbr title="HyperText Transfer Protocol">HTTP</abbr> and cookie
381 authentication modes are recommended in a <b>multi-user environment</b>
382 where you want to give users access to their own database and don't want
383 them to play around with others.<br />
384 Nevertheless be aware that MS Internet Explorer seems to be really buggy
385 about cookies, at least till version 6.<br />
386 Even in a <b>single-user environment</b>, you might prefer to use
387 <abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie mode so
388 that your user/password pair are not in clear in the configuration file.
389 </li>
391 <li><abbr title="HyperText Transfer Protocol">HTTP</abbr> and cookie
392 authentication modes are more secure: the MySQL login information does
393 not need to be set in the phpMyAdmin configuration file (except possibly
394 for the <a href="#controluser">controluser</a>).<br />
395 However, keep in mind that the password travels in plain text, unless
396 you are using the HTTPS protocol.<br />
397 In cookie mode, the password is stored, encrypted with the blowfish
398 algorithm, in a temporary cookie.</li>
400 <li id="pmausr">Note: this section is only applicable if
401 your MySQL server is running with <tt>--skip-show-database</tt>.<br /><br />
403 For '<abbr title="HyperText Transfer Protocol">HTTP</abbr>' and 'cookie'
404 modes, phpMyAdmin needs a controluser that has <b>only</b> the
405 <tt>SELECT</tt> privilege on the <i>`mysql`.`user` (all columns except
406 `Password`)</i>, <i>`mysql`.`db` (all columns)</i>, <i>`mysql`.`host`
407 (all columns)</i> and <i>`mysql`.`tables_priv` (all columns except
408 `Grantor` and `Timestamp`)</i> tables.<br /> You must specify the details
409 for the <a href="#controluser">controluser</a> in the <tt>config.inc.php</tt>
410 file under the
411 <tt><a href="#cfg_Servers_controluser" class="configrule">
412 $cfg['Servers'][$i]['controluser']</a></tt> and
413 <tt><a href="#cfg_Servers_controlpass" class="configrule">
414 $cfg['Servers'][$i]['controlpass']</a></tt> settings.<br />
415 The following example assumes you want to use <tt>pma</tt> as the
416 controluser and <tt>pmapass</tt> as the controlpass, but <b>this is
417 only an example: use something else in your file!</b> Input these
418 statements from the phpMyAdmin <abbr title="structured query language">SQL
419 </abbr> Query window or mysql command&#8211;line client.<br />
420 Of course you have to replace <tt>localhost</tt> with the webserver's host
421 if it's not the same as the MySQL server's one.
423 <pre>
424 GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY 'pmapass';
425 GRANT SELECT (
426 Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
427 Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
428 File_priv, Grant_priv, References_priv, Index_priv, Alter_priv,
429 Show_db_priv, Super_priv, Create_tmp_table_priv, Lock_tables_priv,
430 Execute_priv, Repl_slave_priv, Repl_client_priv
431 ) ON mysql.user TO 'pma'@'localhost';
432 GRANT SELECT ON mysql.db TO 'pma'@'localhost';
433 GRANT SELECT ON mysql.host TO 'pma'@'localhost';
434 GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv)
435 ON mysql.tables_priv TO 'pma'@'localhost';</pre>
437 If you want to use the many new relation and bookmark features:
439 <pre>
440 GRANT SELECT, INSERT, UPDATE, DELETE ON &lt;pma_db&gt;.* TO 'pma'@'localhost';
441 </pre>
443 (this of course requires that your <a href="#linked-tables">phpMyAdmin
444 configuration storage</a> be set up).
445 <br /></li>
447 <li>Then each of the <i>true</i> users should be granted a set of privileges
448 on a set of particular databases. Normally you shouldn't give global
449 privileges to an ordinary user, unless you understand the impact of those
450 privileges (for example, you are creating a superuser).<br />
451 For example, to grant the user <i>real_user</i> with all privileges on
452 the database <i>user_base</i>:<br />
454 <pre>
455 GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost IDENTIFIED BY 'real_password';
456 </pre>
458 What the user may now do is controlled entirely by the MySQL user
459 management system.<br />
460 With <abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie
461 authentication mode, you don't need to fill the user/password fields
462 inside the <a href="#cfg_Servers" class="configrule">$cfg['Servers']</a>
463 array.</li>
464 </ul>
466 <h4>'<abbr title="HyperText Transfer Protocol">HTTP</abbr>' authentication mode</h4>
468 <ul><li>Uses <abbr title="HyperText Transfer Protocol">HTTP</abbr> Basic authentication
469 method and allows you to log in as any valid MySQL user.</li>
470 <li>Is supported with most PHP configurations. For
471 <abbr title="Internet Information Services">IIS</abbr>
472 (<abbr title="Internet Server Application Programming Interface">ISAPI</abbr>)
473 support using <abbr title="Common Gateway Interface">CGI</abbr> PHP see
474 <a href="#faq1_32"><abbr title="Frequently Asked Questions">FAQ</abbr>
475 1.32</a>, for using with Apache
476 <abbr title="Common Gateway Interface">CGI</abbr> see
477 <a href="#faq1_35"><abbr title="Frequently Asked Questions">FAQ</abbr>
478 1.35</a>.</li>
479 <li>See also <a href="#faq4_4">
480 <abbr title="Frequently Asked Questions">FAQ</abbr> 4.4</a> about not
481 using the <a href="#glossary"><i>.htaccess</i></a> mechanism along with
482 '<abbr title="HyperText Transfer Protocol">HTTP</abbr>' authentication
483 mode.</li>
484 </ul>
486 <h4>'cookie' authentication mode</h4>
488 <ul><li>You can use this method as a replacement for the
489 <abbr title="HyperText Transfer Protocol">HTTP</abbr> authentication
490 (for example, if you're running
491 <abbr title="Internet Information Services">IIS</abbr>).</li>
492 <li>Obviously, the user must enable cookies in the browser, but this is
493 now a requirement for all authentication modes.</li>
494 <li>With this mode, the user can truly log out of phpMyAdmin and log in back
495 with the same username.</li>
496 <li>If you want to log in to arbitrary server see
497 <a href="#AllowArbitraryServer" class="configrule">
498 $cfg['AllowArbitraryServer']</a> directive.</li>
499 <li>As mentioned in the <a href="#require">requirements</a> section, having
500 the <tt>mcrypt</tt> extension will speed up access considerably, but is
501 not required.</li>
502 </ul>
504 <h4>'signon' authentication mode</h4>
506 <ul><li>This mode is a convenient way of using credentials from another
507 application to authenticate to phpMyAdmin.</li>
508 <li>The other application has to store login information into
509 session data.</li>
510 <li>More details in the <a href="#cfg_Servers_auth_type">auth_type</a>
511 section.</li>
512 </ul>
513 <h4>'config' authentication mode</h4>
515 <ul><li>This mode is the less secure one because it requires you to fill the
516 <a href="#servers_user" class="configrule">
517 $cfg['Servers'][$i]['user']</a> and
518 <a href="#servers_user" class="configrule">
519 $cfg['Servers'][$i]['password']</a> fields (and as a result, anyone who
520 can read your config.inc.php can discover your username and password).
521 <br />
522 But you don't need to setup a &quot;controluser&quot; here: using the
523 <a href="#servers_only_db" class="configrule">
524 $cfg['Servers'][$i]['only_db']</a> might be enough.</li>
525 <li>In the <a href="#faqmultiuser">
526 <abbr title="Internet service provider">ISP</abbr>
527 <abbr title="Frequently Asked Questions">FAQ</abbr></a> section, there
528 is an entry explaining how to protect your configuration file.</li>
529 <li>For additional security in this mode, you may wish to consider the Host
530 authentication
531 <a href="#servers_allowdeny_order" class="configrule">
532 $cfg['Servers'][$i]['AllowDeny']['order']</a> and
533 <a href="#servers_allowdeny_rules" class="configrule">
534 $cfg['Servers'][$i]['AllowDeny']['rules']</a> configuration
535 directives.</li>
536 <li>Unlike cookie and http, does not require a user to log in when first
537 loading the phpMyAdmin site. This is by design but could allow any
538 user to access your installation. Use of some restriction method is
539 suggested, perhaps a <a href="#glossary"><i>.htaccess</i></a> file with the
540 HTTP-AUTH directive or disallowing incoming HTTP requests at
541 one&#8217;s router or firewall will suffice (both of which
542 are beyond the scope of this manual but easily searchable with Google).</li>
543 </ul>
544 <h4 id="swekey">Swekey authentication</h4>
546 The Swekey is a low cost authentication USB key that can be used in
547 web applications.<br /><br />
548 When Swekey authentication is activated, phpMyAdmin requires the
549 users's Swekey to be plugged before entering the login page (currently
550 supported for cookie authentication mode only). Swekey Authentication is
551 disabled by default.<br /><br />
552 To enable it, add the following line to <tt>config.inc.php</tt>:
553 </p>
554 <pre>
555 $cfg['Servers'][$i]['auth_swekey_config'] = '/etc/swekey.conf';
556 </pre>
558 You then have to create the <tt>swekey.conf</tt> file that will associate
559 each user with their Swekey Id. It is important to place this file outside
560 of your web server's document root (in the example, it is located in <tt>/etc</tt>). A self documented sample file is provided
561 in the <tt>examples</tt> directory. Feel free to use it with your own
562 users' information.<br /><br />
563 If you want to purchase a Swekey please visit
564 <a href="http://phpmyadmin.net/auth_key">http://phpmyadmin.net/auth_key</a>
565 since this link provides funding for phpMyAdmin.
566 </p>
567 <!-- CONFIGURATION -->
568 <h2 id="config">Configuration</h2>
570 <p> <span class="important">Warning for <acronym title="Apple Macintosh">Mac</acronym>
571 users:</span> PHP does not seem to like
572 <acronym title="Apple Macintosh">Mac</acronym> end of lines character
573 (&quot;<tt>\r</tt>&quot;). So ensure you choose the option that allows to use
574 the *nix end of line character (&quot;<tt>\n</tt>&quot;) in your text editor
575 before saving a script you have modified.</p>
577 <p> <span class="important">Configuration note:</span>
578 Almost all configurable data is placed in <tt>config.inc.php</tt>. If this file
579 does not exist, please refer to the <a href="#setup">Quick install</a>
580 section to create one. This file only needs to contain the parameters you want to
581 change from their corresponding default value in
582 <tt>libraries/config.default.php</tt>.</p>
584 <p> The parameters which relate to design (like colors) are placed in
585 <tt>themes/themename/layout.inc.php</tt>. You might also want to create
586 <i>config.footer.inc.php</i> and <i>config.header.inc.php</i> files to add
587 your site specific code to be included on start and end of each page.</p>
589 <dl><dt id="cfg_PmaAbsoluteUri">$cfg['PmaAbsoluteUri'] string</dt>
590 <dd>Sets here the complete <abbr title="Uniform Resource Locator">URL</abbr>
591 (with full path) to your phpMyAdmin installation's directory.
592 E.g. <tt>http://www.your_web.net/path_to_your_phpMyAdmin_directory/</tt>.
593 Note also that the <abbr title="Uniform Resource Locator">URL</abbr> on
594 some web servers are case&#8211;sensitive.
595 Don&#8217;t forget the trailing slash at the end.<br /><br />
597 Starting with version 2.3.0, it is advisable to try leaving this
598 blank. In most cases phpMyAdmin automatically detects the proper
599 setting. Users of port forwarding will need to set PmaAbsoluteUri (<a
600 href="https://sourceforge.net/tracker/index.php?func=detail&amp;aid=1340187&amp;group_id=23067&amp;atid=377409">more info</a>).
601 A good test is to browse a table, edit a row and save it. There should
602 be an error message if phpMyAdmin is having trouble auto&#8211;detecting
603 the correct value. If you get an error that this must be set or if
604 the autodetect code fails to detect your path, please post a bug
605 report on our bug tracker so we can improve the code.</dd>
607 <dt id="cfg_PmaNoRelation_DisableWarning">$cfg['PmaNoRelation_DisableWarning'] boolean</dt>
608 <dd>Starting with version 2.3.0 phpMyAdmin offers a lot of features to work
609 with master / foreign &#8211; tables (see
610 <a href="#pmadb" class="configrule">$cfg['Servers'][$i]['pmadb']</a>).
611 <br />
612 If you tried to set this up and it does not work for you, have a look on
613 the &quot;Structure&quot; page of one database where you would like to
614 use it. You will find a link that will analyze why those features have
615 been disabled.<br />
616 If you do not want to use those features set this variable to
617 <tt>TRUE</tt> to stop this message from appearing.</dd>
619 <dt id="cfg_SuhosinDisableWarning">$cfg['SuhosinDisableWarning'] boolean</dt>
620 <dd>A warning is displayed on the main page if Suhosin is detected.
621 You can set this parameter to <tt>TRUE</tt> to stop this message
622 from appearing.</dd>
624 <dt id="cfg_McryptDisableWarning">$cfg['McryptDisableWarning'] boolean</dt>
625 <dd>Disable the default warning that is displayed if mcrypt is missing for
626 cookie authentication.
627 You can set this parameter to <tt>TRUE</tt> to stop this message
628 from appearing.</dd>
630 <dt id="cfg_TranslationWarningThreshold">$cfg['TranslationWarningThreshold'] integer</dt>
631 <dd>Show warning about incomplete translations on certain threshold.</dd>
633 <dt id="cfg_AllowThirdPartyFraming">$cfg['AllowThirdPartyFraming'] boolean</dt>
634 <dd>Setting this to <tt>true</tt> allows a page located on a different
635 domain to call phpMyAdmin inside a frame, and is a potential security
636 hole allowing cross-frame scripting attacks.</dd>
638 <dt id="cfg_blowfish_secret">$cfg['blowfish_secret'] string</dt>
639 <dd>The &quot;cookie&quot; auth_type uses blowfish
640 algorithm to encrypt the password.<br />
641 If you are using the &quot;cookie&quot; auth_type, enter here a random
642 passphrase of your choice. It will be used internally by the blowfish
643 algorithm: you won&#8217;t be prompted for this passphrase. There is
644 no maximum length for this secret.<br /><br />
646 Since version 3.1.0 phpMyAdmin can generate this on the fly, but it
647 makes a bit weaker security as this generated secret is stored in
648 session and furthermore it makes impossible to recall user name from
649 cookie.</dd>
651 <dt id="cfg_Servers">$cfg['Servers'] array</dt>
652 <dd>Since version 1.4.2, phpMyAdmin supports the administration of multiple
653 MySQL servers. Therefore, a
654 <a href="#cfg_Servers" class="configrule">$cfg['Servers']</a>-array has
655 been added which contains the login information for the different servers.
656 The first
657 <a href="#cfg_Servers_host" class="configrule">$cfg['Servers'][$i]['host']</a>
658 contains the hostname of the first server, the second
659 <a href="#cfg_Servers_host" class="configrule">$cfg['Servers'][$i]['host']</a>
660 the hostname of the second server, etc. In
661 <tt>./libraries/config.default.php</tt>, there is only one section for
662 server definition, however you can put as many as you need in
663 <tt>./config.inc.php</tt>, copy that block or needed parts (you don't
664 have to define all settings, just those you need to change).</dd>
666 <dt id="cfg_Servers_host">$cfg['Servers'][$i]['host'] string</dt>
667 <dd>The hostname or <abbr title="Internet Protocol">IP</abbr> address of your
668 $i-th MySQL-server. E.g. localhost.</dd>
670 <dt id="cfg_Servers_port">$cfg['Servers'][$i]['port'] string</dt>
671 <dd>The port-number of your $i-th MySQL-server. Default is 3306 (leave
672 blank). If you use &quot;localhost&quot; as the hostname, MySQL
673 ignores this port number and connects with the socket, so if you want
674 to connect to a port different from the default port, use
675 &quot;127.0.0.1&quot; or the real hostname in
676 <a href="#cfg_Servers_host" class="configrule">$cfg['Servers'][$i]['host']</a>.
677 </dd>
679 <dt id="cfg_Servers_socket">$cfg['Servers'][$i]['socket'] string</dt>
680 <dd>The path to the socket to use. Leave blank for default.<br />
681 To determine the correct socket, check your MySQL configuration or, using the
682 <tt>mysql</tt> command&#8211;line client, issue the <tt>status</tt> command.
683 Among the resulting information displayed will be the socket used.</dd>
685 <dt id="cfg_Servers_ssl">$cfg['Servers'][$i]['ssl'] boolean</dt>
686 <dd>Whether to enable SSL for connection to MySQL server.
687 </dd>
689 <dt id="cfg_Servers_connect_type">$cfg['Servers'][$i]['connect_type'] string</dt>
690 <dd>What type connection to use with the MySQL server. Your options are
691 <tt>'socket'</tt> and <tt>'tcp'</tt>. It defaults to 'tcp' as that
692 is nearly guaranteed to be available on all MySQL servers, while
693 sockets are not supported on some platforms.<br /><br />
695 To use the socket mode, your MySQL server must be on the same machine
696 as the Web server.</dd>
698 <dt id="cfg_Servers_extension">$cfg['Servers'][$i]['extension'] string</dt>
699 <dd>What php MySQL extension to use for the connection. Valid options are:
700 <br /><br />
702 <tt><i>mysql</i></tt> :
703 The classic MySQL extension.<br /><br />
705 <tt><i>mysqli</i></tt> :
706 The improved MySQL extension. This extension became available
707 with PHP 5.0.0 and is the recommended way to connect to a server
708 running MySQL 4.1.x or newer.</dd>
710 <dt id="cfg_Servers_compress">$cfg['Servers'][$i]['compress'] boolean</dt>
711 <dd>Whether to use a compressed protocol for the MySQL server connection
712 or not (experimental).</dd>
714 <dt id="controlhost">
715 <span id="cfg_Servers_controlhost">$cfg['Servers'][$i]['controlhost']</span> string<br />
716 </dt>
717 <dd>Permits to use an alternate host to hold the configuration storage
718 data.</dd>
720 <dt id="controluser">
721 <span id="cfg_Servers_controluser">$cfg['Servers'][$i]['controluser']</span> string<br />
722 <span id="cfg_Servers_controlpass">$cfg['Servers'][$i]['controlpass']</span> string
723 </dt>
724 <dd>This special account is used for 2 distinct purposes: to make possible
725 all relational features (see
726 <a href="#pmadb" class="configrule">$cfg['Servers'][$i]['pmadb']</a>)
727 and, for a MySQL server running with
728 <tt>--skip-show-database</tt>, to enable a multi-user installation
729 (<abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie
730 authentication mode).<br /><br />
732 When using <abbr title="HyperText Transfer Protocol">HTTP</abbr> or
733 cookie authentication modes (or 'config'
734 authentication mode since phpMyAdmin 2.2.1), you need to supply the
735 details of a MySQL account that has <tt>SELECT</tt> privilege on the
736 <i>mysql.user (all columns except &quot;Password&quot;)</i>,
737 <i>mysql.db (all columns)</i> and <i>mysql.tables_priv (all columns
738 except &quot;Grantor&quot; and &quot;Timestamp&quot;) </i>tables.
739 This account is used to check what databases the user will see at
740 login.<br />
741 Please see the <a href="#setup">install section</a> on
742 &quot;Using authentication modes&quot; for more information.<br /><br />
744 In phpMyAdmin versions before 2.2.5, those were called
745 &quot;stduser/stdpass&quot;.</dd>
747 <dt id="cfg_Servers_auth_type">$cfg['Servers'][$i]['auth_type'] string
748 <tt>['<abbr title="HyperText Transfer Protocol">HTTP</abbr>'|'http'|'cookie'|'config'|'signon']</tt></dt>
749 <dd>Whether config or cookie or
750 <abbr title="HyperText Transfer Protocol">HTTP</abbr> or signon authentication
751 should be used for this server.
752 <ul><li>'config' authentication (<tt>$auth_type&nbsp;=&nbsp;'config'</tt>)
753 is the plain old way: username and password are stored in
754 <i>config.inc.php</i>.</li>
755 <li>'cookie' authentication mode
756 (<tt>$auth_type&nbsp;=&nbsp;'cookie'</tt>) as introduced in
757 2.2.3 allows you to log in as any valid MySQL user with the
758 help of cookies. Username and password are stored in
759 cookies during the session and password is deleted when it
760 ends. This can also allow you to log in in arbitrary server if
761 <tt><a href="#AllowArbitraryServer" class="configrule">$cfg['AllowArbitraryServer']</a></tt> enabled.
762 </li>
763 <li>'<abbr title="HyperText Transfer Protocol">HTTP</abbr>' authentication (was called 'advanced' in previous versions and can be written also as 'http')
764 (<tt>$auth_type&nbsp;=&nbsp;'<abbr title="HyperText Transfer Protocol">HTTP</abbr>'</tt>) as introduced in 1.3.0
765 allows you to log in as any valid MySQL user via HTTP-Auth.</li>
766 <li>'signon' authentication mode
767 (<tt>$auth_type&nbsp;=&nbsp;'signon'</tt>)
768 as introduced in 2.10.0 allows you to log in from prepared PHP
769 session data or using supplied PHP script. This is useful for implementing single signon
770 from another application.
772 Sample way how to seed session is in signon example: <code>examples/signon.php</code>.
773 There is also alternative example using OpenID - <code>examples/openid.php</code> and
774 example for scripts based solution - <code>examples/signon-script.php</code>.
776 You need to
777 configure <a href="#cfg_Servers_SignonSession"
778 class="configrule">session name</a> or <a href="#cfg_Servers_SignonScript"
779 class="configrule">script to be executed</a> and <a
780 href="#cfg_Servers_SignonURL" class="configrule">signon
781 <abbr title="Uniform Resource Locator">URL</abbr></a> to use
782 this authentication method.</li>
783 </ul>
785 Please see the <a href="#setup">install section</a> on &quot;Using authentication modes&quot;
786 for more information.
787 </dd>
788 <dt id="servers_auth_http_realm">
789 <span id="cfg_Servers_auth_http_realm">$cfg['Servers'][$i]['auth_http_realm']</span> string<br />
790 </dt>
791 <dd>
792 When using auth_type = '<abbr title="HyperText Transfer Protocol">HTTP</abbr>', this field allows to define a custom
793 <abbr title="HyperText Transfer Protocol">HTTP</abbr> Basic Auth Realm which will be displayed to the user. If not explicitly
794 specified in your configuration, a string combined of "phpMyAdmin " and either
795 <a href="#cfg_Servers_verbose" class="configrule">$cfg['Servers'][$i]['verbose']</a>
796 or <a href="#cfg_Servers_host" class="configrule">$cfg['Servers'][$i]['host']</a> will be used.
797 </dd>
798 <dt id="servers_auth_swekey_config">
799 <span id="cfg_Servers_auth_swekey_config">$cfg['Servers'][$i]['auth_swekey_config']</span> string<br />
800 </dt>
801 <dd>
802 The name of the file containing <a href="#swekey">Swekey</a> ids and login
803 names for hardware authentication. Leave empty to deactivate this feature.
804 </dd>
805 <dt id="servers_user">
806 <span id="cfg_Servers_user">$cfg['Servers'][$i]['user']</span> string<br />
807 <span id="cfg_Servers_password">$cfg['Servers'][$i]['password']</span> string
808 </dt>
809 <dd>
810 When using auth_type = 'config', this is the user/password-pair
811 which phpMyAdmin will use to connect to the
812 MySQL server. This user/password pair is not needed when <abbr title="HyperText Transfer Protocol">HTTP</abbr> or
813 cookie authentication is used and should be empty.</dd>
814 <dt id="servers_nopassword">
815 <span
816 id="cfg_Servers_nopassword">$cfg['Servers'][$i]['nopassword']</span> boolean
817 </dt>
818 <dd>
819 Allow attempt to log in without password when a login with password
820 fails. This can be used together with http authentication, when
821 authentication is done some other way and phpMyAdmin gets user name
822 from auth and uses empty password for connecting to MySQL. Password
823 login is still tried first, but as fallback, no password method is
824 tried.</dd>
825 <dt id="servers_only_db">
826 <span id="cfg_Servers_only_db">$cfg['Servers'][$i]['only_db']</span> string or array
827 </dt>
828 <dd>
829 If set to a (an array of) database name(s), only this (these) database(s)
830 will be shown to the user. Since phpMyAdmin 2.2.1, this/these
831 database(s) name(s) may contain MySQL wildcards characters
832 (&quot;_&quot; and &quot;%&quot;): if you want to use literal instances
833 of these characters, escape them (I.E. use <tt>'my\_db'</tt> and not
834 <tt>'my_db'</tt>).<br />
835 This setting is an efficient way to lower the server load since the
836 latter does not need to send MySQL requests to build the available
837 database list. But <span class="important">it does not replace the
838 privileges rules of the MySQL database server</span>. If set, it just
839 means only these databases will be displayed but
840 <span class="important">not that all other databases can't be used.</span>
841 <br /><br />
843 An example of using more that one database:
844 <tt>$cfg['Servers'][$i]['only_db'] = array('db1', 'db2');</tt>
845 <br /><br />
847 As of phpMyAdmin 2.5.5 the order inside the array is used for sorting the
848 databases in the left frame, so that you can individually arrange your databases.<br />
849 If you want to have certain databases at the top, but don't care about the others, you do not
850 need to specify all other databases. Use:
851 <tt>$cfg['Servers'][$i]['only_db'] = array('db3', 'db4', '*');</tt>
852 instead to tell phpMyAdmin that it should display db3 and db4 on top, and the rest in alphabetic
853 order.</dd>
855 <dt><span id="cfg_Servers_hide_db">$cfg['Servers'][$i]['hide_db']</span> string
856 </dt>
857 <dd>Regular expression for hiding some databases from unprivileged users.
858 This only hides them
859 from listing, but a user is still able to access them (using, for example,
860 the SQL query area). To limit access, use the MySQL privilege system.
861 <br /><br />
862 For example, to hide all databases starting with the letter &#34;a&#34;, use<br />
863 <pre>$cfg['Servers'][$i]['hide_db'] = '^a';</pre>
864 and to hide both &#34;db1&#34; and &#34;db2&#34; use <br />
865 <pre>$cfg['Servers'][$i]['hide_db'] = '^(db1|db2)$';</pre>
866 More information on regular expressions can be found in the
867 <a href="http://php.net/manual/en/reference.pcre.pattern.syntax.php">
868 PCRE pattern syntax</a> portion of the PHP reference manual.
869 </dd>
871 <dt id="cfg_Servers_verbose">$cfg['Servers'][$i]['verbose'] string</dt>
872 <dd>Only useful when using phpMyAdmin with multiple server entries. If set,
873 this string will be displayed instead of the hostname in the pull-down
874 menu on the main page. This can be useful if you want to show only
875 certain databases on your system, for example. For HTTP auth, all
876 non-US-ASCII characters will be stripped.</dd>
878 <dt id="pmadb">
879 <span id="cfg_Servers_pmadb">$cfg['Servers'][$i]['pmadb']</span> string
880 </dt>
881 <dd>The name of the database containing the phpMyAdmin configuration storage.
882 <br /><br />
884 See the <a href="#linked-tables">phpMyAdmin configuration storage</a>
885 section in this document to see the benefits of this feature,
886 and for a quick way of creating this database and the needed tables.
887 <br /><br />
889 If you are the only user of this phpMyAdmin installation, you can
890 use your current database to store those special tables; in this
891 case, just put your current database name in
892 <tt>$cfg['Servers'][$i]['pmadb']</tt>. For a multi-user installation,
893 set this parameter to the name of your central database containing
894 the phpMyAdmin configuration storage.</dd>
896 <dt id="bookmark">
897 <span id="cfg_Servers_bookmarktable">$cfg['Servers'][$i]['bookmarktable']</span> string
898 </dt>
899 <dd>Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This can be
900 useful for queries you often run.<br /><br />
902 To allow the usage of this functionality:
903 <ul><li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
904 <li>enter the table name in
905 <tt>$cfg['Servers'][$i]['bookmarktable']</tt></li>
906 </ul>
907 </dd>
909 <dt id="relation">
910 <span id="cfg_Servers_relation">$cfg['Servers'][$i]['relation']</span> string
911 </dt>
912 <dd>Since release 2.2.4 you can describe, in a special 'relation' table,
913 which column is a key in another table (a foreign key). phpMyAdmin
914 currently uses this to
915 <ul><li>make clickable, when you browse the master table, the data values
916 that point to the foreign table;</li>
917 <li>display in an optional tool-tip the &quot;display column&quot;
918 when browsing the master table, if you move the mouse to a column
919 containing a foreign key (use also the 'table_info' table);<br />
920 (see <a href="#faqdisplay"><abbr title="Frequently Asked Questions">
921 FAQ</abbr> 6.7</a>)</li>
922 <li>in edit/insert mode, display a drop-down list of possible foreign
923 keys (key value and &quot;display column&quot; are shown)<br />
924 (see <a href="#faq6_21"><abbr title="Frequently Asked Questions">
925 FAQ</abbr> 6.21</a>)</li>
926 <li>display links on the table properties page, to check referential
927 integrity (display missing foreign keys) for each described key;
928 </li>
929 <li>in query-by-example, create automatic joins (see <a href="#faq6_6">
930 <abbr title="Frequently Asked Questions">FAQ</abbr> 6.6</a>)</li>
931 <li>enable you to get a <abbr title="Portable Document Format">PDF</abbr>
932 schema of your database (also uses the table_coords table).</li>
933 </ul>
935 The keys can be numeric or character.<br /><br />
937 To allow the usage of this functionality:
939 <ul><li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin
940 configuration storage</li>
941 <li>put the relation table name in
942 <tt>$cfg['Servers'][$i]['relation']</tt></li>
943 <li>now as normal user open phpMyAdmin and for each one of your
944 tables where you want to use this feature, click
945 &quot;Structure/Relation view/&quot; and choose foreign
946 columns.
947 </li>
948 </ul>
950 Please note that in the current version, <tt>master_db</tt>
951 must be the same as <tt>foreign_db</tt>. Those columns have been put in
952 future development of the cross-db relations.
953 </dd>
955 <dt id="table_info">
956 <span id="cfg_Servers_table_info">$cfg['Servers'][$i]['table_info']</span> string
957 </dt>
958 <dd>
959 Since release 2.3.0 you can describe, in a special 'table_info'
960 table, which column is to be displayed as a tool-tip when moving the
961 cursor over the corresponding key.<br />
962 This configuration variable will hold the name of this special
963 table. To allow the usage of this functionality:
964 <ul><li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
965 <li>put the table name in
966 <tt>$cfg['Servers'][$i]['table_info']</tt> (e.g.
967 'pma_table_info')</li>
968 <li>then for each table where you want to use this feature,
969 click &quot;Structure/Relation view/Choose column to display&quot;
970 to choose the column.</li>
971 </ul>
972 Usage tip: <a href="#faqdisplay">Display column</a>.
973 </dd>
974 <dt id="table_coords">
975 <span id="cfg_Servers_table_coords">$cfg['Servers'][$i]['table_coords']</span> string<br />
976 <span id="cfg_Servers_pdf_pages">$cfg['Servers'][$i]['pdf_pages']</span> string
977 </dt>
978 <dd>Since release 2.3.0 you can have phpMyAdmin create
979 <abbr title="Portable Document Format">PDF</abbr> pages showing
980 the relations between your tables. To do this it needs two tables
981 &quot;pdf_pages&quot; (storing information about the available
982 <abbr title="Portable Document Format">PDF</abbr>
983 pages) and &quot;table_coords&quot; (storing coordinates where each
984 table will be placed on a <abbr title="Portable Document Format">PDF</abbr>
985 schema output).<br /><br />
987 You must be using the &quot;relation&quot; feature.<br /><br />
989 To allow the usage of this functionality:
991 <ul><li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
992 <li>put the correct table names in
993 <tt>$cfg['Servers'][$i]['table_coords']</tt> and
994 <tt>$cfg['Servers'][$i]['pdf_pages']</tt></li>
995 </ul>
997 Usage tips: <a href="#faqpdf"><abbr title="Portable Document Format">PDF</abbr> output</a>.
998 </dd>
1000 <dt id="col_com">
1001 <span id="cfg_Servers_column_info">$cfg['Servers'][$i]['column_info']</span> string
1002 </dt>
1003 <dd><!-- This part requires a content update! -->
1004 Since release 2.3.0 you can store comments to describe each column for
1005 each table. These will then be shown on the &quot;printview&quot;.
1006 <br /><br />
1008 Starting with release 2.5.0, comments are consequently used on the table
1009 property pages and table browse view, showing up as tool-tips above the
1010 column name (properties page) or embedded within the header of table in
1011 browse view. They can also be shown in a table dump. Please see the
1012 relevant configuration directives later on.<br /><br />
1014 Also new in release 2.5.0 is a MIME-transformation system which is also
1015 based on the following table structure. See <a href="#transformations">
1016 Transformations</a> for further information. To use the
1017 MIME-transformation system, your column_info table has to have the three
1018 new columns 'mimetype', 'transformation', 'transformation_options'.
1019 <br /><br />
1021 To allow the usage of this functionality:
1022 <ul><li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
1023 <li>put the table name in
1024 <tt>$cfg['Servers'][$i]['column_info']</tt> (e.g.
1025 'pma_column_info')</li>
1026 <li>to update your PRE-2.5.0 Column_comments Table use this:
1028 <pre>
1029 ALTER TABLE `pma_column_comments`
1030 ADD `mimetype` VARCHAR( 255 ) NOT NULL,
1031 ADD `transformation` VARCHAR( 255 ) NOT NULL,
1032 ADD `transformation_options` VARCHAR( 255 ) NOT NULL;
1033 </pre>
1035 and remember that the Variable in <i>config.inc.php</i> has been
1036 renamed from<br />
1037 <tt>$cfg['Servers'][$i]['column_comments']</tt> to
1038 <tt>$cfg['Servers'][$i]['column_info']</tt></li>
1039 </ul>
1040 </dd>
1042 <dt id="history">
1043 <span id="cfg_Servers_history">$cfg['Servers'][$i]['history']</span> string
1044 </dt>
1045 <dd>Since release 2.5.0 you can store your
1046 <abbr title="structured query language">SQL</abbr> history, which means
1047 all queries you entered manually into the phpMyAdmin interface. If you
1048 don't want to use a table-based history, you can use the JavaScript-based
1049 history. Using that, all your history items are deleted when closing the
1050 window.<br /><br />
1052 Using
1053 <a href="#cfg_QueryHistoryMax" class="configrule">$cfg['QueryHistoryMax']</a>
1054 you can specify an amount of history items you want to have on hold. On
1055 every login, this list gets cut to the maximum amount.<br /><br />
1057 The query history is only available if JavaScript is enabled in your
1058 browser.<br /><br />
1060 To allow the usage of this functionality:
1062 <ul><li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
1063 <li>put the table name in <tt>$cfg['Servers'][$i]['history']</tt>
1064 (e.g. 'pma_history')
1065 </li>
1066 </ul>
1067 </dd>
1069 <dt id="recent">
1070 <span id="cfg_Servers_recent">$cfg['Servers'][$i]['recent']</span> string
1071 </dt>
1072 <dd>
1073 Since release 3.5.0 you can show recently used tables in the left navigation frame.
1074 It helps you to jump across table directly, without the need to select the database,
1075 and then select the table. Using
1076 <a href="#cfg_LeftRecentTable" class="configrule">$cfg['LeftRecentTable']</a>
1077 you can configure the maximum number of recent tables shown. When you select a table
1078 from the list, it will jump to the page specified in
1079 <a href="#cfg_LeftDefaultTabTable" class="configrule">$cfg['LeftDefaultTabTable']</a>.<br/><br/>
1081 Without configuring the storage, you can still access the recently used tables,
1082 but it will disappear after you logout.<br/><br/>
1084 To allow the usage of this functionality persistently:
1086 <ul>
1087 <li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
1088 <li>put the table name in <tt>$cfg['Servers'][$i]['recent']</tt> (e.g. 'pma_recent')</li>
1089 </ul>
1090 </dd>
1092 <dt id="table_uiprefs">
1093 <span id="cfg_Servers_table_uiprefs">$cfg['Servers'][$i]['table_uiprefs']</span> string
1094 </dt>
1095 <dd>
1096 Since release 3.5.0 phpMyAdmin can be configured to remember several things
1097 (sorted column
1098 <a href="#cfg_RememberSorting" class="configrule">$cfg['RememberSorting']</a>
1099 , column order, and column visibility from a database table) for browsing tables.
1100 Without configuring the storage, these features still can be used,
1101 but the values will disappear after you logout.<br/><br/>
1103 To allow the usage of these functionality persistently:
1105 <ul>
1106 <li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
1107 <li>put the table name in <tt>$cfg['Servers'][$i]['table_uiprefs']</tt> (e.g. 'pma_table_uiprefs')</li>
1108 </ul>
1109 </dd>
1111 <dt id="tracking">
1112 <span id="cfg_Servers_tracking">$cfg['Servers'][$i]['tracking']</span> string
1113 </dt>
1114 <dd>
1115 Since release 3.3.x a tracking mechanism is available.
1116 It helps you to track every <abbr title="structured query language">SQL</abbr> command which
1117 is executed by phpMyAdmin. The mechanism supports logging of data manipulation
1118 and data definition statements. After enabling it you can create versions of tables.
1119 <br/><br/>
1120 The creation of a version has two effects:
1122 <ul>
1123 <li>phpMyAdmin saves a snapshot of the table, including structure and indexes.</li>
1124 <li>phpMyAdmin logs all commands which change the structure and/or data of the table and links these commands with the version number.</li>
1125 </ul>
1127 Of course you can view the tracked changes. On the "Tracking" page a complete report is available for every version.
1128 For the report you can use filters, for example you can get a list of statements within a date range.
1129 When you want to filter usernames you can enter * for all names or you enter a list of names separated by ','.
1130 In addition you can export the (filtered) report to a file or to a temporary database.
1131 <br/><br/>
1133 To allow the usage of this functionality:
1135 <ul>
1136 <li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
1137 <li>put the table name in <tt>$cfg['Servers'][$i]['tracking']</tt> (e.g. 'pma_tracking')</li>
1138 </ul>
1139 </dd>
1141 <dt id="tracking2">
1142 <span id="cfg_Servers_tracking_version_auto_create">$cfg['Servers'][$i]['tracking_version_auto_create']</span> boolean
1143 </dt>
1144 <dd>
1145 Whether the tracking mechanism creates versions for tables and views automatically. Default value is false.
1146 <br/><br/>
1147 If this is set to true and you create a table or view with
1149 <ul>
1150 <li>CREATE TABLE ...</li>
1151 <li>CREATE VIEW ...</li>
1152 </ul>
1154 and no version exists for it, the mechanism will
1155 create a version for you automatically.
1156 </dd>
1158 <dt id="tracking3">
1159 <span id="cfg_Servers_tracking_default_statements">$cfg['Servers'][$i]['tracking_default_statements']</span> string
1160 </dt>
1161 <dd>
1162 Defines the list of statements the auto-creation uses for new versions. Default value is
1163 <br/>
1165 <pre>CREATE TABLE,ALTER TABLE,DROP TABLE,RENAME TABLE,
1166 CREATE INDEX,DROP INDEX,
1167 INSERT,UPDATE,DELETE,TRUNCATE,REPLACE,
1168 CREATE VIEW,ALTER VIEW,DROP VIEW,
1169 CREATE DATABASE,ALTER DATABASE,DROP DATABASE</pre>
1170 </dd>
1172 <dt id="tracking4">
1173 <span id="cfg_Servers_tracking_add_drop_view">$cfg['Servers'][$i]['tracking_add_drop_view']</span> boolean
1174 </dt>
1175 <dd>
1176 Whether a DROP VIEW IF EXISTS statement will be added as first line to the log when creating a view. Default value is true.
1177 <br/><br/>
1178 </dd>
1181 <dt id="tracking5">
1182 <span id="cfg_Servers_tracking_add_drop_table">$cfg['Servers'][$i]['tracking_add_drop_table']</span> boolean
1183 </dt>
1184 <dd>
1185 Whether a DROP TABLE IF EXISTS statement will be added as first line to the log when creating a table. Default value is true.
1186 <br/><br/>
1187 </dd>
1189 <dt id="tracking6">
1190 <span id="cfg_Servers_tracking_add_drop_database">$cfg['Servers'][$i]['tracking_add_drop_database']</span> boolean
1191 </dt>
1192 <dd>
1193 Whether a DROP DATABASE IF EXISTS statement will be added as first line to the log when creating a database. Default value is true.
1194 <br/><br/>
1195 </dd>
1197 <dt id="userconfig">
1198 <span id="cfg_Servers_userconfig">$cfg['Servers'][$i]['userconfig']</span> string
1199 </dt>
1200 <dd>
1201 Since release 3.4.x phpMyAdmin allows users to set most preferences by themselves
1202 and store them in the database.
1203 <br /><br />
1205 If you don't allow for storing preferences in <a href="#pmadb">pmadb</a>, users can
1206 still personalize phpMyAdmin, but settings will be saved in browser's local storage,
1207 or, it is is unavailable, until the end of session.
1208 <br /><br />
1210 To allow the usage of this functionality:
1212 <ul>
1213 <li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin
1214 configuration storage</li>
1215 <li>put the table name in <tt>$cfg['Servers'][$i]['userconfig']</tt></li>
1216 </ul>
1217 </dd>
1219 <dt id="designer_coords">
1220 <span id="cfg_Servers_designer_coords">$cfg['Servers'][$i]['designer_coords']</span> string
1221 </dt>
1222 <dd>Since release 2.10.0 a Designer interface is available; it permits
1223 to visually manage the relations.
1224 <br /><br />
1226 To allow the usage of this functionality:
1228 <ul><li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
1229 <li>put the table name in <tt>$cfg['Servers'][$i]['designer_coords']</tt> (e.g. 'pma_designer_coords')
1230 </li>
1231 </ul>
1232 </dd>
1234 <dt><span id="cfg_Servers_MaxTableUiprefs">$cfg['Servers'][$i]['MaxTableUiprefs']</span> integer
1235 </dt>
1236 <dd>Maximum number of rows saved in <a
1237 href="#cfg_Servers_table_uiprefs">$cfg['Servers'][$i]['table_uiprefs']</a> table.<br /><br />
1239 When tables are dropped or renamed, table_uiprefs may contain invalid
1240 data (referring to tables which no longer exist).<br />
1241 We only keep this number of newest rows in table_uiprefs and automatically delete older rows.</dd>
1243 <dt><span id="cfg_Servers_verbose_check">$cfg['Servers'][$i]['verbose_check']</span> boolean
1244 </dt>
1245 <dd>Because release 2.5.0 introduced the new MIME-transformation support, the
1246 column_info table got enhanced with three new columns. If the above variable
1247 is set to <tt>TRUE</tt> (default) phpMyAdmin will check if you have the
1248 latest table structure available. If not, it will emit a warning to the
1249 superuser.<br /><br />
1251 You can disable this checking behavior by setting the variable to false,
1252 which should offer a performance increase.<br /><br />
1254 Recommended to set to FALSE, when you are sure, your table structure is
1255 up to date.</dd>
1256 <dt><span id="cfg_Servers_AllowRoot">$cfg['Servers'][$i]['AllowRoot']</span>
1257 boolean</dt>
1258 <dd>Whether to allow root access. This is just a shortcut for the AllowDeny rules below.
1259 </dd>
1260 <dt><span id="cfg_Servers_AllowNoPassword">$cfg['Servers'][$i]['AllowNoPassword']</span>
1261 boolean</dt>
1262 <dd>Whether to allow logins without a password. The default
1263 value of <tt>false</tt> for this parameter prevents unintended access
1264 to a MySQL server with was left with an empty password for root or
1265 on which an anonymous (blank) user is defined.
1266 </dd>
1267 <dt id="servers_allowdeny_order">
1268 <span id="cfg_Servers_AllowDeny_order">$cfg['Servers'][$i]['AllowDeny']['order']</span> string
1269 </dt>
1270 <dd>If your rule order is empty, then <abbr title="Internet Protocol">IP</abbr>
1271 authorization is disabled.<br /><br />
1273 If your rule order is set to <tt>'deny,allow'</tt> then the system applies
1274 all deny rules followed by allow rules. Access is allowed by default. Any
1275 client which does not match a Deny command or does match an Allow command
1276 will be allowed access to the server. <br /><br />
1278 If your rule order is set to <tt>'allow,deny'</tt> then the system
1279 applies all allow rules followed by deny rules. Access is denied by
1280 default. Any client which does not match an Allow directive or does
1281 match a Deny directive will be denied access to the server.<br /><br />
1283 If your rule order is set to 'explicit', authorization is
1284 performed in a similar fashion to rule order 'deny,allow', with the
1285 added restriction that your host/username combination <b>must</b> be
1286 listed in the <i>allow</i> rules, and not listed in the <i>deny</i>
1287 rules. This is the <b>most</b> secure means of using Allow/Deny rules,
1288 and was available in Apache by specifying allow and deny rules without
1289 setting any order.<br /><br />
1291 Please also see <a
1292 href="#cfg_TrustedProxies">$cfg['TrustedProxies']</a> for detecting IP
1293 address behind proxies.
1294 </dd>
1295 <dt id="servers_allowdeny_rules">
1296 <span id="cfg_Servers_AllowDeny_rules">$cfg['Servers'][$i]['AllowDeny']['rules']</span> array of strings
1297 </dt>
1298 <dd>The general format for the rules is as such:
1300 <pre>
1301 &lt;'allow' | 'deny'&gt; &lt;username&gt; [from] &lt;ipmask&gt;
1302 </pre>
1304 If you wish to match all users, it is possible to use a <tt>'%'</tt> as
1305 a wildcard in the <i>username</i> field.<br />
1306 There are a few shortcuts you can use in the <i>ipmask</i> field as
1307 well (please note that those containing SERVER_ADDRESS might not be
1308 available on all webservers):
1309 <pre>
1310 'all' -&gt; 0.0.0.0/0
1311 'localhost' -&gt; 127.0.0.1/8
1312 'localnetA' -&gt; SERVER_ADDRESS/8
1313 'localnetB' -&gt; SERVER_ADDRESS/16
1314 'localnetC' -&gt; SERVER_ADDRESS/24
1315 </pre>
1317 Having an empty rule list is equivalent to either using
1318 <tt>'allow % from all'</tt> if your rule order is set to
1319 <tt>'deny,allow'</tt> or <tt>'deny % from all'</tt> if your rule order
1320 is set to <tt>'allow,deny'</tt> or <tt>'explicit'</tt>.<br /><br />
1322 For the <abbr title="Internet Protocol">IP</abbr> matching system, the
1323 following work:<br />
1324 <tt>xxx.xxx.xxx.xxx</tt> (an exact <abbr title="Internet Protocol">IP</abbr> address)<br />
1325 <tt>xxx.xxx.xxx.[yyy-zzz]</tt> (an <abbr title="Internet Protocol">IP</abbr> address range)<br />
1326 <tt>xxx.xxx.xxx.xxx/nn</tt> (CIDR, Classless Inter-Domain Routing type <abbr title="Internet Protocol">IP</abbr> addresses)<br />
1327 But the following does not work:<br />
1328 <tt>xxx.xxx.xxx.xx[yyy-zzz]</tt> (partial
1329 <abbr title="Internet Protocol">IP</abbr> address range)<br />
1330 Also IPv6 addresses are not supported.
1331 </dd>
1332 <dt><span id="cfg_Servers_DisableIS">$cfg['Servers'][$i]['DisableIS']</span> boolean</dt>
1333 <dd>Disable using <tt>INFORMATION_SCHEMA</tt> to retrieve information (use <tt>SHOW</tt> commands instead), because of speed issues when many databases are present. Currently used in some parts of the code, more to come.
1334 </dd>
1335 <dt><span id="cfg_Servers_ShowDatabasesCommand">$cfg['Servers'][$i]['ShowDatabasesCommand']</span> string</dt>
1336 <dd>On a server with a huge number of databases, the default <tt>SHOW
1337 DATABASES</tt> command used to fetch the name of available databases will
1338 probably be too slow, so it can be replaced by faster commands (see
1339 <tt>libraries/config.default.php</tt> for examples).
1340 </dd>
1341 <dt><span id="cfg_Servers_CountTables">$cfg['Servers'][$i]['CountTables']</span> boolean</dt>
1342 <dd>Whether to count the number of tables for each database when preparing the list of databases for the navigation frame.
1343 </dd>
1344 <dt><span id="cfg_Servers_SignonScript">$cfg['Servers'][$i]['SignonScript']</span> string</dt>
1345 <dd>Name of PHP script to be sourced and executed to obtain
1346 login credentials. This is alternative approach to session based single
1347 signon. The script needs to provide function
1348 <code>get_login_credentials</code> which returns list of username and
1349 password, accepting single parameter of existing username (can be empty).
1350 See <code>examples/signon-script.php</code> for an example.
1351 </dd>
1352 <dt><span id="cfg_Servers_SignonSession">$cfg['Servers'][$i]['SignonSession']</span> string</dt>
1353 <dd>Name of session which will be used for signon authentication method.
1354 You should use something different than <code>phpMyAdmin</code>, because
1355 this is session which phpMyAdmin uses internally. Takes effect only if
1356 <a href="#cfg_Servers_SignonScript" class="configrule">SignonScript</a>
1357 is not configured.
1358 </dd>
1359 <dt><span id="cfg_Servers_SignonURL">$cfg['Servers'][$i]['SignonURL']</span> string</dt>
1360 <dd><abbr title="Uniform Resource Locator">URL</abbr> where user will be
1361 redirected to log in for signon authentication method. Should be absolute
1362 including protocol.
1363 </dd>
1364 <dt><span id="cfg_Servers_LogoutURL">$cfg['Servers'][$i]['LogoutURL']</span> string</dt>
1365 <dd><abbr title="Uniform Resource Locator">URL</abbr> where user will be
1366 redirected after logout (doesn't affect config authentication method).
1367 Should be absolute including protocol.
1368 </dd>
1370 <dt id="cfg_ServerDefault">$cfg['ServerDefault'] integer</dt>
1371 <dd>If you have more than one server configured, you can set
1372 <tt>$cfg['ServerDefault']</tt> to any one of them to autoconnect to
1373 that server when phpMyAdmin is started, or set it to 0 to be given a
1374 list of servers without logging in.<br />
1375 If you have only one server configured, <tt>$cfg['ServerDefault']</tt>
1376 MUST be set to that server.</dd>
1378 <dt id="cfg_AjaxEnable">$cfg['AjaxEnable'] boolean</dt>
1379 <dd>Defines whether to refresh only parts of certain pages using Ajax
1380 techniques. Applies only where a non-Ajax behavior is possible;
1381 for example, the Designer feature is Ajax-only so this directive
1382 does not apply to it.</dd>
1384 <dt id="cfg_VersionCheck">$cfg['VersionCheck'] boolean</dt>
1385 <dd>Enables check for latest versions using javascript on main phpMyAdmin
1386 page.</dd>
1388 <dt id="cfg_MaxDbList">$cfg['MaxDbList'] integer</dt>
1389 <dd>The maximum number of database names to be displayed in the
1390 navigation frame and the database list.</dd>
1392 <dt id="cfg_MaxTableList">$cfg['MaxTableList'] integer</dt>
1393 <dd>The maximum number of table names to be displayed in the
1394 main panel's list (except on the Export page). This limit is also enforced in the navigation panel
1395 when in Light mode.</dd>
1397 <dt id="cfg_ShowHint">$cfg['ShowHint'] boolean</dt>
1398 <dd>Whether or not to show hints (for example, hints when hovering over table headers).</dd>
1400 <dt id="cfg_MaxCharactersInDisplayedSQL">$cfg['MaxCharactersInDisplayedSQL'] integer</dt>
1401 <dd>The maximum number of characters when a <abbr title="structured query language">
1402 SQL</abbr> query is displayed. The default limit of 1000 should be correct
1403 to avoid the display of tons of hexadecimal codes that represent BLOBs, but
1404 some users have real <abbr title="structured query language">SQL</abbr>
1405 queries that are longer than 1000 characters. Also, if a query's length
1406 exceeds this limit, this query is not saved in the history.</dd>
1408 <dt id="cfg_OBGzip">$cfg['OBGzip'] string/boolean</dt>
1409 <dd>Defines whether to use GZip output buffering for increased
1410 speed in <abbr title="HyperText Transfer Protocol">HTTP</abbr> transfers.<br />
1411 Set to true/false for enabling/disabling. When set to 'auto' (string),
1412 phpMyAdmin tries to enable output buffering and will automatically disable
1413 it if your browser has some problems with buffering. IE6 with a certain patch
1414 is known to cause data corruption when having enabled buffering.</dd>
1416 <dt id="cfg_PersistentConnections">$cfg['PersistentConnections'] boolean</dt>
1417 <dd>Whether <a href="http://php.net/manual/en/features.persistent-connections.php">persistent connections</a>
1418 should be used or not. Works with following extensions:
1419 <ul>
1420 <li>mysql (<a href="http://php.net/manual/en/function.mysql-pconnect.php">mysql_pconnect</a>),</li>
1421 <li>mysqli (requires PHP 5.3.0 or newer, <a href="http://php.net/manual/en/mysqli.persistconns.php">more information</a>).</li>
1422 </ul></dd>
1424 <dt id="cfg_ForceSSL">$cfg['ForceSSL'] boolean</dt>
1425 <dd>Whether to force using https while accessing phpMyAdmin.</dd>
1427 <dt id="cfg_ExecTimeLimit">$cfg['ExecTimeLimit'] integer [number of seconds]</dt>
1428 <dd>Set the number of seconds a script is allowed to run. If seconds is set
1429 to zero, no time limit is imposed.<br />
1430 This setting is used while importing/exporting dump files and in the
1431 Synchronize feature but has no effect when PHP is running in safe mode.</dd>
1433 <dt id="cfg_SessionSavePath">$cfg['SessionSavePath'] string</dt>
1434 <dd>Path for storing session data (<a
1435 href="http://php.net/session_save_path">session_save_path PHP parameter</a>).</dd>
1437 <dt id="cfg_MemoryLimit">$cfg['MemoryLimit'] string [number of bytes]</dt>
1438 <dd>Set the number of bytes a script is allowed to allocate. If set
1439 to zero, no limit is imposed.<br />
1440 This setting is used while importing/exporting dump files and at some
1441 other places in phpMyAdmin so you definitely don't want to put here
1442 a too low value. It has no effect when PHP is running in safe mode.<br />
1443 You can also use any string as in php.ini, eg. '16M'. Ensure
1444 you don't omit the suffix (16 means 16 bytes!)</dd>
1446 <dt id="cfg_SkipLockedTables">$cfg['SkipLockedTables'] boolean</dt>
1447 <dd>Mark used tables and make it possible to show databases with locked
1448 tables (since MySQL 3.23.30).</dd>
1450 <dt id="cfg_ShowSQL">$cfg['ShowSQL'] boolean</dt>
1451 <dd>Defines whether <abbr title="structured query language">SQL</abbr> queries
1452 generated by phpMyAdmin should be displayed or not.</dd>
1454 <dt id="cfg_RetainQueryBox">$cfg['RetainQueryBox'] boolean</dt>
1455 <dd>Defines whether the <abbr title="structured query language">SQL</abbr>
1456 query box should be kept displayed after its submission.</dd>
1458 <dt id="cfg_AllowUserDropDatabase">$cfg['AllowUserDropDatabase'] boolean</dt>
1459 <dd>Defines whether normal users (non-administrator) are allowed to
1460 delete their own database or not. If set as FALSE, the link &quot;Drop
1461 Database&quot; will not be shown, and even a &quot;DROP DATABASE
1462 mydatabase&quot; will be rejected. Quite practical for
1463 <abbr title="Internet service provider">ISP</abbr>'s with many
1464 customers.<br />
1465 Please note that this limitation of <abbr title="structured query language">
1466 SQL</abbr> queries is not as strict as when using MySQL privileges. This
1467 is due to nature of <abbr title="structured query language">SQL</abbr> queries
1468 which might be quite complicated. So this choice should be viewed as
1469 help to avoid accidental dropping rather than strict privilege
1470 limitation.</dd>
1472 <dt id="cfg_Confirm">$cfg['Confirm'] boolean</dt>
1473 <dd>Whether a warning (&quot;Are your really sure...&quot;) should be
1474 displayed when you're about to lose data.</dd>
1476 <dt id="cfg_LoginCookieRecall">$cfg['LoginCookieRecall'] boolean</dt>
1477 <dd>Define whether the previous login should be recalled or not in cookie
1478 authentication mode.<br /><br />
1480 This is automatically disabled if you do not have configured
1481 <tt><a href="#cfg_blowfish_secret">$cfg['blowfish_secret']</a></tt>.
1482 </dd>
1484 <dt id="cfg_LoginCookieValidity">$cfg['LoginCookieValidity'] integer [number of seconds]</dt>
1485 <dd>Define how long is login cookie valid. Please note that php
1486 configuration option <a href="http://php.net/manual/en/session.configuration.php#ini.session.gc-maxlifetime">session.gc_maxlifetime</a>
1487 might limit session validity and if session is lost, login cookie is
1488 also invalidated. So it is a good idea to set <code>session.gc_maxlifetime</code>
1489 not lower than the value of $cfg['LoginCookieValidity'].</dd>
1491 <dt id="cfg_LoginCookieStore">$cfg['LoginCookieStore'] integer [number of seconds]</dt>
1492 <dd>Define how long login cookie should be stored in browser. Default 0
1493 means that it will be kept for existing session. This is recommended
1494 for not trusted environments.</dd>
1496 <dt id="cfg_LoginCookieDeleteAll">$cfg['LoginCookieDeleteAll'] boolean</dt>
1497 <dd>If enabled (default), logout deletes cookies for all servers,
1498 otherwise only for current one. Setting this to false makes it easy to
1499 forget to log out from other server, when you are using more of
1500 them.</dd>
1502 <dt id="cfg_UseDbSearch">$cfg['UseDbSearch'] boolean</dt>
1503 <dd>Define whether the "search string inside database" is enabled or not.</dd>
1505 <dt id="cfg_IgnoreMultiSubmitErrors">$cfg['IgnoreMultiSubmitErrors'] boolean</dt>
1506 <dd>Define whether phpMyAdmin will continue executing a multi-query
1507 statement if one of the queries fails. Default is to abort execution.</dd>
1509 <dt id="cfg_VerboseMultiSubmit">$cfg['VerboseMultiSubmit'] boolean</dt>
1510 <dd>Define whether phpMyAdmin will output the results of each query of a
1511 multi-query statement embedded into the
1512 <abbr title="structured query language">SQL</abbr> output as inline
1513 comments. Defaults to <tt>TRUE</tt>.</dd>
1514 <dt id="AllowArbitraryServer">
1515 <span id="cfg_AllowArbitraryServer">$cfg['AllowArbitraryServer']</span> boolean</dt>
1516 <dd>If enabled, allows you to log in to arbitrary servers using cookie auth and permits to specify servers of your choice in the Synchronize dialog.
1517 <br /><br />
1519 <b>NOTE:</b> Please use this carefully, as this may allow users access to
1520 MySQL servers behind the firewall where your
1521 <abbr title="HyperText Transfer Protocol">HTTP</abbr> server is placed.
1522 </dd>
1524 <dt id ="cfg_Error_Handler_display">$cfg['Error_Handler']['display'] boolean</dt>
1525 <dd>Whether to display errors from PHP or not.</dd>
1527 <dt id ="cfg_Error_Handler_gather">$cfg['Error_Handler']['gather'] boolean</dt>
1528 <dd>Whether to gather errors from PHP or not.</dd>
1530 <dt id="cfg_LeftFrameLight">$cfg['LeftFrameLight'] boolean</dt>
1531 <dd>Defines whether to use a select-based menu and display only the current
1532 tables in the left frame (smaller page). Only in Non-Lightmode you can
1533 use the feature to display nested folders using
1534 <a href="#cfg_LeftFrameTableSeparator" class="configrule">$cfg['LeftFrameTableSeparator']</a>
1535 </dd>
1537 <dt id="cfg_LeftFrameDBTree">$cfg['LeftFrameDBTree'] boolean</dt>
1538 <dd>Defines whether to display the names of databases (in the
1539 selector) using a tree, see also
1540 <a href="#cfg_LeftFrameDBSeparator" class="configrule">$cfg['LeftFrameDBSeparator']</a>.
1541 </dd>
1543 <dt id="cfg_LeftFrameDBSeparator">$cfg['LeftFrameDBSeparator']
1544 string or array</dt>
1545 <dd>The string used to separate the parts of the database name when showing
1546 them in a tree. Alternatively you can specify more strings in an array
1547 and all of them will be used as a separator.</dd>
1549 <dt id="cfg_LeftFrameTableSeparator">$cfg['LeftFrameTableSeparator'] string</dt>
1550 <dd>Defines a string to be used to nest table spaces. Defaults to '__'.
1551 This means if you have tables like 'first__second__third' this will be
1552 shown as a three-level hierarchy like: first &gt; second &gt; third.
1553 If set to FALSE or empty, the feature is disabled. NOTE: You should
1554 not use this separator at the beginning or end of a
1555 table name or multiple times after another without any other
1556 characters in between.</dd>
1558 <dt id="cfg_LeftFrameTableLevel">$cfg['LeftFrameTableLevel'] string</dt>
1559 <dd>Defines how many sublevels should be displayed when splitting
1560 up tables by the above separator.</dd>
1562 <dt id="cfg_LeftRecentTable">$cfg['LeftRecentTable'] integer</dt>
1563 <dd>The maximum number of recently used tables shown in the left navigation
1564 frame. Set this to 0 (zero) to disable the listing of recent tables.</dd>
1566 <dt id="cfg_ShowTooltip">$cfg['ShowTooltip'] boolean</dt>
1567 <dd>Defines whether to display table comment as tool-tip in left frame or
1568 not.</dd>
1570 <dt id="cfg_ShowTooltipAliasDB">$cfg['ShowTooltipAliasDB'] boolean</dt>
1571 <dd>If tool-tips are enabled and a DB comment is set, this will flip the
1572 comment and the real name. That means that if you have a table called
1573 'user0001' and add the comment 'MyName' on it, you will see the name
1574 'MyName' used consequently in the left frame and the tool-tip shows
1575 the real name of the DB.</dd>
1577 <dt id="cfg_ShowTooltipAliasTB">$cfg['ShowTooltipAliasTB'] boolean/string</dt>
1578 <dd>Same as <a href="#cfg_ShowTooltipAliasDB" class="configrule">$cfg['ShowTooltipAliasDB']</a>, except this works for table names.
1580 When setting this to 'nested', the Alias of the Tablename is only used
1581 to split/nest the tables according to the
1582 <a href="#cfg_LeftFrameTableSeparator" class="configrule">$cfg['LeftFrameTableSeparator']</a>
1583 directive. So only the folder is called like the Alias, the tablename itself
1584 stays the real tablename.</dd>
1586 <dt id="cfg_LeftDisplayLogo">$cfg['LeftDisplayLogo'] boolean</dt>
1587 <dd>Defines whether or not to display the phpMyAdmin logo at the top of the left frame.
1588 Defaults to <tt>TRUE</tt>.</dd>
1589 <dt id="cfg_LeftLogoLink">$cfg['LeftLogoLink'] string</dt>
1590 <dd>Enter <abbr title="Uniform Resource Locator">URL</abbr> where logo in the navigation frame will point to.
1591 For use especially with self made theme which changes this.
1592 The default value for this is <tt>main.php</tt>.</dd>
1594 <dt id="cfg_LeftLogoLinkWindow">$cfg['LeftLogoLinkWindow'] string</dt>
1595 <dd>Whether to open the linked page in the main window (<tt>main</tt>)
1596 or in a new one (<tt>new</tt>). Note: use <tt>new</tt> if you are
1597 linking to <tt>phpmyadmin.net</tt>.</dd>
1599 <dt id="cfg_LeftDisplayTableFilterMinimum">$cfg['LeftDisplayTableFilterMinimum']
1600 integer</dt>
1601 <dd>Defines the minimum number of tables to display a JavaScript filter box above the
1602 list of tables in the left frame.
1603 Defaults to <tt>30</tt>. To disable the filter completely some high number
1604 can he used (e.g. 9999)</dd>
1606 <dt id="cfg_LeftDisplayServers">$cfg['LeftDisplayServers'] boolean</dt>
1607 <dd>Defines whether or not to display a server choice at the top of the left frame.
1608 Defaults to FALSE.</dd>
1609 <dt id="cfg_DisplayServersList">$cfg['DisplayServersList'] boolean</dt>
1610 <dd>Defines whether to display this server choice as links instead of in a drop-down.
1611 Defaults to FALSE (drop-down).</dd>
1612 <dt id="cfg_DisplayDatabasesList">$cfg['DisplayDatabasesList'] boolean or text</dt>
1613 <dd>Defines whether to display database choice in light navigation frame as links
1614 instead of in a drop-down. Defaults to 'auto' - on main page list is
1615 shown, when database is selected, only drop down is displayed.</dd>
1617 <dt id="cfg_LeftDefaultTabTable">$cfg['LeftDefaultTabTable'] string</dt>
1618 <dd>Defines the tab displayed by default when clicking the small
1619 icon next to each table name in the navigation panel. Possible
1620 values: &quot;tbl_structure.php&quot;,
1621 &quot;tbl_sql.php&quot;, &quot;tbl_select.php&quot;,
1622 &quot;tbl_change.php&quot; or &quot;sql.php&quot;.</dd>
1624 <dt id="cfg_ShowStats">$cfg['ShowStats'] boolean</dt>
1625 <dd>Defines whether or not to display space usage and statistics about databases
1626 and tables.<br />
1627 Note that statistics requires at least MySQL 3.23.3 and that, at this
1628 date, MySQL doesn't return such information for Berkeley DB tables.</dd>
1630 <dt><span id="cfg_ShowServerInfo">$cfg['ShowServerInfo'] </span>boolean</dt>
1631 <dd>Defines whether to display detailed server information on main page.
1632 You can additionally hide more information by using
1633 <tt><a href="#cfg_Servers_verbose">$cfg['Servers'][$i]['verbose']</a></tt>.
1634 </dd>
1636 <dt><span id="cfg_ShowPhpInfo">$cfg['ShowPhpInfo'] </span>boolean<br />
1637 <span id="cfg_ShowChgPassword">$cfg['ShowChgPassword'] </span>boolean<br />
1638 <span id="cfg_ShowCreateDb">$cfg['ShowCreateDb'] </span>boolean
1639 </dt>
1640 <dd>Defines whether to display the &quot;PHP information&quot; and
1641 &quot;Change password &quot; links and form for creating database or
1642 not at the starting main (right) frame. This setting
1643 does not check MySQL commands entered directly.<br /><br />
1645 Please note that to block the usage of phpinfo() in scripts, you
1646 have to put this in your <i>php.ini</i>:
1648 <pre>disable_functions = phpinfo()</pre>
1650 Also note that enabling the &quot;Change password &quot; link has no
1651 effect with &quot;config&quot; authentication mode: because of the
1652 hard coded password value in the configuration file, end users can't
1653 be allowed to change their passwords.</dd>
1655 <dt id="cfg_SuggestDBName">$cfg['SuggestDBName'] boolean</dt>
1656 <dd>Defines whether to suggest a database name on the
1657 &quot;Create Database&quot; form or to keep the textfield empty.</dd>
1659 <dt id="cfg_NavigationBarIconic">$cfg['NavigationBarIconic'] string</dt>
1660 <dd>Defines whether navigation bar buttons and the right panel top menu
1661 contain text or symbols only. A value of TRUE displays icons, FALSE
1662 displays text and 'both' displays both icons and text.</dd>
1664 <dt id="cfg_ShowAll">$cfg['ShowAll'] boolean</dt>
1665 <dd>Defines whether a user should be displayed a
1666 &quot;Show all&quot; button in browse mode or not in all cases.
1667 By default it is shown only on small tables (less than 5 &times;
1668 <a href="#cfg_MaxRows">$cfg['MaxRows']</a> rows) to avoid performance
1669 issues while getting too many rows.</dd>
1671 <dt id="cfg_MaxRows">$cfg['MaxRows'] integer</dt>
1672 <dd>Number of rows displayed when browsing a result set and no LIMIT
1673 clause is used. If the result set contains more rows, &quot;Previous&quot; and &quot;Next&quot; links will be shown.</dd>
1675 <dt id="cfg_Order">$cfg['Order'] string [<tt>DESC</tt>|<tt>ASC</tt>|<tt>SMART</tt>]</dt>
1676 <dd>Defines whether columns are displayed in ascending (<tt>ASC</tt>) order,
1677 in descending (<tt>DESC</tt>) order or in a &quot;smart&quot;
1678 (<tt>SMART</tt>) order - I.E. descending order for columns of type TIME,
1679 DATE, DATETIME and TIMESTAMP, ascending order else- by default.</dd>
1681 <dt id="cfg_DisplayBinaryAsHex">$cfg['DisplayBinaryAsHex'] boolean </dt>
1682 <dd>Defines whether the &quot;Show binary contents as HEX&quot; browse
1683 option is ticked by default.</dd>
1685 <dt id="cfg_ProtectBinary">$cfg['ProtectBinary'] boolean or string</dt>
1686 <dd>Defines whether <tt>BLOB</tt> or <tt>BINARY</tt> columns are protected
1687 from editing when browsing a table's content. Valid values are:
1688 <ul><li><tt>FALSE</tt> to allow editing of all columns;</li>
1689 <li><tt>'blob'</tt> to allow editing of all columns except <tt>BLOBS</tt>;</li>
1690 <li><tt>'all'</tt> to disallow editing of all <tt>BINARY</tt> or
1691 <tt>BLOB</tt> columns.</li>
1692 </ul>
1693 </dd>
1695 <dt id="cfg_ShowFunctionFields">$cfg['ShowFunctionFields'] boolean</dt>
1696 <dd>Defines whether or not MySQL functions fields should be initially
1697 displayed in edit/insert mode. Since version 2.10, the user can
1698 toggle this setting from the interface.
1699 </dd>
1701 <dt id="cfg_ShowFieldTypesInDataEditView">$cfg['ShowFieldTypesInDataEditView'] boolean</dt>
1702 <dd>Defines whether or not type fields should be initially
1703 displayed in edit/insert mode. The user can
1704 toggle this setting from the interface.
1705 </dd>
1707 <dt id="cfg_CharEditing">$cfg['CharEditing'] string</dt>
1708 <dd>Defines which type of editing controls should be used for CHAR and
1709 VARCHAR columns. Possible values are:
1710 <ul><li>input - this allows to limit size of text to size of columns in
1711 MySQL, but has problems with newlines in columns</li>
1712 <li>textarea - no problems with newlines in columns, but also no
1713 length limitations</li>
1714 </ul>
1715 Default is old behavior so input.</dd>
1717 <dt id="cfg_MinSizeForInputField">$cfg['MinSizeForInputField'] integer</dt>
1718 <dd>Defines the minimum size for input fields generated for CHAR and
1719 VARCHAR columns.</dd>
1721 <dt id="cfg_MaxSizeForInputField">$cfg['MaxSizeForInputField'] integer</dt>
1722 <dd>Defines the maximum size for input fields generated for CHAR and
1723 VARCHAR columns.</dd>
1725 <dt id="cfg_InsertRows">$cfg['InsertRows'] integer</dt>
1726 <dd>Defines the maximum number of concurrent entries for the Insert page.</dd>
1728 <dt id="cfg_ForeignKeyMaxLimit">$cfg['ForeignKeyMaxLimit'] integer</dt>
1729 <dd>If there are fewer items than this in the set of foreign keys, then a
1730 drop-down box of foreign keys is presented, in the style described by the
1731 <a href="#cfg_ForeignKeyDropdownOrder" class="configrule">$cfg['ForeignKeyDropdownOrder']</a>
1732 setting.</dd>
1734 <dt id="cfg_ForeignKeyDropdownOrder">$cfg['ForeignKeyDropdownOrder'] array</dt>
1735 <dd>For the foreign key drop-down fields, there are several methods of
1736 display, offering both the key and value data. The contents of the
1737 array should be one or both of the following strings:
1738 <i>'content-id'</i>, <i>'id-content'</i>.</dd>
1740 <dt><span id="cfg_ZipDump">$cfg['ZipDump'] </span>boolean<br />
1741 <span id="cfg_GZipDump">$cfg['GZipDump'] </span>boolean<br />
1742 <span id="cfg_BZipDump">$cfg['BZipDump'] </span>boolean
1743 </dt>
1744 <dd>Defines whether to allow the use of zip/GZip/BZip2 compression when
1745 creating a dump file</dd>
1747 <dt><span id="cfg_CompressOnFly">$cfg['CompressOnFly'] </span>boolean<br />
1748 </dt>
1749 <dd>Defines whether to allow on the fly compression for GZip/BZip2
1750 compressed exports. This doesn't affect smaller dumps and allows users to
1751 create larger dumps that won't otherwise fit in memory due to php
1752 memory limit. Produced files contain more GZip/BZip2 headers, but all
1753 normal programs handle this correctly.</dd>
1755 <dt id="cfg_LightTabs">$cfg['LightTabs'] boolean</dt>
1756 <dd>If set to <tt>TRUE</tt>, use less graphically intense tabs on the top of the
1757 mainframe.</dd>
1759 <dt id="cfg_PropertiesIconic">$cfg['PropertiesIconic'] string</dt>
1760 <dd>If set to <tt>TRUE</tt>, will display icons instead of text for db and table
1761 properties links (like 'Browse', 'Select', 'Insert', ...).<br /> Can be
1762 set to <tt>'both'</tt> if you want icons AND text.<br />
1763 When set to <tt>FALSE</tt>, will only show text.</dd>
1765 <dt id="cfg_PropertiesNumColumns">$cfg['PropertiesNumColumns'] integer</dt>
1766 <dd>How many columns will be utilized to display the tables on the
1767 database property view? Default is 1 column. When setting this to a
1768 value larger than 1, the type of the database will be omitted for more
1769 display space.</dd>
1772 <dt id="cfg_DefaultTabServer">$cfg['DefaultTabServer'] string</dt>
1773 <dd>Defines the tab displayed by default on server view. Possible
1774 values: &quot;main.php&quot; (recommended for multi-user setups),
1775 &quot;server_databases.php&quot;, &quot;server_status.php&quot;,
1776 &quot;server_variables.php&quot;, &quot;server_privileges.php&quot;
1777 or &quot;server_processlist.php&quot;.</dd>
1779 <dt id="cfg_DefaultTabDatabase">$cfg['DefaultTabDatabase'] string</dt>
1780 <dd>Defines the tab displayed by default on database view. Possible
1781 values: &quot;db_structure.php&quot;,
1782 &quot;db_sql.php&quot; or &quot;db_search.php&quot;.</dd>
1784 <dt id="cfg_DefaultTabTable">$cfg['DefaultTabTable'] string</dt>
1785 <dd>Defines the tab displayed by default on table view. Possible
1786 values: &quot;tbl_structure.php&quot;,
1787 &quot;tbl_sql.php&quot;, &quot;tbl_select.php&quot;,
1788 &quot;tbl_change.php&quot; or &quot;sql.php&quot;.</dd>
1790 <dt id="cfg_MySQLManualBase">$cfg['MySQLManualBase'] string</dt>
1791 <dd>If set to an <abbr title="Uniform Resource Locator">URL</abbr> which
1792 points to the MySQL documentation (type depends
1793 on <a href="#cfg_MySQLManualType" class="configrule">$cfg['MySQLManualType']</a>), appropriate help links are
1794 generated.<br />
1795 See <a href="http://dev.mysql.com/doc/">MySQL Documentation page</a>
1796 for more information about MySQL manuals and their types.</dd>
1798 <dt id="cfg_MySQLManualType">$cfg['MySQLManualType'] string</dt>
1799 <dd>Type of MySQL documentation:
1800 <ul><li>viewable - &quot;viewable online&quot;, current one used on MySQL website</li>
1801 <li>searchable - &quot;Searchable, with user comments&quot;</li>
1802 <li>chapters - &quot;HTML, one page per chapter&quot;</li>
1803 <li>big - &quot;HTML, all on one page&quot;</li>
1804 <li>none - do not show documentation links</li>
1805 </ul>
1806 </dd>
1808 <dt id="cfg_DefaultLang">$cfg['DefaultLang'] string</dt>
1809 <dd>Defines the default language to use, if not browser-defined or
1810 user-defined.<br />
1811 The corresponding language file needs to be in
1812 locale/<i>code</i>/LC_MESSAGES/phpmyadmin.mo.
1813 </dd>
1815 <dt id="cfg_DefaultConnectionCollation">$cfg['DefaultConnectionCollation'] string</dt>
1816 <dd>Defines the default connection collation to use, if not
1817 user-defined.<br />
1818 See the <a href="http://dev.mysql.com/doc/mysql/en/charset-charsets.html">MySQL
1819 documentation</a> for list of possible values. This setting is ignored when
1820 connected to Drizzle server.</dd>
1822 <dt id="cfg_Lang">$cfg['Lang'] string</dt>
1823 <dd>Force language to use.<br />
1824 The corresponding language file needs to be in
1825 locale/<i>code</i>/LC_MESSAGES/phpmyadmin.mo.
1826 </dd>
1828 <dt id="cfg_FilterLanguages">$cfg['FilterLanguages'] string</dt>
1829 <dd>Limit list of available languages to those matching the given regular
1830 expression. For example if you want only Czech and English, you should
1831 set filter to <code>'^(cs|en)'</code>.</dd>
1833 <dt id="cfg_RecodingEngine">$cfg['RecodingEngine'] string</dt>
1834 <dd>You can select here which functions will be used for character set
1835 conversion. Possible values are:
1836 <ul><li>auto - automatically use available one (first is tested
1837 iconv, then recode)</li>
1838 <li>iconv - use iconv or libiconv functions</li>
1839 <li>recode - use recode_string function</li>
1840 <li>none - disable encoding conversion</li>
1841 </ul>
1842 Default is auto.</dd>
1843 <dd>
1844 Enabled charset conversion activates a pull-down menu
1845 in the Export and Import pages, to choose the character set when
1846 exporting a file. The default value in this menu comes from
1847 <tt>$cfg['Export']['charset']</tt> and <tt>$cfg['Import']['charset']</tt>.
1848 </dd>
1850 <dt id="cfg_IconvExtraParams">$cfg['IconvExtraParams'] string</dt>
1851 <dd>Specify some parameters for iconv used in charset conversion. See
1852 <a href="http://www.gnu.org/software/libiconv/documentation/libiconv/iconv_open.3.html">iconv
1853 documentation</a> for details. By default <code>//TRANSLIT</code> is
1854 used, so that invalid characters will be transliterated.</dd>
1856 <dt id="cfg_AvailableCharsets">$cfg['AvailableCharsets'] array</dt>
1857 <dd>Available character sets for MySQL conversion. You can add your own (any of
1858 supported by recode/iconv) or remove these which you don't use.
1859 Character sets will be shown in same order as here listed, so if you
1860 frequently use some of these move them to the top.</dd>
1862 <dt id="cfg_TrustedProxies">$cfg['TrustedProxies'] array</dt>
1863 <dd>Lists proxies and HTTP headers which are trusted for <a
1864 href="#servers_allowdeny_order">IP Allow/Deny</a>. This list is by
1865 default empty, you need to fill in some trusted proxy servers if you
1866 want to use rules for IP addresses behind proxy.<br /><br />
1868 The following example specifies that phpMyAdmin should trust a
1869 HTTP_X_FORWARDED_FOR (<tt>X-Forwarded-For</tt>) header coming from the proxy 1.2.3.4:
1870 <pre>
1871 $cfg['TrustedProxies'] =
1872 array('1.2.3.4' =&gt; 'HTTP_X_FORWARDED_FOR');
1873 </pre>
1874 The $cfg['Servers'][$i]['AllowDeny']['rules'] directive uses the
1875 client's IP address as usual.
1876 </dd>
1878 <dt id="cfg_GD2Available">$cfg['GD2Available'] string</dt>
1879 <dd>Specifies whether GD &gt;= 2 is available. If yes it can be used for
1880 MIME transformations.<br />
1881 Possible values are:
1882 <ul><li>auto - automatically detect</li>
1883 <li>yes - GD 2 functions can be used</li>
1884 <li>no - GD 2 function cannot be used</li>
1885 </ul>
1886 Default is auto.
1887 </dd>
1889 <dt id="cfg_CheckConfigurationPermissions">$cfg['CheckConfigurationPermissions'] boolean</dt>
1890 <dd>
1891 We normally check the permissions on the configuration file to ensure
1892 it's not world writable. However, phpMyAdmin could be installed on
1893 a NTFS filesystem mounted on a non-Windows server, in which case the
1894 permissions seems wrong but in fact cannot be detected. In this case
1895 a sysadmin would set this parameter to <tt>FALSE</tt>. Default is <tt>TRUE</tt>.
1896 </dd>
1898 <dt id="cfg_LinkLengthLimit">$cfg['LinkLengthLimit'] integer</dt>
1899 <dd>
1900 Limit for length of <abbr title="Uniform Resource Locator">URL</abbr> in links.
1901 When length would be above this limit, it is replaced by form with button.
1902 This is required as some web servers (<abbr title="Internet Information Services">
1903 IIS</abbr>) have problems with long <abbr title="Uniform Resource Locator">
1904 URL</abbr>s. Default is <code>1000</code>.
1905 </dd>
1908 id="cfg_DisableMultiTableMaintenance">$cfg['DisableMultiTableMaintenance'] boolean</dt>
1909 <dd>
1910 In the database Structure page, it's possible to mark some tables then
1911 choose an operation like optimizing for many tables. This can slow down
1912 a server; therefore, setting this to <code>true</code> prevents this kind
1913 of multiple maintenance operation. Default is <code>false</code>.
1914 </dd>
1916 <dt id="cfg_NaviWidth">$cfg['NaviWidth'] integer</dt>
1917 <dd>Navi frame width in pixels. See <tt>themes/themename/layout.inc.php</tt>.
1918 </dd>
1920 <dt><span id="cfg_NaviBackground">$cfg['NaviBackground']</span> string [CSS color for background]<br />
1921 <span id="cfg_MainBackground">$cfg['MainBackground']</span> string [CSS color for background]
1922 </dt>
1923 <dd>The background styles used for both the frames.
1924 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1926 <dt id="cfg_NaviPointerBackground">$cfg['NaviPointerBackground'] string [CSS color for background]<br />
1927 <span id="cfg_NaviPointerColor">$cfg['NaviPointerColor']</span> string [CSS color]</dt>
1928 <dd>The style used for the pointer in the navi frame.
1929 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1931 <dt id="cfg_LeftPointerEnable">$cfg['LeftPointerEnable'] boolean</dt>
1932 <dd>A value of <tt>TRUE</tt> activates the navi pointer (when LeftFrameLight
1933 is <tt>FALSE</tt>).</dd>
1935 <dt id="cfg_Border">$cfg['Border'] integer</dt>
1936 <dd>The size of a table's border. See <tt>themes/themename/layout.inc.php</tt>.
1937 </dd>
1939 <dt id="cfg_ThBackground">$cfg['ThBackground'] string [CSS color for background]<br />
1940 <span id="cfg_ThColor">$cfg['ThColor']</span> string [CSS color]</dt>
1941 <dd>The style used for table headers. See
1942 <tt>themes/themename/layout.inc.php</tt>.</dd>
1944 <dt id="cfg_BgcolorOne">$cfg['BgOne'] string [CSS color]</dt>
1945 <dd>The color (HTML) #1 for table rows. See <tt>themes/themename/layout.inc.php</tt>.
1946 </dd>
1948 <dt id="cfg_BgcolorTwo">$cfg['BgTwo'] string [CSS color]</dt>
1949 <dd>The color (HTML) #2 for table rows. See <tt>themes/themename/layout.inc.php</tt>.
1950 </dd>
1952 <dt><span id="cfg_BrowsePointerBackground">$cfg['BrowsePointerBackground'] </span>string [CSS color]<br />
1953 <span id="cfg_BrowsePointerColor">$cfg['BrowsePointerColor'] </span>string [CSS color]<br />
1954 <span id="cfg_BrowseMarkerBackground">$cfg['BrowseMarkerBackground'] </span>string [CSS color]<br />
1955 <span id="cfg_BrowseMarkerColor">$cfg['BrowseMarkerColor'] </span>string [CSS color]
1956 </dt>
1957 <dd>The colors (HTML) uses for the pointer and the marker in browse mode.<br />
1958 The former feature highlights the row over which your mouse is passing
1959 and the latter lets you visually mark/unmark rows by clicking on
1960 them. Highlighting / marking a column is done by hovering over /
1961 clicking the column's header (outside of the text).<br />
1962 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1965 <dt id="cfg_FontFamily">$cfg['FontFamily'] string</dt>
1966 <dd>You put here a valid CSS font family value, for example
1967 <tt>arial, sans-serif</tt>.<br />
1968 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1970 <dt id="cfg_FontFamilyFixed">$cfg['FontFamilyFixed'] string</dt>
1971 <dd>You put here a valid CSS font family value, for example
1972 <tt>monospace</tt>. This one is used in textarea.<br />
1973 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1975 <dt id="cfg_BrowsePointerEnable">$cfg['BrowsePointerEnable'] boolean</dt>
1976 <dd>Whether to activate the browse pointer or not.</dd>
1978 <dt id="cfg_BrowseMarkerEnable">$cfg['BrowseMarkerEnable'] boolean</dt>
1979 <dd>Whether to activate the browse marker or not.</dd>
1981 <dt><span id="cfg_TextareaCols">$cfg['TextareaCols'] </span>integer<br />
1982 <span id="cfg_TextareaRows">$cfg['TextareaRows'] </span>integer<br />
1983 <span id="cfg_CharTextareaCols">$cfg['CharTextareaCols'] </span>integer<br />
1984 <span id="cfg_CharTextareaRows">$cfg['CharTextareaRows'] </span>integer
1985 </dt>
1986 <dd>Number of columns and rows for the textareas.<br />
1987 This value will be emphasized (*2) for <abbr title="structured query language">SQL</abbr> query textareas and (*1.25) for
1988 <abbr title="structured query language">SQL</abbr> textareas inside the query window.<br />
1989 The Char* values are used for CHAR and VARCHAR editing (if configured
1990 via <a href="#cfg_CharEditing">$cfg['CharEditing']</a>).</dd>
1992 <dt><span id="cfg_LongtextDoubleTextarea">$cfg['LongtextDoubleTextarea'] </span>boolean
1993 </dt>
1994 <dd>Defines whether textarea for LONGTEXT columns should have double size.</dd>
1996 <dt><span id="cfg_TextareaAutoSelect">$cfg['TextareaAutoSelect'] </span>boolean
1997 </dt>
1998 <dd>Defines if the whole textarea of the query box will be selected on
1999 click.</dd>
2001 <dt id="cfg_LimitChars">$cfg['LimitChars'] integer</dt>
2002 <dd>Maximum number of characters shown in any non-numeric field on browse view.
2003 Can be turned off by a toggle button on the browse page.</dd>
2005 <dt><span id="cfg_RowActionLinks">$cfg['RowActionLinks'] </span>string
2006 </dt>
2007 <dd>Defines the place where table row links (Edit, Copy,
2008 Delete) would be put when tables contents are displayed (you may
2009 have them displayed at the left side, right side, both sides or nowhere).
2010 &quot;left&quot; and &quot;right&quot; are parsed as &quot;top&quot;
2011 and &quot;bottom&quot; with vertical display mode.</dd>
2013 <dt id="cfg_DefaultDisplay">$cfg['DefaultDisplay'] string</dt>
2014 <dd>There are 3 display modes: horizontal, horizontalflipped and vertical.
2015 Define which one is displayed by default. The first mode displays each
2016 row on a horizontal line, the second rotates the headers by 90
2017 degrees, so you can use descriptive headers even though columns only
2018 contain small values and still print them out. The vertical mode sorts
2019 each row on a vertical lineup.
2020 </dd>
2022 <dt id="cfg_RememberSorting">$cfg['RememberSorting'] boolean</dt>
2023 <dd>If enabled, remember the sorting of each table when browsing them.</dd>
2025 <dt id="cfg_HeaderFlipType">$cfg['HeaderFlipType'] string</dt>
2026 <dd>
2027 The HeaderFlipType can be set to 'auto', 'css' or 'fake'. When using
2028 'css' the rotation of the header for horizontalflipped is done via
2029 CSS. The CSS transformation currently works only in Internet
2030 Explorer.If set to 'fake' PHP does the transformation for you, but of
2031 course this does not look as good as CSS. The 'auto' option enables
2032 CSS transformation when browser supports it and use PHP based one
2033 otherwise.
2034 </dd>
2036 <dt id="cfg_ShowBrowseComments">$cfg['ShowBrowseComments'] boolean<br />
2037 <span id="cfg_ShowPropertyComments">$cfg['ShowPropertyComments'] </span>boolean
2038 </dt>
2039 <dd>By setting the corresponding variable to <tt>TRUE</tt> you can enable the
2040 display of column comments in Browse or Property display. In browse
2041 mode, the comments are shown inside the header. In property mode,
2042 comments are displayed using a CSS-formatted dashed-line below the
2043 name of the column. The comment is shown as a tool-tip for that column.
2044 </dd>
2046 <dt id ="cfg_SQLQuery_Edit">$cfg['SQLQuery']['Edit'] boolean</dt>
2047 <dd>Whether to display an edit link to change a query in any SQL Query box.</dd>
2049 <dt id ="cfg_SQLQuery_Explain">$cfg['SQLQuery']['Explain'] boolean</dt>
2050 <dd>Whether to display a link to explain a SELECT query in any SQL Query box.</dd>
2052 <dt id ="cfg_SQLQuery_ShowAsPHP">$cfg['SQLQuery']['ShowAsPHP'] boolean</dt>
2053 <dd>Whether to display a link to wrap a query in PHP code in any SQL Query box.</dd>
2055 <dt id ="cfg_SQLQuery_Validate">$cfg['SQLQuery']['Validate'] boolean</dt>
2056 <dd>Whether to display a link to validate a query in any SQL Query box.
2057 See also <tt><a href="#cfg_SQLValidator">$cfg_SQLValidator</a></tt>.</dd>
2059 <dt id ="cfg_SQLQuery_Refresh">$cfg['SQLQuery']['Refresh'] boolean</dt>
2060 <dd>Whether to display a link to refresh a query in any SQL Query box.</dd>
2062 <dt id="cfg_UploadDir">$cfg['UploadDir'] string</dt>
2063 <dd>
2064 The name of the directory where
2065 <abbr title="structured query language">SQL</abbr> files have been
2066 uploaded by other means than phpMyAdmin (for example, ftp). Those files
2067 are available under a drop-down box when you click the database or
2068 table name, then the Import tab.
2069 <br /><br />
2071 If you want different directory for each user, %u will be replaced
2072 with username.<br /><br />
2074 Please note that the file names must have the suffix &quot;.sql&quot;
2075 (or &quot;.sql.bz2&quot; or &quot;.sql.gz&quot; if support for
2076 compressed formats is enabled).<br /><br />
2078 This feature is useful when your file is too big to be uploaded via
2079 <abbr title="HyperText Transfer Protocol">HTTP</abbr>, or when file
2080 uploads are disabled in PHP.<br /><br />
2082 Please note that if PHP is running in safe mode, this directory must
2083 be owned by the same user as the owner of the phpMyAdmin scripts.
2084 <br /><br />
2086 See also <a href="#faq1_16">
2087 <abbr title="Frequently Asked Questions">FAQ</abbr> 1.16</a> for
2088 alternatives.
2089 </dd>
2091 <dt id="cfg_SaveDir">$cfg['SaveDir'] string</dt>
2092 <dd>
2093 The name of the directory where dumps can be saved.<br /><br />
2095 If you want different directory for each user, %u will be replaced
2096 with username.<br /><br />
2098 Please note that the directory must exist and has to be writable for
2099 the user running webserver.<br /><br />
2101 Please note that if PHP is running in safe mode, this directory must
2102 be owned by the same user as the owner of the phpMyAdmin scripts.
2103 </dd>
2105 <dt id="cfg_TempDir">$cfg['TempDir'] string</dt>
2106 <dd>
2107 The name of the directory where temporary files can be stored.
2108 <br /><br />
2110 This is needed for importing ESRI Shapefiles, see
2111 <a href="#faq6_30"><abbr title="Frequently Asked Questions">FAQ</abbr>
2112 6.30</a> and to work around limitations of <tt>open_basedir</tt> for uploaded
2113 files, see <a href="#faq1_11"><abbr title="Frequently Asked Questions">FAQ</abbr>
2114 1.11</a>.
2115 <br /><br />
2117 If the directory where phpMyAdmin is installed is subject to an
2118 <tt>open_basedir</tt> restriction, you need to create a
2119 temporary directory in some directory accessible by the web
2120 server. However for security reasons, this directory should be outside
2121 the tree published by webserver. If you cannot avoid having this
2122 directory published by webserver, place at least an empty
2123 <tt>index.html</tt> file there, so that directory listing is not
2124 possible.
2125 <br /><br />
2127 This directory should have as strict permissions as possible as the only
2128 user required to access this directory is the one who runs the
2129 webserver. If you have root privileges, simply make this user owner of
2130 this directory and make it accessible only by it:
2131 <br /><br />
2133 <pre>
2134 chown www-data:www-data tmp
2135 chmod 700 tmp
2136 </pre>
2138 If you cannot change owner of the directory, you can achieve a similar
2139 setup using <abbr title="Access Control List">ACL</abbr>:
2141 <pre>
2142 chmod 700 tmp
2143 setfacl -m "g:www-data:rwx" tmp
2144 setfacl -d -m "g:www-data:rwx" tmp
2145 </pre>
2147 If neither of above works for you, you can still make the directory
2148 <code>chmod 777</code>, but it might impose risk of other users on
2149 system reading and writing data in this directory.
2150 </dd>
2152 <dt id="cfg_Export">$cfg['Export'] array</dt>
2153 <dd>
2154 In this array are defined default parameters for export, names of
2155 items are similar to texts seen on export page, so you can easily
2156 identify what they mean.
2157 </dd>
2159 <dt id="cfg_Export_method">$cfg['Export']['method'] string</dt>
2160 <dd>
2161 Defines how the export form is displayed when it loads. Valid values are:
2162 <ul>
2163 <li><tt>quick</tt> to display the minimum number of options to configure</li>
2164 <li><tt>custom</tt> to display every available option to configure</li>
2165 <li><tt>custom-no-form</tt> same as <tt>custom</tt> but does not display the option of using quick export</li>
2166 </ul>
2167 </dd>
2169 <dt id="cfg_Import">$cfg['Import'] array</dt>
2170 <dd>
2171 In this array are defined default parameters for import, names of
2172 items are similar to texts seen on import page, so you can easily
2173 identify what they mean.
2174 </dd>
2176 <dt id="cfg_SaveCellsAtOnce">$cfg['SaveCellsAtOnce'] boolean</dt>
2177 <dd>
2178 Defines whether or not to save all edited cells at once in browse-mode.
2179 </dd>
2181 <dt id="cfg_ShowDisplayDirection">$cfg['ShowDisplayDirection'] boolean</dt>
2182 <dd>
2183 Defines whether or not type display direction option is shown
2184 when browsing a table.
2185 </dd>
2187 <dt id="cfg_RepeatCells">$cfg['RepeatCells'] integer</dt>
2188 <dd>
2189 Repeat the headers every X cells, or 0 to deactivate.
2190 </dd>
2192 <dt id="cfg_EditInWindow">$cfg['EditInWindow'] boolean<br />
2193 <span id="cfg_QueryWindowWidth">$cfg['QueryWindowWidth'] </span>integer<br />
2194 <span id="cfg_QueryWindowHeight">$cfg['QueryWindowHeight'] </span>integer<br />
2195 <span id="cfg_QueryHistoryDB">$cfg['QueryHistoryDB'] </span>boolean<br />
2196 <span id="cfg_QueryWindowDefTab">$cfg['QueryWindowDefTab'] </span>string<br />
2197 <span id="cfg_QueryHistoryMax">$cfg['QueryHistoryMax'] </span>integer
2198 </dt>
2199 <dd>
2200 All those variables affect the query window feature. A <tt><abbr title="structured query language">SQL</abbr></tt> link
2201 or icon is always displayed on the left panel. If JavaScript is enabled in
2202 your browser, a click on this opens a distinct query window, which is
2203 a direct interface to enter <abbr title="structured query language">SQL</abbr> queries. Otherwise, the right panel
2204 changes to display a query box.<br /><br />
2206 The size of this query window can be customized with
2207 <tt>$cfg['QueryWindowWidth']</tt> and <tt>$cfg['QueryWindowHeight']</tt>
2208 - both integers for the size in pixels. Note that normally, those
2209 parameters will be modified in <tt>layout.inc.php</tt> for the
2210 theme you are using.<br /><br />
2212 If <tt>$cfg['EditInWindow']</tt> is set to true, a click on [Edit]
2213 from the results page (in the &quot;Showing Rows&quot; section)
2214 opens the query window and puts the current query
2215 inside it. If set to false, clicking on the link puts the <abbr title="structured query language">SQL</abbr>
2216 query in the right panel's query box.
2217 <br /><br />
2218 The usage of the JavaScript query window is recommended if you have a
2219 JavaScript enabled browser. Basic functions are used to exchange quite
2220 a few variables, so most 4th generation browsers should be capable to
2221 use that feature. It currently is only tested with Internet Explorer 6
2222 and Mozilla 1.x.
2223 <br /><br />
2224 If <tt>$cfg['QueryHistoryDB']</tt> is set to <tt>TRUE</tt>, all your Queries are logged
2225 to a table, which has to be created by you (see <a
2226 href="#history" class="configrule">$cfg['Servers'][$i]['history']</a>). If set to FALSE,
2227 all your queries will be appended to the form, but only as long as
2228 your window is opened they remain saved.
2229 <br /><br />
2230 When using the JavaScript based query window, it will always get
2231 updated when you click on a new table/db to browse and will focus if
2232 you click on "Edit <abbr title="structured query language">SQL</abbr>" after using a query. You can suppress updating
2233 the query window by checking the box "Do not overwrite this query from
2234 outside the window" below the query textarea. Then you can browse
2235 tables/databases in the background without losing the contents of the
2236 textarea, so this is especially useful when composing a query with
2237 tables you first have to look in. The checkbox will get automatically
2238 checked whenever you change the contents of the textarea. Please
2239 uncheck the button whenever you definitely want the query window to
2240 get updated even though you have made alterations.
2241 <br /><br />
2242 If <tt>$cfg['QueryHistoryDB']</tt> is set to <tt>TRUE</tt> you can specify the amount of
2243 saved history items using <tt>$cfg['QueryHistoryMax']</tt>.
2244 <br /><br />
2245 The query window also has a custom tabbed look to group the features.
2246 Using the variable <tt>$cfg['QueryWindowDefTab']</tt> you can specify the
2247 default tab to be used when opening the query window. It can be set to
2248 either 'sql', 'files', 'history' or 'full'.</dd>
2250 <dt id="cfg_BrowseMIME">$cfg['BrowseMIME'] boolean</dt>
2251 <dd>Enable <a href="#transformations">MIME-transformations</a>.</dd>
2253 <dt id="cfg_MaxExactCount">$cfg['MaxExactCount'] integer</dt>
2254 <dd>For InnoDB tables, determines for how large tables phpMyAdmin
2255 should get the exact row count using <code>SELECT COUNT</code>.
2256 If the approximate row count as returned by
2257 <code>SHOW TABLE STATUS</code> is smaller than this value,
2258 <code>SELECT COUNT</code> will be used, otherwise the approximate
2259 count will be used.
2260 </dd>
2261 <dt id="cfg_MaxExactCountViews">$cfg['MaxExactCountViews'] integer</dt>
2262 <dd>For VIEWs, since obtaining the exact count could have an
2263 impact on performance, this value is the maximum to be displayed, using
2264 a <code>SELECT COUNT ... LIMIT</code>. Setting this to 0 bypasses
2265 any row counting.
2266 </dd>
2268 <dt id="cfg_NaturalOrder">$cfg['NaturalOrder'] boolean</dt>
2269 <dd>Sorts database and table names according to natural order (for example,
2270 t1, t2, t10). Currently implemented in the left panel (Light mode)
2271 and in Database view, for the table list.</dd>
2273 <dt id="cfg_InitialSlidersState">$cfg['InitialSlidersState'] string</dt>
2274 <dd>If set to <tt>'closed'</tt>, the visual sliders are initially in a
2275 closed state. A value of <tt>'open'</tt> does the reverse. To completely
2276 disable all visual sliders, use <tt>'disabled'</tt>.</dd>
2278 <dt id="cfg_UserprefsDisallow">$cfg['UserprefsDisallow'] array</dt>
2279 <dd>Contains names of configuration options (keys in <tt>$cfg</tt> array)
2280 that users can't set through user preferences. For possible values, refer
2281 to <tt>libraries/config/user_preferences.forms.php</tt>.</dd>
2283 <dt id="cfg_UserprefsDeveloperTab">$cfg['UserprefsDeveloperTab'] boolean</dt>
2284 <dd>Activates in the user preferences a tab containing options for
2285 developers of phpMyAdmin.</dd>
2287 <dt id="cfg_TitleTable">$cfg['TitleTable'] string</dt>
2288 <dt id="cfg_TitleDatabase">$cfg['TitleDatabase'] string</dt>
2289 <dt id="cfg_TitleServer">$cfg['TitleServer'] string</dt>
2290 <dt id="cfg_TitleDefault">$cfg['TitleDefault'] string</dt>
2291 <dd>Allows you to specify window's title bar. You can use
2292 <a href="#faq6_27">format string expansion</a>.
2293 </dd>
2295 <dt id="cfg_ErrorIconic">$cfg['ErrorIconic'] boolean</dt>
2296 <dd>Uses icons for warnings, errors and informations.</dd>
2298 <dt id="cfg_MainPageIconic">$cfg['MainPageIconic'] boolean</dt>
2299 <dd>Uses icons on main page in lists and menu tabs.</dd>
2301 <dt id="cfg_ReplaceHelpImg">$cfg['ReplaceHelpImg'] boolean</dt>
2302 <dd>Shows a help button instead of the &quot;Documentation&quot; message.
2303 </dd>
2305 <dt id="cfg_ThemePath">$cfg['ThemePath'] string</dt>
2306 <dd>If theme manager is active, use this as the path of the subdirectory
2307 containing all the themes.</dd>
2309 <dt id="cfg_ThemeManager">$cfg['ThemeManager'] boolean</dt>
2310 <dd>Enables user-selectable themes. See <a href="#faqthemes">
2311 <abbr title="Frequently Asked Questions">FAQ</abbr> 2.7</a>.</dd>
2313 <dt id="cfg_ThemeDefault">$cfg['ThemeDefault'] string</dt>
2314 <dd>The default theme (a subdirectory under <tt>cfg['ThemePath']</tt>).</dd>
2316 <dt id="cfg_ThemePerServer">$cfg['ThemePerServer'] boolean</dt>
2317 <dd>Whether to allow different theme for each server.</dd>
2319 <dt id="cfg_DefaultQueryTable">$cfg['DefaultQueryTable'] string<br />
2320 <span id="cfg_DefaultQueryDatabase">$cfg['DefaultQueryDatabase']</span> string
2321 </dt>
2322 <dd>Default queries that will be displayed in query boxes when user didn't
2323 specify any. You can use standard
2324 <a href="#faq6_27">format string expansion</a>.
2325 </dd>
2327 <dt id="cfg_SQP_fmtType">$cfg['SQP']['fmtType'] string [<tt>html</tt>|<tt>none</tt>]</dt>
2328 <dd>
2329 The main use of the new <abbr title="structured query language">SQL</abbr> Parser is to pretty-print <abbr title="structured query language">SQL</abbr> queries. By
2330 default we use HTML to format the query, but you can disable this by
2331 setting this variable to <tt>'none'</tt>.
2332 </dd>
2334 <dt id="cfg_SQP_fmtInd">$cfg['SQP']['fmtInd'] float<br />
2335 <span id="cfg_SQP">$cfg['SQP']['fmtIndUnit']</span> string [<tt>em</tt>|<tt>px</tt>|<tt>pt</tt>|<tt>ex</tt>]</dt>
2336 <dd>For the pretty-printing of <abbr title="structured query language">SQL</abbr> queries, under some cases the part of a
2337 query inside a bracket is indented. By changing
2338 <tt>$cfg['SQP']['fmtInd']</tt> you can change the amount of this indent.
2339 <br />Related in purpose is <tt>$cfg['SQP']['fmtIndUnit']</tt> which
2340 specifies the units of the indent amount that you specified. This is
2341 used via stylesheets.</dd>
2343 <dt id="cfg_SQP_fmtColor">$cfg['SQP']['fmtColor'] array of string tuples</dt>
2344 <dd>This array is used to define the colours for each type of element of
2345 the pretty-printed <abbr title="structured query language">SQL</abbr> queries. The tuple format is<br />
2346 <i>class</i> =&gt; [<i>HTML colour code</i> | <i>empty string</i>]<br />
2347 If you specify an empty string for the color of a class, it is ignored
2348 in creating the stylesheet.
2349 You should not alter the class names, only the colour strings.<br />
2350 <b>Class name key:</b>
2351 <ul><li><b>comment</b> Applies to all comment sub-classes</li>
2352 <li><b>comment_mysql</b> Comments as <tt>"#...\n"</tt></li>
2353 <li><b>comment_ansi</b> Comments as <tt>"-- ...\n"</tt></li>
2354 <li><b>comment_c</b> Comments as <tt>"/*...*/"</tt></li>
2355 <li><b>digit</b> Applies to all digit sub-classes</li>
2356 <li><b>digit_hex</b> Hexadecimal numbers</li>
2357 <li><b>digit_integer</b> Integer numbers</li>
2358 <li><b>digit_float</b> Floating point numbers</li>
2359 <li><b>punct</b> Applies to all punctuation sub-classes</li>
2360 <li><b>punct_bracket_open_round</b> Opening brackets<tt>"("</tt></li>
2361 <li><b>punct_bracket_close_round</b> Closing brackets <tt>")"</tt></li>
2362 <li><b>punct_listsep</b> List item Separator <tt>","</tt></li>
2363 <li><b>punct_qualifier</b> Table/Column Qualifier <tt>"."</tt> </li>
2364 <li><b>punct_queryend</b> End of query marker <tt>";"</tt></li>
2365 <li><b>alpha</b> Applies to all alphabetic classes</li>
2366 <li><b>alpha_columnType</b> Identifiers matching a column type</li>
2367 <li><b>alpha_columnAttrib</b> Identifiers matching a database/table/column attribute</li>
2368 <li><b>alpha_functionName</b> Identifiers matching a MySQL function name</li>
2369 <li><b>alpha_reservedWord</b> Identifiers matching any other reserved word</li>
2370 <li><b>alpha_variable</b> Identifiers matching a <abbr title="structured query language">SQL</abbr> variable <tt>"@foo"</tt></li>
2371 <li><b>alpha_identifier</b> All other identifiers</li>
2372 <li><b>quote</b> Applies to all quotation mark classes</li>
2373 <li><b>quote_double</b> Double quotes <tt>"</tt></li>
2374 <li><b>quote_single</b> Single quotes <tt>'</tt></li>
2375 <li><b>quote_backtick</b> Backtick quotes <tt>`</tt></li>
2376 </ul>
2377 </dd>
2379 <dt id="cfg_SQLValidator">$cfg['SQLValidator'] boolean</dt>
2380 <dd><dl><dt id="cfg_SQLValidator_use">$cfg['SQLValidator']['use'] boolean</dt>
2381 <dd>phpMyAdmin now supports use of the <a href="http://developer.mimer.com/validator/index.htm">Mimer <abbr title="structured query language">SQL</abbr> Validator</a> service,
2382 as originally published on
2383 <a href="http://developers.slashdot.org/article.pl?sid=02/02/19/1720246">Slashdot</a>.
2384 <br />
2385 For help in setting up your system to use the service, see the
2386 <a href="#faqsqlvalidator"><abbr title="Frequently Asked Questions">FAQ</abbr> 6.14</a>.
2387 </dd>
2389 <dt id="cfg_SQLValidator_username">$cfg['SQLValidator']['username'] string<br />
2390 <span id="cfg_SQLValidator_password">$cfg['SQLValidator']['password']</span> string</dt>
2391 <dd>The SOAP service allows you to log in with <tt>anonymous</tt>
2392 and any password, so we use those by default. Instead, if
2393 you have an account with them, you can put your login details
2394 here, and it will be used in place of the anonymous login.</dd>
2395 </dl>
2396 </dd>
2398 <dt id="cfg_DBG">$cfg['DBG']</dt>
2399 <dd><b>DEVELOPERS ONLY!</b></dd>
2401 <dt id="cfg_DBG_sql">$cfg['DBG']['sql'] boolean</dt>
2402 <dd><b>DEVELOPERS ONLY!</b><br />
2403 Enable logging queries and execution times to be displayed in the bottom
2404 of main page (right frame).</dd>
2406 <dt id="cfg_ColumnTypes">$cfg['ColumnTypes'] array</dt>
2407 <dd>All possible types of a MySQL column. In most cases you don't need to
2408 edit this.</dd>
2410 <dt id="cfg_AttributeTypes">$cfg['AttributeTypes'] array</dt>
2411 <dd>Possible attributes for columns. In most cases you don't need to edit
2412 this.</dd>
2414 <dt id="cfg_Functions">$cfg['Functions'] array</dt>
2415 <dd>A list of functions MySQL supports. In most cases you don't need to
2416 edit this.</dd>
2418 <dt id="cfg_RestrictColumnTypes">$cfg['RestrictColumnTypes'] array</dt>
2419 <dd>Mapping of column types to meta types used for preferring displayed
2420 functions. In most cases you don't need to edit this.</dd>
2422 <dt id="cfg_RestrictFunctions">$cfg['RestrictFunctions'] array</dt>
2423 <dd>Functions preferred for column meta types as defined in
2424 <a href="#cfg_RestrictColumnTypes" class="configrule">$cfg['RestrictColumnTypes']</a>. In most cases you don't need
2425 to edit this.</dd>
2427 <dt id="cfg_DefaultFunctions">$cfg['DefaultFunctions'] array</dt>
2428 <dd>Functions selected by default when inserting/changing row, Functions
2429 are defined for meta types from
2430 <a href="#cfg_RestrictColumnTypes" class="configrule">$cfg['RestrictColumnTypes']</a> and for
2431 <code>first_timestamp</code>, which is used for first timestamp column
2432 in table.</dd>
2434 </dl>
2436 <!-- TRANSFORMATIONS -->
2437 <h2 id="transformations">Transformations</h2>
2439 <ol><li><a href="#transformationsintro">Introduction</a></li>
2440 <li><a href="#transformationshowto">Usage</a></li>
2441 <li><a href="#transformationsfiles">File structure</a></li>
2442 </ol>
2444 <h3 id="transformationsintro">1. Introduction</h3>
2446 <p> To enable transformations, you have to setup the <tt>column_info</tt> table
2447 and the proper directives. Please see the <a href="#config">Configuration
2448 section</a> on how to do so.</p>
2450 <p> You can apply different transformations to the contents of each column. The
2451 transformation will take the content of each column and transform it with
2452 certain rules defined in the selected transformation.</p>
2454 <p> Say you have a column 'filename' which contains a filename. Normally you would
2455 see in phpMyAdmin only this filename. Using transformations you can transform
2456 that filename into a HTML link, so you can click inside of the phpMyAdmin
2457 structure on the column's link and will see the file displayed in a new browser
2458 window. Using transformation options you can also specify strings to
2459 append/prepend to a string or the format you want the output stored in.</p>
2461 <p> For a general overview of all available transformations and their options,
2462 you can consult your
2463 <i>&lt;www.your-host.com&gt;/&lt;your-install-dir&gt;/transformation_overview.php</i>
2464 installation.</p>
2466 <p> For a tutorial on how to effectively use transformations, see our
2467 <a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a> on
2468 the official phpMyAdmin homepage.</p>
2470 <h3 id="transformationshowto">2. Usage</h3>
2472 <p> Go to your <i>tbl_structure.php</i> page (i.e. reached through
2473 clicking on the 'Structure' link for a table). There click on
2474 &quot;Change&quot; (or change icon) and there you will see three new
2475 fields at
2476 the end of the line. They are called 'MIME-type', 'Browser transformation' and
2477 'Transformation options'.</p>
2479 <ul><li>The field 'MIME-type' is a drop-down field. Select the MIME-type
2480 that corresponds to the column's contents. Please note that
2481 transformations are inactive as long as no MIME-type is selected.</li>
2483 <li>The field 'Browser transformation' is a drop-down field. You can choose from a
2484 hopefully growing amount of pre-defined transformations. See below for information on
2485 how to build your own transformation.<br />
2487 There are global transformations and mimetype-bound transformations. Global transformations
2488 can be used for any mimetype. They will take the mimetype, if necessary, into regard.
2489 Mimetype-bound transformations usually only operate on a certain mimetype. There are
2490 transformations which operate on the main mimetype (like 'image'), which will most likely
2491 take the subtype into regard, and those who only operate on a
2492 specific subtype (like 'image/jpeg').<br />
2494 You can use transformations on mimetypes for which the function was not defined for. There
2495 is no security check for you selected the right transformation, so take care of what the
2496 output will be like.</li>
2498 <li>The field 'Transformation options' is a free-type textfield. You have to enter
2499 transform-function specific options here. Usually the transforms can operate with default
2500 options, but it is generally a good idea to look up the overview to see which options are
2501 necessary.<br />
2503 Much like the ENUM/SET-Fields, you have to split up several options using the format
2504 'a','b','c',...(NOTE THE MISSING BLANKS). This is because internally the options will be
2505 parsed as an array, leaving the first value the first element in the array, and so
2506 forth.<br />
2508 If you want to specify a MIME character set you can define it in the transformation_options.
2509 You have to put that outside of the pre-defined options of the specific mime-transform,
2510 as the last value of the set. Use the format "'; charset=XXX'". If you use a transform,
2511 for which you can specify 2 options and you want to append a character set, enter "'first
2512 parameter','second parameter','charset=us-ascii'". You can, however use the defaults for
2513 the parameters: "'','','charset=us-ascii'".</li>
2514 </ul>
2516 <h3 id="transformationsfiles">3. File structure</h3>
2518 <p> All mimetypes and their transformations are defined through single files in
2519 the directory 'libraries/transformations/'.</p>
2521 <p> They are stored in files to ease up customization and easy adding of new
2522 transformations.</p>
2524 <p> Because the user cannot enter own mimetypes, it is kept sure that transformations
2525 always work. It makes no sense to apply a transformation to a mimetype the
2526 transform-function doesn't know to handle.</p>
2528 <p> One can, however, use empty mime-types and global transformations which should work
2529 for many mimetypes. You can also use transforms on a different mimetype than what they where built
2530 for, but pay attention to option usage as well as what the transformation does to your
2531 column.</p>
2533 <p> There is a basic file called '<i>global.inc.php</i>'. This function can be included by
2534 any other transform function and provides some basic functions.</p>
2536 <p> There are 5 possible file names:</p>
2538 <ol><li>A mimetype+subtype transform:<br /><br />
2540 <tt>[mimetype]_[subtype]__[transform].inc.php</tt><br /><br />
2542 Please not that mimetype and subtype are separated via '_', which shall
2543 not be contained in their names. The transform function/filename may
2544 contain only characters which cause no problems in the file system as
2545 well as the PHP function naming convention.<br /><br />
2547 The transform function will the be called
2548 '<tt>PMA_transform_[mimetype]_[subtype]__[transform]()</tt>'.<br /><br />
2550 <b>Example:</b><br /><br />
2552 <tt>text_html__formatted.inc.php</tt><br />
2553 <tt>PMA_transform_text_html__formatted()</tt></li>
2555 <li>A mimetype (w/o subtype) transform:<br /><br />
2557 <tt>[mimetype]__[transform].inc.php</tt><br /><br />
2559 Please note that there are no single '_' characters.
2560 The transform function/filename may contain only characters which cause
2561 no problems in the file system as well as the PHP function naming
2562 convention.<br /><br />
2564 The transform function will the be called
2565 '<tt>PMA_transform_[mimetype]__[transform]()</tt>'.<br /><br />
2567 <b>Example:</b><br /><br />
2569 <tt>text__formatted.inc.php</tt><br />
2570 <tt>PMA_transform_text__formatted()</tt></li>
2572 <li>A mimetype+subtype without specific transform function<br /><br />
2574 <tt>[mimetype]_[subtype].inc.php</tt><br /><br />
2576 Please note that there are no '__' characters in the filename. Do not
2577 use special characters in the filename causing problems with the file
2578 system.<br /><br />
2580 No transformation function is defined in the file itself.<br /><br />
2582 <b>Example:</b><br /><br />
2584 <tt>text_plain.inc.php</tt><br />
2585 (No function)</li>
2587 <li>A mimetype (w/o subtype) without specific transform function<br /><br />
2589 <tt>[mimetype].inc.php</tt><br /><br />
2591 Please note that there are no '_' characters in the filename. Do not use
2592 special characters in the filename causing problems with the file system.
2593 <br /><br />
2595 No transformation function is defined in the file itself.<br /><br />
2597 <b>Example:</b><br /><br />
2599 <tt>text.inc.php</tt><br />
2600 (No function)</li>
2602 <li>A global transform function with no specific mimetype<br /><br />
2604 <tt>global__[transform].inc.php</tt><br /><br />
2606 The transform function will the be called
2607 '<tt>PMA_transform_global__[transform]()</tt>'.<br /><br />
2609 <b>Example:</b><br /><br />
2611 <tt>global__formatted</tt><br />
2612 <tt>PMA_transform_global__formatted()</tt></li>
2613 </ol>
2615 <p> So generally use '_' to split up mimetype and subtype, and '__' to provide a
2616 transform function.</p>
2618 <p> All filenames containing no '__' in themselves are not shown as valid transform
2619 functions in the dropdown.</p>
2621 <p> Please see the libraries/transformations/TEMPLATE file for adding your own transform
2622 function. See the libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
2623 without a transform function.</p>
2625 <p> To create a new transform function please see
2626 <tt>libraries/transformations/template_generator.sh</tt>.
2627 To create a new, empty mimetype please see
2628 <tt>libraries/transformations/template_generator_mimetype.sh</tt>.</p>
2630 <p> A transform function always gets passed three variables:</p>
2632 <ol><li><b>$buffer</b> - Contains the text inside of the column. This is the text,
2633 you want to transform.</li>
2634 <li><b>$options</b> - Contains any user-passed options to a transform function
2635 as an array.</li>
2636 <li><b>$meta</b> - Contains an object with information about your column.
2637 The data is drawn from the output of the
2638 <a href="http://www.php.net/mysql_fetch_field">mysql_fetch_field()</a>
2639 function. This means, all object properties described on the
2640 <a href="http://www.php.net/mysql_fetch_field">manual page</a> are
2641 available in this variable and can be used to transform a column accordingly
2642 to unsigned/zerofill/not_null/... properties.<br />
2643 The $meta-&gt;mimetype variable contains the original MIME-type of the
2644 column (i.e. 'text/plain', 'image/jpeg' etc.)</li>
2645 </ol>
2647 <p> Additionally you should also provide additional function to provide
2648 information about the transformation to the user. This function should
2649 have same name as transformation function just with appended
2650 <code>_info</code> suffix. This function accepts no parameters and returns
2651 array with information about the transformation. Currently following keys
2652 can be used:
2653 </p>
2654 <dl>
2655 <dt><code>info</code></dt>
2656 <dd>Long description of the transformation.</dd>
2657 </dl>
2659 <!-- FAQ -->
2660 <h2 id="faq">FAQ - Frequently Asked Questions</h2>
2662 <ol><li><a href="#faqserver">Server</a></li>
2663 <li><a href="#faqconfig">Configuration</a></li>
2664 <li><a href="#faqlimitations">Known limitations</a></li>
2665 <li><a href="#faqmultiuser">ISPs, multi-user installations</a></li>
2666 <li><a href="#faqbrowsers">Browsers or client <abbr title="operating system">OS</abbr></a></li>
2667 <li><a href="#faqusing">Using phpMyAdmin</a></li>
2668 <li><a href="#faqproject">phpMyAdmin project</a></li>
2669 <li><a href="#faqsecurity">Security</a></li>
2670 <li><a href="#faqsynchronization">Synchronization</a></li>
2671 </ol>
2673 <p> Please have a look at our
2674 <a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a> on
2675 the official phpMyAdmin homepage for in-depth coverage of phpMyAdmin's
2676 features and or interface.</p>
2678 <h3 id="faqserver">Server</h3>
2680 <h4 id="faq1_1">
2681 <a href="#faq1_1">1.1 My server is crashing each time a specific
2682 action is required or phpMyAdmin sends a blank page or a page full of
2683 cryptic characters to my browser, what can I do?</a></h4>
2685 <p> Try to set the <a href="#cfg_OBGzip" class="configrule">$cfg['OBGzip']</a>
2686 directive to <tt>FALSE</tt> in your <i>config.inc.php</i> file and the
2687 <tt>zlib.output_compression</tt> directive to <tt>Off</tt> in your php
2688 configuration file.<br /></p>
2690 <h4 id="faq1_2">
2691 <a href="#faq1_2">1.2 My Apache server crashes when using phpMyAdmin.</a></h4>
2693 <p> You should first try the latest versions of Apache (and possibly MySQL).<br />
2694 See also the
2695 <a href="#faq1_1"><abbr title="Frequently Asked Questions">FAQ</abbr> 1.1</a>
2696 entry about PHP bugs with output buffering.<br />
2697 If your server keeps crashing, please ask for help in the various Apache
2698 support groups.</p>
2700 <h4 id="faq1_3">
2701 <a href="#faq1_3">1.3 (withdrawn).</a></h4>
2703 <h4 id="faq1_4">
2704 <a href="#faq1_4">1.4 Using phpMyAdmin on
2705 <abbr title="Internet Information Services">IIS</abbr>, I'm displayed the
2706 error message: &quot;The specified <abbr title="Common Gateway Interface">CGI</abbr>
2707 application misbehaved by not returning a complete set of
2708 <abbr title="HyperText Transfer Protocol">HTTP</abbr> headers ...&quot;.</a>
2709 </h4>
2711 <p> You just forgot to read the <i>install.txt</i> file from the PHP distribution.
2712 Have a look at the last message in this
2713 <a href="http://bugs.php.net/bug.php?id=12061">bug report</a> from the
2714 official PHP bug database.</p>
2716 <h4 id="faq1_5">
2717 <a href="#faq1_5">1.5 Using phpMyAdmin on
2718 <abbr title="Internet Information Services">IIS</abbr>, I'm facing crashes
2719 and/or many error messages with the
2720 <abbr title="HyperText Transfer Protocol">HTTP</abbr>.</a></h4>
2722 <p> This is a known problem with the PHP
2723 <abbr title="Internet Server Application Programming Interface">ISAPI</abbr>
2724 filter: it's not so stable. Please use instead the cookie authentication mode.
2725 </p>
2727 <h4 id="faq1_6">
2728 <a href="#faq1_6">1.6 I can't use phpMyAdmin on PWS: nothing is displayed!</a></h4>
2730 <p> This seems to be a PWS bug. Filippo Simoncini found a workaround (at this
2731 time there is no better fix): remove or comment the <tt>DOCTYPE</tt>
2732 declarations (2 lines) from the scripts <i>libraries/header.inc.php</i>,
2733 <i>libraries/header_printview.inc.php</i>, <i>index.php</i>,
2734 <i>navigation.php</i> and <i>libraries/common.lib.php</i>.</p>
2736 <h4 id="faq1_7">
2737 <a href="#faq1_7">1.7 How can I GZip or Bzip a dump or a
2738 <abbr title="comma separated values">CSV</abbr> export? It does not seem to
2739 work.</a></h4>
2741 <p> These features are based on the <tt>gzencode()</tt> and <tt>bzcompress()</tt>
2742 PHP functions to be more independent of the platform (Unix/Windows, Safe Mode
2743 or not, and so on). So, you must have Zlib/Bzip2
2744 support (<tt>--with-zlib</tt> and <tt>--with-bz2</tt>).<br /></p>
2746 <h4 id="faq1_8">
2747 <a href="#faq1_8">1.8 I cannot insert a text file in a table, and I get
2748 an error about safe mode being in effect.</a></h4>
2750 <p> Your uploaded file is saved by PHP in the &quot;upload dir&quot;, as
2751 defined in <i>php.ini</i> by the variable <tt>upload_tmp_dir</tt> (usually
2752 the system default is <i>/tmp</i>).<br />
2753 We recommend the following setup for Apache servers running in safe mode,
2754 to enable uploads of files while being reasonably secure:</p>
2756 <ul><li>create a separate directory for uploads: <tt>mkdir /tmp/php</tt></li>
2757 <li>give ownership to the Apache server's user.group:
2758 <tt>chown apache.apache /tmp/php</tt></li>
2759 <li>give proper permission: <tt>chmod 600 /tmp/php</tt></li>
2760 <li>put <tt>upload_tmp_dir = /tmp/php</tt> in <i>php.ini</i></li>
2761 <li>restart Apache</li>
2762 </ul>
2764 <h4 id="faq1_9">
2765 <a href="#faq1_9">1.9 (withdrawn).</a></h4>
2767 <h4 id="faq1_10">
2768 <a href="#faq1_10">1.10 I'm having troubles when uploading files with
2769 phpMyAdmin running on a secure server. My browser is Internet Explorer and
2770 I'm using the Apache server.</a></h4>
2772 <p> As suggested by &quot;Rob M&quot; in the phpWizard forum, add this line to
2773 your <i>httpd.conf</i>:</p>
2775 <pre>SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown</pre>
2777 <p> It seems to clear up many problems between Internet Explorer and SSL.</p>
2779 <h4 id="faq1_11">
2780 <a href="#faq1_11">1.11 I get an 'open_basedir restriction' while
2781 uploading a file from the query box.</a></h4>
2783 <p> Since version 2.2.4, phpMyAdmin supports servers with open_basedir
2784 restrictions. However you need to create temporary directory and
2785 configure it as <a href="#cfg_TempDir" class="configrule">$cfg['TempDir']</a>.
2786 The uploaded files will be moved there, and after execution of your
2787 <abbr title="structured query language">SQL</abbr> commands, removed.</p>
2789 <h4 id="faq1_12">
2790 <a href="#faq1_12">1.12 I have lost my MySQL root password, what can I do?</a></h4>
2792 <p> The MySQL manual explains how to
2793 <a href="http://dev.mysql.com/doc/mysql/en/resetting-permissions.html">
2794 reset the permissions</a>.</p>
2796 <h4 id="faq1_13">
2797 <a href="#faq1_13">1.13 (withdrawn).</a></h4>
2799 <h4 id="faq1_14">
2800 <a href="#faq1_14">1.14 (withdrawn).</a></h4>
2802 <h4 id="faq1_15">
2803 <a href="#faq1_15">1.15 I have problems with <i>mysql.user</i> column names.</a>
2804 </h4>
2806 <p> In previous MySQL versions, the <tt>User</tt> and <tt>Password</tt>columns
2807 were named <tt>user</tt> and <tt>password</tt>. Please modify your column
2808 names to align with current standards.</p>
2810 <h4 id="faq1_16">
2811 <a href="#faq1_16">1.16 I cannot upload big dump files (memory,
2812 <abbr title="HyperText Transfer Protocol">HTTP</abbr> or timeout problems).</a>
2813 </h4>
2815 <p> Starting with version 2.7.0, the import engine has been re&#8211;written and these
2816 problems should not occur. If possible, upgrade your phpMyAdmin to the latest version
2817 to take advantage of the new import features.</p>
2819 <p> The first things to check (or ask your host provider to check) are the
2820 values of <tt>upload_max_filesize</tt>, <tt>memory_limit</tt> and
2821 <tt>post_max_size</tt> in the <i>php.ini</i> configuration file.
2822 All of these three settings limit the maximum size of data that can be
2823 submitted and handled by PHP. One user also said that
2824 <tt>post_max_size</tt>
2825 and <tt>memory_limit</tt> need to be larger than <tt>upload_max_filesize</tt>.<br /> <br />
2827 There exist several workarounds if your upload is too big or your
2828 hosting provider is unwilling to change the settings:</p>
2830 <ul><li>Look at the <a href="#cfg_UploadDir" class="configrule">$cfg['UploadDir']</a>
2831 feature. This allows one to
2832 upload a file to the server via scp, ftp, or your favorite file transfer
2833 method. PhpMyAdmin is then able to import the files from the temporary
2834 directory. More information is available in the <a href="#config">Configuration
2835 section</a> of this document.</li>
2836 <li>Using a utility (such as <a href="http://www.ozerov.de/bigdump.php">
2837 BigDump</a>) to split the files before uploading. We cannot support this
2838 or any third party applications, but are aware of users having success
2839 with it.</li>
2840 <li>If you have shell (command line) access, use MySQL to import the files
2841 directly. You can do this by issuing the &quot;source&quot; command from
2842 within MySQL: <tt>source <i>filename.sql</i></tt>.</li>
2843 </ul>
2845 <h4 id="faq1_17">
2846 <a id="faqmysqlversions" href="#faq1_17">1.17 Which MySQL versions does phpMyAdmin
2847 support?</a></h4>
2849 <p> Since phpMyAdmin 3.0.x, only MySQL 5.0.1 and newer are supported. For
2850 older MySQL versions, you need to use the latest 2.x branch. phpMyAdmin can
2851 connect to your MySQL server using PHP's classic
2852 <a href="http://php.net/mysql">MySQL extension</a> as well as the
2853 <a href="http://php.net/mysqli">improved MySQL extension (MySQLi)</a> that
2854 is available in PHP 5.0. The latter one should be used unless you have a
2855 good reason not to do so.<br />
2856 When compiling PHP, we strongly recommend that you manually link the MySQL
2857 extension of your choice to a MySQL client library of at least the same
2858 minor version since the one that is bundled with some PHP distributions is
2859 rather old and might cause problems <a href="#faq1_17a">
2860 (see <abbr title="Frequently Asked Questions">FAQ</abbr> 1.17a)</a>.<br /><br />
2861 <a href="http://mariadb.org/">MariaDB</a> is also supported
2862 (versions 5.1 and 5.2 were tested).<br /><br />
2863 Since phpMyAdmin 3.5 <a href="http://www.drizzle.org/">Drizzle</a> is supported.
2864 </p>
2866 <h5 id="faq1_17a">
2867 <a href="#faq1_17a">1.17a I cannot connect to the MySQL server. It always returns the error
2868 message, &quot;Client does not support authentication protocol requested
2869 by server; consider upgrading MySQL client&quot;</a></h5>
2871 <p> You tried to access MySQL with an old MySQL client library. The version of
2872 your MySQL client library can be checked in your phpinfo() output.
2873 In general, it should have at least the same minor version as your server
2874 - as mentioned in <a href="#faq1_17">
2875 <abbr title="Frequently Asked Questions">FAQ</abbr> 1.17</a>.<br /><br />
2877 This problem is generally caused by using MySQL version 4.1 or newer. MySQL
2878 changed the authentication hash and your PHP is trying to use the old method.
2879 The proper solution is to use the <a href="http://www.php.net/mysqli">mysqli extension</a>
2880 with the proper client library to match your MySQL installation. Your
2881 chosen extension is specified in <a href="#cfg_Servers_extension" class="configrule">$cfg['Servers'][$i]['extension']</a>.
2882 More information (and several workarounds) are located in the
2883 <a href="http://dev.mysql.com/doc/mysql/en/old-client.html">MySQL Documentation</a>.
2884 </p>
2886 <h4 id="faq1_18">
2887 <a href="#faq1_18">1.18 (withdrawn).</a></h4>
2889 <h4 id="faq1_19">
2890 <a href="#faq1_19">1.19 I can't run the &quot;display relations&quot; feature because the
2891 script seems not to know the font face I'm using!</a></h4>
2893 <p> The &quot;FPDF&quot; library we're using for this feature requires some
2894 special files to use font faces.<br />
2895 Please refers to the <a href="http://www.fpdf.org/">FPDF manual</a> to build
2896 these files.</p>
2898 <h4 id="faqmysql">
2899 <a href="#faqmysql">1.20 I receive the error &quot;cannot load MySQL extension, please
2900 check PHP Configuration&quot;.</a></h4>
2902 <p> To connect to a MySQL server, PHP needs a set of MySQL functions called
2903 &quot;MySQL extension&quot;. This extension may be part of the PHP
2904 distribution (compiled-in), otherwise it needs to be loaded dynamically. Its
2905 name is probably <i>mysql.so</i> or <i>php_mysql.dll</i>. phpMyAdmin tried
2906 to load the extension but failed.<br /><br />
2908 Usually, the problem is solved by installing a software package called
2909 &quot;PHP-MySQL&quot; or something similar.</p>
2911 <h4 id="faq1_21">
2912 <a href="#faq1_21">1.21 I am running the
2913 <abbr title="Common Gateway Interface">CGI</abbr> version of PHP under Unix,
2914 and I cannot log in using cookie auth.</a></h4>
2916 <p> In <i>php.ini</i>, set <tt>mysql.max_links</tt> higher than 1.</p>
2918 <h4 id="faq1_22">
2919 <a href="#faq1_22">1.22 I don't see the &quot;Location of text file&quot; field,
2920 so I cannot upload.</a></h4>
2922 <p> This is most likely because in <i>php.ini</i>, your <tt>file_uploads</tt>
2923 parameter is not set to &quot;on&quot;.</p>
2925 <h4 id="faq1_23">
2926 <a href="#faq1_23">1.23 I'm running MySQL on a Win32 machine. Each time I create
2927 a new table the table and column names are changed to lowercase!</a></h4>
2929 <p> This happens because the MySQL directive <tt>lower_case_table_names</tt>
2930 defaults to 1 (<tt>ON</tt>) in the Win32 version of MySQL. You can change
2931 this behavior by simply changing the directive to 0 (<tt>OFF</tt>):<br />
2932 Just edit your <tt>my.ini</tt> file that should be located in your Windows
2933 directory and add the following line to the group [mysqld]:</p>
2935 <pre>set-variable = lower_case_table_names=0</pre>
2937 <p> Next, save the file and restart the MySQL service. You can always check the
2938 value of this directive using the query</p>
2940 <pre>SHOW VARIABLES LIKE 'lower_case_table_names';</pre>
2942 <h4 id="faq1_24">
2943 <a href="#faq1_24">1.24 (withdrawn).</a></h4>
2945 <h4 id="faq1_25">
2946 <a href="#faq1_25">1.25 I am running Apache with mod_gzip-1.3.26.1a on Windows XP,
2947 and I get problems, such as undefined variables when I run a
2948 <abbr title="structured query language">SQL</abbr> query.</a></h4>
2950 <p> A tip from Jose Fandos: put a comment on the following two lines
2951 in httpd.conf, like this:</p>
2953 <pre>
2954 # mod_gzip_item_include file \.php$
2955 # mod_gzip_item_include mime "application/x-httpd-php.*"
2956 </pre>
2958 <p> as this version of mod_gzip on Apache (Windows) has problems handling
2959 PHP scripts. Of course you have to restart Apache.</p>
2961 <h4 id="faq1_26">
2962 <a href="#faq1_26">1.26 I just installed phpMyAdmin in my document root of
2963 <abbr title="Internet Information Services">IIS</abbr> but
2964 I get the error &quot;No input file specified&quot; when trying to
2965 run phpMyAdmin.</a></h4>
2967 <p> This is a permission problem. Right-click on the phpmyadmin folder
2968 and choose properties. Under the tab Security, click on &quot;Add&quot;
2969 and select the user &quot;IUSR_machine&quot; from the list. Now set his
2970 permissions and it should work.</p>
2972 <h4 id="faq1_27">
2973 <a href="#faq1_27">1.27 I get empty page when I want to view huge page (eg.
2974 db_structure.php with plenty of tables).</a></h4>
2976 <p> This is a <a href="http://bugs.php.net/21079">PHP bug</a> that occur when
2977 GZIP output buffering is enabled. If you turn off it (by
2978 <a href="#cfg_OBGzip" class="configrule">$cfg['OBGzip'] = false</a>
2979 in <i>config.inc.php</i>), it should work. This bug will be fixed in
2980 PHP&nbsp;5.0.0.</p>
2982 <h4 id="faq1_28">
2983 <a href="#faq1_28">1.28 My MySQL server sometimes refuses queries and returns the
2984 message 'Errorcode: 13'. What does this mean?</a></h4>
2986 <p> This can happen due to a MySQL bug when having database / table names with
2987 upper case characters although <tt>lower_case_table_names</tt> is set to 1.
2988 To fix this, turn off this directive, convert all database and table names
2989 to lower case and turn it on again. Alternatively, there's a bug-fix
2990 available starting with MySQL&nbsp;3.23.56 / 4.0.11-gamma.</p>
2992 <h4 id="faq1_29">
2993 <a href="#faq1_29">1.29 When I create a table or modify a column, I get an error
2994 and the columns are duplicated.</a></h4>
2996 <p> It is possible to configure Apache in such a way that PHP has problems
2997 interpreting .php files.</p>
2999 <p> The problems occur when two different (and conflicting) set of directives
3000 are used:</p>
3002 <pre>
3003 SetOutputFilter PHP
3004 SetInputFilter PHP
3005 </pre>
3007 <p> and</p>
3009 <pre>AddType application/x-httpd-php .php</pre>
3011 <p> In the case we saw, one set of directives was in
3012 <tt>/etc/httpd/conf/httpd.conf</tt>, while
3013 the other set was in <tt>/etc/httpd/conf/addon-modules/php.conf</tt>.<br />
3014 The recommended way is with <tt>AddType</tt>, so just comment out
3015 the first set of lines and restart Apache:</p>
3017 <pre>
3018 #SetOutputFilter PHP
3019 #SetInputFilter PHP
3020 </pre>
3022 <h4 id="faq1_30">
3023 <a href="#faq1_30">1.30 I get the error &quot;navigation.php: Missing hash&quot;.</a></h4>
3025 <p> This problem is known to happen when the server is running Turck MMCache
3026 but upgrading MMCache to version 2.3.21 solves the problem.</p>
3028 <h4 id="faq1_31">
3029 <a href="#faq1_31">1.31 Does phpMyAdmin support php5?</a></h4>
3031 <p>Yes.</p>
3033 Since release 3.0 only PHP 5.2 and newer. For older PHP versions 2.9 branch
3034 is still maintained.
3035 </p>
3037 <h4 id="faq1_32">
3038 <a href="#faq1_32">1.32 Can I use <abbr title="HyperText Transfer Protocol">HTTP</abbr> authentication with <abbr title="Internet Information Services">IIS</abbr>?</a></h4>
3040 <p> Yes. This procedure was tested with phpMyAdmin 2.6.1, PHP 4.3.9 in <abbr title="Internet Server Application Programming Interface">ISAPI</abbr>
3041 mode under <abbr title="Internet Information Services">IIS</abbr> 5.1.</p>
3043 <ol><li>In your <tt>php.ini</tt> file, set <tt>cgi.rfc2616_headers = 0</tt></li>
3044 <li>In <tt>Web Site Properties -&gt; File/Directory Security -&gt; Anonymous
3045 Access</tt> dialog box, check the <tt>Anonymous access</tt> checkbox and
3046 uncheck any other checkboxes (i.e. uncheck <tt>Basic authentication</tt>,
3047 <tt>Integrated Windows authentication</tt>, and <tt>Digest</tt> if it's
3048 enabled.) Click <tt>OK</tt>.</li>
3049 <li>In <tt>Custom Errors</tt>, select the range of <tt>401;1</tt> through
3050 <tt>401;5</tt> and click the <tt>Set to Default</tt> button.</li>
3051 </ol>
3053 <h4 id="faq1_33">
3054 <a href="#faq1_33">1.33 (withdrawn).</a></h4>
3056 <h4 id="faq1_34">
3057 <a href="#faq1_34">1.34 Can I access directly to database or table pages?</a></h4>
3059 <p> Yes. Out of the box, you can use <abbr title="Uniform Resource Locator">URL</abbr>s like
3060 http://server/phpMyAdmin/index.php?server=X&amp;db=database&amp;table=table&amp;target=script. For <tt>server</tt> you use the server number which refers to
3061 the order of the server paragraph in <tt>config.inc.php</tt>.
3062 Table and script parts are optional. If you want
3063 http://server/phpMyAdmin/database[/table][/script] <abbr title="Uniform Resource Locator">URL</abbr>s, you need to do
3064 some configuration. Following lines apply only for <a
3065 href="http://httpd.apache.org">Apache</a> web server. First make sure,
3066 that you have enabled some features within global configuration. You need
3067 <code>Options FollowSymLinks</code> and <code>AllowOverride
3068 FileInfo</code> enabled for directory where phpMyAdmin is installed and
3069 you need mod_rewrite to be enabled. Then you just need to create following
3070 <a href="#glossary"><i>.htaccess</i></a> file in root folder of phpMyAdmin installation
3071 (don't forget to change directory name inside of it):</p>
3073 <pre>
3074 RewriteEngine On
3075 RewriteBase /path_to_phpMyAdmin
3076 RewriteRule ^([a-zA-Z0-9_]+)/([a-zA-Z0-9_]+)/([a-z_]+\.php)$ index.php?db=$1&amp;table=$2&amp;target=$3 [R]
3077 RewriteRule ^([a-zA-Z0-9_]+)/([a-z_]+\.php)$ index.php?db=$1&amp;target=$2 [R]
3078 RewriteRule ^([a-zA-Z0-9_]+)/([a-zA-Z0-9_]+)$ index.php?db=$1&amp;table=$2 [R]
3079 RewriteRule ^([a-zA-Z0-9_]+)$ index.php?db=$1 [R]
3080 </pre>
3082 <h4 id="faq1_35">
3083 <a href="#faq1_35">1.35 Can I use <abbr title="HyperText Transfer Protocol">HTTP</abbr> authentication with Apache <abbr title="Common Gateway Interface">CGI</abbr>?</a></h4>
3085 <p> Yes. However you need to pass authentication variable to <abbr title="Common Gateway Interface">CGI</abbr> using
3086 following rewrite rule:</p>
3088 <pre>
3089 RewriteEngine On
3090 RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization},L]
3091 </pre>
3093 <h4 id="faq1_36">
3094 <a href="#faq1_36">1.36 I get an error &quot;500 Internal Server Error&quot;.</a>
3095 </h4>
3097 There can be many explanations to this and a look at your server's
3098 error log file might give a clue.
3099 </p>
3101 <h4 id="faq1_37">
3102 <a href="#faq1_37">1.37 I run phpMyAdmin on cluster of different machines and
3103 password encryption in cookie auth doesn't work.</a></h4>
3105 <p> If your cluster consist of different architectures, PHP code used for
3106 encryption/decryption won't work correct. This is caused by use of
3107 pack/unpack functions in code. Only solution is to use mcrypt extension
3108 which works fine in this case.</p>
3110 <h4 id="faq1_38">
3111 <a href="#faq1_38">1.38 Can I use phpMyAdmin on a server on which Suhosin is enabled?</a></h4>
3113 <p> Yes but the default configuration values of Suhosin are known to cause
3114 problems with some operations, for example editing a table with many
3115 columns and no primary key or with textual primary key.
3116 </p>
3118 Suhosin configuration might lead to malfunction in some cases and it can
3119 not be fully avoided as phpMyAdmin is kind of application which needs to
3120 transfer big amounts of columns in single HTTP request, what is something
3121 what Suhosin tries to prevent. Generally all
3122 <code>suhosin.request.*</code>, <code>suhosin.post.*</code> and
3123 <code>suhosin.get.*</code> directives can have negative effect on
3124 phpMyAdmin usability. You can always find in your error logs which limit
3125 did cause dropping of variable, so you can diagnose the problem and adjust
3126 matching configuration variable.
3127 </p>
3129 The default values for most Suhosin configuration options will work in most
3130 scenarios, however you might want to adjust at least following parameters:
3131 </p>
3133 <ul>
3134 <li><a href="http://www.hardened-php.net/suhosin/configuration.html#suhosin.request.max_vars">suhosin.request.max_vars</a> should be increased (eg. 2048)</li>
3135 <li><a href="http://www.hardened-php.net/suhosin/configuration.html#suhosin.post.max_vars">suhosin.post.max_vars</a> should be increased (eg. 2048)</li>
3136 <li><a href="http://www.hardened-php.net/suhosin/configuration.html#suhosin.request.max_array_index_length">suhosin.request.max_array_index_length</a> should be increased (eg. 256)</li>
3137 <li><a href="http://www.hardened-php.net/suhosin/configuration.html#suhosin.post.max_array_index_length">suhosin.post.max_array_index_length</a> should be increased (eg. 256)</li>
3138 <li><a href="http://www.hardened-php.net/suhosin/configuration.html#suhosin.request.max_totalname_length">suhosin.request.max_totalname_length</a> should be increased (eg. 8192)</li>
3139 <li><a href="http://www.hardened-php.net/suhosin/configuration.html#suhosin.post.max_totalname_length">suhosin.post.max_totalname_length</a> should be increased (eg. 8192)</li>
3140 <li><a href="http://www.hardened-php.net/suhosin/configuration.html#suhosin.get.max_value_length">suhosin.get.max_value_length</a> should be increased (eg. 1024)</li>
3141 <li><a href="http://www.hardened-php.net/suhosin/configuration.html#suhosin.sql.bailout_on_error">suhosin.sql.bailout_on_error</a> needs to be disabled (the default)</li>
3142 <li><a href="http://www.hardened-php.net/suhosin/configuration.html#logging_configuration">suhosin.log.*</a> should not include <abbr title="structured query language">SQL</abbr>, otherwise you get big slowdown</li>
3143 </ul>
3146 You can also disable the warning using the <a href="#cfg_SuhosinDisableWarning">
3147 <tt>SuhosinDisableWarning</tt> directive</a>.
3148 </p>
3150 <h4 id="faq1_39">
3151 <a href="#faq1_39">1.39 When I try to connect via https, I can log in,
3152 but then my connection is redirected back to http. What can cause this
3153 behavior?</a></h4>
3155 <p> Be sure that you have enabled <tt>SSLOptions</tt> and <tt>StdEnvVars</tt>
3156 in your Apache configuration. See <a href="http://httpd.apache.org/docs/2.0/mod/mod_ssl.html#ssloptions">http://httpd.apache.org/docs/2.0/mod/mod_ssl.html#ssloptions</a>.</p>
3158 <h4 id="faq1_40">
3159 <a href="#faq1_40">1.40 When accessing phpMyAdmin via an Apache reverse proxy, cookie login does not work.</a></h4>
3161 <p>To be able to use cookie auth Apache must know that it has to rewrite the set-cookie headers.<br />
3162 Example from the Apache 2.2 documentation:</p>
3163 <pre>
3164 ProxyPass /mirror/foo/ http://backend.example.com/
3165 ProxyPassReverse /mirror/foo/ http://backend.example.com/
3166 ProxyPassReverseCookieDomain backend.example.com public.example.com
3167 ProxyPassReverseCookiePath / /mirror/foo/
3168 </pre>
3170 <p>Note: if the backend url looks like http://host/~user/phpmyadmin,
3171 the tilde (~) must be url encoded as %7E in the ProxyPassReverse* lines.
3172 This is not specific to phpmyadmin, it's just the behavior of Apache.
3173 </p>
3175 <pre>
3176 ProxyPass /mirror/foo/ http://backend.example.com/~user/phpmyadmin
3177 ProxyPassReverse /mirror/foo/
3178 http://backend.example.com/%7Euser/phpmyadmin
3179 ProxyPassReverseCookiePath /%7Euser/phpmyadmin /mirror/foo
3180 </pre>
3182 <p>See <a href="http://httpd.apache.org/docs/2.2/mod/mod_proxy.html">http://httpd.apache.org/docs/2.2/mod/mod_proxy.html</a>
3183 for more details.</p>
3185 <h4 id="faq1_41">
3186 <a href="#faq1_41">1.41 When I view a database and ask to see its
3187 privileges, I get an error about an unknown column.</a></h4>
3189 <p> The MySQL server's privilege tables are not up to date, you need to run
3190 the <tt>mysql_upgrade</tt> command on the server.</p>
3192 <h4 id="faq1_42">
3193 <a href="#faq1_42">1.42 How can I prevent robots from accessing phpMyAdmin?</a></h4>
3195 <p>You can add various rules to <a href="#glossary"><i>.htaccess</i></a> to filter access
3196 based on user agent field. This is quite easy to circumvent, but could prevent at least
3197 some robots accessing your installation.</p>
3199 <pre>
3200 RewriteEngine on
3202 # Allow only GET and POST verbs
3203 RewriteCond %{REQUEST_METHOD} !^(GET|POST)$ [NC,OR]
3205 # Ban Typical Vulnerability Scanners and others
3206 # Kick out Script Kiddies
3207 RewriteCond %{HTTP_USER_AGENT} ^(java|curl|wget).* [NC,OR]
3208 RewriteCond %{HTTP_USER_AGENT} ^.*(libwww-perl|curl|wget|python|nikto|wkito|pikto|scan|acunetix).* [NC,OR]
3209 RewriteCond %{HTTP_USER_AGENT} ^.*(winhttp|HTTrack|clshttp|archiver|loader|email|harvest|extract|grab|miner).* [NC,OR]
3211 # Ban Search Engines, Crawlers to your administrative panel
3212 # No reasons to access from bots
3213 # Ultimately Better than the useless robots.txt
3214 # Did google respect robots.txt?
3215 # Try google: intitle:phpMyAdmin intext:"Welcome to phpMyAdmin *.*.*" intext:"Log in" -wiki -forum -forums -questions intext:"Cookies must be enabled"
3216 RewriteCond %{HTTP_USER_AGENT} ^.*(AdsBot-Google|ia_archiver|Scooter|Ask.Jeeves|Baiduspider|Exabot|FAST.Enterprise.Crawler|FAST-WebCrawler|www\.neomo\.de|Gigabot|Mediapartners-Google|Google.Desktop|Feedfetcher-Google|Googlebot|heise-IT-Markt-Crawler|heritrix|ibm.com\cs/crawler|ICCrawler|ichiro|MJ12bot|MetagerBot|msnbot-NewsBlogs|msnbot|msnbot-media|NG-Search|lucene.apache.org|NutchCVS|OmniExplorer_Bot|online.link.validator|psbot0|Seekbot|Sensis.Web.Crawler|SEO.search.Crawler|Seoma.\[SEO.Crawler\]|SEOsearch|Snappy|www.urltrends.com|www.tkl.iis.u-tokyo.ac.jp/~crawler|SynooBot|crawleradmin.t-info@telekom.de|TurnitinBot|voyager|W3.SiteSearch.Crawler|W3C-checklink|W3C_Validator|www.WISEnutbot.com|yacybot|Yahoo-MMCrawler|Yahoo\!.DE.Slurp|Yahoo\!.Slurp|YahooSeeker).* [NC]
3217 RewriteRule .* - [F]
3218 </pre>
3222 <h3 id="faqconfig">Configuration</h3>
3224 <h4 id="faq2_1">
3225 <a href="#faq2_1">2.1 The error message &quot;Warning: Cannot add header information -
3226 headers already sent by ...&quot; is displayed, what's the problem?</a></h4>
3228 <p> Edit your <i>config.inc.php</i> file and ensure there is nothing
3229 (I.E. no blank lines, no spaces, no characters...) neither before the
3230 <tt>&lt;?php</tt> tag at the beginning, neither after the <tt>?&gt;</tt>
3231 tag at the end. We also got a report from a user under
3232 <abbr title="Internet Information Services">IIS</abbr>, that used
3233 a zipped distribution kit: the file <tt>libraries/Config.class.php</tt>
3234 contained an end-of-line character (hex 0A) at the end; removing this character
3235 cleared his errors.</p>
3237 <h4 id="faq2_2">
3238 <a href="#faq2_2">2.2 phpMyAdmin can't connect to MySQL. What's wrong?</a></h4>
3240 <p> Either there is an error with your PHP setup or your username/password is
3241 wrong. Try to make a small script which uses mysql_connect and see if it
3242 works. If it doesn't, it may be you haven't even compiled MySQL support
3243 into PHP.</p>
3245 <h4 id="faq2_3">
3246 <a href="#faq2_3">2.3 The error message &quot;Warning: MySQL Connection Failed: Can't
3247 connect to local MySQL server through socket '/tmp/mysql.sock'
3248 (111) ...&quot; is displayed. What can I do?</a></h4>
3250 <p> For RedHat users, Harald Legner suggests this on the mailing list:</p>
3252 <p> On my RedHat-Box the socket of MySQL is <i>/var/lib/mysql/mysql.sock</i>.
3253 In your <i>php.ini</i> you will find a line</p>
3255 <pre>mysql.default_socket = /tmp/mysql.sock</pre>
3257 <p> change it to</p>
3259 <pre>mysql.default_socket = /var/lib/mysql/mysql.sock</pre>
3261 <p> Then restart apache and it will work.</p>
3263 <p> Here is a fix suggested by Brad Ummer:</p>
3265 <ul><li>First, you need to determine what socket is being used by MySQL.<br />
3266 To do this, telnet to your server and go to the MySQL bin directory. In
3267 this directory there should be a file named <i>mysqladmin</i>. Type
3268 <tt>./mysqladmin variables</tt>, and this should give you a bunch of
3269 info about your MySQL server, including the socket
3270 (<i>/tmp/mysql.sock</i>, for example).</li>
3271 <li>Then, you need to tell PHP to use this socket.<br /> To do this in
3272 phpMyAdmin, you need to complete the socket information in the
3273 <i>config.inc.php</i>.<br />
3274 For example:
3275 <a href="#cfg_Servers_socket" class="configrule">
3276 $cfg['Servers'][$i]['socket']&nbsp;=&nbsp;'/tmp/mysql.sock';</a>
3277 <br /><br />
3279 Please also make sure that the permissions of this file allow to be readable
3280 by your webserver (i.e. '0755').</li>
3281 </ul>
3283 <p> Have also a look at the
3284 <a href="http://dev.mysql.com/doc/en/can-not-connect-to-server.html">
3285 corresponding section of the MySQL documentation</a>.</p>
3287 <h4 id="faq2_4">
3288 <a href="#faq2_4">2.4 Nothing is displayed by my browser when I try to run phpMyAdmin,
3289 what can I do?</a></h4>
3291 <p> Try to set the <a href="#cfg_OBGzip" class="configrule">$cfg['OBGZip']</a>
3292 directive to <tt>FALSE</tt> in the phpMyAdmin configuration file. It helps
3293 sometime.<br />
3294 Also have a look at your PHP version number: if it contains &quot;b&quot; or &quot;alpha&quot;
3295 it means you're running a testing version of PHP. That's not a so good idea,
3296 please upgrade to a plain revision.</p>
3298 <h4 id="faq2_5">
3299 <a href="#faq2_5">2.5 Each time I want to insert or change a row or drop a database
3300 or a table, an error 404 (page not found) is displayed or, with <abbr title="HyperText Transfer Protocol">HTTP</abbr> or
3301 cookie authentication, I'm asked to log in again. What's wrong?</a></h4>
3303 <p> Check the value you set for the
3304 <a href="#cfg_PmaAbsoluteUri" class="configrule">$cfg['PmaAbsoluteUri']</a>
3305 directive in the phpMyAdmin configuration file.</p>
3307 <h4 id="faq2_6">
3308 <a href="#faq2_6">2.6 I get an &quot;Access denied for user: 'root@localhost' (Using
3309 password: YES)&quot;-error when trying to access a MySQL-Server on a
3310 host which is port-forwarded for my localhost.</a></h4>
3312 <p> When you are using a port on your localhost, which you redirect via
3313 port-forwarding to another host, MySQL is not resolving the localhost
3314 as expected.<br />
3315 Erik Wasser explains: The solution is: if your host is &quot;localhost&quot;
3316 MySQL (the command line tool <code>mysql</code> as well) always tries to use the socket
3317 connection for speeding up things. And that doesn't work in this configuration
3318 with port forwarding.<br />
3319 If you enter "127.0.0.1" as hostname, everything is right and MySQL uses the
3320 <abbr title="Transmission Control Protocol">TCP</abbr> connection.</p>
3322 <h4 id="faqthemes"><a href="#faqthemes">2.7 Using and creating themes</a></h4>
3324 <p> Themes are configured with
3325 <a href="#cfg_ThemePath" class="configrule">$cfg['ThemePath']</a>,
3326 <a href="#cfg_ThemeManager" class="configrule">$cfg['ThemeManager']</a> and
3327 <a href="#cfg_ThemeDefault" class="configrule">$cfg['ThemeDefault']</a>.<br />
3328 <br />
3329 Under <a href="#cfg_ThemePath" class="configrule">$cfg['ThemePath']</a>, you
3330 should not delete the directory &quot;original&quot; or its underlying
3331 structure, because this is the system theme used by phpMyAdmin.
3332 &quot;original&quot; contains all images and styles, for backwards
3333 compatibility and for all themes that would not include images or css-files.
3334 <br /><br />
3336 If <a href="#cfg_ThemeManager" class="configrule">$cfg['ThemeManager']</a>
3337 is enabled, you can select your favorite theme on the main page. Your
3338 selected theme will be stored in a cookie.<br /><br /></p>
3340 <p> To create a theme:</p>
3342 <ul><li>make a new subdirectory (for example &quot;your_theme_name&quot;) under
3343 <a href="#cfg_ThemePath" class="configrule">$cfg['ThemePath']</a>
3344 (by default <tt>themes</tt>)</li>
3345 <li>copy the files and directories from &quot;original&quot; to
3346 &quot;your_theme_name&quot;</li>
3347 <li>edit the css-files in &quot;your_theme_name/css&quot;</li>
3348 <li>put your new images in &quot;your_theme_name/img&quot;</li>
3349 <li>edit <tt>layout.inc.php</tt> in &quot;your_theme_name&quot;</li>
3350 <li>edit <tt>info.inc.php</tt> in &quot;your_theme_name&quot; to
3351 contain your chosen theme name, that will be visible in user interface</li>
3352 <li>make a new screenshot of your theme and save it under
3353 &quot;your_theme_name/screen.png&quot;</li>
3354 </ul>
3356 <p> In theme directory there is file <tt>info.inc.php</tt> which contains
3357 theme verbose name, theme generation and theme version. These versions and
3358 generations are enumerated from 1 and do not have any direct dependence on
3359 phpMyAdmin version. Themes within same generation should be backwards
3360 compatible - theme with version 2 should work in phpMyAdmin requiring
3361 version 1. Themes with different generation are incompatible.</p>
3363 <p> If you do not want to use your own symbols and buttons, remove the
3364 directory &quot;img&quot; in &quot;your_theme_name&quot;. phpMyAdmin will
3365 use the default icons and buttons (from the system-theme &quot;original&quot;).
3366 </p>
3368 <h4 id="faqmissingparameters">
3369 <a href="#faqmissingparameters">2.8 I get &quot;Missing parameters&quot; errors,
3370 what can I do?</a></h4>
3372 <p> Here are a few points to check:</p>
3374 <ul><li>In <tt>config.inc.php</tt>, try to leave the
3375 <a href="#cfg_PmaAbsoluteUri" class="configrule">$cfg['PmaAbsoluteUri']</a>
3376 directive empty. See also
3377 <a href="#faq4_7"><abbr title="Frequently Asked Questions">FAQ</abbr> 4.7</a>.
3378 </li>
3379 <li>Maybe you have a broken PHP installation or you need to upgrade
3380 your Zend Optimizer. See
3381 <a href="http://bugs.php.net/bug.php?id=31134">
3382 http://bugs.php.net/bug.php?id=31134</a>.
3383 </li>
3384 <li>If you are using Hardened PHP with the ini directive <tt>varfilter.max_request_variables</tt>
3385 set to the default (200) or another low value, you could get this
3386 error if your table has a high number of columns. Adjust this setting
3387 accordingly. (Thanks to Klaus Dorninger for the hint).
3388 </li>
3389 <li>In the <tt>php.ini</tt> directive <tt>arg_separator.input</tt>, a value
3390 of &quot;;&quot; will cause this error. Replace it with &quot;&amp;;&quot;.
3391 </li>
3392 <li>If you are using <a href="http://www.hardened-php.net/">Hardened-PHP</a>,
3393 you might want to increase
3394 <a href="http://www.hardened-php.net/hphp/troubleshooting.html">request limits</a>.
3395 </li>
3396 <li>The directory specified in the <tt>php.ini</tt> directive <tt>session.save_path</tt> does not exist or is read-only.
3397 </li>
3398 </ul>
3400 <h4 id="faq2_9">
3401 <a href="#faq2_9">2.9 Seeing an upload progress bar</a></h4>
3403 <p> To be able to see a progress bar during your uploads, your server must
3404 have either the <a href="http://pecl.php.net/package/APC">APC</a> extension
3405 or the <a href="http://pecl.php.net/package/uploadprogress">uploadprogress</a>
3406 one. Moreover, the JSON extension has to be enabled in your PHP.</p>
3407 <p> If using APC, you must set <tt>apc.rfc1867</tt> to <tt>on</tt> in your php.ini.</p>
3409 <h3 id="faqlimitations">Known limitations</h3>
3411 <h4 id="login_bug">
3412 <a href="#login_bug">3.1 When using
3413 <abbr title="HyperText Transfer Protocol">HTTP</abbr> authentication, a user
3414 who logged out can not log in again in with the same nick.</a></h4>
3416 <p> This is related to the authentication mechanism (protocol) used by
3417 phpMyAdmin. To bypass this problem: just close all the opened
3418 browser windows and then go back to phpMyAdmin. You should be able to
3419 log in again.</p>
3421 <h4 id="faq3_2">
3422 <a href="#faq3_2">3.2 When dumping a large table in compressed mode, I get a memory
3423 limit error or a time limit error.</a></h4>
3425 <p> Compressed dumps are built in memory and because of this are limited to
3426 php's memory limit. For GZip/BZip2 exports this can be overcome since 2.5.4
3427 using
3428 <a href="#cfg_CompressOnFly" class="configrule">$cfg['CompressOnFly']</a>
3429 (enabled by default). Zip exports can not be handled this way, so if you need
3430 Zip files for larger dump, you have to use another way.</p>
3432 <h4 id="faq3_3">
3433 <a href="#faq3_3">3.3 With InnoDB tables, I lose foreign key relationships
3434 when I rename a table or a column.</a></h4>
3436 <p> This is an InnoDB bug, see <a href="http://bugs.mysql.com/bug.php?id=21704">http://bugs.mysql.com/bug.php?id=21704</a>.</p>
3438 <h4 id="faq3_4">
3439 <a href="#faq3_4">3.4 I am unable to import dumps I created with the mysqldump tool
3440 bundled with the MySQL server distribution.</a></h4>
3442 <p> The problem is that older versions of <code>mysqldump</code> created invalid comments like this:</p>
3444 <pre>
3445 -- MySQL dump 8.22
3447 -- Host: localhost Database: database
3448 ---------------------------------------------------------
3449 -- Server version 3.23.54
3450 </pre>
3452 <p> The invalid part of the code is the horizontal line made of dashes that
3453 appears once in every dump created with mysqldump. If you want to run your
3454 dump you have to turn it into valid MySQL. This means, you have to add a
3455 whitespace after the first two dashes of the line or add a # before it:
3456 <br />
3457 <code>
3458 -- -------------------------------------------------------<br />
3459 </code>
3460 or<br />
3461 <code>
3462 #---------------------------------------------------------
3463 </code>
3464 </p>
3466 <h4 id="faq3_5">
3467 <a href="#faq3_5">3.5 When using nested folders there are some multiple hierarchies
3468 displayed in a wrong manner?!</a> (<a href="#cfg_LeftFrameTableSeparator"
3469 class="configrule">$cfg['LeftFrameTableSeparator']</a>)</h4>
3471 <p> Please note that you should not use the separating string multiple times
3472 without any characters between them, or at the beginning/end of your table
3473 name. If you have to, think about using another TableSeparator or disabling
3474 that feature</p>
3476 <h4 id="faq3_6">
3477 <a href="#faq3_6">3.6 What is currently not supported in phpMyAdmin about InnoDB?</a></h4>
3479 <p> In Relation view, being able to choose a table in another database,
3480 or having more than one index column in the foreign key.<br /><br/>
3481 In Query-by-example (Query), automatic generation of the query
3482 LEFT JOIN from the foreign table.<br /><br/>
3483 </p>
3485 <h4 id="faq3_7">
3486 <a href="#faq3_7">3.7 I have table with many (100+) columns and when I try to browse table
3487 I get series of errors like &quot;Warning: unable to parse url&quot;. How
3488 can this be fixed?</a></h4>
3490 Your table neither have a primary key nor an unique one, so we must use a
3491 long expression to identify this row. This causes problems to parse_url
3492 function. The workaround is to create a primary or unique key.
3493 <br />
3494 </p>
3496 <h4 id="faq3_8">
3497 <a href="#faq3_8">3.8 I cannot use (clickable) HTML-forms in columns where I put
3498 a MIME-Transformation onto!</a></h4>
3500 <p> Due to a surrounding form-container (for multi-row delete checkboxes), no
3501 nested forms can be put inside the table where phpMyAdmin displays the results.
3502 You can, however, use any form inside of a table if keep the parent
3503 form-container with the target to tbl_row_delete.php and just put your own
3504 input-elements inside. If you use a custom submit input field, the form will
3505 submit itself to the displaying page again, where you can validate the
3506 $HTTP_POST_VARS in a transformation.
3508 For a tutorial on how to effectively use transformations, see our
3509 <a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a>
3510 on the official phpMyAdmin-homepage.</p>
3512 <h4 id="faq3_9">
3513 <a href="#faq3_9">3.9 I get error messages when using "--sql_mode=ANSI" for the
3514 MySQL server</a></h4>
3516 <p> When MySQL is running in ANSI-compatibility mode, there are some major
3517 differences in how <abbr title="structured query language">SQL</abbr> is
3518 structured (see <a href="http://dev.mysql.com/doc/mysql/en/ansi-mode.html">
3519 http://dev.mysql.com/doc/mysql/en/ansi-mode.html</a>). Most important of all,
3520 the quote-character (") is interpreted as an identifier quote character and
3521 not as a string quote character, which makes many internal phpMyAdmin
3522 operations into invalid <abbr title="structured query language">SQL</abbr>
3523 statements. There is no workaround to this behaviour. News to this item will
3524 be posted in Bug report
3525 <a href="https://sourceforge.net/tracker/index.php?func=detail&amp;aid=816858&amp;group_id=23067&amp;atid=377408">#816858</a>
3526 </p>
3528 <h4 id="faq3_10">
3529 <a href="#faq3_10">3.10 Homonyms and no primary key: When the results of a SELECT display
3530 more that one column with the same value
3531 (for example <tt>SELECT lastname from employees where firstname like 'A%'</tt> and two &quot;Smith&quot; values are displayed),
3532 if I click Edit I cannot be sure that I am editing the intended row.</a></h4>
3534 <p> Please make sure that your table has a primary key, so that phpMyAdmin
3535 can use it for the Edit and Delete links.</p>
3537 <h4 id="faq3_11">
3538 <a href="#faq3_11">3.11 The number of rows for InnoDB tables is not correct.</a></h4>
3540 <p> phpMyAdmin uses a quick method to get the row count, and this method
3541 only returns an approximate count in the case of InnoDB tables. See
3542 <a href="#cfg_MaxExactCount" class="configrule">$cfg['MaxExactCount']</a> for
3543 a way to modify those results, but
3544 this could have a serious impact on performance.</p>
3546 <h4 id="faq3_12">
3547 <a href="#faq3_12">3.12 (withdrawn).</a></h4>
3549 <h4 id="faq3_13">
3550 <a href="#faq3_13">3.13 I get an error when entering <tt>USE</tt> followed by a db name
3551 containing an hyphen.
3552 </a></h4>
3554 The tests I have made with MySQL 5.1.49 shows that the
3555 API does not accept this syntax for the USE command.
3556 </p>
3558 <h4 id="faq3_14">
3559 <a href="#faq3_14">3.14 I am not able to browse a table when I don't have the right to SELECT one of the columns.</a></h4>
3561 This has been a known limitation of phpMyAdmin since the beginning and
3562 it's not likely to be solved in the future.
3563 </p>
3565 <!-- Begin: Excel import limitations -->
3567 <h4 id="faq3_15">
3568 <a href="#faq3_15">3.15 (withdrawn).</a></h4>
3570 <h4 id="faq3_16">
3571 <a href="#faq3_16">3.16 (withdrawn).</a></h4>
3573 <h4 id="faq3_17">
3574 <a href="#faq3_17">3.17 (withdrawn).</a></h4>
3576 <!-- End: Excel import limitations -->
3577 <!-- Begin: CSV import limitations -->
3579 <h4 id="faq3_18">
3580 <a href="#faq3_18">3.18 When I import a <abbr title="comma separated values">
3581 CSV</abbr> file that contains multiple tables, they are lumped together into
3582 a single table.</a></h4>
3584 There is no reliable way to differentiate tables in <abbr title="comma separated values">
3585 CSV</abbr> format. For the time being, you will have to break apart
3586 <abbr title="comma separated values">CSV</abbr> files containing multiple tables.
3587 </p>
3589 <!-- End: CSV import limitations -->
3590 <!-- Begin: Import type-detection limitations -->
3592 <h4 id="faq3_19">
3593 <a href="#faq3_19">3.19 When I import a file and have phpMyAdmin determine the appropriate data structure it only uses int, decimal, and varchar types.</a></h4>
3595 Currently, the import type-detection system can only assign these MySQL types to columns. In future, more will likely be added but for the time being
3596 you will have to edit the structure to your liking post-import.
3597 <br /><br />
3598 Also, you should note the fact that phpMyAdmin will use the size of the largest item in any given column as the column size for the appropriate type. If you
3599 know you will be adding larger items to that column then you should manually adjust the column sizes accordingly. This is done for the sake of efficiency.
3600 </p>
3602 <!-- End: Import type-detection limitations -->
3604 <h3 id="faqmultiuser"><abbr title="Internet service provider">ISP</abbr>s, multi-user installations</h3>
3606 <h4 id="faq4_1">
3607 <a href="#faq4_1">4.1 I'm an <abbr title="Internet service provider">ISP</abbr>. Can I setup one central copy of phpMyAdmin or do I
3608 need to install it for each customer.
3609 </a></h4>
3611 Since version 2.0.3, you can setup a central copy of phpMyAdmin for all
3612 your users. The development of this feature was kindly sponsored by
3613 NetCologne GmbH.
3614 This requires a properly setup MySQL user management and phpMyAdmin
3615 <abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie authentication. See the install section on
3616 &quot;Using <abbr title="HyperText Transfer Protocol">HTTP</abbr> authentication&quot;.
3617 </p>
3619 <h4 id="faq4_2">
3620 <a href="#faq4_2">4.2 What's the preferred way of making phpMyAdmin secure against evil
3621 access.
3622 </a></h4>
3624 This depends on your system.<br />
3625 If you're running a server which cannot be accessed by other people, it's
3626 sufficient to use the directory protection bundled with your webserver
3627 (with Apache you can use <a href="#glossary"><i>.htaccess</i></a> files, for example).<br />
3628 If other people have telnet access to your server, you should use
3629 phpMyAdmin's <abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie authentication features.
3630 <br /><br />
3631 Suggestions:
3632 </p>
3633 <ul>
3634 <li>
3635 Your <i>config.inc.php</i> file should be <tt>chmod 660</tt>.
3636 </li>
3637 <li>
3638 All your phpMyAdmin files should be chown -R phpmy.apache, where phpmy
3639 is a user whose password is only known to you, and apache is the
3640 group under which Apache runs.
3641 </li>
3642 <li>
3643 Follow security recommendations for PHP and your webserver.
3644 </li>
3645 </ul>
3647 <h4 id="faq4_3">
3648 <a href="#faq4_3">4.3 I get errors about not being able to include a file in
3649 <i>/lang</i> or in <i>/libraries</i>.
3650 </a></h4>
3652 Check <i>php.ini</i>, or ask your sysadmin to check it. The
3653 <tt>include_path</tt> must contain &quot;.&quot; somewhere in it, and
3654 <tt>open_basedir</tt>, if used, must contain &quot;.&quot; and
3655 &quot;./lang&quot; to allow normal operation of phpMyAdmin.
3656 </p>
3658 <h4 id="faq4_4">
3659 <a href="#faq4_4">4.4 phpMyAdmin always gives &quot;Access denied&quot; when using <abbr title="HyperText Transfer Protocol">HTTP</abbr>
3660 authentication.
3661 </a></h4>
3663 <p> This could happen for several reasons:</p>
3665 <ul><li><a href="#cfg_Servers_controluser" class="configrule">$cfg['Servers'][$i]['controluser']</a>
3666 and/or
3667 <a href="#cfg_Servers_controlpass" class="configrule">$cfg['Servers'][$i]['controlpass']</a>
3668 are wrong.</li>
3669 <li>The username/password you specify in the login dialog are invalid.</li>
3670 <li>You have already setup a security mechanism for the
3671 phpMyAdmin-directory, eg. a <a href="#glossary"><i>.htaccess</i></a> file. This would interfere with
3672 phpMyAdmin's authentication, so remove it.</li>
3673 </ul>
3675 <h4 id="faq4_5">
3676 <a href="#faq4_5">4.5 Is it possible to let users create their own databases?</a></h4>
3678 <p> Starting with 2.2.5, in the user management page, you can enter a wildcard
3679 database name for a user (for example &quot;joe%&quot;),
3680 and put the privileges you want. For example,
3681 adding <tt>SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER</tt>
3682 would let a user create/manage his/her database(s).</p>
3684 <h4 id="faq4_6">
3685 <a href="#faq4_6">4.6 How can I use the Host-based authentication additions?</a></h4>
3687 <p> If you have existing rules from an old <a href="#glossary"><i>.htaccess</i></a> file, you can take them
3688 and add a username between the <tt>'deny'</tt>/<tt>'allow'</tt> and
3689 <tt>'from'</tt> strings. Using the username wildcard of <tt>'%'</tt> would
3690 be a major benefit here if your installation is suited to using it. Then
3691 you can just add those updated lines into the
3692 <a href="#cfg_Servers_AllowDeny_rules" class="configrule">
3693 $cfg['Servers'][$i]['AllowDeny']['rules']</a> array.</p>
3695 <p> If you want a pre-made sample, you can try this fragment. It stops the
3696 'root' user from logging in from any networks other than the private
3697 network <abbr title="Internet Protocol">IP</abbr> blocks.</p>
3699 <pre>
3700 //block root from logging in except from the private networks
3701 $cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';
3702 $cfg['Servers'][$i]['AllowDeny']['rules'] = array(
3703 'deny root from all',
3704 'allow root from localhost',
3705 'allow root from 10.0.0.0/8',
3706 'allow root from 192.168.0.0/16',
3707 'allow root from 172.16.0.0/12',
3709 </pre>
3711 <h4 id="faq4_7">
3712 <a href="#faq4_7">4.7 Authentication window is displayed more than once, why?</a></h4>
3714 <p> This happens if you are using a <abbr title="Uniform Resource Locator">URL</abbr> to start phpMyAdmin which is
3715 different than the one set in your
3716 <a href="#cfg_PmaAbsoluteUri" class="configrule">$cfg['PmaAbsoluteUri']</a>.
3717 For example, a missing &quot;www&quot;, or entering with an <abbr title="Internet Protocol">IP</abbr> address
3718 while a domain name is defined in the config file.</p>
3720 <h4 id="faq4_8">
3721 <a href="#faq4_8">4.8 Which parameters can I use in the URL that starts phpMyAdmin?</a></h4>
3723 <p>When starting phpMyAdmin, you can use the <tt>db</tt>, <tt>pma_username</tt>, <tt>pma_password</tt> and <tt>server</tt> parameters. This last one can contain either the numeric host index (from <tt>$i</tt> of the configuration file) or one of the host names present in the configuration file. Using <tt>pma_username</tt> and <tt>pma_password</tt> has been tested along with the usage of 'cookie' <tt>auth_type</tt>.</p>
3725 <h3 id="faqbrowsers">Browsers or client <abbr title="operating system">OS</abbr></h3>
3727 <h4 id="faq5_1">
3728 <a href="#faq5_1">5.1 I get an out of memory error, and my controls are non-functional,
3729 when trying to create a table with more than 14 columns.
3730 </a></h4>
3732 We could reproduce this problem only under Win98/98SE. Testing under
3733 WinNT4 or Win2K, we could easily create more than 60 columns.
3734 <br />
3735 A workaround is to create a smaller number of columns, then come back to
3736 your table properties and add the other columns.
3737 </p>
3739 <h4 id="faq5_2">
3740 <a href="#faq5_2">5.2 With Xitami 2.5b4, phpMyAdmin won't process form fields.</a></h4>
3742 This is not a phpMyAdmin problem but a Xitami known bug: you'll face it
3743 with each script/website that use forms.<br />
3744 Upgrade or downgrade your Xitami server.
3745 </p>
3747 <h4 id="faq5_3">
3748 <a href="#faq5_3">5.3 I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).</a></h4>
3750 With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except that
3751 the proposed file name for the dump is always 'tbl_dump.php'. Bzip2 dumps
3752 don't seem to work.<br />
3754 With Konqueror 2.2.1: plain dumps work; zip dumps are placed into
3755 the user's temporary directory, so they must be moved before closing
3756 Konqueror, or else they disappear. GZip dumps give an error message.<br />
3758 Testing needs to be done for Konqueror 2.2.2.<br />
3759 </p>
3761 <h4 id="faq5_4">
3762 <a href="#faq5_4">5.4 I can't use the cookie authentication mode because Internet
3763 Explorer never stores the cookies.
3764 </a></h4>
3766 MS Internet Explorer seems to be really buggy about cookies, at least till
3767 version 6.
3768 </p>
3770 <h4 id="faq5_5">
3771 <a href="#faq5_5">5.5 In Internet Explorer 5.0, I get JavaScript errors when browsing my
3772 rows.
3773 </a></h4>
3775 Upgrade to at least Internet Explorer 5.5 SP2.<br />
3776 </p>
3778 <h4 id="faq5_6">
3779 <a href="#faq5_6">5.6 In Internet Explorer 5.0, 5.5 or 6.0, I get an error (like "Page not found")
3780 when trying to modify a row in a table with many columns, or with a text
3781 column
3782 </a></h4>
3784 Your table neither have a primary key nor an unique one, so we must use a
3785 long <abbr title="Uniform Resource Locator">URL</abbr> to identify this row. There is a limit on the length of the <abbr title="Uniform Resource Locator">URL</abbr> in
3786 those browsers, and this not happen in Netscape, for example. The
3787 workaround is to create a primary or unique key, or use another browser.
3788 <br />
3789 </p>
3791 <h4 id="faq5_7">
3792 <a href="#faq5_7">5.7 I refresh (reload) my browser, and come back to the welcome
3793 page.
3794 </a></h4>
3796 Some browsers support right-clicking into the frame you want to refresh,
3797 just do this in the right frame.<br />
3798 </p>
3800 <h4 id="faq5_8">
3801 <a href="#faq5_8">5.8 With Mozilla 0.9.7 I have problems sending a query modified in the
3802 query box.
3803 </a></h4>
3805 Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
3806 Mozilla versions.<br />
3807 </p>
3809 <h4 id="faq5_9">
3810 <a href="#faq5_9">5.9 With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
3811 whitespace in the <abbr title="structured query language">SQL</abbr>-Query edit area: the page scrolls down.
3812 </a></h4>
3814 This is a Mozilla bug (see bug #26882 at
3815 <a href="http://bugzilla.mozilla.org/">BugZilla</a>).<br />
3816 </p>
3818 <h4 id="faq5_10">
3819 <a href="#faq5_10">5.10 With Netscape 4.75 I get empty rows between each row of data in a
3820 <abbr title="comma separated values">CSV</abbr> exported file.
3821 </a></h4>
3823 This is a known Netscape 4.75 bug: it adds some line feeds when exporting
3824 data in octet-stream mode. Since we can't detect the specific Netscape
3825 version, we cannot workaround this bug.
3826 </p>
3828 <h4 id="faq5_11">
3829 <a href="#faq5_11">5.11 Extended-ASCII characters like German umlauts are displayed
3830 wrong.</a></h4>
3832 <p> Please ensure that you have set your browser's character set to the one of the
3833 language file you have selected on phpMyAdmin's start page.
3834 Alternatively, you can try the auto detection mode that is supported by the
3835 recent versions of the most browsers.</p>
3837 <h4 id="faq5_12">
3838 <a href="#faq5_12">5.12 <acronym title="Apple Macintosh">Mac</acronym> <abbr title="operating system">OS</abbr> X: Safari browser changes special characters to
3839 &quot;?&quot;.</a></h4>
3841 <p> This issue has been reported by a <abbr title="operating system">OS</abbr> X user, who adds that Chimera,
3842 Netscape and Mozilla do not have this problem.</p>
3844 <h4 id="faq5_13">
3845 <a href="#faq5_13">5.13 With Internet Explorer 5.5 or 6, and <abbr title="HyperText Transfer Protocol">HTTP</abbr> authentication type,
3846 I cannot manage two servers: I log in to the first one, then the other one,
3847 but if I switch back to the first, I have to log in on each operation.</a></h4>
3849 <p> This is a bug in Internet Explorer, other browsers do not behave this way.</p>
3851 <h4 id="faq5_14">
3852 <a href="#faq5_14">5.14 Using Opera6, I can manage to get to the authentication,
3853 but nothing happens after that, only a blank screen.</a></h4>
3855 <p> Please upgrade to Opera7 at least.</p>
3857 <h4 id="faq5_15">
3858 <a href="#faq5_15">5.15 I have display problems with Safari.</a></h4>
3860 <p> Please upgrade to at least version 1.2.3.</p>
3862 <h4 id="faq5_16">
3863 <a href="#faq5_16">5.16 With Internet Explorer, I get &quot;Access is denied&quot;
3864 Javascript errors. Or I cannot make phpMyAdmin work under Windows.</a></h4>
3866 <p> Please check the following points:</p>
3867 <ul><li>Maybe you have defined your <tt>PmaAbsoluteUri</tt> setting
3868 in <tt>config.inc.php</tt> to an <abbr title="Internet Protocol">IP</abbr>
3869 address and you are starting
3870 phpMyAdmin with a <abbr title="Uniform Resource Locator">URL</abbr>
3871 containing a domain name, or the reverse situation.</li>
3872 <li>Security settings in IE and/or Microsoft Security Center are
3873 too high, thus blocking scripts execution.</li>
3874 <li>The Windows Firewall is blocking Apache and MySQL. You must
3875 allow <abbr title="HyperText Transfer Protocol">HTTP</abbr> ports
3876 (80 or 443) and MySQL port (usually 3306)
3877 in the &quot;in&quot; and &quot;out&quot; directions.</li>
3878 </ul>
3880 <h4 id="faq5_17">
3881 <a href="#faq5_17">5.17 With Firefox, I cannot delete rows of data or drop a database.</a></h4>
3882 <p> Many users have confirmed that the Tabbrowser Extensions plugin they
3883 installed in their Firefox is causing the problem.</p>
3885 <h4 id="faq5_18">
3886 <a href="#faq5_18">5.18 With Konqueror 4.2.x an invalid <tt>LIMIT</tt>
3887 clause is generated when I browse a table.</a></h4>
3888 <p> This happens only when both of these conditions are met: using the
3889 <tt>http</tt> authentication mode and <tt>register_globals</tt> being set
3890 to <tt>On</tt> on the server. It seems to be a browser-specific problem;
3891 meanwhile use the <tt>cookie</tt> authentication mode.</p>
3893 <h4 id="faq5_19">
3894 <a href="#faq5_19">5.19 I get JavaScript errors in my browser.</a></h4>
3895 <p> Issues have been reported with some combinations of browser extensions.
3896 To troubleshoot, disable all extensions then clear your browser cache
3897 to see if the problem goes away.</p>
3899 <h3 id="faqusing">Using phpMyAdmin</h3>
3901 <h4 id="faq6_1">
3902 <a href="#faq6_1">6.1 I can't insert new rows into a table / I can't create a table
3903 - MySQL brings up a <abbr title="structured query language">SQL</abbr>-error.
3904 </a></h4>
3906 Examine the <abbr title="structured query language">SQL</abbr> error with care. Often the problem is caused by
3907 specifying a wrong column-type.<br />
3908 Common errors include:
3909 </p>
3910 <ul>
3911 <li>Using <tt>VARCHAR</tt> without a size argument</li>
3912 <li>Using <tt>TEXT</tt> or <tt>BLOB</tt> with a size argument</li>
3913 </ul>
3915 Also, look at the syntax chapter in the MySQL manual to confirm that your
3916 syntax is correct.
3917 </p>
3919 <h4 id="faq6_2">
3920 <a href="#faq6_2">6.2 When I create a table, I set an index for two
3921 columns and
3922 phpMyAdmin generates only one index with those two columns.
3923 </a></h4>
3925 This is the way to create a multi-columns
3926 index. If you want two indexes, create the first one when creating the
3927 table, save, then display the table properties and click the Index link to
3928 create the other index.
3929 </p>
3931 <h4 id="faq6_3">
3932 <a href="#faq6_3">6.3 How can I insert a null value into my table?</a></h4>
3934 Since version 2.2.3, you have a checkbox for each column that can be null.
3935 Before 2.2.3, you had to enter &quot;null&quot;, without the quotes, as the
3936 column's value. Since version 2.5.5, you have to use the checkbox to get
3937 a real NULL value, so if you enter &quot;NULL&quot; this means you want
3938 a literal NULL in the column, and not a NULL value (this works in PHP4).
3939 </p>
3941 <h4 id="faq6_4">
3942 <a href="#faq6_4">6.4 How can I backup my database or table?</a></h4>
3944 <p> Click on a database or table name in the left frame, the properties will be
3945 displayed. Then on the menu, click &quot;Export&quot;, you can dump
3946 the structure, the data, or both. This will generate standard <abbr title="structured query language">SQL</abbr>
3947 statements that can be used to recreate your database/table.
3948 <br /><br />
3949 You will need to choose &quot;Save as file&quot;, so that phpMyAdmin can
3950 transmit the resulting dump to your station. Depending on your PHP
3951 configuration, you will see options to compress the dump. See also the
3952 <a href="#cfg_ExecTimeLimit" class="configrule">$cfg['ExecTimeLimit']</a>
3953 configuration variable.<br /><br />
3955 For additional help on this subject, look for the word &quot;dump&quot; in
3956 this document.</p>
3958 <h4 id="faq6_5">
3959 <a href="#faq6_5">6.5 How can I restore (upload) my database or table using a dump?
3960 How can I run a &quot;.sql&quot; file?
3961 </a></h4>
3963 <p> Click on a database name in the left frame, the properties will be
3964 displayed. Select &quot;Import&quot; from the list
3965 of tabs in the right&#8211;hand frame (or &quot;<abbr title="structured query language">SQL</abbr>&quot; if your phpMyAdmin
3966 version is previous to 2.7.0). In the &quot;Location of the text file&quot; section, type in
3967 the path to your dump filename, or use the Browse button. Then click Go.
3968 <br /><br />
3969 With version 2.7.0, the import engine has been re&#8211;written, if possible it is suggested
3970 that you upgrade to take advantage of the new features.
3971 <br /><br />
3972 For additional help on this subject, look for the word &quot;upload&quot;
3973 in this document.
3974 </p>
3976 <h4 id="faq6_6">
3977 <a href="#faq6_6">6.6 How can I use the relation table in Query-by-example?</a></h4>
3979 <p> Here is an example with the tables persons, towns and countries, all
3980 located in the database mydb. If you don't have a <tt>pma_relation</tt>
3981 table, create it as explained in the configuration section. Then create the
3982 example tables:</p>
3984 <pre>
3985 CREATE TABLE REL_countries (
3986 country_code char(1) NOT NULL default '',
3987 description varchar(10) NOT NULL default '',
3988 PRIMARY KEY (country_code)
3989 ) TYPE=MyISAM;
3991 INSERT INTO REL_countries VALUES ('C', 'Canada');
3993 CREATE TABLE REL_persons (
3994 id tinyint(4) NOT NULL auto_increment,
3995 person_name varchar(32) NOT NULL default '',
3996 town_code varchar(5) default '0',
3997 country_code char(1) NOT NULL default '',
3998 PRIMARY KEY (id)
3999 ) TYPE=MyISAM;
4001 INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');
4002 INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');
4004 CREATE TABLE REL_towns (
4005 town_code varchar(5) NOT NULL default '0',
4006 description varchar(30) NOT NULL default '',
4007 PRIMARY KEY (town_code)
4008 ) TYPE=MyISAM;
4010 INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');
4011 INSERT INTO REL_towns VALUES ('M', 'Montr&eacute;al');
4012 </pre>
4014 <p> To setup appropriate links and display information:</p>
4016 <ul><li>on table &quot;REL_persons&quot; click Structure, then Relation view</li>
4017 <li>in Links, for &quot;town_code&quot; choose &quot;REL_towns-&gt;code&quot;</li>
4018 <li>in Links, for &quot;country_code&quot; choose &quot;REL_countries-&gt;country_code&quot;</li>
4019 <li>on table &quot;REL_towns&quot; click Structure, then Relation view</li>
4020 <li>in &quot;Choose column to display&quot;, choose &quot;description&quot;</li>
4021 <li>repeat the two previous steps for table &quot;REL_countries&quot;</li>
4022 </ul>
4024 <p> Then test like this:</p>
4026 <ul><li>Click on your db name in the left frame</li>
4027 <li>Choose &quot;Query&quot;</li>
4028 <li>Use tables: persons, towns, countries</li>
4029 <li>Click &quot;Update query&quot;</li>
4030 <li>In the columns row, choose persons.person_name and click the
4031 &quot;Show&quot; tickbox </li>
4032 <li>Do the same for towns.description and countries.descriptions in the
4033 other 2 columns</li>
4034 <li>Click &quot;Update query&quot; and you will see in the query box that
4035 the correct joins have been generated</li>
4036 <li>Click &quot;Submit query&quot;</li>
4037 </ul>
4039 <h4 id="faqdisplay">
4040 <a href="#faqdisplay">6.7 How can I use the &quot;display column&quot; feature?</a></h4>
4042 Starting from the previous example, create the pma_table_info as explained
4043 in the configuration section, then browse your persons table,
4044 and move the mouse over a town code or country code.
4045 <br /><br />
4046 See also <a href="#faq6_21"><abbr title="Frequently Asked Questions">FAQ</abbr> 6.21</a> for an additional feature that &quot;display column&quot;
4047 enables: drop-down list of possible values.
4048 </p>
4050 <h4 id="faqpdf">
4051 <a href="#faqpdf">6.8 How can I produce a <abbr title="Portable Document Format">PDF</abbr> schema of my database?</a></h4>
4053 First the configuration variables &quot;relation&quot;,
4054 &quot;table_coords&quot; and &quot;pdf_pages&quot; have to be filled in.
4055 <br /><br />
4056 Then you need to think about your schema layout. Which tables will go on
4057 which pages?
4058 </p>
4059 <ul>
4060 <li>Select your database in the left frame.</li>
4061 <li>Choose &quot;Operations&quot; in the navigation bar at the top.</li>
4062 <li>Choose &quot;Edit <abbr title="Portable Document Format">PDF</abbr>
4063 Pages&quot; near the bottom of the page.</li>
4064 <li>Enter a name for the first <abbr title="Portable Document Format">PDF</abbr>
4065 page and click Go. If you like, you
4066 can use the &quot;automatic layout,&quot; which will put all your
4067 linked tables onto the new page.</li>
4068 <li>Select the name of the new page (making sure the Edit radio button
4069 is selected) and click Go.</li>
4070 <li>Select a table from the list, enter its coordinates and click Save.<br />
4071 Coordinates are relative; your diagram will
4072 be automatically scaled to fit the page. When initially placing tables
4073 on the page, just pick any coordinates -- say, 50x50. After clicking
4074 Save, you can then use the <a href="#wysiwyg">graphical editor</a> to
4075 position the element correctly.</li>
4076 <li>When you'd like to look at your <abbr title="Portable Document Format">PDF</abbr>,
4077 first be sure to click the Save
4078 button beneath the list of tables and coordinates, to save any changes
4079 you made there. Then scroll all the way down, select the
4080 <abbr title="Portable Document Format">PDF</abbr> options
4081 you want, and click Go.</li>
4082 <li>Internet Explorer for Windows may suggest an incorrect filename when
4083 you try to save a generated <abbr title="Portable Document Format">PDF</abbr>.
4084 When saving a generated <abbr title="Portable Document Format">PDF</abbr>, be
4085 sure that the filename ends in &quot;.pdf&quot;, for example
4086 &quot;schema.pdf&quot;. Browsers on other operating systems, and other
4087 browsers on Windows, do not have this problem.</li>
4088 </ul>
4090 <h4 id="faq6_9">
4091 <a href="#faq6_9">6.9 phpMyAdmin is changing the type of one of my
4092 columns!</a></h4>
4094 <p> No, it's MySQL that is doing
4095 <a href="http://dev.mysql.com/doc/en/silent-column-changes.html">silent
4096 column type changing</a>.</p>
4098 <h4 id="underscore">
4099 <a href="#underscore">6.10 When creating a privilege, what happens with
4100 underscores in the database name?</a></h4>
4102 <p> If you do not put a backslash before the underscore, this is a wildcard
4103 grant, and the underscore means &quot;any character&quot;. So, if the
4104 database name is &quot;john_db&quot;, the user would get rights to john1db,
4105 john2db ...<br /><br />
4107 If you put a backslash before the underscore, it means that the database
4108 name will have a real underscore.</p>
4110 <h4 id="faq6_11">
4111 <a href="#faq6_11">6.11 What is the curious symbol &oslash; in the
4112 statistics pages?</a></h4>
4114 <p> It means &quot;average&quot;.</p>
4116 <h4 id="faqexport">
4117 <a href="#faqexport">6.12 I want to understand some Export options.</a></h4>
4119 <p><b>Structure:</b></p>
4121 <ul><li>&quot;Add DROP TABLE&quot; will add a line telling MySQL to
4122 <a href="http://dev.mysql.com/doc/mysql/en/drop-table.html">drop the table</a>,
4123 if it already exists during the import. It does NOT drop the table after
4124 your export, it only affects the import file.</li>
4125 <li>&quot;If Not Exists&quot; will only create the table if it doesn't exist.
4126 Otherwise, you may get an error if the table name exists but has a
4127 different structure.</li>
4128 <li>&quot;Add AUTO_INCREMENT value&quot; ensures that AUTO_INCREMENT value
4129 (if any) will be included in backup.</li>
4130 <li>&quot;Enclose table and column names with backquotes&quot; ensures that
4131 column and table names formed with special characters are protected.</li>
4132 <li>&quot;Add into comments&quot; includes column comments, relations, and MIME
4133 types set in the pmadb in the dump as
4134 <abbr title="structured query language">SQL</abbr> comments (<i>/* xxx */</i>).
4135 </li>
4136 </ul>
4138 <p><b>Data:</b></p>
4140 <ul><li>&quot;Complete inserts&quot; adds the column names on every INSERT
4141 command, for better documentation (but resulting file is bigger).</li>
4142 <li>&quot;Extended inserts&quot; provides a shorter dump file by using only
4143 once the INSERT verb and the table name.</li>
4144 <li>&quot;Delayed inserts&quot; are best explained in the
4145 <a href="http://dev.mysql.com/doc/mysql/en/insert-delayed.html">MySQL manual</a>.
4146 </li>
4147 <li>&quot;Ignore inserts&quot; treats errors as a warning instead. Again,
4148 more info is provided in the
4149 <a href="http://dev.mysql.com/doc/mysql/en/insert.html">MySQL manual</a>,
4150 but basically with this selected, invalid values are adjusted and
4151 inserted rather than causing the entire statement to fail.</li>
4152 </ul>
4154 <h4 id="faq6_13">
4155 <a href="#faq6_13">6.13 I would like to create a database with a dot
4156 in its name.</a></h4>
4158 <p> This is a bad idea, because in MySQL the syntax &quot;database.table&quot;
4159 is the normal way to reference a database and table name. Worse, MySQL
4160 will usually let you create a database with a dot, but then you cannot
4161 work with it, nor delete it.</p>
4163 <h4 id="faqsqlvalidator">
4164 <a href="#faqsqlvalidator">6.14 How do I set up the
4165 <abbr title="structured query language">SQL</abbr> Validator?</a></h4>
4167 <p>
4168 To use SQL Validator, you need PHP with
4169 <abbr title="Extensible Markup Language">XML</abbr>,
4170 <abbr title="Perl Compatible Regular Expressions">PCRE</abbr> and
4171 <abbr title="PHP Extension and Application Repository">PEAR</abbr> support.
4172 In addition you need a <abbr title="Simple Object Access
4173 Protocol">SOAP</abbr> support, either as a PHP extension or as a PEAR SOAP
4174 module.
4175 </p>
4178 To install <abbr title="PHP Extension and Application
4179 Repository">PEAR</abbr> <abbr title="Simple Object Access
4180 Protocol">SOAP</abbr> module, run <tt>"pear install Net_Socket Net_URL
4181 HTTP_Request Mail_Mime Net_DIME SOAP"</tt> to get the necessary <abbr
4182 title="PHP Extension and Application Repository">PEAR</abbr> modules for
4183 usage.
4184 </p>
4187 If you use the Validator, you should be aware that any
4188 <abbr title="structured query language">SQL</abbr> statement you
4189 submit will be stored anonymously (database/table/column names,
4190 strings, numbers replaced with generic values). The Mimer
4191 <abbr title="structured query language">SQL</abbr>
4192 Validator itself, is &copy; 2001 Upright Database Technology.
4193 We utilize it as free SOAP service.
4194 </p>
4196 <h4 id="faq6_15">
4197 <a href="#faq6_15">6.15 I want to add a BLOB column and put an index on
4198 it, but MySQL says &quot;BLOB column '...' used in key specification without
4199 a key length&quot;.</a></h4>
4201 <p> The right way to do this, is to create the column without any indexes,
4202 then display the table structure and use the &quot;Create an index&quot;
4203 dialog. On this page, you will be able to choose your BLOB column, and
4204 set a size to the index, which is the condition to create an index on
4205 a BLOB column.</p>
4207 <h4 id="faq6_16">
4208 <a href="#faq6_16">6.16 How can I simply move in page with plenty
4209 editing fields?</a></h4>
4211 <p> You can use Ctrl+arrows (Option+Arrows in Safari) for moving on most pages
4212 with many editing fields (table structure changes, row editing, etc.).</p>
4214 <h4 id="faq6_17">
4215 <a href="#faq6_17">6.17 Transformations: I can't enter my own mimetype!
4216 WTF is this feature then useful for?</a></h4>
4218 <p> Slow down :). Defining mimetypes is of no use, if you can't put transformations
4219 on them. Otherwise you could just put a comment on the column. Because entering
4220 your own mimetype will cause serious syntax checking issues and validation,
4221 this introduces a high-risk false-user-input situation. Instead you have to
4222 initialize mimetypes using functions or empty mimetype definitions.<br />
4223 Plus, you have a whole overview of available mimetypes. Who knows all those
4224 mimetypes by heart so he/she can enter it at will?</p>
4226 <h4 id="faqbookmark">
4227 <a href="#faqbookmark">6.18 Bookmarks: Where can I store bookmarks? Why
4228 can't I see any bookmarks below the query box? What is this variable for?
4229 </a></h4>
4231 <p> Any query you have executed can be stored as a bookmark on the page where the
4232 results are displayed. You will find a button labeled 'Bookmark this query'
4233 just at the end of the page.<br />
4234 As soon as you have stored a bookmark, it is related to the database you run
4235 the query on. You can now access a bookmark dropdown on each page, the query
4236 box appears on for that database.<br /><br />
4238 Since phpMyAdmin 2.5.0 you are also able to store variables for the bookmarks.
4239 Just use the string <b>/*[VARIABLE]*/</b> anywhere in your query. Everything
4240 which is put into the <i>value</i> input box on the query box page will
4241 replace the string &quot;/*[VARIABLE]*/&quot; in your stored query. Just be
4242 aware of that you HAVE to create a valid query, otherwise your query won't be
4243 even able to be stored in the database.<br />
4244 Also remember, that everything else inside the <b>/*[VARIABLE]*/</b> string
4245 for your query will remain the way it is, but will be stripped of the /**/
4246 chars. So you can use:<br /><br />
4248 <code>/*, [VARIABLE] AS myname */</code><br /><br />
4250 which will be expanded to<br /><br />
4252 <code>, VARIABLE as myname</code><br /><br />
4254 in your query, where VARIABLE is the string you entered in the input box. If
4255 an empty string is provided, no replacements are made.<br /><br />
4257 A more complex example. Say you have stored this query:<br /><br />
4258 <code>SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE '%[VARIABLE]%' */</code>
4259 <br /><br />
4261 Say, you now enter &quot;phpMyAdmin&quot; as the variable for the stored query,
4262 the full query will be:<br /><br />
4264 <code>SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE '%phpMyAdmin%'</code>
4265 <br /><br />
4267 You can use multiple occurrences of <b>/*[VARIABLE]*/</b> in a single query (that is, multiple occurrences of the <i>same</i> variable).<br />
4268 <b>NOTE THE ABSENCE OF SPACES</b> inside the &quot;/**/&quot; construct. Any
4269 spaces inserted there
4270 will be later also inserted as spaces in your query and may lead to unexpected
4271 results especially when
4272 using the variable expansion inside of a &quot;LIKE ''&quot; expression.<br />
4273 Your initial query which is going to be stored as a bookmark has to yield at
4274 least one result row so
4275 you can store the bookmark. You may have that to work around using well
4276 positioned &quot;/**/&quot; comments.</p>
4278 <h4 id="faq6_19">
4279 <a href="#faq6_19">6.19 How can I create simple L<sup>A</sup>T<sub><big>E</big></sub>X document to
4280 include exported table?</a></h4>
4282 <p> You can simply include table in your L<sup>A</sup>T<sub><big>E</big></sub>X documents, minimal sample
4283 document should look like following one (assuming you have table
4284 exported in file <code>table.tex</code>):</p>
4286 <pre>
4287 \documentclass{article} % or any class you want
4288 \usepackage{longtable} % for displaying table
4289 \begin{document} % start of document
4290 \include{table} % including exported table
4291 \end{document} % end of document
4292 </pre>
4294 <h4 id="faq6_20">
4295 <a href="#faq6_20">6.20 I see a lot of databases which are not mine, and cannot
4296 access them.
4297 </a></h4>
4299 <p> You have one of these global privileges: CREATE
4300 TEMPORARY TABLES, SHOW DATABASES, LOCK TABLES. Those privileges also
4301 enable users to see all the database names.
4302 See this <a href="http://bugs.mysql.com/179">bug report</a>.<br /><br />
4304 So if your users do not need those privileges, you can remove them and their
4305 databases list will shorten.</p>
4307 <h4 id="faq6_21">
4308 <a href="#faq6_21">6.21 In edit/insert mode, how can I see a list of
4309 possible values for a column, based on some foreign table?</a></h4>
4311 <p> You have to setup appropriate links between the tables, and also
4312 setup the &quot;display column&quot; in the foreign table. See
4313 <a href="#faq6_6"><abbr title="Frequently Asked Questions">FAQ</abbr>
4314 6.6</a> for an example. Then, if there are 100 values or less in the
4315 foreign table, a drop-down list of values will be available.
4316 You will see two lists of values, the first list containing the key
4317 and the display column, the second list containing the display column
4318 and the key. The reason for this is to be able to type the first
4319 letter of either the key or the display column.<br /><br />
4321 For 100 values or more, a distinct window will appear, to browse foreign
4322 key values and choose one. To change the default limit of 100, see
4323 <tt><a href="#cfg_ForeignKeyMaxLimit" class="configrule">$cfg['ForeignKeyMaxLimit']</a></tt>.</p>
4325 <h4 id="faq6_22">
4326 <a href="#faq6_22">6.22 Bookmarks: Can I execute a default bookmark
4327 automatically when entering Browse mode for a table?</a></h4>
4329 <p> Yes. If a bookmark has the same label as a table name and it's not a public bookmark, it will be executed.
4330 </p>
4332 <h4 id="faq6_23">
4333 <a href="#faq6_23">6.23 Export: I heard phpMyAdmin can export Microsoft Excel files?</a></h4>
4335 <p> You can use
4336 <abbr title="comma separated values">CSV</abbr> for Microsoft Excel,
4337 which works out of the box.<br />
4338 Since phpMyAdmin 3.4.5 support for direct export to Microsoft Excel
4339 version 97 and newer was dropped.
4340 </p>
4342 <h4 id="faq6_24">
4343 <a href="#faq6_24">6.24 Now that phpMyAdmin supports native MySQL 4.1.x column comments,
4344 what happens to my column comments stored in pmadb?</a></h4>
4346 <p> Automatic migration of a table's pmadb-style column comments to the native
4347 ones is done whenever you enter Structure page for this table.</p>
4349 <h4 id="faq6_25">
4350 <a href="#faq6_25">6.25 (withdrawn).</a></h4>
4352 <h4 id="faq6_26">
4353 <a href="#faq6_26">6.26 How can I select a range of rows?</a></h4>
4355 <p> Click the first row of the range, hold the shift key and click the last row of the range. This works everywhere you see rows, for example in Browse mode or on the Structure page.</p>
4358 <h4 id="faq6_27">
4359 <a href="#faq6_27">6.27 What format strings can I use?</a></h4>
4362 In all places where phpMyAdmin accepts format strings, you can use
4363 <code>@VARIABLE@</code> expansion and
4364 <a href="http://php.net/strftime">strftime</a> format strings. The
4365 expanded variables depend on a context (for example, if you haven't chosen a
4366 table, you can not get the table name), but the following variables can be used:
4367 </p>
4368 <dl>
4369 <dt><code>@HTTP_HOST@</code></dt>
4370 <dd>HTTP host that runs phpMyAdmin</dd>
4371 <dt><code>@SERVER@</code></dt>
4372 <dd>MySQL server name</dd>
4373 <dt><code>@VERBOSE@</code></dt>
4374 <dd>Verbose MySQL server name as defined in <a href="#cfg_Servers_verbose">server configuration</a></dd>
4375 <dt><code>@VSERVER@</code></dt>
4376 <dd>Verbose MySQL server name if set, otherwise normal</dd>
4377 <dt><code>@DATABASE@</code></dt>
4378 <dd>Currently opened database</dd>
4379 <dt><code>@TABLE@</code></dt>
4380 <dd>Currently opened table</dd>
4381 <dt><code>@COLUMNS@</code></dt>
4382 <dd>Columns of the currently opened table</dd>
4383 <dt><code>@PHPMYADMIN@</code></dt>
4384 <dd>phpMyAdmin with version</dd>
4385 </dl>
4387 <h4 id="wysiwyg">
4388 <a href="#wysiwyg">6.28 How can I easily edit relational schema for export?</a></h4>
4390 <p>
4391 By clicking on the button 'toggle scratchboard' on the page
4392 where you edit x/y coordinates of those elements you can activate a
4393 scratchboard where all your elements are placed. By clicking on an
4394 element, you can move them around in the pre-defined area and the x/y
4395 coordinates will get updated dynamically. Likewise, when entering a
4396 new position directly into the input field, the new position in the
4397 scratchboard changes after your cursor leaves the input field.
4398 </p>
4400 You have to click on the 'OK'-button below the tables to save the new
4401 positions. If you want to place a new element, first add it to the
4402 table of elements and then you can drag the new element around.
4403 </p>
4405 By changing the paper size and the orientation you can change the size
4406 of the scratchboard as well. You can do so by just changing the
4407 dropdown field below, and the scratchboard will resize automatically,
4408 without interfering with the current placement of the elements.
4409 </p>
4411 If ever an element gets out of range you can either enlarge the paper
4412 size or click on the 'reset' button to place all elements below each
4413 other.
4414 </p>
4416 <h4 id="faq6_29">
4417 <a href="#faq6_29">6.29 Why can't I get a chart from my query result table?</a></h4>
4419 <p> Not every table can be put to the chart. Only tables with one, two or three columns can be visualised as a chart. Moreover the table must be in a special format for chart script to understand it. Currently supported formats can be found in the <a href="http://wiki.phpmyadmin.net/pma/Charts#Data_formats_for_query_results_chart">wiki</a>.</p>
4421 <h4 id="faq6_30">
4422 <a href="#faq6_30">6.30 Import: How can I import ESRI Shapefiles</a></h4>
4424 <p>
4425 An ESRI Shapefile is actually a set of several files, where .shp file contains
4426 geometry data and .dbf file contains data related to those geometry data.
4427 To read data from .dbf file you need to have PHP compiled with the dBase extension
4428 (--enable-dbase). Otherwise only geometry data will be imported.
4429 </p>
4431 <p>To upload these set of files you can use either of the following methods:</p>
4432 <ul>
4433 <li>
4435 Configure upload directory with
4436 <a href="#cfg_UploadDir" class="configrule">$cfg['UploadDir']</a>, upload both
4437 .shp and .dbf files with the same filename and chose the .shp file from the import page.
4438 </p>
4439 </li>
4440 <li>
4442 Create a Zip archive with .shp and .dbf files and import it. For this to work,
4443 you need to set <a href="#cfg_TempDir" class="configrule">$cfg['TempDir']</a> to a
4444 place where the web server user can write (for example <tt>'./tmp'</tt>).
4445 </p>
4447 <p> To create the temporary directory on a UNIX-based system, you can do:</p>
4448 <pre>
4449 cd phpMyAdmin
4450 mkdir tmp
4451 chmod o+rwx tmp
4452 </pre>
4453 </li>
4454 </ul>
4456 <h4 id="faq6_31">
4457 <a href="#faq6_31">6.31 How do I create a relation in designer?</a></h4>
4459 <p>To select relation, click:<br />
4460 <img src="themes/original/img/pmd/help_relation.png" width="100" height="100" alt="[relation icon]" /><br />
4461 The display column is shown in pink. To set/unset a column as the display column, click the "Choose column to display" icon, then click on the appropriate column name.</p>
4463 <h4 id="faq6_32">
4464 <a href="#faq6_32">6.32 How can I use the zoom search feature?</a></h4>
4466 <p> The Zoom search feature is an alternative to table search feature. It allows you to explore
4467 a table by representing its data in a scatter plot. You can locate this feature by selecting
4468 a table and clicking the 'Search' tab. One of the sub-tabs in the 'Table Search' page is
4469 'Zoom Search'. <br/><br/>
4471 Consider the table REL_persons in <a href="#faq6_6"><abbr title="Frequently Asked Questions">
4472 FAQ</abbr> 6.6</a> for an example. To use zoom search, two columns need to be selected,
4473 for example, id and town_code. The id values will be represented on one axis and town_code
4474 values on the other axis. Each row will be represented as a point in a scatter plot based
4475 on its id and town_code. You can include two additional search criteria apart from the two
4476 fields to display.<br/><br/>
4478 You can choose which field should be displayed as label for each point. If a display
4479 column has been set for the table (see <a href="#faqdisplay"><abbr title="Frequently Asked
4480 Questions">FAQ</abbr> 6.7</a>), it is taken as the label unless you specify otherwise.
4481 You can also select the maximum number of rows you want to be displayed in the plot by
4482 specifing it in the 'Max rows to plot' field. Once you have decided over your criteria,
4483 click 'Go' to display the plot.<br/><br/>
4485 After the plot is generated, you can use the mousewheel to zoom in and out of the plot.
4486 In addition, panning feature is enabled to navigate through the plot. You can zoom-in to
4487 a certail level of detail and use panning to locate your area of interest. Clicking on a
4488 point opens a dialogue box, displaying field values of the data row represented by the point.
4489 You can edit the values if required and click on submit to issue an update query. Basic
4490 instructions on how to use can be viewed by clicking the 'How to use?' link located just above
4491 the plot.</p>
4493 <h3 id="faqproject">phpMyAdmin project</h3>
4495 <h4 id="faq7_1">
4496 <a href="#faq7_1">7.1 I have found a bug. How do I inform developers?</a></h4>
4498 <p> Our Bug Tracker is located at
4499 <a href="http://sf.net/projects/phpmyadmin/">http://sf.net/projects/phpmyadmin/</a>
4500 under the Bugs section.<br /><br />
4502 But please first discuss your bug with other users:<br />
4503 <a href="https://sourceforge.net/projects/phpmyadmin/forums">
4504 https://sourceforge.net/projects/phpmyadmin/forums</a>.
4505 </p>
4507 <h4 id="faq7_2">
4508 <a href="#faq7_2">7.2 I want to translate the messages to a new language or upgrade an
4509 existing language, where do I start?</a></h4>
4511 <p> Translations are very welcome and all you need to have are the language skills.
4512 The easiest way is to use our <a href="https://l10n.cihar.com/projects/phpmyadmin/">online
4513 translation service</a>.
4514 You can check out all the possibilities to translate in the
4515 <a href="http://www.phpmyadmin.net/home_page/translate.php">translate section on our website</a>.
4516 </p>
4518 <h4 id="faq7_3">
4519 <a href="#faq7_3">7.3 I would like to help out with the development of
4520 phpMyAdmin. How should I proceed?</a></h4>
4522 <p>We welcome every contribution to the development of phpMyAdmin.
4523 You can check out all the possibilities to contribute in the
4524 <a href="http://www.phpmyadmin.net/home_page/improve.php">contribute section on our website</a>.
4525 </p>
4527 <h3 id="faqsecurity">Security</h3>
4529 <h4 id="faq8_1">
4530 <a href="#faq8_1">8.1 Where can I get information about the security alerts issued for phpMyAdmin?</a></h4>
4532 <p> Please refer to
4533 <a href="http://www.phpmyadmin.net/home_page/security.php">http://www.phpmyadmin.net/home_page/security.php</a>
4534 </p>
4536 <h4 id="faq8_2">
4537 <a href="#faq8_2">8.2 How can I protect phpMyAdmin against brute force attacks?</a></h4>
4539 <p> If you use Apache web server, phpMyAdmin exports information about
4540 authentication to the Apache environment and it can be used in Apache logs.
4541 Currently there are two variables available:
4542 </p>
4543 <dl>
4544 <dt><code>userID</code></dt>
4545 <dd>User name of currently active user (he does not have to be logged
4546 in).</dd>
4547 <dt><code>userStatus</code></dt>
4548 <dd>Status of currently active user, one of <code>ok</code> (user is
4549 logged in), <code>mysql-denied</code> (MySQL denied user login),
4550 <code>allow-denied</code> (user denied by allow/deny rules),
4551 <code>root-denied</code> (root is denied in configuration),
4552 <code>empty-denied</code> (empty password is denied).</dd>
4553 </dl>
4555 <code>LogFormat</code> directive for Apache can look like following:
4556 </p>
4557 <pre>
4558 LogFormat "%h %l %u %t \"%r\" %>s %b \
4559 \"%{Referer}i\" \"%{User-Agent}i\" %{userID}n %{userStatus}n" pma_combined
4560 </pre>
4562 You can then use any log analyzing tools to detect possible break-in
4563 attempts.
4564 </p>
4566 <h3 id="faqsynchronization">Synchronization</h3>
4567 <h4 id="faq9_1">
4568 <a href="#faq9_1">9.1 How can I synchronize two databases/tables in phpMyAdmin?</a></h4>
4570 <p> You can now synchronize databases/tables in phpMyAdmin using the Synchronize feature.
4571 It allows you to connect to local as well as remote servers. This requires you to enter
4572 server host name, username, password, port and the name of the database. Therefore you can
4573 now synchronize your databases placed on the same server or some remote server.
4574 </p>
4577 This feature is helpful for developers who need to replicate their
4578 database&#8217;s structure as well as data. Moreover, this feature not only
4579 helps replication but also facilitates the user to keep his/her database
4580 in sync with another database. Other than the full database, certain
4581 tables of the databases can also be synchronized.
4582 </p>
4585 You need to fill in the host name of the server, the username and
4586 password of an user account already there in MySQL. Port is by default
4587 populated with 3306 (MySQL default port). Then the name of the database
4588 should be mentioned at the end. All the information other than the port
4589 needs to be filled explicitly for the source as well as target servers.
4590 </p>
4593 After successfully passing through the authentication phase, the source and
4594 target database table names will be displayed. It will be a tabular
4595 representation.
4596 </p>
4599 On the left, are listed the source database table names. Some of the
4600 names have a <code>+</code> plus sign preceding them. This shows that these tables
4601 are only present in source database and they need to be added to the
4602 target database in order to synchronize the target database. The tables
4603 whose names are not preceded by a <code>+</code> sign are already present in the
4604 target database.
4605 </p>
4608 On the right, are listed the target database table names. There are few
4609 table names that have <code>(not present)</code> appended after their names. This
4610 means that these tables are to be created in target database in order to
4611 synchronize target database with source database. Some table names
4612 have a <code>-</code> minus sign preceding them. This shows that these tables are
4613 only present in target database and they will remain unchanged in the
4614 target database. The column in the middle shows the difference between
4615 the source and target corresponding tables.
4616 </p>
4619 The difference is depicted by the red and green buttons with <tt>S</tt> and <tt>D</tt>
4620 letters, indicating that either Structure or Data are not up to date. By
4621 clicking on them, they will turn grey, what means that they will be synchronized.
4622 </p>
4624 <h4 id="faq9_2">
4625 <a href="#faq9_2">9.2 Are there problems with data synchronizing large
4626 tables?</a></h4>
4629 Yes. This aspect of synchronization is currently limited to small tables, and they
4630 must have a primary key.
4631 </p>
4633 <!-- DEVELOPERS -->
4634 <h2 id="developers">Developers Information</h2>
4636 <p> phpMyAdmin is Open Source, so you're invited to contribute to it. Many
4637 great features have been written by other people and you too can help to
4638 make phpMyAdmin a useful tool.</p>
4640 <p>You can check out all the possibilities to contribute in the
4641 <a href="http://www.phpmyadmin.net/home_page/improve.php">contribute section on our website</a>.
4642 </p>
4644 <h2 id="copyright">Copyright</h2>
4646 <pre>
4647 Copyright (C) 1998-2000 Tobias Ratschiller &lt;tobias_at_ratschiller.com&gt;
4648 Copyright (C) 2001-2012 Marc Delisle &lt;marc_at_infomarc.info&gt;
4649 Olivier Müller &lt;om_at_omnis.ch&gt;
4650 Robin Johnson &lt;robbat2_at_users.sourceforge.net&gt;
4651 Alexander M. Turek &lt;me_at_derrabus.de&gt;
4652 Michal &#268;iha&#345; &lt;michal_at_cihar.com&gt;
4653 Garvin Hicking &lt;me_at_supergarv.de&gt;
4654 Michael Keck &lt;mkkeck_at_users.sourceforge.net&gt;
4655 Sebastian Mendel &lt;cybot_tm_at_users.sourceforge.net&gt;
4656 [check <a href="#credits">credits</a> for more details]
4657 </pre>
4660 This program is free software; you can redistribute it and/or modify
4661 it under the terms of the GNU General Public License version 2,
4662 as published by the Free Software Foundation.
4663 </p>
4666 This program is distributed in the hope that it will be useful,
4667 but WITHOUT ANY WARRANTY; without even the implied warranty of
4668 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4669 GNU General Public License for more details.
4670 </p>
4673 You should have received a copy of the GNU General Public License
4674 along with this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.
4675 </p>
4677 <!-- CREDITS -->
4678 <h2 id="credits">Credits</h2>
4680 <h3>Credits, in chronological order</h3>
4682 <ul>
4684 <li>Tobias Ratschiller &lt;tobias_at_ratschiller.com&gt;
4685 <ul>
4686 <li>creator of the phpmyadmin project</li>
4687 <li>maintainer from 1998 to summer 2000</li>
4688 </ul></li>
4690 <li>Marc Delisle &lt;marc_at_infomarc.info&gt;
4691 <ul>
4692 <li>multi-language version in December 1998</li>
4693 <li>various fixes and improvements</li>
4694 <li><abbr title="structured query language">SQL</abbr> analyser (most of it)</li>
4695 <li>current project maintainer</li>
4696 </ul></li>
4698 <li>Olivier M&uuml;ller &lt;om_at_omnis.ch&gt;
4699 <ul>
4700 <li>started SourceForge phpMyAdmin project in March 2001</li>
4701 <li>sync'ed different existing CVS trees with new features and bugfixes</li>
4702 <li>multi-language improvements, dynamic language selection</li>
4703 <li>many bugfixes and improvements</li>
4704 </ul></li>
4706 <li>Lo&iuml;c Chapeaux &lt;lolo_at_phpheaven.net&gt;
4707 <ul>
4708 <li>rewrote and optimized javascript, DHTML and DOM stuff</li>
4709 <li>rewrote the scripts so they fit the <abbr title="PHP Extension and Application Repository">PEAR</abbr> coding standards and
4710 generate XHTML1.0 and CSS2 compliant codes</li>
4711 <li>improved the language detection system</li>
4712 <li>many bugfixes and improvements</li>
4713 </ul></li>
4715 <li>Robin Johnson &lt;robbat2_at_users.sourceforge.net&gt;
4716 <ul>
4717 <li>database maintenance controls</li>
4718 <li>table type code</li>
4719 <li>Host authentication <abbr title="Internet Protocol">IP</abbr> Allow/Deny</li>
4720 <li>DB-based configuration (Not completed)</li>
4721 <li><abbr title="structured query language">SQL</abbr> parser and pretty-printer</li>
4722 <li><abbr title="structured query language">SQL</abbr> validator</li>
4723 <li>many bugfixes and improvements</li>
4724 </ul></li>
4726 <li>Armel Fauveau &lt;armel.fauveau_at_globalis-ms.com&gt;
4727 <ul>
4728 <li>bookmarks feature</li>
4729 <li>multiple dump feature</li>
4730 <li>gzip dump feature</li>
4731 <li>zip dump feature</li>
4732 </ul></li>
4734 <li>Geert Lund &lt;glund_at_silversoft.dk&gt;
4735 <ul>
4736 <li>various fixes</li>
4737 <li>moderator of the phpMyAdmin former users forum at phpwizard.net</li>
4738 </ul></li>
4740 <li>Korakot Chaovavanich &lt;korakot_at_iname.com&gt;
4741 <ul>
4742 <li>&quot;insert as new row&quot; feature</li>
4743 </ul></li>
4745 <li>Pete Kelly &lt;webmaster_at_trafficg.com&gt;
4746 <ul>
4747 <li>rewrote and fix dump code</li>
4748 <li>bugfixes</li>
4749 </ul></li>
4751 <li>Steve Alberty &lt;alberty_at_neptunlabs.de&gt;
4752 <ul>
4753 <li>rewrote dump code for PHP4</li>
4754 <li>mySQL table statistics</li>
4755 <li>bugfixes</li>
4756 </ul></li>
4758 <li>Benjamin Gandon &lt;gandon_at_isia.cma.fr&gt;
4759 <ul>
4760 <li>main author of the version 2.1.0.1</li>
4761 <li>bugfixes</li>
4762 </ul></li>
4764 <li>Alexander M. Turek &lt;me_at_derrabus.de&gt;
4765 <ul>
4766 <li>MySQL 4.0 / 4.1 / 5.0 compatibility</li>
4767 <li>abstract database interface (PMA_DBI) with MySQLi support</li>
4768 <li>privileges administration</li>
4769 <li><abbr title="Extensible Markup Language">XML</abbr> exports</li>
4770 <li>various features and fixes</li>
4771 <li>German language file updates</li>
4772 </ul></li>
4774 <li>Mike Beck &lt;mike.beck_at_web.de&gt;
4775 <ul>
4776 <li>automatic joins in QBE</li>
4777 <li>links column in printview</li>
4778 <li>Relation view</li>
4779 </ul></li>
4781 <li>Michal &#268;iha&#345; &lt;michal_at_cihar.com&gt;
4782 <ul>
4783 <li>enhanced index creation/display feature</li>
4784 <li>feature to use a different charset for HTML than for MySQL</li>
4785 <li>improvements of export feature</li>
4786 <li>various features and fixes</li>
4787 <li>Czech language file updates</li>
4788 </ul></li>
4790 <li>Christophe Gesch&eacute; from the &quot;MySQL Form Generator for PHPMyAdmin&quot;
4791 (http://sf.net/projects/phpmysqlformgen/)
4792 <ul>
4793 <li>suggested the patch for multiple table printviews</li>
4794 </ul></li>
4796 <li>Garvin Hicking &lt;me_at_supergarv.de&gt;
4797 <ul>
4798 <li>built the patch for vertical display of table rows</li>
4799 <li>built the Javascript based Query window + <abbr title="structured query language">SQL</abbr> history</li>
4800 <li>Improvement of column/db comments</li>
4801 <li>(MIME)-Transformations for columns</li>
4802 <li>Use custom alias names for Databases in left frame</li>
4803 <li>hierarchical/nested table display</li>
4804 <li><abbr title="Portable Document Format">PDF</abbr>-scratchboard for WYSIWYG-distribution of <abbr title="Portable Document Format">PDF</abbr> relations</li>
4805 <li>new icon sets</li>
4806 <li>vertical display of column properties page</li>
4807 <li>some bugfixes, features, support, German language additions</li>
4808 </ul></li>
4810 <li>Yukihiro Kawada &lt;kawada_at_den.fujifilm.co.jp&gt;
4811 <ul>
4812 <li>japanese kanji encoding conversion feature</li>
4813 </ul></li>
4815 <li>Piotr Roszatycki &lt;d3xter_at_users.sourceforge.net&gt; and Dan Wilson
4816 <ul>
4817 <li>the Cookie authentication mode</li>
4818 </ul></li>
4820 <li>Axel Sander &lt;n8falke_at_users.sourceforge.net&gt;
4821 <ul>
4822 <li>table relation-links feature</li>
4823 </ul></li>
4825 <li>Maxime Delorme &lt;delorme.maxime_at_free.fr&gt;
4826 <ul>
4827 <li><abbr title="Portable Document Format">PDF</abbr> schema output, thanks also to Olivier Plathey for the
4828 &quot;FPDF&quot; library (see <a href="http://www.fpdf.org/">http://www.fpdf.org/</a>) and Steven Wittens
4829 for the &quot;UFPDF&quot; library (see <a href="http://www.acko.net/node/56">http://www.acko.net/node/56</a>).</li>
4830 </ul></li>
4832 <li>Olof Edlund &lt;olof.edlund_at_upright.se&gt;
4833 <ul>
4834 <li><abbr title="structured query language">SQL</abbr> validator server</li>
4835 </ul></li>
4837 <li>Ivan R. Lanin &lt;ivanlanin_at_users.sourceforge.net&gt;
4838 <ul>
4839 <li>phpMyAdmin logo (until June 2004)</li>
4840 </ul></li>
4842 <li>Mike Cochrane &lt;mike_at_graftonhall.co.nz&gt;
4843 <ul>
4844 <li>blowfish library from the Horde project</li>
4845 </ul></li>
4847 <li>Marcel Tschopp &lt;ne0x_at_users.sourceforge.net&gt;
4848 <ul>
4849 <li>mysqli support</li>
4850 <li>many bugfixes and improvements</li>
4851 </ul></li>
4853 <li>Nicola Asuni (Tecnick.com)
4854 <ul>
4855 <li>TCPDF library (<a
4856 href="http://www.tcpdf.org">http://www.tcpdf.org</a>)</li>
4857 </ul></li>
4859 <li>Michael Keck &lt;mkkeck_at_users.sourceforge.net&gt;
4860 <ul>
4861 <li>redesign for 2.6.0</li>
4862 <li>phpMyAdmin sailboat logo (June 2004)</li>
4863 </ul></li>
4865 <li>Mathias Landh&auml;u&szlig;er
4866 <ul>
4867 <li>Representation at conferences</li>
4868 </ul></li>
4870 <li>Sebastian Mendel &lt;cybot_tm_at_users.sourceforge.net&gt;
4871 <ul>
4872 <li>interface improvements</li>
4873 <li>various bugfixes</li>
4874 </ul></li>
4876 <li>Ivan A Kirillov
4877 <ul>
4878 <li>new relations Designer</li>
4879 </ul></li>
4881 <li>Raj Kissu Rajandran (Google Summer of Code 2008)
4882 <ul>
4883 <li>BLOBstreaming support (withdrawn in release 4.0)</li>
4884 </ul></li>
4886 <li>Piotr Przybylski (Google Summer of Code 2008, 2010 and 2011)
4887 <ul>
4888 <li>improved setup script</li>
4889 <li>user preferences</li>
4890 <li>Drizzle support</li>
4891 </ul></li>
4893 <li>Derek Schaefer (Google Summer of Code 2009)
4894 <ul>
4895 <li>Improved the import system</li>
4896 </ul></li>
4898 <li>Alexander Rutkowski (Google Summer of Code 2009)
4899 <ul>
4900 <li>Tracking mechanism</li>
4901 </ul></li>
4903 <li>Zahra Naeem (Google Summer of Code 2009)
4904 <ul>
4905 <li>Synchronization feature</li>
4906 </ul></li>
4908 <li>Tom&#225;&#353; Srnka (Google Summer of Code 2009)
4909 <ul>
4910 <li>Replication support</li>
4911 </ul></li>
4913 <li>Muhammad Adnan (Google Summer of Code 2010)
4914 <ul>
4915 <li>Relation schema export to multiple formats</li>
4916 </ul></li>
4918 <li>Lori Lee (Google Summer of Code 2010)
4919 <ul>
4920 <li>User interface improvements</li>
4921 <li>ENUM/SET editor</li>
4922 <li>Simplified interface for export/import</li>
4923 </ul></li>
4925 <li>Ninad Pundalik (Google Summer of Code 2010)
4926 <ul>
4927 <li>AJAXifying the interface</li>
4928 </ul></li>
4930 <li>Martynas Mickevičius (Google Summer of Code 2010)
4931 <ul>
4932 <li>Charts</li>
4933 </ul></li>
4935 <li>Barrie Leslie
4936 <ul>
4937 <li>BLOBstreaming support with PBMS PHP extension (withdrawn in release 4.0)</li>
4938 </ul></li>
4940 <li>Ankit Gupta (Google Summer of Code 2010)
4941 <ul>
4942 <li>Visual query builder</li>
4943 </ul></li>
4945 <li>Rouslan Placella (Google Summer of Code 2011)
4946 <ul>
4947 <li>Improved support for Stored Routines, Triggers and Events</li>
4948 <li>Italian translation updates</li>
4949 </ul></li>
4951 </ul>
4954 And also to the following people who have contributed minor changes,
4955 enhancements, bugfixes or support for a new language since version 2.1.0:
4956 </p>
4959 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
4960 P&eacute;ter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
4961 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kl&auml;ger,
4962 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
4963 Bernard M. Piller, Laurent Haas, &quot;Sakamoto&quot;, Yuval Sarna,
4964 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
4965 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
4966 Lu&iacute;s V., Martijn W. van der Lee,
4967 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
4968 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, &quot;Manuzhai&quot;.
4969 </p>
4972 <h3>Original Credits of Version 2.1.0</h3>
4975 This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
4976 to create a web-based interface to MySQL using PHP3. Although I have not
4977 used any of his source-code, there are some concepts I've borrowed from
4978 him. phpMyAdmin was created because Peter told me he wasn't going to
4979 further develop his (great) tool.
4980 </p>
4982 Thanks go to
4983 </p>
4984 <ul>
4985 <li>Amalesh Kempf &lt;ak-lsml_at_living-source.com&gt; who contributed the
4986 code for the check when dropping a table or database. He also suggested
4987 that you should be able to specify the primary key on tbl_create.php3. To
4988 version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
4989 well as a bug-report. Plus many smaller improvements.
4990 </li>
4991 <li>Jan Legenhausen &lt;jan_at_nrw.net&gt;: He made many of the changes that
4992 were introduced in 1.3.0 (including quite significant ones like the
4993 authentication). For 1.4.1 he enhanced the table-dump feature. Plus
4994 bug-fixes and help.
4995 </li>
4996 <li>Marc Delisle &lt;DelislMa_at_CollegeSherbrooke.qc.ca&gt; made phpMyAdmin
4997 language-independent by outsourcing the strings to a separate file. He
4998 also contributed the French translation.
4999 </li>
5000 <li>Alexandr Bravo &lt;abravo_at_hq.admiral.ru&gt; who contributed
5001 tbl_select.php3, a feature to display only some columns from a table.
5002 </li>
5003 <li>Chris Jackson &lt;chrisj_at_ctel.net&gt; added support for MySQL
5004 functions in tbl_change.php3. He also added the
5005 &quot;Query by Example&quot; feature in 2.0.
5006 </li>
5007 <li>Dave Walton &lt;walton_at_nordicdms.com&gt; added support for multiple
5008 servers and is a regular contributor for bug-fixes.
5009 </li>
5010 <li>Gabriel Ash &lt;ga244_at_is8.nyu.edu&gt; contributed the random access
5011 features for 2.0.6.
5012 </li>
5013 </ul>
5015 The following people have contributed minor changes, enhancements, bugfixes
5016 or support for a new language:
5017 </p>
5019 Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
5020 Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
5021 Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
5022 G. Wieggers.
5023 </p>
5025 And thanks to everyone else who sent me email with suggestions, bug-reports
5026 and or just some feedback.
5027 </p>
5029 <h2 id="glossary">Glossary</h2>
5031 <p> From Wikipedia, the free encyclopedia</p>
5033 <ul>
5034 <li><a href="http://www.wikipedia.org/wiki/.htaccess">.htaccess</a>
5035 - the default name of Apache's directory-level configuration file.</li>
5036 <li><a href="http://www.wikipedia.org/wiki/Blowfish_%28cipher%29">Blowfish</a>
5037 - a keyed, symmetric block cipher, designed in 1993 by Bruce Schneier.</li>
5038 <li><a href="http://en.wikipedia.org/wiki/Web_browser">Browser (Web Browser)</a>
5039 - a software application that enables a user to display and interact with
5040 text, images, and other information typically located on a web page at a
5041 website on the World Wide Web.</li>
5042 <li><a href="http://www.wikipedia.org/wiki/Bzip2">bzip2</a>
5043 - a free software/open source data compression algorithm and program
5044 developed by Julian Seward.</li>
5045 <li><a href="http://www.wikipedia.org/wiki/CGI">CGI (Common Gateway Interface)</a>
5046 - an important World Wide Web technology that enables a client web browser
5047 to request data from a program executed on the Web server.</li>
5048 <li><a href="http://www.wikipedia.org/wiki/Changelog">Changelog</a>
5049 - a log or record of changes made to a project.</li>
5050 <li><a href="http://www.wikipedia.org/wiki/Client_%28computing%29">Client</a>
5051 - a computer system that accesses a (remote) service on another computer
5052 by some kind of network.</li>
5053 <li><a href="http://www.wikipedia.org/wiki/Column_%28database%29">column</a>
5054 - a set of data values of a particular simple type, one for each row of
5055 the table.</li>
5056 <li><a href="http://www.wikipedia.org/wiki/HTTP_cookie">Cookie</a>
5057 - a packet of information sent by a server to a World Wide Web browser
5058 and then sent back by the browser each time it accesses that server.</li>
5059 <li><a href="http://www.wikipedia.org/wiki/Comma-separated_values">CSV</a>
5060 - Comma-separated values</li>
5061 <li>DB - look at <a href="#database">Database</a>.</li>
5062 <li><a id="database" href="http://www.wikipedia.org/wiki/Database">database</a>
5063 - an organized collection of data.</li>
5064 <li>Engine - look at <a href="#glossar_storage_engine">Storage Engines</a>.</li>
5065 <li><a href="http://www.wikipedia.org/wiki/extension">extension</a>
5066 - a PHP module that extends PHP with additional functionality.</li>
5067 <li><a href="http://www.wikipedia.org/wiki/FAQ">FAQ (Frequently Asked Questions)</a>
5068 - a list of commonly asked question and there answers.</li>
5069 <li><a href="http://www.wikipedia.org/wiki/Field_%28computer_science%29">Field</a>
5070 - one part of divided data/columns.</li>
5071 <li><a href="http://www.wikipedia.org/wiki/Foreign_key">foreign key</a>
5072 - a column or group of columns in a database row that point to a key
5073 column or group of columns forming a key of another database row in some
5074 (usually different) table.</li>
5075 <li><a href="http://www.fpdf.org/">FPDF (FreePDF)</a>
5076 - the free PDF library</li>
5077 <li><a id="gd" href="http://www.wikipedia.org/wiki/GD_Graphics_Library">
5078 GD Graphics Library</a> - a library by Thomas Boutell and others for
5079 dynamically manipulating images.</li>
5080 <li>GD2 - look at <a href="#gd">GD Graphics Library</a>.</li>
5081 <li><a href="http://www.wikipedia.org/wiki/Gzip">gzip</a>
5082 - gzip is short for GNU zip, a GNU free software file compression
5083 program.</li>
5084 <li><a href="http://www.wikipedia.org/wiki/Host">host</a>
5085 - any machine connected to a computer network, a node that has a hostname.</li>
5086 <li><a href="http://www.wikipedia.org/wiki/Hostname">hostname</a>
5087 - the unique name by which a network attached device is known on a network.</li>
5088 <li><a href="http://www.wikipedia.org/wiki/HyperText_Transfer_Protocol">HTTP
5089 (HyperText Transfer Protocol)</a>
5090 - the primary method used to transfer or convey information on the World
5091 Wide Web.</li>
5092 <li><a href="http://www.wikipedia.org/wiki/Https:_URI_scheme">https</a>
5093 - a <abbr title="HyperText Transfer Protocol">HTTP</abbr>-connection with
5094 additional security measures.</li>
5095 <li><a href="http://www.wikipedia.org/wiki/Internet_Information_Services">IIS (Internet Information Services)</a>
5096 - a set of Internet-based services for servers using Microsoft Windows.</li>
5097 <li><a id="glossar_index" href="http://www.wikipedia.org/wiki/Index_%28database%29">Index</a>
5098 - a feature that allows quick access to the rows in a table.</li>
5099 <li><a href="http://www.wikipedia.org/wiki/Internet_Protocol">IP (Internet Protocol)</a>
5100 - a data-oriented protocol used by source and destination hosts for
5101 communicating data across a packet-switched internetwork.</li>
5102 <li><a href="http://www.wikipedia.org/wiki/IP_Address">IP Address</a>
5103 - a unique number that devices use in order to identify and communicate
5104 with each other on a network utilizing the Internet Protocol standard.</li>
5105 <li><a href="http://www.wikipedia.org/wiki/ISAPI">ISAPI
5106 (Internet Server Application Programming Interface)</a>
5107 - the API of Internet Information Services (IIS).</li>
5108 <li><a href="http://www.wikipedia.org/wiki/ISP">ISP (Internet service provider)</a>
5109 - a business or organization that offers users access to the Internet and related services.</li>
5110 <li><a id="jpeg" href="http://www.wikipedia.org/wiki/JPEG">JPEG</a>
5111 - a most commonly used standard method of lossy compression for
5112 photographic images.</li>
5113 <li>JPG - look at <a href="#jpeg">JPEG</a>.</li>
5114 <li>Key - look at <a href="#glossar_index">index</a>.</li>
5115 <li><a href="http://www.wikipedia.org/wiki/LaTeX">L<sup>A</sup>T<sub><big>E</big></sub>X</a>
5116 - a document preparation system for the T<sub>E</sub>X typesetting program.</li>
5117 <li><a href="http://www.wikipedia.org/wiki/Mac">Mac (Apple Macintosh)</a>
5118 - line of personal computers is designed, developed, manufactured, and
5119 marketed by Apple Computer.</li>
5120 <li><a id="glossar_mac_os_x" href="http://www.wikipedia.org/wiki/Mac_OS_X"><acronym title="Apple Macintosh">Mac</acronym> <abbr title="operating system">OS</abbr> X</a>
5121 - the operating system which is included with all currently shipping Apple
5122 Macintosh computers in the consumer and professional markets.</li>
5123 <li><a href="http://www.wikipedia.org/wiki/MCrypt">MCrypt</a>
5124 - a cryptographic library.</li>
5125 <li><a href="http://php.net/mcrypt">mcrypt</a>
5126 - the MCrypt PHP extension.</li>
5127 <li><a href="http://www.wikipedia.org/wiki/MIME">MIME (Multipurpose Internet Mail Extensions)</a>
5128 - an Internet Standard for the format of e-mail.</li>
5129 <li><a href="http://www.wikipedia.org/wiki/module">module</a>
5130 - some sort of extension for the Apache Webserver.</li>
5131 <li><a href="http://www.wikipedia.org/wiki/MySQL">MySQL</a>
5132 - a multithreaded, multi-user, SQL (Structured Query Language) Database
5133 Management System (DBMS).</li>
5134 <li><a href="http://php.net/mysqli">mysqli</a>
5135 - the improved MySQL client PHP extension.</li>
5136 <li><a href="http://php.net/mysql">mysql</a>
5137 - the MySQL client PHP extension.</li>
5138 <li><a href="http://www.wikipedia.org/wiki/OpenDocument">OpenDocument</a>
5139 - open standard for office documents.</li>
5140 <li><a href="http://www.wikipedia.org/wiki/OS_X"><abbr title="operating system">OS</abbr> X</a>
5141 - look at <a href="#glossar_mac_os_x"><acronym title="Apple Macintosh">Mac</acronym> <abbr title="operating system">OS</abbr> X</a>.</li>
5142 <li><a href="http://www.wikipedia.org/wiki/Portable_Document_Format">PDF
5143 (Portable Document Format)</a>
5144 - a file format developed by Adobe Systems for representing two
5145 dimensional documents in a device independent and resolution independent
5146 format.</li>
5147 <li><a href="http://pear.php.net/">PEAR</a>
5148 - the PHP Extension and Application Repository.</li>
5149 <li><a href="http://php.net/pcre">PCRE (Perl Compatible Regular Expressions)</a>
5150 - the perl-compatible regular expression functions for PHP</li>
5151 <li><a href="http://www.wikipedia.org/wiki/PHP">PHP</a>
5152 - short for "PHP: Hypertext Preprocessor", is an open-source, reflective
5153 programming language used mainly for developing server-side applications
5154 and dynamic web content, and more recently, a broader range of software
5155 applications.</li>
5156 <li><a href="http://www.wikipedia.org/wiki/Port_%28computing%29">port</a>
5157 - a connection through which data is sent and received.</li>
5158 <li><a href="http://www.wikipedia.org/wiki/Request_for_Comments">RFC</a>
5159 - Request for Comments (RFC) documents are a series of memoranda
5160 encompassing new research, innovations, and methodologies applicable to
5161 Internet technologies.</li>
5162 <li><a href="http://www.ietf.org/rfc/rfc1952.txt">RFC 1952</a>
5163 - GZIP file format specification version 4.3</li>
5164 <li><a href="http://www.wikipedia.org/wiki/Row_%28database%29">Row (record, tuple)</a>
5165 - represents a single, implicitly structured data item in a table.</li>
5166 <li><a href="http://www.wikipedia.org/wiki/Server_%28computing%29">Server</a>
5167 - a computer system that provides services to other computing
5168 systems over a network.</li>
5169 <li><a id="glossar_storage_engine" href="http://dev.mysql.com/doc/en/storage-engines.html">Storage Engines</a>
5170 - handlers for different table types</li>
5171 <li><a href="http://www.wikipedia.org/wiki/Socket#Computer_sockets">socket</a>
5172 - a form of inter-process communication.</li>
5173 <li><a href="http://www.wikipedia.org/wiki/Secure_Sockets_Layer">SSL (Secure
5174 Sockets Layer)</a>
5175 - a cryptographic protocol which provides secure communication on the Internet.</li>
5176 <li><a href="http://en.wikipedia.org/wiki/Stored_procedure">Stored procedure</a>
5177 - a subroutine available to applications accessing a relational database system</li>
5178 <li><a href="http://www.wikipedia.org/wiki/SQL">SQL</a>
5179 - Structured Query Language</li>
5180 <li><a href="http://www.wikipedia.org/wiki/Table_%28database%29">table</a>
5181 - a set of data elements (cells) that is organized, defined and stored as
5182 horizontal rows and vertical columns where each item can be uniquely
5183 identified by a label or key or by it?s position in relation to other items.</li>
5184 <li>Table type</li>
5185 <li><a href="http://www.wikipedia.org/wiki/Tar_%28file_format%29">tar</a>
5186 - a type of archive file format: the Tape ARchive format.</li>
5187 <li><a href="http://www.wikipedia.org/wiki/TCP">TCP (Transmission Control Protocol)</a>
5188 - one of the core protocols of the Internet protocol suite.</li>
5189 <li><a href="http://en.wikipedia.org/wiki/Database_trigger">trigger</a>
5190 - a procedural code that is automatically executed in response to
5191 certain events on a particular table or view in a database</li>
5192 <li><a href="http://www.acko.net/node/56">UFPDF</a>
5193 - Unicode/UTF-8 extension for FPDF</li>
5194 <li><a href="http://www.wikipedia.org/wiki/URL">URL (Uniform Resource Locator)</a>
5195 - a sequence of characters, conforming to a standardized format, that is
5196 used for referring to resources, such as documents and images on the
5197 Internet, by their location.</li>
5198 <li><a href="http://www.wikipedia.org/wiki/Webserver">Webserver</a>
5199 - A computer (program) that is responsible for accepting HTTP requests
5200 from clients and serving them Web pages.</li>
5201 <li><a href="http://www.wikipedia.org/wiki/XML">XML (Extensible Markup Language)</a>
5202 - a W3C-recommended general-purpose markup language for creating
5203 special-purpose markup languages, capable of describing many different
5204 kinds of data.</li>
5205 <li><a href="http://www.wikipedia.org/wiki/ZIP_%28file_format%29">ZIP</a>
5206 - a popular data compression and archival format.</li>
5207 <li><a href="http://www.wikipedia.org/wiki/Zlib">zlib</a>
5208 - an open-source, cross-platform data compression library by Jean-loup
5209 Gailly and Mark Adler.</li>
5210 </ul>
5211 </div>
5213 <ul id="footer">
5214 <li>Copyright &copy; 2003 - 2010 <a href="http://www.phpmyadmin.net/home_page/team.php">phpMyAdmin devel team</a></li>
5215 <li><a href="LICENSE">License</a></li>
5216 <li><a href="http://www.phpmyadmin.net/home_page/donate.php">Donate</a></li>
5217 <li class="last">Valid <a href="http://validator.w3.org/check/referer">HTML</a> and <a href="http://jigsaw.w3.org/css-validator/check/referer">CSS</a></li>
5218 </ul>
5220 </body>
5221 </html>