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