is*() methods now return boolean values;
[phpmyadmin.git] / Documentation.html
blobd63b03859d58891a49e9bb002d06e462a0ae56fc
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)<br />
1125 Also IPv6 addresses are not supported.
1126 </dd>
1127 <dt><span id="cfg_Servers_SignonSession">$cfg['Servers'][$i]['SignonSession']</span> string</dt>
1128 <dd>Name of session which will be used for signon authentication method.
1129 </dd>
1130 <dt><span id="cfg_Servers_SignonURL">$cfg['Servers'][$i]['SignonURL']</span> string</dt>
1131 <dd>URL where user will be redirected to log in for signon authentication method. Should be absolute including protocol.
1132 </dd>
1133 <dt><span id="cfg_Servers_LogoutURL">$cfg['Servers'][$i]['LogoutURL']</span> string</dt>
1134 <dd>URL where user will be redirected after logout (doesn't affect config authentication method). Should be absolute including protocol.
1135 </dd>
1137 <dt id="cfg_ServerDefault">$cfg['ServerDefault'] integer</dt>
1138 <dd>If you have more than one server configured, you can set
1139 <tt>$cfg['ServerDefault']</tt> to any one of them to autoconnect to
1140 that server when phpMyAdmin is started, or set it to 0 to be given a
1141 list of servers without logging in.<br />
1142 If you have only one server configured, <tt>$cfg['ServerDefault']</tt>
1143 MUST be set to that server.</dd>
1145 <dt id="cfg_MaxDbList">$cfg['MaxDbList'] integer</dt>
1146 <dd>The maximum number of database names to be displayed in the
1147 navigation frame and the database list.</dd>
1149 <dt id="cfg_MaxTableList">$cfg['MaxTableList'] integer</dt>
1150 <dd>The maximum number of table names to be displayed in the
1151 main panel's list (except on the Export page). This limit is also enforced in the navigation panel
1152 when in Light mode.</dd>
1154 <dt id="cfg_MaxCharactersInDisplayedSQL">$cfg['MaxCharactersInDisplayedSQL'] integer</dt>
1155 <dd>The maximum number of characters when a SQL query is displayed. The
1156 default limit of 1000 should be correct to avoid the display of tons
1157 of hexadecimal codes that represent BLOBs, but some users have real
1158 SQL queries that are longer than 1000 characters. Also, if a query's
1159 length exceeds this limit, this query is not saved in the history.</dd>
1161 <dt id="cfg_OBGzip">$cfg['OBGzip'] string/boolean</dt>
1162 <dd>Defines whether to use GZip output buffering for increased
1163 speed in <abbr title="HyperText Transfer Protocol">HTTP</abbr> transfers.<br />
1164 Set to true/false for enabling/disabling. When set to 'auto' (string),
1165 phpMyAdmin tries to enable output buffering and will automatically disable
1166 it if your browser has some problems with buffering. IE6 with a certain patch
1167 is known to cause data corruption when having enabled buffering.</dd>
1169 <dt id="cfg_PersistentConnections">$cfg['PersistentConnections'] boolean</dt>
1170 <dd>Whether persistent connections should be used or not (mysql_connect or
1171 mysql_pconnect).</dd>
1173 <dt id="cfg_ForceSSL">$cfg['ForceSSL'] boolean</dt>
1174 <dd>Whether to force using https while accessing phpMyAdmin.</dd>
1176 <dt id="cfg_ExecTimeLimit">$cfg['ExecTimeLimit'] integer [number of seconds]</dt>
1177 <dd>Set the number of seconds a script is allowed to run. If seconds is set
1178 to zero, no time limit is imposed.<br />
1179 This setting is used while importing/exporting dump files but has no
1180 effect when PHP is running in safe mode.</dd>
1182 <dt id="cfg_MemoryLimit">$cfg['MemoryLimit'] integer [number of bytes]</dt>
1183 <dd>Set the number of bytes a script is allowed to allocate. If number set
1184 to zero, no limit is imposed.<br />
1185 This setting is used while importing/exporting dump files but has no
1186 effect when PHP is running in safe mode.<br />
1187 You can also use any string as in php.ini, eg. '16M'.</dd>
1189 <dt id="cfg_SkipLockedTables">$cfg['SkipLockedTables'] boolean</dt>
1190 <dd>Mark used tables and make it possible to show databases with locked
1191 tables (since MySQL 3.23.30).</dd>
1193 <dt id="cfg_ShowSQL">$cfg['ShowSQL'] boolean</dt>
1194 <dd>Defines whether <abbr title="structured query language">SQL</abbr> queries
1195 generated by phpMyAdmin should be displayed or not.</dd>
1197 <dt id="cfg_AllowUserDropDatabase">$cfg['AllowUserDropDatabase'] boolean</dt>
1198 <dd>Defines whether normal users (non-administrator) are allowed to
1199 delete their own database or not. If set as FALSE, the link &quot;Drop
1200 Database&quot; will not be shown, and even a &quot;DROP DATABASE
1201 mydatabase&quot; will be rejected. Quite practical for
1202 <abbr title="Internet service provider">ISP</abbr>'s with many
1203 customers.<br />
1204 Please note that this limitation of SQL queries is not as strict as
1205 when using MySQL privileges. This is due to nature of SQL queries
1206 which might be quite complicated. So this choice should be viewed as
1207 help to avoid accidental dropping rather than strict privilege
1208 limitation.</dd>
1210 <dt id="cfg_Confirm">$cfg['Confirm'] boolean</dt>
1211 <dd>Whether a warning (&quot;Are your really sure...&quot;) should be
1212 displayed when you're about to lose data.</dd>
1214 <dt id="cfg_LoginCookieRecall">$cfg['LoginCookieRecall'] boolean</dt>
1215 <dd>Define whether the previous login should be recalled or not in cookie
1216 authentication mode.<br /><br />
1218 This is automatically diabled if you do not have configured
1219 <tt><a href="#cfg_blowfish_secret">$cfg['blowfish_secret']</a></tt>.
1220 </dd>
1222 <dt id="cfg_LoginCookieValidity">$cfg['LoginCookieValidity'] integer [number of seconds]</dt>
1223 <dd>Define how long is login cookie valid. Please note that php
1224 configuration option <a href="http://php.net/manual/en/session.configuration.php#ini.session.gc-maxlifetime">session.gc-maxlifetime</a>
1225 might limit session validity and if session is lost, login cookie is
1226 also invalidated. So it is good idea to set <code>session.gc-maxlifetime</code>
1227 at least as high is $cfg['LoginCookieValidity'] is set.</dd>
1229 <dt id="cfg_LoginCookieStore">$cfg['LoginCookieStore'] integer [number of seconds]</dt>
1230 <dd>Define how long is login cookie should be stored in browser. Default 0
1231 means that it will be kept for existing session. This is recommended
1232 for not trusted environments.</dd>
1234 <dt id="cfg_LoginCookieDeleteAll">$cfg['LoginCookieDeleteAll'] boolean</dt>
1235 <dd>If enabled (default), logout deletes cookies for all servers,
1236 otherwise only for current one. Setting this to false makes it easy to
1237 forget to log out from other server, when you are using more of
1238 them.</dd>
1240 <dt id="cfg_UseDbSearch">$cfg['UseDbSearch'] boolean</dt>
1241 <dd>Define whether the "search string inside database" is enabled or not.</dd>
1243 <dt id="cfg_IgnoreMultiSubmitErrors">$cfg['IgnoreMultiSubmitErrors'] boolean</dt>
1244 <dd>Define whether phpMyAdmin will continue executing a multi-query
1245 statement if one of the queries fails. Default is to abort execution.</dd>
1247 <dt id="cfg_VerboseMultiSubmit">$cfg['VerboseMultiSubmit'] boolean</dt>
1248 <dd>Define whether phpMyAdmin will output the results of each query of a
1249 multi-query statement embedded into the
1250 <abbr title="structured query language">SQL</abbr> output as inline
1251 comments. Defaults to <tt>TRUE</tt>.</dd>
1252 <dt id="AllowArbitraryServer">
1253 <span id="cfg_AllowArbitraryServer">$cfg['AllowArbitraryServer']</span> boolean</dt>
1254 <dd>If enabled allows you to log in to arbitrary servers using cookie auth.
1255 <br /><br />
1257 <b>NOTE:</b> Please use this carefully, as this may allow users access to
1258 MySQL servers behind the firewall where your
1259 <abbr title="HyperText Transfer Protocol">HTTP</abbr> server is placed.
1260 </dd>
1262 <dt id="cfg_LeftFrameLight">$cfg['LeftFrameLight'] boolean</dt>
1263 <dd>Defines whether to use a select-based menu and display only the current
1264 tables in the left frame (smaller page). Only in Non-Lightmode you can
1265 use the feature to display nested folders using
1266 <a href="#cfg_LeftFrameTableSeparator" class="configrule">$cfg['LeftFrameTableSeparator']</a>
1267 </dd>
1269 <dt id="cfg_LeftFrameDBTree">$cfg['LeftFrameDBTree'] boolean</dt>
1270 <dd>In light mode, defines whether to display the names of databases (in the
1271 selector) using a tree, see also
1272 <a href="#cfg_LeftFrameDBSeparator" class="configrule">$cfg['LeftFrameDBSeparator']</a>.
1273 </dd>
1275 <dt id="cfg_LeftFrameDBSeparator">$cfg['LeftFrameDBSeparator']
1276 string or array</dt>
1277 <dd>The string used to separate the parts of the database name when showing
1278 them in a tree. Alternatively you can specify more strings in an array
1279 and all of them will be used as a separator.</dd>
1281 <dt id="cfg_LeftFrameTableSeparator">$cfg['LeftFrameTableSeparator'] string</dt>
1282 <dd>Defines a string to be used to nest table spaces. Defaults to '__'.
1283 This means if you have tables like 'first__second__third' this will be
1284 shown as a three-level hierarchy like: first &gt; second &gt; third.
1285 If set to FALSE or empty, the feature is disabled. NOTE: You should
1286 not use this separator at the beginning or end of a
1287 table name or multiple times after another without any other
1288 characters in between.</dd>
1290 <dt id="cfg_LeftFrameTableLevel">$cfg['LeftFrameTableLevel'] string</dt>
1291 <dd>Defines how many sublevels should be displayed when splitting
1292 up tables by the above separator.</dd>
1294 <dt id="cfg_ShowTooltip">$cfg['ShowTooltip'] boolean</dt>
1295 <dd>Defines whether to display table comment as tool-tip in left frame or
1296 not.</dd>
1298 <dt id="cfg_ShowTooltipAliasDB">$cfg['ShowTooltipAliasDB'] boolean</dt>
1299 <dd>If tool-tips are enabled and a DB comment is set, this will flip the
1300 comment and the real name. That means that if you have a table called
1301 'user0001' and add the comment 'MyName' on it, you will see the name
1302 'MyName' used consequently in the left frame and the tool-tip shows
1303 the real name of the DB.</dd>
1305 <dt id="cfg_ShowTooltipAliasTB">$cfg['ShowTooltipAliasTB'] boolean/string</dt>
1306 <dd>Same as <a href="#cfg_ShowTooltipAliasDB" class="configrule">$cfg['ShowTooltipAliasDB']</a>, except this works for table names.
1308 When setting this to 'nested', the Alias of the Tablename is only used
1309 to split/nest the tables according to the
1310 <a href="#cfg_LeftFrameTableSeparator" class="configrule">$cfg['LeftFrameTableSeparator']</a>
1311 directive. So only the folder is called like the Alias, the tablename itself
1312 stays the real tablename.</dd>
1314 <dt id="cfg_LeftDisplayLogo">$cfg['LeftDisplayLogo'] boolean</dt>
1315 <dd>Defines whether or not to display the phpMyAdmin logo at the top of the left frame.
1316 Defaults to <tt>TRUE</tt>.</dd>
1317 <dt id="cfg_LeftLogoLink">$cfg['LeftLogoLink'] string</dt>
1318 <dd>Enter URL where logo in the navigation frame will point to.
1319 For use especially with self made theme which changes this.
1320 The default value for this is <tt>main.php</tt>.</dd>
1322 <dt id="cfg_LeftLogoLinkWindow">$cfg['LeftLogoLinkWindow'] string</dt>
1323 <dd>Whether to open the linked page in the main window (<tt>main</tt>)
1324 or in a new one (<tt>new</tt>). Note: use <tt>new</tt> if you are
1325 linking to <tt>phpmyadmin.net</tt>.</dd>
1327 <dt id="cfg_LeftDisplayServers">$cfg['LeftDisplayServers'] boolean</dt>
1328 <dd>Defines whether or not to display a server choice at the top of the left frame.
1329 Defaults to FALSE.</dd>
1330 <dt id="cfg_DisplayServersList">$cfg['DisplayServersList'] boolean</dt>
1331 <dd>Defines whether to display this server choice as links instead of in a drop-down.
1332 Defaults to FALSE (drop-down).</dd>
1333 <dt id="cfg_DisplayDatabasesList">$cfg['DisplayDatabasesList'] boolean or text</dt>
1334 <dd>Defines whether to display database choice in light navigation frame as links
1335 instead of in a drop-down. Defaults to 'auto' - on main page list is
1336 shown, when database is selected, only drop down is displayed.</dd>
1338 <dt id="cfg_LeftDefaultTabTable">$cfg['LeftDefaultTabTable'] string</dt>
1339 <dd>Defines the tab displayed by default when clicking the small
1340 icon next to each table name in the navigation panel. Possible
1341 values: &quot;tbl_structure.php&quot;,
1342 &quot;tbl_sql.php&quot;, &quot;tbl_select.php&quot;,
1343 &quot;tbl_change.php&quot; or &quot;sql.php&quot;.</dd>
1345 <dt id="cfg_ShowStats">$cfg['ShowStats'] boolean</dt>
1346 <dd>Defines whether or not to display space usage and statistics about databases
1347 and tables.<br />
1348 Note that statistics requires at least MySQL 3.23.3 and that, at this
1349 date, MySQL doesn't return such information for Berkeley DB tables.</dd>
1351 <dt><span id="cfg_ShowServerInfo">$cfg['ShowServerInfo'] </span>boolean</dt>
1352 <dd>Defines whether to display detailed server information on main page.
1353 You can additionally hide more information by using
1354 <tt><a href="#cfg_Servers_verbose">$cfg['Servers'][$i]['verbose']</a></tt>.
1355 </dd>
1357 <dt><span id="cfg_ShowPhpInfo">$cfg['ShowPhpInfo'] </span>boolean<br />
1358 <span id="cfg_ShowChgPassword">$cfg['ShowChgPassword'] </span>boolean<br />
1359 <span id="cfg_ShowCreateDb">$cfg['ShowCreateDb'] </span>boolean
1360 </dt>
1361 <dd>Defines whether to display the &quot;PHP information&quot; and
1362 &quot;Change password &quot; links and form for creating database or
1363 not at the starting main (right) frame. This setting
1364 does not check MySQL commands entered directly.<br /><br />
1366 Please note that to block the usage of phpinfo() in scripts, you
1367 have to put this in your <i>php.ini</i>:
1369 <pre>disable_functions = phpinfo()</pre>
1371 Also note that enabling the &quot;Change password &quot; link has no
1372 effect with &quot;config&quot; authentication mode: because of the
1373 hard coded password value in the configuration file, end users can't
1374 be allowed to change their passwords.</dd>
1376 <dt id="cfg_SuggestDBName">$cfg['SuggestDBName'] boolean</dt>
1377 <dd>Defines whether to suggest a database name on the
1378 &quot;Create Database&quot; form or to keep the textfield empty.</dd>
1380 <dt id="cfg_NavigationBarIconic">$cfg['NavigationBarIconic'] string</dt>
1381 <dd>Defines whether navigation bar buttons and the right panel top menu
1382 contain text or symbols only. A value of TRUE displays icons, FALSE
1383 displays text and 'both' displays both icons and text.</dd>
1385 <dt id="cfg_ShowAll">$cfg['ShowAll'] boolean</dt>
1386 <dd>Defines whether a user should be displayed a
1387 &quot;show all (records)&quot; button in browse mode or not.</dd>
1389 <dt id="cfg_MaxRows">$cfg['MaxRows'] integer</dt>
1390 <dd>Number of rows displayed when browsing a result set. If the result set
1391 contains more rows, &quot;Previous&quot; and &quot;Next&quot; links will be shown.</dd>
1393 <dt id="cfg_Order">$cfg['Order'] string [<tt>DESC</tt>|<tt>ASC</tt>|<tt>SMART</tt>]</dt>
1394 <dd>Defines whether fields are displayed in ascending (<tt>ASC</tt>) order,
1395 in descending (<tt>DESC</tt>) order or in a &quot;smart&quot;
1396 (<tt>SMART</tt>) order - I.E. descending order for fields of type TIME,
1397 DATE, DATETIME and TIMESTAMP, ascending order else- by default.</dd>
1399 <dt id="cfg_ProtectBinary">$cfg['ProtectBinary'] boolean or string</dt>
1400 <dd>Defines whether <tt>BLOB</tt> or <tt>BINARY</tt> fields are protected
1401 from editing when browsing a table's content. Valid values are:
1402 <ul><li><tt>FALSE</tt> to allow editing of all fields;</li>
1403 <li><tt>'blob'</tt> to allow editing of all fields except <tt>BLOBS</tt>;</li>
1404 <li><tt>'all'</tt> to disallow editing of all <tt>BINARY</tt> or
1405 <tt>BLOB</tt> fields.</li>
1406 </ul>
1407 </dd>
1409 <dt id="cfg_ShowFunctionFields">$cfg['ShowFunctionFields'] boolean</dt>
1410 <dd>Defines whether or not MySQL functions fields should be initially
1411 displayed in edit/insert mode. Since version 2.10, the user can
1412 toggle this setting from the interface.
1413 </dd>
1415 <dt id="cfg_CharEditing">$cfg['CharEditing'] string</dt>
1416 <dd>Defines which type of editing controls should be used for CHAR and
1417 VARCHAR fields. Possible values are:
1418 <ul><li>input - this allows to limit size of text to size of field in
1419 MySQL, but has problems with newlines in fields</li>
1420 <li>textarea - no problems with newlines in fields, but also no
1421 length limitations</li>
1422 </ul>
1423 Default is old behavior so input.</dd>
1425 <dt id="cfg_InsertRows">$cfg['InsertRows'] integer</dt>
1426 <dd>Defines the maximum number of concurrent entries for the Insert page.</dd>
1428 <dt id="cfg_ForeignKeyMaxLimit">$cfg['ForeignKeyMaxLimit'] integer</dt>
1429 <dd>If there are fewer items than this in the set of foreign keys, then a
1430 drop-down box of foreign keys is presented, in the style described by the
1431 <a href="#cfg_ForeignKeyDropdownOrder" class="configrule">$cfg['ForeignKeyDropdownOrder']</a>
1432 setting.</dd>
1434 <dt id="cfg_ForeignKeyDropdownOrder">$cfg['ForeignKeyDropdownOrder'] array</dt>
1435 <dd>For the foreign key drop-down fields, there are several methods of
1436 display, offering both the key and value data. The contents of the
1437 array should be one or both of the following strings:
1438 <i>'content-id'</i>, <i>'id-content'</i>.</dd>
1440 <dt><span id="cfg_ZipDump">$cfg['ZipDump'] </span>boolean<br />
1441 <span id="cfg_GZipDump">$cfg['GZipDump'] </span>boolean<br />
1442 <span id="cfg_BZipDump">$cfg['BZipDump'] </span>boolean
1443 </dt>
1444 <dd>Defines whether to allow the use of zip/GZip/BZip2 compression when
1445 creating a dump file</dd>
1447 <dt><span id="cfg_CompressOnFly">$cfg['CompressOnFly'] </span>boolean<br />
1448 </dt>
1449 <dd>Defines whether to allow on the fly compression for GZip/BZip2
1450 compressed exports. This doesn't affect smaller dumps and allows users to
1451 create larger dumps that won't otherwise fit in memory due to php
1452 memory limit. Produced files contain more GZip/BZip2 headers, but all
1453 normal programs handle this correctly.</dd>
1455 <dt id="cfg_LightTabs">$cfg['LightTabs'] boolean</dt>
1456 <dd>If set to <tt>TRUE</tt>, use less graphically intense tabs on the top of the
1457 mainframe.</dd>
1459 <dt id="cfg_PropertiesIconic">$cfg['PropertiesIconic'] string</dt>
1460 <dd>If set to <tt>TRUE</tt>, will display icons instead of text for db and table
1461 properties links (like 'Browse', 'Select', 'Insert', ...).<br /> Can be
1462 set to <tt>'both'</tt> if you want icons AND text.<br />
1463 When set to <tt>FALSE</tt>, will only show text.</dd>
1465 <dt id="cfg_PropertiesNumColumns">$cfg['PropertiesNumColumns'] integer</dt>
1466 <dd>How many columns will be utilized to display the tables on the
1467 database property view? Default is 1 column. When setting this to a
1468 value larger than 1, the type of the database will be omitted for more
1469 display space.</dd>
1472 <dt id="cfg_DefaultTabServer">$cfg['DefaultTabServer'] string</dt>
1473 <dd>Defines the tab displayed by default on server view. Possible
1474 values: &quot;main.php&quot; (recommended for multi-user setups),
1475 &quot;server_databases.php&quot;, &quot;server_status.php&quot;,
1476 &quot;server_variables.php&quot;, &quot;server_privileges.php&quot;
1477 or &quot;server_processlist.php&quot;.</dd>
1479 <dt id="cfg_DefaultTabDatabase">$cfg['DefaultTabDatabase'] string</dt>
1480 <dd>Defines the tab displayed by default on database view. Possible
1481 values: &quot;db_structure.php&quot;,
1482 &quot;db_sql.php&quot; or &quot;db_search.php&quot;.</dd>
1484 <dt id="cfg_DefaultTabTable">$cfg['DefaultTabTable'] string</dt>
1485 <dd>Defines the tab displayed by default on table view. Possible
1486 values: &quot;tbl_structure.php&quot;,
1487 &quot;tbl_sql.php&quot;, &quot;tbl_select.php&quot;,
1488 &quot;tbl_change.php&quot; or &quot;sql.php&quot;.</dd>
1490 <dt id="cfg_MySQLManualBase">$cfg['MySQLManualBase'] string</dt>
1491 <dd>If set to an <abbr title="Uniform Resource Locator">URL</abbr> which
1492 points to the MySQL documentation (type depends
1493 on <a href="#cfg_MySQLManualType" class="configrule">$cfg['MySQLManualType']</a>), appropriate help links are
1494 generated.<br />
1495 See <a href="http://dev.mysql.com/doc/">MySQL Documentation page</a>
1496 for more information about MySQL manuals and their types.</dd>
1498 <dt id="cfg_MySQLManualType">$cfg['MySQLManualType'] string</dt>
1499 <dd>Type of MySQL documentation:
1500 <ul><li>viewable - &quot;viewable online&quot;, current one used on MySQL website</li>
1501 <li>searchable - &quot;Searchable, with user comments&quot;</li>
1502 <li>chapters - &quot;HTML, one page per chapter&quot;</li>
1503 <li>big - &quot;HTML, all on one page&quot;</li>
1504 <li>none - do not show documentation links</li>
1505 </ul>
1506 </dd>
1508 <dt id="cfg_DefaultLang">$cfg['DefaultLang'] string</dt>
1509 <dd>Defines the default language to use, if not browser-defined or
1510 user-defined.<br />
1511 See the <i>select_lang.lib.php</i> script to know the valid values for
1512 this setting.</dd>
1514 <dt id="cfg_DefaultConnectionCollation">$cfg['DefaultConnectionCollation'] string</dt>
1515 <dd>Defines the default connection collation to use, if not
1516 user-defined.<br />
1517 See the <a href="http://dev.mysql.com/doc/mysql/en/charset-charsets.html">MySQL
1518 documentation</a> for list of possible values.</dd>
1520 <dt id="cfg_Lang">$cfg['Lang'] string</dt>
1521 <dd>Force: always use this language (must be defined in the
1522 <i>select_lang.lib.php</i> script).</dd>
1524 <dt id="cfg_FilterLanguages">$cfg['FilterLanguages'] string</dt>
1525 <dd>Limit list of available languages to those matching the given regular
1526 expression. For example if you want only Czech and English, you should
1527 set filter to <code>'^(cs|en)'</code>.</dd>
1529 <dt id="cfg_DefaultCharset">$cfg['DefaultCharset'] string</dt>
1530 <dd>Default character set to use for recoding of MySQL queries. This must be
1531 enabled and it's described by
1532 <a href="#cfg_AllowAnywhereRecoding" class="configrule">$cfg['AllowAnywhereRecoding']</a>
1533 option.<br />
1534 You can give here any character set which is in
1535 <a href="#cfg_AvailableCharsets" class="configrule">$cfg['AvailableCharsets']</a>
1536 array and this is just default choice, user can select any of them.</dd>
1538 <dt id="cfg_AllowAnywhereRecoding">$cfg['AllowAnywhereRecoding'] boolean</dt>
1539 <dd>Allow character set recoding of MySQL queries. You need recode or iconv
1540 support (compiled in or module) in PHP to allow MySQL queries recoding
1541 and used language file must have it enabled (by default only these
1542 which are in Unicode, just to avoid losing some characters).<br /><br />
1544 Setting this to <tt>TRUE</tt> also activates a pull-down menu
1545 in the Export and Import pages, to choose the character set when
1546 exporting a file. The default value in this menu comes from
1547 <tt>$cfg['Export']['charset']</tt> and <tt>$cfg['Import']['charset']</tt>.
1548 </dd>
1550 <dt id="cfg_RecodingEngine">$cfg['RecodingEngine'] string</dt>
1551 <dd>You can select here which functions will be used for character set
1552 conversion. Possible values are:
1553 <ul><li>auto - automatically use available one (first is tested
1554 iconv, then recode)</li>
1555 <li>iconv - use iconv or libiconv functions</li>
1556 <li>recode - use recode_string function</li>
1557 </ul>
1558 Default is auto.</dd>
1560 <dt id="cfg_IconvExtraParams">$cfg['IconvExtraParams'] string</dt>
1561 <dd>Specify some parameters for iconv used in charset conversion. See
1562 <a href="http://www.gnu.org/software/libiconv/documentation/libiconv/iconv_open.3.html">iconv
1563 documentation</a> for details. By default <code>//TRANSLIT</code> is
1564 used, so that invalid characters will be transliterated.</dd>
1566 <dt id="cfg_AvailableCharsets">$cfg['AvailableCharsets'] array</dt>
1567 <dd>Available character sets for MySQL conversion. You can add your own (any of
1568 supported by recode/iconv) or remove these which you don't use.
1569 Character sets will be shown in same order as here listed, so if you
1570 frequently use some of these move them to the top.</dd>
1572 <dt id="cfg_TrustedProxies">$cfg['TrustedProxies'] array</dt>
1573 <dd>Lists proxies and HTTP headers which are trusted for <a
1574 href="#servers_allowdeny_order">IP Allow/Deny</a>. This list is by
1575 default empty, you need to fill in some trusted proxy servers if you
1576 want to use rules for IP addresses behind proxy.<br /><br />
1578 The following example specifies that phpMyAdmin should trust a
1579 HTTP_X_FORWARDED_FOR (<tt>X-Forwarded-For</tt>) header coming from the proxy 1.2.3.4:
1580 <pre>
1581 $cfg['TrustedProxies'] =
1582 array('1.2.3.4' =&gt; 'HTTP_X_FORWARDED_FOR');
1583 </pre>
1584 The $cfg['Servers'][$i]['AllowDeny']['rules'] directive uses the
1585 client's IP address as usual.
1586 </dd>
1588 <dt id="cfg_GD2Available">$cfg['GD2Available'] string</dt>
1589 <dd>Specifies whether GD &gt;= 2 is available. If yes it can be used for
1590 MIME transformations.<br />
1591 Possible values are:
1592 <ul><li>auto - automatically detect, this is a bit expensive
1593 operation for php &lt; 4.3.0 so it is preferred to change this
1594 according to your server real possibilities</li>
1595 <li>yes - GD 2 functions can be used</li>
1596 <li>no - GD 2 function cannot be used</li>
1597 </ul>
1598 Default is auto.
1599 </dd>
1601 <dt id="cfg_CheckConfigurationPermissions">$cfg['CheckConfigurationPermissions'] boolean</dt>
1602 <dd>
1603 We normally check the permissions on the configuration file to ensure
1604 it's not world writable. However, phpMyAdmin could be installed on
1605 a NTFS filesystem mounted on a non-Windows server, in which case the
1606 permissions seems wrong but in fact cannot be detected. In this case
1607 a sysadmin would set this parameter to <tt>FALSE</tt>. Default is <tt>TRUE</tt>.
1608 </dd>
1610 <dt id="cfg_NaviWidth">$cfg['NaviWidth'] integer</dt>
1611 <dd>Navi frame width in pixels. See <tt>themes/themename/layout.inc.php</tt>.
1612 </dd>
1614 <dt><span id="cfg_NaviBackground">$cfg['NaviBackground']</span> string [valid css code for background]<br />
1615 <span id="cfg_MainBackground">$cfg['MainBackground']</span> string [valid css code for background]
1616 </dt>
1617 <dd>The background styles used for both the frames.
1618 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1620 <dt id="cfg_NaviPointerBackground">$cfg['NaviPointerBackground'] string [valid css code for background]<br />
1621 <span id="cfg_NaviPointerColor">$cfg['NaviPointerColor']</span> string [valid css color]</dt>
1622 <dd>The style used for the pointer in the navi frame.
1623 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1625 <dt id="cfg_NaviDatabaseNameColor">$cfg['NaviDatabaseNameColor'] string [valid css code]<br />
1626 </dt>
1627 <dd>The color used for the database name in the navi frame.
1628 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1630 <dt id="cfg_LeftPointerEnable">$cfg['LeftPointerEnable'] boolean</dt>
1631 <dd>A value of <tt>TRUE</tt> activates the navi pointer (when LeftFrameLight
1632 is <tt>FALSE</tt>).</dd>
1634 <dt id="cfg_Border">$cfg['Border'] integer</dt>
1635 <dd>The size of a table's border. See <tt>themes/themename/layout.inc.php</tt>.
1636 </dd>
1638 <dt id="cfg_ThBackground">$cfg['ThBackground'] string [valid css code for background]<br />
1639 <span id="cfg_ThColor">$cfg['ThColor']</span> string [valid css color]</dt>
1640 <dd>The style used for table headers. See
1641 <tt>themes/themename/layout.inc.php</tt>.</dd>
1643 <dt id="cfg_BgcolorOne">$cfg['BgOne'] string [HTML color]</dt>
1644 <dd>The color (HTML) #1 for table rows. See <tt>themes/themename/layout.inc.php</tt>.
1645 </dd>
1647 <dt id="cfg_BgcolorTwo">$cfg['BgTwo'] string [HTML color]</dt>
1648 <dd>The color (HTML) #2 for table rows. See <tt>themes/themename/layout.inc.php</tt>.
1649 </dd>
1651 <dt><span id="cfg_BrowsePointerBackground">$cfg['BrowsePointerBackground'] </span>string [HTML color]<br />
1652 <span id="cfg_BrowsePointerColor">$cfg['BrowsePointerColor'] </span>string [HTML color]<br />
1653 <span id="cfg_BrowseMarkerBackground">$cfg['BrowseMarkerBackground'] </span>string [HTML color]<br />
1654 <span id="cfg_BrowseMarkerColor">$cfg['BrowseMarkerColor'] </span>string [HTML color]
1655 </dt>
1656 <dd>The colors (HTML) uses for the pointer and the marker in browse mode.<br />
1657 The former feature highlights the row over which your mouse is passing
1658 and the latter lets you visually mark/unmark rows by clicking on
1659 them.<br />
1660 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1663 <dt id="cfg_FontFamily">$cfg['FontFamily'] string</dt>
1664 <dd>You put here a valid CSS font family value, for example
1665 <tt>arial, sans-serif</tt>.<br />
1666 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1668 <dt id="cfg_FontFamilyFixed">$cfg['FontFamilyFixed'] string</dt>
1669 <dd>You put here a valid CSS font family value, for example
1670 <tt>monospace</tt>. This one is used in textarea.<br />
1671 See <tt>themes/themename/layout.inc.php</tt>.</dd>
1673 <dt id="cfg_BrowsePointerEnable">$cfg['BrowsePointerEnable'] boolean</dt>
1674 <dd>Whether to activate the browse pointer or not.</dd>
1676 <dt id="cfg_BrowseMarkerEnable">$cfg['BrowseMarkerEnable'] boolean</dt>
1677 <dd>Whether to activate the browse marker or not.</dd>
1679 <dt><span id="cfg_TextareaCols">$cfg['TextareaCols'] </span>integer<br />
1680 <span id="cfg_TextareaRows">$cfg['TextareaRows'] </span>integer<br />
1681 <span id="cfg_CharTextareaCols">$cfg['CharTextareaCols'] </span>integer<br />
1682 <span id="cfg_CharTextareaRows">$cfg['CharTextareaRows'] </span>integer
1683 </dt>
1684 <dd>Number of columns and rows for the textareas.<br />
1685 This value will be emphasized (*2) for <abbr title="structured query language">SQL</abbr> query textareas and (*1.25) for
1686 <abbr title="structured query language">SQL</abbr> textareas inside the query window.<br />
1687 The Char* values are used for CHAR and VARCHAR editing (if configured
1688 via <a href="#cfg_CharEditing">$cfg['CharEditing']</a>).</dd>
1690 <dt><span id="cfg_LongtextDoubleTextarea">$cfg['LongtextDoubleTextarea'] </span>boolean
1691 </dt>
1692 <dd>Defines whether textarea for LONGTEXT fields should have double size.</dd>
1694 <dt><span id="cfg_TextareaAutoSelect">$cfg['TextareaAutoSelect'] </span>boolean
1695 </dt>
1696 <dd>Defines if the whole textarea of the query box will be selected on
1697 click.</dd>
1698 <dt id="CtrlArrowsMoving">
1699 <span id="cfg_CtrlArrowsMoving">$cfg['CtrlArrowsMoving'] </span>boolean
1700 </dt>
1701 <dd>Enable Ctrl+Arrows (Option+Arrows in Safari) moving between fields when
1702 editing.</dd>
1704 <dt id="cfg_LimitChars">$cfg['LimitChars'] integer</dt>
1705 <dd>Maximum number of characters showen in any non-numeric field on browse view.
1706 Can be turned off by a toggle button on the browse page.</dd>
1708 <dt><span id="cfg_ModifyDeleteAtLeft">$cfg['ModifyDeleteAtLeft'] </span>boolean
1709 <span id="cfg_ModifyDeleteAtRight">$cfg['ModifyDeleteAtRight'] </span>boolean
1710 </dt>
1711 <dd>Defines the place where modify and delete links would be put when
1712 tables contents are displayed (you may have them displayed both at the
1713 left and at the right).
1714 &quot;Left&quot; and &quot;right&quot; are parsed as &quot;top&quot;
1715 and &quot;bottom&quot; with vertical display mode.</dd>
1717 <dt id="cfg_DefaultDisplay">$cfg['DefaultDisplay'] string
1718 <span id="cfg_HeaderFlipType">$cfg['HeaderFlipType'] </span>string
1719 </dt>
1720 <dd>There are 3 display modes: horizontal, horizontalflipped and vertical.
1721 Define which one is displayed by default. The first mode displays each
1722 row on a horizontal line, the second rotates the headers by 90
1723 degrees, so you can use descriptive headers even though fields only
1724 contain small values and still print them out. The vertical mode sorts
1725 each row on a vertical lineup.<br /><br />
1727 The HeaderFlipType can be set to 'css' or 'fake'. When using 'css'
1728 the rotation of the header for horizontalflipped is done via CSS. If
1729 set to 'fake' PHP does the transformation for you, but of course this
1730 does not look as good as CSS.</dd>
1732 <dt id="DefaultPropDisplay">
1733 <span id="cfg_DefaultPropDisplay">$cfg['DefaultPropDisplay']</span>
1734 string or integer</dt>
1735 <dd>When editing/creating new columns in a table all fields normally get
1736 lined up one field a line. (default: 'horizontal'). If you set this to
1737 'vertical' you can have each field lined up vertically beneath each
1738 other. You can save up a lot of place on the horizontal direction and
1739 no longer have to scroll. If you set this to integer, editing of fewer
1740 columns will appear in 'vertical' mode, while editing of more fields
1741 still in 'horizontal' mode. This way you can still effectively edit
1742 large number of fields, while having full view on few of them.</dd>
1744 <dt id="cfg_ShowBrowseComments">$cfg['ShowBrowseComments'] boolean<br />
1745 <span id="cfg_ShowPropertyComments">$cfg['ShowPropertyComments'] </span>boolean
1746 </dt>
1747 <dd>By setting the corresponding variable to <tt>TRUE</tt> you can enable the
1748 display of column comments in Browse or Property display. In browse
1749 mode, the comments are shown inside the header. In property mode,
1750 comments are displayed using a CSS-formatted dashed-line below the
1751 name of the field. The comment is shown as a tool-tip for that field.
1752 </dd>
1754 <dt id ="cfb_SQLQuery_Edit">$cfg['SQLQuery']['Edit'] boolean</dt>
1755 <dd>Whether to display an edit link to change a query in any SQL Query box.</dd>
1757 <dt id ="cfb_SQLQuery_Explain">$cfg['SQLQuery']['Explain'] boolean</dt>
1758 <dd>Whether to display a link to explain a SELECT query in any SQL Query box.</dd>
1760 <dt id ="cfb_SQLQuery_ShowAsPHP">$cfg['SQLQuery']['ShowAsPHP'] boolean</dt>
1761 <dd>Whether to display a link to wrap a query in PHP code in any SQL Query box.</dd>
1763 <dt id ="cfb_SQLQuery_Validate">$cfg['SQLQuery']['Validate'] boolean</dt>
1764 <dd>Whether to display a link to validate a query in any SQL Query box.
1765 See also <tt><a href="#cfg_SQLValidator">$cfg_SQLValidator</a></tt>.</dd>
1767 <dt id ="cfb_SQLQuery_Refresh">$cfg['SQLQuery']['Refresh'] boolean</dt>
1768 <dd>Whether to display a link to refresh a query in any SQL Query box.</dd>
1770 <dt id="cfg_UploadDir">$cfg['UploadDir'] string</dt>
1771 <dd>
1772 The name of the directory where
1773 <abbr title="structured query language">SQL</abbr> files have been
1774 uploaded by other means than phpMyAdmin (for example, ftp). Those files
1775 are available under a drop-down box when you click the database or
1776 table name, then the Import tab.
1777 <br /><br />
1779 If you want different directory for each user, %u will be replaced
1780 with username.<br /><br />
1782 Please note that the file names must have the suffix &quot;.sql&quot;
1783 (or &quot;.sql.bz2&quot; or &quot;.sql.gz&quot; if support for
1784 compressed formats is enabled).<br /><br />
1786 This feature is useful when your file is too big to be uploaded via
1787 <abbr title="HyperText Transfer Protocol">HTTP</abbr>, or when file
1788 uploads are disabled in PHP.<br /><br />
1790 Please note that if PHP is running in safe mode, this directory must
1791 be owned by the same user as the owner of the phpMyAdmin scripts.
1792 <br /><br />
1794 See also <a href="#faq1_16">
1795 <abbr title="Frequently Asked Questions">FAQ</abbr> 1.16</a> for
1796 alternatives.
1797 </dd>
1799 <dt id="cfg_SaveDir">$cfg['SaveDir'] string</dt>
1800 <dd>
1801 The name of the directory where dumps can be saved.<br /><br />
1803 If you want different directory for each user, %u will be replaced
1804 with username.<br /><br />
1806 Please note that the directory must exist and has to be writable for
1807 the user running webserver.<br /><br />
1809 Please note that if PHP is running in safe mode, this directory must
1810 be owned by the same user as the owner of the phpMyAdmin scripts.
1811 </dd>
1813 <dt id="cfg_TempDir">$cfg['TempDir'] string</dt>
1814 <dd>
1815 The name of the directory where temporary files can be stored.
1816 <br /><br />
1818 This is needed for native MS Excel export, see
1819 <a href="#faq6_23"><abbr title="Frequently Asked Questions">FAQ</abbr>
1820 6.23</a> and to work around limitations of
1821 <tt>open_basedir</tt> for uploaded
1822 files, see <a href="#faq1_11"><abbr title="Frequently Asked Questions">FAQ</abbr>
1823 1.11</a>.
1824 <br /><br />
1826 If the directory where phpMyAdmin is installed is subject to an
1827 <tt>open_basedir</tt> restriction, you need to create a
1828 temporary directory in some directory accessible by the web
1829 server. However for security reasons, this directory should be outside
1830 the tree published by webserver. If you cannot avoid having this
1831 directory published by webserver, place at least an empty
1832 <tt>index.html</tt> file there, so that directory listing is not
1833 possible.
1834 <br /><br />
1836 This directory should have as strict permissions as possible as the only
1837 user required to access this directory is the one who runs the
1838 webserver. If you have root privileges, simply make this user owner of
1839 this directory and make it accessible only by it:
1840 <br /><br />
1842 <pre>
1843 chown www-data:www-data tmp
1844 chmod 700 tmp
1845 </pre>
1847 If you cannot change owner of the directory, you can achieve a similar
1848 setup using <abbr title="Access Control List">ACL</abbr>:
1850 <pre>
1851 chmod 700 tmp
1852 setfacl -m "g:www-data:rwx" tmp
1853 setfacl -d -m "g:www-data:rwx" tmp
1854 </pre>
1856 If neither of above works for you, you can still make the directory
1857 <code>chmod 777</code>, but it might impose risk of other users on
1858 system reading and writing data in this directory.
1859 </dd>
1861 <dt id="cfg_Export">$cfg['Export'] array</dt>
1862 <dd>
1863 In this array are defined default parameters for export, names of
1864 items are similar to texts seen on export page, so you can easily
1865 identify what they mean.
1866 </dd>
1868 <dt id="cfg_Import">$cfg['Import'] array</dt>
1869 <dd>
1870 In this array are defined default parameters for import, names of
1871 items are similar to texts seen on import page, so you can easily
1872 identify what they mean.
1873 </dd>
1875 <dt id="cfg_RepeatCells">$cfg['RepeatCells'] integer</dt>
1876 <dd>
1877 Repeat the headers every X cells, or 0 to deactivate.
1878 </dd>
1880 <dt id="cfg_EditInWindow">$cfg['EditInWindow'] boolean<br />
1881 <span id="cfg_QueryWindowWidth">$cfg['QueryWindowWidth'] </span>integer<br />
1882 <span id="cfg_QueryWindowHeight">$cfg['QueryWindowHeight'] </span>integer<br />
1883 <span id="cfg_QueryHistoryDB">$cfg['QueryHistoryDB'] </span>boolean<br />
1884 <span id="cfg_QueryWindowDefTab">$cfg['QueryWindowDefTab'] </span>string<br />
1885 <span id="cfg_QueryHistoryMax">$cfg['QueryHistoryMax'] </span>integer
1886 </dt>
1887 <dd>
1888 All those variables affect the query window feature. A <tt><abbr title="structured query language">SQL</abbr></tt> link
1889 or icon is always displayed on the left panel. If JavaScript is enabled in
1890 your browser, a click on this opens a distinct query window, which is
1891 a direct interface to enter <abbr title="structured query language">SQL</abbr> queries. Otherwise, the right panel
1892 changes to display a query box.<br /><br />
1894 The size of this query window can be customized with
1895 <tt>$cfg['QueryWindowWidth']</tt> and <tt>$cfg['QueryWindowWidth']</tt>
1896 - both integers for the size in pixels. Note that normally, those
1897 parameters will be modified in <tt>layout.inc.php</tt> for the
1898 theme you are using.<br /><br />
1900 If <tt>$cfg['EditInWindow']</tt> is set to true, a click on [Edit]
1901 from the results page (in the &quot;Showing Rows&quot; section)
1902 opens the query window and puts the current query
1903 inside it. If set to false, clicking on the link puts the <abbr title="structured query language">SQL</abbr>
1904 query in the right panel's query box.
1905 <br /><br />
1906 The usage of the JavaScript query window is recommended if you have a
1907 JavaScript enabled browser. Basic functions are used to exchange quite
1908 a few variables, so most 4th generation browsers should be capable to
1909 use that feature. It currently is only tested with Internet Explorer 6
1910 and Mozilla 1.x.
1911 <br /><br />
1912 If <tt>$cfg['QueryHistoryDB']</tt> is set to <tt>TRUE</tt>, all your Queries are logged
1913 to a table, which has to be created by you (see <a
1914 href="#history" class="configrule">$cfg['Servers'][$i]['history']</a>). If set to FALSE,
1915 all your queries will be appended to the form, but only as long as
1916 your window is opened they remain saved.
1917 <br /><br />
1918 When using the JavaScript based query window, it will always get
1919 updated when you click on a new table/db to browse and will focus if
1920 you click on "Edit <abbr title="structured query language">SQL</abbr>" after using a query. You can suppress updating
1921 the query window by checking the box "Do not overwrite this query from
1922 outside the window" below the query textarea. Then you can browse
1923 tables/databases in the background without losing the contents of the
1924 textarea, so this is especially useful when composing a query with
1925 tables you first have to look in. The checkbox will get automatically
1926 checked whenever you change the contents of the textarea. Please
1927 uncheck the button whenever you definitely want the query window to
1928 get updated even though you have made alterations.
1929 <br /><br />
1930 If <tt>$cfg['QueryHistoryDB']</tt> is set to <tt>TRUE</tt> you can specify the amount of
1931 saved history items using <tt>$cfg['QueryHistoryMax']</tt>.
1932 <br /><br />
1933 The query window also has a custom tabbed look to group the features.
1934 Using the variable <tt>$cfg['QueryWindowDefTab']</tt> you can specify the
1935 default tab to be used when opening the query window. It can be set to
1936 either 'sql', 'files', 'history' or 'full'.</dd>
1938 <dt id="cfg_BrowseMIME">$cfg['BrowseMIME'] boolean</dt>
1939 <dd>Enable <a href="#transformations">MIME-transformations</a>.</dd>
1941 <dt id="cfg_MaxExactCount">$cfg['MaxExactCount'] integer</dt>
1942 <dd>For InnoDB tables, determines for how large tables phpMyAdmin
1943 should get the exact row count using <code>SELECT COUNT</code>.
1944 If the approximate row count as returned by
1945 <code>SHOW TABLE STATUS</code> is smaller than this value,
1946 <code>SELECT COUNT</code> will be used, otherwise the approximate
1947 count will be used.
1948 </dd>
1949 <dt id="cfg_MaxExactCountViews">$cfg['MaxExactCountViews'] integer</dt>
1950 <dd>For VIEWs, since obtaining the exact count could have an
1951 impact on performance, this value is the maximum to be displayed, using
1952 a <code>SELECT COUNT ... LIMIT</code>. The default value of 0 bypasses
1953 any row counting.
1954 </dd>
1956 <dt id="wysiwyg">
1957 <span id="cfg_WYSIWYG-PDF">$cfg['WYSIWYG-PDF'] </span>boolean</dt>
1958 <dd>Utilizes a WYSIWYG editing control to easily place elements of a
1959 <abbr title="Portable Document Format">PDF</abbr>
1960 page. By clicking on the button 'toggle scratchboard' on the page
1961 where you edit x/y coordinates of those elements you can activate a
1962 scratchboard where all your elements are placed. By clicking on an
1963 element, you can move them around in the pre-defined area and the x/y
1964 coordinates will get updated dynamically. Likewise, when entering a
1965 new position directly into the input field, the new position in the
1966 scratchboard changes after your cursor leaves the input field.<br />
1967 You have to click on the 'OK'-button below the tables to save the new
1968 positions. If you want to place a new element, first add it to the
1969 table of elements and then you can drag the new element around.<br />
1970 By changing the paper size and the orientation you can change the size
1971 of the scratchboard as well. You can do so by just changing the
1972 dropdown field below, and the scratchboard will resize automatically,
1973 without interfering with the current placement of the elements.<br />
1974 If ever an element gets out of range you can either enlarge the paper
1975 size or click on the 'reset' button to place all elements below each
1976 other.<br />
1977 <b>NOTE:</b> You have to use a recent browser like IE6 or Mozilla to
1978 get this control to work. The basic Drag&amp;Drop script functionality
1979 was kindly borrowed from www.youngpup.net and is underlying so
1980 specific license.</dd>
1982 <dt id="cfg_NaturalOrder">$cfg['NaturalOrder'] boolean</dt>
1983 <dd>Sorts database and table names according to natural order (for example,
1984 t1, t2, t10). Currently implemented in the left panel (Light mode)
1985 and in Database view, for the table list.</dd>
1987 <dt id="cfg_InitialSlidersState">$cfg['InitialSlidersState'] string</dt>
1988 <dd>If set to <tt>'closed'</tt>, the visual sliders are initially in a
1989 closed state. A value of 'open' does the reverse.</dd>
1991 <dt id="cfg_TitleTable">$cfg['TitleTable'] string</dt>
1992 <dt id="cfg_TitleDatabase">$cfg['TitleDatabase'] string</dt>
1993 <dt id="cfg_TitleServer">$cfg['TitleServer'] string</dt>
1994 <dt id="cfg_TitleDefault">$cfg['TitleDefault'] string</dt>
1995 <dd>Allows you to specify window's title bar. Following magic string can
1996 be used to get special values:
1997 <dl>
1998 <dt><code>@HTTP_HOST@</code></dt>
1999 <dd>HTTP host that runs phpMyAdmin</dd>
2000 <dt><code>@SERVER@</code></dt>
2001 <dd>MySQL server name</dd>
2002 <dt><code>@VERBOSE@</code></dt>
2003 <dd>Verbose MySQL server name as defined in <a href="#cfg_Servers_verbose">server configuration</a></dd>
2004 <dt><code>@VSERVER@</code></dt>
2005 <dd>Verbose MySQL server name if set, otherwise normal</dd>
2006 <dt><code>@DATABASE@</code></dt>
2007 <dd>Currently opened database</dd>
2008 <dt><code>@TABLE@</code></dt>
2009 <dd>Currently opened table</dd>
2010 <dt><code>@PHPMYADMIN@</code></dt>
2011 <dd>phpMyAdmin with version</dd>
2012 </dl>
2013 </dd>
2015 <dt id="cfg_ErrorIconic">$cfg['ErrorIconic'] boolean</dt>
2016 <dd>Uses icons for warnings, errors and informations.</dd>
2018 <dt id="cfg_MainPageIconic">$cfg['MainPageIconic'] boolean</dt>
2019 <dd>Uses icons on main page in lists and menu tabs.</dd>
2021 <dt id="cfg_ReplaceHelpImg">$cfg['ReplaceHelpImg'] boolean</dt>
2022 <dd>Shows a help button instead of the &quot;Documentation&quot; message.
2023 </dd>
2025 <dt id="cfg_ThemePath">$cfg['ThemePath'] string</dt>
2026 <dd>If theme manager is active, use this as the path of the subdirectory
2027 containing all the themes.</dd>
2029 <dt id="cfg_ThemeManager">$cfg['ThemeManager'] boolean</dt>
2030 <dd>Enables user-selectable themes. See <a href="#faqthemes">
2031 <abbr title="Frequently Asked Questions">FAQ</abbr> 2.7</a>.</dd>
2033 <dt id="cfg_ThemeDefault">$cfg['ThemeDefault'] string</dt>
2034 <dd>The default theme (a subdirectory under <tt>cfg['ThemePath']</tt>).</dd>
2036 <dt id="cfg_ThemePerServer">$cfg['ThemePerServer'] boolean</dt>
2037 <dd>Whether to allow different theme for each server.</dd>
2039 <dt id="cfg_DefaultQueryTable">$cfg['DefaultQueryTable'] string<br />
2040 <span id="cfg_DefaultQueryDatabase">$cfg['DefaultQueryDatabase']</span> string
2041 </dt>
2042 <dd>Default queries that will be displayed in query boxes when user didn't
2043 specify any. Use %d for database name, %t for table name and %f for a
2044 comma separated list of field names. Note that %t and %f are only
2045 applicable to <tt>$cfg['DefaultQueryTable']</tt>.</dd>
2047 <dt id="cfg_SQP_fmtType">$cfg['SQP']['fmtType'] string [<tt>html</tt>|<tt>none</tt>]</dt>
2048 <dd>
2049 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
2050 default we use HTML to format the query, but you can disable this by
2051 setting this variable to <tt>'none'</tt>.
2052 </dd>
2054 <dt id="cfg_SQP_fmtInd">$cfg['SQP']['fmtInd'] float<br />
2055 <span id="cfg_SQP">$cfg['SQP']['fmtIndUnit']</span> string [<tt>em</tt>|<tt>px</tt>|<tt>pt</tt>|<tt>ex</tt>]</dt>
2056 <dd>For the pretty-printing of <abbr title="structured query language">SQL</abbr> queries, under some cases the part of a
2057 query inside a bracket is indented. By changing
2058 <tt>$cfg['SQP']['fmtInd']</tt> you can change the amount of this indent.
2059 <br />Related in purpose is <tt>$cfg['SQP']['fmtIndUnit']</tt> which
2060 specifies the units of the indent amount that you specified. This is
2061 used via stylesheets.</dd>
2063 <dt id="cfg_SQP_fmtColor">$cfg['SQP']['fmtColor'] array of string tuples</dt>
2064 <dd>This array is used to define the colours for each type of element of
2065 the pretty-printed <abbr title="structured query language">SQL</abbr> queries. The tuple format is<br />
2066 <i>class</i> =&gt; [<i>HTML colour code</i> | <i>empty string</i>]<br />
2067 If you specify an empty string for the color of a class, it is ignored
2068 in creating the stylesheet.
2069 You should not alter the class names, only the colour strings.<br />
2070 <b>Class name key:</b>
2071 <ul><li><b>comment</b> Applies to all comment sub-classes</li>
2072 <li><b>comment_mysql</b> Comments as <tt>"#...\n"</tt></li>
2073 <li><b>comment_ansi</b> Comments as <tt>"-- ...\n"</tt></li>
2074 <li><b>comment_c</b> Comments as <tt>"/*...*/"</tt></li>
2075 <li><b>digit</b> Applies to all digit sub-classes</li>
2076 <li><b>digit_hex</b> Hexadecimal numbers</li>
2077 <li><b>digit_integer</b> Integer numbers</li>
2078 <li><b>digit_float</b> Floating point numbers</li>
2079 <li><b>punct</b> Applies to all punctuation sub-classes</li>
2080 <li><b>punct_bracket_open_round</b> Opening brackets<tt>"("</tt></li>
2081 <li><b>punct_bracket_close_round</b> Closing brackets <tt>")"</tt></li>
2082 <li><b>punct_listsep</b> List item Separator <tt>","</tt></li>
2083 <li><b>punct_qualifier</b> Table/Column Qualifier <tt>"."</tt> </li>
2084 <li><b>punct_queryend</b> End of query marker <tt>";"</tt></li>
2085 <li><b>alpha</b> Applies to all alphabetic classes</li>
2086 <li><b>alpha_columnType</b> Identifiers matching a column type</li>
2087 <li><b>alpha_columnAttrib</b> Identifiers matching a database/table/column attribute</li>
2088 <li><b>alpha_functionName</b> Identifiers matching a MySQL function name</li>
2089 <li><b>alpha_reservedWord</b> Identifiers matching any other reserved word</li>
2090 <li><b>alpha_variable</b> Identifiers matching a <abbr title="structured query language">SQL</abbr> variable <tt>"@foo"</tt></li>
2091 <li><b>alpha_identifier</b> All other identifiers</li>
2092 <li><b>quote</b> Applies to all quotation mark classes</li>
2093 <li><b>quote_double</b> Double quotes <tt>"</tt></li>
2094 <li><b>quote_single</b> Single quotes <tt>'</tt></li>
2095 <li><b>quote_backtick</b> Backtick quotes <tt>`</tt></li>
2096 </ul>
2097 </dd>
2099 <dt id="cfg_SQLValidator">$cfg['SQLValidator'] boolean</dt>
2100 <dd><dl><dt id="cfg_SQLValidator_use">$cfg['SQLValidator']['use'] boolean</dt>
2101 <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,
2102 as originally published on
2103 <a href="http://developers.slashdot.org/article.pl?sid=02/02/19/1720246">Slashdot</a>.
2104 <br />
2105 For help in setting up your system to use the service, see the
2106 <a href="#faqsqlvalidator"><abbr title="Frequently Asked Questions">FAQ</abbr> 6.14</a>.
2107 </dd>
2109 <dt id="cfg_SQLValidator_username">$cfg['SQLValidator']['username'] string<br />
2110 <span id="cfg_SQLValidator_password">$cfg['SQLValidator']['password']</span> string</dt>
2111 <dd>The SOAP service allows you to log in with <tt>anonymous</tt>
2112 and any password, so we use those by default. Instead, if
2113 you have an account with them, you can put your login details
2114 here, and it will be used in place of the anonymous login.</dd>
2115 </dl>
2116 </dd>
2118 <dt id="cfg_DBG">$cfg['DBG']</dt>
2119 <dd><b>DEVELOPERS ONLY!</b></dd>
2121 <dt id="cfg_DBG_enable_sql">$cfg['DBG']['sql'] boolean</dt>
2122 <dd><b>DEVELOPERS ONLY!</b><br />
2123 Enable logging queries and execution times to be displayed in the bottom
2124 of main page (right frame).</dd>
2126 <dt id="cfg_DBG_enable_php">$cfg['DBG']['php'] boolean</dt>
2127 <dd><b>DEVELOPERS ONLY!</b><br />
2128 Enable the DBG extension for debugging phpMyAdmin. Required for profiling
2129 the code.<br />
2130 For help in setting up your system to this, see the
2131 <a href="#developersdbg">Developers</a> section.</dd>
2133 <dt id="cfg_DBG_profile_enable">$cfg['DBG']['profile']['enable'] boolean</dt>
2134 <dd><b>DEVELOPERS ONLY!</b><br />
2135 Enable profiling support for phpMyAdmin. This will append a chunk of data
2136 to the end of every page displayed in the main window with profiling
2137 statistics for that page.<br />
2138 You may need to increase the maximum execution time for this to
2139 complete successfully.<i>Profiling was removed from the code for
2140 version 2.9.0 due to licensing issues.</i></dd>
2142 <dt id="cfg_DBG_profile_threshold">$cfg['DBG']['profile']['threshold'] float (units in milliseconds)</dt>
2143 <dd><b>DEVELOPERS ONLY!</b><br />
2144 When profiling data is displayed, this variable controls the threshold of
2145 display for any profiling data, based on the average time each time has
2146 taken. If it is over the threshold it is displayed, otherwise it is not
2147 displayed. This takes a value in milliseconds. In most cases you don't need
2148 to edit this.</dd>
2150 <dt id="cfg_ColumnTypes">$cfg['ColumnTypes'] array</dt>
2151 <dd>All possible types of a MySQL column. In most cases you don't need to
2152 edit this.</dd>
2154 <dt id="cfg_AttributeTypes">$cfg['AttributeTypes'] array</dt>
2155 <dd>Possible attributes for fields. In most cases you don't need to edit
2156 this.</dd>
2158 <dt id="cfg_Functions">$cfg['Functions'] array</dt>
2159 <dd>A list of functions MySQL supports. In most cases you don't need to
2160 edit this.</dd>
2162 <dt id="cfg_RestrictColumnTypes">$cfg['RestrictColumnTypes'] array</dt>
2163 <dd>Mapping of column types to meta types used for preferring displayed
2164 functions. In most cases you don't need to edit this.</dd>
2166 <dt id="cfg_RestrictFunctions">$cfg['RestrictFunctions'] array</dt>
2167 <dd>Functions preferred for column meta types as defined in
2168 <a href="#cfg_RestrictColumnTypes" class="configrule">$cfg['RestrictColumnTypes']</a>. In most cases you don't need
2169 to edit this.</dd>
2171 <dt id="cfg_DefaultFunctions">$cfg['DefaultFunctions'] array</dt>
2172 <dd>Functions selected by default when inserting/changing row, Functions
2173 are defined for meta types from
2174 <a href="#cfg_RestrictColumnTypes" class="configrule">$cfg['RestrictColumnTypes']</a> and for
2175 <code>first_timestamp</code>, which is used for first timestamp column
2176 in table.</dd>
2178 <dt id="cfg_NumOperators">$cfg['NumOperators'] array</dt>
2179 <dd>Operators available for search operations on numeric and date fields.
2180 </dd>
2182 <dt id="cfg_TextOperators">$cfg['TextOperators'] array</dt>
2183 <dd>Operators available for search operations on character fields.
2184 Note that we put <code>LIKE</code> by default instead of
2185 <code>LIKE %...%</code>, to avoid unintended performance problems
2186 in case of huge tables.</dd>
2188 <dt id="cfg_EnumOperators">$cfg['EnumOperators'] array</dt>
2189 <dd>Operators available for search operations on enum fields.</dd>
2191 <dt id="cfg_NullOperators">$cfg['NullOperators'] array</dt>
2192 <dd>Additional operators available for search operations when the
2193 field can be null.</dd>
2195 </dl>
2197 <!-- TRANSFORMATIONS -->
2198 <h2 id="transformations">Transformations</h2>
2200 <ol><li><a href="#transformationsintro">Introduction</a></li>
2201 <li><a href="#transformationshowto">Usage</a></li>
2202 <li><a href="#transformationsfiles">File structure</a></li>
2203 </ol>
2205 <h3 id="transformationsintro">1. Introduction</h3>
2207 <p> To enable transformations, you have to setup the <tt>column_info</tt> table
2208 and the proper directives. Please see the <a href="#config">Configuration
2209 section</a> on how to do so.</p>
2211 <p> You can apply different transformations to the contents of each field. The
2212 transformation will take the content of each field and transform it with
2213 certain rules defined in the selected transformation.</p>
2215 <p> Say you have a field 'filename' which contains a filename. Normally you would
2216 see in phpMyAdmin only this filename. Using transformations you can transform
2217 that filename into a HTML link, so you can click inside of the phpMyAdmin
2218 structure on the field's link and will see the file displayed in a new browser
2219 window. Using transformation options you can also specify strings to
2220 append/prepend to a string or the format you want the output stored in.</p>
2222 <p> For a general overview of all available transformations and their options,
2223 you can consult your
2224 <i>&lt;www.your-host.com&gt;/&lt;your-install-dir&gt;/transformation_overview.php</i>
2225 installation.</p>
2227 <p> For a tutorial on how to effectively use transformations, see our
2228 <a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a> on
2229 the official phpMyAdmin homepage.</p>
2231 <h3 id="transformationshowto">2. Usage</h3>
2233 <p> Go to your <i>tbl_structure.php</i> page (i.e. reached through
2234 clicking on the 'Structure' link for a table). There click on
2235 &quot;Change&quot; (or change icon) and there you will see three new fields at
2236 the end of the line. They are called 'MIME-type', 'Browser transformation' and
2237 'Transformation options'.</p>
2239 <ul><li>The field 'MIME-type' is a drop-down field. Select the MIME-type
2240 that corresponds to the column's contents. Please note that
2241 transformations are inactive as long as no MIME-type is selected.</li>
2243 <li>The field 'Browser transformation' is a drop-down field. You can choose from a
2244 hopefully growing amount of pre-defined transformations. See below for information on
2245 how to build your own transformation.<br />
2247 There are global transformations and mimetype-bound transformations. Global transformations
2248 can be used for any mimetype. They will take the mimetype, if necessary, into regard.
2249 Mimetype-bound transformations usually only operate on a certain mimetype. There are
2250 transformations which operate on the main mimetype (like 'image'), which will most likely
2251 take the subtype into regard, and those who only operate on a
2252 specific subtype (like 'image/jpeg').<br />
2254 You can use transformations on mimetypes for which the function was not defined for. There
2255 is no security check for you selected the right transformation, so take care of what the
2256 output will be like.</li>
2258 <li>The field 'Transformation options' is a free-type textfield. You have to enter
2259 transform-function specific options here. Usually the transforms can operate with default
2260 options, but it is generally a good idea to look up the overview to see which options are
2261 necessary.<br />
2263 Much like the ENUM/SET-Fields, you have to split up several options using the format
2264 'a','b','c',...(NOTE THE MISSING BLANKS). This is because internally the options will be
2265 parsed as an array, leaving the first value the first element in the array, and so
2266 forth.<br />
2268 If you want to specify a MIME character set you can define it in the transformation_options.
2269 You have to put that outside of the pre-defined options of the specific mime-transform,
2270 as the last value of the set. Use the format "'; charset=XXX'". If you use a transform,
2271 for which you can specify 2 options and you want to append a character set, enter "'first
2272 parameter','second parameter','charset=us-ascii'". You can, however use the defaults for
2273 the parameters: "'','','charset=us-ascii'".</li>
2274 </ul>
2276 <h3 id="transformationsfiles">3. File structure</h3>
2278 <p> All mimetypes and their transformations are defined through single files in
2279 the directory 'libraries/transformations/'.</p>
2281 <p> They are stored in files to ease up customization and easy adding of new
2282 transformations.</p>
2284 <p> Because the user cannot enter own mimetypes, it is kept sure that transformations
2285 always work. It makes no sense to apply a transformation to a mimetype, the
2286 transform-function doesn't know to handle.</p>
2288 <p> One can, however, use empty mime-types and global transformations which should work
2289 for many mimetypes. You can also use transforms on a different mimetype they where built
2290 for, but pay attention to option usage as well as what the transformation does to your
2291 field.</p>
2293 <p> There is a basic file called '<i>global.inc.php</i>'. This function can be included by
2294 any other transform function and provides some basic functions.</p>
2296 <p> There are 5 possible file names:</p>
2298 <ol><li>A mimetype+subtype transform:<br /><br />
2300 <tt>[mimetype]_[subtype]__[transform].inc.php</tt><br /><br />
2302 Please not that mimetype and subtype are separated via '_', which shall
2303 not be contained in their names. The transform function/filename may
2304 contain only characters which cause no problems in the file system as
2305 well as the PHP function naming convention.<br /><br />
2307 The transform function will the be called
2308 '<tt>PMA_transform_[mimetype]_[subtype]__[transform]()</tt>'.<br /><br />
2310 <b>Example:</b><br /><br />
2312 <tt>text_html__formatted.inc.php</tt><br />
2313 <tt>PMA_transform_text_html__formatted()</tt></li>
2315 <li>A mimetype (w/o subtype) transform:<br /><br />
2317 <tt>[mimetype]__[transform].inc.php</tt><br /><br />
2319 Please note that there are no single '_' characters.
2320 The transform function/filename may contain only characters which cause
2321 no problems in the file system as well as the PHP function naming
2322 convention.<br /><br />
2324 The transform function will the be called
2325 '<tt>PMA_transform_[mimetype]__[transform]()</tt>'.<br /><br />
2327 <b>Example:</b><br /><br />
2329 <tt>text__formatted.inc.php</tt><br />
2330 <tt>PMA_transform_text__formatted()</tt></li>
2332 <li>A mimetype+subtype without specific transform function<br /><br />
2334 <tt>[mimetype]_[subtype].inc.php</tt><br /><br />
2336 Please note that there are no '__' characters in the filename. Do not
2337 use special characters in the filename causing problems with the file
2338 system.<br /><br />
2340 No transformation function is defined in the file itself.<br /><br />
2342 <b>Example:</b><br /><br />
2344 <tt>text_plain.inc.php</tt><br />
2345 (No function)</li>
2347 <li>A mimetype (w/o subtype) without specific transform function<br /><br />
2349 <tt>[mimetype].inc.php</tt><br /><br />
2351 Please note that there are no '_' characters in the filename. Do not use
2352 special characters in the filename causing problems with the file system.
2353 <br /><br />
2355 No transformation function is defined in the file itself.<br /><br />
2357 <b>Example:</b><br /><br />
2359 <tt>text.inc.php</tt><br />
2360 (No function)</li>
2362 <li>A global transform function with no specific mimetype<br /><br />
2364 <tt>global__[transform].inc.php</tt><br /><br />
2366 The transform function will the be called
2367 '<tt>PMA_transform_global__[transform]()</tt>'.<br /><br />
2369 <b>Example:</b><br /><br />
2371 <tt>global__formatted</tt><br />
2372 <tt>PMA_transform_global__formatted()</tt></li>
2373 </ol>
2375 <p> So generally use '_' to split up mimetype and subtype, and '__' to provide a
2376 transform function.</p>
2378 <p> All filenames containing no '__' in themselves are not shown as valid transform
2379 functions in the dropdown.</p>
2381 <p> Please see the libraries/transformations/TEMPLATE file for adding your own transform
2382 function. See the libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
2383 without a transform function. Also note the introduction of a function description in
2384 the language files. For each function a $strTransformation_[filename without .inc.php]
2385 has to exist.</p>
2387 <p> You can use the template generator to generate new functions and entries in the
2388 language file.</p>
2390 <p> To create a new transform function please see
2391 <tt>libraries/transformations/template_generator.sh</tt>.
2392 To create a new, empty mimetype please see
2393 <tt>libraries/transformations/template_generator_mimetype.sh</tt>.</p>
2395 <p> A transform function always gets passed three variables:</p>
2397 <ol><li><b>$buffer</b> - Contains the text inside of the column. This is the text,
2398 you want to transform.</li>
2399 <li><b>$options</b> - Contains any user-passed options to a transform function
2400 as an array.</li>
2401 <li><b>$meta</b> - Contains an object with field information to your column.
2402 The data is drawn from the output of the
2403 <a href="http://www.php.net/mysql_fetch_field">mysql_fetch_field()</a>
2404 function. This means, all object properties described on the
2405 <a href="http://www.php.net/mysql_fetch_field">manual page</a> are
2406 available in this variable and can be used to transform a field accordingly
2407 to unsigned/zerofill/not_null/... properties.<br />
2408 The $meta-&gt;mimetype variable contains the original MIME-type of the
2409 field (i.e. 'text/plain', 'image/jpeg' etc.)</li>
2410 </ol>
2412 <!-- FAQ -->
2413 <h2 id="faq">FAQ - Frequently Asked Questions</h2>
2415 <ol><li><a href="#faqserver">Server</a></li>
2416 <li><a href="#faqconfig">Configuration</a></li>
2417 <li><a href="#faqlimitations">Known limitations</a></li>
2418 <li><a href="#faqmultiuser">ISPs, multi-user installations</a></li>
2419 <li><a href="#faqbrowsers">Browsers or client <abbr title="operating system">OS</abbr></a></li>
2420 <li><a href="#faqusing">Using phpMyAdmin</a></li>
2421 <li><a href="#faqproject">phpMyAdmin project</a></li>
2422 <li><a href="#faqsecurity">Security</a></li>
2423 </ol>
2425 <p> Please have a look at our
2426 <a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a> on
2427 the official phpMyAdmin homepage for in-depth coverage of phpMyAdmin's
2428 features and or interface.</p>
2430 <h3 id="faqserver">Server</h3>
2432 <h4 id="faq1_1">
2433 <a href="#faq1_1">1.1 I'm running PHP 4+ and my server is crashing each time a specific
2434 action is required or phpMyAdmin sends a blank page or a page full of
2435 cryptic characters to my browser, what can I do?</a></h4>
2437 <p> There are some known PHP bugs with output buffering and compression.<br />
2438 Try to set the <a href="#cfg_OBGzip" class="configrule">$cfg['OBGzip']</a>
2439 directive to <tt>FALSE</tt> in your <i>config.inc.php</i> file and the
2440 <tt>zlib.output_compression</tt> directive to <tt>Off</tt> in your php
2441 configuration file.<br />
2442 Furthermore, we know about such problems connected to the release
2443 candidates of PHP 4.2.0 (tested with PHP 4.2.0 RC1 to RC4) together with
2444 MS Internet Explorer. Please upgrade to the release version PHP 4.2.0.</p>
2446 <h4 id="faq1_2">
2447 <a href="#faq1_2">1.2 My Apache server crashes when using phpMyAdmin.</a></h4>
2449 <p> You should first try the latest versions of Apache (and possibly MySQL).<br />
2450 See also the
2451 <a href="#faq1_1"><abbr title="Frequently Asked Questions">FAQ</abbr> 1.1</a>
2452 entry about PHP bugs with output buffering.<br />
2453 If your server keeps crashing, please ask for help in the various Apache
2454 support groups.</p>
2456 <h4 id="faq1_3">
2457 <a href="#faq1_3">1.3 I'm running phpMyAdmin with "cookie" authentication
2458 mode under PHP 4.2.0 or 4.2.1 loaded as an Apache 2 module but can't enter the
2459 script: I'm always displayed the login screen.</a></h4>
2461 <p> This is a known PHP bug (see this
2462 <a href="http://bugs.php.net/bug.php?id=16626">bug report</a>) from the
2463 official PHP bug database. It means there is and won't be any phpMyAdmin
2464 fix against it because there is no way to code a fix.</p>
2466 <h4 id="faq1_4">
2467 <a href="#faq1_4">1.4 Using phpMyAdmin on
2468 <abbr title="Internet Information Services">IIS</abbr>, I'm displayed the
2469 error message: &quot;The specified <abbr title="Common Gateway Interface">CGI</abbr>
2470 application misbehaved by not returning a complete set of
2471 <abbr title="HyperText Transfer Protocol">HTTP</abbr> headers ...&quot;.</a>
2472 </h4>
2474 <p> You just forgot to read the <i>install.txt</i> file from the php distribution.
2475 Have a look at the last message in this
2476 <a href="http://bugs.php.net/bug.php?id=12061">bug report</a> from the
2477 official PHP bug database.</p>
2479 <h4 id="faq1_5">
2480 <a href="#faq1_5">1.5 Using phpMyAdmin on
2481 <abbr title="Internet Information Services">IIS</abbr>, I'm facing crashes
2482 and/or many error messages with the
2483 <abbr title="HyperText Transfer Protocol">HTTP</abbr> or advanced authentication
2484 mode.</a></h4>
2486 <p> This is a known problem with the PHP
2487 <abbr title="Internet Server Application Programming Interface">ISAPI</abbr>
2488 filter: it's not so stable. Please use instead the cookie authentication mode.
2489 </p>
2491 <h4 id="faq1_6">
2492 <a href="#faq1_6">1.6 I can't use phpMyAdmin on PWS: nothing is displayed!</a></h4>
2494 <p> This seems to be a PWS bug. Filippo Simoncini found a workaround (at this
2495 time there is no better fix): remove or comment the <tt>DOCTYPE</tt>
2496 declarations (2 lines) from the scripts <i>libraries/header.inc.php</i>,
2497 <i>libraries/header_printview.inc.php</i>, <i>index.php</i>,
2498 <i>navigation.php</i> and <i>libraries/common.lib.php</i>.</p>
2500 <h4 id="faq1_7">
2501 <a href="#faq1_7">1.7 How can I GZip or Bzip a dump or a
2502 <abbr title="comma separated values">CSV</abbr> export? It does not seem to
2503 work.</a></h4>
2505 <p> These features are based on the <tt>gzencode()</tt> and <tt>bzcompress()</tt>
2506 PHP functions to be more independent of the platform (Unix/Windows, Safe Mode
2507 or not, and so on). So, you must have PHP4&nbsp;&gt;=&nbsp;4.0.4 and Zlib/Bzip2
2508 support (<tt>--with-zlib</tt> and <tt>--with-bz2</tt>).<br />
2509 We faced PHP crashes when trying to download a dump with MS Internet
2510 Explorer when phpMyAdmin is run with a release candidate of PHP 4.2.0. In
2511 this case you should switch to the release version of PHP 4.2.0.</p>
2513 <h4 id="faq1_8">
2514 <a href="#faq1_8">1.8 I cannot insert a text file in a table, and I get
2515 an error about safe mode being in effect.</a></h4>
2517 <p> Your uploaded file is saved by PHP in the &quot;upload dir&quot;, as
2518 defined in <i>php.ini</i> by the variable <tt>upload_tmp_dir</tt> (usually
2519 the system default is <i>/tmp</i>).<br />
2520 We recommend the following setup for Apache servers running in safe mode,
2521 to enable uploads of files while being reasonably secure:</p>
2523 <ul><li>create a separate directory for uploads: <tt>mkdir /tmp/php</tt></li>
2524 <li>give ownership to the Apache server's user.group:
2525 <tt>chown apache.apache /tmp/php</tt></li>
2526 <li>give proper permission: <tt>chmod 600 /tmp/php</tt></li>
2527 <li>put <tt>upload_tmp_dir = /tmp/php</tt> in <i>php.ini</i></li>
2528 <li>restart Apache</li>
2529 </ul>
2531 <h4 id="faq1_9">
2532 <a href="#faq1_9">1.9 I'm having troubles when uploading files. In
2533 general file uploads don't work on my system and uploaded files have a
2534 <tt>Content-Type:</tt> header in the first line.</a></h4>
2536 <p> It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat 7.0
2537 and you updated your PHP RPM to php-4.0.4pl1-3.i386.rpm, didn't you?<br />
2538 So the problem is that this package has a serious bug that was corrected
2539 ages ago in PHP (2001-01-28: see
2540 <a href="http://www.php.net/bugs.php?id=8966">PHP's bug tracking system</a>
2541 for more details). The problem is that the bugged package is still
2542 available though it was corrected (see
2543 <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=24933">RedHat's BugZilla</a>
2544 for more details).<br />
2545 So please download
2546 <a href="http://www.redhat.com/swr/i386/php-4.0.4pl1-9.i386.html">the fixed package (4.0.4pl1-9)</a>
2547 and the problem should go away.<br />
2548 And that fixes the \r\n problem with file uploads!</p>
2550 <h4 id="faq1_10">
2551 <a href="#faq1_10">1.10 I'm having troubles when uploading files with
2552 phpMyAdmin running on a secure server. My browser is Internet Explorer and
2553 I'm using the Apache server.</a></h4>
2555 <p> As suggested by &quot;Rob M&quot; in the phpWizard forum, add this line to
2556 your <i>httpd.conf</i>:</p>
2558 <pre>SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown</pre>
2560 <p> It seems to clear up many problems between Internet Explorer and SSL.</p>
2562 <h4 id="faq1_11">
2563 <a href="#faq1_11">1.11 I get an 'open_basedir restriction' while
2564 uploading a file from the query box.</a></h4>
2566 <p> Since version 2.2.4, phpMyAdmin supports servers with open_basedir
2567 restrictions. However you need to create temporary directory and
2568 configure it as <a href="#cfg_TempDir" class="configrule">$cfg['TempDir']</a>.
2569 The uploaded files will be moved there, and after execution of your
2570 <abbr title="structured query language">SQL</abbr> commands, removed.</p>
2572 <h4 id="faq1_12">
2573 <a href="#faq1_12">1.12 I have lost my MySQL root password, what can I do?</a></h4>
2575 <p> The MySQL manual explains how to
2576 <a href="http://www.mysql.com/doc/R/e/Resetting_permissions.html">
2577 reset the permissions</a>.</p>
2579 <h4 id="faq1_13">
2580 <a href="#faq1_13">1.13 I get an error 'No
2581 <abbr title="structured query language">SQL</abbr> query' when trying to
2582 execute a bookmark.</a></h4>
2584 <p> If PHP does not have read/write access to its <tt>upload_tmp_dir</tt>, it
2585 cannot access the uploaded query.</p>
2587 <h4 id="faq1_14">
2588 <a href="#faq1_14">1.14 I get an error 'No
2589 <abbr title="structured query language">SQL</abbr> query' when trying to
2590 submit a query from the convenient text area.</a></h4>
2592 <p> Check the <tt>post_max_size</tt> directive from your PHP configuration file
2593 and try to increase it.</p>
2595 <h4 id="faq1_15">
2596 <a href="#faq1_15">1.15 I have problems with <i>mysql.user</i> field names.</a>
2597 </h4>
2599 <p> In previous MySQL versions, the <tt>User</tt> and <tt>Password</tt> fields
2600 were named <tt>user</tt> and <tt>password</tt>. Please modify your field
2601 names to align with current standards.</p>
2603 <h4 id="faq1_16">
2604 <a href="#faq1_16">1.16 I cannot upload big dump files (memory,
2605 <abbr title="HyperText Transfer Protocol">HTTP</abbr> or timeout problems).</a>
2606 </h4>
2608 <p> Starting with version 2.7.0, the import engine has been re&#8211;written and these
2609 problems should not occur. If possible, upgrade your phpMyAdmin to the latest version
2610 to take advantage of the new import features.</p>
2612 <p> The first things to check (or ask your host provider to check) are the
2613 values of <tt>upload_max_filesize</tt>, <tt>memory_limit</tt> and
2614 <tt>post_max_size</tt> in the <i>php.ini</i> configuration file.
2615 All of these three settings limit the maximum size of data that can be
2616 submitted and handled by PHP. One user also said that post_max_size
2617 and memory_limit need to be larger than upload_max_filesize.<br /> <br />
2619 There exist several workarounds if your upload is too big or your
2620 hosting provider is unwilling to change the settings:</p>
2622 <ul><li>Look at the <a href="#cfg_UploadDir" class="configrule">$cfg['UploadDir']</a>
2623 feature. This allows one to
2624 upload a file to the server via scp, ftp, or your favorite file transfer
2625 method. PhpMyAdmin is then able to import the files from the temporary
2626 directory. More information is available in the <a href="#config">Configuration
2627 section</a> of this document.</li>
2628 <li>Using a utility (such as <a href="http://www.ozerov.de/bigdump.php">
2629 BigDump</a>) to split the files before uploading. We cannot support this
2630 or any third party applications, but are aware of users having success
2631 with it.</li>
2632 <li>If you have shell (command line) access, use MySQL to import the files
2633 directly. You can do this by issuing the &quot;source&quot; command from
2634 within MySQL: <tt>source <i>filename.sql</i></tt>.</li>
2635 </ul>
2637 <h4 id="faq1_17">
2638 <a id="faqmysqlversions" href="#faq1_17">1.17 Which MySQL versions does phpMyAdmin
2639 support?</a></h4>
2641 <p> In phpMyAdmin 3.0.x, versions starting with MySQL 5.0.1 are
2642 fully supported. phpMyAdmin may connect to your MySQL server
2643 using PHP's classic
2644 <a href="http://php.net/mysql">MySQL extension</a> as well as the
2645 <a href="http://php.net/mysqli">improved MySQL extension (MySQLi)</a> that
2646 is available in php 5.0.<br />
2647 Either way, the developers of both extensions recommend to use the classic
2648 extension for MySQL 4.0 and below and MySQLi for MySQL 4.1 and newer.<br />
2649 When compiling php, we strongly recommend that you manually link the MySQL
2650 extension of your choice to a MySQL client library of at least the same
2651 minor version since the one that is bundled with some PHP distributions is
2652 rather old and might cause problems <a href="#faq1_17a">
2653 (see <abbr title="Frequently Asked Questions">FAQ</abbr> 1.17a)</a>.
2654 If your webserver is running on a windows system, you might want to try
2655 MySQL's
2656 <a href="http://dev.mysql.com/downloads/connector/php/">Connector/PHP</a>
2657 instead of the MySQL / MySQLi extensions that are bundled with the official
2658 php Win32 builds.</p>
2660 <h5 id="faq1_17a">
2661 <a href="#faq1_17a">1.17a I cannot connect to the MySQL server. It always returns the error
2662 message, &quot;Client does not support authentication protocol requested
2663 by server; consider upgrading MySQL client&quot;</a></h5>
2665 <p> You tried to access MySQL with an old MySQL client library. The version of
2666 your MySQL client library can be checked in your phpinfo() output.
2667 In general, it should have at least the same minor version as your server
2668 - as mentioned in <a href="#faq1_17">
2669 <abbr title="Frequently Asked Questions">FAQ</abbr> 1.17</a>.<br /><br />
2671 This problem is generally caused by using MySQL version 4.1 or newer. MySQL
2672 changed the authentication hash and your PHP is trying to use the old method.
2673 The proper solution is to use the <a href="http://www.php.net/mysqli">mysqli extension</a>
2674 with the proper client library to match your MySQL installation. Your
2675 chosen extension is specified in <a href="#cfg_Servers_extension" class="configrule">$cfg['Servers'][$i]['extension']</a>.
2676 More information (and several workarounds) are located in the
2677 <a href="http://dev.mysql.com/doc/mysql/en/old-client.html">MySQL Documentation</a>.
2678 </p>
2680 <h4 id="faq1_18">
2681 <a href="#faq1_18">1.18 I'm running MySQL&nbsp;&lt;=&nbsp;4.0.1 having
2682 <tt>lower_case_table_names</tt> set to 1. If I create a new table with a
2683 capital letter in its name it is changed to lowercase as it should. But
2684 if I try to DROP this table MySQL is unable to find the corresponding
2685 file.</a></h4>
2687 <p> This is a bug of MySQL&nbsp;&lt;=&nbsp;4.0.1. Please upgrade to at least
2688 MySQL&nbsp;4.0.2 or turn off your <tt>lower_case_table_names</tt>
2689 directive.</p>
2691 <h4 id="faq1_19">
2692 <a href="#faq1_19">1.19 I can't run the &quot;display relations&quot; feature because the
2693 script seems not to know the font face I'm using!</a></h4>
2695 <p> The &quot;FPDF&quot; library we're using for this feature requires some
2696 special files to use font faces.<br />
2697 Please refers to the <a href="http://www.fpdf.org/">FPDF manual</a> to build
2698 these files.</p>
2700 <h4 id="faqmysql">
2701 <a href="#faqmysql">1.20 I receive the error &quot;cannot load MySQL extension, please
2702 check PHP Configuration&quot;.</a></h4>
2704 <p> To connect to a MySQL server, PHP needs a set of MySQL functions called
2705 &quot;MySQL extension&quot;. This extension may be part of the PHP
2706 distribution (compiled-in), otherwise it needs to be loaded dynamically. Its
2707 name is probably <i>mysql.so</i> or <i>php_mysql.dll</i>. phpMyAdmin tried
2708 to load the extension but failed.<br /><br />
2710 Usually, the problem is solved by installing a software package called
2711 &quot;PHP-MySQL&quot; or something similar.</p>
2713 <h4 id="faq1_21">
2714 <a href="#faq1_21">1.21 I am running the
2715 <abbr title="Common Gateway Interface">CGI</abbr> version of PHP under Unix,
2716 and I cannot log in using cookie auth.</a></h4>
2718 <p> In <i>php.ini</i>, set <tt>mysql.max_links</tt> higher than 1.</p>
2720 <h4 id="faq1_22">
2721 <a href="#faq1_22">1.22 I don't see the &quot;Location of text file&quot; field,
2722 so I cannot upload.</a></h4>
2724 <p> This is most likely because in <i>php.ini</i>, your <tt>file_uploads</tt>
2725 parameter is not set to &quot;on&quot;.</p>
2727 <h4 id="faq1_23">
2728 <a href="#faq1_23">1.23 I'm running MySQL on a Win32 machine. Each time I create
2729 a new table the table and field names are changed to lowercase!</a></h4>
2731 <p> This happens because the MySQL directive <tt>lower_case_table_names</tt>
2732 defaults to 1 (<tt>ON</tt>) in the Win32 version of MySQL. You can change
2733 this behavior by simply changing the directive to 0 (<tt>OFF</tt>):<br />
2734 Just edit your <tt>my.ini</tt> file that should be located in your Windows
2735 directory and add the following line to the group [mysqld]:</p>
2737 <pre>set-variable = lower_case_table_names=0</pre>
2739 <p> Next, save the file and restart the MySQL service. You can always check the
2740 value of this directive using the query</p>
2742 <pre>SHOW VARIABLES LIKE 'lower_case_table_names';</pre>
2744 <h4 id="faq1_24">
2745 <a href="#faq1_24">1.24 Some characters are being truncated in my queries, or I
2746 get characters randomly added. I am running PHP 4.2.3.</a></h4>
2748 <p> This is a <a href="http://bugs.php.net/bug.php?id=19404">PHP 4.2.3 bug</a>.
2749 </p>
2751 <h4 id="faq1_25">
2752 <a href="#faq1_25">1.25 I am running Apache with mod_gzip-1.3.26.1a on Windows XP,
2753 and I get problems, such as undefined variables when I run a
2754 <abbr title="structured query language">SQL</abbr> query.</a></h4>
2756 <p> A tip from Jose Fandos: put a comment on the following two lines
2757 in httpd.conf, like this:</p>
2759 <pre>
2760 # mod_gzip_item_include file \.php$
2761 # mod_gzip_item_include mime "application/x-httpd-php.*"
2762 </pre>
2764 <p> as this version of mod_gzip on Apache (Windows) has problems handling
2765 PHP scripts. Of course you have to restart Apache.</p>
2767 <h4 id="faq1_26">
2768 <a href="#faq1_26">1.26 I just installed phpMyAdmin in my document root of
2769 <abbr title="Internet Information Services">IIS</abbr> but
2770 I get the error &quot;No input file specified&quot; when trying to
2771 run phpMyAdmin.</a></h4>
2773 <p> This is a permission problem. Right-click on the phpmyadmin folder
2774 and choose properties. Under the tab Security, click on &quot;Add&quot;
2775 and select the user &quot;IUSR_machine&quot; from the list. Now set his
2776 permissions and it should work.</p>
2778 <h4 id="faq1_27">
2779 <a href="#faq1_27">1.27 I get empty page when I want to view huge page (eg.
2780 db_structure.php with plenty of tables).</a></h4>
2782 <p> This is a <a href="http://bugs.php.net/21079">PHP bug</a> that occur when
2783 GZIP output buffering is enabled. If you turn off it (by
2784 <a href="#cfg_OBGzip" class="configrule">$cfg['OBGzip'] = false</a>
2785 in <i>config.inc.php</i>), it should work. This bug will be fixed in
2786 PHP&nbsp;5.0.0.</p>
2788 <h4 id="faq1_28">
2789 <a href="#faq1_28">1.28 My MySQL server sometimes refuses queries and returns the
2790 message 'Errorcode: 13'. What does this mean?</a></h4>
2792 <p> This can happen due to a MySQL bug when having database / table names with
2793 upper case characters although <tt>lower_case_table_names</tt> is set to 1.
2794 To fix this, turn off this directive, convert all database and table names
2795 to lower case and turn it on again. Alternatively, there's a bug-fix
2796 available starting with MySQL&nbsp;3.23.56 / 4.0.11-gamma.</p>
2798 <h4 id="faq1_29">
2799 <a href="#faq1_29">1.29 When I create a table or modify a field, I get an error
2800 and the fields are duplicated.</a></h4>
2802 <p> It is possible to configure Apache in such a way that PHP has problems
2803 interpreting .php files.</p>
2805 <p> The problems occur when two different (and conflicting) set of directives
2806 are used:</p>
2808 <pre>
2809 SetOutputFilter PHP
2810 SetInputFilter PHP
2811 </pre>
2813 <p> and</p>
2815 <pre>AddType application/x-httpd-php .php</pre>
2817 <p> In the case we saw, one set of directives was in
2818 <tt>/etc/httpd/conf/httpd.conf</tt>, while
2819 the other set was in <tt>/etc/httpd/conf/addon-modules/php.conf</tt>.<br />
2820 The recommended way is with <tt>AddType</tt>, so just comment out
2821 the first set of lines and restart Apache:</p>
2823 <pre>
2824 #SetOutputFilter PHP
2825 #SetInputFilter PHP
2826 </pre>
2828 <h4 id="faq1_30">
2829 <a href="#faq1_30">1.30 I get the error &quot;navigation.php: Missing hash&quot;.</a></h4>
2831 <p> This problem is known to happen when the server is running Turck MMCache
2832 but upgrading MMCache to version 2.3.21 solves the problem.</p>
2834 <h4 id="faq1_31">
2835 <a href="#faq1_31">1.31 Does phpMyAdmin support php5?</a></h4>
2837 <p> Yes.<br />
2838 However, phpMyAdmin needs to be backwards compatible to php4. This is why
2839 phpMyAdmin disables the <tt>E_STRICT</tt> error_level in
2840 <tt>error_reporting</tt> settings.
2841 </p>
2843 <h4 id="faq1_32">
2844 <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>
2846 <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>
2847 mode under <abbr title="Internet Information Services">IIS</abbr> 5.1.</p>
2849 <ol><li>In your <tt>php.ini</tt> file, set <tt>cgi.rfc2616_headers = 0</tt></li>
2850 <li>In <tt>Web Site Properties -&gt; File/Directory Security -&gt; Anonymous
2851 Access</tt> dialog box, check the <tt>Anonymous access</tt> checkbox and
2852 uncheck any other checkboxes (i.e. uncheck <tt>Basic authentication</tt>,
2853 <tt>Integrated Windows authentication</tt>, and <tt>Digest</tt> if it's
2854 enabled.) Click <tt>OK</tt>.</li>
2855 <li>In <tt>Custom Errors</tt>, select the range of <tt>401;1</tt> through
2856 <tt>401;5</tt> and click the <tt>Set to Default</tt> button.</li>
2857 </ol>
2859 <h4 id="faq1_33">
2860 <a href="#faq1_33">1.33 Is there a problem with the mysqli extension when running
2861 PHP 5.0.4 on 64-bit systems?</a></h4>
2863 <p> Yes. This problem affects phpMyAdmin (&quot;Call to undefined function
2864 pma_reloadnavigation&quot;), so upgrade your PHP to the next version.</p>
2866 <h4 id="faq1_34">
2867 <a href="#faq1_34">1.34 Can I access directly to database or table pages?</a></h4>
2869 <p> Yes. Out of the box, you can use <abbr title="Uniform Resource Locator">URL</abbr>s like
2870 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
2871 the order of the server paragraph in <tt>config.inc.php</tt>.
2872 Table and script parts are optional. If you want
2873 http://server/phpMyAdmin/database[/table][/script] <abbr title="Uniform Resource Locator">URL</abbr>s, you need to do
2874 some configuration. Following lines apply only for <a
2875 href="http://httpd.apache.org">Apache</a> web server. First make sure,
2876 that you have enabled some features within global configuration. You need
2877 <code>Options FollowSymLinks</code> and <code>AllowOverride
2878 FileInfo</code> enabled for directory where phpMyAdmin is installed and
2879 you need mod_rewrite to be enabled. Then you just need to create following
2880 <code>.htaccess</code> file in root folder of phpMyAdmin installation
2881 (don't forget to change directory name inside of it):</p>
2883 <pre>
2884 RewriteEngine On
2885 RewriteBase /path_to_phpMyAdmin
2886 RewriteRule ^([a-zA-Z0-9_]+)/([a-zA-Z0-9_]+)/([a-z_]+\.php)$ index.php?db=$1&amp;table=$2&amp;target=$3 [R]
2887 RewriteRule ^([a-zA-Z0-9_]+)/([a-z_]+\.php)$ index.php?db=$1&amp;target=$2 [R]
2888 RewriteRule ^([a-zA-Z0-9_]+)/([a-zA-Z0-9_]+)$ index.php?db=$1&amp;table=$2 [R]
2889 RewriteRule ^([a-zA-Z0-9_]+)$ index.php?db=$1 [R]
2890 </pre>
2892 <h4 id="faq1_35">
2893 <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>
2895 <p> Yes. However you need to pass authentication variable to <abbr title="Common Gateway Interface">CGI</abbr> using
2896 following rewrite rule:</p>
2898 <pre>
2899 RewriteEngine On
2900 RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization},L]
2901 </pre>
2903 <h4 id="faq1_36">
2904 <a href="#faq1_36">1.36 I get an error &quot;500 Internal Server Error&quot;.</a>
2905 </h4>
2907 There can be many explanations to this and a look at your server's
2908 error log file might give a clue.
2909 </p>
2911 <h4 id="faq1_37">
2912 <a href="#faq1_37">1.37 I run phpMyAdmin on cluster of different machines and
2913 password encryption in cookie auth doesn't work.</a></h4>
2915 <p> If your cluster consist of different architectures, PHP code used for
2916 encryption/decryption won't work correct. This is caused by use of
2917 pack/unpack functions in code. Only solution is to use mcrypt extension
2918 which works fine in this case.</p>
2920 <h4 id="faq1_38">
2921 <a href="#faq1_38">1.38 Can I use phpMyAdmin on a server on which Suhosin is enabled?</a></h4>
2923 <p> Yes but the default configuration values of Suhosin are known to cause
2924 problems with some operations, for example editing a table with many
2925 columns and no primary key. Tuning information is available at
2926 <a href="http://www.hardened-php.net/hphp/troubleshooting.html">
2927 http://www.hardened-php.net/hphp/troubleshooting.html</a>,
2928 although the parameter names have changed (<tt>suhosin</tt> instead
2929 of <tt>hphp</tt>). See also the <a href="#cfg_SuhosinDisableWarning">
2930 <tt>SuhosinDisableWarning</tt> directive</a>.
2931 </p>
2933 <h3 id="faqconfig">Configuration</h3>
2935 <h4 id="faq2_1">
2936 <a href="#faq2_1">2.1 The error message &quot;Warning: Cannot add header information -
2937 headers already sent by ...&quot; is displayed, what's the problem?</a></h4>
2939 <p> Edit your <i>config.inc.php</i> file and ensure there is nothing
2940 (I.E. no blank lines, no spaces, no characters...) neither before the
2941 <tt>&lt;?php</tt> tag at the beginning, neither after the <tt>?&gt;</tt>
2942 tag at the end. We also got a report from a user under IIS, that used
2943 a zipped distribution kit: the file <tt>libraries/Config.class.php</tt>
2944 contained an end-of-line character (hex 0A) at the end; removing this character
2945 cleared his errors.</p>
2947 <h4 id="faq2_2">
2948 <a href="#faq2_2">2.2 phpMyAdmin can't connect to MySQL. What's wrong?</a></h4>
2950 <p> Either there is an error with your PHP setup or your username/password is
2951 wrong. Try to make a small script which uses mysql_connect and see if it
2952 works. If it doesn't, it may be you haven't even compiled MySQL support
2953 into PHP.</p>
2955 <h4 id="faq2_3">
2956 <a href="#faq2_3">2.3 The error message &quot;Warning: MySQL Connection Failed: Can't
2957 connect to local MySQL server through socket '/tmp/mysql.sock'
2958 (111) ...&quot; is displayed. What can I do?</a></h4>
2960 <p> For RedHat users, Harald Legner suggests this on the mailing list:</p>
2962 <p> On my RedHat-Box the socket of MySQL is <i>/var/lib/mysql/mysql.sock</i>.
2963 In your <i>php.ini</i> you will find a line</p>
2965 <pre>mysql.default_socket = /tmp/mysql.sock</pre>
2967 <p> change it to</p>
2969 <pre>mysql.default_socket = /var/lib/mysql/mysql.sock</pre>
2971 <p> Then restart apache and it will work.</p>
2973 <p> Here is a fix suggested by Brad Ummer:</p>
2975 <ul><li>First, you need to determine what socket is being used by MySQL.<br />
2976 To do this, telnet to your server and go to the MySQL bin directory. In
2977 this directory there should be a file named <i>mysqladmin</i>. Type
2978 <tt>./mysqladmin variables</tt>, and this should give you a bunch of
2979 info about your MySQL server, including the socket
2980 (<i>/tmp/mysql.sock</i>, for example).</li>
2981 <li>Then, you need to tell PHP to use this socket.<br /> To do this in
2982 phpMyAdmin, you need to complete the socket information in the
2983 <i>config.inc.php</i>.<br />
2984 For example:
2985 <a href="#cfg_Servers_socket" class="configrule">
2986 $cfg['Servers'][$i]['socket']&nbsp;=&nbsp;'/tmp/mysql.sock';</a>
2987 <br /><br />
2989 Please also make sure that the permissions of this file allow to be readable
2990 by your webserver (i.e. '0755').</li>
2991 </ul>
2993 <p> Have also a look at the
2994 <a href="http://www.mysql.com/doc/C/a/Can_not_connect_to_server.html">
2995 corresponding section of the MySQL documentation</a>.</p>
2997 <h4 id="faq2_4">
2998 <a href="#faq2_4">2.4 Nothing is displayed by my browser when I try to run phpMyAdmin,
2999 what can I do?</a></h4>
3001 <p> Try to set the <a href="#cfg_OBGzip" class="configrule">$cfg['OBGZip']</a>
3002 directive to <tt>FALSE</tt> in the phpMyAdmin configuration file. It helps
3003 sometime.<br />
3004 Also have a look at your PHP version number: if it contains &quot;4.0b...&quot;
3005 it means you're running a beta version of PHP. That's not a so good idea,
3006 please upgrade to a plain revision.</p>
3008 <h4 id="faq2_5">
3009 <a href="#faq2_5">2.5 Each time I want to insert or change a record or drop a database
3010 or a table, an error 404 (page not found) is displayed or, with <abbr title="HyperText Transfer Protocol">HTTP</abbr> or
3011 cookie authentication, I'm asked to log in again. What's wrong?</a></h4>
3013 <p> Check the value you set for the
3014 <a href="#cfg_PmaAbsoluteUri" class="configrule">$cfg['PmaAbsoluteUri']</a>
3015 directive in the phpMyAdmin configuration file.</p>
3017 <h4 id="faq2_6">
3018 <a href="#faq2_6">2.6 I get an &quot;Access denied for user: 'root@localhost' (Using
3019 password: YES)&quot;-error when trying to access a MySQL-Server on a
3020 host which is port-forwarded for my localhost.</a></h4>
3022 <p> When you are using a port on your localhost, which you redirect via
3023 port-forwarding to another host, MySQL is not resolving the localhost
3024 as expected.<br />
3025 Erik Wasser explains: The solution is: if your host is &quot;localhost&quot;
3026 MySQL (the commandline tool 'mysql' as well) always tries to use the socket
3027 connection for speeding up things. And that doesn't work in this configuration
3028 with port forwarding.<br />
3029 If you enter "127.0.0.1" as hostname, everything is right and MySQL uses the
3030 <abbr title="Transmission Control Protocol">TCP</abbr> connection.</p>
3032 <h4 id="faqthemes"><a href="#faqthemes">2.7 Using and creating themes</a></h4>
3034 <p> Themes are configured with
3035 <a href="#cfg_ThemePath" class="configrule">$cfg['ThemePath']</a>,
3036 <a href="#cfg_ThemeManager" class="configrule">$cfg['ThemeManager']</a> and
3037 <a href="#cfg_ThemeDefault" class="configrule">$cfg['ThemeDefault']</a>.<br />
3038 <br />
3039 Under <a href="#cfg_ThemePath" class="configrule">$cfg['ThemePath']</a>, you
3040 should not delete the directory &quot;original&quot; or its underlying
3041 structure, because this is the system theme used by phpMyAdmin.
3042 &quot;original&quot; contains all images and styles, for backwards
3043 compatibility and for all themes that would not include images or css-files.
3044 <br /><br />
3046 If <a href="#cfg_ThemeManager" class="configrule">$cfg['ThemeManager']</a>
3047 is enabled, you can select your favorite theme on the main page. Your
3048 selected theme will be stored in a cookie.<br /><br /></p>
3050 <p> To create a theme:</p>
3052 <ul><li>make a new subdirectory (for example &quot;your_theme_name&quot;) under
3053 <a href="#cfg_ThemePath" class="configrule">$cfg['ThemePath']</a>
3054 (by default <tt>themes</tt>)</li>
3055 <li>copy the files and directories from &quot;original&quot; to
3056 &quot;your_theme_name&quot;</li>
3057 <li>edit the css-files in &quot;your_theme_name/css&quot;</li>
3058 <li>put your new images in &quot;your_theme_name/img&quot;</li>
3059 <li>edit <tt>layout.inc.php</tt> in &quot;your_theme_name&quot;</li>
3060 <li>edit <tt>info.inc.php</tt> in &quot;your_theme_name&quot; to
3061 contain your chosen theme name, that will be visible in user interface</li>
3062 <li>make a new screenshot of your theme and save it under
3063 &quot;your_theme_name/screen.png&quot;</li>
3064 </ul>
3066 <p> In theme directory there is file <tt>info.inc.php</tt> which contains
3067 theme verbose name, theme generation and theme version. These versions and
3068 generations are enumerated from 1 and do not have any direct dependence on
3069 phpMyAdmin version. Themes within same generation should be backwards
3070 compatible - theme with version 2 should work in phpMyAdmin requiring
3071 version 1. Themes with different generation are incompatible.</p>
3073 <p> If you do not want to use your own symbols and buttons, remove the
3074 directory &quot;img&quot; in &quot;your_theme_name&quot;. phpMyAdmin will
3075 use the default icons and buttons (from the system-theme &quot;original&quot;).
3076 </p>
3078 <h4 id="faqmissingparameters">
3079 <a href="#faqmissingparameters">2.8 I get &quot;Missing parameters&quot; errors,
3080 what can I do?</a></h4>
3082 <p> Here are a few points to check:</p>
3084 <ul><li>In <tt>config.inc.php</tt>, try to leave the
3085 <a href="#cfg_PmaAbsoluteUri" class="configrule">$cfg['PmaAbsoluteUri']</a>
3086 directive empty. See also
3087 <a href="#faq4_7"><abbr title="Frequently Asked Questions">FAQ</abbr> 4.7</a>.
3088 </li>
3089 <li>Maybe you have a broken PHP installation or you need to upgrade
3090 your Zend Optimizer. See
3091 <a href="http://bugs.php.net/bug.php?id=31134">
3092 http://bugs.php.net/bug.php?id=31134</a>.
3093 </li>
3094 <li>If you are using Hardened PHP with the ini directive <tt>varfilter.max_request_variables</tt>
3095 set to the default (200) or another low value, you could get this
3096 error if your table has a high number of columns. Adjust this setting
3097 accordingly. (Thanks to Klaus Dorninger for the hint).
3098 </li>
3099 <li>In the <tt>php.ini</tt> directive <tt>arg_separator.input</tt>, a value
3100 of &quot;;&quot; will cause this error. Replace it with &quot;&amp;;&quot;.
3101 </li>
3102 <li>If you are using <a href="http://www.hardened-php.net/">Hardened-PHP</a>,
3103 you might want to increase
3104 <a href="http://www.hardened-php.net/hphp/troubleshooting.html">request limits</a>.
3105 </li>
3106 <li>The directory specified in the <tt>php.ini</tt> directive <tt>session.save_path</tt> does not exist or is read-only.
3107 </li>
3108 </ul>
3110 <h3 id="faqlimitations">Known limitations</h3>
3112 <h4 id="login_bug">
3113 <a href="#login_bug">3.1 When using
3114 <abbr title="HyperText Transfer Protocol">HTTP</abbr> authentication, an user
3115 who logged out can not log in again in with the same nick.</a></h4>
3117 <p> This is related to the authentication mechanism (protocol) used by
3118 phpMyAdmin. To bypass this problem: just close all the opened
3119 browser windows and then go back to phpMyAdmin. You should be able to
3120 log in again.</p>
3122 <h4 id="faq3_2">
3123 <a href="#faq3_2">3.2 When dumping a large table in compressed mode, I get a memory
3124 limit error or a time limit error.</a></h4>
3126 <p> Compressed dumps are built in memory and because of this are limited to
3127 php's memory limit. For GZip/BZip2 exports this can be overcome since 2.5.4
3128 using
3129 <a href="#cfg_CompressOnFly" class="configrule">$cfg['CompressOnFly']</a>
3130 (enabled by default). Zip exports can not be handled this way, so if you need
3131 Zip files for larger dump, you have to use another way.</p>
3133 <h4 id="faq3_3">
3134 <a href="#faq3_3">3.3 With InnoDB tables, I lose foreign key relationships when I rename
3135 or alter a table.</a></h4>
3137 <p> This seems to be a InnoDB bug (fixed in MySQL 3.23.50?).</p>
3139 <h4 id="faq3_4">
3140 <a href="#faq3_4">3.4 I am unable to import dumps I created with the mysqldump tool
3141 bundled with the MySQL server distribution.</a></h4>
3143 <p> The problem is that older versions of mysqldump created invalid comments like this:</p>
3145 <pre>
3146 -- MySQL dump 8.22
3148 -- Host: localhost Database: database
3149 ---------------------------------------------------------
3150 -- Server version 3.23.54
3151 </pre>
3153 <p> The invalid part of the code is the horizontal line made of dashes that
3154 appears once in every dump created with mysqldump. If you want to run your
3155 dump you have to turn it into valid MySQL. This means, you have to add a
3156 whitespace after the first two dashes of the line or add a # before it:
3157 <br />
3158 <code>
3159 -- -------------------------------------------------------<br />
3160 </code>
3161 or<br />
3162 <code>
3163 #---------------------------------------------------------
3164 </code>
3165 </p>
3167 <h4 id="faq3_5">
3168 <a href="#faq3_5">3.5 When using nested folders there are some multiple hierarchies
3169 displayed in a wrong manner?!</a> (<a href="#cfg_LeftFrameTableSeparator"
3170 class="configrule">$cfg['LeftFrameTableSeparator']</a>)</h4>
3172 <p> Please note that you should not use the separating string multiple times
3173 without any characters between them, or at the beginning/end of your table
3174 name. If you have to, think about using another TableSeparator or disabling
3175 that feature</p>
3177 <h4 id="faq3_6">
3178 <a href="#faq3_6">3.6 What is currently not supported in phpMyAdmin about InnoDB?</a></h4>
3180 <p> In Relation view, being able to choose a table in another database,
3181 or having more than one index field in the foreign key.<br /><br/>
3182 In Query-by-example (Query), automatic generation of the query
3183 LEFT JOIN from the foreign table.<br /><br/>
3184 </p>
3186 <h4 id="faq3_7">
3187 <a href="#faq3_7">3.7 I have table with many (100+) fields and when I try to browse table
3188 I get series of errors like &quot;Warning: unable to parse url&quot;. How
3189 can this be fixed?</a></h4>
3191 Your table neither have a primary key nor an unique one, so we must use a
3192 long expression to identify this row. This causes problems to parse_url
3193 function. The workaround is to create a primary or unique key.
3194 <br />
3195 </p>
3197 <h4 id="faq3_8">
3198 <a href="#faq3_8">3.8 I cannot use (clickable) HTML-forms in fields where I put
3199 a MIME-Transformation onto!</a></h4>
3201 <p> Due to a surrounding form-container (for multi-row delete checkboxes), no
3202 nested forms can be put inside the table where phpMyAdmin displays the results.
3203 You can, however, use any form inside of a table if keep the parent
3204 form-container with the target to tbl_row_delete.php and just put your own
3205 input-elements inside. If you use a custom submit input field, the form will
3206 submit itself to the displaying page again, where you can validate the
3207 $HTTP_POST_VARS in a transformation.
3209 For a tutorial on how to effectively use transformations, see our
3210 <a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a>
3211 on the official phpMyAdmin-homepage.</p>
3213 <h4 id="faq3_9">
3214 <a href="#faq3_9">3.9 I get error messages when using "--sql_mode=ANSI" for the
3215 MySQL server</a></h4>
3217 <p> When MySQL is running in ANSI-compatibility mode, there are some major
3218 differences in how <abbr title="structured query language">SQL</abbr> is
3219 structured (see <a href="http://dev.mysql.com/doc/mysql/en/ANSI_mode.html">
3220 http://dev.mysql.com/doc/mysql/en/ANSI_mode.html</a>). Most important of all,
3221 the quote-character (") is interpreted as an identifier quote character and
3222 not as a string quote character, which makes many internal phpMyAdmin
3223 operations into invalid <abbr title="structured query language">SQL</abbr>
3224 statements. There is no workaround to this behaviour. News to this item will
3225 be posted in Bug report
3226 <a href="https://sf.net/tracker/index.php?func=detail&amp;aid=816858&amp;group_id=23067&amp;atid=377408">#816858</a>
3227 </p>
3229 <h4 id="faq3_10">
3230 <a href="#faq3_10">3.10 Homonyms and no primary key: When the results of a SELECT display
3231 more that one column with the same value
3232 (for example <tt>SELECT lastname from employees where firstname like 'A%'</tt> and two &quot;Smith&quot; values are displayed),
3233 if I click Edit I cannot be sure that I am editing the intended row.</a></h4>
3235 <p> Please make sure that your table has a primary key, so that phpMyAdmin
3236 can use it for the Edit and Delete links.</p>
3238 <h4 id="faq3_11">
3239 <a href="#faq3_11">3.11 The number of records for InnoDB tables is not correct.</a></h4>
3241 <p> phpMyAdmin uses a quick method to get the row count, and this method
3242 only returns an approximate count in the case of InnoDB tables. See
3243 <a href="#cfg_MaxExactCount" class="configrule">$cfg['MaxExactCount']</a> for
3244 a way to modify those results, but
3245 this could have a serious impact on performance.</p>
3247 <h4 id="faq3_12">
3248 <a href="#faq3_12">3.12 What are the phpMyAdmin limitations for MySQL 3?</a></h4>
3250 <p> The number of records in queries containing COUNT and GROUP BY is
3251 not correctly calculated. Also, sorting results of a query like
3252 &quot;SELECT * from table GROUP BY&quot; ... is problematic.</p>
3254 <h4 id="faq3_13">
3255 <a href="#faq3_13">3.13 I get an error when entering <tt>USE</tt> followed by a db name
3256 containing an hyphen.
3257 </a></h4>
3259 The tests I have made with current MySQL 4.1.11 API shows that the
3260 API does not accept this syntax for the USE command. Enclosing the
3261 db name with backquotes works. For further confusion, no backquotes
3262 are needed with command-line mysql.
3263 </p>
3265 <h4 id="faq3_14">
3266 <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>
3268 This has been a known limitation of phpMyAdmin since the beginning and
3269 it's not likely to be solved in the future.
3270 </p>
3272 <h3 id="faqmultiuser"><abbr title="Internet service provider">ISP</abbr>s, multi-user installations</h3>
3274 <h4 id="faq4_1">
3275 <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
3276 need to install it for each customer.
3277 </a></h4>
3279 Since version 2.0.3, you can setup a central copy of phpMyAdmin for all
3280 your users. The development of this feature was kindly sponsored by
3281 NetCologne GmbH.
3282 This requires a properly setup MySQL user management and phpMyAdmin
3283 <abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie authentication. See the install section on
3284 &quot;Using <abbr title="HyperText Transfer Protocol">HTTP</abbr> authentication&quot;.
3285 </p>
3287 <h4 id="faq4_2">
3288 <a href="#faq4_2">4.2 What's the preferred way of making phpMyAdmin secure against evil
3289 access.
3290 </a></h4>
3292 This depends on your system.<br />
3293 If you're running a server which cannot be accessed by other people, it's
3294 sufficient to use the directory protection bundled with your webserver
3295 (with Apache you can use <i>.htaccess</i> files, for example).<br />
3296 If other people have telnet access to your server, you should use
3297 phpMyAdmin's <abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie authentication features.
3298 <br /><br />
3299 Suggestions:
3300 </p>
3301 <ul>
3302 <li>
3303 Your <i>config.inc.php</i> file should be <tt>chmod 660</tt>.
3304 </li>
3305 <li>
3306 All your phpMyAdmin files should be chown -R phpmy.apache, where phpmy
3307 is a user whose password is only known to you, and apache is the
3308 group under which Apache runs.
3309 </li>
3310 <li>
3311 You should use PHP safe mode, to protect from other users that try
3312 to include your <i>config.inc.php</i> in their scripts.
3313 </li>
3314 </ul>
3316 <h4 id="faq4_3">
3317 <a href="#faq4_3">4.3 I get errors about not being able to include a file in
3318 <i>/lang</i> or in <i>/libraries</i>.
3319 </a></h4>
3321 Check <i>php.ini</i>, or ask your sysadmin to check it. The
3322 <tt>include_path</tt> must contain &quot;.&quot; somewhere in it, and
3323 <tt>open_basedir</tt>, if used, must contain &quot;.&quot; and
3324 &quot;./lang&quot; to allow normal operation of phpMyAdmin.
3325 </p>
3327 <h4 id="faq4_4">
3328 <a href="#faq4_4">4.4 phpMyAdmin always gives &quot;Access denied&quot; when using <abbr title="HyperText Transfer Protocol">HTTP</abbr>
3329 authentication.
3330 </a></h4>
3332 <p> This could happen for several reasons:</p>
3334 <ul><li><a href="#cfg_Servers_controluser" class="configrule">$cfg['Servers'][$i]['controluser']</a>
3335 and/or
3336 <a href="#cfg_Servers_controlpass" class="configrule">$cfg['Servers'][$i]['controlpass']</a>
3337 are wrong.</li>
3338 <li>The username/password you specify in the login dialog are invalid.</li>
3339 <li>You have already setup a security mechanism for the
3340 phpMyAdmin-directory, eg. a .htaccess file. This would interfere with
3341 phpMyAdmin's authentication, so remove it.</li>
3342 </ul>
3344 <h4 id="faq4_5">
3345 <a href="#faq4_5">4.5 Is it possible to let users create their own databases?</a></h4>
3347 <p> Starting with 2.2.5, in the user management page, you can enter a wildcard
3348 database name for a user (for example &quot;joe%&quot;),
3349 and put the privileges you want. For example,
3350 adding <tt>SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER</tt>
3351 would let a user create/manage his/her database(s).</p>
3353 <h4 id="faq4_6">
3354 <a href="#faq4_6">4.6 How can I use the Host-based authentication additions?</a></h4>
3356 <p> If you have existing rules from an old .htaccess file, you can take them
3357 and add a username between the <tt>'deny'</tt>/<tt>'allow'</tt> and
3358 <tt>'from'</tt> strings. Using the username wildcard of <tt>'%'</tt> would
3359 be a major benefit here if your installation is suited to using it. Then
3360 you can just add those updated lines into the
3361 <a href="#cfg_Servers_AllowDeny_rules" class="configrule">
3362 $cfg['Servers'][$i]['AllowDeny']['rules']</a> array.</p>
3364 <p> If you want a pre-made sample, you can try this fragment. It stops the
3365 'root' user from logging in from any networks other than the private
3366 network <abbr title="Internet Protocol">IP</abbr> blocks.</p>
3368 <pre>
3369 //block root from logging in except from the private networks
3370 $cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';
3371 $cfg['Servers'][$i]['AllowDeny']['rules'] = array(
3372 'deny root from all',
3373 'allow root from localhost',
3374 'allow root from 10.0.0.0/8',
3375 'allow root from 192.168.0.0/16',
3376 'allow root from 172.16.0.0/12',
3378 </pre>
3380 <h4 id="faq4_7">
3381 <a href="#faq4_7">4.7 Authentication window is displayed more than once, why?</a></h4>
3383 <p> This happens if you are using a <abbr title="Uniform Resource Locator">URL</abbr> to start phpMyAdmin which is
3384 different than the one set in your
3385 <a href="#cfg_PmaAbsoluteUri" class="configrule">$cfg['PmaAbsoluteUri']</a>.
3386 For example, a missing &quot;www&quot;, or entering with an <abbr title="Internet Protocol">IP</abbr> address
3387 while a domain name is defined in the config file.</p>
3389 <h4 id="faq4_8">
3390 <a href="#faq4_8">4.8 Which parameters can I use in the URL that starts phpMyAdmin?</a></h4>
3392 <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>
3394 <h3 id="faqbrowsers">Browsers or client <abbr title="operating system">OS</abbr></h3>
3396 <h4 id="faq5_1">
3397 <a href="#faq5_1">5.1 I get an out of memory error, and my controls are non-functional,
3398 when trying to create a table with more than 14 fields.
3399 </a></h4>
3401 We could reproduce this problem only under Win98/98SE. Testing under
3402 WinNT4 or Win2K, we could easily create more than 60 fields.
3403 <br />
3404 A workaround is to create a smaller number of fields, then come back to
3405 your table properties and add the other fields.
3406 </p>
3408 <h4 id="faq5_2">
3409 <a href="#faq5_2">5.2 With Xitami 2.5b4, phpMyAdmin won't process form fields.</a></h4>
3411 This is not a phpMyAdmin problem but a Xitami known bug: you'll face it
3412 with each script/website that use forms.<br />
3413 Upgrade or downgrade your Xitami server.
3414 </p>
3416 <h4 id="faq5_3">
3417 <a href="#faq5_3">5.3 I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).</a></h4>
3419 With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except that
3420 the proposed file name for the dump is always 'tbl_dump.php'. Bzip2 dumps
3421 don't seem to work.<br />
3423 With Konqueror 2.2.1: plain dumps work; zip dumps are placed into
3424 the user's temporary directory, so they must be moved before closing
3425 Konqueror, or else they disappear. GZip dumps give an error message.<br />
3427 Testing needs to be done for Konqueror 2.2.2.<br />
3428 </p>
3430 <h4 id="faq5_4">
3431 <a href="#faq5_4">5.4 I can't use the cookie authentication mode because Internet
3432 Explorer never stores the cookies.
3433 </a></h4>
3435 MS Internet Explorer seems to be really buggy about cookies, at least till
3436 version 6. And thanks to Andrew Zivolup we've traced also a PHP 4.1.1 bug
3437 in this area!
3438 <br />
3439 Then, if you're running PHP 4.1.1, try to upgrade or downgrade... it may
3440 work!
3441 </p>
3443 <h4 id="faq5_5">
3444 <a href="#faq5_5">5.5 In Internet Explorer 5.0, I get JavaScript errors when browsing my
3445 rows.
3446 </a></h4>
3448 Upgrade to at least Internet Explorer 5.5 SP2.<br />
3449 </p>
3451 <h4 id="faq5_6">
3452 <a href="#faq5_6">5.6 In Internet Explorer 5.0, 5.5 or 6.0, I get an error (like "Page not found")
3453 when trying to modify a row in a table with many fields, or with a text field
3454 </a></h4>
3456 Your table neither have a primary key nor an unique one, so we must use a
3457 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
3458 those browsers, and this not happen in Netscape, for example. The
3459 workaround is to create a primary or unique key, or use another browser.
3460 <br />
3461 </p>
3463 <h4 id="faq5_7">
3464 <a href="#faq5_7">5.7 I refresh (reload) my browser, and come back to the welcome
3465 page.
3466 </a></h4>
3468 Some browsers support right-clicking into the frame you want to refresh,
3469 just do this in the right frame.<br />
3470 </p>
3472 <h4 id="faq5_8">
3473 <a href="#faq5_8">5.8 With Mozilla 0.9.7 I have problems sending a query modified in the
3474 query box.
3475 </a></h4>
3477 Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
3478 Mozilla versions.<br />
3479 </p>
3481 <h4 id="faq5_9">
3482 <a href="#faq5_9">5.9 With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
3483 whitespace in the <abbr title="structured query language">SQL</abbr>-Query edit area: the page scrolls down.
3484 </a></h4>
3486 This is a Mozilla bug (see bug #26882 at
3487 <a href="http://bugzilla.mozilla.org/">BugZilla</a>).<br />
3488 </p>
3490 <h4 id="faq5_10">
3491 <a href="#faq5_10">5.10 With Netscape 4.75 I get empty rows between each row of data in a
3492 <abbr title="comma separated values">CSV</abbr> exported file.
3493 </a></h4>
3495 This is a known Netscape 4.75 bug: it adds some line feeds when exporting
3496 data in octet-stream mode. Since we can't detect the specific Netscape
3497 version, we cannot workaround this bug.
3498 </p>
3500 <h4 id="faq5_11">
3501 <a href="#faq5_11">5.11 Extended-ASCII characters like German umlauts are displayed
3502 wrong.</a></h4>
3504 <p> Please ensure that you have set your browser's character set to the one of the
3505 language file you have selected on phpMyAdmin's start page.
3506 Alternatively, you can try the auto detection mode that is supported by the
3507 recent versions of the most browsers.</p>
3509 <h4 id="faq5_12">
3510 <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
3511 &quot;?&quot;.</a></h4>
3513 <p> This issue has been reported by a <abbr title="operating system">OS</abbr> X user, who adds that Chimera,
3514 Netscape and Mozilla do not have this problem.</p>
3516 <h4 id="faq5_13">
3517 <a href="#faq5_13">5.13 With Internet Explorer 5.5 or 6, and <abbr title="HyperText Transfer Protocol">HTTP</abbr> authentication type,
3518 I cannot manage two servers: I log in to the first one, then the other one,
3519 but if I switch back to the first, I have to log in on each operation.</a></h4>
3521 <p> This is a bug in Internet Explorer, other browsers do not behave this way.</p>
3523 <h4 id="faq5_14">
3524 <a href="#faq5_14">5.14 Using Opera6, I can manage to get to the authentication,
3525 but nothing happens after that, only a blank screen.</a></h4>
3527 <p> Having <tt>$cfg['QueryFrameJS']</tt> set o <tt>TRUE</tt>, this leads to a
3528 bug in Opera6, because it is not able to interpret frameset definitions
3529 written by JavaScript. Please upgrade your phpMyAdmin installtion or to
3530 Opera7 at least.</p>
3532 <h4 id="faq5_15">
3533 <a href="#faq5_15">5.15 I have display problems with Safari.</a></h4>
3535 <p> Please upgrade to at least version 1.2.3.</p>
3537 <h4 id="faq5_16">
3538 <a href="#faq5_16">5.16 With Internet Explorer, I get &quot;Access is denied&quot;
3539 Javascript errors. Or I cannot make phpMyAdmin work under Windows.</a></h4>
3541 <p> Please check the following points:</p>
3542 <ul><li>Maybe you have defined your <tt>PmaAbsoluteUri</tt> setting
3543 in <tt>config.inc.php</tt> to an <abbr title="Internet Protocol">IP</abbr>
3544 address and you are starting
3545 phpMyAdmin with a <abbr title="Uniform Resource Locator">URL</abbr>
3546 containing a domain name, or the reverse situation.</li>
3547 <li>Security settings in IE and/or Microsoft Security Center are
3548 too high, thus blocking scripts execution.</li>
3549 <li>The Windows Firewall is blocking Apache and MySQL. You must
3550 allow <abbr title="HyperText Transfer Protocol">HTTP</abbr> ports
3551 (80 or 443) and MySQL port (usually 3306)
3552 in the &quot;in&quot; and &quot;out&quot; directions.</li>
3553 </ul>
3555 <h4 id="faq5_17">
3556 <a href="#faq5_17">5.17 With Firefox, I cannot delete rows of data or drop a database.</a></h4>
3557 <p> Many users have confirmed that the Tabbrowser Extensions plugin they
3558 installed in their Firefox is causing the problem.</p>
3560 <h3 id="faqusing">Using phpMyAdmin</h3>
3562 <h4 id="faq6_1">
3563 <a href="#faq6_1">6.1 I can't insert new rows into a table / I can't create a table
3564 - MySQL brings up a <abbr title="structured query language">SQL</abbr>-error.
3565 </a></h4>
3567 Examine the <abbr title="structured query language">SQL</abbr> error with care. Often the problem is caused by
3568 specifying a wrong field-type.<br />
3569 Common errors include:
3570 </p>
3571 <ul>
3572 <li>Using <tt>VARCHAR</tt> without a size argument</li>
3573 <li>Using <tt>TEXT</tt> or <tt>BLOB</tt> with a size argument</li>
3574 </ul>
3576 Also, look at the syntax chapter in the MySQL manual to confirm that your
3577 syntax is correct.
3578 </p>
3580 <h4 id="faq6_2">
3581 <a href="#faq6_2">6.2 When I create a table, I set an index for two fields and
3582 phpMyAdmin generates only one index with those two fields.
3583 </a></h4>
3585 This is the way to create a multi-fields
3586 index. If you want two indexes, create the first one when creating the
3587 table, save, then display the table properties and click the Index link to
3588 create the other index.
3589 </p>
3591 <h4 id="faq6_3">
3592 <a href="#faq6_3">6.3 How can I insert a null value into my table?</a></h4>
3594 Since version 2.2.3, you have a checkbox for each field that can be null.
3595 Before 2.2.3, you had to enter &quot;null&quot;, without the quotes, as the
3596 field's value. Since version 2.5.5, you have to use the checkbox to get
3597 a real NULL value, so if you enter &quot;NULL&quot; this means you want
3598 a literal NULL in the field, and not a NULL value (this works in PHP4).
3599 </p>
3601 <h4 id="faq6_4">
3602 <a href="#faq6_4">6.4 How can I backup my database or table?</a></h4>
3604 <p> Click on a database or table name in the left frame, the properties will be
3605 displayed. Then on the menu, click &quot;Export&quot;, you can dump
3606 the structure, the data, or both. This will generate standard <abbr title="structured query language">SQL</abbr>
3607 statements that can be used to recreate your database/table.
3608 <br /><br />
3609 You will need to choose &quot;Save as file&quot;, so that phpMyAdmin can
3610 transmit the resulting dump to your station. Depending on your PHP
3611 configuration, you will see options to compress the dump. See also the
3612 <a href="#cfg_ExecTimeLimit" class="configrule">$cfg['ExecTimeLimit']</a>
3613 configuration variable.<br /><br />
3615 For additional help on this subject, look for the word &quot;dump&quot; in
3616 this document.</p>
3618 <h4 id="faq6_5">
3619 <a href="#faq6_5">6.5 How can I restore (upload) my database or table using a dump?
3620 How can I run a &quot;.sql&quot; file?
3621 </a></h4>
3623 <p> Click on a database name in the left frame, the properties will be
3624 displayed. Select &quot;Import&quot; from the list
3625 of tabs in the right&#8211;hand frame (or &quot;<abbr title="structured query language">SQL</abbr>&quot; if your phpMyAdmin
3626 version is previous to 2.7.0). In the &quot;Location of the text file&quot; section, type in
3627 the path to your dump filename, or use the Browse button. Then click Go.
3628 <br /><br />
3629 With version 2.7.0, the import engine has been re&#8211;written, if possible it is suggested
3630 that you upgrade to take advantage of the new features.
3631 <br /><br />
3632 For additional help on this subject, look for the word &quot;upload&quot;
3633 in this document.
3634 </p>
3636 <h4 id="faq6_6">
3637 <a href="#faq6_6">6.6 How can I use the relation table in Query-by-example?</a></h4>
3639 <p> Here is an example with the tables persons, towns and countries, all
3640 located in the database mydb. If you don't have a <tt>pma_relation</tt>
3641 table, create it as explained in the configuration section. Then create the
3642 example tables:</p>
3644 <pre>
3645 CREATE TABLE REL_countries (
3646 country_code char(1) NOT NULL default '',
3647 description varchar(10) NOT NULL default '',
3648 PRIMARY KEY (country_code)
3649 ) TYPE=MyISAM;
3651 INSERT INTO REL_countries VALUES ('C', 'Canada');
3653 CREATE TABLE REL_persons (
3654 id tinyint(4) NOT NULL auto_increment,
3655 person_name varchar(32) NOT NULL default '',
3656 town_code varchar(5) default '0',
3657 country_code char(1) NOT NULL default '',
3658 PRIMARY KEY (id)
3659 ) TYPE=MyISAM;
3661 INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');
3662 INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');
3664 CREATE TABLE REL_towns (
3665 town_code varchar(5) NOT NULL default '0',
3666 description varchar(30) NOT NULL default '',
3667 PRIMARY KEY (town_code)
3668 ) TYPE=MyISAM;
3670 INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');
3671 INSERT INTO REL_towns VALUES ('M', 'Montr&eacute;al');
3672 </pre>
3674 <p> To setup appropriate links and display information:</p>
3676 <ul><li>on table &quot;REL_persons&quot; click Structure, then Relation view</li>
3677 <li>in Links, for &quot;town_code&quot; choose &quot;REL_towns-&gt;code&quot;</li>
3678 <li>in Links, for &quot;country_code&quot; choose &quot;REL_countries-&gt;country_code&quot;</li>
3679 <li>on table &quot;REL_towns&quot; click Structure, then Relation view</li>
3680 <li>in &quot;Choose field to display&quot;, choose &quot;description&quot;</li>
3681 <li>repeat the two previous steps for table &quot;REL_countries&quot;</li>
3682 </ul>
3684 <p> Then test like this:</p>
3686 <ul><li>Click on your db name in the left frame</li>
3687 <li>Choose &quot;Query&quot;</li>
3688 <li>Use tables: persons, towns, countries</li>
3689 <li>Click &quot;Update query&quot;</li>
3690 <li>In the fields row, choose persons.person_name and click the
3691 &quot;Show&quot; tickbox </li>
3692 <li>Do the same for towns.description and countries.descriptions in the
3693 other 2 columns</li>
3694 <li>Click &quot;Update query&quot; and you will see in the query box that
3695 the correct joins have been generated</li>
3696 <li>Click &quot;Submit query&quot;</li>
3697 </ul>
3699 <h4 id="faqdisplay">
3700 <a href="#faqdisplay">6.7 How can I use the &quot;display field&quot; feature?</a></h4>
3702 Starting from the previous example, create the pma_table_info as explained
3703 in the configuration section, then browse your persons table,
3704 and move the mouse over a town code or country code.
3705 <br /><br />
3706 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;
3707 enables: drop-down list of possible values.
3708 </p>
3710 <h4 id="faqpdf">
3711 <a href="#faqpdf">6.8 How can I produce a <abbr title="Portable Document Format">PDF</abbr> schema of my database?</a></h4>
3713 First the configuration variables &quot;relation&quot;,
3714 &quot;table_coords&quot; and &quot;pdf_pages&quot; have to be filled in.
3715 <br /><br />
3716 Then you need to think about your schema layout. Which tables will go on
3717 which pages?
3718 </p>
3719 <ul>
3720 <li>Select your database in the left frame.</li>
3721 <li>Choose &quot;Operations&quot; in the navigation bar at the top.</li>
3722 <li>Choose &quot;Edit <abbr title="Portable Document Format">PDF</abbr>
3723 Pages&quot; near the bottom of the page.</li>
3724 <li>Enter a name for the first <abbr title="Portable Document Format">PDF</abbr>
3725 page and click Go. If you like, you
3726 can use the &quot;automatic layout,&quot; which will put all your
3727 linked tables onto the new page.</li>
3728 <li>Select the name of the new page (making sure the Edit radio button
3729 is selected) and click Go.</li>
3730 <li>Select a table from the list, enter its coordinates and click Save.<br />
3731 Coordinates are relative; your diagram will
3732 be automatically scaled to fit the page. When initially placing tables
3733 on the page, just pick any coordinates -- say, 50x50. After clicking
3734 Save, you can then use the <a href="#wysiwyg">graphical editor</a> to
3735 position the element correctly.</li>
3736 <li>When you'd like to look at your <abbr title="Portable Document Format">PDF</abbr>,
3737 first be sure to click the Save
3738 button beneath the list of tables and coordinates, to save any changes
3739 you made there. Then scroll all the way down, select the
3740 <abbr title="Portable Document Format">PDF</abbr> options
3741 you want, and click Go.</li>
3742 <li>Internet Explorer for Windows may suggest an incorrect filename when
3743 you try to save a generated <abbr title="Portable Document Format">PDF</abbr>.
3744 When saving a generated <abbr title="Portable Document Format">PDF</abbr>, be
3745 sure that the filename ends in &quot;.pdf&quot;, for example
3746 &quot;schema.pdf&quot;. Browsers on other operating systems, and other
3747 browsers on Windows, do not have this problem.</li>
3748 </ul>
3750 <h4 id="faq6_9">
3751 <a href="#faq6_9">6.9 phpMyAdmin is changing the type of one of my
3752 columns!</a></h4>
3754 <p> No, it's MySQL that is doing
3755 <a href="http://www.mysql.com/doc/S/i/Silent_column_changes.html">silent
3756 column type changing</a>.</p>
3758 <h4 id="underscore">
3759 <a href="#underscore">6.10 When creating a privilege, what happens with
3760 underscores in the database name?</a></h4>
3762 <p> If you do not put a backslash before the underscore, this is a wildcard
3763 grant, and the underscore means &quot;any character&quot;. So, if the
3764 database name is &quot;john_db&quot;, the user would get rights to john1db,
3765 john2db ...<br /><br />
3767 If you put a backslash before the underscore, it means that the database
3768 name will have a real underscore.</p>
3770 <h4 id="faq6_11">
3771 <a href="#faq6_11">6.11 What is the curious symbol &oslash; in the
3772 statistics pages?</a></h4>
3774 <p> It means &quot;average&quot;.</p>
3776 <h4 id="faqexport">
3777 <a href="#faqexport">6.12 I want to understand some Export options.</a></h4>
3779 <p><b>Structure:</b></p>
3781 <ul><li>&quot;Add DROP TABLE&quot; will add a line telling MySQL to
3782 <a href="http://dev.mysql.com/doc/mysql/en/drop-table.html">drop the table</a>,
3783 if it already exists during the import. It does NOT drop the table after
3784 your export, it only affects the import file.</li>
3785 <li>&quot;If Not Exists&quot; will only create the table if it doesn't exist.
3786 Otherwise, you may get an error if the table name exists but has a
3787 different structure.</li>
3788 <li>&quot;Add AUTO_INCREMENT value&quot; ensures that AUTO_INCREMENT value
3789 (if any) will be included in backup.</li>
3790 <li>&quot;Enclose table and field names with backquotes&quot; ensures that
3791 field and table names formed with special characters are protected.</li>
3792 <li>&quot;Add into comments&quot; includes column comments, relations, and MIME
3793 types set in the pmadb in the dump as
3794 <abbr title="structured query language">SQL</abbr> comments (<i>/* xxx */</i>).
3795 </li>
3796 </ul>
3798 <p><b>Data:</b></p>
3800 <ul><li>&quot;Complete inserts&quot; adds the column names on every INSERT
3801 command, for better documentation (but resulting file is bigger).</li>
3802 <li>&quot;Extended inserts&quot; provides a shorter dump file by using only
3803 once the INSERT verb and the table name.</li>
3804 <li>&quot;Delayed inserts&quot; are best explained in the
3805 <a href="http://dev.mysql.com/doc/mysql/en/insert-delayed.html">MySQL manual</a>.
3806 </li>
3807 <li>&quot;Ignore inserts&quot; treats errors as a warning instead. Again,
3808 more info is provided in the
3809 <a href="http://dev.mysql.com/doc/mysql/en/insert.html">MySQL manual</a>,
3810 but basically with this selected, invalid values are adjusted and
3811 inserted rather than causing the entire statement to fail.</li>
3812 </ul>
3814 <h4 id="faq6_13">
3815 <a href="#faq6_13">6.13 I would like to create a database with a dot
3816 in its name.</a></h4>
3818 <p> This is a bad idea, because in MySQL the syntax &quot;database.table&quot;
3819 is the normal way to reference a database and table name. Worse, MySQL
3820 will usually let you create a database with a dot, but then you cannot
3821 work with it, nor delete it.</p>
3823 <h4 id="faqsqlvalidator">
3824 <a href="#faqsqlvalidator">6.14 How do I set up the
3825 <abbr title="structured query language">SQL</abbr> Validator?</a></h4>
3827 <p> To use it, you need a very recent version of PHP, 4.3.0 recommended, with
3828 <abbr title="Extensible Markup Language">XML</abbr>,
3829 <abbr title="Perl Compatible Regular Expressions">PCRE</abbr> and
3830 <abbr title="PHP Extension and Application Repository">PEAR</abbr> support.
3831 On your system command line, run <tt>"pear install Net_Socket Net_URL
3832 HTTP_Request Mail_Mime Net_DIME SOAP"</tt> to get the necessary
3833 <abbr title="PHP Extension and Application Repository">PEAR</abbr> modules
3834 for usage.<br />
3835 On a more recent pear version, I had problems with the state of Net_DIME
3836 being beta, so this single command
3837 <tt>"pear -d preferred_state=beta install -a SOAP"</tt> installed all the
3838 needed modules.<br />
3839 If you use the Validator, you should be aware that any
3840 <abbr title="structured query language">SQL</abbr> statement you
3841 submit will be stored anonymously (database/table/column names,
3842 strings, numbers replaced with generic values). The Mimer
3843 <abbr title="structured query language">SQL</abbr>
3844 Validator itself, is &copy; 2001 Upright Database Technology.
3845 We utilize it as free SOAP service.</p>
3847 <h4 id="faq6_15">
3848 <a href="#faq6_15">6.15 I want to add a BLOB field and put an index on
3849 it, but MySQL says &quot;BLOB column '...' used in key specification without
3850 a key length&quot;.</a></h4>
3852 <p> The right way to do this, is to create the field without any indexes,
3853 then display the table structure and use the &quot;Create an index&quot;
3854 dialog. On this page, you will be able to choose your BLOB field, and
3855 set a size to the index, which is the condition to create an index on
3856 a BLOB field.</p>
3858 <h4 id="faq6_16">
3859 <a href="#faq6_16">6.16 How can I simply move in page with plenty
3860 editing fields?</a></h4>
3862 <p> You can use Ctrl+arrows (Option+Arrows in Safari) for moving on most pages
3863 with many editing fields (table structure changes, row editing, etc.)
3864 (must be enabled in configuration - see.
3865 <a href="#CtrlArrowsMoving" class="configrule">$cfg['CtrlArrowsMoving']</a>).
3866 You can also have a look at the directive
3867 <a href="#DefaultPropDisplay" class="configrule">$cfg['DefaultPropDisplay']</a>
3868 ('vertical') and see if this eases up editing for you.</p>
3870 <h4 id="faq6_17">
3871 <a href="#faq6_17">6.17 Transformations: I can't enter my own mimetype!
3872 WTF is this feature then useful for?</a></h4>
3874 <p> Slow down :). Defining mimetypes is of no use, if you can't put transformations
3875 on them. Otherwise you could just put a comment on the field. Because entering
3876 your own mimetype will cause serious syntax checking issues and validation,
3877 this introduces a high-risk false-user-input situation. Instead you have to
3878 initialize mimetypes using functions or empty mimetype definitions.<br />
3879 Plus, you have a whole overview of available mimetypes. Who knows all those
3880 mimetypes by heart so he/she can enter it at will?</p>
3882 <h4 id="faqbookmark">
3883 <a href="#faqbookmark">6.18 Bookmarks: Where can I store bookmarks? Why
3884 can't I see any bookmarks below the query box? What is this variable for?
3885 </a></h4>
3887 <p> Any query you have executed can be stored as a bookmark on the page where the
3888 results are displayed. You will find a button labeled 'Bookmark this query'
3889 just at the end of the page.<br />
3890 As soon as you have stored a bookmark, it is related to the database you run
3891 the query on. You can now access a bookmark dropdown on each page, the query
3892 box appears on for that database.<br /><br />
3894 Since phpMyAdmin 2.5.0 you are also able to store variables for the bookmarks.
3895 Just use the string <b>/*[VARIABLE]*/</b> anywhere in your query. Everything
3896 which is put into the <i>value</i> input box on the query box page will
3897 replace the string &quot;/*[VARIABLE]*/&quot; in your stored query. Just be
3898 aware of that you HAVE to create a valid query, otherwise your query won't be
3899 even able to be stored in the database.<br />
3900 Also remember, that everything else inside the <b>/*[VARIABLE]*/</b> string
3901 for your query will remain the way it is, but will be stripped of the /**/
3902 chars. So you can use:<br /><br />
3904 <code>/*, [VARIABLE] AS myname */</code><br /><br />
3906 which will be expanded to<br /><br />
3908 <code>, VARIABLE as myname</code><br /><br />
3910 in your query, where VARIABLE is the string you entered in the input box. If
3911 an empty string is provided, no replacements are made.<br /><br />
3913 A more complex example. Say you have stored this query:<br /><br />
3914 <code>SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE '%[VARIABLE]%' */</code>
3915 <br /><br />
3917 Say, you now enter &quot;phpMyAdmin&quot; as the variable for the stored query,
3918 the full query will be:<br /><br />
3920 <code>SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE '%phpMyAdmin%'</code>
3921 <br /><br />
3923 You can use multiple occurrences of <b>/*[VARIABLE]*/</b> in a single query.<br />
3924 <b>NOTE THE ABSENCE OF SPACES</b> inside the &quot;/**/&quot; construct. Any
3925 spaces inserted there
3926 will be later also inserted as spaces in your query and may lead to unexpected
3927 results especially when
3928 using the variable expansion inside of a &quot;LIKE ''&quot; expression.<br />
3929 Your initial query which is going to be stored as a bookmark has to yield at
3930 least one result row so
3931 you can store the bookmark. You may have that to work around using well
3932 positioned &quot;/**/&quot; comments.</p>
3934 <h4 id="faq6_19">
3935 <a href="#faq6_19">6.19 How can I create simple L<sup>A</sup>T<sub><big>E</big></sub>X document to
3936 include exported table?</a></h4>
3938 <p> You can simply include table in your L<sup>A</sup>T<sub><big>E</big></sub>X documents, minimal sample
3939 document should look like following one (assuming you have table
3940 exported in file <code>table.tex</code>):</p>
3942 <pre>
3943 \documentclass{article} % or any class you want
3944 \usepackage{longtable} % for displaying table
3945 \begin{document} % start of document
3946 \include{table} % including exported table
3947 \end{document} % end of document
3948 </pre>
3950 <h4 id="faq6_20">
3951 <a href="#faq6_20">6.20 In MySQL 4, I see a lot of databases which are not mine, and cannot
3952 access them.
3953 </a></h4>
3955 <p> Upgrading to MySQL 4 usually gives users those global privileges: CREATE
3956 TEMPORARY TABLES, SHOW DATABASES, LOCK TABLES. Those privileges also
3957 enable users to see all the database names.
3958 See this <a href="http://bugs.mysql.com/179">bug report</a>.<br /><br />
3960 So if your users do not need those privileges, you can remove them and their
3961 databases list will shorten.</p>
3963 <h4 id="faq6_21">
3964 <a href="#faq6_21">6.21 In edit/insert mode, how can I see a list of
3965 possible values for a field, based on some foreign table?</a></h4>
3967 <p> You have to setup appropriate links between the tables, and also
3968 setup the &quot;display field&quot; in the foreign table. See
3969 <a href="#faq6_6"><abbr title="Frequently Asked Questions">FAQ</abbr>
3970 6.6</a> for an example. Then, if there are 100 values or less in the
3971 foreign table, a drop-down list of values will be available.
3972 You will see two lists of values, the first list containing the key
3973 and the display field, the second list containing the display field
3974 and the key. The reason for this is to be able to type the first
3975 letter of either the key or the display field.<br /><br />
3977 For 100 values or more, a distinct window will appear, to browse foreign
3978 key values and choose one. To change the default limit of 100, see
3979 <tt><a href="#cfg_ForeignKeyMaxLimit" class="configrule">$cfg['ForeignKeyMaxLimit']</a></tt>.</p>
3981 <h4 id="faq6_22">
3982 <a href="#faq6_22">6.22 Bookmarks: Can I execute a default bookmark
3983 automatically when entering Browse mode for a table?</a></h4>
3985 <p> Yes. If a bookmark has the same label as a table name, it will be executed.
3986 </p>
3988 <h4 id="faq6_23">
3989 <a href="#faq6_23">6.23 Export: I heard phpMyAdmin can export Microsoft
3990 Excel files, how can I enable that?</a></h4>
3992 <p> Current version does support direct export to Microsoft Excel and Word
3993 versions 2000 and newer. If you need export older versions, you can use
3994 <abbr title="comma separated values">CSV</abbr> suitable for Microsoft Excel,
3995 which works out of the box or you can
3996 try native <b>experimental</b> MS Excel exporter. <b>This export has
3997 several problems, most important are limitation of cell content to 255
3998 chars and no support for charsets, so think carefully whether you want to
3999 enable this.</b>. For enabling this you need to set
4000 <a href="#cfg_TempDir" class="configrule">$cfg['TempDir']</a> to
4001 place where web server user can write (for example <tt>'./tmp'</tt>) and
4002 install <abbr title="PHP Extension and Application Repository">PEAR</abbr>
4003 module Spreadsheet_Excel_Writer into php include path. The
4004 installation can be done by following command:</p>
4006 <pre>
4007 pear -d preferred_state=beta install -a Spreadsheet_Excel_Writer
4008 </pre>
4010 <p> First part of switches set we want to install beta version of that module
4011 (no stable version available yet) and then we tell pear we want to satisfy
4012 dependencies.</p>
4014 <p> If you are running in PHP safe mode, you will have to set
4015 in <tt>php.ini</tt> the <tt>safe_mode_include_dir</tt> to the directory
4016 where your <abbr title="PHP Extension and Application Repository">PEAR</abbr>
4017 modules are located, for example:</p>
4019 <pre>
4020 safe_mode_include_dir = /usr/local/lib/php
4021 </pre>
4023 <p> To create the temporary directory on a UNIX-based system, you can do:</p>
4025 <pre>
4026 cd phpMyAdmin
4027 mkdir tmp
4028 chmod o+rwx tmp
4029 </pre>
4031 <h4 id="faq6_24">
4032 <a href="#faq6_24">6.24 Now that phpMyAdmin supports native MySQL 4.1.x column comments,
4033 what happens to my column comments stored in pmadb?</a></h4>
4035 <p> Automatic migration of a table's pmadb-style column comments to the native
4036 ones is done whenever you enter Structure page for this table.</p>
4038 <h4 id="faq6_25">
4039 <a href="#faq6_25">6.25 How does BLOB streaming work in phpMyAdmin?</a></h4>
4041 <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>
4043 <ol>
4044 <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>
4045 <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>
4046 <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>
4047 <li>Ensure that your target table has a LONGBLOB column.</li>
4048 <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>
4049 <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>
4050 </ol>
4052 <h3 id="faqproject">phpMyAdmin project</h3>
4054 <h4 id="faq7_1">
4055 <a href="#faq7_1">7.1 I have found a bug. How do I inform developers?</a></h4>
4057 <p> Our Bug Tracker is located at
4058 <a href="http://sf.net/projects/phpmyadmin/">http://sf.net/projects/phpmyadmin/</a>
4059 under the Bugs section.<br /><br />
4061 But please first discuss your bug with other users:<br />
4062 <a href="http://sf.net/projects/phpmyadmin/">
4063 http://sf.net/projects/phpmyadmin/</a> (and choose Forums)</p>
4065 <h4 id="faq7_2">
4066 <a href="#faq7_2">7.2 I want to translate the messages to a new language or upgrade an
4067 existing language, where do I start?</a></h4>
4069 <p> Always use the current SVN version of your language file.
4070 For a new language, start from <i>english-utf-8.inc.php</i>. If you
4071 don't know how to get the SVN version, please ask one of the developers.
4072 <br />
4073 Please note that we try not to use HTML entities like &amp;eacute; in
4074 the translations, since we define the right character set in the file.
4075 With HTML entities, the text on JavaScript messages would not
4076 display correctly.
4077 However there are some entities that need to be there, for quotes
4078 ,non-breakable spaces, ampersands, less than, greater than.<br />
4079 You can then put your translations, as a zip file to avoid losing special
4080 characters, on the sourceforge.net translation tracker.<br />
4081 It would be a good idea to subscribe to the phpmyadmin-translators mailing
4082 list, because this is where we ask for translations of new messages.</p>
4084 <h4 id="faq7_3">
4085 <a href="#faq7_3">7.3 I would like to help out with the development of
4086 phpMyAdmin. How should I proceed?</a></h4>
4088 <p> The following method is preferred for new developers:</p>
4090 <ol><li>fetch the current SVN tree over anonymous SVN:<br />
4091 <tt>svn co https://phpmyadmin.svn.sourceforge.net/svnroot/phpmyadmin/trunk/phpMyAdmin</tt><br />
4092 </li>
4093 <li>add your stuff</li>
4094 <li>generate patch with your changes:
4095 <tt>svn diff</tt><br />
4096 </li>
4097 <li>put the patch inside the <a
4098 href="https://sourceforge.net/tracker/?group_id=23067&amp;atid=377410">patch
4099 tracker of the phpMyAdmin project</a>.
4100 </li>
4101 </ol>
4103 <p> Write access to the SVN tree is granted only to experienced developers who
4104 have already contributed something useful to phpMyAdmin.<br />
4105 Also, have a look at the <a href="#developers">Developers section</a>.</p>
4107 <h3 id="faqsecurity">Security</h3>
4109 <h4 id="faq8_1">
4110 <a href="#faq8_1">8.1 Where can I get information about the security alerts issued for phpMyAdmin?</a></h4>
4112 <p> Please refer to
4113 <a href="http://www.phpmyadmin.net/home_page/security.php">http://www.phpmyadmin.net/home_page/security.php</a>
4114 </p>
4116 <!-- DEVELOPERS -->
4117 <h2 id="developers">Developers Information</h2>
4119 <p> phpMyAdmin is Open Source, so you're invited to contribute to it. Many
4120 great features have been written by other people and you too can help to
4121 make phpMyAdmin a useful tool.</p>
4123 <p> If you're planning to contribute source, please read the following
4124 information:</p>
4126 <ul><li>All files include <i>libraries/header.inc.php</i> (layout),.
4127 <i>libraries/common.lib.php</i> (common functions) and
4128 <i>config.inc.php</i>.<br />
4129 Only configuration data should go in <i>config.inc.php</i>. Please keep
4130 it free from other code.<br />
4131 Commonly used functions should be added to
4132 <i>libraries/common.lib.php</i> and more specific ones may be added
4133 within a library stored into the <i>libraries</i> sub-directory.</li>
4134 <li>Obviously, you're free to use whatever coding style you want. But
4135 please try to keep your code as simple as possible: beginners are
4136 using phpMyAdmin as an example application.<br />
4137 As far as possible, we want the scripts to be XHTML1.0 and CSS2
4138 compliant on one hand, they fit the
4139 <a href="http://pear.php.net/">
4140 <abbr title="PHP Extension and Application Repository">PEAR</abbr>
4141 coding standards</a>
4142 on the other hand. Please pay attention to this.</li>
4143 <li>Please try to keep up the file-naming conventions. Table-related stuff
4144 goes to <i>tbl_*.php</i>, db-related code to <i>db_*.php</i>,
4145 server-related tools to <i>server_*.php</i> and so on.</li>
4146 <li>Please don't put message strings in your code, instead add the string
4147 (at least) to <i>english-utf-8.inc.php</i> and print() it out.</li>
4148 <li>If you want to be really helpful, write an entry for the ChangeLog.</li>
4149 <li id="developersdbg">
4150 The DBG extension (<a href="http://dd.cron.ru/dbg/">PHP
4151 Debugger DBG</a>) is now supported by phpMyAdmin for developers to
4152 better debug and profile their code.<br />
4153 Please see the
4154 <a href="#cfg_DBG" class="configrule">$cfg['DBG']*</a> configuration
4155 options for more information.<br />
4156 This is in memoriam of the Space Shuttle Columbia (STS-107) which was
4157 lost during its re-entry into Earth's atmosphere and in memory of the
4158 brave men and women who gave their lives for the people of Earth.</li>
4159 </ul>
4161 <h2 id="copyright">Copyright</h2>
4163 <pre>
4164 Copyright (C) 1998-2000 Tobias Ratschiller &lt;tobias_at_ratschiller.com&gt;
4165 Copyright (C) 2001-2008 Marc Delisle &lt;Marc.Delisle_at_cegepsherbrooke.qc.ca&gt;
4166 Olivier Müller &lt;om_at_omnis.ch&gt;
4167 Robin Johnson &lt;robbat2_at_users.sourceforge.net&gt;
4168 Alexander M. Turek &lt;me_at_derrabus.de&gt;
4169 Michal ÄŒihaÅ™ &lt;michal_at_cihar.com&gt;
4170 Garvin Hicking &lt;me_at_supergarv.de&gt;
4171 Michael Keck &lt;mkkeck_at_users.sourceforge.net&gt;
4172 Sebastian Mendel &lt;cybot_tm_at_users.sourceforge.net&gt;
4173 [check <a href="#credits">credits</a> for more details]
4175 This program is free software; you can redistribute it and/or modify
4176 it under the terms of the GNU General Public License version 2,
4177 as published by the Free Software Foundation.
4179 This program is distributed in the hope that it will be useful,
4180 but WITHOUT ANY WARRANTY; without even the implied warranty of
4181 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4182 GNU General Public License for more details.
4184 You should have received a copy of the GNU General Public License
4185 along with this program; if not, write to the Free Software
4186 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
4187 </pre>
4189 <!-- CREDITS -->
4190 <h2 id="credits">Credits</h2>
4192 <pre>
4193 phpMyAdmin - Credits
4194 ====================
4196 CREDITS, in chronological order
4197 -------------------------------
4199 - Tobias Ratschiller &lt;tobias_at_ratschiller.com&gt;
4200 * creator of the phpmyadmin project
4201 * maintainer from 1998 to summer 2000
4203 - Marc Delisle &lt;Marc.Delisle_at_cegepsherbrooke.qc.ca&gt;
4204 * multi-language version
4205 * various fixes and improvements
4206 * <abbr title="structured query language">SQL</abbr> analyser (most of it)
4207 * current project maintainer
4209 - Olivier M&uuml;ller &lt;om_at_omnis.ch&gt;
4210 * started SourceForge phpMyAdmin project in March 2001
4211 * sync'ed different existing CVS trees with new features and bugfixes
4212 * multi-language improvements, dynamic language selection
4213 * current project maintainer
4214 * many bugfixes and improvements
4216 - Lo&iuml;c Chapeaux &lt;lolo_at_phpheaven.net&gt;
4217 * rewrote and optimized javascript, DHTML and DOM stuff
4218 * rewrote the scripts so they fit the <abbr title="PHP Extension and Application Repository">PEAR</abbr> coding standards and
4219 generate XHTML1.0 and CSS2 compliant codes
4220 * improved the language detection system
4221 * many bugfixes and improvements
4223 - Robin Johnson &lt;robbat2_at_users.sourceforge.net&gt;
4224 * database maintenance controls
4225 * table type code
4226 * Host authentication <abbr title="Internet Protocol">IP</abbr> Allow/Deny
4227 * DB-based configuration (Not completed)
4228 * <abbr title="structured query language">SQL</abbr> parser and pretty-printer
4229 * <abbr title="structured query language">SQL</abbr> validator
4230 * many bugfixes and improvements
4232 - Armel Fauveau &lt;armel.fauveau_at_globalis-ms.com&gt;
4233 * bookmarks feature
4234 * multiple dump feature
4235 * gzip dump feature
4236 * zip dump feature
4238 - Geert Lund &lt;glund_at_silversoft.dk&gt;
4239 * various fixes
4240 * moderator of the phpMyAdmin former users forum at phpwizard.net
4242 - Korakot Chaovavanich &lt;korakot_at_iname.com&gt;
4243 * &quot;insert as new row&quot; feature
4245 - Pete Kelly &lt;webmaster_at_trafficg.com&gt;
4246 * rewrote and fix dump code
4247 * bugfixes
4249 - Steve Alberty &lt;alberty_at_neptunlabs.de&gt;
4250 * rewrote dump code for PHP4
4251 * mySQL table statistics
4252 * bugfixes
4254 - Benjamin Gandon &lt;gandon_at_isia.cma.fr&gt;
4255 * main author of the version 2.1.0.1
4256 * bugfixes
4258 - Alexander M. Turek &lt;me_at_derrabus.de&gt;
4259 * MySQL 4.0 / 4.1 / 5.0 compatibility
4260 * abstract database interface (PMA_DBI) with MySQLi support
4261 * privileges administration
4262 * <abbr title="Extensible Markup Language">XML</abbr> exports
4263 * various features and fixes
4264 * German language file updates
4266 - Mike Beck &lt;mike.beck_at_web.de&gt;
4267 * automatic joins in QBE
4268 * links column in printview
4269 * Relation view
4271 - Michal &#268;iha&#345; &lt;michal_at_cihar.com&gt;
4272 * enhanced index creation/display feature
4273 * feature to use a different charset for HTML than for MySQL
4274 * improvements of export feature
4275 * various features and fixes
4276 * Czech language file updates
4278 - Christophe Gesch&eacute; from the &quot;MySQL Form Generator for PHPMyAdmin&quot;
4279 (http://sf.net/projects/phpmysqlformgen/)
4280 * suggested the patch for multiple table printviews
4282 - Garvin Hicking &lt;me_at_supergarv.de&gt;
4283 * built the patch for vertical display of table rows
4284 * built the Javascript based Query window + <abbr title="structured query language">SQL</abbr> history
4285 * Improvement of column/db comments
4286 * (MIME)-Transformations for columns
4287 * Use custom alias names for Databases in left frame
4288 * hierarchical/nested table display
4289 * <abbr title="Portable Document Format">PDF</abbr>-scratchboard for WYSIWYG-distribution of <abbr title="Portable Document Format">PDF</abbr> relations
4290 * new icon sets
4291 * vertical display of column properties page
4292 * some bugfixes, features, support, German language additions
4294 - Yukihiro Kawada &lt;kawada_at_den.fujifilm.co.jp&gt;
4295 * japanese kanji encoding conversion feature
4297 - Piotr Roszatycki &lt;d3xter_at_users.sourceforge.net&gt; and Dan Wilson
4298 * the Cookie authentication mode
4300 - Axel Sander &lt;n8falke_at_users.sourceforge.net&gt;
4301 * table relation-links feature
4303 - Maxime Delorme &lt;delorme.maxime_at_free.fr&gt;
4304 * <abbr title="Portable Document Format">PDF</abbr> schema output, thanks also to Olivier Plathey for the
4305 &quot;FPDF&quot; library (see <a href="http://www.fpdf.org/">http://www.fpdf.org/</a>) and Steven Wittens
4306 for the &quot;UFPDF&quot; library (see <a href="http://www.acko.net/node/56">http://www.acko.net/node/56</a>).
4308 - Olof Edlund &lt;olof.edlund_at_upright.se&gt;
4309 * <abbr title="structured query language">SQL</abbr> validator server
4311 - Ivan R. Lanin &lt;ivanlanin_at_users.sourceforge.net&gt;
4312 * phpMyAdmin logo (until June 2004)
4314 - Mike Cochrane &lt;mike_at_graftonhall.co.nz&gt;
4315 * blowfish library from the Horde project
4317 - Marcel Tschopp &lt;ne0x_at_users.sourceforge.net&gt;
4318 * mysqli support
4319 * many bugfixes and improvements
4321 - Michael Keck &lt;mkkeck_at_users.sourceforge.net&gt;
4322 * redesign for 2.6.0
4323 * phpMyAdmin sailboat logo (June 2004)
4325 - Mathias Landh&auml;u&szlig;er
4326 * Representation at conferences
4328 - Sebastian Mendel &lt;cybot_tm_at_users.sourceforge.net&gt;
4329 * interface improvements
4330 * various bugfixes
4332 - Ivan A Kirillov
4333 * new relations Designer
4335 - Raj Kissu Rajandran (Google Summer of Code 2008)
4336 * BLOBstreaming support
4338 - Piotr Przybylski (Google Summer of Code 2008)
4339 * improved setup script
4341 And also to the following people who have contributed minor changes,
4342 enhancements, bugfixes or support for a new language since version 2.1.0:
4344 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
4345 P&eacute;ter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
4346 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kl&auml;ger,
4347 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
4348 Bernard M. Piller, Laurent Haas, &quot;Sakamoto&quot;, Yuval Sarna,
4349 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
4350 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
4351 Lu&iacute;s V., Martijn W. van der Lee,
4352 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
4353 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, &quot;Manuzhai&quot;.
4356 Original Credits of Version 2.1.0
4357 ---------------------------------
4359 This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
4360 to create a web-based interface to MySQL using PHP3. Although I have not
4361 used any of his source-code, there are some concepts I've borrowed from
4362 him. phpMyAdmin was created because Peter told me he wasn't going to
4363 further develop his (great) tool.
4364 Thanks go to
4365 - Amalesh Kempf &lt;ak-lsml_at_living-source.com&gt; who contributed the
4366 code for the check when dropping a table or database. He also suggested
4367 that you should be able to specify the primary key on tbl_create.php3. To
4368 version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
4369 well as a bug-report. Plus many smaller improvements.
4370 - Jan Legenhausen &lt;jan_at_nrw.net&gt;: He made many of the changes that
4371 were introduced in 1.3.0 (including quite significant ones like the
4372 authentication). For 1.4.1 he enhanced the table-dump feature. Plus
4373 bug-fixes and help.
4374 - Marc Delisle &lt;DelislMa_at_CollegeSherbrooke.qc.ca&gt; made phpMyAdmin
4375 language-independent by outsourcing the strings to a separate file. He
4376 also contributed the French translation.
4377 - Alexandr Bravo &lt;abravo_at_hq.admiral.ru&gt; who contributed
4378 tbl_select.php3, a feature to display only some fields from a table.
4379 - Chris Jackson &lt;chrisj_at_ctel.net&gt; added support for MySQL
4380 functions in tbl_change.php3. He also added the
4381 &quot;Query by Example&quot; feature in 2.0.
4382 - Dave Walton &lt;walton_at_nordicdms.com&gt; added support for multiple
4383 servers and is a regular contributor for bug-fixes.
4384 - Gabriel Ash &lt;ga244_at_is8.nyu.edu&gt; contributed the random access
4385 features for 2.0.6.
4386 The following people have contributed minor changes, enhancements, bugfixes
4387 or support for a new language:
4388 Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
4389 Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
4390 Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
4391 G. Wieggers.
4393 And thanks to everyone else who sent me email with suggestions, bug-reports
4394 and or just some feedback.
4395 </pre>
4397 <h2 id="glossary">Glossary</h2>
4399 <p> From Wikipedia, the free encyclopedia</p>
4401 <ul>
4402 <li><a href="http://www.wikipedia.org/wiki/.htaccess">.htaccess</a>
4403 - the default name of Apache's directory-level configuration file.</li>
4404 <li><a href="http://www.wikipedia.org/wiki/Blowfish_%28cipher%29">Blowfish</a>
4405 - a keyed, symmetric block cipher, designed in 1993 by Bruce Schneier.</li>
4406 <li><a href="http://www.wikipedia.org/wiki/Browser">Browser (Web Browser)</a>
4407 - a software application that enables a user to display and interact with
4408 text, images, and other information typically located on a web page at a
4409 website on the World Wide Web.</li>
4410 <li><a href="http://www.wikipedia.org/wiki/Bzip2">bzip2</a>
4411 - a free software/open source data compression algorithm and program
4412 developed by Julian Seward.</li>
4413 <li><a href="http://www.wikipedia.org/wiki/CGI">CGI (Common Gateway Interface)</a>
4414 - an important World Wide Web technology that enables a client web browser
4415 to request data from a program executed on the Web server.</li>
4416 <li><a href="http://www.wikipedia.org/wiki/Changelog">Changelog</a>
4417 - a log or record of changes made to a project.</li>
4418 <li><a href="http://www.wikipedia.org/wiki/Client_%28computing%29">Client</a>
4419 - a computer system that accesses a (remote) service on another computer
4420 by some kind of network.</li>
4421 <li><a href="http://www.wikipedia.org/wiki/Column_%28database%29">column</a>
4422 - a set of data values of a particular simple type, one for each row of
4423 the table.</li>
4424 <li><a href="http://www.wikipedia.org/wiki/HTTP_cookie">Cookie</a>
4425 - a packet of information sent by a server to a World Wide Web browser
4426 and then sent back by the browser each time it accesses that server.</li>
4427 <li><a href="http://www.wikipedia.org/wiki/Comma-separated_values">CSV</a>
4428 - Comma-separated values</li>
4429 <li>DB - look at <a href="#database">Database</a>.</li>
4430 <li><a id="database" href="http://www.wikipedia.org/wiki/Database">database</a>
4431 - an organized collection of data.</li>
4432 <li>Engine - look at <a href="#glossar_storage_engine">Storage Engines</a>.</li>
4433 <li><a href="http://www.wikipedia.org/wiki/extension">extension</a>
4434 - a PHP module that extends PHP with additional functionality.</li>
4435 <li><a href="http://www.wikipedia.org/wiki/FAQ">FAQ (Frequently Asked Questions)</a>
4436 - a list of commonly asked question and there answers.</li>
4437 <li><a href="http://www.wikipedia.org/wiki/Field_%28computer_science%29">Field</a>
4438 - one part of divided data/columns.</li>
4439 <li><a href="http://www.wikipedia.org/wiki/Foreign_key">foreign key</a>
4440 - a field or group of fields in a database record that point to a key
4441 field or group of fields forming a key of another database record in some
4442 (usually different) table.</li>
4443 <li><a href="http://www.fpdf.org/">FPDF (FreePDF)</a>
4444 - the free PDF library</li>
4445 <li><a id="gd" href="http://www.wikipedia.org/wiki/GD_Graphics_Library">
4446 GD Graphics Library</a> - a library by Thomas Boutell and others for
4447 dynamically manipulating images.</li>
4448 <li>GD2 - look at <a href="#gd">GD Graphics Library</a>.</li>
4449 <li><a href="http://www.wikipedia.org/wiki/Gzip">gzip</a>
4450 - gzip is short for GNU zip, a GNU free software file compression
4451 program.</li>
4452 <li><a href="http://www.wikipedia.org/wiki/Host">host</a>
4453 - any machine connected to a computer network, a node that has a hostname.</li>
4454 <li><a href="http://www.wikipedia.org/wiki/Hostname">hostname</a>
4455 - the unique name by which a network attached device is known on a network.</li>
4456 <li><a href="http://www.wikipedia.org/wiki/HyperText_Transfer_Protocol">HTTP
4457 (HyperText Transfer Protocol)</a>
4458 - the primary method used to transfer or convey information on the World
4459 Wide Web.</li>
4460 <li><a href="http://www.wikipedia.org/wiki/Https:_URI_scheme">https</a>
4461 - a <abbr title="HyperText Transfer Protocol">HTTP</abbr>-connection with
4462 additional security measures.</li>
4463 <li><a href="http://www.wikipedia.org/wiki/Internet_Information_Services">IIS (Internet Information Services)</a>
4464 - a set of Internet-based services for servers using Microsoft Windows.</li>
4465 <li><a id="glossar_index" href="http://www.wikipedia.org/wiki/Index_%28database%29">Index</a>
4466 - a feature that allows quick access to the rows in a table.</li>
4467 <li><a href="http://www.wikipedia.org/wiki/Internet_Protocol">IP (Internet Protocol)</a>
4468 - a data-oriented protocol used by source and destination hosts for
4469 communicating data across a packet-switched internetwork.</li>
4470 <li><a href="http://www.wikipedia.org/wiki/IP_Address">IP Address</a>
4471 - a unique number that devices use in order to identify and communicate
4472 with each other on a network utilizing the Internet Protocol standard.</li>
4473 <li><a href="http://www.wikipedia.org/wiki/ISAPI">ISAPI
4474 (Internet Server Application Programming Interface)</a>
4475 - the API of Internet Information Services (IIS).</li>
4476 <li><a href="http://www.wikipedia.org/wiki/ISP">ISP (Internet service provider)</a>
4477 - a business or organization that offers users access to the Internet and related services.</li>
4478 <li><a id="jpeg" href="http://www.wikipedia.org/wiki/JPEG">JPEG</a>
4479 - a most commonly used standard method of lossy compression for
4480 photographic images.</li>
4481 <li>JPG - look at <a href="#jpeg">JPEG</a>.</li>
4482 <li>Key - look at <a href="#glossar_index">index</a>.</li>
4483 <li><a href="http://www.wikipedia.org/wiki/LaTeX">L<sup>A</sup>T<sub><big>E</big></sub>X</a>
4484 - a document preparation system for the T<sub>E</sub>X typesetting program.</li>
4485 <li><a href="http://www.wikipedia.org/wiki/Mac">Mac (Apple Macintosh)</a>
4486 - line of personal computers is designed, developed, manufactured, and
4487 marketed by Apple Computer.</li>
4488 <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>
4489 - the operating system which is included with all currently shipping Apple
4490 Macintosh computers in the consumer and professional markets.</li>
4491 <li><a href="http://www.wikipedia.org/wiki/MCrypt">MCrypt</a>
4492 - a cryptographic library.</li>
4493 <li><a href="http://php.net/mcrypt">mcrypt</a>
4494 - the MCrypt PHP extension.</li>
4495 <li><a href="http://www.wikipedia.org/wiki/MIME">MIME (Multipurpose Internet Mail Extensions)</a>
4496 - an Internet Standard for the format of e-mail.</li>
4497 <li><a href="http://www.wikipedia.org/wiki/module">module</a>
4498 - some sort of extension for the Apache Webserver.</li>
4499 <li><a href="http://www.wikipedia.org/wiki/MySQL">MySQL</a>
4500 - a multithreaded, multi-user, SQL (Structured Query Language) Database
4501 Management System (DBMS).</li>
4502 <li><a href="http://php.net/mysqli">mysqli</a>
4503 - the improved MySQL client PHP extension.</li>
4504 <li><a href="http://php.net/mysql">mysql</a>
4505 - the MySQL client PHP extension.</li>
4506 <li><a href="http://www.wikipedia.org/wiki/OpenDocument">OpenDocument</a>
4507 - open standard for office documents.</li>
4508 <li><a href="http://www.wikipedia.org/wiki/OS_X"><abbr title="operating system">OS</abbr> X</a>
4509 - look at <a href="#glossar_mac_os_x"><acronym title="Apple Macintosh">Mac</acronym> <abbr title="operating system">OS</abbr> X</a>.</li>
4510 <li><a href="http://www.wikipedia.org/wiki/Portable_Document_Format">PDF
4511 (Portable Document Format)</a>
4512 - a file format developed by Adobe Systems for representing two
4513 dimensional documents in a device independent and resolution independent
4514 format.</li>
4515 <li><a href="http://pear.php.net/">PEAR</a>
4516 - the PHP Extension and Application Repository.</li>
4517 <li><a href="http://php.net/pcre">PCRE (Perl Compatible Regular Expressions)</a>
4518 - the perl-compatible regular expression functions for PHP</li>
4519 <li><a href="http://www.wikipedia.org/wiki/PHP">PHP</a>
4520 - short for "PHP: Hypertext Preprocessor", is an open-source, reflective
4521 programming language used mainly for developing server-side applications
4522 and dynamic web content, and more recently, a broader range of software
4523 applications.</li>
4524 <li><a href="http://www.wikipedia.org/wiki/Port_%28computing%29">port</a>
4525 - a connection through which data is sent and received.</li>
4526 <li><a href="http://www.wikipedia.org/wiki/Request_for_Comments">RFC</a>
4527 - Request for Comments (RFC) documents are a series of memoranda
4528 encompassing new research, innovations, and methodologies applicable to
4529 Internet technologies.</li>
4530 <li><a href="http://www.ietf.org/rfc/rfc1952.txt">RFC 1952</a>
4531 - GZIP file format specification version 4.3</li>
4532 <li><a href="http://www.wikipedia.org/wiki/Row_%28database%29">Row (record, tulpel)</a>
4533 - represents a single, implicitly structured data item in a table.</li>
4534 <li><a href="http://www.wikipedia.org/wiki/Server_%28computing%29">Server</a>
4535 - a computer system that provides services to other computing
4536 systems over a network.</li>
4537 <li><a id="glossar_storage_engine" href="http://dev.mysql.com/doc/refman/5.0/en/storage-engines.html">Storage Engines</a>
4538 - handlers for different table types</li>
4539 <li><a href="http://www.wikipedia.org/wiki/Socket#Computer_sockets">socket</a>
4540 - a form of inter-process communication.</li>
4541 <li><a href="http://www.wikipedia.org/wiki/Secure_Sockets_Layer">SSL (Secure
4542 Sockets Layer)</a>
4543 - a cryptographic protocol which provides secure communication on the Internet.</li>
4544 <li><a href="http://www.wikipedia.org/wiki/SQL">SQL</a>
4545 - Structured Query Language</li>
4546 <li><a href="http://www.wikipedia.org/wiki/Table_%28database%29">table</a>
4547 - a set of data elements (cells) that is organized, defined and stored as
4548 horizontal rows and vertical columns where each item can be uniquely
4549 identified by a label or key or by it?s position in relation to other items.</li>
4550 <li>Table type</li>
4551 <li><a href="http://www.wikipedia.org/wiki/Tar_%28file_format%29">tar</a>
4552 - a type of archive file format: the Tape ARchive format.</li>
4553 <li><a href="http://www.wikipedia.org/wiki/TCP">TCP (Transmission Control Protocol)</a>
4554 - one of the core protocols of the Internet protocol suite.</li>
4555 <li><a href="http://www.acko.net/node/56">UFPDF</a>
4556 - Unicode/UTF-8 extension for FPDF</li>
4557 <li><a href="http://www.wikipedia.org/wiki/URL">URL (Uniform Resource Locator)</a>
4558 - a sequence of characters, conforming to a standardized format, that is
4559 used for referring to resources, such as documents and images on the
4560 Internet, by their location.</li>
4561 <li><a href="http://www.wikipedia.org/wiki/Webserver">Webserver</a>
4562 - A computer (program) that is responsible for accepting HTTP requests
4563 from clients and serving them Web pages.</li>
4564 <li><a href="http://www.wikipedia.org/wiki/XML">XML (Extensible Markup Language)</a>
4565 - a W3C-recommended general-purpose markup language for creating
4566 special-purpose markup languages, capable of describing many different
4567 kinds of data.</li>
4568 <li><a href="http://www.wikipedia.org/wiki/ZIP_%28file_format%29">ZIP</a>
4569 - a popular data compression and archival format.</li>
4570 <li><a href="http://www.wikipedia.org/wiki/Zlib">zlib</a>
4571 - an open-source, cross-platform data compression library by Jean-loup
4572 Gailly and Mark Adler.</li>
4573 </ul>
4574 </div>
4577 <ul id="footer">
4578 <li>Copyright &copy; 2003 - 2008 <a href="${base_url}team.${file_ext}">phpMyAdmin devel team</a></li>
4579 <li><a href="LICENSE">License</a></li>
4580 <li><a href="http://www.phpmyadmin.net/home_page/donate.php">Donate</a></li>
4581 <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>
4582 </ul>
4583 </body>
4584 </html>