rfe #1821619 LeftFrameDBSeparator can be an array
[phpmyadmin/crack.git] / Documentation.html
blobf1bbed10c3828080169e89dfcf7703635e41f8c5
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US"
4 version="-//W3C//DTD XHTML 1.1//EN" dir="ltr">
5 <!-- $Id$ -->
6 <!--
7 vim: expandtab ts=4 sw=4 sts=4 tw=78
8 -->
10 <head>
11 <link rel="icon" href="./favicon.ico" type="image/x-icon" />
12 <link rel="shortcut icon" href="./favicon.ico" type="image/x-icon" />
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
14 <title>phpMyAdmin 3.2.0-dev - Documentation</title>
15 <link rel="stylesheet" type="text/css" href="docs.css" />
16 </head>
18 <body id="top">
19 <div id="header">
20 <h1>
21 <a href="http://www.phpmyadmin.net/">php<span class="myadmin">MyAdmin</span></a>
22 3.2.0-dev
23 Documentation
24 </h1>
25 </div>
27 <!-- TOP MENU -->
28 <ul class="header">
29 <li><a href="#top">Top</a></li>
30 <li><a href="#require">Requirements</a></li>
31 <li><a href="#intro">Introduction</a></li>
32 <li><a href="#setup">Installation</a></li>
33 <li><a href="#setup_script">Setup script</a></li>
34 <li><a href="#config">Configuration</a></li>
35 <li><a href="#transformations">Transformations</a></li>
36 <li><a href="#faq"><abbr title="Frequently Asked Questions">FAQ</abbr></a></li>
37 <li><a href="#developers">Developers</a></li>
38 <li><a href="#copyright">Copyright</a></li>
39 <li><a href="#credits">Credits</a></li>
40 <li><a href="translators.html">Translators</a></li>
41 <li><a href="#glossary">Glossary</a></li>
42 </ul>
44 <div id="body">
46 <ul><li><a href="http://www.phpmyadmin.net/">
47 phpMyAdmin homepage</a></li>
48 <li><a href="https://sf.net/projects/phpmyadmin/">
49 SourceForge phpMyAdmin project page</a></li>
50 <li><a href="http://wiki.cihar.com">
51 Official phpMyAdmin wiki</a></li>
52 <li>Local documents:
53 <ul><li>Version history: <a href="changelog.php">ChangeLog</a></li>
54 <li>License: <a href="license.php">LICENSE</a></li>
55 </ul>
56 </li>
57 <li>Documentation version:
58 <i>$Id$</i>
59 </li>
60 </ul>
62 <!-- REQUIREMENTS -->
63 <h2 id="require">Requirements</h2>
65 <ul><li><b>PHP</b>
66 <ul><li>You need PHP 5.2.0 or newer, with <tt>session</tt> support
67 (<a href="#faq1_31">see
68 <abbr title="Frequently Asked Questions">FAQ</abbr> 1.31</a>)
69 and the Standard PHP Library (SPL) extension.
70 </li>
71 <li>To support uploading of ZIP files, you need the PHP <tt>zip</tt> extension.</li>
72 <li>For proper support of multibyte strings (eg. UTF-8, which is
73 currently default), you should install mbstring and ctype
74 extensions.
75 </li>
76 <li>You need GD2 support in PHP to display inline
77 thumbnails of JPEGs (&quot;image/jpeg: inline&quot;) with their
78 original aspect ratio</li>
79 <li>When using the &quot;cookie&quot;
80 <a href="#authentication_modes">authentication method</a>, the
81 <a href="http://www.php.net/mcrypt"><tt>mcrypt</tt></a> extension
82 is strongly suggested for most users and is <b>required</b> for
83 64&#8211;bit machines. Not using mcrypt will cause phpMyAdmin to
84 load pages significantly slower.
85 </li>
86 </ul>
87 </li>
88 <li><b>MySQL</b> 5.0 or newer (<a href="#faq1_17">details</a>);</li>
89 <li><b>Web browser</b> with cookies enabled.</li>
90 </ul>
92 <!-- INTRODUCTION -->
93 <h2 id="intro">Introduction</h2>
95 <p> phpMyAdmin can manage a whole MySQL server (needs a super-user) as well as
96 a single database. To accomplish the latter you'll need a properly set up
97 MySQL user who can read/write only the desired database. It's up to you to
98 look up the appropriate part in the MySQL manual.
99 </p>
101 <h3>Currently phpMyAdmin can:</h3>
103 <ul><li>browse and drop databases, tables, views, fields and indexes</li>
104 <li>create, copy, drop, rename and alter databases, tables, fields and
105 indexes</li>
106 <li>maintenance server, databases and tables, with proposals on server
107 configuration</li>
108 <li>execute, edit and bookmark any
109 <abbr title="structured query language">SQL</abbr>-statement, even
110 batch-queries</li>
111 <li>load text files into tables</li>
112 <li>create<a href="#footnote_1"><sup>1</sup></a> and read dumps of tables
113 </li>
114 <li>export<a href="#footnote_1"><sup>1</sup></a> data to various formats:
115 <abbr title="comma separated values">CSV</abbr>,
116 <abbr title="Extensible Markup Language">XML</abbr>,
117 <abbr title="Portable Document Format">PDF</abbr>,
118 <abbr title="International Standards Organisation">ISO</abbr>/<abbr
119 title="International Electrotechnical Commission">IEC</abbr> 26300 -
120 OpenDocument Text and Spreadsheet,
121 <abbr title="Microsoft Word 2000">Word</abbr>,
122 <abbr title="Microsoft Excel 2000">Excel</abbr> and L<sup>A</sup>T<sub><big>E</big></sub>X formats
123 </li>
124 <li>administer multiple servers</li>
125 <li>manage MySQL users and privileges</li>
126 <li>check referential integrity in MyISAM tables</li>
127 <li>using Query-by-example (QBE), create complex queries automatically
128 connecting required tables</li>
129 <li>create <abbr title="Portable Document Format">PDF</abbr> graphics of
130 your Database layout</li>
131 <li>search globally in a database or a subset of it</li>
132 <li>transform stored data into any format using a set of predefined
133 functions, like displaying BLOB-data as image or download-link
134 </li>
135 <li>support InnoDB tables and foreign keys <a href="#faq3_6">(see
136 <abbr title="Frequently Asked Questions">FAQ</abbr> 3.6)</a></li>
137 <li>support mysqli, the improved MySQL extension <a href="#faq1_17">
138 (see <abbr title="Frequently Asked Questions">FAQ</abbr> 1.17)</a></li>
139 <li>communicate in <a href="./translators.html">55 different languages</a>
140 </li>
141 </ul>
143 <h4>A word about users:</h4>
144 <p> Many people have difficulty
145 understanding the concept of user management with regards to phpMyAdmin. When
146 a user logs in to phpMyAdmin, that username and password are passed directly
147 to MySQL. phpMyAdmin does no account management on its own (other than
148 allowing one to manipulate the MySQL user account information); all users
149 must be valid MySQL users.</p>
151 <p class="footnote" id="footnote_1">
152 <sup>1)</sup> phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats)
153 dumps and <abbr title="comma separated values">CSV</abbr> exports if you use
154 PHP with Zlib support (<tt>--with-zlib</tt>) and/or Bzip2 support
155 (<tt>--with-bz2</tt>). Proper support may also need changes in
156 <tt>php.ini</tt>.</p>
158 <!-- INSTALLATION -->
159 <h2 id="setup">Installation</h2>
161 <ol><li><a href="#quick_install">Quick Install</a></li>
162 <li><a href="#setup_script">Setup script usage</a></li>
163 <li><a href="#linked-tables">Linked-tables infrastructure</a></li>
164 <li><a href="#upgrading">Upgrading from an older version</a></li>
165 <li><a href="#authentication_modes">Using authentication modes</a></li>
166 </ol>
168 <p class="important">
169 phpMyAdmin does not apply any special security methods to the MySQL database
170 server. It is still the system administrator's job to grant permissions on
171 the MySQL databases properly. phpMyAdmin's &quot;Privileges&quot; page can
172 be used for this.
173 </p>
175 <p class="important">
176 Warning for <acronym title="Apple Macintosh">Mac</acronym> users:<br />
177 if you are on a <acronym title="Apple Macintosh">Mac</acronym>
178 <abbr title="operating system">OS</abbr> version before
179 <abbr title="operating system">OS</abbr> X, StuffIt unstuffs with
180 <acronym title="Apple Macintosh">Mac</acronym> formats.<br />
181 So you'll have to resave as in BBEdit to Unix style ALL phpMyAdmin scripts
182 before uploading them to your server, as PHP seems not to like
183 <acronym title="Apple Macintosh">Mac</acronym>-style end of lines character
184 (&quot;<tt>\r</tt>&quot;).</p>
186 <h3 id="quick_install">Quick Install</h3>
187 <ol><li>Choose an appropriate distribution kit from the phpmyadmin.net
188 Downloads page. Some kits contain only the English messages,
189 others contain all languages in UTF-8 format (this should be fine
190 in most situations), others contain all
191 languages and all character sets. We'll assume you chose a kit whose
192 name looks like <tt>phpMyAdmin-x.x.x-all-languages.tar.gz</tt>.
193 </li>
194 <li>Untar or unzip the distribution (be sure to unzip the subdirectories):
195 <tt>tar -xzvf phpMyAdmin_x.x.x-all-languages.tar.gz</tt> in your webserver's
196 document root. If you don't have direct access to your document root,
197 put the files in a directory on your local machine, and, after step 4,
198 transfer the directory on your web server using, for example, ftp.</li>
199 <li>Ensure that all the scripts have the appropriate owner (if PHP is
200 running in safe mode, having some scripts with an owner different
201 from the owner of other scripts will be a
202 problem). See <a href="#faq4_2">
203 <abbr title="Frequently Asked Questions">FAQ</abbr> 4.2</a> and
204 <a href="#faq1_26"><abbr title="Frequently Asked Questions">FAQ</abbr>
205 1.26</a> for suggestions.</li>
206 <li>Now you must configure your installation. There are two methods that
207 can be used. Traditionally, users have hand-edited a copy of
208 <tt>config.inc.php</tt>, but now a wizard-style setup script is
209 provided for those who prefer a graphical installation. Creating a
210 <tt>config.inc.php</tt> is still a quick way to get started and needed for some advanced features.
211 <ul><li>To manually create the file, simply use your text editor to
212 create the file <tt>config.inc.php</tt> (you can copy
213 <tt>config.sample.inc.php</tt> to get minimal configuration
214 file) in the main (top-level) phpMyAdmin directory (the one
215 that contains <tt>index.php</tt>). phpMyAdmin first loads
216 <tt>libraries/config.default.php</tt> and then overrides those
217 values with anything found in <tt>config.inc.php</tt>. If the
218 default value is okay for a particular setting, there is no
219 need to include it in <tt>config.inc.php</tt>. You'll need a
220 few directives to get going, a simple configuration may look
221 like this:
222 <pre>
223 &lt;?php
224 $cfg['blowfish_secret'] = 'ba17c1ec07d65003'; // use here a value of your choice
226 $i=0;
227 $i++;
228 $cfg['Servers'][$i]['auth_type'] = 'cookie';
229 ?&gt;
230 </pre>
231 Or, if you prefer to not be prompted every time you log in:
232 <pre>
233 &lt;?php
235 $i=0;
236 $i++;
237 $cfg['Servers'][$i]['user'] = 'root';
238 $cfg['Servers'][$i]['password'] = 'cbb74bc'; // use here your password
239 ?&gt;
240 </pre>
241 For a full explanation of possible configuration values, see the
242 <a href="#config">Configuration Section</a> of this document.</li>
243 <li id="setup_script">Instead of manually editing
244 <tt>config.inc.php</tt>, you can use the
245 <a href="setup/">Setup Script</a>. First you must
246 manually create a folder <tt>config</tt> in the phpMyAdmin
247 directory. This is a security measure. On a Linux/Unix system you
248 can use the following commands:
249 <pre>
250 cd phpMyAdmin
251 mkdir config # create directory for saving
252 chmod o+rw config # give it world writable permissions
253 </pre>
254 And to edit an existing configuration, copy it over first:
255 <pre>
256 cp config.inc.php config/ # copy current configuration for editing
257 chmod o+w config/config.inc.php # give it world writable permissions
258 </pre>
259 On other platforms, simply create the folder and ensure that your
260 web server has read and write access to it. <a href="#faq1_26">FAQ
261 1.26</a> can help with this.<br /><br />
263 Next, open <tt><a href="setup/">setup/</a>
264 </tt>in your browser. Note that <strong>changes are not saved to
265 disk until explicitly choose <tt>Save</tt></strong> from the
266 <i>Configuration</i> area of the screen. Normally the script saves
267 the new config.inc.php to the <tt>config/</tt> directory, but if
268 the webserver does not have the proper permissions you may see the
269 error "Cannot load or save configuration." Ensure that the <tt>
270 config/</tt> directory exists and has the proper permissions -
271 or use the <tt>Download</tt> link to save the config file locally
272 and upload (via FTP or some similar means) to the proper location.<br /><br />
274 Once the file has been saved, it must be moved out of the <tt>
275 config/</tt> directory and the permissions must be reset, again
276 as a security measure:
277 <pre>
278 mv config/config.inc.php . # move file to current directory
279 chmod o-rw config.inc.php # remove world read and write permissions
280 </pre>
281 Now the file is ready to be used. You can choose to review or edit
282 the file with your favorite editor, if you prefer to set some
283 advanced options which the setup script does not provide.</li></ul></li>
284 <li>If you are using the
285 <tt>auth_type</tt> &quot;config&quot;, it is suggested that you
286 protect the phpMyAdmin installation directory because using
287 config does not require a user to
288 enter a password to access the phpMyAdmin installation. Use of an alternate
289 authentication method is recommended, for example with
290 HTTP&#8211;AUTH in a <a href="#glossary"><i>.htaccess</i></a> file or switch to using
291 <tt>auth_type</tt> cookie or http. See the
292 <a href="#faqmultiuser"> multi&#8211;user sub&#8211;section</a> of this
293 <abbr title="Frequently Asked Questions">FAQ</abbr> for additional
294 information, especially <a href="#faq4_4">
295 <abbr title="Frequently Asked Questions">FAQ</abbr> 4.4</a>.</li>
296 <li>Open the <a href="index.php">main phpMyAdmin directory</a>
297 in your browser. phpMyAdmin should now display a welcome screen
298 and your databases, or a login dialog if using
299 <abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie
300 authentication mode.</li>
301 <li>You should deny access to the <tt>./libraries</tt> and
302 <tt>./setup/lib</tt> subfolders in your webserver configuration. For
303 Apache you can use supplied .htaccess file in that folder, for other
304 webservers, you should configure this yourself. Such configuration
305 prevents from possible path exposure and cross side scripting
306 vulnerabilities that might happen to be found in that code.</li>
307 <li>
308 It is generally good idea to protect public phpMyAdmin installation
309 against access by robots as they usually can not do anything good
310 there. You can do this using <code>robots.txt</code> file in root of
311 your webserver or limit access by web server configuration. You can
312 find example <code>.htaccess</code> file which can help you achieve
313 this in <code>contrib</code> directory in phpMyAdmin.
314 </li>
315 </ol>
317 <h3 id="linked-tables">Linked-tables infrastructure</h3>
319 <p> For a whole set of new features (bookmarks, comments,
320 <abbr title="structured query language">SQL</abbr>-history,
321 <abbr title="Portable Document Format">PDF</abbr>-generation, field contents
322 transformation, etc.) you need to create a set of special tables. Those
323 tables can be located in your own database, or in a central database for a
324 multi-user installation (this database would then be accessed by the
325 controluser, so no other user should have rights to it).</p>
327 <p> Please look at your <tt>./scripts/</tt> directory, where you should find a
328 file called <i>create_tables.sql</i>. (If you are using a Windows server, pay
329 special attention to <a href="#faq1_23">
330 <abbr title="Frequently Asked Questions">FAQ</abbr> 1.23</a>).</p>
332 <p> If you already had this infrastructure and upgraded to MySQL 4.1.2
333 or newer, please use <i>./scripts/upgrade_tables_mysql_4_1_2+.sql</i>.</p>
335 <p> You can use your phpMyAdmin to create the tables for you. Please be aware
336 that you may need special (administrator) privileges to create the database
337 and tables, and that the script may need some tuning, depending on the
338 database name.</p>
340 <p> After having imported the <i>./scripts/create_tables.sql</i> file, you
341 should specify the table names in your <i>./config.inc.php</i> file. The
342 directives used for that can be found in the <a href="#config">Configuration
343 section</a>. You will also need to have a controluser with the proper rights
344 to those tables (see section <a href="#authentication_modes">Using
345 authentication modes</a> below).</p>
347 <h3 id="upgrading">Upgrading from an older version</h3>
349 <p> Simply copy <i>./config.inc.php</i> from your previous installation into the newly
350 unpacked one. Configuration files from very old versions (2.3.0 or before) may
351 require some tweaking as some options have been changed or removed.
352 For compatibility with PHP 6, remove a <tt>set_magic_quotes_runtime(0);</tt>
353 statement that you might find near the end of your configuration file.</p>
355 <p> You should <strong>not</strong> copy <tt>libraries/config.default.php</tt>
356 over <tt>config.inc.php</tt> because the default configuration file
357 is version-specific.</p>
359 <p> If you have upgraded your MySQL server from a version previous to 4.1.2 to
360 version 4.1.2 or newer and if you use the pmadb/linked table infrastructure,
361 you should run the SQL script found in
362 <tt>scripts/upgrade_tables_mysql_4_1_2+.sql</tt>.</p>
364 <h3 id="authentication_modes">Using authentication modes</h3>
366 <ul><li><abbr title="HyperText Transfer Protocol">HTTP</abbr> and cookie
367 authentication modes are recommended in a <b>multi-user environment</b>
368 where you want to give users access to their own database and don't want
369 them to play around with others.<br />
370 Nevertheless be aware that MS Internet Explorer seems to be really buggy
371 about cookies, at least till version 6, and PHP 4.1.1 is also a bit buggy
372 in this area!<br />
373 Even in a <b>single-user environment</b>, you might prefer to use
374 <abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie mode so
375 that your user/password pair are not in clear in the configuration file.
376 </li>
378 <li><abbr title="HyperText Transfer Protocol">HTTP</abbr> and cookie
379 authentication modes are more secure: the MySQL login information does
380 not need to be set in the phpMyAdmin configuration file (except possibly
381 for the <a href="#controluser">controluser</a>).<br />
382 However, keep in mind that the password travels in plain text, unless
383 you are using the HTTPS protocol.<br />
384 In cookie mode, the password is stored, encrypted with the blowfish
385 algorithm, in a temporary cookie.</li>
387 <li>Note: starting with phpMyAdmin 2.6.1, this section is only applicable if
388 your MySQL server is running with <tt>--skip-show-database</tt>.<br /><br />
390 For '<abbr title="HyperText Transfer Protocol">HTTP</abbr>' and 'cookie'
391 modes, phpMyAdmin needs a controluser that has <b>only</b> the
392 <tt>SELECT</tt> privilege on the <i>`mysql`.`user` (all columns except
393 `Password`)</i>, <i>`mysql`.`db` (all columns)</i>, <i>`mysql`.`host`
394 (all columns)</i> and <i>`mysql`.`tables_priv` (all columns except
395 `Grantor` and `Timestamp`)</i> tables.<br /> You must specify the details
396 for the <a href="#controluser">controluser</a> in the <tt>config.inc.php</tt>
397 file under the
398 <tt><a href="#cfg_Servers_controluser" class="configrule">
399 $cfg['Servers'][$i]['controluser']</a></tt> and
400 <tt><a href="#cfg_Servers_controlpass" class="configrule">
401 $cfg['Servers'][$i]['controlpass']</a></tt> settings.<br />
402 The following example assumes you want to use <tt>pma</tt> as the
403 controluser and <tt>pmapass</tt> as the controlpass, but <b>this is
404 only an example: use something else in your file!</b> Input these
405 statements from the phpMyAdmin SQL Query window or mysql command&#8211;line
406 client.<br />
407 Of course you have to replace <tt>localhost</tt> with the webserver's host
408 if it's not the same as the MySQL server's one.
410 <pre>
411 GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY 'pmapass';
412 GRANT SELECT (
413 Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
414 Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
415 File_priv, Grant_priv, References_priv, Index_priv, Alter_priv,
416 Show_db_priv, Super_priv, Create_tmp_table_priv, Lock_tables_priv,
417 Execute_priv, Repl_slave_priv, Repl_client_priv
418 ) ON mysql.user TO 'pma'@'localhost';
419 GRANT SELECT ON mysql.db TO 'pma'@'localhost';
420 GRANT SELECT ON mysql.host TO 'pma'@'localhost';
421 GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv)
422 ON mysql.tables_priv TO 'pma'@'localhost';</pre>
424 If you want to use the many new relation and bookmark features:
426 <pre>
427 GRANT SELECT, INSERT, UPDATE, DELETE ON &lt;pma_db&gt;.* TO 'pma'@'localhost';
428 </pre>
430 (this of course requires that your <a href="#linked-tables">linked-tables
431 infrastructure</a> be set up).<br /></li>
433 <li>Then each of the <i>true</i> users should be granted a set of privileges
434 on a set of particular databases. Normally you shouldn't give global
435 privileges to an ordinary user, unless you understand the impact of those
436 privileges (for example, you are creating a superuser).<br />
437 For example, to grant the user <i>real_user</i> with all privileges on
438 the database <i>user_base</i>:<br />
440 <pre>
441 GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost IDENTIFIED BY 'real_password';
442 </pre>
444 What the user may now do is controlled entirely by the MySQL user
445 management system.<br />
446 With <abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie
447 authentication mode, you don't need to fill the user/password fields
448 inside the <a href="#cfg_Servers" class="configrule">$cfg['Servers']</a>
449 array.</li>
450 </ul>
452 <h4>'<abbr title="HyperText Transfer Protocol">HTTP</abbr>' authentication mode</h4>
454 <ul><li>Uses <abbr title="HyperText Transfer Protocol">HTTP</abbr> Basic authentication
455 method and allows you to log in as any valid MySQL user.</li>
456 <li>Is supported with most PHP configurations. For
457 <abbr title="Internet Information Services">IIS</abbr>
458 (<abbr title="Internet Server Application Programming Interface">ISAPI</abbr>)
459 support using <abbr title="Common Gateway Interface">CGI</abbr> PHP see
460 <a href="#faq1_32"><abbr title="Frequently Asked Questions">FAQ</abbr>
461 1.32</a>, for using with Apache
462 <abbr title="Common Gateway Interface">CGI</abbr> see
463 <a href="#faq1_35"><abbr title="Frequently Asked Questions">FAQ</abbr>
464 1.35</a>.</li>
465 <li>See also <a href="#faq4_4">
466 <abbr title="Frequently Asked Questions">FAQ</abbr> 4.4</a> about not
467 using the <i>.htaccess</i> mechanism along with
468 '<abbr title="HyperText Transfer Protocol">HTTP</abbr>' authentication
469 mode.</li>
470 </ul>
472 <h4>'cookie' authentication mode</h4>
474 <ul><li>You can use this method as a replacement for the
475 <abbr title="HyperText Transfer Protocol">HTTP</abbr> authentication
476 (for example, if you're running
477 <abbr title="Internet Information Services">IIS</abbr>).</li>
478 <li>Obviously, the user must enable cookies in the browser, but this is
479 now a requirement for all authentication modes.</li>
480 <li>With this mode, the user can truly log out of phpMyAdmin and log in back
481 with the same username.</li>
482 <li>If you want to log in to arbitrary server see
483 <a href="#AllowArbitraryServer" class="configrule">
484 $cfg['AllowArbitraryServer']</a> directive.</li>
485 <li>As mentioned in the <a href="#require">requirements</a> section, having
486 the <tt>mcrypt</tt> extension will speed up access considerably, but is
487 not required.</li>
488 </ul>
490 <h4>'signon' authentication mode</h4>
492 <ul><li>This mode is a convenient way of using credentials from another
493 application to authenticate to phpMyAdmin.</li>
494 <li>The other application has to store login information into
495 session data.</li>
496 <li>More details in the <a href="#cfg_Servers_auth_type">auth_type</a>
497 section.</li>
498 </ul>
499 <h4>'config' authentication mode</h4>
501 <ul><li>This mode is the less secure one because it requires you to fill the
502 <a href="#servers_user" class="configrule">
503 $cfg['Servers'][$i]['user']</a> and
504 <a href="#servers_user" class="configrule">
505 $cfg['Servers'][$i]['password']</a> fields (and as a result, anyone who
506 can read your config.inc.php can discover your username and password).
507 <br />
508 But you don't need to setup a &quot;controluser&quot; here: using the
509 <a href="#servers_only_db" class="configrule">
510 $cfg['Servers'][$i]['only_db']</a> might be enough.</li>
511 <li>In the <a href="#faqmultiuser">
512 <abbr title="Internet service provider">ISP</abbr>
513 <abbr title="Frequently Asked Questions">FAQ</abbr></a> section, there
514 is an entry explaining how to protect your configuration file.</li>
515 <li>For additional security in this mode, you may wish to consider the Host
516 authentication
517 <a href="#servers_allowdeny_order" class="configrule">
518 $cfg['Servers'][$i]['AllowDeny']['order']</a> and
519 <a href="#servers_allowdeny_rules" class="configrule">
520 $cfg['Servers'][$i]['AllowDeny']['rules']</a> configuration
521 directives.</li>
522 <li>Unlike cookie and http, does not require a user to log in when first
523 loading the phpMyAdmin site. This is by design but could allow any
524 user to access your installation. Use of some restriction method is
525 suggested, perhaps a <a href="#glossary">.htaccess</a> file with the
526 HTTP-AUTH directive or disallowing incoming HTTP requests at
527 one&#8217;s router or firewall will suffice (both of which
528 are beyond the scope of this manual but easily searchable with Google).</li>
529 </ul>
530 <h4 id="swekey">Swekey authentication</h4>
532 The Swekey is a low cost authentication USB key that can be used in
533 web applications.<br /><br />
534 When Swekey authentication is activated, phpMyAdmin requires the
535 users's Swekey to be plugged before entering the login page (currently
536 supported for cookie authentication mode only). Swekey Authentication is
537 disabled by default.<br /><br />
538 To enable it, add the following line to <tt>config.inc.php</tt>:
539 </p>
540 <pre>
541 $cfg['Servers'][$i]['auth_swekey_config'] = '/etc/swekey.conf';
542 </pre>
544 You then have to create the <tt>swekey.conf</tt> file that will associate
545 each user with their Swekey Id. It is important to place this file outside
546 of your web server's document root (in the example, it is located in <tt>/etc</tt>). A self documented sample file is provided
547 in the <tt>contrib</tt> directory. Feel free to use it with your own
548 users' information.<br /><br />
549 If you want to purchase a Swekey please visit
550 <a href="http://phpmyadmin.net/auth_key">http://phpmyadmin.net/auth_key</a>
551 since this link provides funding for phpMyAdmin.
552 </p>
553 <!-- CONFIGURATION -->
554 <h2 id="config">Configuration</h2>
556 <p> <span class="important">Warning for <acronym title="Apple Macintosh">Mac</acronym>
557 users:</span> PHP does not seem to like
558 <acronym title="Apple Macintosh">Mac</acronym> end of lines character
559 (&quot;<tt>\r</tt>&quot;). So ensure you choose the option that allows to use
560 the *nix end of line character (&quot;<tt>\n</tt>&quot;) in your text editor
561 before saving a script you have modified.</p>
563 <p> <span class="important">Configuration note:</span>
564 Almost all configurable data is placed in <tt>config.inc.php</tt>. If this file
565 does not exist, please refer to the <a href="#setup">Quick install</a>
566 section to create one. This file only needs to contain the parameters you want to
567 change from their corresponding default value in
568 <tt>libraries/config.default.php</tt>.</p>
570 <p> The parameters which relate to design (like colors) are placed in
571 <tt>themes/themename/layout.inc.php</tt>. You might also want to create
572 <i>config.footer.inc.php</i> and <i>config.header.inc.php</i> files to add
573 your site specific code to be included on start and end of each page.</p>
575 <dl><dt id="cfg_PmaAbsoluteUri">$cfg['PmaAbsoluteUri'] string</dt>
576 <dd>Sets here the complete <abbr title="Uniform Resource Locator">URL</abbr>
577 (with full path) to your phpMyAdmin installation's directory.
578 E.g. <tt>http://www.your_web.net/path_to_your_phpMyAdmin_directory/</tt>.
579 Note also that the <abbr title="Uniform Resource Locator">URL</abbr> on
580 some web servers are case&#8211;sensitive.
581 Don&#8217;t forget the trailing slash at the end.<br /><br />
583 Starting with version 2.3.0, it is advisable to try leaving this
584 blank. In most cases phpMyAdmin automatically detects the proper
585 setting. Users of port forwarding will need to set PmaAbsoluteUri (<a
586 href="https://sf.net/tracker/index.php?func=detail&amp;aid=1340187&amp;group_id=23067&amp;atid=377409">more info</a>).
587 A good test is to browse a table, edit a row and save it. There should
588 be an error message if phpMyAdmin is having trouble auto&#8211;detecting
589 the correct value. If you get an error that this must be set or if
590 the autodetect code fails to detect your path, please post a bug
591 report on our bug tracker so we can improve the code.</dd>
593 <dt id="cfg_PmaNoRelation_DisableWarning">$cfg['PmaNoRelation_DisableWarning'] boolean</dt>
594 <dd>Starting with version 2.3.0 phpMyAdmin offers a lot of features to work
595 with master / foreign &#8211; tables (see
596 <a href="#pmadb" class="configrule">$cfg['Servers'][$i]['pmadb']</a>).
597 <br />
598 If you tried to set this up and it does not work for you, have a look on
599 the &quot;Structure&quot; page of one database where you would like to
600 use it. You will find a link that will analyze why those features have
601 been disabled.<br />
602 If you do not want to use those features set this variable to
603 <tt>TRUE</tt> to stop this message from appearing.</dd>
605 <dt id="cfg_SuhosinDisableWarning">$cfg['SuhosinDisableWarning'] boolean</dt>
606 <dd>A warning is displayed on the main page if Suhosin is detected.
607 You can set this parameter to <tt>TRUE</tt> to stop this message
608 from appearing.</dd>
610 <dt id="cfg_AllowThirdPartyFraming">$cfg['AllowThirdPartyFraming'] boolean</dt>
611 <dd>Setting this to <tt>true</tt> allows a page located on a different
612 domain to call phpMyAdmin inside a frame, and is a potential security
613 hole allowing cross-frame scripting attacks.</dd>
615 <dt id="cfg_blowfish_secret">$cfg['blowfish_secret'] string</dt>
616 <dd>The &quot;cookie&quot; auth_type uses blowfish
617 algorithm to encrypt the password.<br />
618 If you are using the &quot;cookie&quot; auth_type, enter here a random
619 passphrase of your choice. It will be used internally by the blowfish
620 algorithm: you won&#8217;t be prompted for this passphrase. The maximum
621 number of characters for this parameter seems to be 46.<br /><br />
623 Since version 3.1.0 phpMyAdmin can generate this on the fly, but it
624 makes a bit weaker security as this generated secret is stored in
625 session and furthermore it makes impossible to recall user name from
626 cookie.</dd>
628 <dt id="cfg_Servers">$cfg['Servers'] array</dt>
629 <dd>Since version 1.4.2, phpMyAdmin supports the administration of multiple
630 MySQL servers. Therefore, a
631 <a href="#cfg_Servers" class="configrule">$cfg['Servers']</a>-array has
632 been added which contains the login information for the different servers.
633 The first
634 <a href="#cfg_Servers_host" class="configrule">$cfg['Servers'][$i]['host']</a>
635 contains the hostname of the first server, the second
636 <a href="#cfg_Servers_host" class="configrule">$cfg['Servers'][$i]['host']</a>
637 the hostname of the second server, etc. In
638 <tt>./libraries/config.default.php</tt>, there is only one section for
639 server definition, however you can put as many as you need in
640 <tt>./config.inc.php</tt>, copy that block or needed parts (you don't
641 have to define all settings, just those you need to change).</dd>
643 <dt id="cfg_Servers_host">$cfg['Servers'][$i]['host'] string</dt>
644 <dd>The hostname or <abbr title="Internet Protocol">IP</abbr> address of your
645 $i-th MySQL-server. E.g. localhost.</dd>
647 <dt id="cfg_Servers_port">$cfg['Servers'][$i]['port'] string</dt>
648 <dd>The port-number of your $i-th MySQL-server. Default is 3306 (leave
649 blank). If you use &quot;localhost&quot; as the hostname, MySQL
650 ignores this port number and connects with the socket, so if you want
651 to connect to a port different from the default port, use
652 &quot;127.0.0.1&quot; or the real hostname in
653 <a href="#cfg_Servers_host" class="configrule">$cfg['Servers'][$i]['host']</a>.
654 </dd>
656 <dt id="cfg_Servers_socket">$cfg['Servers'][$i]['socket'] string</dt>
657 <dd>The path to the socket to use. Leave blank for default.<br />
658 To determine the correct socket, check your MySQL configuration or, using the
659 <tt>mysql</tt> command&#8211;line client, issue the <tt>status</tt> command.
660 Among the resulting information displayed will be the socket used.</dd>
662 <dt id="cfg_Servers_ssl">$cfg['Servers'][$i]['ssl'] boolean</dt>
663 <dd>Whether to enable SSL for connection to MySQL server.
664 </dd>
666 <dt id="cfg_Servers_connect_type">$cfg['Servers'][$i]['connect_type'] string</dt>
667 <dd>What type connection to use with the MySQL server. Your options are
668 <tt>'socket'</tt> and <tt>'tcp'</tt>. It defaults to 'tcp' as that
669 is nearly guaranteed to be available on all MySQL servers, while
670 sockets are not supported on some platforms.<br /><br />
672 To use the socket mode, your MySQL server must be on the same machine
673 as the Web server.</dd>
675 <dt id="cfg_Servers_extension">$cfg['Servers'][$i]['extension'] string</dt>
676 <dd>What php MySQL extension to use for the connection. Valid options are:
677 <br /><br />
679 <tt><i>mysql</i></tt> :
680 The classic MySQL extension. This is the recommended and default
681 method at this time.<br /><br />
683 <tt><i>mysqli</i></tt> :
684 The improved MySQL extension. This extension became available
685 with php 5.0.0 and is the recommended way to connect to a server
686 running MySQL 4.1.x or newer.</dd>
688 <dt id="cfg_Servers_compress">$cfg['Servers'][$i]['compress'] boolean</dt>
689 <dd>Whether to use a compressed protocol for the MySQL server connection
690 or not (experimental).<br />
691 This feature requires PHP&nbsp;&gt;=&nbsp;4.3.0.</dd>
693 <dt id="controluser">
694 <span id="cfg_Servers_controluser">$cfg['Servers'][$i]['controluser']</span> string<br />
695 <span id="cfg_Servers_controlpass">$cfg['Servers'][$i]['controlpass']</span> string
696 </dt>
697 <dd>This special account is used for 2 distinct purposes: to make possible
698 all relational features (see
699 <a href="#pmadb" class="configrule">$cfg['Servers'][$i]['pmadb']</a>)
700 and, for a MySQL server previous to 4.1.2 or running with
701 <tt>--skip-show-database</tt>, to enable a multi-user installation
702 (<abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie
703 authentication mode).<br /><br />
705 When using <abbr title="HyperText Transfer Protocol">HTTP</abbr> or
706 cookie authentication modes (or 'config'
707 authentication mode since phpMyAdmin 2.2.1), you need to supply the
708 details of a MySQL account that has <tt>SELECT</tt> privilege on the
709 <i>mysql.user (all columns except &quot;Password&quot;)</i>,
710 <i>mysql.db (all columns)</i> and <i>mysql.tables_priv (all columns
711 except &quot;Grantor&quot; and &quot;Timestamp&quot;) </i>tables.
712 This account is used to check what databases the user will see at
713 login.<br />
714 Please see the <a href="#setup">install section</a> on
715 &quot;Using authentication modes&quot; for more information.<br /><br />
717 In phpMyAdmin versions before 2.2.5, those were called
718 &quot;stduser/stdpass&quot;.</dd>
720 <dt id="cfg_Servers_auth_type">$cfg['Servers'][$i]['auth_type'] string
721 <tt>['<abbr title="HyperText Transfer Protocol">HTTP</abbr>'|'http'|'cookie'|'config'|'signon']</tt></dt>
722 <dd>Whether config or cookie or
723 <abbr title="HyperText Transfer Protocol">HTTP</abbr> or signon authentication
724 should be used for this server.
725 <ul><li>'config' authentication (<tt>$auth_type&nbsp;=&nbsp;'config'</tt>)
726 is the plain old way: username and password are stored in
727 <i>config.inc.php</i>.</li>
728 <li>'cookie' authentication mode
729 (<tt>$auth_type&nbsp;=&nbsp;'cookie'</tt>) as introduced in
730 2.2.3 allows you to log in as any valid MySQL user with the
731 help of cookies. Username and password are stored in
732 cookies during the session and password is deleted when it
733 ends. This can also allow you to log in in arbitrary server if
734 <tt><a href="#AllowArbitraryServer" class="configrule">$cfg['AllowArbitraryServer']</a></tt> enabled.
735 </li>
736 <li>'<abbr title="HyperText Transfer Protocol">HTTP</abbr>' authentication (was called 'advanced' in previous versions and can be written also as 'http')
737 (<tt>$auth_type&nbsp;=&nbsp;'<abbr title="HyperText Transfer Protocol">HTTP</abbr>'</tt>) as introduced in 1.3.0
738 allows you to log in as any valid MySQL user via HTTP-Auth.</li>
739 <li>'signon' authentication mode
740 (<tt>$auth_type&nbsp;=&nbsp;'signon'</tt>)
741 as introduced in 2.10.0 allows you to log in from prepared PHP
742 session data. This is useful for implementing single signon
743 from another application. Sample way how to seed session is in
744 signon example: <code>scripts/signon.php</code>. You need to
745 configure <a href="#cfg_Servers_SignonSession"
746 class="configrule">session name</a> and <a
747 href="#cfg_Servers_SignonURL" class="configrule">signon
748 URL</a> to use this authentication method.</li>
749 </ul>
751 Please see the <a href="#setup">install section</a> on &quot;Using authentication modes&quot;
752 for more information.
753 </dd>
754 <dt id="servers_auth_swekey_config">
755 <span id="cfg_Servers_auth_swekey_config">$cfg['Servers'][$i]['auth_swekey_config']</span> string<br />
756 </dt>
757 <dd>
758 The name of the file containing <a href="#swekey">Swekey</a> ids and login
759 names for hardware authentication. Leave empty to deactivate this feature.
760 </dd>
761 <dt id="servers_user">
762 <span id="cfg_Servers_user">$cfg['Servers'][$i]['user']</span> string<br />
763 <span id="cfg_Servers_password">$cfg['Servers'][$i]['password']</span> string
764 </dt>
765 <dd>
766 When using auth_type = 'config', this is the user/password-pair
767 which phpMyAdmin will use to connect to the
768 MySQL server. This user/password pair is not needed when <abbr title="HyperText Transfer Protocol">HTTP</abbr> or
769 cookie authentication is used and should be empty.</dd>
770 <dt id="servers_nopassword">
771 <span
772 id="cfg_Servers_nopassword">$cfg['Servers'][$i]['nopassword']</span> boolean
773 </dt>
774 <dd>
775 Allow attempt to log in without password when a login with password
776 fails. This can be used together with http authentication, when
777 authentication is done some other way and phpMyAdmin gets user name
778 from auth and uses empty password for connecting to MySQL. Password
779 login is still tried first, but as fallback, no password method is
780 tried.</dd>
781 <dt id="servers_only_db">
782 <span id="cfg_Servers_only_db">$cfg['Servers'][$i]['only_db']</span> string or array
783 </dt>
784 <dd>
785 If set to a (an array of) database name(s), only this (these) database(s)
786 will be shown to the user. Since phpMyAdmin 2.2.1, this/these
787 database(s) name(s) may contain MySQL wildcards characters
788 (&quot;_&quot; and &quot;%&quot;): if you want to use literal instances
789 of these characters, escape them (I.E. use <tt>'my\_db'</tt> and not
790 <tt>'my_db'</tt>).<br />
791 This setting is an efficient way to lower the server load since the
792 latter does not need to send MySQL requests to build the available
793 database list. But <span class="important">it does not replace the
794 privileges rules of the MySQL database server</span>. If set, it just
795 means only these databases will be displayed but
796 <span class="important">not that all other databases can't be used.</span>
797 <br /><br />
799 An example of using more that one database:
800 <tt>$cfg['Servers'][$i]['only_db'] = array('db1', 'db2');</tt>
801 <br /><br />
803 As of phpMyAdmin 2.5.5 the order inside the array is used for sorting the
804 databases in the left frame, so that you can individually arrange your databases.<br />
805 If you want to have certain databases at the top, but don't care about the others, you do not
806 need to specify all other databases. Use:
807 <tt>$cfg['Servers'][$i]['only_db'] = array('db3', 'db4', '*');</tt>
808 instead to tell phpMyAdmin that it should display db3 and db4 on top, and the rest in alphabetic
809 order.</dd>
811 <dt><span id="cfg_Servers_hide_db">$cfg['Servers'][$i]['hide_db']</span> string
812 </dt>
813 <dd>Regular expression for hiding some databases. This only hides them
814 from listing, but a user is still able to access them (using, for example,
815 the SQL query area). To limit access, use the MySQL privilege system.
816 <br /><br />
817 For example, to hide all databases starting with the letter &#34;a&#34;, use<br />
818 <pre>$cfg['Servers'][$i]['hide_db'] = '^a';</pre>
819 and to hide both &#34;db1&#34; and &#34;db2&#34; use <br />
820 <pre>$cfg['Servers'][$i]['hide_db'] = '(db1|db2)';</pre>
821 More information on regular expressions can be found in the
822 <a href="http://php.net/manual/en/reference.pcre.pattern.syntax.php">
823 PCRE pattern syntax</a> portion of the PHP reference manual.
824 </dd>
826 <dt id="cfg_Servers_verbose">$cfg['Servers'][$i]['verbose'] string</dt>
827 <dd>Only useful when using phpMyAdmin with multiple server entries. If set,
828 this string will be displayed instead of the hostname in the pull-down
829 menu on the main page. This can be useful if you want to show only
830 certain databases on your system, for example. For HTTP auth, all
831 non-US-ASCII characters will be stripped.</dd>
833 <dt id="pmadb">
834 <span id="cfg_Servers_pmadb">$cfg['Servers'][$i]['pmadb']</span> string
835 </dt>
836 <dd>The name of the database containing the linked-tables infrastructure.
837 <br /><br />
839 See the <a href="#linked-tables">Linked-tables infrastructure</a>
840 section in this document to see the benefits of this infrastructure,
841 and for a quick way of creating this database and the needed tables.
842 <br /><br />
844 If you are the only user of this phpMyAdmin installation, you can
845 use your current database to store those special tables; in this
846 case, just put your current database name in
847 <tt>$cfg['Servers'][$i]['pmadb']</tt>. For a multi-user installation,
848 set this parameter to the name of your central database containing
849 the linked-tables infrastructure.</dd>
851 <dt id="bookmark">
852 <span id="cfg_Servers_bookmarktable">$cfg['Servers'][$i]['bookmarktable']</span> string
853 </dt>
854 <dd>Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This can be
855 useful for queries you often run.<br /><br />
857 To allow the usage of this functionality:
858 <ul><li>set up <a href="#pmadb">pmadb</a> and the linked-tables infrastructure</li>
859 <li>enter the table name in
860 <tt>$cfg['Servers'][$i]['bookmarktable']</tt></li>
861 </ul>
862 </dd>
864 <dt id="relation">
865 <span id="cfg_Servers_relation">$cfg['Servers'][$i]['relation']</span> string
866 </dt>
867 <dd>Since release 2.2.4 you can describe, in a special 'relation' table,
868 which field is a key in another table (a foreign key). phpMyAdmin
869 currently uses this to
870 <ul><li>make clickable, when you browse the master table, the data values
871 that point to the foreign table;</li>
872 <li>display in an optional tool-tip the &quot;display field&quot;
873 when browsing the master table, if you move the mouse to a column
874 containing a foreign key (use also the 'table_info' table);<br />
875 (see <a href="#faqdisplay"><abbr title="Frequently Asked Questions">
876 FAQ</abbr> 6.7</a>)</li>
877 <li>in edit/insert mode, display a drop-down list of possible foreign
878 keys (key value and &quot;display field&quot; are shown)<br />
879 (see <a href="#faq6_21"><abbr title="Frequently Asked Questions">
880 FAQ</abbr> 6.21</a>)</li>
881 <li>display links on the table properties page, to check referential
882 integrity (display missing foreign keys) for each described key;
883 </li>
884 <li>in query-by-example, create automatic joins (see <a href="#faq6_6">
885 <abbr title="Frequently Asked Questions">FAQ</abbr> 6.6</a>)</li>
886 <li>enable you to get a <abbr title="Portable Document Format">PDF</abbr>
887 schema of your database (also uses the table_coords table).</li>
888 </ul>
890 The keys can be numeric or character.<br /><br />
892 To allow the usage of this functionality:
894 <ul><li>set up <a href="#pmadb">pmadb</a> and the linked-tables
895 infrastructure</li>
896 <li>put the relation table name in
897 <tt>$cfg['Servers'][$i]['relation']</tt></li>
898 <li>now as normal user open phpMyAdmin and for each one of your
899 tables where you want to use this feature, click
900 &quot;Structure/Relation view/&quot; and choose foreign fields.
901 </li>
902 </ul>
904 Please note that in the current version, <tt>master_db</tt>
905 must be the same as <tt>foreign_db</tt>. Those fields have been put in
906 future development of the cross-db relations.
907 </dd>
909 <dt id="table_info">
910 <span id="cfg_Servers_table_info">$cfg['Servers'][$i]['table_info']</span> string
911 </dt>
912 <dd>
913 Since release 2.3.0 you can describe, in a special 'table_info'
914 table, which field is to be displayed as a tool-tip when moving the
915 cursor over the corresponding key.<br />
916 This configuration variable will hold the name of this special
917 table. To allow the usage of this functionality:
918 <ul><li>set up <a href="#pmadb">pmadb</a> and the linked-tables infrastructure</li>
919 <li>put the table name in
920 <tt>$cfg['Servers'][$i]['table_info']</tt></li>
921 <li>then for each table where you want to use this feature,
922 click &quot;Structure/Relation view/Choose field to display&quot;
923 to choose the field.</li>
924 </ul>
925 Usage tip: <a href="#faqdisplay">Display field</a>.
926 </dd>
927 <dt id="table_coords">
928 <span id="cfg_Servers_table_coords">$cfg['Servers'][$i]['table_coords']</span> string<br />
929 <span id="cfg_Servers_pdf_pages">$cfg['Servers'][$i]['pdf_pages']</span> string
930 </dt>
931 <dd>Since release 2.3.0 you can have phpMyAdmin create
932 <abbr title="Portable Document Format">PDF</abbr> pages showing
933 the relations between your tables. To do this it needs two tables
934 &quot;pdf_pages&quot; (storing information about the available
935 <abbr title="Portable Document Format">PDF</abbr>
936 pages) and &quot;table_coords&quot; (storing coordinates where each
937 table will be placed on a <abbr title="Portable Document Format">PDF</abbr>
938 schema output).<br /><br />
940 You must be using the &quot;relation&quot; feature.<br /><br />
942 To allow the usage of this functionality:
944 <ul><li>set up <a href="#pmadb">pmadb</a> and the linked-tables
945 infrastructure</li>
946 <li>put the correct table names in
947 <tt>$cfg['Servers'][$i]['table_coords']</tt> and
948 <tt>$cfg['Servers'][$i]['pdf_pages']</tt></li>
949 </ul>
951 Usage tips: <a href="#faqpdf"><abbr title="Portable Document Format">PDF</abbr> output</a>.
952 </dd>
954 <dt id="col_com">
955 <span id="cfg_Servers_column_info">$cfg['Servers'][$i]['column_info']</span> string
956 </dt>
957 <dd><!-- This part requires a content update! -->
958 Since release 2.3.0 you can store comments to describe each column for
959 each table. These will then be shown on the &quot;printview&quot;.
960 <br /><br />
962 Starting with release 2.5.0, comments are consequently used on the table
963 property pages and table browse view, showing up as tool-tips above the
964 column name (properties page) or embedded within the header of table in
965 browse view. They can also be shown in a table dump. Please see the
966 relevant configuration directives later on.<br /><br />
968 Also new in release 2.5.0 is a MIME-transformation system which is also
969 based on the following table structure. See <a href="#transformations">
970 Transformations</a> for further information. To use the
971 MIME-transformation system, your column_info table has to have the three
972 new fields 'mimetype', 'transformation', 'transformation_options'.
973 <br /><br />
975 To allow the usage of this functionality:
976 <ul><li>set up <a href="#pmadb">pmadb</a> and the linked-tables
977 infrastructure</li>
978 <li>put the table name in
979 <tt>$cfg['Servers'][$i]['column_info']</tt></li>
980 <li>to update your PRE-2.5.0 Column_comments Table use this:
982 <pre>
983 ALTER TABLE `pma_column_comments`
984 ADD `mimetype` VARCHAR( 255 ) NOT NULL,
985 ADD `transformation` VARCHAR( 255 ) NOT NULL,
986 ADD `transformation_options` VARCHAR( 255 ) NOT NULL;
987 </pre>
989 and remember that the Variable in <i>config.inc.php</i> has been
990 renamed from<br />
991 <tt>$cfg['Servers'][$i]['column_comments']</tt> to
992 <tt>$cfg['Servers'][$i]['column_info']</tt></li>
993 </ul>
994 </dd>
996 <dt id="history">
997 <span id="cfg_Servers_history">$cfg['Servers'][$i]['history']</span> string
998 </dt>
999 <dd>Since release 2.5.0 you can store your
1000 <abbr title="structured query language">SQL</abbr> history, which means
1001 all queries you entered manually into the phpMyAdmin interface. If you
1002 don't want to use a table-based history, you can use the JavaScript-based
1003 history. Using that, all your history items are deleted when closing the
1004 window.<br /><br />
1006 Using
1007 <a href="#cfg_QueryHistoryMax" class="configrule">$cfg['QueryHistoryMax']</a>
1008 you can specify an amount of history items you want to have on hold. On
1009 every login, this list gets cut to the maximum amount.<br /><br />
1011 The query history is only available if JavaScript is enabled in your
1012 browser.<br /><br />
1014 To allow the usage of this functionality:
1016 <ul><li>set up <a href="#pmadb">pmadb</a> and the linked-tables
1017 infrastructure</li>
1018 <li>put the table name in <tt>$cfg['Servers'][$i]['history']</tt>
1019 </li>
1020 </ul>
1021 </dd>
1023 <dt id="designer_coords">
1024 <span id="cfg_Servers_designer_coords">$cfg['Servers'][$i]['designer_coords']</span> string
1025 </dt>
1026 <dd>Since release 2.10.0 a Designer interface is available; it permits
1027 to visually manage the relations.
1028 <br /><br />
1030 To allow the usage of this functionality:
1032 <ul><li>set up <a href="#pmadb">pmadb</a> and the linked-tables
1033 infrastructure</li>
1034 <li>put the table name in <tt>$cfg['Servers'][$i]['designer_coords']</tt>
1035 </li>
1036 </ul>
1037 </dd>
1039 <dt><span id="cfg_Servers_verbose_check">$cfg['Servers'][$i]['verbose_check']</span> boolean
1040 </dt>
1041 <dd>Because release 2.5.0 introduced the new MIME-transformation support, the
1042 column_info table got enhanced with three new fields. If the above variable
1043 is set to <tt>TRUE</tt> (default) phpMyAdmin will check if you have the
1044 latest table structure available. If not, it will emit a warning to the
1045 superuser.<br /><br />
1047 You can disable this checking behavior by setting the variable to false,
1048 which should offer a performance increase.<br /><br />
1050 Recommended to set to FALSE, when you are sure, your table structure is
1051 up to date.</dd>
1052 <dt><span id="cfg_Servers_AllowRoot">$cfg['Servers'][$i]['AllowRoot']</span>
1053 boolean</dt>
1054 <dd>Whether to allow root access. This is just a shortcut for the AllowDeny rules below.
1055 </dd>
1056 <dt><span id="cfg_Servers_AllowNoPasswordRoot">$cfg['Servers'][$i]['AllowNoPasswordRoot']</span>
1057 boolean</dt>
1058 <dd>Whether to allow access to root user without password. The default
1059 value of <tt>false</tt> for this parameter prevents unintended access
1060 to a MySQL server with was left with an empty password for root.
1061 </dd>
1062 <dt id="servers_allowdeny_order">
1063 <span id="cfg_Servers_AllowDeny_order">$cfg['Servers'][$i]['AllowDeny']['order']</span> string
1064 </dt>
1065 <dd>If your rule order is empty, then <abbr title="Internet Protocol">IP</abbr>
1066 authentication is disabled.<br /><br />
1068 If your rule order is set to <tt>'deny,allow'</tt> then the system applies
1069 all deny rules followed by allow rules. Access is allowed by default. Any
1070 client which does not match a Deny command or does match an Allow command
1071 will be allowed access to the server. <br /><br />
1073 If your rule order is set to <tt>'allow,deny'</tt> then the system
1074 applies all allow rules followed by deny rules. Access is denied by
1075 default. Any client which does not match an Allow directive or does
1076 match a Deny directive will be denied access to the server.<br /><br />
1078 If your rule order is set to 'explicit', the authentication is
1079 performed in a similar fashion to rule order 'deny,allow', with the
1080 added restriction that your host/username combination <b>must</b> be
1081 listed in the <i>allow</i> rules, and not listed in the <i>deny</i>
1082 rules. This is the <b>most</b> secure means of using Allow/Deny rules,
1083 and was available in Apache by specifying allow and deny rules without
1084 setting any order.<br /><br />
1086 Please also see <a
1087 href="#cfg_TrustedProxies">$cfg['TrustedProxies']</a> for detecting IP
1088 address behind proxies.
1089 </dd>
1090 <dt id="servers_allowdeny_rules">
1091 <span id="cfg_Servers_AllowDeny_rules">$cfg['Servers'][$i]['AllowDeny']['rules']</span> array of strings
1092 </dt>
1093 <dd>The general format for the rules is as such:
1095 <pre>
1096 &lt;'allow' | 'deny'&gt; &lt;username&gt; [from] &lt;ipmask&gt;
1097 </pre>
1099 If you wish to match all users, it is possible to use a <tt>'%'</tt> as
1100 a wildcard in the <i>username</i> field.<br />
1101 There are a few shortcuts you can use in the <i>ipmask</i> field as
1102 well (please note that those containing SERVER_ADDRESS might not be
1103 available on all webservers):
1104 <pre>
1105 'all' -&gt; 0.0.0.0/0
1106 'localhost' -&gt; 127.0.0.1/8
1107 'localnetA' -&gt; SERVER_ADDRESS/8
1108 'localnetB' -&gt; SERVER_ADDRESS/16
1109 'localnetC' -&gt; SERVER_ADDRESS/24
1110 </pre>
1112 Having an empty rule list is equivalent to either using
1113 <tt>'allow % from all'</tt> if your rule order is set to
1114 <tt>'deny,allow'</tt> or <tt>'deny % from all'</tt> if your rule order
1115 is set to <tt>'allow,deny'</tt> or <tt>'explicit'</tt>.<br /><br />
1117 For the <abbr title="Internet Protocol">IP</abbr> matching system, the
1118 following work:<br />
1119 <tt>xxx.xxx.xxx.xxx</tt> (an exact <abbr title="Internet Protocol">IP</abbr> address)<br />
1120 <tt>xxx.xxx.xxx.[yyy-zzz]</tt> (an <abbr title="Internet Protocol">IP</abbr> address range)<br />
1121 <tt>xxx.xxx.xxx.xxx/nn</tt> (CIDR, Classless Inter-Domain Routing type <abbr title="Internet Protocol">IP</abbr> addresses)<br />
1122 But the following does not work:<br />
1123 <tt>xxx.xxx.xxx.xx[yyy-zzz]</tt> (partial
1124 <abbr title="Internet Protocol">IP</abbr> address range)
1125 </dd>
1126 <dt><span id="cfg_Servers_SignonSession">$cfg['Servers'][$i]['SignonSession']</span> string</dt>
1127 <dd>Name of session which will be used for signon authentication method.
1128 </dd>
1129 <dt><span id="cfg_Servers_SignonURL">$cfg['Servers'][$i]['SignonURL']</span> string</dt>
1130 <dd>URL where user will be redirected to log in for signon authentication method. Should be absolute including protocol.
1131 </dd>
1132 <dt><span id="cfg_Servers_LogoutURL">$cfg['Servers'][$i]['LogoutURL']</span> string</dt>
1133 <dd>URL where user will be redirected after logout (doesn't affect config authentication method). Should be absolute including protocol.
1134 </dd>
1136 <dt id="cfg_ServerDefault">$cfg['ServerDefault'] integer</dt>
1137 <dd>If you have more than one server configured, you can set
1138 <tt>$cfg['ServerDefault']</tt> to any one of them to autoconnect to
1139 that server when phpMyAdmin is started, or set it to 0 to be given a
1140 list of servers without logging in.<br />
1141 If you have only one server configured, <tt>$cfg['ServerDefault']</tt>
1142 MUST be set to that server.</dd>
1144 <dt id="cfg_MaxDbList">$cfg['MaxDbList'] integer</dt>
1145 <dd>The maximum number of database names to be displayed in the
1146 navigation frame and the database list.</dd>
1148 <dt id="cfg_MaxTableList">$cfg['MaxTableList'] integer</dt>
1149 <dd>The maximum number of table names to be displayed in the
1150 main panel's list (except on the Export page). This limit is also enforced in the navigation panel
1151 when in Light mode.</dd>
1153 <dt id="cfg_MaxCharactersInDisplayedSQL">$cfg['MaxCharactersInDisplayedSQL'] integer</dt>
1154 <dd>The maximum number of characters when a SQL query is displayed. The
1155 default limit of 1000 should be correct to avoid the display of tons
1156 of hexadecimal codes that represent BLOBs, but some users have real
1157 SQL queries that are longer than 1000 characters. Also, if a query's
1158 length exceeds this limit, this query is not saved in the history.</dd>
1160 <dt id="cfg_OBGzip">$cfg['OBGzip'] string/boolean</dt>
1161 <dd>Defines whether to use GZip output buffering for increased
1162 speed in <abbr title="HyperText Transfer Protocol">HTTP</abbr> transfers.<br />
1163 Set to true/false for enabling/disabling. When set to 'auto' (string),
1164 phpMyAdmin tries to enable output buffering and will automatically disable
1165 it if your browser has some problems with buffering. IE6 with a certain patch
1166 is known to cause data corruption when having enabled buffering.</dd>
1168 <dt id="cfg_PersistentConnections">$cfg['PersistentConnections'] boolean</dt>
1169 <dd>Whether persistent connections should be used or not (mysql_connect or
1170 mysql_pconnect).</dd>
1172 <dt id="cfg_ForceSSL">$cfg['ForceSSL'] boolean</dt>
1173 <dd>Whether to force using https while accessing phpMyAdmin.</dd>
1175 <dt id="cfg_ExecTimeLimit">$cfg['ExecTimeLimit'] integer [number of seconds]</dt>
1176 <dd>Set the number of seconds a script is allowed to run. If seconds is set
1177 to zero, no time limit is imposed.<br />
1178 This setting is used while importing/exporting dump files but has no
1179 effect when PHP is running in safe mode.</dd>
1181 <dt id="cfg_MemoryLimit">$cfg['MemoryLimit'] integer [number of bytes]</dt>
1182 <dd>Set the number of bytes a script is allowed to allocate. If number set
1183 to zero, no limit is imposed.<br />
1184 This setting is used while importing/exporting dump files but has no
1185 effect when PHP is running in safe mode.<br />
1186 You can also use any string as in php.ini, eg. '16M'.</dd>
1188 <dt id="cfg_SkipLockedTables">$cfg['SkipLockedTables'] boolean</dt>
1189 <dd>Mark used tables and make it possible to show databases with locked
1190 tables (since MySQL 3.23.30).</dd>
1192 <dt id="cfg_ShowSQL">$cfg['ShowSQL'] boolean</dt>
1193 <dd>Defines whether <abbr title="structured query language">SQL</abbr> queries
1194 generated by phpMyAdmin should be displayed or not.</dd>
1196 <dt id="cfg_AllowUserDropDatabase">$cfg['AllowUserDropDatabase'] boolean</dt>
1197 <dd>Defines whether normal users (non-administrator) are allowed to
1198 delete their own database or not. If set as FALSE, the link &quot;Drop
1199 Database&quot; will not be shown, and even a &quot;DROP DATABASE
1200 mydatabase&quot; will be rejected. Quite practical for
1201 <abbr title="Internet service provider">ISP</abbr>'s with many
1202 customers.<br />
1203 Please note that this limitation of SQL queries is not as strict as
1204 when using MySQL privileges. This is due to nature of SQL queries
1205 which might be quite complicated. So this choice should be viewed as
1206 help to avoid accidental dropping rather than strict privilege
1207 limitation.</dd>
1209 <dt id="cfg_Confirm">$cfg['Confirm'] boolean</dt>
1210 <dd>Whether a warning (&quot;Are your really sure...&quot;) should be
1211 displayed when you're about to lose data.</dd>
1213 <dt id="cfg_LoginCookieRecall">$cfg['LoginCookieRecall'] boolean</dt>
1214 <dd>Define whether the previous login should be recalled or not in cookie
1215 authentication mode.<br /><br />
1217 This is automatically diabled if you do not have configured
1218 <tt><a href="#cfg_blowfish_secret">$cfg['blowfish_secret']</a></tt>.
1219 </dd>
1221 <dt id="cfg_LoginCookieValidity">$cfg['LoginCookieValidity'] integer [number of seconds]</dt>
1222 <dd>Define how long is login cookie valid. Please note that php
1223 configuration option <a href="http://php.net/manual/en/session.configuration.php#ini.session.gc-maxlifetime">session.gc-maxlifetime</a>
1224 might limit session validity and if session is lost, login cookie is
1225 also invalidated. So it is good idea to set <code>session.gc-maxlifetime</code>
1226 at least as high is $cfg['LoginCookieValidity'] is set.</dd>
1228 <dt id="cfg_LoginCookieStore">$cfg['LoginCookieStore'] integer [number of seconds]</dt>
1229 <dd>Define how long is login cookie should be stored in browser. Default 0
1230 means that it will be kept for existing session. This is recommended
1231 for not trusted environments.</dd>
1233 <dt id="cfg_LoginCookieDeleteAll">$cfg['LoginCookieDeleteAll'] boolean</dt>
1234 <dd>If enabled (default), logout deletes cookies for all servers,
1235 otherwise only for current one. Setting this to false makes it easy to
1236 forget to log out from other server, when you are using more of
1237 them.</dd>
1239 <dt id="cfg_UseDbSearch">$cfg['UseDbSearch'] boolean</dt>
1240 <dd>Define whether the "search string inside database" is enabled or not.</dd>
1242 <dt id="cfg_IgnoreMultiSubmitErrors">$cfg['IgnoreMultiSubmitErrors'] boolean</dt>
1243 <dd>Define whether phpMyAdmin will continue executing a multi-query
1244 statement if one of the queries fails. Default is to abort execution.</dd>
1246 <dt id="cfg_VerboseMultiSubmit">$cfg['VerboseMultiSubmit'] boolean</dt>
1247 <dd>Define whether phpMyAdmin will output the results of each query of a
1248 multi-query statement embedded into the
1249 <abbr title="structured query language">SQL</abbr> output as inline
1250 comments. Defaults to <tt>TRUE</tt>.</dd>
1251 <dt id="AllowArbitraryServer">
1252 <span id="cfg_AllowArbitraryServer">$cfg['AllowArbitraryServer']</span> boolean</dt>
1253 <dd>If enabled allows you to log in to arbitrary servers using cookie auth.
1254 <br /><br />
1256 <b>NOTE:</b> Please use this carefully, as this may allow users access to
1257 MySQL servers behind the firewall where your
1258 <abbr title="HyperText Transfer Protocol">HTTP</abbr> server is placed.
1259 </dd>
1261 <dt id="cfg_LeftFrameLight">$cfg['LeftFrameLight'] boolean</dt>
1262 <dd>Defines whether to use a select-based menu and display only the current
1263 tables in the left frame (smaller page). Only in Non-Lightmode you can
1264 use the feature to display nested folders using
1265 <a href="#cfg_LeftFrameTableSeparator" class="configrule">$cfg['LeftFrameTableSeparator']</a>
1266 </dd>
1268 <dt id="cfg_LeftFrameDBTree">$cfg['LeftFrameDBTree'] boolean</dt>
1269 <dd>In light mode, defines whether to display the names of databases (in the
1270 selector) using a tree, see also
1271 <a href="#cfg_LeftFrameDBSeparator" class="configrule">$cfg['LeftFrameDBSeparator']</a>.
1272 </dd>
1274 <dt id="cfg_LeftFrameDBSeparator">$cfg['LeftFrameDBSeparator']
1275 string or array</dt>
1276 <dd>The string used to separate the parts of the database name when showing
1277 them in a tree. Alternatively you can specify more strings in an array
1278 and all of them will be used as a separator.</dd>
1280 <dt id="cfg_LeftFrameTableSeparator">$cfg['LeftFrameTableSeparator'] string</dt>
1281 <dd>Defines a string to be used to nest table spaces. Defaults to '__'.
1282 This means if you have tables like 'first__second__third' this will be
1283 shown as a three-level hierarchy like: first &gt; second &gt; third.
1284 If set to FALSE or empty, the feature is disabled. NOTE: You should
1285 not use this separator at the beginning or end of a
1286 table name or multiple times after another without any other
1287 characters in between.</dd>
1289 <dt id="cfg_LeftFrameTableLevel">$cfg['LeftFrameTableLevel'] string</dt>
1290 <dd>Defines how many sublevels should be displayed when splitting
1291 up tables by the above separator.</dd>
1293 <dt id="cfg_ShowTooltip">$cfg['ShowTooltip'] boolean</dt>
1294 <dd>Defines whether to display table comment as tool-tip in left frame or
1295 not.</dd>
1297 <dt id="cfg_ShowTooltipAliasDB">$cfg['ShowTooltipAliasDB'] boolean</dt>
1298 <dd>If tool-tips are enabled and a DB comment is set, this will flip the
1299 comment and the real name. That means that if you have a table called
1300 'user0001' and add the comment 'MyName' on it, you will see the name
1301 'MyName' used consequently in the left frame and the tool-tip shows
1302 the real name of the DB.</dd>
1304 <dt id="cfg_ShowTooltipAliasTB">$cfg['ShowTooltipAliasTB'] boolean/string</dt>
1305 <dd>Same as <a href="#cfg_ShowTooltipAliasDB" class="configrule">$cfg['ShowTooltipAliasDB']</a>, except this works for table names.
1307 When setting this to 'nested', the Alias of the Tablename is only used
1308 to split/nest the tables according to the
1309 <a href="#cfg_LeftFrameTableSeparator" class="configrule">$cfg['LeftFrameTableSeparator']</a>
1310 directive. So only the folder is called like the Alias, the tablename itself
1311 stays the real tablename.</dd>
1313 <dt id="cfg_LeftDisplayLogo">$cfg['LeftDisplayLogo'] boolean</dt>
1314 <dd>Defines whether or not to display the phpMyAdmin logo at the top of the left frame.
1315 Defaults to <tt>TRUE</tt>.</dd>
1316 <dt id="cfg_LeftLogoLink">$cfg['LeftLogoLink'] string</dt>
1317 <dd>Enter URL where logo in the navigation frame will point to.
1318 For use especially with self made theme which changes this.
1319 The default value for this is <tt>main.php</tt>.</dd>
1321 <dt id="cfg_LeftLogoLinkWindow">$cfg['LeftLogoLinkWindow'] string</dt>
1322 <dd>Whether to open the linked page in the main window (<tt>main</tt>)
1323 or in a new one (<tt>new</tt>). Note: use <tt>new</tt> if you are
1324 linking to <tt>phpmyadmin.net</tt>.</dd>
1326 <dt id="cfg_LeftDisplayServers">$cfg['LeftDisplayServers'] boolean</dt>
1327 <dd>Defines whether or not to display a server choice at the top of the left frame.
1328 Defaults to FALSE.</dd>
1329 <dt id="cfg_DisplayServersList">$cfg['DisplayServersList'] boolean</dt>
1330 <dd>Defines whether to display this server choice as links instead of in a drop-down.
1331 Defaults to FALSE (drop-down).</dd>
1332 <dt id="cfg_DisplayDatabasesList">$cfg['DisplayDatabasesList'] boolean or text</dt>
1333 <dd>Defines whether to display database choice in light navigation frame as links
1334 instead of in a drop-down. Defaults to 'auto' - on main page list is
1335 shown, when database is selected, only drop down is displayed.</dd>
1337 <dt id="cfg_LeftDefaultTabTable">$cfg['LeftDefaultTabTable'] string</dt>
1338 <dd>Defines the tab displayed by default when clicking the small
1339 icon next to each table name in the navigation panel. Possible
1340 values: &quot;tbl_structure.php&quot;,
1341 &quot;tbl_sql.php&quot;, &quot;tbl_select.php&quot;,
1342 &quot;tbl_change.php&quot; or &quot;sql.php&quot;.</dd>
1344 <dt id="cfg_ShowStats">$cfg['ShowStats'] boolean</dt>
1345 <dd>Defines whether or not to display space usage and statistics about databases
1346 and tables.<br />
1347 Note that statistics requires at least MySQL 3.23.3 and that, at this
1348 date, MySQL doesn't return such information for Berkeley DB tables.</dd>
1350 <dt><span id="cfg_ShowServerInfo">$cfg['ShowServerInfo'] </span>boolean</dt>
1351 <dd>Defines whether to display detailed server information on main page.
1352 You can additionally hide more information by using
1353 <tt><a href="#cfg_Servers_verbose">$cfg['Servers'][$i]['verbose']</a></tt>.
1354 </dd>
1356 <dt><span id="cfg_ShowPhpInfo">$cfg['ShowPhpInfo'] </span>boolean<br />
1357 <span id="cfg_ShowChgPassword">$cfg['ShowChgPassword'] </span>boolean<br />
1358 <span id="cfg_ShowCreateDb">$cfg['ShowCreateDb'] </span>boolean
1359 </dt>
1360 <dd>Defines whether to display the &quot;PHP information&quot; and
1361 &quot;Change password &quot; links and form for creating database or
1362 not at the starting main (right) frame. This setting
1363 does not check MySQL commands entered directly.<br /><br />
1365 Please note that to block the usage of phpinfo() in scripts, you
1366 have to put this in your <i>php.ini</i>:
1368 <pre>disable_functions = phpinfo()</pre>
1370 Also note that enabling the &quot;Change password &quot; link has no
1371 effect with &quot;config&quot; authentication mode: because of the
1372 hard coded password value in the configuration file, end users can't
1373 be allowed to change their passwords.</dd>
1375 <dt id="cfg_SuggestDBName">$cfg['SuggestDBName'] boolean</dt>
1376 <dd>Defines whether to suggest a database name on the
1377 &quot;Create Database&quot; form or to keep the textfield empty.</dd>
1379 <dt id="cfg_NavigationBarIconic">$cfg['NavigationBarIconic'] string</dt>
1380 <dd>Defines whether navigation bar buttons and the right panel top menu
1381 contain text or symbols only. A value of TRUE displays icons, FALSE
1382 displays text and 'both' displays both icons and text.</dd>
1384 <dt id="cfg_ShowAll">$cfg['ShowAll'] boolean</dt>
1385 <dd>Defines whether a user should be displayed a
1386 &quot;show all (records)&quot; button in browse mode or not.</dd>
1388 <dt id="cfg_MaxRows">$cfg['MaxRows'] integer</dt>
1389 <dd>Number of rows displayed when browsing a result set. If the result set
1390 contains more rows, &quot;Previous&quot; and &quot;Next&quot; links will be shown.</dd>
1392 <dt id="cfg_Order">$cfg['Order'] string [<tt>DESC</tt>|<tt>ASC</tt>|<tt>SMART</tt>]</dt>
1393 <dd>Defines whether fields are displayed in ascending (<tt>ASC</tt>) order,
1394 in descending (<tt>DESC</tt>) order or in a &quot;smart&quot;
1395 (<tt>SMART</tt>) order - I.E. descending order for fields of type TIME,
1396 DATE, DATETIME and TIMESTAMP, ascending order else- by default.</dd>
1398 <dt id="cfg_ProtectBinary">$cfg['ProtectBinary'] boolean or string</dt>
1399 <dd>Defines whether <tt>BLOB</tt> or <tt>BINARY</tt> fields are protected
1400 from editing when browsing a table's content. Valid values are:
1401 <ul><li><tt>FALSE</tt> to allow editing of all fields;</li>
1402 <li><tt>'blob'</tt> to allow editing of all fields except <tt>BLOBS</tt>;</li>
1403 <li><tt>'all'</tt> to disallow editing of all <tt>BINARY</tt> or
1404 <tt>BLOB</tt> fields.</li>
1405 </ul>
1406 </dd>
1408 <dt id="cfg_ShowFunctionFields">$cfg['ShowFunctionFields'] boolean</dt>
1409 <dd>Defines whether or not MySQL functions fields should be initially
1410 displayed in edit/insert mode. Since version 2.10, the user can
1411 toggle this setting from the interface.
1412 </dd>
1414 <dt id="cfg_CharEditing">$cfg['CharEditing'] string</dt>
1415 <dd>Defines which type of editing controls should be used for CHAR and
1416 VARCHAR fields. Possible values are:
1417 <ul><li>input - this allows to limit size of text to size of field in
1418 MySQL, but has problems with newlines in fields</li>
1419 <li>textarea - no problems with newlines in fields, but also no
1420 length limitations</li>
1421 </ul>
1422 Default is old behavior so input.</dd>
1424 <dt id="cfg_InsertRows">$cfg['InsertRows'] integer</dt>
1425 <dd>Defines the maximum number of concurrent entries for the Insert page.</dd>
1427 <dt id="cfg_ForeignKeyMaxLimit">$cfg['ForeignKeyMaxLimit'] integer</dt>
1428 <dd>If there are fewer items than this in the set of foreign keys, then a
1429 drop-down box of foreign keys is presented, in the style described by the
1430 <a href="#cfg_ForeignKeyDropdownOrder" class="configrule">$cfg['ForeignKeyDropdownOrder']</a>
1431 setting.</dd>
1433 <dt id="cfg_ForeignKeyDropdownOrder">$cfg['ForeignKeyDropdownOrder'] array</dt>
1434 <dd>For the foreign key drop-down fields, there are several methods of
1435 display, offering both the key and value data. The contents of the
1436 array should be one or both of the following strings:
1437 <i>'content-id'</i>, <i>'id-content'</i>.</dd>
1439 <dt><span id="cfg_ZipDump">$cfg['ZipDump'] </span>boolean<br />
1440 <span id="cfg_GZipDump">$cfg['GZipDump'] </span>boolean<br />
1441 <span id="cfg_BZipDump">$cfg['BZipDump'] </span>boolean
1442 </dt>
1443 <dd>Defines whether to allow the use of zip/GZip/BZip2 compression when
1444 creating a dump file</dd>
1446 <dt><span id="cfg_CompressOnFly">$cfg['CompressOnFly'] </span>boolean<br />
1447 </dt>
1448 <dd>Defines whether to allow on the fly compression for GZip/BZip2
1449 compressed exports. This doesn't affect smaller dumps and allows users to
1450 create larger dumps that won't otherwise fit in memory due to php
1451 memory limit. Produced files contain more GZip/BZip2 headers, but all
1452 normal programs handle this correctly.</dd>
1454 <dt id="cfg_LightTabs">$cfg['LightTabs'] boolean</dt>
1455 <dd>If set to <tt>TRUE</tt>, use less graphically intense tabs on the top of the
1456 mainframe.</dd>
1458 <dt id="cfg_PropertiesIconic">$cfg['PropertiesIconic'] string</dt>
1459 <dd>If set to <tt>TRUE</tt>, will display icons instead of text for db and table
1460 properties links (like 'Browse', 'Select', 'Insert', ...).<br /> Can be
1461 set to <tt>'both'</tt> if you want icons AND text.<br />
1462 When set to <tt>FALSE</tt>, will only show text.</dd>
1464 <dt id="cfg_PropertiesNumColumns">$cfg['PropertiesNumColumns'] integer</dt>
1465 <dd>How many columns will be utilized to display the tables on the
1466 database property view? Default is 1 column. When setting this to a
1467 value larger than 1, the type of the database will be omitted for more
1468 display space.</dd>
1471 <dt id="cfg_DefaultTabServer">$cfg['DefaultTabServer'] string</dt>
1472 <dd>Defines the tab displayed by default on server view. Possible
1473 values: &quot;main.php&quot; (recommended for multi-user setups),
1474 &quot;server_databases.php&quot;, &quot;server_status.php&quot;,
1475 &quot;server_variables.php&quot;, &quot;server_privileges.php&quot;
1476 or &quot;server_processlist.php&quot;.</dd>
1478 <dt id="cfg_DefaultTabDatabase">$cfg['DefaultTabDatabase'] string</dt>
1479 <dd>Defines the tab displayed by default on database view. Possible
1480 values: &quot;db_structure.php&quot;,
1481 &quot;db_sql.php&quot; or &quot;db_search.php&quot;.</dd>
1483 <dt id="cfg_DefaultTabTable">$cfg['DefaultTabTable'] string</dt>
1484 <dd>Defines the tab displayed by default on table view. Possible
1485 values: &quot;tbl_structure.php&quot;,
1486 &quot;tbl_sql.php&quot;, &quot;tbl_select.php&quot;,
1487 &quot;tbl_change.php&quot; or &quot;sql.php&quot;.</dd>
1489 <dt id="cfg_MySQLManualBase">$cfg['MySQLManualBase'] string</dt>
1490 <dd>If set to an <abbr title="Uniform Resource Locator">URL</abbr> which
1491 points to the MySQL documentation (type depends
1492 on <a href="#cfg_MySQLManualType" class="configrule">$cfg['MySQLManualType']</a>), appropriate help links are
1493 generated.<br />
1494 See <a href="http://dev.mysql.com/doc/">MySQL Documentation page</a>
1495 for more information about MySQL manuals and their types.</dd>
1497 <dt id="cfg_MySQLManualType">$cfg['MySQLManualType'] string</dt>
1498 <dd>Type of MySQL documentation:
1499 <ul><li>viewable - &quot;viewable online&quot;, current one used on MySQL website</li>
1500 <li>searchable - &quot;Searchable, with user comments&quot;</li>
1501 <li>chapters - &quot;HTML, one page per chapter&quot;</li>
1502 <li>big - &quot;HTML, all on one page&quot;</li>
1503 <li>none - do not show documentation links</li>
1504 </ul>
1505 </dd>
1507 <dt id="cfg_DefaultLang">$cfg['DefaultLang'] string</dt>
1508 <dd>Defines the default language to use, if not browser-defined or
1509 user-defined.<br />
1510 See the <i>select_lang.lib.php</i> script to know the valid values for
1511 this setting.</dd>
1513 <dt id="cfg_DefaultConnectionCollation">$cfg['DefaultConnectionCollation'] string</dt>
1514 <dd>Defines the default connection collation to use, if not
1515 user-defined.<br />
1516 See the <a href="http://dev.mysql.com/doc/mysql/en/charset-charsets.html">MySQL
1517 documentation</a> for list of possible values.</dd>
1519 <dt id="cfg_Lang">$cfg['Lang'] string</dt>
1520 <dd>Force: always use this language (must be defined in the
1521 <i>select_lang.lib.php</i> script).</dd>
1523 <dt id="cfg_FilterLanguages">$cfg['FilterLanguages'] string</dt>
1524 <dd>Limit list of available languages to those matching the given regular
1525 expression. For example if you want only Czech and English, you should
1526 set filter to <code>'^(cs|en)'</code>.</dd>
1528 <dt id="cfg_DefaultCharset">$cfg['DefaultCharset'] string</dt>
1529 <dd>Default character set to use for recoding of MySQL queries. This must be
1530 enabled and it's described by
1531 <a href="#cfg_AllowAnywhereRecoding" class="configrule">$cfg['AllowAnywhereRecoding']</a>
1532 option.<br />
1533 You can give here any character set which is in
1534 <a href="#cfg_AvailableCharsets" class="configrule">$cfg['AvailableCharsets']</a>
1535 array and this is just default choice, user can select any of them.</dd>
1537 <dt id="cfg_AllowAnywhereRecoding">$cfg['AllowAnywhereRecoding'] boolean</dt>
1538 <dd>Allow character set recoding of MySQL queries. You need recode or iconv
1539 support (compiled in or module) in PHP to allow MySQL queries recoding
1540 and used language file must have it enabled (by default only these
1541 which are in Unicode, just to avoid losing some characters).<br /><br />
1543 Setting this to <tt>TRUE</tt> also activates a pull-down menu
1544 in the Export and Import pages, to choose the character set when
1545 exporting a file. The default value in this menu comes from
1546 <tt>$cfg['Export']['charset']</tt> and <tt>$cfg['Import']['charset']</tt>.
1547 </dd>
1549 <dt id="cfg_RecodingEngine">$cfg['RecodingEngine'] string</dt>
1550 <dd>You can select here which functions will be used for character set
1551 conversion. Possible values are:
1552 <ul><li>auto - automatically use available one (first is tested
1553 iconv, then recode)</li>
1554 <li>iconv - use iconv or libiconv functions</li>
1555 <li>recode - use recode_string function</li>
1556 </ul>
1557 Default is auto.</dd>
1559 <dt id="cfg_IconvExtraParams">$cfg['IconvExtraParams'] string</dt>
1560 <dd>Specify some parameters for iconv used in charset conversion. See
1561 <a href="http://www.gnu.org/software/libiconv/documentation/libiconv/iconv_open.3.html">iconv
1562 documentation</a> for details. By default <code>//TRANSLIT</code> is
1563 used, so that invalid characters will be transliterated.</dd>
1565 <dt id="cfg_AvailableCharsets">$cfg['AvailableCharsets'] array</dt>
1566 <dd>Available character sets for MySQL conversion. You can add your own (any of
1567 supported by recode/iconv) or remove these which you don't use.
1568 Character sets will be shown in same order as here listed, so if you
1569 frequently use some of these move them to the top.</dd>
1571 <dt id="cfg_TrustedProxies">$cfg['TrustedProxies'] array</dt>
1572 <dd>Lists proxies and HTTP headers which are trusted for <a
1573 href="#servers_allowdeny_order">IP Allow/Deny</a>. This list is by
1574 default empty, you need to fill in some trusted proxy servers if you
1575 want to use rules for IP addresses behind proxy.<br /><br />
1577 The following example specifies that phpMyAdmin should trust a
1578 HTTP_X_FORWARDED_FOR (<tt>X-Forwarded-For</tt>) header coming from the proxy 1.2.3.4:
1579 <pre>
1580 $cfg['TrustedProxies'] =
1581 array('1.2.3.4' =&gt; 'HTTP_X_FORWARDED_FOR');
1582 </pre>
1583 The $cfg['Servers'][$i]['AllowDeny']['rules'] directive uses the
1584 client's IP address as usual.
1585 </dd>
1587 <dt id="cfg_GD2Available">$cfg['GD2Available'] string</dt>
1588 <dd>Specifies whether GD &gt;= 2 is available. If yes it can be used for
1589 MIME transformations.<br />
1590 Possible values are:
1591 <ul><li>auto - automatically detect, this is a bit expensive
1592 operation for php &lt; 4.3.0 so it is preferred to change this
1593 according to your server real possibilities</li>
1594 <li>yes - GD 2 functions can be used</li>
1595 <li>no - GD 2 function cannot be used</li>
1596 </ul>
1597 Default is auto.
1598 </dd>
1600 <dt id="cfg_CheckConfigurationPermissions">$cfg['CheckConfigurationPermissions'] boolean</dt>
1601 <dd>
1602 We normally check the permissions on the configuration file to ensure
1603 it's not world writable. However, phpMyAdmin could be installed on
1604 a NTFS filesystem mounted on a non-Windows server, in which case the
1605 permissions seems wrong but in fact cannot be detected. In this case
1606 a sysadmin would set this parameter to <tt>FALSE</tt>. Default is <tt>TRUE</tt>.
1607 </dd>
1609 <dt id="cfg_NaviWidth">$cfg['NaviWidth'] integer</dt>
1610 <dd>Navi frame width in pixels. See <tt>themes/themename/layout.inc.php</tt>.
1611 </dd>
1613 <dt><span id="cfg_NaviBackground">$cfg['NaviBackground']</span> string [valid css code for background]<br />
1614 <span id="cfg_MainBackground">$cfg['MainBackground']</span> string [valid css code for background]
1615 </dt>
1616 <dd>The background styles used for both the frames.
1617 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1619 <dt id="cfg_NaviPointerBackground">$cfg['NaviPointerBackground'] string [valid css code for background]<br />
1620 <span id="cfg_NaviPointerColor">$cfg['NaviPointerColor']</span> string [valid css color]</dt>
1621 <dd>The style used for the pointer in the navi frame.
1622 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1624 <dt id="cfg_NaviDatabaseNameColor">$cfg['NaviDatabaseNameColor'] string [valid css code]<br />
1625 </dt>
1626 <dd>The color used for the database name in the navi frame.
1627 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1629 <dt id="cfg_LeftPointerEnable">$cfg['LeftPointerEnable'] boolean</dt>
1630 <dd>A value of <tt>TRUE</tt> activates the navi pointer (when LeftFrameLight
1631 is <tt>FALSE</tt>).</dd>
1633 <dt id="cfg_Border">$cfg['Border'] integer</dt>
1634 <dd>The size of a table's border. See <tt>themes/themename/layout.inc.php</tt>.
1635 </dd>
1637 <dt id="cfg_ThBackground">$cfg['ThBackground'] string [valid css code for background]<br />
1638 <span id="cfg_ThColor">$cfg['ThColor']</span> string [valid css color]</dt>
1639 <dd>The style used for table headers. See
1640 <tt>themes/themename/layout.inc.php</tt>.</dd>
1642 <dt id="cfg_BgcolorOne">$cfg['BgOne'] string [HTML color]</dt>
1643 <dd>The color (HTML) #1 for table rows. See <tt>themes/themename/layout.inc.php</tt>.
1644 </dd>
1646 <dt id="cfg_BgcolorTwo">$cfg['BgTwo'] string [HTML color]</dt>
1647 <dd>The color (HTML) #2 for table rows. See <tt>themes/themename/layout.inc.php</tt>.
1648 </dd>
1650 <dt><span id="cfg_BrowsePointerBackground">$cfg['BrowsePointerBackground'] </span>string [HTML color]<br />
1651 <span id="cfg_BrowsePointerColor">$cfg['BrowsePointerColor'] </span>string [HTML color]<br />
1652 <span id="cfg_BrowseMarkerBackground">$cfg['BrowseMarkerBackground'] </span>string [HTML color]<br />
1653 <span id="cfg_BrowseMarkerColor">$cfg['BrowseMarkerColor'] </span>string [HTML color]
1654 </dt>
1655 <dd>The colors (HTML) uses for the pointer and the marker in browse mode.<br />
1656 The former feature highlights the row over which your mouse is passing
1657 and the latter lets you visually mark/unmark rows by clicking on
1658 them.<br />
1659 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1662 <dt id="cfg_FontFamily">$cfg['FontFamily'] string</dt>
1663 <dd>You put here a valid CSS font family value, for example
1664 <tt>arial, sans-serif</tt>.<br />
1665 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1667 <dt id="cfg_FontFamilyFixed">$cfg['FontFamilyFixed'] string</dt>
1668 <dd>You put here a valid CSS font family value, for example
1669 <tt>monospace</tt>. This one is used in textarea.<br />
1670 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1672 <dt id="cfg_BrowsePointerEnable">$cfg['BrowsePointerEnable'] boolean</dt>
1673 <dd>Whether to activate the browse pointer or not.</dd>
1675 <dt id="cfg_BrowseMarkerEnable">$cfg['BrowseMarkerEnable'] boolean</dt>
1676 <dd>Whether to activate the browse marker or not.</dd>
1678 <dt><span id="cfg_TextareaCols">$cfg['TextareaCols'] </span>integer<br />
1679 <span id="cfg_TextareaRows">$cfg['TextareaRows'] </span>integer<br />
1680 <span id="cfg_CharTextareaCols">$cfg['CharTextareaCols'] </span>integer<br />
1681 <span id="cfg_CharTextareaRows">$cfg['CharTextareaRows'] </span>integer
1682 </dt>
1683 <dd>Number of columns and rows for the textareas.<br />
1684 This value will be emphasized (*2) for <abbr title="structured query language">SQL</abbr> query textareas and (*1.25) for
1685 <abbr title="structured query language">SQL</abbr> textareas inside the query window.<br />
1686 The Char* values are used for CHAR and VARCHAR editing (if configured
1687 via <a href="#cfg_CharEditing">$cfg['CharEditing']</a>).</dd>
1689 <dt><span id="cfg_LongtextDoubleTextarea">$cfg['LongtextDoubleTextarea'] </span>boolean
1690 </dt>
1691 <dd>Defines whether textarea for LONGTEXT fields should have double size.</dd>
1693 <dt><span id="cfg_TextareaAutoSelect">$cfg['TextareaAutoSelect'] </span>boolean
1694 </dt>
1695 <dd>Defines if the whole textarea of the query box will be selected on
1696 click.</dd>
1697 <dt id="CtrlArrowsMoving">
1698 <span id="cfg_CtrlArrowsMoving">$cfg['CtrlArrowsMoving'] </span>boolean
1699 </dt>
1700 <dd>Enable Ctrl+Arrows (Option+Arrows in Safari) moving between fields when
1701 editing.</dd>
1703 <dt id="cfg_LimitChars">$cfg['LimitChars'] integer</dt>
1704 <dd>Maximum number of characters showen in any non-numeric field on browse view.
1705 Can be turned off by a toggle button on the browse page.</dd>
1707 <dt><span id="cfg_ModifyDeleteAtLeft">$cfg['ModifyDeleteAtLeft'] </span>boolean
1708 <span id="cfg_ModifyDeleteAtRight">$cfg['ModifyDeleteAtRight'] </span>boolean
1709 </dt>
1710 <dd>Defines the place where modify and delete links would be put when
1711 tables contents are displayed (you may have them displayed both at the
1712 left and at the right).
1713 &quot;Left&quot; and &quot;right&quot; are parsed as &quot;top&quot;
1714 and &quot;bottom&quot; with vertical display mode.</dd>
1716 <dt id="cfg_DefaultDisplay">$cfg['DefaultDisplay'] string
1717 <span id="cfg_HeaderFlipType">$cfg['HeaderFlipType'] </span>string
1718 </dt>
1719 <dd>There are 3 display modes: horizontal, horizontalflipped and vertical.
1720 Define which one is displayed by default. The first mode displays each
1721 row on a horizontal line, the second rotates the headers by 90
1722 degrees, so you can use descriptive headers even though fields only
1723 contain small values and still print them out. The vertical mode sorts
1724 each row on a vertical lineup.<br /><br />
1726 The HeaderFlipType can be set to 'css' or 'fake'. When using 'css'
1727 the rotation of the header for horizontalflipped is done via CSS. If
1728 set to 'fake' PHP does the transformation for you, but of course this
1729 does not look as good as CSS.</dd>
1731 <dt id="DefaultPropDisplay">
1732 <span id="cfg_DefaultPropDisplay">$cfg['DefaultPropDisplay']</span>
1733 string or integer</dt>
1734 <dd>When editing/creating new columns in a table all fields normally get
1735 lined up one field a line. (default: 'horizontal'). If you set this to
1736 'vertical' you can have each field lined up vertically beneath each
1737 other. You can save up a lot of place on the horizontal direction and
1738 no longer have to scroll. If you set this to integer, editing of fewer
1739 columns will appear in 'vertical' mode, while editing of more fields
1740 still in 'horizontal' mode. This way you can still effectively edit
1741 large number of fields, while having full view on few of them.</dd>
1743 <dt id="cfg_ShowBrowseComments">$cfg['ShowBrowseComments'] boolean<br />
1744 <span id="cfg_ShowPropertyComments">$cfg['ShowPropertyComments'] </span>boolean
1745 </dt>
1746 <dd>By setting the corresponding variable to <tt>TRUE</tt> you can enable the
1747 display of column comments in Browse or Property display. In browse
1748 mode, the comments are shown inside the header. In property mode,
1749 comments are displayed using a CSS-formatted dashed-line below the
1750 name of the field. The comment is shown as a tool-tip for that field.
1751 </dd>
1753 <dt id ="cfb_SQLQuery_Edit">$cfg['SQLQuery']['Edit'] boolean</dt>
1754 <dd>Whether to display an edit link to change a query in any SQL Query box.</dd>
1756 <dt id ="cfb_SQLQuery_Explain">$cfg['SQLQuery']['Explain'] boolean</dt>
1757 <dd>Whether to display a link to explain a SELECT query in any SQL Query box.</dd>
1759 <dt id ="cfb_SQLQuery_ShowAsPHP">$cfg['SQLQuery']['ShowAsPHP'] boolean</dt>
1760 <dd>Whether to display a link to wrap a query in PHP code in any SQL Query box.</dd>
1762 <dt id ="cfb_SQLQuery_Validate">$cfg['SQLQuery']['Validate'] boolean</dt>
1763 <dd>Whether to display a link to validate a query in any SQL Query box.
1764 See also <tt><a href="#cfg_SQLValidator">$cfg_SQLValidator</a></tt>.</dd>
1766 <dt id ="cfb_SQLQuery_Refresh">$cfg['SQLQuery']['Refresh'] boolean</dt>
1767 <dd>Whether to display a link to refresh a query in any SQL Query box.</dd>
1769 <dt id="cfg_UploadDir">$cfg['UploadDir'] string</dt>
1770 <dd>
1771 The name of the directory where
1772 <abbr title="structured query language">SQL</abbr> files have been
1773 uploaded by other means than phpMyAdmin (for example, ftp). Those files
1774 are available under a drop-down box when you click the database or
1775 table name, then the Import tab.
1776 <br /><br />
1778 If you want different directory for each user, %u will be replaced
1779 with username.<br /><br />
1781 Please note that the file names must have the suffix &quot;.sql&quot;
1782 (or &quot;.sql.bz2&quot; or &quot;.sql.gz&quot; if support for
1783 compressed formats is enabled).<br /><br />
1785 This feature is useful when your file is too big to be uploaded via
1786 <abbr title="HyperText Transfer Protocol">HTTP</abbr>, or when file
1787 uploads are disabled in PHP.<br /><br />
1789 Please note that if PHP is running in safe mode, this directory must
1790 be owned by the same user as the owner of the phpMyAdmin scripts.
1791 <br /><br />
1793 See also <a href="#faq1_16">
1794 <abbr title="Frequently Asked Questions">FAQ</abbr> 1.16</a> for
1795 alternatives.
1796 </dd>
1798 <dt id="cfg_SaveDir">$cfg['SaveDir'] string</dt>
1799 <dd>
1800 The name of the directory where dumps can be saved.<br /><br />
1802 If you want different directory for each user, %u will be replaced
1803 with username.<br /><br />
1805 Please note that the directory must exist and has to be writable for
1806 the user running webserver.<br /><br />
1808 Please note that if PHP is running in safe mode, this directory must
1809 be owned by the same user as the owner of the phpMyAdmin scripts.
1810 </dd>
1812 <dt id="cfg_TempDir">$cfg['TempDir'] string</dt>
1813 <dd>
1814 The name of the directory where temporary files can be stored.
1815 <br /><br />
1817 This is needed for native MS Excel export, see
1818 <a href="#faq6_23"><abbr title="Frequently Asked Questions">FAQ</abbr>
1819 6.23</a> and to work around limitations of
1820 <tt>open_basedir</tt> for uploaded
1821 files, see <a href="#faq1_11"><abbr title="Frequently Asked Questions">FAQ</abbr>
1822 1.11</a>.
1823 <br /><br />
1825 If the directory where phpMyAdmin is installed is subject to an
1826 <tt>open_basedir</tt> restriction, you need to create a
1827 temporary directory in some directory accessible by the web
1828 server. However for security reasons, this directory should be outside
1829 the tree published by webserver. If you cannot avoid having this
1830 directory published by webserver, place at least an empty
1831 <tt>index.html</tt> file there, so that directory listing is not
1832 possible.
1833 <br /><br />
1835 This directory should have as strict permissions as possible as the only
1836 user required to access this directory is the one who runs the
1837 webserver. If you have root privileges, simply make this user owner of
1838 this directory and make it accessible only by it:
1839 <br /><br />
1841 <pre>
1842 chown www-data:www-data tmp
1843 chmod 700 tmp
1844 </pre>
1846 If you cannot change owner of the directory, you can achieve a similar
1847 setup using <abbr title="Access Control List">ACL</abbr>:
1849 <pre>
1850 chmod 700 tmp
1851 setfacl -m "g:www-data:rwx" tmp
1852 setfacl -d -m "g:www-data:rwx" tmp
1853 </pre>
1855 If neither of above works for you, you can still make the directory
1856 <code>chmod 777</code>, but it might impose risk of other users on
1857 system reading and writing data in this directory.
1858 </dd>
1860 <dt id="cfg_Export">$cfg['Export'] array</dt>
1861 <dd>
1862 In this array are defined default parameters for export, names of
1863 items are similar to texts seen on export page, so you can easily
1864 identify what they mean.
1865 </dd>
1867 <dt id="cfg_Import">$cfg['Import'] array</dt>
1868 <dd>
1869 In this array are defined default parameters for import, names of
1870 items are similar to texts seen on import page, so you can easily
1871 identify what they mean.
1872 </dd>
1874 <dt id="cfg_RepeatCells">$cfg['RepeatCells'] integer</dt>
1875 <dd>
1876 Repeat the headers every X cells, or 0 to deactivate.
1877 </dd>
1879 <dt id="cfg_EditInWindow">$cfg['EditInWindow'] boolean<br />
1880 <span id="cfg_QueryWindowWidth">$cfg['QueryWindowWidth'] </span>integer<br />
1881 <span id="cfg_QueryWindowHeight">$cfg['QueryWindowHeight'] </span>integer<br />
1882 <span id="cfg_QueryHistoryDB">$cfg['QueryHistoryDB'] </span>boolean<br />
1883 <span id="cfg_QueryWindowDefTab">$cfg['QueryWindowDefTab'] </span>string<br />
1884 <span id="cfg_QueryHistoryMax">$cfg['QueryHistoryMax'] </span>integer
1885 </dt>
1886 <dd>
1887 All those variables affect the query window feature. A <tt><abbr title="structured query language">SQL</abbr></tt> link
1888 or icon is always displayed on the left panel. If JavaScript is enabled in
1889 your browser, a click on this opens a distinct query window, which is
1890 a direct interface to enter <abbr title="structured query language">SQL</abbr> queries. Otherwise, the right panel
1891 changes to display a query box.<br /><br />
1893 The size of this query window can be customized with
1894 <tt>$cfg['QueryWindowWidth']</tt> and <tt>$cfg['QueryWindowWidth']</tt>
1895 - both integers for the size in pixels. Note that normally, those
1896 parameters will be modified in <tt>layout.inc.php</tt> for the
1897 theme you are using.<br /><br />
1899 If <tt>$cfg['EditInWindow']</tt> is set to true, a click on [Edit]
1900 from the results page (in the &quot;Showing Rows&quot; section)
1901 opens the query window and puts the current query
1902 inside it. If set to false, clicking on the link puts the <abbr title="structured query language">SQL</abbr>
1903 query in the right panel's query box.
1904 <br /><br />
1905 The usage of the JavaScript query window is recommended if you have a
1906 JavaScript enabled browser. Basic functions are used to exchange quite
1907 a few variables, so most 4th generation browsers should be capable to
1908 use that feature. It currently is only tested with Internet Explorer 6
1909 and Mozilla 1.x.
1910 <br /><br />
1911 If <tt>$cfg['QueryHistoryDB']</tt> is set to <tt>TRUE</tt>, all your Queries are logged
1912 to a table, which has to be created by you (see <a
1913 href="#history" class="configrule">$cfg['Servers'][$i]['history']</a>). If set to FALSE,
1914 all your queries will be appended to the form, but only as long as
1915 your window is opened they remain saved.
1916 <br /><br />
1917 When using the JavaScript based query window, it will always get
1918 updated when you click on a new table/db to browse and will focus if
1919 you click on "Edit <abbr title="structured query language">SQL</abbr>" after using a query. You can suppress updating
1920 the query window by checking the box "Do not overwrite this query from
1921 outside the window" below the query textarea. Then you can browse
1922 tables/databases in the background without losing the contents of the
1923 textarea, so this is especially useful when composing a query with
1924 tables you first have to look in. The checkbox will get automatically
1925 checked whenever you change the contents of the textarea. Please
1926 uncheck the button whenever you definitely want the query window to
1927 get updated even though you have made alterations.
1928 <br /><br />
1929 If <tt>$cfg['QueryHistoryDB']</tt> is set to <tt>TRUE</tt> you can specify the amount of
1930 saved history items using <tt>$cfg['QueryHistoryMax']</tt>.
1931 <br /><br />
1932 The query window also has a custom tabbed look to group the features.
1933 Using the variable <tt>$cfg['QueryWindowDefTab']</tt> you can specify the
1934 default tab to be used when opening the query window. It can be set to
1935 either 'sql', 'files', 'history' or 'full'.</dd>
1937 <dt id="cfg_BrowseMIME">$cfg['BrowseMIME'] boolean</dt>
1938 <dd>Enable <a href="#transformations">MIME-transformations</a>.</dd>
1940 <dt id="cfg_MaxExactCount">$cfg['MaxExactCount'] integer</dt>
1941 <dd>For InnoDB tables, determines for how large tables phpMyAdmin
1942 should get the exact row count using <code>SELECT COUNT</code>.
1943 If the approximate row count as returned by
1944 <code>SHOW TABLE STATUS</code> is smaller than this value,
1945 <code>SELECT COUNT</code> will be used, otherwise the approximate
1946 count will be used.
1947 </dd>
1948 <dt id="cfg_MaxExactCountViews">$cfg['MaxExactCountViews'] integer</dt>
1949 <dd>For VIEWs, since obtaining the exact count could have an
1950 impact on performance, this value is the maximum to be displayed, using
1951 a <code>SELECT COUNT ... LIMIT</code>. The default value of 0 bypasses
1952 any row counting.
1953 </dd>
1955 <dt id="wysiwyg">
1956 <span id="cfg_WYSIWYG-PDF">$cfg['WYSIWYG-PDF'] </span>boolean</dt>
1957 <dd>Utilizes a WYSIWYG editing control to easily place elements of a
1958 <abbr title="Portable Document Format">PDF</abbr>
1959 page. By clicking on the button 'toggle scratchboard' on the page
1960 where you edit x/y coordinates of those elements you can activate a
1961 scratchboard where all your elements are placed. By clicking on an
1962 element, you can move them around in the pre-defined area and the x/y
1963 coordinates will get updated dynamically. Likewise, when entering a
1964 new position directly into the input field, the new position in the
1965 scratchboard changes after your cursor leaves the input field.<br />
1966 You have to click on the 'OK'-button below the tables to save the new
1967 positions. If you want to place a new element, first add it to the
1968 table of elements and then you can drag the new element around.<br />
1969 By changing the paper size and the orientation you can change the size
1970 of the scratchboard as well. You can do so by just changing the
1971 dropdown field below, and the scratchboard will resize automatically,
1972 without interfering with the current placement of the elements.<br />
1973 If ever an element gets out of range you can either enlarge the paper
1974 size or click on the 'reset' button to place all elements below each
1975 other.<br />
1976 <b>NOTE:</b> You have to use a recent browser like IE6 or Mozilla to
1977 get this control to work. The basic Drag&amp;Drop script functionality
1978 was kindly borrowed from www.youngpup.net and is underlying so
1979 specific license.</dd>
1981 <dt id="cfg_NaturalOrder">$cfg['NaturalOrder'] boolean</dt>
1982 <dd>Sorts database and table names according to natural order (for example,
1983 t1, t2, t10). Currently implemented in the left panel (Light mode)
1984 and in Database view, for the table list.</dd>
1986 <dt id="cfg_InitialSlidersState">$cfg['InitialSlidersState'] string</dt>
1987 <dd>If set to <tt>'closed'</tt>, the visual sliders are initially in a
1988 closed state. A value of 'open' does the reverse.</dd>
1990 <dt id="cfg_TitleTable">$cfg['TitleTable'] string</dt>
1991 <dt id="cfg_TitleDatabase">$cfg['TitleDatabase'] string</dt>
1992 <dt id="cfg_TitleServer">$cfg['TitleServer'] string</dt>
1993 <dt id="cfg_TitleDefault">$cfg['TitleDefault'] string</dt>
1994 <dd>Allows you to specify window's title bar. Following magic string can
1995 be used to get special values:
1996 <dl>
1997 <dt><code>@HTTP_HOST@</code></dt>
1998 <dd>HTTP host that runs phpMyAdmin</dd>
1999 <dt><code>@SERVER@</code></dt>
2000 <dd>MySQL server name</dd>
2001 <dt><code>@VERBOSE@</code></dt>
2002 <dd>Verbose MySQL server name as defined in <a href="#cfg_Servers_verbose">server configuration</a></dd>
2003 <dt><code>@VSERVER@</code></dt>
2004 <dd>Verbose MySQL server name if set, otherwise normal</dd>
2005 <dt><code>@DATABASE@</code></dt>
2006 <dd>Currently opened database</dd>
2007 <dt><code>@TABLE@</code></dt>
2008 <dd>Currently opened table</dd>
2009 <dt><code>@PHPMYADMIN@</code></dt>
2010 <dd>phpMyAdmin with version</dd>
2011 </dl>
2012 </dd>
2014 <dt id="cfg_ErrorIconic">$cfg['ErrorIconic'] boolean</dt>
2015 <dd>Uses icons for warnings, errors and informations.</dd>
2017 <dt id="cfg_MainPageIconic">$cfg['MainPageIconic'] boolean</dt>
2018 <dd>Uses icons on main page in lists and menu tabs.</dd>
2020 <dt id="cfg_ReplaceHelpImg">$cfg['ReplaceHelpImg'] boolean</dt>
2021 <dd>Shows a help button instead of the &quot;Documentation&quot; message.
2022 </dd>
2024 <dt id="cfg_ThemePath">$cfg['ThemePath'] string</dt>
2025 <dd>If theme manager is active, use this as the path of the subdirectory
2026 containing all the themes.</dd>
2028 <dt id="cfg_ThemeManager">$cfg['ThemeManager'] boolean</dt>
2029 <dd>Enables user-selectable themes. See <a href="#faqthemes">
2030 <abbr title="Frequently Asked Questions">FAQ</abbr> 2.7</a>.</dd>
2032 <dt id="cfg_ThemeDefault">$cfg['ThemeDefault'] string</dt>
2033 <dd>The default theme (a subdirectory under <tt>cfg['ThemePath']</tt>).</dd>
2035 <dt id="cfg_ThemePerServer">$cfg['ThemePerServer'] boolean</dt>
2036 <dd>Whether to allow different theme for each server.</dd>
2038 <dt id="cfg_DefaultQueryTable">$cfg['DefaultQueryTable'] string<br />
2039 <span id="cfg_DefaultQueryDatabase">$cfg['DefaultQueryDatabase']</span> string
2040 </dt>
2041 <dd>Default queries that will be displayed in query boxes when user didn't
2042 specify any. Use %d for database name, %t for table name and %f for a
2043 comma separated list of field names. Note that %t and %f are only
2044 applicable to <tt>$cfg['DefaultQueryTable']</tt>.</dd>
2046 <dt id="cfg_SQP_fmtType">$cfg['SQP']['fmtType'] string [<tt>html</tt>|<tt>none</tt>]</dt>
2047 <dd>
2048 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
2049 default we use HTML to format the query, but you can disable this by
2050 setting this variable to <tt>'none'</tt>.
2051 </dd>
2053 <dt id="cfg_SQP_fmtInd">$cfg['SQP']['fmtInd'] float<br />
2054 <span id="cfg_SQP">$cfg['SQP']['fmtIndUnit']</span> string [<tt>em</tt>|<tt>px</tt>|<tt>pt</tt>|<tt>ex</tt>]</dt>
2055 <dd>For the pretty-printing of <abbr title="structured query language">SQL</abbr> queries, under some cases the part of a
2056 query inside a bracket is indented. By changing
2057 <tt>$cfg['SQP']['fmtInd']</tt> you can change the amount of this indent.
2058 <br />Related in purpose is <tt>$cfg['SQP']['fmtIndUnit']</tt> which
2059 specifies the units of the indent amount that you specified. This is
2060 used via stylesheets.</dd>
2062 <dt id="cfg_SQP_fmtColor">$cfg['SQP']['fmtColor'] array of string tuples</dt>
2063 <dd>This array is used to define the colours for each type of element of
2064 the pretty-printed <abbr title="structured query language">SQL</abbr> queries. The tuple format is<br />
2065 <i>class</i> =&gt; [<i>HTML colour code</i> | <i>empty string</i>]<br />
2066 If you specify an empty string for the color of a class, it is ignored
2067 in creating the stylesheet.
2068 You should not alter the class names, only the colour strings.<br />
2069 <b>Class name key:</b>
2070 <ul><li><b>comment</b> Applies to all comment sub-classes</li>
2071 <li><b>comment_mysql</b> Comments as <tt>"#...\n"</tt></li>
2072 <li><b>comment_ansi</b> Comments as <tt>"-- ...\n"</tt></li>
2073 <li><b>comment_c</b> Comments as <tt>"/*...*/"</tt></li>
2074 <li><b>digit</b> Applies to all digit sub-classes</li>
2075 <li><b>digit_hex</b> Hexadecimal numbers</li>
2076 <li><b>digit_integer</b> Integer numbers</li>
2077 <li><b>digit_float</b> Floating point numbers</li>
2078 <li><b>punct</b> Applies to all punctuation sub-classes</li>
2079 <li><b>punct_bracket_open_round</b> Opening brackets<tt>"("</tt></li>
2080 <li><b>punct_bracket_close_round</b> Closing brackets <tt>")"</tt></li>
2081 <li><b>punct_listsep</b> List item Separator <tt>","</tt></li>
2082 <li><b>punct_qualifier</b> Table/Column Qualifier <tt>"."</tt> </li>
2083 <li><b>punct_queryend</b> End of query marker <tt>";"</tt></li>
2084 <li><b>alpha</b> Applies to all alphabetic classes</li>
2085 <li><b>alpha_columnType</b> Identifiers matching a column type</li>
2086 <li><b>alpha_columnAttrib</b> Identifiers matching a database/table/column attribute</li>
2087 <li><b>alpha_functionName</b> Identifiers matching a MySQL function name</li>
2088 <li><b>alpha_reservedWord</b> Identifiers matching any other reserved word</li>
2089 <li><b>alpha_variable</b> Identifiers matching a <abbr title="structured query language">SQL</abbr> variable <tt>"@foo"</tt></li>
2090 <li><b>alpha_identifier</b> All other identifiers</li>
2091 <li><b>quote</b> Applies to all quotation mark classes</li>
2092 <li><b>quote_double</b> Double quotes <tt>"</tt></li>
2093 <li><b>quote_single</b> Single quotes <tt>'</tt></li>
2094 <li><b>quote_backtick</b> Backtick quotes <tt>`</tt></li>
2095 </ul>
2096 </dd>
2098 <dt id="cfg_SQLValidator">$cfg['SQLValidator'] boolean</dt>
2099 <dd><dl><dt id="cfg_SQLValidator_use">$cfg['SQLValidator']['use'] boolean</dt>
2100 <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,
2101 as originally published on
2102 <a href="http://developers.slashdot.org/article.pl?sid=02/02/19/1720246">Slashdot</a>.
2103 <br />
2104 For help in setting up your system to use the service, see the
2105 <a href="#faqsqlvalidator"><abbr title="Frequently Asked Questions">FAQ</abbr> 6.14</a>.
2106 </dd>
2108 <dt id="cfg_SQLValidator_username">$cfg['SQLValidator']['username'] string<br />
2109 <span id="cfg_SQLValidator_password">$cfg['SQLValidator']['password']</span> string</dt>
2110 <dd>The SOAP service allows you to log in with <tt>anonymous</tt>
2111 and any password, so we use those by default. Instead, if
2112 you have an account with them, you can put your login details
2113 here, and it will be used in place of the anonymous login.</dd>
2114 </dl>
2115 </dd>
2117 <dt id="cfg_DBG">$cfg['DBG']</dt>
2118 <dd><b>DEVELOPERS ONLY!</b></dd>
2120 <dt id="cfg_DBG_enable_sql">$cfg['DBG']['sql'] boolean</dt>
2121 <dd><b>DEVELOPERS ONLY!</b><br />
2122 Enable logging queries and execution times to be displayed in the bottom
2123 of main page (right frame).</dd>
2125 <dt id="cfg_DBG_enable_php">$cfg['DBG']['php'] boolean</dt>
2126 <dd><b>DEVELOPERS ONLY!</b><br />
2127 Enable the DBG extension for debugging phpMyAdmin. Required for profiling
2128 the code.<br />
2129 For help in setting up your system to this, see the
2130 <a href="#developersdbg">Developers</a> section.</dd>
2132 <dt id="cfg_DBG_profile_enable">$cfg['DBG']['profile']['enable'] boolean</dt>
2133 <dd><b>DEVELOPERS ONLY!</b><br />
2134 Enable profiling support for phpMyAdmin. This will append a chunk of data
2135 to the end of every page displayed in the main window with profiling
2136 statistics for that page.<br />
2137 You may need to increase the maximum execution time for this to
2138 complete successfully.<i>Profiling was removed from the code for
2139 version 2.9.0 due to licensing issues.</i></dd>
2141 <dt id="cfg_DBG_profile_threshold">$cfg['DBG']['profile']['threshold'] float (units in milliseconds)</dt>
2142 <dd><b>DEVELOPERS ONLY!</b><br />
2143 When profiling data is displayed, this variable controls the threshold of
2144 display for any profiling data, based on the average time each time has
2145 taken. If it is over the threshold it is displayed, otherwise it is not
2146 displayed. This takes a value in milliseconds. In most cases you don't need
2147 to edit this.</dd>
2149 <dt id="cfg_ColumnTypes">$cfg['ColumnTypes'] array</dt>
2150 <dd>All possible types of a MySQL column. In most cases you don't need to
2151 edit this.</dd>
2153 <dt id="cfg_AttributeTypes">$cfg['AttributeTypes'] array</dt>
2154 <dd>Possible attributes for fields. In most cases you don't need to edit
2155 this.</dd>
2157 <dt id="cfg_Functions">$cfg['Functions'] array</dt>
2158 <dd>A list of functions MySQL supports. In most cases you don't need to
2159 edit this.</dd>
2161 <dt id="cfg_RestrictColumnTypes">$cfg['RestrictColumnTypes'] array</dt>
2162 <dd>Mapping of column types to meta types used for preferring displayed
2163 functions. In most cases you don't need to edit this.</dd>
2165 <dt id="cfg_RestrictFunctions">$cfg['RestrictFunctions'] array</dt>
2166 <dd>Functions preferred for column meta types as defined in
2167 <a href="#cfg_RestrictColumnTypes" class="configrule">$cfg['RestrictColumnTypes']</a>. In most cases you don't need
2168 to edit this.</dd>
2170 <dt id="cfg_DefaultFunctions">$cfg['DefaultFunctions'] array</dt>
2171 <dd>Functions selected by default when inserting/changing row, Functions
2172 are defined for meta types from
2173 <a href="#cfg_RestrictColumnTypes" class="configrule">$cfg['RestrictColumnTypes']</a> and for
2174 <code>first_timestamp</code>, which is used for first timestamp column
2175 in table.</dd>
2177 <dt id="cfg_NumOperators">$cfg['NumOperators'] array</dt>
2178 <dd>Operators available for search operations on numeric and date fields.
2179 </dd>
2181 <dt id="cfg_TextOperators">$cfg['TextOperators'] array</dt>
2182 <dd>Operators available for search operations on character fields.
2183 Note that we put <code>LIKE</code> by default instead of
2184 <code>LIKE %...%</code>, to avoid unintended performance problems
2185 in case of huge tables.</dd>
2187 <dt id="cfg_EnumOperators">$cfg['EnumOperators'] array</dt>
2188 <dd>Operators available for search operations on enum fields.</dd>
2190 <dt id="cfg_NullOperators">$cfg['NullOperators'] array</dt>
2191 <dd>Additional operators available for search operations when the
2192 field can be null.</dd>
2194 </dl>
2196 <!-- TRANSFORMATIONS -->
2197 <h2 id="transformations">Transformations</h2>
2199 <ol><li><a href="#transformationsintro">Introduction</a></li>
2200 <li><a href="#transformationshowto">Usage</a></li>
2201 <li><a href="#transformationsfiles">File structure</a></li>
2202 </ol>
2204 <h3 id="transformationsintro">1. Introduction</h3>
2206 <p> To enable transformations, you have to setup the <tt>column_info</tt> table
2207 and the proper directives. Please see the <a href="#config">Configuration
2208 section</a> on how to do so.</p>
2210 <p> You can apply different transformations to the contents of each field. The
2211 transformation will take the content of each field and transform it with
2212 certain rules defined in the selected transformation.</p>
2214 <p> Say you have a field 'filename' which contains a filename. Normally you would
2215 see in phpMyAdmin only this filename. Using transformations you can transform
2216 that filename into a HTML link, so you can click inside of the phpMyAdmin
2217 structure on the field's link and will see the file displayed in a new browser
2218 window. Using transformation options you can also specify strings to
2219 append/prepend to a string or the format you want the output stored in.</p>
2221 <p> For a general overview of all available transformations and their options,
2222 you can consult your
2223 <i>&lt;www.your-host.com&gt;/&lt;your-install-dir&gt;/transformation_overview.php</i>
2224 installation.</p>
2226 <p> For a tutorial on how to effectively use transformations, see our
2227 <a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a> on
2228 the official phpMyAdmin homepage.</p>
2230 <h3 id="transformationshowto">2. Usage</h3>
2232 <p> Go to your <i>tbl_structure.php</i> page (i.e. reached through
2233 clicking on the 'Structure' link for a table). There click on
2234 &quot;Change&quot; (or change icon) and there you will see three new fields at
2235 the end of the line. They are called 'MIME-type', 'Browser transformation' and
2236 'Transformation options'.</p>
2238 <ul><li>The field 'MIME-type' is a drop-down field. Select the MIME-type
2239 that corresponds to the column's contents. Please note that
2240 transformations are inactive as long as no MIME-type is selected.</li>
2242 <li>The field 'Browser transformation' is a drop-down field. You can choose from a
2243 hopefully growing amount of pre-defined transformations. See below for information on
2244 how to build your own transformation.<br />
2246 There are global transformations and mimetype-bound transformations. Global transformations
2247 can be used for any mimetype. They will take the mimetype, if necessary, into regard.
2248 Mimetype-bound transformations usually only operate on a certain mimetype. There are
2249 transformations which operate on the main mimetype (like 'image'), which will most likely
2250 take the subtype into regard, and those who only operate on a
2251 specific subtype (like 'image/jpeg').<br />
2253 You can use transformations on mimetypes for which the function was not defined for. There
2254 is no security check for you selected the right transformation, so take care of what the
2255 output will be like.</li>
2257 <li>The field 'Transformation options' is a free-type textfield. You have to enter
2258 transform-function specific options here. Usually the transforms can operate with default
2259 options, but it is generally a good idea to look up the overview to see which options are
2260 necessary.<br />
2262 Much like the ENUM/SET-Fields, you have to split up several options using the format
2263 'a','b','c',...(NOTE THE MISSING BLANKS). This is because internally the options will be
2264 parsed as an array, leaving the first value the first element in the array, and so
2265 forth.<br />
2267 If you want to specify a MIME character set you can define it in the transformation_options.
2268 You have to put that outside of the pre-defined options of the specific mime-transform,
2269 as the last value of the set. Use the format "'; charset=XXX'". If you use a transform,
2270 for which you can specify 2 options and you want to append a character set, enter "'first
2271 parameter','second parameter','charset=us-ascii'". You can, however use the defaults for
2272 the parameters: "'','','charset=us-ascii'".</li>
2273 </ul>
2275 <h3 id="transformationsfiles">3. File structure</h3>
2277 <p> All mimetypes and their transformations are defined through single files in
2278 the directory 'libraries/transformations/'.</p>
2280 <p> They are stored in files to ease up customization and easy adding of new
2281 transformations.</p>
2283 <p> Because the user cannot enter own mimetypes, it is kept sure that transformations
2284 always work. It makes no sense to apply a transformation to a mimetype, the
2285 transform-function doesn't know to handle.</p>
2287 <p> One can, however, use empty mime-types and global transformations which should work
2288 for many mimetypes. You can also use transforms on a different mimetype they where built
2289 for, but pay attention to option usage as well as what the transformation does to your
2290 field.</p>
2292 <p> There is a basic file called '<i>global.inc.php</i>'. This function can be included by
2293 any other transform function and provides some basic functions.</p>
2295 <p> There are 5 possible file names:</p>
2297 <ol><li>A mimetype+subtype transform:<br /><br />
2299 <tt>[mimetype]_[subtype]__[transform].inc.php</tt><br /><br />
2301 Please not that mimetype and subtype are separated via '_', which shall
2302 not be contained in their names. The transform function/filename may
2303 contain only characters which cause no problems in the file system as
2304 well as the PHP function naming convention.<br /><br />
2306 The transform function will the be called
2307 '<tt>PMA_transform_[mimetype]_[subtype]__[transform]()</tt>'.<br /><br />
2309 <b>Example:</b><br /><br />
2311 <tt>text_html__formatted.inc.php</tt><br />
2312 <tt>PMA_transform_text_html__formatted()</tt></li>
2314 <li>A mimetype (w/o subtype) transform:<br /><br />
2316 <tt>[mimetype]__[transform].inc.php</tt><br /><br />
2318 Please note that there are no single '_' characters.
2319 The transform function/filename may contain only characters which cause
2320 no problems in the file system as well as the PHP function naming
2321 convention.<br /><br />
2323 The transform function will the be called
2324 '<tt>PMA_transform_[mimetype]__[transform]()</tt>'.<br /><br />
2326 <b>Example:</b><br /><br />
2328 <tt>text__formatted.inc.php</tt><br />
2329 <tt>PMA_transform_text__formatted()</tt></li>
2331 <li>A mimetype+subtype without specific transform function<br /><br />
2333 <tt>[mimetype]_[subtype].inc.php</tt><br /><br />
2335 Please note that there are no '__' characters in the filename. Do not
2336 use special characters in the filename causing problems with the file
2337 system.<br /><br />
2339 No transformation function is defined in the file itself.<br /><br />
2341 <b>Example:</b><br /><br />
2343 <tt>text_plain.inc.php</tt><br />
2344 (No function)</li>
2346 <li>A mimetype (w/o subtype) without specific transform function<br /><br />
2348 <tt>[mimetype].inc.php</tt><br /><br />
2350 Please note that there are no '_' characters in the filename. Do not use
2351 special characters in the filename causing problems with the file system.
2352 <br /><br />
2354 No transformation function is defined in the file itself.<br /><br />
2356 <b>Example:</b><br /><br />
2358 <tt>text.inc.php</tt><br />
2359 (No function)</li>
2361 <li>A global transform function with no specific mimetype<br /><br />
2363 <tt>global__[transform].inc.php</tt><br /><br />
2365 The transform function will the be called
2366 '<tt>PMA_transform_global__[transform]()</tt>'.<br /><br />
2368 <b>Example:</b><br /><br />
2370 <tt>global__formatted</tt><br />
2371 <tt>PMA_transform_global__formatted()</tt></li>
2372 </ol>
2374 <p> So generally use '_' to split up mimetype and subtype, and '__' to provide a
2375 transform function.</p>
2377 <p> All filenames containing no '__' in themselves are not shown as valid transform
2378 functions in the dropdown.</p>
2380 <p> Please see the libraries/transformations/TEMPLATE file for adding your own transform
2381 function. See the libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
2382 without a transform function. Also note the introduction of a function description in
2383 the language files. For each function a $strTransformation_[filename without .inc.php]
2384 has to exist.</p>
2386 <p> You can use the template generator to generate new functions and entries in the
2387 language file.</p>
2389 <p> To create a new transform function please see
2390 <tt>libraries/transformations/template_generator.sh</tt>.
2391 To create a new, empty mimetype please see
2392 <tt>libraries/transformations/template_generator_mimetype.sh</tt>.</p>
2394 <p> A transform function always gets passed three variables:</p>
2396 <ol><li><b>$buffer</b> - Contains the text inside of the column. This is the text,
2397 you want to transform.</li>
2398 <li><b>$options</b> - Contains any user-passed options to a transform function
2399 as an array.</li>
2400 <li><b>$meta</b> - Contains an object with field information to your column.
2401 The data is drawn from the output of the
2402 <a href="http://www.php.net/mysql_fetch_field">mysql_fetch_field()</a>
2403 function. This means, all object properties described on the
2404 <a href="http://www.php.net/mysql_fetch_field">manual page</a> are
2405 available in this variable and can be used to transform a field accordingly
2406 to unsigned/zerofill/not_null/... properties.<br />
2407 The $meta-&gt;mimetype variable contains the original MIME-type of the
2408 field (i.e. 'text/plain', 'image/jpeg' etc.)</li>
2409 </ol>
2411 <!-- FAQ -->
2412 <h2 id="faq">FAQ - Frequently Asked Questions</h2>
2414 <ol><li><a href="#faqserver">Server</a></li>
2415 <li><a href="#faqconfig">Configuration</a></li>
2416 <li><a href="#faqlimitations">Known limitations</a></li>
2417 <li><a href="#faqmultiuser">ISPs, multi-user installations</a></li>
2418 <li><a href="#faqbrowsers">Browsers or client <abbr title="operating system">OS</abbr></a></li>
2419 <li><a href="#faqusing">Using phpMyAdmin</a></li>
2420 <li><a href="#faqproject">phpMyAdmin project</a></li>
2421 <li><a href="#faqsecurity">Security</a></li>
2422 </ol>
2424 <p> Please have a look at our
2425 <a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a> on
2426 the official phpMyAdmin homepage for in-depth coverage of phpMyAdmin's
2427 features and or interface.</p>
2429 <h3 id="faqserver">Server</h3>
2431 <h4 id="faq1_1">
2432 <a href="#faq1_1">1.1 I'm running PHP 4+ and my server is crashing each time a specific
2433 action is required or phpMyAdmin sends a blank page or a page full of
2434 cryptic characters to my browser, what can I do?</a></h4>
2436 <p> There are some known PHP bugs with output buffering and compression.<br />
2437 Try to set the <a href="#cfg_OBGzip" class="configrule">$cfg['OBGzip']</a>
2438 directive to <tt>FALSE</tt> in your <i>config.inc.php</i> file and the
2439 <tt>zlib.output_compression</tt> directive to <tt>Off</tt> in your php
2440 configuration file.<br />
2441 Furthermore, we know about such problems connected to the release
2442 candidates of PHP 4.2.0 (tested with PHP 4.2.0 RC1 to RC4) together with
2443 MS Internet Explorer. Please upgrade to the release version PHP 4.2.0.</p>
2445 <h4 id="faq1_2">
2446 <a href="#faq1_2">1.2 My Apache server crashes when using phpMyAdmin.</a></h4>
2448 <p> You should first try the latest versions of Apache (and possibly MySQL).<br />
2449 See also the
2450 <a href="#faq1_1"><abbr title="Frequently Asked Questions">FAQ</abbr> 1.1</a>
2451 entry about PHP bugs with output buffering.<br />
2452 If your server keeps crashing, please ask for help in the various Apache
2453 support groups.</p>
2455 <h4 id="faq1_3">
2456 <a href="#faq1_3">1.3 I'm running phpMyAdmin with "cookie" authentication
2457 mode under PHP 4.2.0 or 4.2.1 loaded as an Apache 2 module but can't enter the
2458 script: I'm always displayed the login screen.</a></h4>
2460 <p> This is a known PHP bug (see this
2461 <a href="http://bugs.php.net/bug.php?id=16626">bug report</a>) from the
2462 official PHP bug database. It means there is and won't be any phpMyAdmin
2463 fix against it because there is no way to code a fix.</p>
2465 <h4 id="faq1_4">
2466 <a href="#faq1_4">1.4 Using phpMyAdmin on
2467 <abbr title="Internet Information Services">IIS</abbr>, I'm displayed the
2468 error message: &quot;The specified <abbr title="Common Gateway Interface">CGI</abbr>
2469 application misbehaved by not returning a complete set of
2470 <abbr title="HyperText Transfer Protocol">HTTP</abbr> headers ...&quot;.</a>
2471 </h4>
2473 <p> You just forgot to read the <i>install.txt</i> file from the php distribution.
2474 Have a look at the last message in this
2475 <a href="http://bugs.php.net/bug.php?id=12061">bug report</a> from the
2476 official PHP bug database.</p>
2478 <h4 id="faq1_5">
2479 <a href="#faq1_5">1.5 Using phpMyAdmin on
2480 <abbr title="Internet Information Services">IIS</abbr>, I'm facing crashes
2481 and/or many error messages with the
2482 <abbr title="HyperText Transfer Protocol">HTTP</abbr> or advanced authentication
2483 mode.</a></h4>
2485 <p> This is a known problem with the PHP
2486 <abbr title="Internet Server Application Programming Interface">ISAPI</abbr>
2487 filter: it's not so stable. Please use instead the cookie authentication mode.
2488 </p>
2490 <h4 id="faq1_6">
2491 <a href="#faq1_6">1.6 I can't use phpMyAdmin on PWS: nothing is displayed!</a></h4>
2493 <p> This seems to be a PWS bug. Filippo Simoncini found a workaround (at this
2494 time there is no better fix): remove or comment the <tt>DOCTYPE</tt>
2495 declarations (2 lines) from the scripts <i>libraries/header.inc.php</i>,
2496 <i>libraries/header_printview.inc.php</i>, <i>index.php</i>,
2497 <i>navigation.php</i> and <i>libraries/common.lib.php</i>.</p>
2499 <h4 id="faq1_7">
2500 <a href="#faq1_7">1.7 How can I GZip or Bzip a dump or a
2501 <abbr title="comma separated values">CSV</abbr> export? It does not seem to
2502 work.</a></h4>
2504 <p> These features are based on the <tt>gzencode()</tt> and <tt>bzcompress()</tt>
2505 PHP functions to be more independent of the platform (Unix/Windows, Safe Mode
2506 or not, and so on). So, you must have PHP4&nbsp;&gt;=&nbsp;4.0.4 and Zlib/Bzip2
2507 support (<tt>--with-zlib</tt> and <tt>--with-bz2</tt>).<br />
2508 We faced PHP crashes when trying to download a dump with MS Internet
2509 Explorer when phpMyAdmin is run with a release candidate of PHP 4.2.0. In
2510 this case you should switch to the release version of PHP 4.2.0.</p>
2512 <h4 id="faq1_8">
2513 <a href="#faq1_8">1.8 I cannot insert a text file in a table, and I get
2514 an error about safe mode being in effect.</a></h4>
2516 <p> Your uploaded file is saved by PHP in the &quot;upload dir&quot;, as
2517 defined in <i>php.ini</i> by the variable <tt>upload_tmp_dir</tt> (usually
2518 the system default is <i>/tmp</i>).<br />
2519 We recommend the following setup for Apache servers running in safe mode,
2520 to enable uploads of files while being reasonably secure:</p>
2522 <ul><li>create a separate directory for uploads: <tt>mkdir /tmp/php</tt></li>
2523 <li>give ownership to the Apache server's user.group:
2524 <tt>chown apache.apache /tmp/php</tt></li>
2525 <li>give proper permission: <tt>chmod 600 /tmp/php</tt></li>
2526 <li>put <tt>upload_tmp_dir = /tmp/php</tt> in <i>php.ini</i></li>
2527 <li>restart Apache</li>
2528 </ul>
2530 <h4 id="faq1_9">
2531 <a href="#faq1_9">1.9 I'm having troubles when uploading files. In
2532 general file uploads don't work on my system and uploaded files have a
2533 <tt>Content-Type:</tt> header in the first line.</a></h4>
2535 <p> It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat 7.0
2536 and you updated your PHP RPM to php-4.0.4pl1-3.i386.rpm, didn't you?<br />
2537 So the problem is that this package has a serious bug that was corrected
2538 ages ago in PHP (2001-01-28: see
2539 <a href="http://www.php.net/bugs.php?id=8966">PHP's bug tracking system</a>
2540 for more details). The problem is that the bugged package is still
2541 available though it was corrected (see
2542 <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=24933">RedHat's BugZilla</a>
2543 for more details).<br />
2544 So please download
2545 <a href="http://www.redhat.com/swr/i386/php-4.0.4pl1-9.i386.html">the fixed package (4.0.4pl1-9)</a>
2546 and the problem should go away.<br />
2547 And that fixes the \r\n problem with file uploads!</p>
2549 <h4 id="faq1_10">
2550 <a href="#faq1_10">1.10 I'm having troubles when uploading files with
2551 phpMyAdmin running on a secure server. My browser is Internet Explorer and
2552 I'm using the Apache server.</a></h4>
2554 <p> As suggested by &quot;Rob M&quot; in the phpWizard forum, add this line to
2555 your <i>httpd.conf</i>:</p>
2557 <pre>SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown</pre>
2559 <p> It seems to clear up many problems between Internet Explorer and SSL.</p>
2561 <h4 id="faq1_11">
2562 <a href="#faq1_11">1.11 I get an 'open_basedir restriction' while
2563 uploading a file from the query box.</a></h4>
2565 <p> Since version 2.2.4, phpMyAdmin supports servers with open_basedir
2566 restrictions. However you need to create temporary directory and
2567 configure it as <a href="#cfg_TempDir" class="configrule">$cfg['TempDir']</a>.
2568 The uploaded files will be moved there, and after execution of your
2569 <abbr title="structured query language">SQL</abbr> commands, removed.</p>
2571 <h4 id="faq1_12">
2572 <a href="#faq1_12">1.12 I have lost my MySQL root password, what can I do?</a></h4>
2574 <p> The MySQL manual explains how to
2575 <a href="http://www.mysql.com/doc/R/e/Resetting_permissions.html">
2576 reset the permissions</a>.</p>
2578 <h4 id="faq1_13">
2579 <a href="#faq1_13">1.13 I get an error 'No
2580 <abbr title="structured query language">SQL</abbr> query' when trying to
2581 execute a bookmark.</a></h4>
2583 <p> If PHP does not have read/write access to its <tt>upload_tmp_dir</tt>, it
2584 cannot access the uploaded query.</p>
2586 <h4 id="faq1_14">
2587 <a href="#faq1_14">1.14 I get an error 'No
2588 <abbr title="structured query language">SQL</abbr> query' when trying to
2589 submit a query from the convenient text area.</a></h4>
2591 <p> Check the <tt>post_max_size</tt> directive from your PHP configuration file
2592 and try to increase it.</p>
2594 <h4 id="faq1_15">
2595 <a href="#faq1_15">1.15 I have problems with <i>mysql.user</i> field names.</a>
2596 </h4>
2598 <p> In previous MySQL versions, the <tt>User</tt> and <tt>Password</tt> fields
2599 were named <tt>user</tt> and <tt>password</tt>. Please modify your field
2600 names to align with current standards.</p>
2602 <h4 id="faq1_16">
2603 <a href="#faq1_16">1.16 I cannot upload big dump files (memory,
2604 <abbr title="HyperText Transfer Protocol">HTTP</abbr> or timeout problems).</a>
2605 </h4>
2607 <p> Starting with version 2.7.0, the import engine has been re&#8211;written and these
2608 problems should not occur. If possible, upgrade your phpMyAdmin to the latest version
2609 to take advantage of the new import features.</p>
2611 <p> The first things to check (or ask your host provider to check) are the
2612 values of <tt>upload_max_filesize</tt>, <tt>memory_limit</tt> and
2613 <tt>post_max_size</tt> in the <i>php.ini</i> configuration file.
2614 All of these three settings limit the maximum size of data that can be
2615 submitted and handled by PHP. One user also said that post_max_size
2616 and memory_limit need to be larger than upload_max_filesize.<br /> <br />
2618 There exist several workarounds if your upload is too big or your
2619 hosting provider is unwilling to change the settings:</p>
2621 <ul><li>Look at the <a href="#cfg_UploadDir" class="configrule">$cfg['UploadDir']</a>
2622 feature. This allows one to
2623 upload a file to the server via scp, ftp, or your favorite file transfer
2624 method. PhpMyAdmin is then able to import the files from the temporary
2625 directory. More information is available in the <a href="#config">Configuration
2626 section</a> of this document.</li>
2627 <li>Using a utility (such as <a href="http://www.ozerov.de/bigdump.php">
2628 BigDump</a>) to split the files before uploading. We cannot support this
2629 or any third party applications, but are aware of users having success
2630 with it.</li>
2631 <li>If you have shell (command line) access, use MySQL to import the files
2632 directly. You can do this by issuing the &quot;source&quot; command from
2633 within MySQL: <tt>source <i>filename.sql</i></tt>.</li>
2634 </ul>
2636 <h4 id="faq1_17">
2637 <a id="faqmysqlversions" href="#faq1_17">1.17 Which MySQL versions does phpMyAdmin
2638 support?</a></h4>
2640 <p> In phpMyAdmin 3.0.x, versions starting with MySQL 5.0.1 are
2641 fully supported. phpMyAdmin may connect to your MySQL server
2642 using PHP's classic
2643 <a href="http://php.net/mysql">MySQL extension</a> as well as the
2644 <a href="http://php.net/mysqli">improved MySQL extension (MySQLi)</a> that
2645 is available in php 5.0.<br />
2646 Either way, the developers of both extensions recommend to use the classic
2647 extension for MySQL 4.0 and below and MySQLi for MySQL 4.1 and newer.<br />
2648 When compiling php, we strongly recommend that you manually link the MySQL
2649 extension of your choice to a MySQL client library of at least the same
2650 minor version since the one that is bundled with some PHP distributions is
2651 rather old and might cause problems <a href="#faq1_17a">
2652 (see <abbr title="Frequently Asked Questions">FAQ</abbr> 1.17a)</a>.
2653 If your webserver is running on a windows system, you might want to try
2654 MySQL's
2655 <a href="http://dev.mysql.com/downloads/connector/php/">Connector/PHP</a>
2656 instead of the MySQL / MySQLi extensions that are bundled with the official
2657 php Win32 builds.</p>
2659 <h5 id="faq1_17a">
2660 <a href="#faq1_17a">1.17a I cannot connect to the MySQL server. It always returns the error
2661 message, &quot;Client does not support authentication protocol requested
2662 by server; consider upgrading MySQL client&quot;</a></h5>
2664 <p> You tried to access MySQL with an old MySQL client library. The version of
2665 your MySQL client library can be checked in your phpinfo() output.
2666 In general, it should have at least the same minor version as your server
2667 - as mentioned in <a href="#faq1_17">
2668 <abbr title="Frequently Asked Questions">FAQ</abbr> 1.17</a>.<br /><br />
2670 This problem is generally caused by using MySQL version 4.1 or newer. MySQL
2671 changed the authentication hash and your PHP is trying to use the old method.
2672 The proper solution is to use the <a href="http://www.php.net/mysqli">mysqli extension</a>
2673 with the proper client library to match your MySQL installation. Your
2674 chosen extension is specified in <a href="#cfg_Servers_extension" class="configrule">$cfg['Servers'][$i]['extension']</a>.
2675 More information (and several workarounds) are located in the
2676 <a href="http://dev.mysql.com/doc/mysql/en/old-client.html">MySQL Documentation</a>.
2677 </p>
2679 <h4 id="faq1_18">
2680 <a href="#faq1_18">1.18 I'm running MySQL&nbsp;&lt;=&nbsp;4.0.1 having
2681 <tt>lower_case_table_names</tt> set to 1. If I create a new table with a
2682 capital letter in its name it is changed to lowercase as it should. But
2683 if I try to DROP this table MySQL is unable to find the corresponding
2684 file.</a></h4>
2686 <p> This is a bug of MySQL&nbsp;&lt;=&nbsp;4.0.1. Please upgrade to at least
2687 MySQL&nbsp;4.0.2 or turn off your <tt>lower_case_table_names</tt>
2688 directive.</p>
2690 <h4 id="faq1_19">
2691 <a href="#faq1_19">1.19 I can't run the &quot;display relations&quot; feature because the
2692 script seems not to know the font face I'm using!</a></h4>
2694 <p> The &quot;FPDF&quot; library we're using for this feature requires some
2695 special files to use font faces.<br />
2696 Please refers to the <a href="http://www.fpdf.org/">FPDF manual</a> to build
2697 these files.</p>
2699 <h4 id="faqmysql">
2700 <a href="#faqmysql">1.20 I receive the error &quot;cannot load MySQL extension, please
2701 check PHP Configuration&quot;.</a></h4>
2703 <p> To connect to a MySQL server, PHP needs a set of MySQL functions called
2704 &quot;MySQL extension&quot;. This extension may be part of the PHP
2705 distribution (compiled-in), otherwise it needs to be loaded dynamically. Its
2706 name is probably <i>mysql.so</i> or <i>php_mysql.dll</i>. phpMyAdmin tried
2707 to load the extension but failed.<br /><br />
2709 Usually, the problem is solved by installing a software package called
2710 &quot;PHP-MySQL&quot; or something similar.</p>
2712 <h4 id="faq1_21">
2713 <a href="#faq1_21">1.21 I am running the
2714 <abbr title="Common Gateway Interface">CGI</abbr> version of PHP under Unix,
2715 and I cannot log in using cookie auth.</a></h4>
2717 <p> In <i>php.ini</i>, set <tt>mysql.max_links</tt> higher than 1.</p>
2719 <h4 id="faq1_22">
2720 <a href="#faq1_22">1.22 I don't see the &quot;Location of text file&quot; field,
2721 so I cannot upload.</a></h4>
2723 <p> This is most likely because in <i>php.ini</i>, your <tt>file_uploads</tt>
2724 parameter is not set to &quot;on&quot;.</p>
2726 <h4 id="faq1_23">
2727 <a href="#faq1_23">1.23 I'm running MySQL on a Win32 machine. Each time I create
2728 a new table the table and field names are changed to lowercase!</a></h4>
2730 <p> This happens because the MySQL directive <tt>lower_case_table_names</tt>
2731 defaults to 1 (<tt>ON</tt>) in the Win32 version of MySQL. You can change
2732 this behavior by simply changing the directive to 0 (<tt>OFF</tt>):<br />
2733 Just edit your <tt>my.ini</tt> file that should be located in your Windows
2734 directory and add the following line to the group [mysqld]:</p>
2736 <pre>set-variable = lower_case_table_names=0</pre>
2738 <p> Next, save the file and restart the MySQL service. You can always check the
2739 value of this directive using the query</p>
2741 <pre>SHOW VARIABLES LIKE 'lower_case_table_names';</pre>
2743 <h4 id="faq1_24">
2744 <a href="#faq1_24">1.24 Some characters are being truncated in my queries, or I
2745 get characters randomly added. I am running PHP 4.2.3.</a></h4>
2747 <p> This is a <a href="http://bugs.php.net/bug.php?id=19404">PHP 4.2.3 bug</a>.
2748 </p>
2750 <h4 id="faq1_25">
2751 <a href="#faq1_25">1.25 I am running Apache with mod_gzip-1.3.26.1a on Windows XP,
2752 and I get problems, such as undefined variables when I run a
2753 <abbr title="structured query language">SQL</abbr> query.</a></h4>
2755 <p> A tip from Jose Fandos: put a comment on the following two lines
2756 in httpd.conf, like this:</p>
2758 <pre>
2759 # mod_gzip_item_include file \.php$
2760 # mod_gzip_item_include mime "application/x-httpd-php.*"
2761 </pre>
2763 <p> as this version of mod_gzip on Apache (Windows) has problems handling
2764 PHP scripts. Of course you have to restart Apache.</p>
2766 <h4 id="faq1_26">
2767 <a href="#faq1_26">1.26 I just installed phpMyAdmin in my document root of
2768 <abbr title="Internet Information Services">IIS</abbr> but
2769 I get the error &quot;No input file specified&quot; when trying to
2770 run phpMyAdmin.</a></h4>
2772 <p> This is a permission problem. Right-click on the phpmyadmin folder
2773 and choose properties. Under the tab Security, click on &quot;Add&quot;
2774 and select the user &quot;IUSR_machine&quot; from the list. Now set his
2775 permissions and it should work.</p>
2777 <h4 id="faq1_27">
2778 <a href="#faq1_27">1.27 I get empty page when I want to view huge page (eg.
2779 db_structure.php with plenty of tables).</a></h4>
2781 <p> This is a <a href="http://bugs.php.net/21079">PHP bug</a> that occur when
2782 GZIP output buffering is enabled. If you turn off it (by
2783 <a href="#cfg_OBGzip" class="configrule">$cfg['OBGzip'] = false</a>
2784 in <i>config.inc.php</i>), it should work. This bug will be fixed in
2785 PHP&nbsp;5.0.0.</p>
2787 <h4 id="faq1_28">
2788 <a href="#faq1_28">1.28 My MySQL server sometimes refuses queries and returns the
2789 message 'Errorcode: 13'. What does this mean?</a></h4>
2791 <p> This can happen due to a MySQL bug when having database / table names with
2792 upper case characters although <tt>lower_case_table_names</tt> is set to 1.
2793 To fix this, turn off this directive, convert all database and table names
2794 to lower case and turn it on again. Alternatively, there's a bug-fix
2795 available starting with MySQL&nbsp;3.23.56 / 4.0.11-gamma.</p>
2797 <h4 id="faq1_29">
2798 <a href="#faq1_29">1.29 When I create a table or modify a field, I get an error
2799 and the fields are duplicated.</a></h4>
2801 <p> It is possible to configure Apache in such a way that PHP has problems
2802 interpreting .php files.</p>
2804 <p> The problems occur when two different (and conflicting) set of directives
2805 are used:</p>
2807 <pre>
2808 SetOutputFilter PHP
2809 SetInputFilter PHP
2810 </pre>
2812 <p> and</p>
2814 <pre>AddType application/x-httpd-php .php</pre>
2816 <p> In the case we saw, one set of directives was in
2817 <tt>/etc/httpd/conf/httpd.conf</tt>, while
2818 the other set was in <tt>/etc/httpd/conf/addon-modules/php.conf</tt>.<br />
2819 The recommended way is with <tt>AddType</tt>, so just comment out
2820 the first set of lines and restart Apache:</p>
2822 <pre>
2823 #SetOutputFilter PHP
2824 #SetInputFilter PHP
2825 </pre>
2827 <h4 id="faq1_30">
2828 <a href="#faq1_30">1.30 I get the error &quot;navigation.php: Missing hash&quot;.</a></h4>
2830 <p> This problem is known to happen when the server is running Turck MMCache
2831 but upgrading MMCache to version 2.3.21 solves the problem.</p>
2833 <h4 id="faq1_31">
2834 <a href="#faq1_31">1.31 Does phpMyAdmin support php5?</a></h4>
2836 <p> Yes.<br />
2837 However, phpMyAdmin needs to be backwards compatible to php4. This is why
2838 phpMyAdmin disables the <tt>E_STRICT</tt> error_level in
2839 <tt>error_reporting</tt> settings.
2840 </p>
2842 <h4 id="faq1_32">
2843 <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>
2845 <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>
2846 mode under <abbr title="Internet Information Services">IIS</abbr> 5.1.</p>
2848 <ol><li>In your <tt>php.ini</tt> file, set <tt>cgi.rfc2616_headers = 0</tt></li>
2849 <li>In <tt>Web Site Properties -&gt; File/Directory Security -&gt; Anonymous
2850 Access</tt> dialog box, check the <tt>Anonymous access</tt> checkbox and
2851 uncheck any other checkboxes (i.e. uncheck <tt>Basic authentication</tt>,
2852 <tt>Integrated Windows authentication</tt>, and <tt>Digest</tt> if it's
2853 enabled.) Click <tt>OK</tt>.</li>
2854 <li>In <tt>Custom Errors</tt>, select the range of <tt>401;1</tt> through
2855 <tt>401;5</tt> and click the <tt>Set to Default</tt> button.</li>
2856 </ol>
2858 <h4 id="faq1_33">
2859 <a href="#faq1_33">1.33 Is there a problem with the mysqli extension when running
2860 PHP 5.0.4 on 64-bit systems?</a></h4>
2862 <p> Yes. This problem affects phpMyAdmin (&quot;Call to undefined function
2863 pma_reloadnavigation&quot;), so upgrade your PHP to the next version.</p>
2865 <h4 id="faq1_34">
2866 <a href="#faq1_34">1.34 Can I access directly to database or table pages?</a></h4>
2868 <p> Yes. Out of the box, you can use <abbr title="Uniform Resource Locator">URL</abbr>s like
2869 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
2870 the order of the server paragraph in <tt>config.inc.php</tt>.
2871 Table and script parts are optional. If you want
2872 http://server/phpMyAdmin/database[/table][/script] <abbr title="Uniform Resource Locator">URL</abbr>s, you need to do
2873 some configuration. Following lines apply only for <a
2874 href="http://httpd.apache.org">Apache</a> web server. First make sure,
2875 that you have enabled some features within global configuration. You need
2876 <code>Options FollowSymLinks</code> and <code>AllowOverride
2877 FileInfo</code> enabled for directory where phpMyAdmin is installed and
2878 you need mod_rewrite to be enabled. Then you just need to create following
2879 <code>.htaccess</code> file in root folder of phpMyAdmin installation
2880 (don't forget to change directory name inside of it):</p>
2882 <pre>
2883 RewriteEngine On
2884 RewriteBase /path_to_phpMyAdmin
2885 RewriteRule ^([a-zA-Z0-9_]+)/([a-zA-Z0-9_]+)/([a-z_]+\.php)$ index.php?db=$1&amp;table=$2&amp;target=$3 [R]
2886 RewriteRule ^([a-zA-Z0-9_]+)/([a-z_]+\.php)$ index.php?db=$1&amp;target=$2 [R]
2887 RewriteRule ^([a-zA-Z0-9_]+)/([a-zA-Z0-9_]+)$ index.php?db=$1&amp;table=$2 [R]
2888 RewriteRule ^([a-zA-Z0-9_]+)$ index.php?db=$1 [R]
2889 </pre>
2891 <h4 id="faq1_35">
2892 <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>
2894 <p> Yes. However you need to pass authentication variable to <abbr title="Common Gateway Interface">CGI</abbr> using
2895 following rewrite rule:</p>
2897 <pre>
2898 RewriteEngine On
2899 RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization},L]
2900 </pre>
2902 <h4 id="faq1_36">
2903 <a href="#faq1_36">1.36 I get an error &quot;500 Internal Server Error&quot;.</a>
2904 </h4>
2906 There can be many explanations to this and a look at your server's
2907 error log file might give a clue.
2908 </p>
2910 <h4 id="faq1_37">
2911 <a href="#faq1_37">1.37 I run phpMyAdmin on cluster of different machines and
2912 password encryption in cookie auth doesn't work.</a></h4>
2914 <p> If your cluster consist of different architectures, PHP code used for
2915 encryption/decryption won't work correct. This is caused by use of
2916 pack/unpack functions in code. Only solution is to use mcrypt extension
2917 which works fine in this case.</p>
2919 <h4 id="faq1_38">
2920 <a href="#faq1_38">1.38 Can I use phpMyAdmin on a server on which Suhosin is enabled?</a></h4>
2922 <p> Yes but the default configuration values of Suhosin are known to cause
2923 problems with some operations, for example editing a table with many
2924 columns and no primary key. Tuning information is available at
2925 <a href="http://www.hardened-php.net/hphp/troubleshooting.html">
2926 http://www.hardened-php.net/hphp/troubleshooting.html</a>,
2927 although the parameter names have changed (<tt>suhosin</tt> instead
2928 of <tt>hphp</tt>). See also the <a href="#cfg_SuhosinDisableWarning">
2929 <tt>SuhosinDisableWarning</tt> directive</a>.
2930 </p>
2932 <h3 id="faqconfig">Configuration</h3>
2934 <h4 id="faq2_1">
2935 <a href="#faq2_1">2.1 The error message &quot;Warning: Cannot add header information -
2936 headers already sent by ...&quot; is displayed, what's the problem?</a></h4>
2938 <p> Edit your <i>config.inc.php</i> file and ensure there is nothing
2939 (I.E. no blank lines, no spaces, no characters...) neither before the
2940 <tt>&lt;?php</tt> tag at the beginning, neither after the <tt>?&gt;</tt>
2941 tag at the end. We also got a report from a user under IIS, that used
2942 a zipped distribution kit: the file <tt>libraries/Config.class.php</tt>
2943 contained an end-of-line character (hex 0A) at the end; removing this character
2944 cleared his errors.</p>
2946 <h4 id="faq2_2">
2947 <a href="#faq2_2">2.2 phpMyAdmin can't connect to MySQL. What's wrong?</a></h4>
2949 <p> Either there is an error with your PHP setup or your username/password is
2950 wrong. Try to make a small script which uses mysql_connect and see if it
2951 works. If it doesn't, it may be you haven't even compiled MySQL support
2952 into PHP.</p>
2954 <h4 id="faq2_3">
2955 <a href="#faq2_3">2.3 The error message &quot;Warning: MySQL Connection Failed: Can't
2956 connect to local MySQL server through socket '/tmp/mysql.sock'
2957 (111) ...&quot; is displayed. What can I do?</a></h4>
2959 <p> For RedHat users, Harald Legner suggests this on the mailing list:</p>
2961 <p> On my RedHat-Box the socket of MySQL is <i>/var/lib/mysql/mysql.sock</i>.
2962 In your <i>php.ini</i> you will find a line</p>
2964 <pre>mysql.default_socket = /tmp/mysql.sock</pre>
2966 <p> change it to</p>
2968 <pre>mysql.default_socket = /var/lib/mysql/mysql.sock</pre>
2970 <p> Then restart apache and it will work.</p>
2972 <p> Here is a fix suggested by Brad Ummer:</p>
2974 <ul><li>First, you need to determine what socket is being used by MySQL.<br />
2975 To do this, telnet to your server and go to the MySQL bin directory. In
2976 this directory there should be a file named <i>mysqladmin</i>. Type
2977 <tt>./mysqladmin variables</tt>, and this should give you a bunch of
2978 info about your MySQL server, including the socket
2979 (<i>/tmp/mysql.sock</i>, for example).</li>
2980 <li>Then, you need to tell PHP to use this socket.<br /> To do this in
2981 phpMyAdmin, you need to complete the socket information in the
2982 <i>config.inc.php</i>.<br />
2983 For example:
2984 <a href="#cfg_Servers_socket" class="configrule">
2985 $cfg['Servers'][$i]['socket']&nbsp;=&nbsp;'/tmp/mysql.sock';</a>
2986 <br /><br />
2988 Please also make sure that the permissions of this file allow to be readable
2989 by your webserver (i.e. '0755').</li>
2990 </ul>
2992 <p> Have also a look at the
2993 <a href="http://www.mysql.com/doc/C/a/Can_not_connect_to_server.html">
2994 corresponding section of the MySQL documentation</a>.</p>
2996 <h4 id="faq2_4">
2997 <a href="#faq2_4">2.4 Nothing is displayed by my browser when I try to run phpMyAdmin,
2998 what can I do?</a></h4>
3000 <p> Try to set the <a href="#cfg_OBGzip" class="configrule">$cfg['OBGZip']</a>
3001 directive to <tt>FALSE</tt> in the phpMyAdmin configuration file. It helps
3002 sometime.<br />
3003 Also have a look at your PHP version number: if it contains &quot;4.0b...&quot;
3004 it means you're running a beta version of PHP. That's not a so good idea,
3005 please upgrade to a plain revision.</p>
3007 <h4 id="faq2_5">
3008 <a href="#faq2_5">2.5 Each time I want to insert or change a record or drop a database
3009 or a table, an error 404 (page not found) is displayed or, with <abbr title="HyperText Transfer Protocol">HTTP</abbr> or
3010 cookie authentication, I'm asked to log in again. What's wrong?</a></h4>
3012 <p> Check the value you set for the
3013 <a href="#cfg_PmaAbsoluteUri" class="configrule">$cfg['PmaAbsoluteUri']</a>
3014 directive in the phpMyAdmin configuration file.</p>
3016 <h4 id="faq2_6">
3017 <a href="#faq2_6">2.6 I get an &quot;Access denied for user: 'root@localhost' (Using
3018 password: YES)&quot;-error when trying to access a MySQL-Server on a
3019 host which is port-forwarded for my localhost.</a></h4>
3021 <p> When you are using a port on your localhost, which you redirect via
3022 port-forwarding to another host, MySQL is not resolving the localhost
3023 as expected.<br />
3024 Erik Wasser explains: The solution is: if your host is &quot;localhost&quot;
3025 MySQL (the commandline tool 'mysql' as well) always tries to use the socket
3026 connection for speeding up things. And that doesn't work in this configuration
3027 with port forwarding.<br />
3028 If you enter "127.0.0.1" as hostname, everything is right and MySQL uses the
3029 <abbr title="Transmission Control Protocol">TCP</abbr> connection.</p>
3031 <h4 id="faqthemes"><a href="#faqthemes">2.7 Using and creating themes</a></h4>
3033 <p> Themes are configured with
3034 <a href="#cfg_ThemePath" class="configrule">$cfg['ThemePath']</a>,
3035 <a href="#cfg_ThemeManager" class="configrule">$cfg['ThemeManager']</a> and
3036 <a href="#cfg_ThemeDefault" class="configrule">$cfg['ThemeDefault']</a>.<br />
3037 <br />
3038 Under <a href="#cfg_ThemePath" class="configrule">$cfg['ThemePath']</a>, you
3039 should not delete the directory &quot;original&quot; or its underlying
3040 structure, because this is the system theme used by phpMyAdmin.
3041 &quot;original&quot; contains all images and styles, for backwards
3042 compatibility and for all themes that would not include images or css-files.
3043 <br /><br />
3045 If <a href="#cfg_ThemeManager" class="configrule">$cfg['ThemeManager']</a>
3046 is enabled, you can select your favorite theme on the main page. Your
3047 selected theme will be stored in a cookie.<br /><br /></p>
3049 <p> To create a theme:</p>
3051 <ul><li>make a new subdirectory (for example &quot;your_theme_name&quot;) under
3052 <a href="#cfg_ThemePath" class="configrule">$cfg['ThemePath']</a>
3053 (by default <tt>themes</tt>)</li>
3054 <li>copy the files and directories from &quot;original&quot; to
3055 &quot;your_theme_name&quot;</li>
3056 <li>edit the css-files in &quot;your_theme_name/css&quot;</li>
3057 <li>put your new images in &quot;your_theme_name/img&quot;</li>
3058 <li>edit <tt>layout.inc.php</tt> in &quot;your_theme_name&quot;</li>
3059 <li>edit <tt>info.inc.php</tt> in &quot;your_theme_name&quot; to
3060 contain your chosen theme name, that will be visible in user interface</li>
3061 <li>make a new screenshot of your theme and save it under
3062 &quot;your_theme_name/screen.png&quot;</li>
3063 </ul>
3065 <p> In theme directory there is file <tt>info.inc.php</tt> which contains
3066 theme verbose name, theme generation and theme version. These versions and
3067 generations are enumerated from 1 and do not have any direct dependence on
3068 phpMyAdmin version. Themes within same generation should be backwards
3069 compatible - theme with version 2 should work in phpMyAdmin requiring
3070 version 1. Themes with different generation are incompatible.</p>
3072 <p> If you do not want to use your own symbols and buttons, remove the
3073 directory &quot;img&quot; in &quot;your_theme_name&quot;. phpMyAdmin will
3074 use the default icons and buttons (from the system-theme &quot;original&quot;).
3075 </p>
3077 <h4 id="faqmissingparameters">
3078 <a href="#faqmissingparameters">2.8 I get &quot;Missing parameters&quot; errors,
3079 what can I do?</a></h4>
3081 <p> Here are a few points to check:</p>
3083 <ul><li>In <tt>config.inc.php</tt>, try to leave the
3084 <a href="#cfg_PmaAbsoluteUri" class="configrule">$cfg['PmaAbsoluteUri']</a>
3085 directive empty. See also
3086 <a href="#faq4_7"><abbr title="Frequently Asked Questions">FAQ</abbr> 4.7</a>.
3087 </li>
3088 <li>Maybe you have a broken PHP installation or you need to upgrade
3089 your Zend Optimizer. See
3090 <a href="http://bugs.php.net/bug.php?id=31134">
3091 http://bugs.php.net/bug.php?id=31134</a>.
3092 </li>
3093 <li>If you are using Hardened PHP with the ini directive <tt>varfilter.max_request_variables</tt>
3094 set to the default (200) or another low value, you could get this
3095 error if your table has a high number of columns. Adjust this setting
3096 accordingly. (Thanks to Klaus Dorninger for the hint).
3097 </li>
3098 <li>In the <tt>php.ini</tt> directive <tt>arg_separator.input</tt>, a value
3099 of &quot;;&quot; will cause this error. Replace it with &quot;&amp;;&quot;.
3100 </li>
3101 <li>If you are using <a href="http://www.hardened-php.net/">Hardened-PHP</a>,
3102 you might want to increase
3103 <a href="http://www.hardened-php.net/hphp/troubleshooting.html">request limits</a>.
3104 </li>
3105 <li>The directory specified in the <tt>php.ini</tt> directive <tt>session.save_path</tt> does not exist or is read-only.
3106 </li>
3107 </ul>
3109 <h3 id="faqlimitations">Known limitations</h3>
3111 <h4 id="login_bug">
3112 <a href="#login_bug">3.1 When using
3113 <abbr title="HyperText Transfer Protocol">HTTP</abbr> authentication, an user
3114 who logged out can not log in again in with the same nick.</a></h4>
3116 <p> This is related to the authentication mechanism (protocol) used by
3117 phpMyAdmin. To bypass this problem: just close all the opened
3118 browser windows and then go back to phpMyAdmin. You should be able to
3119 log in again.</p>
3121 <h4 id="faq3_2">
3122 <a href="#faq3_2">3.2 When dumping a large table in compressed mode, I get a memory
3123 limit error or a time limit error.</a></h4>
3125 <p> Compressed dumps are built in memory and because of this are limited to
3126 php's memory limit. For GZip/BZip2 exports this can be overcome since 2.5.4
3127 using
3128 <a href="#cfg_CompressOnFly" class="configrule">$cfg['CompressOnFly']</a>
3129 (enabled by default). Zip exports can not be handled this way, so if you need
3130 Zip files for larger dump, you have to use another way.</p>
3132 <h4 id="faq3_3">
3133 <a href="#faq3_3">3.3 With InnoDB tables, I lose foreign key relationships when I rename
3134 or alter a table.</a></h4>
3136 <p> This seems to be a InnoDB bug (fixed in MySQL 3.23.50?).</p>
3138 <h4 id="faq3_4">
3139 <a href="#faq3_4">3.4 I am unable to import dumps I created with the mysqldump tool
3140 bundled with the MySQL server distribution.</a></h4>
3142 <p> The problem is that older versions of mysqldump created invalid comments like this:</p>
3144 <pre>
3145 -- MySQL dump 8.22
3147 -- Host: localhost Database: database
3148 ---------------------------------------------------------
3149 -- Server version 3.23.54
3150 </pre>
3152 <p> The invalid part of the code is the horizontal line made of dashes that
3153 appears once in every dump created with mysqldump. If you want to run your
3154 dump you have to turn it into valid MySQL. This means, you have to add a
3155 whitespace after the first two dashes of the line or add a # before it:
3156 <br />
3157 <code>
3158 -- -------------------------------------------------------<br />
3159 </code>
3160 or<br />
3161 <code>
3162 #---------------------------------------------------------
3163 </code>
3164 </p>
3166 <h4 id="faq3_5">
3167 <a href="#faq3_5">3.5 When using nested folders there are some multiple hierarchies
3168 displayed in a wrong manner?!</a> (<a href="#cfg_LeftFrameTableSeparator"
3169 class="configrule">$cfg['LeftFrameTableSeparator']</a>)</h4>
3171 <p> Please note that you should not use the separating string multiple times
3172 without any characters between them, or at the beginning/end of your table
3173 name. If you have to, think about using another TableSeparator or disabling
3174 that feature</p>
3176 <h4 id="faq3_6">
3177 <a href="#faq3_6">3.6 What is currently not supported in phpMyAdmin about InnoDB?</a></h4>
3179 <p> In Relation view, being able to choose a table in another database,
3180 or having more than one index field in the foreign key.<br /><br/>
3181 In Query-by-example (Query), automatic generation of the query
3182 LEFT JOIN from the foreign table.<br /><br/>
3183 </p>
3185 <h4 id="faq3_7">
3186 <a href="#faq3_7">3.7 I have table with many (100+) fields and when I try to browse table
3187 I get series of errors like &quot;Warning: unable to parse url&quot;. How
3188 can this be fixed?</a></h4>
3190 Your table neither have a primary key nor an unique one, so we must use a
3191 long expression to identify this row. This causes problems to parse_url
3192 function. The workaround is to create a primary or unique key.
3193 <br />
3194 </p>
3196 <h4 id="faq3_8">
3197 <a href="#faq3_8">3.8 I cannot use (clickable) HTML-forms in fields where I put
3198 a MIME-Transformation onto!</a></h4>
3200 <p> Due to a surrounding form-container (for multi-row delete checkboxes), no
3201 nested forms can be put inside the table where phpMyAdmin displays the results.
3202 You can, however, use any form inside of a table if keep the parent
3203 form-container with the target to tbl_row_delete.php and just put your own
3204 input-elements inside. If you use a custom submit input field, the form will
3205 submit itself to the displaying page again, where you can validate the
3206 $HTTP_POST_VARS in a transformation.
3208 For a tutorial on how to effectively use transformations, see our
3209 <a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a>
3210 on the official phpMyAdmin-homepage.</p>
3212 <h4 id="faq3_9">
3213 <a href="#faq3_9">3.9 I get error messages when using "--sql_mode=ANSI" for the
3214 MySQL server</a></h4>
3216 <p> When MySQL is running in ANSI-compatibility mode, there are some major
3217 differences in how <abbr title="structured query language">SQL</abbr> is
3218 structured (see <a href="http://dev.mysql.com/doc/mysql/en/ANSI_mode.html">
3219 http://dev.mysql.com/doc/mysql/en/ANSI_mode.html</a>). Most important of all,
3220 the quote-character (") is interpreted as an identifier quote character and
3221 not as a string quote character, which makes many internal phpMyAdmin
3222 operations into invalid <abbr title="structured query language">SQL</abbr>
3223 statements. There is no workaround to this behaviour. News to this item will
3224 be posted in Bug report
3225 <a href="https://sf.net/tracker/index.php?func=detail&amp;aid=816858&amp;group_id=23067&amp;atid=377408">#816858</a>
3226 </p>
3228 <h4 id="faq3_10">
3229 <a href="#faq3_10">3.10 Homonyms and no primary key: When the results of a SELECT display
3230 more that one column with the same value
3231 (for example <tt>SELECT lastname from employees where firstname like 'A%'</tt> and two &quot;Smith&quot; values are displayed),
3232 if I click Edit I cannot be sure that I am editing the intended row.</a></h4>
3234 <p> Please make sure that your table has a primary key, so that phpMyAdmin
3235 can use it for the Edit and Delete links.</p>
3237 <h4 id="faq3_11">
3238 <a href="#faq3_11">3.11 The number of records for InnoDB tables is not correct.</a></h4>
3240 <p> phpMyAdmin uses a quick method to get the row count, and this method
3241 only returns an approximate count in the case of InnoDB tables. See
3242 <a href="#cfg_MaxExactCount" class="configrule">$cfg['MaxExactCount']</a> for
3243 a way to modify those results, but
3244 this could have a serious impact on performance.</p>
3246 <h4 id="faq3_12">
3247 <a href="#faq3_12">3.12 What are the phpMyAdmin limitations for MySQL 3?</a></h4>
3249 <p> The number of records in queries containing COUNT and GROUP BY is
3250 not correctly calculated. Also, sorting results of a query like
3251 &quot;SELECT * from table GROUP BY&quot; ... is problematic.</p>
3253 <h4 id="faq3_13">
3254 <a href="#faq3_13">3.13 I get an error when entering <tt>USE</tt> followed by a db name
3255 containing an hyphen.
3256 </a></h4>
3258 The tests I have made with current MySQL 4.1.11 API shows that the
3259 API does not accept this syntax for the USE command. Enclosing the
3260 db name with backquotes works. For further confusion, no backquotes
3261 are needed with command-line mysql.
3262 </p>
3264 <h4 id="faq3_14">
3265 <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>
3267 This has been a known limitation of phpMyAdmin since the beginning and
3268 it's not likely to be solved in the future.
3269 </p>
3271 <h3 id="faqmultiuser"><abbr title="Internet service provider">ISP</abbr>s, multi-user installations</h3>
3273 <h4 id="faq4_1">
3274 <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
3275 need to install it for each customer.
3276 </a></h4>
3278 Since version 2.0.3, you can setup a central copy of phpMyAdmin for all
3279 your users. The development of this feature was kindly sponsored by
3280 NetCologne GmbH.
3281 This requires a properly setup MySQL user management and phpMyAdmin
3282 <abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie authentication. See the install section on
3283 &quot;Using <abbr title="HyperText Transfer Protocol">HTTP</abbr> authentication&quot;.
3284 </p>
3286 <h4 id="faq4_2">
3287 <a href="#faq4_2">4.2 What's the preferred way of making phpMyAdmin secure against evil
3288 access.
3289 </a></h4>
3291 This depends on your system.<br />
3292 If you're running a server which cannot be accessed by other people, it's
3293 sufficient to use the directory protection bundled with your webserver
3294 (with Apache you can use <i>.htaccess</i> files, for example).<br />
3295 If other people have telnet access to your server, you should use
3296 phpMyAdmin's <abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie authentication features.
3297 <br /><br />
3298 Suggestions:
3299 </p>
3300 <ul>
3301 <li>
3302 Your <i>config.inc.php</i> file should be <tt>chmod 660</tt>.
3303 </li>
3304 <li>
3305 All your phpMyAdmin files should be chown -R phpmy.apache, where phpmy
3306 is a user whose password is only known to you, and apache is the
3307 group under which Apache runs.
3308 </li>
3309 <li>
3310 You should use PHP safe mode, to protect from other users that try
3311 to include your <i>config.inc.php</i> in their scripts.
3312 </li>
3313 </ul>
3315 <h4 id="faq4_3">
3316 <a href="#faq4_3">4.3 I get errors about not being able to include a file in
3317 <i>/lang</i> or in <i>/libraries</i>.
3318 </a></h4>
3320 Check <i>php.ini</i>, or ask your sysadmin to check it. The
3321 <tt>include_path</tt> must contain &quot;.&quot; somewhere in it, and
3322 <tt>open_basedir</tt>, if used, must contain &quot;.&quot; and
3323 &quot;./lang&quot; to allow normal operation of phpMyAdmin.
3324 </p>
3326 <h4 id="faq4_4">
3327 <a href="#faq4_4">4.4 phpMyAdmin always gives &quot;Access denied&quot; when using <abbr title="HyperText Transfer Protocol">HTTP</abbr>
3328 authentication.
3329 </a></h4>
3331 <p> This could happen for several reasons:</p>
3333 <ul><li><a href="#cfg_Servers_controluser" class="configrule">$cfg['Servers'][$i]['controluser']</a>
3334 and/or
3335 <a href="#cfg_Servers_controlpass" class="configrule">$cfg['Servers'][$i]['controlpass']</a>
3336 are wrong.</li>
3337 <li>The username/password you specify in the login dialog are invalid.</li>
3338 <li>You have already setup a security mechanism for the
3339 phpMyAdmin-directory, eg. a .htaccess file. This would interfere with
3340 phpMyAdmin's authentication, so remove it.</li>
3341 </ul>
3343 <h4 id="faq4_5">
3344 <a href="#faq4_5">4.5 Is it possible to let users create their own databases?</a></h4>
3346 <p> Starting with 2.2.5, in the user management page, you can enter a wildcard
3347 database name for a user (for example &quot;joe%&quot;),
3348 and put the privileges you want. For example,
3349 adding <tt>SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER</tt>
3350 would let a user create/manage his/her database(s).</p>
3352 <h4 id="faq4_6">
3353 <a href="#faq4_6">4.6 How can I use the Host-based authentication additions?</a></h4>
3355 <p> If you have existing rules from an old .htaccess file, you can take them
3356 and add a username between the <tt>'deny'</tt>/<tt>'allow'</tt> and
3357 <tt>'from'</tt> strings. Using the username wildcard of <tt>'%'</tt> would
3358 be a major benefit here if your installation is suited to using it. Then
3359 you can just add those updated lines into the
3360 <a href="#cfg_Servers_AllowDeny_rules" class="configrule">
3361 $cfg['Servers'][$i]['AllowDeny']['rules']</a> array.</p>
3363 <p> If you want a pre-made sample, you can try this fragment. It stops the
3364 'root' user from logging in from any networks other than the private
3365 network <abbr title="Internet Protocol">IP</abbr> blocks.</p>
3367 <pre>
3368 //block root from logging in except from the private networks
3369 $cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';
3370 $cfg['Servers'][$i]['AllowDeny']['rules'] = array(
3371 'deny root from all',
3372 'allow root from localhost',
3373 'allow root from 10.0.0.0/8',
3374 'allow root from 192.168.0.0/16',
3375 'allow root from 172.16.0.0/12',
3377 </pre>
3379 <h4 id="faq4_7">
3380 <a href="#faq4_7">4.7 Authentication window is displayed more than once, why?</a></h4>
3382 <p> This happens if you are using a <abbr title="Uniform Resource Locator">URL</abbr> to start phpMyAdmin which is
3383 different than the one set in your
3384 <a href="#cfg_PmaAbsoluteUri" class="configrule">$cfg['PmaAbsoluteUri']</a>.
3385 For example, a missing &quot;www&quot;, or entering with an <abbr title="Internet Protocol">IP</abbr> address
3386 while a domain name is defined in the config file.</p>
3388 <h4 id="faq4_8">
3389 <a href="#faq4_8">4.8 Which parameters can I use in the URL that starts phpMyAdmin?</a></h4>
3391 <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>
3393 <h3 id="faqbrowsers">Browsers or client <abbr title="operating system">OS</abbr></h3>
3395 <h4 id="faq5_1">
3396 <a href="#faq5_1">5.1 I get an out of memory error, and my controls are non-functional,
3397 when trying to create a table with more than 14 fields.
3398 </a></h4>
3400 We could reproduce this problem only under Win98/98SE. Testing under
3401 WinNT4 or Win2K, we could easily create more than 60 fields.
3402 <br />
3403 A workaround is to create a smaller number of fields, then come back to
3404 your table properties and add the other fields.
3405 </p>
3407 <h4 id="faq5_2">
3408 <a href="#faq5_2">5.2 With Xitami 2.5b4, phpMyAdmin won't process form fields.</a></h4>
3410 This is not a phpMyAdmin problem but a Xitami known bug: you'll face it
3411 with each script/website that use forms.<br />
3412 Upgrade or downgrade your Xitami server.
3413 </p>
3415 <h4 id="faq5_3">
3416 <a href="#faq5_3">5.3 I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).</a></h4>
3418 With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except that
3419 the proposed file name for the dump is always 'tbl_dump.php'. Bzip2 dumps
3420 don't seem to work.<br />
3422 With Konqueror 2.2.1: plain dumps work; zip dumps are placed into
3423 the user's temporary directory, so they must be moved before closing
3424 Konqueror, or else they disappear. GZip dumps give an error message.<br />
3426 Testing needs to be done for Konqueror 2.2.2.<br />
3427 </p>
3429 <h4 id="faq5_4">
3430 <a href="#faq5_4">5.4 I can't use the cookie authentication mode because Internet
3431 Explorer never stores the cookies.
3432 </a></h4>
3434 MS Internet Explorer seems to be really buggy about cookies, at least till
3435 version 6. And thanks to Andrew Zivolup we've traced also a PHP 4.1.1 bug
3436 in this area!
3437 <br />
3438 Then, if you're running PHP 4.1.1, try to upgrade or downgrade... it may
3439 work!
3440 </p>
3442 <h4 id="faq5_5">
3443 <a href="#faq5_5">5.5 In Internet Explorer 5.0, I get JavaScript errors when browsing my
3444 rows.
3445 </a></h4>
3447 Upgrade to at least Internet Explorer 5.5 SP2.<br />
3448 </p>
3450 <h4 id="faq5_6">
3451 <a href="#faq5_6">5.6 In Internet Explorer 5.0, 5.5 or 6.0, I get an error (like "Page not found")
3452 when trying to modify a row in a table with many fields, or with a text field
3453 </a></h4>
3455 Your table neither have a primary key nor an unique one, so we must use a
3456 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
3457 those browsers, and this not happen in Netscape, for example. The
3458 workaround is to create a primary or unique key, or use another browser.
3459 <br />
3460 </p>
3462 <h4 id="faq5_7">
3463 <a href="#faq5_7">5.7 I refresh (reload) my browser, and come back to the welcome
3464 page.
3465 </a></h4>
3467 Some browsers support right-clicking into the frame you want to refresh,
3468 just do this in the right frame.<br />
3469 </p>
3471 <h4 id="faq5_8">
3472 <a href="#faq5_8">5.8 With Mozilla 0.9.7 I have problems sending a query modified in the
3473 query box.
3474 </a></h4>
3476 Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
3477 Mozilla versions.<br />
3478 </p>
3480 <h4 id="faq5_9">
3481 <a href="#faq5_9">5.9 With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
3482 whitespace in the <abbr title="structured query language">SQL</abbr>-Query edit area: the page scrolls down.
3483 </a></h4>
3485 This is a Mozilla bug (see bug #26882 at
3486 <a href="http://bugzilla.mozilla.org/">BugZilla</a>).<br />
3487 </p>
3489 <h4 id="faq5_10">
3490 <a href="#faq5_10">5.10 With Netscape 4.75 I get empty rows between each row of data in a
3491 <abbr title="comma separated values">CSV</abbr> exported file.
3492 </a></h4>
3494 This is a known Netscape 4.75 bug: it adds some line feeds when exporting
3495 data in octet-stream mode. Since we can't detect the specific Netscape
3496 version, we cannot workaround this bug.
3497 </p>
3499 <h4 id="faq5_11">
3500 <a href="#faq5_11">5.11 Extended-ASCII characters like German umlauts are displayed
3501 wrong.</a></h4>
3503 <p> Please ensure that you have set your browser's character set to the one of the
3504 language file you have selected on phpMyAdmin's start page.
3505 Alternatively, you can try the auto detection mode that is supported by the
3506 recent versions of the most browsers.</p>
3508 <h4 id="faq5_12">
3509 <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
3510 &quot;?&quot;.</a></h4>
3512 <p> This issue has been reported by a <abbr title="operating system">OS</abbr> X user, who adds that Chimera,
3513 Netscape and Mozilla do not have this problem.</p>
3515 <h4 id="faq5_13">
3516 <a href="#faq5_13">5.13 With Internet Explorer 5.5 or 6, and <abbr title="HyperText Transfer Protocol">HTTP</abbr> authentication type,
3517 I cannot manage two servers: I log in to the first one, then the other one,
3518 but if I switch back to the first, I have to log in on each operation.</a></h4>
3520 <p> This is a bug in Internet Explorer, other browsers do not behave this way.</p>
3522 <h4 id="faq5_14">
3523 <a href="#faq5_14">5.14 Using Opera6, I can manage to get to the authentication,
3524 but nothing happens after that, only a blank screen.</a></h4>
3526 <p> Having <tt>$cfg['QueryFrameJS']</tt> set o <tt>TRUE</tt>, this leads to a
3527 bug in Opera6, because it is not able to interpret frameset definitions
3528 written by JavaScript. Please upgrade your phpMyAdmin installtion or to
3529 Opera7 at least.</p>
3531 <h4 id="faq5_15">
3532 <a href="#faq5_15">5.15 I have display problems with Safari.</a></h4>
3534 <p> Please upgrade to at least version 1.2.3.</p>
3536 <h4 id="faq5_16">
3537 <a href="#faq5_16">5.16 With Internet Explorer, I get &quot;Access is denied&quot;
3538 Javascript errors. Or I cannot make phpMyAdmin work under Windows.</a></h4>
3540 <p> Please check the following points:</p>
3541 <ul><li>Maybe you have defined your <tt>PmaAbsoluteUri</tt> setting
3542 in <tt>config.inc.php</tt> to an <abbr title="Internet Protocol">IP</abbr>
3543 address and you are starting
3544 phpMyAdmin with a <abbr title="Uniform Resource Locator">URL</abbr>
3545 containing a domain name, or the reverse situation.</li>
3546 <li>Security settings in IE and/or Microsoft Security Center are
3547 too high, thus blocking scripts execution.</li>
3548 <li>The Windows Firewall is blocking Apache and MySQL. You must
3549 allow <abbr title="HyperText Transfer Protocol">HTTP</abbr> ports
3550 (80 or 443) and MySQL port (usually 3306)
3551 in the &quot;in&quot; and &quot;out&quot; directions.</li>
3552 </ul>
3554 <h4 id="faq5_17">
3555 <a href="#faq5_17">5.17 With Firefox, I cannot delete rows of data or drop a database.</a></h4>
3556 <p> Many users have confirmed that the Tabbrowser Extensions plugin they
3557 installed in their Firefox is causing the problem.</p>
3559 <h3 id="faqusing">Using phpMyAdmin</h3>
3561 <h4 id="faq6_1">
3562 <a href="#faq6_1">6.1 I can't insert new rows into a table / I can't create a table
3563 - MySQL brings up a <abbr title="structured query language">SQL</abbr>-error.
3564 </a></h4>
3566 Examine the <abbr title="structured query language">SQL</abbr> error with care. Often the problem is caused by
3567 specifying a wrong field-type.<br />
3568 Common errors include:
3569 </p>
3570 <ul>
3571 <li>Using <tt>VARCHAR</tt> without a size argument</li>
3572 <li>Using <tt>TEXT</tt> or <tt>BLOB</tt> with a size argument</li>
3573 </ul>
3575 Also, look at the syntax chapter in the MySQL manual to confirm that your
3576 syntax is correct.
3577 </p>
3579 <h4 id="faq6_2">
3580 <a href="#faq6_2">6.2 When I create a table, I set an index for two fields and
3581 phpMyAdmin generates only one index with those two fields.
3582 </a></h4>
3584 This is the way to create a multi-fields
3585 index. If you want two indexes, create the first one when creating the
3586 table, save, then display the table properties and click the Index link to
3587 create the other index.
3588 </p>
3590 <h4 id="faq6_3">
3591 <a href="#faq6_3">6.3 How can I insert a null value into my table?</a></h4>
3593 Since version 2.2.3, you have a checkbox for each field that can be null.
3594 Before 2.2.3, you had to enter &quot;null&quot;, without the quotes, as the
3595 field's value. Since version 2.5.5, you have to use the checkbox to get
3596 a real NULL value, so if you enter &quot;NULL&quot; this means you want
3597 a literal NULL in the field, and not a NULL value (this works in PHP4).
3598 </p>
3600 <h4 id="faq6_4">
3601 <a href="#faq6_4">6.4 How can I backup my database or table?</a></h4>
3603 <p> Click on a database or table name in the left frame, the properties will be
3604 displayed. Then on the menu, click &quot;Export&quot;, you can dump
3605 the structure, the data, or both. This will generate standard <abbr title="structured query language">SQL</abbr>
3606 statements that can be used to recreate your database/table.
3607 <br /><br />
3608 You will need to choose &quot;Save as file&quot;, so that phpMyAdmin can
3609 transmit the resulting dump to your station. Depending on your PHP
3610 configuration, you will see options to compress the dump. See also the
3611 <a href="#cfg_ExecTimeLimit" class="configrule">$cfg['ExecTimeLimit']</a>
3612 configuration variable.<br /><br />
3614 For additional help on this subject, look for the word &quot;dump&quot; in
3615 this document.</p>
3617 <h4 id="faq6_5">
3618 <a href="#faq6_5">6.5 How can I restore (upload) my database or table using a dump?
3619 How can I run a &quot;.sql&quot; file?
3620 </a></h4>
3622 <p> Click on a database name in the left frame, the properties will be
3623 displayed. Select &quot;Import&quot; from the list
3624 of tabs in the right&#8211;hand frame (or &quot;<abbr title="structured query language">SQL</abbr>&quot; if your phpMyAdmin
3625 version is previous to 2.7.0). In the &quot;Location of the text file&quot; section, type in
3626 the path to your dump filename, or use the Browse button. Then click Go.
3627 <br /><br />
3628 With version 2.7.0, the import engine has been re&#8211;written, if possible it is suggested
3629 that you upgrade to take advantage of the new features.
3630 <br /><br />
3631 For additional help on this subject, look for the word &quot;upload&quot;
3632 in this document.
3633 </p>
3635 <h4 id="faq6_6">
3636 <a href="#faq6_6">6.6 How can I use the relation table in Query-by-example?</a></h4>
3638 <p> Here is an example with the tables persons, towns and countries, all
3639 located in the database mydb. If you don't have a <tt>pma_relation</tt>
3640 table, create it as explained in the configuration section. Then create the
3641 example tables:</p>
3643 <pre>
3644 CREATE TABLE REL_countries (
3645 country_code char(1) NOT NULL default '',
3646 description varchar(10) NOT NULL default '',
3647 PRIMARY KEY (country_code)
3648 ) TYPE=MyISAM;
3650 INSERT INTO REL_countries VALUES ('C', 'Canada');
3652 CREATE TABLE REL_persons (
3653 id tinyint(4) NOT NULL auto_increment,
3654 person_name varchar(32) NOT NULL default '',
3655 town_code varchar(5) default '0',
3656 country_code char(1) NOT NULL default '',
3657 PRIMARY KEY (id)
3658 ) TYPE=MyISAM;
3660 INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');
3661 INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');
3663 CREATE TABLE REL_towns (
3664 town_code varchar(5) NOT NULL default '0',
3665 description varchar(30) NOT NULL default '',
3666 PRIMARY KEY (town_code)
3667 ) TYPE=MyISAM;
3669 INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');
3670 INSERT INTO REL_towns VALUES ('M', 'Montr&eacute;al');
3671 </pre>
3673 <p> To setup appropriate links and display information:</p>
3675 <ul><li>on table &quot;REL_persons&quot; click Structure, then Relation view</li>
3676 <li>in Links, for &quot;town_code&quot; choose &quot;REL_towns-&gt;code&quot;</li>
3677 <li>in Links, for &quot;country_code&quot; choose &quot;REL_countries-&gt;country_code&quot;</li>
3678 <li>on table &quot;REL_towns&quot; click Structure, then Relation view</li>
3679 <li>in &quot;Choose field to display&quot;, choose &quot;description&quot;</li>
3680 <li>repeat the two previous steps for table &quot;REL_countries&quot;</li>
3681 </ul>
3683 <p> Then test like this:</p>
3685 <ul><li>Click on your db name in the left frame</li>
3686 <li>Choose &quot;Query&quot;</li>
3687 <li>Use tables: persons, towns, countries</li>
3688 <li>Click &quot;Update query&quot;</li>
3689 <li>In the fields row, choose persons.person_name and click the
3690 &quot;Show&quot; tickbox </li>
3691 <li>Do the same for towns.description and countries.descriptions in the
3692 other 2 columns</li>
3693 <li>Click &quot;Update query&quot; and you will see in the query box that
3694 the correct joins have been generated</li>
3695 <li>Click &quot;Submit query&quot;</li>
3696 </ul>
3698 <h4 id="faqdisplay">
3699 <a href="#faqdisplay">6.7 How can I use the &quot;display field&quot; feature?</a></h4>
3701 Starting from the previous example, create the pma_table_info as explained
3702 in the configuration section, then browse your persons table,
3703 and move the mouse over a town code or country code.
3704 <br /><br />
3705 See also <a href="#faq6_21"><abbr title="Frequently Asked Questions">FAQ</abbr> 6.21</a> for an additional feature that &quot;display field&quot;
3706 enables: drop-down list of possible values.
3707 </p>
3709 <h4 id="faqpdf">
3710 <a href="#faqpdf">6.8 How can I produce a <abbr title="Portable Document Format">PDF</abbr> schema of my database?</a></h4>
3712 First the configuration variables &quot;relation&quot;,
3713 &quot;table_coords&quot; and &quot;pdf_pages&quot; have to be filled in.
3714 <br /><br />
3715 Then you need to think about your schema layout. Which tables will go on
3716 which pages?
3717 </p>
3718 <ul>
3719 <li>Select your database in the left frame.</li>
3720 <li>Choose &quot;Operations&quot; in the navigation bar at the top.</li>
3721 <li>Choose &quot;Edit <abbr title="Portable Document Format">PDF</abbr>
3722 Pages&quot; near the bottom of the page.</li>
3723 <li>Enter a name for the first <abbr title="Portable Document Format">PDF</abbr>
3724 page and click Go. If you like, you
3725 can use the &quot;automatic layout,&quot; which will put all your
3726 linked tables onto the new page.</li>
3727 <li>Select the name of the new page (making sure the Edit radio button
3728 is selected) and click Go.</li>
3729 <li>Select a table from the list, enter its coordinates and click Save.<br />
3730 Coordinates are relative; your diagram will
3731 be automatically scaled to fit the page. When initially placing tables
3732 on the page, just pick any coordinates -- say, 50x50. After clicking
3733 Save, you can then use the <a href="#wysiwyg">graphical editor</a> to
3734 position the element correctly.</li>
3735 <li>When you'd like to look at your <abbr title="Portable Document Format">PDF</abbr>,
3736 first be sure to click the Save
3737 button beneath the list of tables and coordinates, to save any changes
3738 you made there. Then scroll all the way down, select the
3739 <abbr title="Portable Document Format">PDF</abbr> options
3740 you want, and click Go.</li>
3741 <li>Internet Explorer for Windows may suggest an incorrect filename when
3742 you try to save a generated <abbr title="Portable Document Format">PDF</abbr>.
3743 When saving a generated <abbr title="Portable Document Format">PDF</abbr>, be
3744 sure that the filename ends in &quot;.pdf&quot;, for example
3745 &quot;schema.pdf&quot;. Browsers on other operating systems, and other
3746 browsers on Windows, do not have this problem.</li>
3747 </ul>
3749 <h4 id="faq6_9">
3750 <a href="#faq6_9">6.9 phpMyAdmin is changing the type of one of my
3751 columns!</a></h4>
3753 <p> No, it's MySQL that is doing
3754 <a href="http://www.mysql.com/doc/S/i/Silent_column_changes.html">silent
3755 column type changing</a>.</p>
3757 <h4 id="underscore">
3758 <a href="#underscore">6.10 When creating a privilege, what happens with
3759 underscores in the database name?</a></h4>
3761 <p> If you do not put a backslash before the underscore, this is a wildcard
3762 grant, and the underscore means &quot;any character&quot;. So, if the
3763 database name is &quot;john_db&quot;, the user would get rights to john1db,
3764 john2db ...<br /><br />
3766 If you put a backslash before the underscore, it means that the database
3767 name will have a real underscore.</p>
3769 <h4 id="faq6_11">
3770 <a href="#faq6_11">6.11 What is the curious symbol &oslash; in the
3771 statistics pages?</a></h4>
3773 <p> It means &quot;average&quot;.</p>
3775 <h4 id="faqexport">
3776 <a href="#faqexport">6.12 I want to understand some Export options.</a></h4>
3778 <p><b>Structure:</b></p>
3780 <ul><li>&quot;Add DROP TABLE&quot; will add a line telling MySQL to
3781 <a href="http://dev.mysql.com/doc/mysql/en/drop-table.html">drop the table</a>,
3782 if it already exists during the import. It does NOT drop the table after
3783 your export, it only affects the import file.</li>
3784 <li>&quot;If Not Exists&quot; will only create the table if it doesn't exist.
3785 Otherwise, you may get an error if the table name exists but has a
3786 different structure.</li>
3787 <li>&quot;Add AUTO_INCREMENT value&quot; ensures that AUTO_INCREMENT value
3788 (if any) will be included in backup.</li>
3789 <li>&quot;Enclose table and field names with backquotes&quot; ensures that
3790 field and table names formed with special characters are protected.</li>
3791 <li>&quot;Add into comments&quot; includes column comments, relations, and MIME
3792 types set in the pmadb in the dump as
3793 <abbr title="structured query language">SQL</abbr> comments (<i>/* xxx */</i>).
3794 </li>
3795 </ul>
3797 <p><b>Data:</b></p>
3799 <ul><li>&quot;Complete inserts&quot; adds the column names on every INSERT
3800 command, for better documentation (but resulting file is bigger).</li>
3801 <li>&quot;Extended inserts&quot; provides a shorter dump file by using only
3802 once the INSERT verb and the table name.</li>
3803 <li>&quot;Delayed inserts&quot; are best explained in the
3804 <a href="http://dev.mysql.com/doc/mysql/en/insert-delayed.html">MySQL manual</a>.
3805 </li>
3806 <li>&quot;Ignore inserts&quot; treats errors as a warning instead. Again,
3807 more info is provided in the
3808 <a href="http://dev.mysql.com/doc/mysql/en/insert.html">MySQL manual</a>,
3809 but basically with this selected, invalid values are adjusted and
3810 inserted rather than causing the entire statement to fail.</li>
3811 </ul>
3813 <h4 id="faq6_13">
3814 <a href="#faq6_13">6.13 I would like to create a database with a dot
3815 in its name.</a></h4>
3817 <p> This is a bad idea, because in MySQL the syntax &quot;database.table&quot;
3818 is the normal way to reference a database and table name. Worse, MySQL
3819 will usually let you create a database with a dot, but then you cannot
3820 work with it, nor delete it.</p>
3822 <h4 id="faqsqlvalidator">
3823 <a href="#faqsqlvalidator">6.14 How do I set up the
3824 <abbr title="structured query language">SQL</abbr> Validator?</a></h4>
3826 <p> To use it, you need a very recent version of PHP, 4.3.0 recommended, with
3827 <abbr title="Extensible Markup Language">XML</abbr>,
3828 <abbr title="Perl Compatible Regular Expressions">PCRE</abbr> and
3829 <abbr title="PHP Extension and Application Repository">PEAR</abbr> support.
3830 On your system command line, run <tt>"pear install Net_Socket Net_URL
3831 HTTP_Request Mail_Mime Net_DIME SOAP"</tt> to get the necessary
3832 <abbr title="PHP Extension and Application Repository">PEAR</abbr> modules
3833 for usage.<br />
3834 On a more recent pear version, I had problems with the state of Net_DIME
3835 being beta, so this single command
3836 <tt>"pear -d preferred_state=beta install -a SOAP"</tt> installed all the
3837 needed modules.<br />
3838 If you use the Validator, you should be aware that any
3839 <abbr title="structured query language">SQL</abbr> statement you
3840 submit will be stored anonymously (database/table/column names,
3841 strings, numbers replaced with generic values). The Mimer
3842 <abbr title="structured query language">SQL</abbr>
3843 Validator itself, is &copy; 2001 Upright Database Technology.
3844 We utilize it as free SOAP service.</p>
3846 <h4 id="faq6_15">
3847 <a href="#faq6_15">6.15 I want to add a BLOB field and put an index on
3848 it, but MySQL says &quot;BLOB column '...' used in key specification without
3849 a key length&quot;.</a></h4>
3851 <p> The right way to do this, is to create the field without any indexes,
3852 then display the table structure and use the &quot;Create an index&quot;
3853 dialog. On this page, you will be able to choose your BLOB field, and
3854 set a size to the index, which is the condition to create an index on
3855 a BLOB field.</p>
3857 <h4 id="faq6_16">
3858 <a href="#faq6_16">6.16 How can I simply move in page with plenty
3859 editing fields?</a></h4>
3861 <p> You can use Ctrl+arrows (Option+Arrows in Safari) for moving on most pages
3862 with many editing fields (table structure changes, row editing, etc.)
3863 (must be enabled in configuration - see.
3864 <a href="#CtrlArrowsMoving" class="configrule">$cfg['CtrlArrowsMoving']</a>).
3865 You can also have a look at the directive
3866 <a href="#DefaultPropDisplay" class="configrule">$cfg['DefaultPropDisplay']</a>
3867 ('vertical') and see if this eases up editing for you.</p>
3869 <h4 id="faq6_17">
3870 <a href="#faq6_17">6.17 Transformations: I can't enter my own mimetype!
3871 WTF is this feature then useful for?</a></h4>
3873 <p> Slow down :). Defining mimetypes is of no use, if you can't put transformations
3874 on them. Otherwise you could just put a comment on the field. Because entering
3875 your own mimetype will cause serious syntax checking issues and validation,
3876 this introduces a high-risk false-user-input situation. Instead you have to
3877 initialize mimetypes using functions or empty mimetype definitions.<br />
3878 Plus, you have a whole overview of available mimetypes. Who knows all those
3879 mimetypes by heart so he/she can enter it at will?</p>
3881 <h4 id="faqbookmark">
3882 <a href="#faqbookmark">6.18 Bookmarks: Where can I store bookmarks? Why
3883 can't I see any bookmarks below the query box? What is this variable for?
3884 </a></h4>
3886 <p> Any query you have executed can be stored as a bookmark on the page where the
3887 results are displayed. You will find a button labeled 'Bookmark this query'
3888 just at the end of the page.<br />
3889 As soon as you have stored a bookmark, it is related to the database you run
3890 the query on. You can now access a bookmark dropdown on each page, the query
3891 box appears on for that database.<br /><br />
3893 Since phpMyAdmin 2.5.0 you are also able to store variables for the bookmarks.
3894 Just use the string <b>/*[VARIABLE]*/</b> anywhere in your query. Everything
3895 which is put into the <i>value</i> input box on the query box page will
3896 replace the string &quot;/*[VARIABLE]*/&quot; in your stored query. Just be
3897 aware of that you HAVE to create a valid query, otherwise your query won't be
3898 even able to be stored in the database.<br />
3899 Also remember, that everything else inside the <b>/*[VARIABLE]*/</b> string
3900 for your query will remain the way it is, but will be stripped of the /**/
3901 chars. So you can use:<br /><br />
3903 <code>/*, [VARIABLE] AS myname */</code><br /><br />
3905 which will be expanded to<br /><br />
3907 <code>, VARIABLE as myname</code><br /><br />
3909 in your query, where VARIABLE is the string you entered in the input box. If
3910 an empty string is provided, no replacements are made.<br /><br />
3912 A more complex example. Say you have stored this query:<br /><br />
3913 <code>SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE '%[VARIABLE]%' */</code>
3914 <br /><br />
3916 Say, you now enter &quot;phpMyAdmin&quot; as the variable for the stored query,
3917 the full query will be:<br /><br />
3919 <code>SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE '%phpMyAdmin%'</code>
3920 <br /><br />
3922 You can use multiple occurrences of <b>/*[VARIABLE]*/</b> in a single query.<br />
3923 <b>NOTE THE ABSENCE OF SPACES</b> inside the &quot;/**/&quot; construct. Any
3924 spaces inserted there
3925 will be later also inserted as spaces in your query and may lead to unexpected
3926 results especially when
3927 using the variable expansion inside of a &quot;LIKE ''&quot; expression.<br />
3928 Your initial query which is going to be stored as a bookmark has to yield at
3929 least one result row so
3930 you can store the bookmark. You may have that to work around using well
3931 positioned &quot;/**/&quot; comments.</p>
3933 <h4 id="faq6_19">
3934 <a href="#faq6_19">6.19 How can I create simple L<sup>A</sup>T<sub><big>E</big></sub>X document to
3935 include exported table?</a></h4>
3937 <p> You can simply include table in your L<sup>A</sup>T<sub><big>E</big></sub>X documents, minimal sample
3938 document should look like following one (assuming you have table
3939 exported in file <code>table.tex</code>):</p>
3941 <pre>
3942 \documentclass{article} % or any class you want
3943 \usepackage{longtable} % for displaying table
3944 \begin{document} % start of document
3945 \include{table} % including exported table
3946 \end{document} % end of document
3947 </pre>
3949 <h4 id="faq6_20">
3950 <a href="#faq6_20">6.20 In MySQL 4, I see a lot of databases which are not mine, and cannot
3951 access them.
3952 </a></h4>
3954 <p> Upgrading to MySQL 4 usually gives users those global privileges: CREATE
3955 TEMPORARY TABLES, SHOW DATABASES, LOCK TABLES. Those privileges also
3956 enable users to see all the database names.
3957 See this <a href="http://bugs.mysql.com/179">bug report</a>.<br /><br />
3959 So if your users do not need those privileges, you can remove them and their
3960 databases list will shorten.</p>
3962 <h4 id="faq6_21">
3963 <a href="#faq6_21">6.21 In edit/insert mode, how can I see a list of
3964 possible values for a field, based on some foreign table?</a></h4>
3966 <p> You have to setup appropriate links between the tables, and also
3967 setup the &quot;display field&quot; in the foreign table. See
3968 <a href="#faq6_6"><abbr title="Frequently Asked Questions">FAQ</abbr>
3969 6.6</a> for an example. Then, if there are 100 values or less in the
3970 foreign table, a drop-down list of values will be available.
3971 You will see two lists of values, the first list containing the key
3972 and the display field, the second list containing the display field
3973 and the key. The reason for this is to be able to type the first
3974 letter of either the key or the display field.<br /><br />
3976 For 100 values or more, a distinct window will appear, to browse foreign
3977 key values and choose one. To change the default limit of 100, see
3978 <tt><a href="#cfg_ForeignKeyMaxLimit" class="configrule">$cfg['ForeignKeyMaxLimit']</a></tt>.</p>
3980 <h4 id="faq6_22">
3981 <a href="#faq6_22">6.22 Bookmarks: Can I execute a default bookmark
3982 automatically when entering Browse mode for a table?</a></h4>
3984 <p> Yes. If a bookmark has the same label as a table name, it will be executed.
3985 </p>
3987 <h4 id="faq6_23">
3988 <a href="#faq6_23">6.23 Export: I heard phpMyAdmin can export Microsoft
3989 Excel files, how can I enable that?</a></h4>
3991 <p> Current version does support direct export to Microsoft Excel and Word
3992 versions 2000 and newer. If you need export older versions, you can use
3993 <abbr title="comma separated values">CSV</abbr> suitable for Microsoft Excel,
3994 which works out of the box or you can
3995 try native <b>experimental</b> MS Excel exporter. <b>This export has
3996 several problems, most important are limitation of cell content to 255
3997 chars and no support for charsets, so think carefully whether you want to
3998 enable this.</b>. For enabling this you need to set
3999 <a href="#cfg_TempDir" class="configrule">$cfg['TempDir']</a> to
4000 place where web server user can write (for example <tt>'./tmp'</tt>) and
4001 install <abbr title="PHP Extension and Application Repository">PEAR</abbr>
4002 module Spreadsheet_Excel_Writer into php include path. The
4003 installation can be done by following command:</p>
4005 <pre>
4006 pear -d preferred_state=beta install -a Spreadsheet_Excel_Writer
4007 </pre>
4009 <p> First part of switches set we want to install beta version of that module
4010 (no stable version available yet) and then we tell pear we want to satisfy
4011 dependencies.</p>
4013 <p> If you are running in PHP safe mode, you will have to set
4014 in <tt>php.ini</tt> the <tt>safe_mode_include_dir</tt> to the directory
4015 where your <abbr title="PHP Extension and Application Repository">PEAR</abbr>
4016 modules are located, for example:</p>
4018 <pre>
4019 safe_mode_include_dir = /usr/local/lib/php
4020 </pre>
4022 <p> To create the temporary directory on a UNIX-based system, you can do:</p>
4024 <pre>
4025 cd phpMyAdmin
4026 mkdir tmp
4027 chmod o+rwx tmp
4028 </pre>
4030 <h4 id="faq6_24">
4031 <a href="#faq6_24">6.24 Now that phpMyAdmin supports native MySQL 4.1.x column comments,
4032 what happens to my column comments stored in pmadb?</a></h4>
4034 <p> Automatic migration of a table's pmadb-style column comments to the native
4035 ones is done whenever you enter Structure page for this table.</p>
4037 <h4 id="faq6_25">
4038 <a href="#faq6_25">6.25 How does BLOB streaming work in phpMyAdmin?</a></h4>
4040 <p> First, for general information about BLOB streaming on MySQL, visit <a href="http://blobstreaming.org">blobstreaming.org</a>. We currently support streaming if you are running MySQL 5.1 with the PBXT and PBMS storage engines.</p>
4042 <ol>
4043 <li>In <tt>config.inc.php</tt> your host should be defined with a FQDN (fully qualified domain name) instead of something like &quot;localhost&quot;.</li>
4044 <li>A current limitation is that your first login via phpMyAdmin to a freshly-started server must be done with an account that has the SUPER privilege.</li>
4045 <li>On your target database, go to Operations and in the &quot;BLOB Repository&quot; section, click &quot;Enable&quot;. This creates the PBMS system tables inside your database.</li>
4046 <li>Ensure that your target table has a LONGBLOB column.</li>
4047 <li>When you insert or update a row in this table, put a checkmark on the &quot;Upload to BLOB repository&quot; optional choice; otherwise, the upload will be done directly in your column instead of the repository.</li>
4048 <li>Finally when you browse your table, you'll see in your column a link to stream your data, for example &quot;View image&quot;. A header containing the correct MIME-type will be sent to your browser; this MIME-type was stored at upload time but in case it's incorrect, it's possible to edit it by clicking on the displayed MIME-type.</li>
4049 </ol>
4051 <h3 id="faqproject">phpMyAdmin project</h3>
4053 <h4 id="faq7_1">
4054 <a href="#faq7_1">7.1 I have found a bug. How do I inform developers?</a></h4>
4056 <p> Our Bug Tracker is located at
4057 <a href="http://sf.net/projects/phpmyadmin/">http://sf.net/projects/phpmyadmin/</a>
4058 under the Bugs section.<br /><br />
4060 But please first discuss your bug with other users:<br />
4061 <a href="http://sf.net/projects/phpmyadmin/">
4062 http://sf.net/projects/phpmyadmin/</a> (and choose Forums)</p>
4064 <h4 id="faq7_2">
4065 <a href="#faq7_2">7.2 I want to translate the messages to a new language or upgrade an
4066 existing language, where do I start?</a></h4>
4068 <p> Always use the current SVN version of your language file.
4069 For a new language, start from <i>english-utf-8.inc.php</i>. If you
4070 don't know how to get the SVN version, please ask one of the developers.
4071 <br />
4072 Please note that we try not to use HTML entities like &amp;eacute; in
4073 the translations, since we define the right character set in the file.
4074 With HTML entities, the text on JavaScript messages would not
4075 display correctly.
4076 However there are some entities that need to be there, for quotes
4077 ,non-breakable spaces, ampersands, less than, greater than.<br />
4078 You can then put your translations, as a zip file to avoid losing special
4079 characters, on the sourceforge.net translation tracker.<br />
4080 It would be a good idea to subscribe to the phpmyadmin-translators mailing
4081 list, because this is where we ask for translations of new messages.</p>
4083 <h4 id="faq7_3">
4084 <a href="#faq7_3">7.3 I would like to help out with the development of
4085 phpMyAdmin. How should I proceed?</a></h4>
4087 <p> The following method is preferred for new developers:</p>
4089 <ol><li>fetch the current SVN tree over anonymous SVN:<br />
4090 <tt>svn co https://phpmyadmin.svn.sourceforge.net/svnroot/phpmyadmin/trunk/phpMyAdmin</tt><br />
4091 </li>
4092 <li>add your stuff</li>
4093 <li>generate patch with your changes:
4094 <tt>svn diff</tt><br />
4095 </li>
4096 <li>put the patch inside the <a
4097 href="https://sourceforge.net/tracker/?group_id=23067&amp;atid=377410">patch
4098 tracker of the phpMyAdmin project</a>.
4099 </li>
4100 </ol>
4102 <p> Write access to the SVN tree is granted only to experienced developers who
4103 have already contributed something useful to phpMyAdmin.<br />
4104 Also, have a look at the <a href="#developers">Developers section</a>.</p>
4106 <h3 id="faqsecurity">Security</h3>
4108 <h4 id="faq8_1">
4109 <a href="#faq8_1">8.1 Where can I get information about the security alerts issued for phpMyAdmin?</a></h4>
4111 <p> Please refer to
4112 <a href="http://www.phpmyadmin.net/home_page/security.php">http://www.phpmyadmin.net/home_page/security.php</a>
4113 </p>
4115 <!-- DEVELOPERS -->
4116 <h2 id="developers">Developers Information</h2>
4118 <p> phpMyAdmin is Open Source, so you're invited to contribute to it. Many
4119 great features have been written by other people and you too can help to
4120 make phpMyAdmin a useful tool.</p>
4122 <p> If you're planning to contribute source, please read the following
4123 information:</p>
4125 <ul><li>All files include <i>libraries/header.inc.php</i> (layout),.
4126 <i>libraries/common.lib.php</i> (common functions) and
4127 <i>config.inc.php</i>.<br />
4128 Only configuration data should go in <i>config.inc.php</i>. Please keep
4129 it free from other code.<br />
4130 Commonly used functions should be added to
4131 <i>libraries/common.lib.php</i> and more specific ones may be added
4132 within a library stored into the <i>libraries</i> sub-directory.</li>
4133 <li>Obviously, you're free to use whatever coding style you want. But
4134 please try to keep your code as simple as possible: beginners are
4135 using phpMyAdmin as an example application.<br />
4136 As far as possible, we want the scripts to be XHTML1.0 and CSS2
4137 compliant on one hand, they fit the
4138 <a href="http://pear.php.net/">
4139 <abbr title="PHP Extension and Application Repository">PEAR</abbr>
4140 coding standards</a>
4141 on the other hand. Please pay attention to this.</li>
4142 <li>Please try to keep up the file-naming conventions. Table-related stuff
4143 goes to <i>tbl_*.php</i>, db-related code to <i>db_*.php</i>,
4144 server-related tools to <i>server_*.php</i> and so on.</li>
4145 <li>Please don't put message strings in your code, instead add the string
4146 (at least) to <i>english-utf-8.inc.php</i> and print() it out.</li>
4147 <li>If you want to be really helpful, write an entry for the ChangeLog.</li>
4148 <li id="developersdbg">
4149 The DBG extension (<a href="http://dd.cron.ru/dbg/">PHP
4150 Debugger DBG</a>) is now supported by phpMyAdmin for developers to
4151 better debug and profile their code.<br />
4152 Please see the
4153 <a href="#cfg_DBG" class="configrule">$cfg['DBG']*</a> configuration
4154 options for more information.<br />
4155 This is in memoriam of the Space Shuttle Columbia (STS-107) which was
4156 lost during its re-entry into Earth's atmosphere and in memory of the
4157 brave men and women who gave their lives for the people of Earth.</li>
4158 </ul>
4160 <h2 id="copyright">Copyright</h2>
4162 <pre>
4163 Copyright (C) 1998-2000 Tobias Ratschiller &lt;tobias_at_ratschiller.com&gt;
4164 Copyright (C) 2001-2008 Marc Delisle &lt;Marc.Delisle_at_cegepsherbrooke.qc.ca&gt;
4165 Olivier Müller &lt;om_at_omnis.ch&gt;
4166 Robin Johnson &lt;robbat2_at_users.sourceforge.net&gt;
4167 Alexander M. Turek &lt;me_at_derrabus.de&gt;
4168 Michal ÄŒihaÅ™ &lt;michal_at_cihar.com&gt;
4169 Garvin Hicking &lt;me_at_supergarv.de&gt;
4170 Michael Keck &lt;mkkeck_at_users.sourceforge.net&gt;
4171 Sebastian Mendel &lt;cybot_tm_at_users.sourceforge.net&gt;
4172 [check <a href="#credits">credits</a> for more details]
4174 This program is free software; you can redistribute it and/or modify
4175 it under the terms of the GNU General Public License version 2,
4176 as published by the Free Software Foundation.
4178 This program is distributed in the hope that it will be useful,
4179 but WITHOUT ANY WARRANTY; without even the implied warranty of
4180 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4181 GNU General Public License for more details.
4183 You should have received a copy of the GNU General Public License
4184 along with this program; if not, write to the Free Software
4185 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
4186 </pre>
4188 <!-- CREDITS -->
4189 <h2 id="credits">Credits</h2>
4191 <pre>
4192 phpMyAdmin - Credits
4193 ====================
4195 CREDITS, in chronological order
4196 -------------------------------
4198 - Tobias Ratschiller &lt;tobias_at_ratschiller.com&gt;
4199 * creator of the phpmyadmin project
4200 * maintainer from 1998 to summer 2000
4202 - Marc Delisle &lt;Marc.Delisle_at_cegepsherbrooke.qc.ca&gt;
4203 * multi-language version
4204 * various fixes and improvements
4205 * <abbr title="structured query language">SQL</abbr> analyser (most of it)
4206 * current project maintainer
4208 - Olivier M&uuml;ller &lt;om_at_omnis.ch&gt;
4209 * started SourceForge phpMyAdmin project in March 2001
4210 * sync'ed different existing CVS trees with new features and bugfixes
4211 * multi-language improvements, dynamic language selection
4212 * current project maintainer
4213 * many bugfixes and improvements
4215 - Lo&iuml;c Chapeaux &lt;lolo_at_phpheaven.net&gt;
4216 * rewrote and optimized javascript, DHTML and DOM stuff
4217 * rewrote the scripts so they fit the <abbr title="PHP Extension and Application Repository">PEAR</abbr> coding standards and
4218 generate XHTML1.0 and CSS2 compliant codes
4219 * improved the language detection system
4220 * many bugfixes and improvements
4222 - Robin Johnson &lt;robbat2_at_users.sourceforge.net&gt;
4223 * database maintenance controls
4224 * table type code
4225 * Host authentication <abbr title="Internet Protocol">IP</abbr> Allow/Deny
4226 * DB-based configuration (Not completed)
4227 * <abbr title="structured query language">SQL</abbr> parser and pretty-printer
4228 * <abbr title="structured query language">SQL</abbr> validator
4229 * many bugfixes and improvements
4231 - Armel Fauveau &lt;armel.fauveau_at_globalis-ms.com&gt;
4232 * bookmarks feature
4233 * multiple dump feature
4234 * gzip dump feature
4235 * zip dump feature
4237 - Geert Lund &lt;glund_at_silversoft.dk&gt;
4238 * various fixes
4239 * moderator of the phpMyAdmin former users forum at phpwizard.net
4241 - Korakot Chaovavanich &lt;korakot_at_iname.com&gt;
4242 * &quot;insert as new row&quot; feature
4244 - Pete Kelly &lt;webmaster_at_trafficg.com&gt;
4245 * rewrote and fix dump code
4246 * bugfixes
4248 - Steve Alberty &lt;alberty_at_neptunlabs.de&gt;
4249 * rewrote dump code for PHP4
4250 * mySQL table statistics
4251 * bugfixes
4253 - Benjamin Gandon &lt;gandon_at_isia.cma.fr&gt;
4254 * main author of the version 2.1.0.1
4255 * bugfixes
4257 - Alexander M. Turek &lt;me_at_derrabus.de&gt;
4258 * MySQL 4.0 / 4.1 / 5.0 compatibility
4259 * abstract database interface (PMA_DBI) with MySQLi support
4260 * privileges administration
4261 * <abbr title="Extensible Markup Language">XML</abbr> exports
4262 * various features and fixes
4263 * German language file updates
4265 - Mike Beck &lt;mike.beck_at_web.de&gt;
4266 * automatic joins in QBE
4267 * links column in printview
4268 * Relation view
4270 - Michal &#268;iha&#345; &lt;michal_at_cihar.com&gt;
4271 * enhanced index creation/display feature
4272 * feature to use a different charset for HTML than for MySQL
4273 * improvements of export feature
4274 * various features and fixes
4275 * Czech language file updates
4277 - Christophe Gesch&eacute; from the &quot;MySQL Form Generator for PHPMyAdmin&quot;
4278 (http://sf.net/projects/phpmysqlformgen/)
4279 * suggested the patch for multiple table printviews
4281 - Garvin Hicking &lt;me_at_supergarv.de&gt;
4282 * built the patch for vertical display of table rows
4283 * built the Javascript based Query window + <abbr title="structured query language">SQL</abbr> history
4284 * Improvement of column/db comments
4285 * (MIME)-Transformations for columns
4286 * Use custom alias names for Databases in left frame
4287 * hierarchical/nested table display
4288 * <abbr title="Portable Document Format">PDF</abbr>-scratchboard for WYSIWYG-distribution of <abbr title="Portable Document Format">PDF</abbr> relations
4289 * new icon sets
4290 * vertical display of column properties page
4291 * some bugfixes, features, support, German language additions
4293 - Yukihiro Kawada &lt;kawada_at_den.fujifilm.co.jp&gt;
4294 * japanese kanji encoding conversion feature
4296 - Piotr Roszatycki &lt;d3xter_at_users.sourceforge.net&gt; and Dan Wilson
4297 * the Cookie authentication mode
4299 - Axel Sander &lt;n8falke_at_users.sourceforge.net&gt;
4300 * table relation-links feature
4302 - Maxime Delorme &lt;delorme.maxime_at_free.fr&gt;
4303 * <abbr title="Portable Document Format">PDF</abbr> schema output, thanks also to Olivier Plathey for the
4304 &quot;FPDF&quot; library (see <a href="http://www.fpdf.org/">http://www.fpdf.org/</a>) and Steven Wittens
4305 for the &quot;UFPDF&quot; library (see <a href="http://www.acko.net/node/56">http://www.acko.net/node/56</a>).
4307 - Olof Edlund &lt;olof.edlund_at_upright.se&gt;
4308 * <abbr title="structured query language">SQL</abbr> validator server
4310 - Ivan R. Lanin &lt;ivanlanin_at_users.sourceforge.net&gt;
4311 * phpMyAdmin logo (until June 2004)
4313 - Mike Cochrane &lt;mike_at_graftonhall.co.nz&gt;
4314 * blowfish library from the Horde project
4316 - Marcel Tschopp &lt;ne0x_at_users.sourceforge.net&gt;
4317 * mysqli support
4318 * many bugfixes and improvements
4320 - Michael Keck &lt;mkkeck_at_users.sourceforge.net&gt;
4321 * redesign for 2.6.0
4322 * phpMyAdmin sailboat logo (June 2004)
4324 - Mathias Landh&auml;u&szlig;er
4325 * Representation at conferences
4327 - Sebastian Mendel &lt;cybot_tm_at_users.sourceforge.net&gt;
4328 * interface improvements
4329 * various bugfixes
4331 - Ivan A Kirillov
4332 * new relations Designer
4334 - Raj Kissu Rajandran (Google Summer of Code 2008)
4335 * BLOBstreaming support
4337 - Piotr Przybylski (Google Summer of Code 2008)
4338 * improved setup script
4340 And also to the following people who have contributed minor changes,
4341 enhancements, bugfixes or support for a new language since version 2.1.0:
4343 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
4344 P&eacute;ter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
4345 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kl&auml;ger,
4346 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
4347 Bernard M. Piller, Laurent Haas, &quot;Sakamoto&quot;, Yuval Sarna,
4348 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
4349 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
4350 Lu&iacute;s V., Martijn W. van der Lee,
4351 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
4352 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, &quot;Manuzhai&quot;.
4355 Original Credits of Version 2.1.0
4356 ---------------------------------
4358 This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
4359 to create a web-based interface to MySQL using PHP3. Although I have not
4360 used any of his source-code, there are some concepts I've borrowed from
4361 him. phpMyAdmin was created because Peter told me he wasn't going to
4362 further develop his (great) tool.
4363 Thanks go to
4364 - Amalesh Kempf &lt;ak-lsml_at_living-source.com&gt; who contributed the
4365 code for the check when dropping a table or database. He also suggested
4366 that you should be able to specify the primary key on tbl_create.php3. To
4367 version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
4368 well as a bug-report. Plus many smaller improvements.
4369 - Jan Legenhausen &lt;jan_at_nrw.net&gt;: He made many of the changes that
4370 were introduced in 1.3.0 (including quite significant ones like the
4371 authentication). For 1.4.1 he enhanced the table-dump feature. Plus
4372 bug-fixes and help.
4373 - Marc Delisle &lt;DelislMa_at_CollegeSherbrooke.qc.ca&gt; made phpMyAdmin
4374 language-independent by outsourcing the strings to a separate file. He
4375 also contributed the French translation.
4376 - Alexandr Bravo &lt;abravo_at_hq.admiral.ru&gt; who contributed
4377 tbl_select.php3, a feature to display only some fields from a table.
4378 - Chris Jackson &lt;chrisj_at_ctel.net&gt; added support for MySQL
4379 functions in tbl_change.php3. He also added the
4380 &quot;Query by Example&quot; feature in 2.0.
4381 - Dave Walton &lt;walton_at_nordicdms.com&gt; added support for multiple
4382 servers and is a regular contributor for bug-fixes.
4383 - Gabriel Ash &lt;ga244_at_is8.nyu.edu&gt; contributed the random access
4384 features for 2.0.6.
4385 The following people have contributed minor changes, enhancements, bugfixes
4386 or support for a new language:
4387 Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
4388 Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
4389 Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
4390 G. Wieggers.
4392 And thanks to everyone else who sent me email with suggestions, bug-reports
4393 and or just some feedback.
4394 </pre>
4396 <h2 id="glossary">Glossary</h2>
4398 <p> From Wikipedia, the free encyclopedia</p>
4400 <ul>
4401 <li><a href="http://www.wikipedia.org/wiki/.htaccess">.htaccess</a>
4402 - the default name of Apache's directory-level configuration file.</li>
4403 <li><a href="http://www.wikipedia.org/wiki/Blowfish_%28cipher%29">Blowfish</a>
4404 - a keyed, symmetric block cipher, designed in 1993 by Bruce Schneier.</li>
4405 <li><a href="http://www.wikipedia.org/wiki/Browser">Browser (Web Browser)</a>
4406 - a software application that enables a user to display and interact with
4407 text, images, and other information typically located on a web page at a
4408 website on the World Wide Web.</li>
4409 <li><a href="http://www.wikipedia.org/wiki/Bzip2">bzip2</a>
4410 - a free software/open source data compression algorithm and program
4411 developed by Julian Seward.</li>
4412 <li><a href="http://www.wikipedia.org/wiki/CGI">CGI (Common Gateway Interface)</a>
4413 - an important World Wide Web technology that enables a client web browser
4414 to request data from a program executed on the Web server.</li>
4415 <li><a href="http://www.wikipedia.org/wiki/Changelog">Changelog</a>
4416 - a log or record of changes made to a project.</li>
4417 <li><a href="http://www.wikipedia.org/wiki/Client_%28computing%29">Client</a>
4418 - a computer system that accesses a (remote) service on another computer
4419 by some kind of network.</li>
4420 <li><a href="http://www.wikipedia.org/wiki/Column_%28database%29">column</a>
4421 - a set of data values of a particular simple type, one for each row of
4422 the table.</li>
4423 <li><a href="http://www.wikipedia.org/wiki/HTTP_cookie">Cookie</a>
4424 - a packet of information sent by a server to a World Wide Web browser
4425 and then sent back by the browser each time it accesses that server.</li>
4426 <li><a href="http://www.wikipedia.org/wiki/Comma-separated_values">CSV</a>
4427 - Comma-separated values</li>
4428 <li>DB - look at <a href="#database">Database</a>.</li>
4429 <li><a id="database" href="http://www.wikipedia.org/wiki/Database">database</a>
4430 - an organized collection of data.</li>
4431 <li>Engine - look at <a href="#glossar_storage_engine">Storage Engines</a>.</li>
4432 <li><a href="http://www.wikipedia.org/wiki/extension">extension</a>
4433 - a PHP module that extends PHP with additional functionality.</li>
4434 <li><a href="http://www.wikipedia.org/wiki/FAQ">FAQ (Frequently Asked Questions)</a>
4435 - a list of commonly asked question and there answers.</li>
4436 <li><a href="http://www.wikipedia.org/wiki/Field_%28computer_science%29">Field</a>
4437 - one part of divided data/columns.</li>
4438 <li><a href="http://www.wikipedia.org/wiki/Foreign_key">foreign key</a>
4439 - a field or group of fields in a database record that point to a key
4440 field or group of fields forming a key of another database record in some
4441 (usually different) table.</li>
4442 <li><a href="http://www.fpdf.org/">FPDF (FreePDF)</a>
4443 - the free PDF library</li>
4444 <li><a id="gd" href="http://www.wikipedia.org/wiki/GD_Graphics_Library">
4445 GD Graphics Library</a> - a library by Thomas Boutell and others for
4446 dynamically manipulating images.</li>
4447 <li>GD2 - look at <a href="#gd">GD Graphics Library</a>.</li>
4448 <li><a href="http://www.wikipedia.org/wiki/Gzip">gzip</a>
4449 - gzip is short for GNU zip, a GNU free software file compression
4450 program.</li>
4451 <li><a href="http://www.wikipedia.org/wiki/Host">host</a>
4452 - any machine connected to a computer network, a node that has a hostname.</li>
4453 <li><a href="http://www.wikipedia.org/wiki/Hostname">hostname</a>
4454 - the unique name by which a network attached device is known on a network.</li>
4455 <li><a href="http://www.wikipedia.org/wiki/HyperText_Transfer_Protocol">HTTP
4456 (HyperText Transfer Protocol)</a>
4457 - the primary method used to transfer or convey information on the World
4458 Wide Web.</li>
4459 <li><a href="http://www.wikipedia.org/wiki/Https:_URI_scheme">https</a>
4460 - a <abbr title="HyperText Transfer Protocol">HTTP</abbr>-connection with
4461 additional security measures.</li>
4462 <li><a href="http://www.wikipedia.org/wiki/Internet_Information_Services">IIS (Internet Information Services)</a>
4463 - a set of Internet-based services for servers using Microsoft Windows.</li>
4464 <li><a id="glossar_index" href="http://www.wikipedia.org/wiki/Index_%28database%29">Index</a>
4465 - a feature that allows quick access to the rows in a table.</li>
4466 <li><a href="http://www.wikipedia.org/wiki/Internet_Protocol">IP (Internet Protocol)</a>
4467 - a data-oriented protocol used by source and destination hosts for
4468 communicating data across a packet-switched internetwork.</li>
4469 <li><a href="http://www.wikipedia.org/wiki/IP_Address">IP Address</a>
4470 - a unique number that devices use in order to identify and communicate
4471 with each other on a network utilizing the Internet Protocol standard.</li>
4472 <li><a href="http://www.wikipedia.org/wiki/ISAPI">ISAPI
4473 (Internet Server Application Programming Interface)</a>
4474 - the API of Internet Information Services (IIS).</li>
4475 <li><a href="http://www.wikipedia.org/wiki/ISP">ISP (Internet service provider)</a>
4476 - a business or organization that offers users access to the Internet and related services.</li>
4477 <li><a id="jpeg" href="http://www.wikipedia.org/wiki/JPEG">JPEG</a>
4478 - a most commonly used standard method of lossy compression for
4479 photographic images.</li>
4480 <li>JPG - look at <a href="#jpeg">JPEG</a>.</li>
4481 <li>Key - look at <a href="#glossar_index">index</a>.</li>
4482 <li><a href="http://www.wikipedia.org/wiki/LaTeX">L<sup>A</sup>T<sub><big>E</big></sub>X</a>
4483 - a document preparation system for the T<sub>E</sub>X typesetting program.</li>
4484 <li><a href="http://www.wikipedia.org/wiki/Mac">Mac (Apple Macintosh)</a>
4485 - line of personal computers is designed, developed, manufactured, and
4486 marketed by Apple Computer.</li>
4487 <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>
4488 - the operating system which is included with all currently shipping Apple
4489 Macintosh computers in the consumer and professional markets.</li>
4490 <li><a href="http://www.wikipedia.org/wiki/MCrypt">MCrypt</a>
4491 - a cryptographic library.</li>
4492 <li><a href="http://php.net/mcrypt">mcrypt</a>
4493 - the MCrypt PHP extension.</li>
4494 <li><a href="http://www.wikipedia.org/wiki/MIME">MIME (Multipurpose Internet Mail Extensions)</a>
4495 - an Internet Standard for the format of e-mail.</li>
4496 <li><a href="http://www.wikipedia.org/wiki/module">module</a>
4497 - some sort of extension for the Apache Webserver.</li>
4498 <li><a href="http://www.wikipedia.org/wiki/MySQL">MySQL</a>
4499 - a multithreaded, multi-user, SQL (Structured Query Language) Database
4500 Management System (DBMS).</li>
4501 <li><a href="http://php.net/mysqli">mysqli</a>
4502 - the improved MySQL client PHP extension.</li>
4503 <li><a href="http://php.net/mysql">mysql</a>
4504 - the MySQL client PHP extension.</li>
4505 <li><a href="http://www.wikipedia.org/wiki/OpenDocument">OpenDocument</a>
4506 - open standard for office documents.</li>
4507 <li><a href="http://www.wikipedia.org/wiki/OS_X"><abbr title="operating system">OS</abbr> X</a>
4508 - look at <a href="#glossar_mac_os_x"><acronym title="Apple Macintosh">Mac</acronym> <abbr title="operating system">OS</abbr> X</a>.</li>
4509 <li><a href="http://www.wikipedia.org/wiki/Portable_Document_Format">PDF
4510 (Portable Document Format)</a>
4511 - a file format developed by Adobe Systems for representing two
4512 dimensional documents in a device independent and resolution independent
4513 format.</li>
4514 <li><a href="http://pear.php.net/">PEAR</a>
4515 - the PHP Extension and Application Repository.</li>
4516 <li><a href="http://php.net/pcre">PCRE (Perl Compatible Regular Expressions)</a>
4517 - the perl-compatible regular expression functions for PHP</li>
4518 <li><a href="http://www.wikipedia.org/wiki/PHP">PHP</a>
4519 - short for "PHP: Hypertext Preprocessor", is an open-source, reflective
4520 programming language used mainly for developing server-side applications
4521 and dynamic web content, and more recently, a broader range of software
4522 applications.</li>
4523 <li><a href="http://www.wikipedia.org/wiki/Port_%28computing%29">port</a>
4524 - a connection through which data is sent and received.</li>
4525 <li><a href="http://www.wikipedia.org/wiki/Request_for_Comments">RFC</a>
4526 - Request for Comments (RFC) documents are a series of memoranda
4527 encompassing new research, innovations, and methodologies applicable to
4528 Internet technologies.</li>
4529 <li><a href="http://www.ietf.org/rfc/rfc1952.txt">RFC 1952</a>
4530 - GZIP file format specification version 4.3</li>
4531 <li><a href="http://www.wikipedia.org/wiki/Row_%28database%29">Row (record, tulpel)</a>
4532 - represents a single, implicitly structured data item in a table.</li>
4533 <li><a href="http://www.wikipedia.org/wiki/Server_%28computing%29">Server</a>
4534 - a computer system that provides services to other computing
4535 systems over a network.</li>
4536 <li><a id="glossar_storage_engine" href="http://dev.mysql.com/doc/refman/5.0/en/storage-engines.html">Storage Engines</a>
4537 - handlers for different table types</li>
4538 <li><a href="http://www.wikipedia.org/wiki/Socket#Computer_sockets">socket</a>
4539 - a form of inter-process communication.</li>
4540 <li><a href="http://www.wikipedia.org/wiki/Secure_Sockets_Layer">SSL (Secure
4541 Sockets Layer)</a>
4542 - a cryptographic protocol which provides secure communication on the Internet.</li>
4543 <li><a href="http://www.wikipedia.org/wiki/SQL">SQL</a>
4544 - Structured Query Language</li>
4545 <li><a href="http://www.wikipedia.org/wiki/Table_%28database%29">table</a>
4546 - a set of data elements (cells) that is organized, defined and stored as
4547 horizontal rows and vertical columns where each item can be uniquely
4548 identified by a label or key or by it?s position in relation to other items.</li>
4549 <li>Table type</li>
4550 <li><a href="http://www.wikipedia.org/wiki/Tar_%28file_format%29">tar</a>
4551 - a type of archive file format: the Tape ARchive format.</li>
4552 <li><a href="http://www.wikipedia.org/wiki/TCP">TCP (Transmission Control Protocol)</a>
4553 - one of the core protocols of the Internet protocol suite.</li>
4554 <li><a href="http://www.acko.net/node/56">UFPDF</a>
4555 - Unicode/UTF-8 extension for FPDF</li>
4556 <li><a href="http://www.wikipedia.org/wiki/URL">URL (Uniform Resource Locator)</a>
4557 - a sequence of characters, conforming to a standardized format, that is
4558 used for referring to resources, such as documents and images on the
4559 Internet, by their location.</li>
4560 <li><a href="http://www.wikipedia.org/wiki/Webserver">Webserver</a>
4561 - A computer (program) that is responsible for accepting HTTP requests
4562 from clients and serving them Web pages.</li>
4563 <li><a href="http://www.wikipedia.org/wiki/XML">XML (Extensible Markup Language)</a>
4564 - a W3C-recommended general-purpose markup language for creating
4565 special-purpose markup languages, capable of describing many different
4566 kinds of data.</li>
4567 <li><a href="http://www.wikipedia.org/wiki/ZIP_%28file_format%29">ZIP</a>
4568 - a popular data compression and archival format.</li>
4569 <li><a href="http://www.wikipedia.org/wiki/Zlib">zlib</a>
4570 - an open-source, cross-platform data compression library by Jean-loup
4571 Gailly and Mark Adler.</li>
4572 </ul>
4573 </div>
4576 <ul id="footer">
4577 <li>Copyright &copy; 2003 - 2008 <a href="${base_url}team.${file_ext}">phpMyAdmin devel team</a></li>
4578 <li><a href="LICENSE">License</a></li>
4579 <li><a href="http://www.phpmyadmin.net/home_page/donate.php">Donate</a></li>
4580 <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>
4581 </ul>
4582 </body>
4583 </html>