lang
[phpmyadmin/crack.git] / Documentation.html
blob370d4a0e81bf19c06944acc32d19854131941661
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US">
4 <!-- $Id$ -->
5 <!--
6 vim: expandtab ts=4 sw=4 sts=4 tw=78
7 -->
9 <head>
10 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
11 <title>phpMyAdmin 2.6.4-dev - Documentation</title>
12 <link rel="stylesheet" type="text/css" href="docs.css" />
13 </head>
15 <body>
16 <a name="top"></a><br />
18 <div class="header">
19 <hr noshade="noshade" width="100%" />
20 <a href="#top">Top</a> &nbsp;-&nbsp;
21 <a href="#require">Requirements</a> &nbsp;-&nbsp;
22 <a href="#intro">Introduction</a> &nbsp;-&nbsp;
23 <a href="#setup">Installation</a> &nbsp;-&nbsp;
24 <a href="#config">Configuration</a>
25 <br />
26 <a href="#transformations">Transformations</a> &nbsp;-&nbsp;
27 <a href="#faq">FAQ</a> &nbsp;-&nbsp;
28 <a href="#developers">Developers</a> &nbsp;-&nbsp;
29 <a href="#credits">Credits</a> &nbsp;-&nbsp;
30 <a href="translators.html">Translators</a>
31 <hr noshade="noshade" width="100%" />
32 </div>
34 <h1>phpMyAdmin 2.6.4-dev Documentation</h1>
37 <!-- TOP MENU -->
38 <ul>
39 <li>
40 <a href="http://www.phpmyadmin.net/">
41 SourceForge phpMyAdmin project page&nbsp;&nbsp;&nbsp;[ http://www.phpmyadmin.net/ ]
42 </a>
43 </li>
44 <li>
45 Local documents:
46 <ul>
47 <li>Version history: <a href="changelog.php">ChangeLog</a></li>
48 <li>General notes: <a href="readme.php">README</a></li>
49 <li>License: <a href="license.php">LICENSE</a></li>
50 </ul>
51 </li>
52 <li>
53 Documentation version:
54 <i>$Id$</i>
55 </li>
56 </ul>
59 <!-- REQUIREMENTS -->
60 <a name="require"></a><br />
61 <h2>Requirements</h2>
63 <ul>
64 <li>
65 <b>PHP</b>
66 <ul>
67 <li>You need PHP 4.1.0 or newer (<a href="#faq1_31">*</a>)</li>
68 <li>If you want to display inline thumbnails of JPEGs with the
69 original aspect ratio, you also need GD2 support in PHP</li>
70 <li>Starting with phpMyAdmin 2.6.1, MIME-based transformations
71 that use an external program need PHP 4.3.0 or newer</li>
72 </ul>
73 </li>
74 <li>
75 <b>MySQL</b> 3.23.32 or newer (<a href="#faqmysqlversions">details</a>);
76 </li>
77 <li>
78 Not really a requirement but a <b>strong suggestion</b>:
79 if you are using
80 the &quot;cookie&quot; authentication method, having the <tt>mcrypt</tt>
81 PHP extension on your web server accelerates not only the login
82 phase but every other action that you do in phpMyAdmin.
83 </li>
84 <li>
85 a web-browser (doh!).
86 </li>
87 </ul>
90 <!-- INTRODUCTION -->
91 <a name="intro"></a><br />
92 <h2>Introduction</h2>
94 <p>
95 phpMyAdmin can manage a whole MySQL server (needs a super-user) as well as
96 a single database. To accomplish the latter you'll need a properly set up
97 MySQL user who can read/write only the desired database. It's up to you to
98 look up the appropriate part in the MySQL manual.<br />
99 Currently phpMyAdmin can:
100 </p>
102 <ul>
103 <li>create and drop databases</li>
104 <li>create, copy, drop, rename and alter tables</li>
105 <li>do table maintenance</li>
106 <li>delete, edit and add fields</li>
107 <li>execute any SQL-statement, even batch-queries</li>
108 <li>manage keys on fields</li>
109 <li>load text files into tables</li>
110 <li>create (*) and read dumps of tables</li>
111 <li>export (*) data to CSV, XML and Latex formats</li>
112 <li>administer multiple servers</li>
113 <li>manage MySQL users and privileges</li>
114 <li>check referential integrity in MyISAM tables</li>
115 <li>using Query-by-example (QBE), create complex queries automatically connecting required tables</li>
116 <li>create PDF graphics of your Database layout</li>
117 <li>search globally in a database or a subset of it</li>
118 <li>transform stored data into any format using a set of predefined functions,
119 like displaying BLOB-data as image or download-link or ...</li>
120 <li>support InnoDB tables and foreign keys <a href="#faq3_6">(see FAQ 3.6)</a></li>
121 <li>support mysqli, the improved MySQL extension <a href="#faqmysqlversions">(see FAQ 1.17)</a></li>
122 <li>
123 communicate in
124 <a href="./translators.html">50 different languages</a>
125 </li>
126 </ul>
128 <p class="footnote">
129 (*)&nbsp;
130 phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats) dumps
131 and CSV exports if you use PHP4&nbsp;>=&nbsp;4.0.4 with Zlib support
132 (<tt>--with-zlib</tt>) and/or Bzip2 support (<tt>--with-bz2</tt>).
133 </p>
136 <!-- INSTALLATION -->
137 <a name="setup"></a><br />
138 <h2>Installation</h2>
141 <span class="important">NOTE: phpMyAdmin does not apply any special security
142 methods to the MySQL database server. It is still the system administrator's job to
143 grant permissions on the MySQL databases properly. </span>phpMyAdmin's
144 &quot;Privileges&quot; page can be used for this.
145 </p>
148 <span class="important">Warning for Mac users:</span>if you are on a MacOS
149 version before OS X, StuffIt unstuffs with Mac formats.<br />
150 So you'll have to resave as in BBEdit to Unix style ALL phpMyAdmin scripts
151 before uploading them to your server, as PHP seems not to like Mac-style
152 end of lines character (&quot;<tt>\r</tt>&quot;).
153 </p>
155 <h3>Quick Install</h3>
156 <ol>
157 <li> Untar or unzip the distribution (be sure to unzip the subdirectories):
158 <tt>tar -xzvf phpMyAdmin_x.x.x.tar.gz</tt> in your webserver's
159 document root. If you don't have direct access to your document root,
160 put the files in a directory on your local machine, and, after step 3,
161 transfer the directory on your web server using, for example, ftp.</li>
162 <li> Ensure that all the scripts have the appropriate owner (if PHP is
163 running in safe mode, having some scripts with an owner different
164 from the owner of other scripts will be a
165 problem). See <a href="#faq4_2">FAQ 4.2</a> for suggestions.</li>
166 <li> Open the file <tt>config.inc.php</tt> in your favorite editor and change
167 the values for host, user, password and authentication mode to fit
168 your environment. Here, &quot;host&quot; means the MySQL server.
169 Have a look at
170 <a href="#config">Configuration section</a> for an
171 explanation of all values. Please also read the remaining of this
172 Installation section for information about authentication modes
173 and the linked-tables infrastructure.</li>
174 <li> It is recommended that you protect the directory in which you
175 installed phpMyAdmin (unless it's on a closed intranet, or you wish to
176 use HTTP or cookie authentication), for example with HTTP-AUTH (in a
177 <i>.htaccess</i> file). See the
178 <a href="#faqmultiuser">multi-user sub-section of the FAQ</a>
179 for additional information, especially <a href="#faq4_4">FAQ 4.4</a>.</li>
180 <li> Open the file
181 <i>&lt;www.your-host.com&gt;/&lt;your-install-dir&gt;/index.php</i>
182 in your browser. phpMyAdmin should now display a welcome screen
183 and your databases, or a login dialog if using HTTP or cookie
184 authentication mode.</li>
185 </ol>
186 <a name="linked-tables"></a>
187 <h3>Linked-tables infrastructure</h3>
189 For a whole set of new features (bookmarks, comments, SQL-history,
190 PDF-generation, field contents transformation, etc.)
191 you need to create a set of special tables. Those tables can be located
192 in your own database, or in a central database for a multi-user
193 installation (this database would then be accessed by the controluser,
194 so no other user should have rights to it).
195 <br /> <br />
196 Please look at your scripts/
197 directory, where you should find a file called <i>create_tables.sql</i>.
198 (If you are using a Windows server, pay special attention to <a href="#faq1_23">FAQ 1.23</a>).
199 <br /> <br />
200 If your MySQL server's version is 4.1.2 or later, please use
201 <i>create_tables_mysql_4_1_2+.sql</i> instead, for a new installation.
202 <br /> <br />
203 If you already had this infrastructure and upgraded to MySQL 4.1.2
204 or later, please use <i>upgrade_tables_mysql_4_1_2+.sql</i>.
205 <br /> <br />
206 You can use your phpMyAdmin to create the tables for you. Please be
207 aware that you may need special (administrator) privileges to create
208 the database and tables, and that the script may need some tuning,
209 depending on the database name.
210 <br /> <br />
211 After having imported the <i>create_tables.sql</i> file,
212 you should specify the table names in your <i>config.inc.php</i> file. The directives
213 used for that can be found in the <a href="#config">Configuration section</a>.
214 You will also need to have a controluser with the proper rights to
215 those tables (see section <i>Using authentication modes</i> below).
216 </p>
218 <h3>Upgrading from an older version</h3>
219 <ul>
220 <li>
221 You can safely copy your older <i>config.inc.php</i> over a new one, if
222 you can live with default values for possible new parameters (you can
223 check release notes to see what new features were added). This
224 compatibility will stay for long time, current version supports
225 importing config files from 2.2 and maybe even older (nobody has tried
226 that).
227 </li>
228 </ul>
230 <h3>Using authentication modes</h3>
231 <ul>
232 <li>HTTP and cookie authentication modes are recommended in a <b>multi-user
233 environment</b> where you want to give users access to their own
234 database and don't want them to play around with others.
235 <br />
236 Nevertheless be aware that MS Internet Explorer seems to be really
237 buggy about cookies, at least till version 6. And PHP 4.1.1 is also a
238 bit buggy in this area!<br />
239 Even in a <b>single-user environment</b>, you might prefer to use
240 HTTP or cookie mode so that your user/password pair are not in clear
241 in the configuration file.<br /><br /></li>
243 <li>HTTP and cookie authentication modes are more secure: the MySQL
244 login information does not need to be set in the phpMyAdmin
245 configuration file
246 (except possibly for the <a href="#controluser">controluser</a>).
247 <br />
248 However, keep in mind that the password travels in plain text, unless
249 you are using the HTTPS protocol.
250 <br />
251 In cookie mode, the password is stored, encrypted with the blowfish
252 algorithm, in a temporary cookie.
253 <br /><br /></li>
255 <li>
256 <b>Note: starting with phpMyAdmin 2.6.1, configuring the controluser
257 to enable HTTP and cookie authentication applies <i>only
258 to MySQL servers older than 4.1.2</i>.</b> See the <a href="#controluser">controluser</a> directive.
259 <br /><br />
260 For 'HTTP' and 'cookie' modes, phpMyAdmin needs a controluser that has
261 <b>only</b> the <tt>SELECT</tt> privilege on the <i>mysql.user (all
262 columns except &quot;Password&quot;)</i>, <i>mysql.db (all
263 columns)</i>, <i>mysql.host (all columns)</i> and
264 <i>mysql.tables_priv (all columns except
265 &quot;Grantor&quot; &amp; &quot;Timestamp&quot;) </i>tables.<br /> You
266 must specify the details for the <a href="#controluser">controluser</a>
267 in the <i>config.inc.php</i> file under the
268 <tt>$cfg['Servers'][$i]['controluser']</tt>&amp;
269 <tt>$cfg['Servers'][$i]['controlpass']</tt> settings.<br /> The
270 following example assumes you want to use <tt>pma</tt> as the
271 controluser and <tt>pmapass</tt> as the controlpass, but <b>this is
272 only an example: use something else in your file!</b><br /> Of course
273 you have to replace <tt>localhost</tt> by the webserver's host if it's
274 not the same as the MySQL server's one.
275 <pre>
277 GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY 'pmapass';
278 GRANT SELECT (
279 Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
280 Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
281 File_priv, Grant_priv, References_priv, Index_priv, Alter_priv,
282 Show_db_priv, Super_priv, Create_tmp_table_priv, Lock_tables_priv,
283 Execute_priv, Repl_slave_priv, Repl_client_priv
284 ) ON mysql.user TO 'pma'@'localhost';
285 GRANT SELECT ON mysql.db TO 'pma'@'localhost';
286 GRANT SELECT ON mysql.host TO 'pma'@'localhost';
287 GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv)
288 ON mysql.tables_priv TO 'pma'@'localhost';
289 </pre>
290 If you are using an old MySQL version (below 4.0.2), please replace
291 the first GRANT SELECT query by this one:
292 <pre>
294 GRANT SELECT (
295 Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
296 Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
297 File_priv, Grant_priv, References_priv, Index_priv, Alter_priv
298 ) ON mysql.user TO 'pma'@'localhost';
299 </pre>
300 ... and if you want to use the many new relation and bookmark
301 features:
302 <pre>
304 GRANT SELECT, INSERT, UPDATE, DELETE ON &lt;pma_db&gt;.* TO 'pma'@'localhost';
305 </pre>
306 (this of course requires that your <a href="#linked-tables">linked-tables infrastructure</a> be set up).
307 <br />
308 Of course, the above queries only work if your MySQL version supports
309 the GRANT command. This is the case since 3.22.11.
310 </li>
311 <li>
312 Then each of the <i>true</i> users should be granted a set of
313 privileges on a set of particular databases. Normally you shouldn't
314 give global privileges to an ordinary user, unless you understand
315 the impact of those privileges (for example, you are creating
316 a superuser).<br />
317 For example, to grant the user <i>real_user</i> with
318 all privileges on the database <i>user_base</i>:<br />
319 &nbsp;&nbsp;&nbsp;<tt>GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost IDENTIFIED BY 'real_password';</tt>
320 <br />
321 What the user may now do is controlled entirely by the MySQL user
322 management system.<br />
323 With HTTP or cookie authentication mode, you don't need to fill the
324 user/password fields inside the <tt>$cfg['Servers']</tt> array.<br />
325 </li>
326 </ul>
328 <h4>'http' authentication mode</h4>
329 <ul>
330 <li>Was called 'advanced' in versions before 2.2.3.</li>
331 <li>Introduced in 1.3.0, it uses Basic HTTP authentication method and
332 allows you to login as any valid MySQL user.</li>
333 <li>Is supported with PHP running as an Apache module. For IIS (ISAPI)
334 support using CGI PHP, see <a href="#faq1_32">FAQ 1.32</a>.</li>
335 <li>See also <a href="#faq4_4">FAQ 4.4</a> about not using the <i>.htaccess</i> mechanism along
336 with 'http' authentication mode.</li>
337 </ul>
339 <h4>'cookie' authentication mode</h4>
340 <ul>
341 <li>You can use this method as a replacement for the HTTP
342 authentication (for example, if you're running IIS).
343 </li>
344 <li>Obviously, the user must enable cookies in the browser.</li>
345 <li>With this mode, the user can truly logout of phpMyAdmin and login back
346 with the same username.</li>
347 <li>If you want to login to arbitrary server see
348 <tt><a href="#AllowArbitraryServer">$cfg['AllowArbitraryServer']</a></tt> directive.</li>
349 <li>See also the <a href="#require">requirements</a> section for a way
350 to improve the interface speed while using this mode.</li>
351 </ul>
353 <h4>'config' authentication mode</h4>
354 <ul>
355 <li>This mode is the less secure one because it requires you to fill the
356 <tt><a href="#servers_user">$cfg['Servers'][$i]['user']</a></tt> and
357 <tt><a href="#servers_user">$cfg['Servers'][$i]['password']</a></tt> fields.<br />
358 But you don't need to setup a &quot;controluser&quot; here:
359 using the <tt><a href="#servers_only_db">$cfg['Servers'][$i]['only_db']</a></tt> might be enough.</li>
360 <li>In the <a href="#faqmultiuser">ISP FAQ</a> section, there is an entry explaining how to protect
361 your configuration file.<br /></li>
362 <li>For additional security in this mode, you may wish to consider the
363 Host authentication <tt><a href="#servers_allowdeny_order">$cfg['Servers'][$i]['AllowDeny']['order']</a></tt>
364 and <tt><a href="#servers_allowdeny_rules">$cfg['Servers'][$i]['AllowDeny']['rules']</a></tt> configuration
365 directives.</li>
366 </ul>
369 <!-- CONFIGURATION -->
370 <a name="config"></a><br />
371 <h2>Configuration</h2>
374 <span class="important">Warning for Mac users:</span> PHP seems not to like
375 Mac end of lines character (&quot;<tt>\r</tt>&quot;). So ensure you choose
376 the option that allows to use the *nix end of line character
377 (&quot;<tt>\n</tt>&quot;) in your text editor before registering a script
378 you have modified.
379 </p>
382 <span class="important">Configuration note:</span>
383 Almost all configurable data is placed in <i>config.inc.php</i>. The
384 parameters which relate to design (like colors) are placed in
385 <tt>themes/themename/layout.inc.php</tt>. You
386 might also want to modify <i>config.footer.inc.php</i> and
387 <i>config.header.inc.php</i> files to add your site specific code to be
388 included on start and end of each page.
389 </p>
391 <dl>
392 <dt><b>$cfg['PmaAbsoluteUri']</b> string</dt>
393 <dd>
394 Sets here the complete URL (with full path) to your phpMyAdmin
395 installation's directory.
396 E.g. <tt>http://www.your_web.net/path_to_your_phpMyAdmin_directory/</tt>.
397 <br /><br />
398 Starting with version 2.3.0, it is advisable to try leaving this
399 blank. In most cases phpMyAdmin automatically detects the proper
400 setting. Additional details are in the configuration file. If you
401 leave it blank, see the notes for
402 <tt>$cfg['PmaAbsoluteUri_DisableWarning']</tt>; you probably want
403 to change that to <tt>TRUE</tt>.
404 <br /><br />
405 Don't forget the slash at the end of your URL. The URL must contain
406 characters that are valid for a URL, and on some servers, the path
407 is case-sensitive.
408 <br /><br />
409 </dd>
410 <dt><b>$cfg['PmaAbsoluteUri_DisableWarning']</b> boolean</dt>
411 <dd>
412 By default, when you leave $cfg['PmaAbsoluteUri'] empty, and the system
413 detects your absolute URI automatically, we display a warning to remind
414 you. If you have tested the automatic detection, and it works perfectly
415 for your setup, then you can set this variable to squelch the warning.
416 <br /><br />
417 </dd>
419 <dt><b>$cfg['PmaNoRelation_DisableWarning']</b> boolean</dt>
420 <dd>
421 Starting with version 2.3.0 phpMyAdmin offers a lot of features to work
422 with master / foreign - tables (see
423 <a href="#pmadb">$cfg['Servers'][$i]['pmadb']</a>).
424 <br />
425 If you tried to set this up and it does not work for you, have a look on
426 the &quot;Structure&quot; page of one database where you would like to
427 use it. You will find a link that will analyze why those features have
428 been disabled.<br />
429 If you do not want to use those features set this variable to
430 <tt>TRUE</tt> to stop this message from appearing.
431 <br /><br />
432 </dd>
434 <dt><b>$cfg['blowfish_secret']</b> string</dt>
435 <dd>
436 Starting with version 2.5.2, the 'cookie' auth_type uses blowfish
437 algorithm to encrypt the password.
438 <br />
439 If you are using the 'cookie' auth_type, enter here a random
440 passphrase of your choice. It will be used internally by the blowfish
441 algorithm: you won't be prompted for this passphrase. The maximum
442 number of characters for this parameter seems to be 46.
443 </dd>
445 <dt><b>$cfg['Servers']</b> array</dt>
446 <dd>
447 Since version 1.4.2, phpMyAdmin supports the administration of multiple
448 MySQL servers.
449 Therefore, a $cfg['Servers']-array has been added which contains
450 the login information for the different servers. The first
451 <tt>$cfg['Servers'][$i]['host']</tt> contains the hostname of the first
452 server, the second <tt>$cfg['Servers'][$i]['host']</tt> the hostname of
453 the second server, etc.
454 If you have only one server to administer, simply leave free the
455 hostname of the other $cfg['Server']-entries.
456 <br /><br />
457 </dd>
459 <dt><b>$cfg['Servers'][$i]['host']</b> string</dt>
460 <dd>
461 The hostname or IP address of your $i-th MySQL-server. E.g. localhost.
462 <br /><br />
463 </dd>
465 <dt><b>$cfg['Servers'][$i]['port']</b> string</dt>
466 <dd>
467 The port-number of your $i-th MySQL-server. Default is 3306 (leave
468 blank). If you use &quot;localhost&quot; as the hostname, MySQL
469 ignores this port number and connects with the socket, so if you want
470 to connect to a port different from the default port, use
471 &quot;127.0.0.1&quot; or the real hostname in
472 $cfg['Servers'][$i]['host'].
473 <br /><br />
474 </dd>
476 <dt><b>$cfg['Servers'][$i]['socket']</b> string</dt>
477 <dd>
478 The path to the socket to use. Leave blank for default.<br />
479 To use the socket feature you must run PHP 3.0.10 or more.
480 <br /><br />
481 </dd>
483 <dt><b>$cfg['Servers'][$i]['connect_type']</b> string</dt>
484 <dd>
485 What type connection to use with the MySQL server. Your options are
486 <tt>'socket'</tt> &amp; <tt>'tcp'</tt>. It defaults to 'tcp' as that
487 is nearly guaranteed to be available on all MySQL servers, while
488 sockets are not supported on some platforms.
489 <br /><br />
490 To use the socket mode, your MySQL server must be on the same machine
491 as the Web server.
492 <br /><br />
493 </dd>
495 <dt><b>$cfg['Servers'][$i]['extension']</b> string</dt>
496 <dd>
497 What php MySQL extension to use for the connection. Valid options are:
498 <br /><br />
499 <tt><i>mysql</i></tt>&nbsp;:&nbsp;
500 The classic MySQL extension. This is the recommended and default
501 method at this time.
502 <br /><br />
503 <tt><i>mysqli</i></tt>&nbsp;:&nbsp;
504 The improved MySQL extension. This extension became available
505 with php 5.0.0 and is the recommended way to connect to a server
506 running MySQL 4.1.x.
507 <br />
508 Note: phpMyAdmin's MySQL 4.1 support is experimental!
509 <br /><br />
510 </dd>
512 <dt><b>$cfg['Servers'][$i]['compress']</b> boolean</dt>
513 <dd>
514 Whether to use a compressed protocol for the MySQL server connection
515 or not (experimental).<br />
516 This feature requires PHP&nbsp;&gt;=&nbsp;4.3.0.
517 <br /><br />
518 </dd>
520 <dt>
521 <a name="controluser"></a><br />
522 <b>$cfg['Servers'][$i]['controluser']</b> string<br />
523 <b>$cfg['Servers'][$i]['controlpass']</b> string
524 </dt>
525 <dd>
526 <i>Note: starting with phpMyAdmin 2.6.1, configuring the controluser
527 to enable HTTP and cookie authentication applies only
528 to MySQL servers older than 4.1.2.</i>
529 <br /><br />
530 This special account is used for 2 distinct purposes: to make possible
531 all relational features
532 (see <a href="#pmadb">$cfg['Servers'][$i]['pmadb']</a>) and, for a
533 MySQL server older than 4.1.2, to enable a multi-user installation
534 (http or cookie authentication mode).
535 <br /><br />
536 When using HTTP or cookie authentication modes (or 'config'
537 authentication mode since phpMyAdmin 2.2.1), you need to supply the
538 details of a MySQL account that has <tt>SELECT</tt> privilege on the
539 <i>mysql.user (all columns except &quot;Password&quot;)</i>,
540 <i>mysql.db (all columns)</i> &amp; <i>mysql.tables_priv (all columns
541 except &quot;Grantor&quot; &amp; &quot;Timestamp&quot;) </i>tables.
542 This account is used to check what databases the user will see at
543 login.
544 <br />
545 Please see the <a href="#setup">install section</a> on
546 &quot;Using authentication modes&quot; for more information.
547 <br /><br />
548 Note that if you try login to phpMyAdmin with this
549 &quot;controluser&quot;, you could get some errors, depending the exact
550 privileges you gave to the &quot;controluser&quot;. phpMyAdmin does not
551 support a direct login with the &quot;controluser&quot;.
552 <br /><br />
553 In phpMyAdmin versions before 2.2.5, those were called
554 &quot;stduser/stdpass&quot;.
555 <br /><br />
556 </dd>
558 <dt><b>$cfg['Servers'][$i]['auth_type']</b> string
559 <tt>['http'|'cookie'|'config']</tt></dt>
560 <dd>
561 Whether config or cookie or http authentication should be used for this
562 server.
564 <ul>
565 <li>
566 'config' authentication
567 (<tt>$auth_type&nbsp;=&nbsp;'config'</tt>) is the plain old
568 way: username and password are stored in
569 <i>config.inc.php</i>.
570 </li>
571 <li>
572 'cookie' authentication mode
573 (<tt>$auth_type&nbsp;=&nbsp;'cookie'</tt>) as introduced in
574 2.2.3 allows you to log in as any valid MySQL user with the
575 help of cookies. Log name and password are stored in
576 cookies during the session and password is deleted when it
577 ends. This can also allow you to login in arbitrary server if
578 <tt><a href="#AllowArbitraryServer">$cfg['AllowArbitraryServer']</a></tt> enabled.
579 </li>
580 <li>
581 'http' authentication (was called 'advanced' in older versions)
582 (<tt>$auth_type&nbsp;=&nbsp;'http'</tt>) as introduced in 1.3.0
583 allows you to log in as any valid MySQL user via HTTP-Auth.
584 </li>
585 </ul><br />
587 Please see the <a href="#setup">install section</a> on &quot;Using authentication modes&quot;
588 for more information.
589 <br /><br />
590 </dd>
591 <dt>
592 <a name="servers_user"></a><br />
593 <b>$cfg['Servers'][$i]['user']</b> string<br />
594 <b>$cfg['Servers'][$i]['password']</b> string
595 </dt>
596 <dd>
597 The user/password-pair which phpMyAdmin will use to connect to this
598 MySQL-server. This user/password pair is not needed when HTTP or
599 cookie authentication is used, and should be empty.<br /><br />
600 </dd>
601 <dt>
602 <a name="servers_only_db"></a><br />
603 <b>$cfg['Servers'][$i]['only_db']</b> string or array</dt>
604 <dd>
605 If set to a (an array of) database name(s), only this (these) database(s)
606 will be shown to the user. Since phpMyAdmin 2.2.1, this/these
607 database(s) name(s) may contain MySQL wildcards characters
608 (&quot;_&quot; and &quot;%&quot;): if you want to use literal instances
609 of these characters, escape them (I.E. use <tt>'my\_db'</tt> and not
610 <tt>'my_db'</tt>).<br />
611 This setting is an efficient way to lower the server load since the
612 latter does not need to send MySQL requests to build the available
613 database list. But <span class="important">it does not replace the
614 privileges rules of the MySQL database server</span>. If set, it just
615 means only these databases will be displayed but
616 <span class="important">not that all other databases can't be used.</span>
617 <br /><br />
618 An example of using more that one database:
619 <tt>$cfg['Servers'][$i]['only_db'] = array('db1', 'db2'); </tt>
620 <br /><br />
621 As of phpMyAdmin 2.5.5 the order inside the array is used for sorting the
622 databases in the left frame, so that you can individually arrange your databases.<br />
623 If you want to have certain databases at the top, but don't care about the others, you do not
624 need to specify all other databases. Use:
625 <tt>$cfg['Servers'][$i]['only_db'] = array('db3', 'db4', '*');</tt>
626 instead to tell phpMyAdmin that it should display db3 and db4 on top, and the rest in alphabetic
627 order.
628 </dd>
630 <dt><b>$cfg['Servers'][$i]['verbose']</b> string</dt>
631 <dd>
632 Only useful when using phpMyAdmin with multiple server entries. If set,
633 this string will be displayed instead of the hostname in the pull-down
634 menu on the main page. This can be useful if you want to show only
635 certain databases on your system, for example.
636 <br /><br />
637 </dd>
639 <dt>
640 <a name="pmadb"></a><br />
641 <b>$cfg['Servers'][$i]['pmadb']</b> string
642 </dt>
643 <dd>
644 The name of the database containing the linked-tables infrastructure.
645 <br /><br />
646 See the <a href="#linked-tables">Linked-tables infrastructure</a>
647 section in this document to see the benefits of this infrastructure,
648 and for a quick way of creating this database and the needed tables.
649 <br /><br />
650 If you are the only user of this phpMyAdmin installation, you can
651 use your current database to store those special tables; in this
652 case, just put your current database name in
653 <tt>$cfg['Servers'][$i]['pmadb']</tt>. For a multi-user installation,
654 set this parameter to the name of your central database containing
655 the linked-tables infrastructure.
656 <br /><br />
657 </dd>
659 <dt>
660 <a name="bookmark"></a><br />
661 <b>$cfg['Servers'][$i]['bookmarktable']</b> string
662 </dt>
663 <dd>
664 Since release 2.2.0 phpMyAdmin allows to bookmark queries. This can be
665 useful for queries you often run.<br /><br />
667 To allow the usage of this functionality:
668 <ul>
669 <li>set up <a href="#pmadb">pmadb</a> and the linked-tables infrastructure</li>
670 <li>enter the table name in
671 <tt>$cfg['Servers'][$i]['bookmarktable']</tt></li>
672 </ul><br />
673 </dd>
675 <dt>
676 <a name="relation"></a><br />
677 <b>$cfg['Servers'][$i]['relation']</b> string
678 </dt>
679 <dd>
680 Since release 2.2.4 you can describe, in a special 'relation' table,
681 which field is a key in another table (a foreign key). phpMyAdmin
682 currently uses this to
683 <ul>
684 <li>
685 make clickable, when you browse the master table, the data values
686 that point to the foreign table;
687 </li>
688 <li>
689 display in an optional tool-tip the &quot;display field&quot;
690 when browsing the master table, if you move the mouse to a column
691 containing a foreign key (use also the 'table_info' table);<br />
692 (see <a href="#faqdisplay">FAQ 6.7</a>)
693 </li>
694 <li>
695 in edit/insert mode, display a drop-down list of possible
696 foreign keys (key value and &quot;display field&quot; are
697 shown)<br />
698 (see <a href="#faq6_21">FAQ 6.21</a>)
699 </li>
700 <li>
701 display links on the table properties page, to check referential
702 integrity (display missing foreign keys) for each described key;
703 </li>
704 <li>
705 in query-by-example, create automatic joins (see <a href="#faq6_6">FAQ 6.6</a>)
706 </li>
707 <li>
708 enable you to get a PDF schema of your database (also uses the
709 table_coords table).
710 </li>
711 </ul>
712 <br />
714 The keys can be numeric or character.
715 <br /><br />
717 To allow the usage of this functionality:
718 <ul>
719 <li>set up <a href="#pmadb">pmadb</a> and the linked-tables infrastructure</li>
720 <li>
721 put the relation table name in
722 <tt>$cfg['Servers'][$i]['relation']</tt>
723 </li>
724 <li>
725 now as normal user open phpMyAdmin and for each one of your
726 tables where you want to use this feature, click
727 &quot;Structure/Relation view/&quot; and choose foreign fields.
728 </li>
729 </ul><br />
730 Please note that in the current version, <tt>master_db</tt>
731 must be the same as <tt>foreign_db</tt>. Those fields have been put in
732 future development of the cross-db relations.<br /><br />
733 </dd>
735 <dt>
736 <a name="table_info"></a><br />
737 <b>$cfg['Servers'][$i]['table_info']</b> string
738 </dt>
739 <dd>
740 Since release 2.3.0 you can describe, in a special 'table_info'
741 table, which field is to be displayed as a tool-tip when moving the
742 cursor over the corresponding key.
743 <br />
744 This configuration variable will hold the name of this special
745 table.
746 To allow the usage of this functionality:
747 <ul>
748 <li>set up <a href="#pmadb">pmadb</a> and the linked-tables infrastructure</li>
749 <li>
750 put the table name in
751 <tt>$cfg['Servers'][$i]['table_info']</tt>
752 </li>
753 <li>
754 then for each table where you want to use this feature,
755 click &quot;Structure/Relation view/Choose field to display&quot;
756 to choose the field.
757 </li>
758 </ul><br />
759 Usage tip: <a href="#faqdisplay">Display field</a>.
760 <br /><br />
761 </dd>
762 <dt>
763 <a name="table_coords"></a><br />
764 <b>$cfg['Servers'][$i]['table_coords']</b> string<br />
765 <b>$cfg['Servers'][$i]['pdf_pages']</b> string
766 </dt>
767 <dd>
768 Since release 2.3.0 you can have phpMyAdmin create PDF pages showing
769 the relations between your tables. To do this it needs two tables
770 &quot;pdf_pages&quot; (storing information about the available PDF
771 pages) and &quot;table_coords&quot; (storing coordinates where each
772 table will be placed on a PDF schema output).
773 <br /><br />
774 You must be using the &quot;relation&quot; feature.
775 <br /><br />
776 To allow the usage of this functionality:
777 <ul>
778 <li>set up <a href="#pmadb">pmadb</a> and the linked-tables infrastructure</li>
779 <li>
780 put the correct table names in
781 <tt>$cfg['Servers'][$i]['table_coords']</tt> and
782 <tt>$cfg['Servers'][$i]['pdf_pages']</tt>
783 </li>
784 </ul><br />
785 Usage tips: <a href="#faqpdf">PDF output</a>.
786 <br /><br />
787 </dd>
789 <dt>
790 <a name="col_com"></a><br />
791 <b>$cfg['Servers'][$i]['column_info']</b> string
792 </dt>
793 <dd>
794 <!-- This part requires a content update! -->
795 Since release 2.3.0 you can store comments to describe each column
796 for each table. These will then be shown on the &quot;printview&quot;.
797 <br /><br />
798 Starting with release 2.5.0, comments are consequently used on the table property
799 pages and table browse view, showing up as tool-tips above the column name (properties page)
800 or embedded within the header of table in browse view. They can also be shown
801 in a table dump. Please see the relevant configuration directives later on.
802 <br /><br />
803 Also new in release 2.5.0 is a MIME-transformation system which is also based on
804 the following table structure. See <a href="#transformations">Transformations</a>
805 for further information. To use the MIME-transformation system, your column_info
806 table has to have the three new fields 'mimetype', 'transformation', 'transformation_options'.
807 <br /><br />
808 To allow the usage of this functionality:
809 <ul>
810 <li>set up <a href="#pmadb">pmadb</a> and the linked-tables infrastructure</li>
811 <li>
812 put the table name in
813 <tt>$cfg['Servers'][$i]['column_info']</tt>
814 </li>
815 <li>
816 to update your PRE-2.5.0 Column_comments Table use this:<br />
817 <tt>
818 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ALTER TABLE `pma_column_comments` <br />
819 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ADD `mimetype` VARCHAR( 255 ) NOT NULL ,<br />
820 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ADD `transformation` VARCHAR( 255 ) NOT NULL ,<br />
821 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ADD `transformation_options` VARCHAR( 255 ) NOT NULL ;<br />
822 </tt>
823 and remember that the Variable in <i>config.inc.php</i> has been renamed
824 from <br /><tt>$cfg['Servers'][$i]['column_comments']</tt> to <tt>$cfg['Servers'][$i]['column_info']</tt>
825 </li>
826 </ul><br />
827 </dd>
829 <dt>
830 <a name="history"></a><br />
831 <b>$cfg['Servers'][$i]['history']</b> string
832 </dt>
833 <dd>
834 Since release 2.5.0 you can store your SQL history, which means all queries you
835 entered manually into the phpMyAdmin interface. If you don't want to use a table-
836 based history, you can use the JavaScript-based history. Using that, all your
837 history items are deleted when closing the window.<br /><br />
839 Using <b>$cfg['QueryHistoryMax']</b> you can specify an amount of history items
840 you want to have on hold. On every login, this list gets cut to the maximum amount.
841 <br /><br />
843 The query history is only available if you use the JavaScript-based query window,
844 see <b>$cfg['QueryFrame']</b>.
845 <br /><br />
847 To allow the usage of this functionality:
848 <ul>
849 <li>set up <a href="#pmadb">pmadb</a> and the linked-tables infrastructure</li>
850 <li>
851 put the table name in
852 <tt>$cfg['Servers'][$i]['history']</tt>
853 </li>
854 </ul><br />
855 </dd>
857 <dt>
858 <b>$cfg['Servers'][$i]['verbose_check']</b> boolean
859 </dt>
860 <dd>
861 Because release 2.5.0 introduced the new MIME-transformation support, the
862 column_info table got enhanced with three new fields. If the above variable is
863 set to <tt>TRUE</tt> (default) phpMyAdmin will check if you have the latest table structure
864 available. If not, it will emit a warning to the superuser.<br /><br />
866 You can disable this checking behavior by setting the variable to false, which
867 should offer a performance increase.<br /><br />
869 Recommended to set to FALSE, when you are sure, your table structure is up to date.
870 <br /><br />
871 </dd>
872 <dt>
873 <b>$cfg['Servers'][$i]['AllowRoot']</b> boolean
874 </dt>
875 <dd>
876 Whether to allow root access, This is just simplification of rules below.
877 <br /><br />
878 </dd>
879 <dt>
880 <a name="servers_allowdeny_order"></a><br />
881 <b>$cfg['Servers'][$i]['AllowDeny']['order']</b> string
882 </dt>
883 <dd>
884 If your rule order is empty, then IP authentication is disabled.
885 <br /><br />
886 If your rule order is set to <tt>'deny,allow'</tt> then the system
887 applies all deny rules followed by allow rules.
888 Access is allowed by default. Any client which does not match a Deny
889 command or does match an Allow command will be allowed access to the
890 server.
891 <br /><br />
892 If your rule order is set to <tt>'allow,deny'</tt> then the system
893 applies all allow rules followed by deny rules. Access is denied by
894 default. Any client which does not match an Allow directive or does
895 match a Deny directive will be denied access to the server.
896 <br /><br />
897 If your rule order is set to 'explicit', the authentication is
898 performed in a similar fashion to rule order 'deny,allow', with the
899 added restriction that your host/username combination <b>must</b> be
900 listed in the <i>allow</i> rules, and not listed in the <i>deny</i>
901 rules. This is the <b>most</b> secure means of using Allow/Deny rules,
902 and was available in Apache by specifying allow and deny rules without
903 setting any order.
904 <br /><br />
905 </dd>
906 <dt>
907 <a name="servers_allowdeny_rules"></a><br />
908 <b>$cfg['Servers'][$i]['AllowDeny']['rules']</b> array of strings
909 </dt>
910 <dd>
911 The general format for the rules is as such:<br />
912 <tt>
913 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
914 &lt;'allow' | 'deny'&gt; &lt;username&gt; [from] &lt;ipmask&gt;
915 </tt>
916 <br /><br />
918 If you wish to match all users, it is possible to use a <tt>'%'</tt> as
919 a wildcard in the <i>username</i> field.<br />
920 There are a few shortcuts you can use in the <i>ipmask</i> field as
921 well:<br />
922 <tt>
923 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'all' -&gt; 0.0.0.0/0<br />
924 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'localhost' -&gt; 127.0.0.1/8
925 </tt>
926 <br /><br />
928 Having an empty rule list is equivalent to either using
929 <tt>'allow % from all'</tt> if your rule order is set to
930 <tt>'deny,allow'</tt> or <tt>'deny % from all'</tt> if your rule order
931 is set to <tt>'allow,deny'</tt> or <tt>'explicit'</tt>.
932 <br /><br />
934 For the IP matching system, the following work:<br />
935 <tt>xxx.xxx.xxx.xxx</tt> (an exact IP address)<br />
936 <tt>xxx.xxx.xxx.[yyy-zzz]</tt> (an IP address range)<br />
937 <tt>xxx.xxx.xxx.xxx/nn</tt> (CIDR, Classless Inter-Domain Routing type IP addresses)<br />
938 But the following does not work:<br />
939 <tt>xxx.xxx.xxx.xx[yyy-zzz]</tt> (partial IP address range)
940 <br /><br />
941 </dd>
943 <dt><b>$cfg['ServerDefault']</b> integer</dt>
944 <dd>
945 If you have more than one server configured, you can set
946 <tt>$cfg['ServerDefault']</tt> to any one of them to autoconnect to
947 that server when phpMyAdmin is started, or set it to 0 to be given a
948 list of servers without logging in.<br />
949 If you have only one server configured, <tt>$cfg['ServerDefault']</tt>
950 MUST be set to that server.
951 <br /><br />
952 </dd>
954 <dt><b>$cfg['OBGzip'] </b>string/boolean</dt>
955 <dd>
956 Defines whether to use GZip output buffering for increased
957 speed in HTTP transfers.<br />
958 Set to true/false for enabling/disabling. When set to 'auto' (string),
959 phpMyAdmin tries to enable output buffering and will automatically disable
960 it, if your browser has some problems with buffering. IE6 with a certain patch
961 is known to cause data corruption having enabled buffering.
962 <br /><br />
963 </dd>
965 <dt><b>$cfg['PersistentConnections'] </b>boolean</dt>
966 <dd>
967 Whether persistent connections should be used or not (mysql_connect or
968 mysql_pconnect).
969 <br /><br />
970 </dd>
972 <dt><b>$cfg['ExecTimeLimit'] </b>integer [number of seconds]</dt>
973 <dd>
974 Set the number of seconds a script is allowed to run. If seconds is set
975 to zero, no time limit is imposed.<br />
976 This setting is used while importing/exporting dump files but has no
977 effect when PHP is running in safe mode.
978 <br /><br />
979 </dd>
981 <dt><b>$cfg['SkipLockedTables'] </b>boolean</dt>
982 <dd>
983 Mark used tables and make it possible to show databases with locked
984 tables (since 3.23.30).
985 <br /><br />
986 </dd>
988 <dt><b>$cfg['ShowSQL'] </b>boolean</dt>
989 <dd>
990 Defines whether SQL-queries generated by phpMyAdmin should be displayed
991 or not.
992 <br /><br />
993 </dd>
995 <dt><b>$cfg['AllowUserDropDatabase'] </b>boolean</dt>
996 <dd>
997 Defines whether normal users (non-administrator) are allowed to
998 delete their own database or not. If set as FALSE, the link &quot;Drop
999 Database&quot; will not be shown, and even a &quot;DROP DATABASE
1000 mydatabase&quot; will be rejected. Quite practical for ISP's with many
1001 customers.
1002 <br /><br />
1003 </dd>
1005 <dt><b>$cfg['Confirm'] </b>boolean</dt>
1006 <dd>
1007 Whether a warning (&quot;Are your really sure...&quot;) should be
1008 displayed when you're about to lose data.
1009 <br /><br />
1010 </dd>
1012 <dt><b>$cfg['LoginCookieRecall'] </b>boolean</dt>
1013 <dd>
1014 Define whether the previous login should be recalled or not in cookie
1015 authentication mode.
1016 <br /><br />
1017 </dd>
1019 <dt><b>$cfg['UseDbSearch'] </b>boolean</dt>
1020 <dd>
1021 Define whether the "search string inside database" is enabled or not.
1022 <br /><br />
1023 </dd>
1025 <dt><b>$cfg['IgnoreMultiSubmitErrors'] </b>boolean</dt>
1026 <dd>
1027 Define whether phpMyAdmin will continue executing a multi-query
1028 statement if one of the queries fails. Default is to abort execution.
1029 <br /><br />
1030 </dd>
1032 <dt><b>$cfg['VerboseMultiSubmit'] </b>boolean</dt>
1033 <dd>
1034 Define whether phpMyAdmin will output the results of each query of a
1035 multi-query statement embedded into the SQL output as inline comments.
1036 Defaults to <tt>TRUE</tt>.
1037 <br /><br />
1038 </dd>
1039 <dt>
1040 <a name="AllowArbitraryServer"></a><br />
1041 <b>$cfg['AllowArbitraryServer'] </b>boolean</dt>
1042 <dd>
1043 If enabled allows you to login to arbitrary server using cookie auth.
1044 <br /><br />
1045 <b>NOTE:</b> Please use this carefully, as this may allow to access
1046 MySQL servers behind firewall where your http server is placed.
1047 <br /><br />
1048 </dd>
1050 <dt><b>$cfg['LeftFrameLight']</b> boolean</dt>
1051 <dd>
1052 Defines whether to use select-based menu and display only the current
1053 tables in the left frame (smaller page).
1054 Only in Non-Lightmode you can use the feature to display nested folders
1055 using $cfg['LeftFrameTableSeparator']
1056 <br /><br />
1057 </dd>
1059 <dt><b>$cfg['LeftFrameDBTree']</b> boolean</dt>
1060 <dd>
1061 In light mode, defines whether to display the names of databases (in the
1062 selector) using a tree, see also <tt>$cfg['LeftFrameDBSeparator']</tt>.
1063 <br /><br />
1064 </dd>
1066 <dt><b>$cfg['LeftFrameDBSeparator']</b> string</dt>
1067 <dd>
1068 The string used to separate the parts of the database name when showing
1069 them in a tree.
1070 <br /><br />
1071 </dd>
1073 <dt><b>$cfg['LeftFrameTableSeparator']</b> string</dt>
1074 <dd>
1075 Defines a string to be used to nest table spaces. Defaults to '__'.
1076 This means if you have tables like 'first__second__third' this will be
1077 shown as a three-level hierarchie like: first &gt; second &gt; third.
1078 If set to FALSE or empty, the feature is disabled. NOTE: You shall
1079 not use this Separator in a table name at the beginning or end of a
1080 table name, or multiple times after another without any other
1081 characters in between.
1082 <br /><br />
1083 </dd>
1085 <dt><b>$cfg['LeftFrameTableLevel']</b> string</dt>
1086 <dd>
1087 Defines how many sublevels should be displayed when splitting
1088 up tables by the above Separator.
1089 <br /><br />
1090 </dd>
1092 <dt><b>$cfg['ShowTooltip'] </b>boolean</dt>
1093 <dd>
1094 Defines whether to display table comment as tool-tip in left frame or
1095 not.
1096 <br /><br />
1097 </dd>
1099 <dt><b>$cfg['ShowTooltipAliasDB'] </b>boolean</dt>
1100 <dd>
1101 If tool-tips are enabled and a DB comment is set, this will flip the
1102 comment and the real name. That means, if you have a table called
1103 'user0001' and add the comment 'MyName' on it, you will see the name
1104 'MyName' used consequently in the left frame and the tool-tip shows
1105 the real name of the DB.
1106 <br /><br />
1107 </dd>
1109 <dt><b>$cfg['ShowTooltipAliasTB'] </b>boolean/string</dt>
1110 <dd>
1111 Same as $cfg['ShowTooltipAliasDB'], except this works for table names.
1113 When setting this to 'nested', the Alias of the Tablename is only used
1114 to split/nest the tables according to the $cfg['LeftFrameTableSeparator']
1115 directive. So only the folder is called like the Alias, the tablename itself
1116 stays the real tablename.
1117 <br /><br />
1118 </dd>
1119 <dt><b>$cfg['LeftDisplayLogo'] </b>boolean</dt>
1120 <dd>Defines whether to display the phpMyAdmin logo at the top of the left frame or not.
1121 Defaults to <tt>TRUE</tt>. <br />
1122 <br />
1123 </dd>
1124 <dt><b>$cfg['LeftDisplayServers'] </b>boolean</dt>
1125 <dd>Defines whether to display a server choice at the top of the left frame or not.
1126 Defaults to FALSE. <br />
1127 <br />
1128 </dd>
1129 <dt><b>$cfg['DisplayServersList'] </b>boolean</dt>
1130 <dd>Defines whether to display this server choice as links instead of in a drop-down.
1131 Defaults to FALSE (drop-down). <br />
1132 <br />
1133 </dd>
1134 <dt><b>$cfg['ShowStats'] </b>boolean</dt>
1135 <dd>
1136 Defines whether to display space usage and statistics about databases
1137 and tables or not.<br />
1138 Note that statistics requires at least MySQL 3.23.3 and that, at this
1139 date, MySQL doesn't return such information for Berkeley DB tables.
1140 <br /><br />
1141 </dd>
1143 <dt>
1144 <b>$cfg['ShowMysqlInfo'] </b>boolean<br />
1145 <b>$cfg['ShowMysqlVars'] </b>boolean<br />
1146 <b>$cfg['ShowPhpInfo'] </b>boolean<br />
1147 <b>$cfg['ShowChgPassword'] </b>boolean
1148 </dt>
1149 <dd>
1150 Defines whether to display the &quot;MySQL runtime information&quot;,
1151 &quot;MySQL system variables&quot;, &quot;PHP information&quot; and
1152 &quot;Change password &quot; links or not for simple users at the
1153 starting main (right) frame. This setting does not check MySQL
1154 commands entered directly.
1155 <br /><br />
1157 Please note that to block the usage of phpinfo() in scripts, you
1158 have to put this in your <i>php.ini</i>:<br />
1159 &nbsp;&nbsp;&nbsp;&nbsp;<tt>disable_functions = phpinfo()</tt>
1160 <br /><br />
1162 Also note that enabling the &quot;Change password &quot; link has no
1163 effect with &quot;config&quot; authentication mode: because of the
1164 hard coded password value in the configuration file, end users can't
1165 be allowed to change their passwords.
1166 <br /><br />
1167 </dd>
1169 <dt><b>$cfg['SuggestDBName']</b> boolean</dt>
1170 <dd>
1171 Defines whether to suggest a database name on the
1172 &quot;Create Database&quot; form or to keep the textfield empty.
1173 <br /><br />
1174 </dd>
1176 <dt><b>$cfg['ShowBlob'] </b>boolean</dt>
1177 <dd>
1178 Defines whether <tt>BLOB</tt> fields are shown when browsing a table's
1179 content or not.
1180 <br /><br />
1181 </dd>
1183 <dt><b>$cfg['NavigationBarIconic'] </b>string</dt>
1184 <dd>
1185 Defines whether navigation bar buttons and the right panel top menu contain text or symbols only. A value of TRUE displays icons, FALSE displays text and 'both' displays both icons and text.
1186 <br /><br />
1187 </dd>
1189 <dt><b>$cfg['ShowAll'] </b>boolean</dt>
1190 <dd>
1191 Defines whether an user should be displayed a
1192 &quot;show all (records)&quot; button in browse mode or not.
1193 <br /><br />
1194 </dd>
1196 <dt><b>$cfg['MaxRows'] </b>integer</dt>
1197 <dd>
1198 Number of rows displayed when browsing a result set. If the result set
1199 contains more rows, Previous/Next links will be shown.
1200 <br /><br />
1201 </dd>
1203 <dt><b>$cfg['Order'] </b>string [<tt>DESC</tt>|<tt>ASC</tt>|<tt>SMART</tt>]</dt>
1204 <dd>
1205 Defines whether fields are displayed in ascending (<tt>ASC</tt>) order,
1206 in descending (<tt>DESC</tt>) order or in a &quot;smart&quot;
1207 (<tt>SMART</tt>) order - I.E. descending order for fields of type TIME,
1208 DATE, DATETIME &amp; TIMESTAMP, ascending order else- by default.
1209 <br /><br />
1210 </dd>
1212 <dt><b>$cfg['ProtectBinary'] </b>boolean or string</dt>
1213 <dd>
1214 Defines whether <tt>BLOB</tt> or <tt>BINARY</tt> fields are protected
1215 from edition when browsing a table's content or not.
1216 Valid values are:<br />
1217 - <tt>FALSE</tt> to allow edition of all fields;<br />
1218 - <tt>blob</tt> to allow edition of all fields except <tt>BLOBS</tt>;
1219 <br />
1220 - <tt>all</tt> to disallow edition of all <tt>BINARY</tt> or
1221 <tt>BLOB</tt> fields.
1222 <br /><br />
1223 </dd>
1225 <dt><b>$cfg['ShowFunctionFields'] </b>boolean</dt>
1226 <dd>
1227 Defines whether MySQL functions fields should be displayed or not in
1228 edit/insert mode.
1229 <br /><br />
1230 </dd>
1232 <dt><b>$cfg['CharEditing'] </b>string</dt>
1233 <dd>
1234 Defines which type of editing controls should be used for CHAR and
1235 VARCHAR fields. Possible values are:
1236 <ul>
1237 <li>
1238 input - this allows to limit size of text to size of field in
1239 MySQL, but has problems with newlines in fields
1240 </li>
1241 <li>
1242 textarea - no problems with newlines in fields, but also no
1243 length limitations
1244 </li>
1245 </ul>
1246 Default is old behavior so input.
1247 <br /><br />
1248 </dd>
1250 <dt><b>$cfg['InsertRows']</b> integer</dt>
1251 <dd>
1252 Defines the maximum number of concurrent entries for the Insert page.
1253 </dd>
1255 <dt><b>$cfg['ForeignKeyMaxLimit']</b> integer</dt>
1256 <dd>
1257 If there are fewer items than this in the set of foreign keys, then a
1258 drop-down box of foreign keys is presented, in the style described by the
1259 <b>$cfg['ForeignKeyDropdownOrder']</b> setting.
1260 </dd>
1262 <dt><b>$cfg['ForeignKeyDropdownOrder']</b> array</dt>
1263 <dd>
1264 For the foreign key drop-down fields, there are several methods of
1265 display, offering both the key and value data. The contents of the
1266 array should be one or both of the following strings:
1267 <i>'content-id'</i>, <i>'id-content'</i>.
1268 </dd>
1270 <dt>
1271 <b>$cfg['ZipDump'] </b>boolean<br />
1272 <b>$cfg['GZipDump'] </b>boolean<br />
1273 <b>$cfg['BZipDump'] </b>boolean
1274 </dt>
1275 <dd>
1276 Defines whether to allow the use of zip/GZip/BZip2 compression when
1277 creating a dump file or not.
1278 <br /><br />
1279 </dd>
1281 <dt>
1282 <b>$cfg['CompressOnFly'] </b>boolean<br />
1283 </dt>
1284 <dd>
1285 Defines whether to allow on the fly compression for GZip/BZip2
1286 compressed exports. This doesn't affect smaller dumps and allows to
1287 create larger dumps, that won't fit otherwise in memory due to php
1288 memory limit. Produced files contain more GZip/BZip2 headers, but all
1289 normal programs handle this correctly.
1290 <br /><br />
1291 </dd>
1293 <dt><b>$cfg['LightTabs'] </b>string</dt>
1294 <dd>
1295 If set to True, do use less graphically intense tabs on the top of the
1296 mainframe.
1297 <br /><br />
1298 </dd>
1300 <dt><b>$cfg['PropertiesIconic'] </b>string</dt>
1301 <dd>
1302 If set to True, will display icons instead of text for db and table
1303 properties links (like 'Browse', 'Select', 'Insert', ...).<br />
1304 Can be set to 'both' if you want icons AND text.<br />
1305 When set to False, will only show text.
1306 <br /><br />
1307 </dd>
1309 <dt><b>$cfg['PropertiesNumColumns'] </b>integer</dt>
1310 <dd>
1311 How many columns will be utilized to display the tables on the
1312 database property view? Default is 1 column. When setting this to a
1313 value larger than 1, the type of the database will be omitted for more
1314 display space.
1315 <br /><br />
1316 </dd>
1319 <dt><b>$cfg['DefaultTabServer'] </b>string</dt>
1320 <dd>
1321 Defines the tab displayed by default on server view. Possible
1322 values: &quot;main.php&quot; (recommended for multi-user setups),
1323 &quot;server_databases.php&quot;, &quot;server_status.php&quot;,
1324 &quot;server_variables.php&quot;, &quot;server_privileges.php&quot;
1325 or &quot;server_processlist.php&quot;.
1326 <br /><br />
1327 </dd>
1329 <dt><b>$cfg['DefaultTabDatabase'] </b>string</dt>
1330 <dd>
1331 Defines the tab displayed by default on database view. Possible
1332 values: &quot;db_details_structure.php&quot;,
1333 &quot;db_details.php&quot; or &quot;db_search.php&quot;.
1334 <br /><br />
1335 </dd>
1337 <dt><b>$cfg['DefaultTabTable'] </b>string</dt>
1338 <dd>
1339 Defines the tab displayed by default on table view. Possible
1340 values: &quot;tbl_properties_structure.php&quot;,
1341 &quot;tbl_properties.php&quot;, &quot;tbl_select.php&quot; or
1342 &quot;tbl_change.php&quot;.
1343 <br /><br />
1344 </dd>
1346 <dt><b>$cfg['MySQLManualBase']</b> string</dt>
1347 <dd>
1348 If set to an URL which points to the MySQL documentation (type depends
1349 on <tt>$cfg['MySQLManualType']</tt>), appropriate help links are
1350 generated.
1351 <br />
1352 See <a href="http://www.mysql.com/documentation/index.html">MySQL
1353 Documentation page</a> for more information about MySQL manuals and
1354 their types.
1355 <br /><br />
1356 </dd>
1358 <dt><b>$cfg['MySQLManualType']</b> string</dt>
1359 <dd>
1360 Type of MySQL documentation:
1361 <ul>
1362 <li>old - old style used in phpMyAdmin 2.3.0 and earlier</li>
1363 <li>searchable - &quot;Searchable, with user comments&quot;</li>
1364 <li>chapters - &quot;HTML, one page per chapter&quot;</li>
1365 <li>big - &quot;HTML, all on one page&quot;</li>
1366 <li>none - do not show documentation links</li>
1367 </ul>
1368 <br /><br />
1369 </dd>
1371 <dt><b>$cfg['DefaultLang'] </b>string</dt>
1372 <dd>
1373 Defines the default language to use, if not browser-defined or
1374 user-defined.<br />
1375 See the <i>select_lang.lib.php</i> script to know the valid values for
1376 this setting.
1377 <br /><br />
1378 </dd>
1380 <dt><b>$cfg['Lang'] </b>string</dt>
1381 <dd>
1382 Force: always use this language (must be defined in the
1383 <i>select_lang.lib.php</i> script).
1384 <br /><br />
1385 </dd>
1387 <dt><b>$cfg['DefaultCharset'] </b>string</dt>
1388 <dd>
1389 Default character set to use for recoding of MySQL queries. This must be
1390 enabled and it's described by <tt>$cfg['AllowAnywhereRecoding']</tt>
1391 option.<br />
1392 You can give here any character set which is in
1393 <tt>$cfg['AvailableCharsets']</tt> array and this is just default
1394 choice, user can select any of them.
1395 <br /><br />
1396 </dd>
1398 <dt><b>$cfg['AllowAnywhereRecoding'] </b>boolean</dt>
1399 <dd>
1400 Allow character set recoding of MySQL queries. You need recode or iconv
1401 support (compiled in or module) in PHP to allow MySQL queries recoding
1402 and used language file must have it enabled (by default only these
1403 which are in Unicode, just to avoid losing some characters).
1404 <br /><br />
1405 Setting this to <tt>TRUE</tt> also activates a pull-down menu
1406 in the Export page, to choose the character set when exporting a file.
1407 <br /><br />
1408 </dd>
1410 <dt><b>$cfg['RecodingEngine'] </b>string</dt>
1411 <dd>
1412 You can select here which functions will be used for character set
1413 conversion.
1414 Possible values are:<br />
1415 <ul>
1416 <li>auto - automatically use available one (first is tested
1417 iconv, then recode)</li>
1418 <li>iconv - use iconv or libiconv functions</li>
1419 <li>recode - use recode_string function</li>
1420 </ul>
1421 Default is auto.
1422 <br /><br />
1423 </dd>
1425 <dt><b>$cfg['IconvExtraParams'] </b>string</dt>
1426 <dd>
1427 Specify some parameters for iconv used in charset conversion. See
1428 <a href="http://www.gnu.org/software/libiconv/documentation/libiconv/iconv_open.3.html">iconv
1429 documentation</a> for details.
1430 <br /><br />
1431 </dd>
1433 <dt><b>$cfg['AvailableCharsets'] </b>array</dt>
1434 <dd>
1435 Available character sets for MySQL conversion. You can add your own (any of
1436 supported by recode/iconv) or remove these which you don't use.
1437 Character sets will be shown in same order as here listed, so if you
1438 frequently use some of these move them to the top.
1439 <br /><br />
1440 </dd>
1442 <dt><b>$cfg['GD2Available'] </b>string</dt>
1443 <dd>
1444 Specifies whether GD &gt;= 2 is available. If yes it can be used for
1445 MIME transformations.<br />
1446 Possible values are:<br />
1447 <ul>
1448 <li>
1449 auto - automatically detect, this is a bit expensive
1450 operation for php &lt; 4.3.0 so it is preferred to change this
1451 according to your server real possibilities
1452 </li>
1453 <li>yes - GD 2 functions can be used</li>
1454 <li>no - GD 2 function cannot be used</li>
1455 </ul>
1456 Default is auto.
1457 <br /><br />
1458 </dd>
1460 <dt><b>$cfg['LeftWidth'] </b>integer</dt>
1461 <dd>
1462 Left frame width in pixel. See <tt>themes/themename/layout.inc.php</tt>.
1463 <br /><br />
1464 </dd>
1466 <dt>
1467 <b>$cfg['LeftBgColor'] </b>string [HTML color]<br />
1468 <b>$cfg['RightBgColor'] </b>string [HTML color]
1469 </dt>
1470 <dd>
1471 The background colors (HTML) used for both the frames.
1472 See <tt>themes/themename/layout.inc.php</tt>.
1473 <br /><br />
1474 </dd>
1476 <dt>
1477 <b>$cfg['RightBgImage'] </b>string
1478 </dt>
1479 <dd>
1480 The URI of the background image used for the right frame. It must be
1481 an absolute URI. See <tt>themes/themename/layout.inc.php</tt>.
1482 </dd>
1484 <dt><b>$cfg['LeftPointerColor'] </b>string [HTML color]</dt>
1485 <dd>
1486 The color (HTML) used for the pointer in the left frame (does not work
1487 with Netscape 4). See <tt>themes/themename/layout.inc.php</tt>.
1488 <br /><br />
1489 </dd>
1491 <dt><b>$cfg['LeftPointerEnable'] </b>boolean</dt>
1492 <dd>
1493 A value of <tt>TRUE</tt> activates the left pointer (when LeftFrameLight is <tt>FALSE</tt>).
1494 <br /><br />
1495 </dd>
1497 <dt><b>$cfg['Border'] </b>integer</dt>
1498 <dd>
1499 The size of a table's border. See <tt>themes/themename/layout.inc.php</tt>.
1500 <br /><br />
1501 </dd>
1503 <dt><b>$cfg['ThBgcolor'] </b>string [HTML color]</dt>
1504 <dd>
1505 The color (HTML) used for table headers. See <tt>themes/themename/layout.inc.php</tt>.
1506 <br /><br />
1507 </dd>
1509 <dt><b>$cfg['BgcolorOne'] </b>string [HTML color]</dt>
1510 <dd>
1511 The color (HTML) #1 for table rows. See <tt>themes/themename/layout.inc.php</tt>.
1512 <br /><br />
1513 </dd>
1515 <dt><b>$cfg['BgcolorTwo'] </b>string [HTML color]</dt>
1516 <dd>
1517 The color (HTML) #2 for table rows. See <tt>themes/themename/layout.inc.php</tt>.
1518 <br /><br />
1519 </dd>
1521 <dt>
1522 <b>$cfg['BrowsePointerColor'] </b>string [HTML color]<br />
1523 <b>$cfg['BrowseMarkerColor'] </b>string [HTML color]
1524 </dt>
1525 <dd>
1526 The colors (HTML) uses for the pointer and the marker in browse mode
1527 (does not work with Netscape 4).<br />
1528 The former feature highlights the row over which your mouse is passing
1529 and the latter lets you visually mark/unmark rows by clicking on
1530 them.<br />
1531 See <tt>themes/themename/layout.inc.php</tt>.
1532 <br /><br />
1533 </dd>
1535 <dt><b>$cfg['BrowsePointerEnable'] </b>boolean</dt>
1536 <dd>
1537 Whether to activate the browse pointer or not.
1538 <br /><br />
1539 </dd>
1541 <dt><b>$cfg['BrowseMarkerEnable'] </b>boolean</dt>
1542 <dd>
1543 Whether to activate the browse marker or not.
1544 <br /><br />
1545 </dd>
1547 <dt>
1548 <b>$cfg['TextareaCols'] </b>integer<br />
1549 <b>$cfg['TextareaRows'] </b>integer<br />
1550 <b>$cfg['CharTextareaCols'] </b>integer<br />
1551 <b>$cfg['CharTextareaRows'] </b>integer
1552 </dt>
1553 <dd>
1554 Number of columns and rows for the textareas.<br />
1555 This value will be emphasized (*2) for SQL query textareas and (*1.25) for
1556 SQL textareas inside the query window.<br />
1557 The Char* values are used for CHAR and VARCHAR editing (if configured
1558 via $cfg['CharEditing']).
1559 <br /><br />
1560 </dd>
1562 <dt>
1563 <b>$cfg['LongtextDoubleTextarea'] </b>boolean<br />
1564 </dt>
1565 <dd>
1566 Defines whether textarea for LONGTEXT fields should have double size.
1567 <br /><br />
1568 </dd>
1570 <dt>
1571 <b>$cfg['TextareaAutoSelect'] </b>boolean<br />
1572 </dt>
1573 <dd>
1574 Defines if the whole textarea of the query box will be selected on
1575 click.
1576 <br /><br />
1577 </dd>
1578 <dt>
1579 <a name="CtrlArrowsMoving"></a><br />
1580 <b>$cfg['CtrlArrowsMoving'] </b>boolean<br />
1581 </dt>
1582 <dd>
1583 Enable Ctrl+Arrows (Option+Arrows in Safari) moving between fields when editing?
1584 <br /><br />
1585 </dd>
1587 <dt><b>$cfg['LimitChars'] </b>integer</dt>
1588 <dd>
1589 Maximal number of Chars showed in any non-numeric
1590 field on browse view. Can be turned off by a toggle button on the
1591 browse page.
1592 <br /><br />
1593 </dd>
1595 <dt>
1596 <b>$cfg['ModifyDeleteAtLeft'] </b>boolean<br />
1597 <b>$cfg['ModifyDeleteAtRight'] </b>boolean
1598 </dt>
1599 <dd>
1600 Defines the place where modify and delete links would be put when
1601 tables contents are displayed (you may have them displayed both at the
1602 left and at the right).
1603 &quot;Left&quot; and &quot;right&quot; are parsed as &quot;top&quot;
1604 and &quot;bottom&quot; with vertical display mode.
1605 <br /><br />
1606 </dd>
1608 <dt><b>$cfg['DefaultDisplay'] </b>string<br />
1609 <b>$cfg['HeaderFlipType'] </b>string
1610 </dt>
1611 <dd>
1612 There are 3 display modes: horizontal, horizontalflipped and vertical.
1613 Define which one is displayed by default. The first mode displays each
1614 row on a horizontal line, the second rotates the headers by 90
1615 degrees, so you can use descriptive headers even though fields only
1616 contain small values and still print them out. The vertical mode sorts
1617 each row on a vertical lineup.
1618 <br /><br />
1619 The HeaderFlipType can be set to 'css' or 'faked'. When using 'css'
1620 the rotation of the header for horizontalflipped is done via CSS. If
1621 set to 'faked' PHP does the transformation for you, but of course this
1622 does not look as good as CSS.
1623 <br /><br />
1624 </dd>
1625 <dt>
1627 <a name="DefaultPropDisplay"></a><br />
1628 <b>$cfg['DefaultPropDisplay'] </b>string</dt>
1629 <dd>
1630 When editing/creating new columns in a table all fields normally get
1631 lined up one field a line. (default: 'horizontal'). If you set this to
1632 'vertical' you can have each field lined up vertically beneath each
1633 other. You can save up a lot of place on the horizontal direction and
1634 no longer have to scroll.
1635 <br /><br />
1636 </dd>
1638 <dt><b>$cfg['ShowBrowseComments'] </b>boolean<br />
1639 <b>$cfg['ShowPropertyComments'] </b>boolean<br />
1640 </dt>
1641 <dd>
1642 By setting the corresponding variable to <tt>TRUE</tt> you can enable the
1643 display of column comments in Browse or Property display. In browse
1644 mode, the comments are show inside the header. In property mode,
1645 comments are displayed using a CSS-formatted dashed-line below the
1646 name of the field. The comment is shown as a tool-tip for that field.
1647 <br /><br />
1648 </dd>
1650 <dt><b>$cfg['UploadDir'] </b>string</dt>
1651 <dd>
1652 The name of the directory, where SQL files have been uploaded by other
1653 means than phpMyAdmin (for example, ftp). Those files are available
1654 under a drop-down box when you click the database name, then the SQL
1655 tab.
1656 <br /><br />
1657 Please note that the file names must have the suffix &quot;.sql&quot;
1658 (or &quot;.sql.bz2&quot; or &quot;.sql.gz&quot; if support for
1659 compressed formats is enabled).
1660 <br /><br />
1661 This feature is useful when your file is too big to be uploaded via
1662 HTTP, or when file uploads are disabled in PHP.
1663 <br /><br />
1664 Please note that if PHP is running in safe mode, this directory must
1665 be owned by the same user as the owner of the phpMyAdmin scripts.
1666 <br /><br />
1667 See also <a href="#faq1_16">FAQ 1.16</a> for alternatives.
1668 <br /><br />
1669 </dd>
1671 <dt><b>$cfg['docSQLDir'] </b>string</dt>
1672 <dd>
1673 The name of the directory, where docSQL files can be uploaded for
1674 import into phpMyAdmin.
1675 <br /><br />
1676 Please note that if PHP is running in safe mode, this directory must
1677 be owned by the same user as the owner of the phpMyAdmin scripts.
1678 <br /><br />
1679 </dd>
1681 <dt><b>$cfg['SaveDir'] </b>string</dt>
1682 <dd>
1683 The name of the directory, where dumps can be saved.
1684 <br /><br />
1685 Please note that the directory has to be writable for user running
1686 webserver.
1687 <br /><br />
1688 Please note that if PHP is running in safe mode, this directory must
1689 be owned by the same user as the owner of the phpMyAdmin scripts.
1690 <br /><br />
1691 </dd>
1693 <dt><b>$cfg['TempDir'] </b>string</dt>
1694 <dd>
1695 The name of the directory, where temporary files can be stored.
1696 <br /><br />
1697 This is needed for native MS Excel export, see <a href="#faq6_23">FAQ
1698 6.23</a>
1699 <br /><br />
1700 </dd>
1702 <dt><b>$cfg['Export'] </b>array</dt>
1703 <dd>
1704 In this array are defined default parameters for export, names of
1705 items are similar to texts seen on export page, so you can easily
1706 identify what they mean.
1707 <br /><br />
1708 </dd>
1710 <dt><b>$cfg['RepeatCells'] </b>integer</dt>
1711 <dd>
1712 Repeat the headers every X cells, or 0 to deactivate.
1713 <br /><br />
1714 </dd>
1716 <dt><b>$cfg['QueryFrame'] </b>boolean<br />
1717 <b>$cfg['QueryFrameJS'] </b>boolean<br />
1718 <b>$cfg['QueryWindowWidth'] </b>integer<br />
1719 <b>$cfg['QueryWindowHeight'] </b>integer<br />
1720 <b>$cfg['QueryHistoryDB'] </b>boolean<br />
1721 <b>$cfg['QueryWindowDefTab'] </b>string<br />
1722 <b>$cfg['QueryHistoryMax'] </b>integer
1723 </dt>
1724 <dd>
1725 All those variables affect the query box feature. When
1726 $cfg['QueryFrame'] is set to true, a link or icon is displayed
1727 on the left panel. Clicking on it opens the query box, a direct
1728 interface to enter SQL queries.
1729 <br /><br />
1730 When $cfg['QueryFrameJS'] is set to true, clicking on that link opens
1731 the query box, a new custom sized browser window
1732 ($cfg['QueryWindowWidth'], $cfg['QueryWindowWidth'] - both integers
1733 for the size in pixels).
1734 Also, a click on [Edit] from the results page (in the &quot;Showing
1735 Rows&quot; section) opens the query box and puts the current query
1736 inside it. If set to false, clicking on the link only opens the SQL
1737 input in the main frame.
1738 <br /><br />
1739 The usage of the JavaScript query window is recommended if you have a
1740 JavaScript enabled browser. Basic functions are used to exchange quite
1741 a few variables, so most 4th generation browsers should be capable to
1742 use that feature. It currently is only tested with Internet Explorer 6
1743 and Mozilla 1.x.
1744 <br /><br />
1745 If $cfg['QueryHistoryDB'] is set to <tt>TRUE</tt>, all your Queries are logged
1746 to a table, which has to be created by you (see <a
1747 href="#history">$cfg['Servers'][$i]['history']</a>). If set to FALSE,
1748 all your queries will be appended to the form, but only as long as
1749 your window is opened they remain saved.
1750 <br /><br />
1751 When using the JavaScript based query window, it will always get
1752 updated when you click on a new table/db to browse and will focus if
1753 you click on "Edit SQL" after using a query. You can suppress updating
1754 the query window by checking the box "Do not overwrite this query from
1755 outside the window" below the query textarea. Then you can browse
1756 tables/databases in the background without losing the contents of the
1757 textarea, so this is especially useful when composing a query with
1758 tables you first have to look in. The checkbox will get automatically
1759 checked whenever you change the contents of the textarea. Please
1760 uncheck the button whenever you definitely want the query window to
1761 get updated even though you have made alterations.
1762 <br /><br />
1763 If $cfg['QueryHistoryDB'] is set to <tt>TRUE</tt> you can specify the amount of
1764 saved history items using $cfg['QueryHistoryMax'].
1765 <br /><br />
1766 The query window also has a custom tabbed look to group the features.
1767 Using the variable $cfg['QueryWindowDefTab'] you can specify the
1768 default tab to be used when opening the query window. It can be set to
1769 either 'sql', 'files', 'history' or 'full'.
1770 <br /><br />
1771 </dd>
1773 <dt><b>$cfg['BrowseMIME'] </b>boolean</dt>
1774 <dd>
1775 Enable <a href="#transformations">MIME-transformations</a>.
1776 <br /><br />
1777 </dd>
1779 <dt><b>$cfg['MaxExactCount'] </b>integer</dt>
1780 <dd>
1781 Determines for how large tables phpMyAdmin should get exact row count by
1782 <code>SELECT COUNT</code>. If approximate row count is smaller than this
1783 value, <code>SELECT COUNT</code> will be used, otherwise only value
1784 returned by <code>SHOW TABLE STATUS</code>. This has currently an impact
1785 only on InnoDB tables.
1786 <br /><br />
1787 </dd>
1789 <dt><a name="wysiwyg"></a>
1790 <b>$cfg['WYSIWYG-PDF'] </b>boolean</dt>
1791 <dd>
1792 Utilizes a WYSIWYG editing control to easily place elements of a PDF
1793 page. By clicking on the button 'toggle scratchboard' on the page
1794 where you edit x/y coordinates of those elements you can activate a
1795 scratchboard where all your elements are placed. By clicking on an
1796 element, you can move them around in the pre-defined area and the x/y
1797 coordinates will get updated dynamically. Likewise, when entering a
1798 new position directly into the input field, the new position in the
1799 scratchboard changes after your cursor leaves the input field.
1800 <br />
1801 You have to click on the 'OK'-button below the tables to save the new
1802 positions. If you want to place a new element, first add it to the
1803 table of elements and then you can drag the new element around.
1804 <br />
1805 By changing the paper size and the orientation you can change the size
1806 of the scratchboard as well. You can do so by just changing the
1807 dropdown field below, and the scratchboard will resize automatically,
1808 without interfering with the current placement of the elements.
1809 <br />
1810 If ever an element gets out of range you can either enlarge the paper
1811 size or click on the 'reset' button to place all elements below each
1812 other.
1813 <br />
1814 <b>NOTE:</b> You have to use a recent browser like IE6 or Mozilla to
1815 get this control to work. The basic Drag&amp;Drop script functionality
1816 was kindly borrowed from www.youngpup.net and is underlying so
1817 specific license.
1818 <br /><br />
1819 </dd>
1821 <dt><b>$cfg['NaturalOrder'] </b>boolean</dt>
1822 <dd>
1823 Sorts database and table names according to natural order (for example,
1824 t1, t2, t10). Currently implemented in the left panel (Light mode)
1825 and in Database view, for the table list.
1826 <br /><br />
1827 </dd>
1829 <dt><b>$cfg['ShowHttpHostTitle'] </b>boolean</dt>
1830 <dd>
1831 Shows the HTTP host name in window's title bar.
1832 <br /><br />
1833 </dd>
1835 <dt><b>$cfg['SetHttpHostTitle'] </b>string</dt>
1836 <dd>
1837 If <tt>$cfg['ShowHttpHostTitle']</tt> is <tt>TRUE</tt>, it shows the real
1838 HTTP host name, unless an alternate name is set here.
1839 <br /><br />
1840 </dd>
1842 <dt><b>$cfg['ErrorIconic'] </b>boolean</dt>
1843 <dd>
1844 Uses icons for warnings, errors and informations.
1845 <br /><br />
1846 </dd>
1848 <dt><b>$cfg['MainPageIconic'] </b>boolean</dt>
1849 <dd>
1850 Uses icons on main page in lists and menu tabs.
1851 <br /><br />
1852 </dd>
1854 <dt><b>$cfg['ReplaceHelpImg'] </b>boolean</dt>
1855 <dd>
1856 Shows a help button instead of the &quot;Documentation&quot; message.
1857 <br /><br />
1858 </dd>
1860 <dt><b>$cfg['ThemePath'] </b>string</dt>
1861 <dd>
1862 If theme manager is active, use this as the path of the subdirectory
1863 containing all the themes.
1864 <br /><br />
1865 </dd>
1867 <dt><b>$cfg['ThemeManager'] </b>boolean</dt>
1868 <dd>
1869 Enables user-selectable themes. See <a href="#faqthemes">FAQ 2.7</a>.
1870 <br /><br />
1871 </dd>
1873 <dt><b>$cfg['ThemeDefault'] </b>string</dt>
1874 <dd>
1875 The default theme (a subdirectory under <tt>cfg['ThemePath']</tt>).
1876 <br /><br />
1877 </dd>
1879 <dt><b>$cfg['ThemePerServer'] </b>boolean</dt>
1880 <dd>
1881 Whether to allow different theme for each server.
1882 <br /><br />
1883 </dd>
1885 <dt><b>$cfg['DefaultQueryTable']</b> string</dt>
1886 <dt><b>$cfg['DefaultQueryDatabase']</b> string</dt>
1887 <dd>
1888 Default queries that will be displayed in query boxes when user didn't
1889 specify any. Use %d for database name, %t for table name and %f for a
1890 comma separated list of field names. Note that %t and %f are only
1891 applicable to $cfg['DefaultQueryTable'].
1892 <br /><br />
1893 </dd>
1895 <dt><b>$cfg['SQP']['fmtType']</b> string [<tt>html</tt>|<tt>none</tt>]</dt>
1896 <dd>
1897 The main use of the new SQL Parser is to pretty-print SQL queries. By
1898 default we use HTML to format the query, but you can disable this by
1899 setting this variable to <tt>'none'</tt>.
1900 <br /><br />
1901 </dd>
1903 <dt><b>$cfg['SQP']['fmtInd']</b> float<br />
1904 <b>$cfg['SQP']['fmtIndUnit']</b> string [<tt>em</tt>|<tt>px</tt>|<tt>pt</tt>|<tt>ex</tt>]</dt>
1905 <dd>
1906 For the pretty-printing of SQL queries, under some cases the part of a
1907 query inside a bracket is indented. By changing
1908 <tt>$cfg['SQP']['fmtInd']</tt> you can change the amount of this indent.
1909 <br />Related in purpose is <tt>$cfg['SQP']['fmtIndUnit']</tt> which
1910 specifies the units of the indent amount that you specified. This is
1911 used via stylesheets.
1912 <br /><br />
1913 </dd>
1915 <dt><b>$cfg['SQP']['fmtColor']</b> array of string tuples</dt>
1916 <dd>
1917 This array is used to define the colours for each type of element of
1918 the pretty-printed SQL queries. The tuple format is<br />
1919 <i>class</i> =&gt; [<i>HTML colour code</i> | <i>empty string</i>]<br />
1920 If you specify an empty string for the color of a class, it is ignored
1921 in creating the stylesheet.
1922 You should not alter the class names, only the colour strings.<br />
1923 <b>Class name key:</b><br />
1924 <ul>
1925 <li><b>comment</b> Applies to all comment sub-classes</li>
1926 <li><b>comment_mysql</b> Comments as <tt>"#...\n"</tt></li>
1927 <li><b>comment_ansi</b> Comments as <tt>"-- ...\n"</tt></li>
1928 <li><b>comment_c</b> Comments as <tt>"/*...*/"</tt></li>
1929 <li><b>digit</b> Applies to all digit sub-classes</li>
1930 <li><b>digit_hex</b> Hexadecimal numbers</li>
1931 <li><b>digit_integer</b> Integer numbers</li>
1932 <li><b>digit_float</b> Floating point numbers</li>
1933 <li><b>punct</b> Applies to all punctuation sub-classes</li>
1934 <li><b>punct_bracket_open_round</b> Opening brackets<tt>"("</tt></li>
1935 <li><b>punct_bracket_close_round</b> Closing brackets <tt>")"</tt></li>
1936 <li><b>punct_listsep</b> List item Separator <tt>","</tt></li>
1937 <li><b>punct_qualifier</b> Table/Column Qualifier <tt>"."</tt> </li>
1938 <li><b>punct_queryend</b> End of query marker <tt>";"</tt></li>
1939 <li><b>alpha</b> Applies to all alphabetic classes</li>
1940 <li><b>alpha_columnType</b> Identifiers matching a column type</li>
1941 <li><b>alpha_columnAttrib</b> Identifiers matching a database/table/column attribute</li>
1942 <li><b>alpha_functionName</b> Identifiers matching a MySQL function name</li>
1943 <li><b>alpha_reservedWord</b> Identifiers matching any other reserved word</li>
1944 <li><b>alpha_variable</b> Identifiers matching a SQL variable <tt>"@foo"</tt></li>
1945 <li><b>alpha_identifier</b> All other identifiers</li>
1946 <li><b>quote</b> Applies to all quotation mark classes</li>
1947 <li><b>quote_double</b> Double quotes <tt>"</tt></li>
1948 <li><b>quote_single</b> Single quotes <tt>'</tt></li>
1949 <li><b>quote_backtick</b> Backtick quotes <tt>`</tt></li>
1950 </ul><br />
1951 </dd>
1953 <dt><b>$cfg['SQLValidator']['use']</b> boolean</dt>
1954 <dd>
1955 phpMyAdmin now supports use of the <a href="http://developer.mimer.com/validator/index.htm">Mimer SQL Validator</a> service,
1956 as originally published on
1957 <a href="http://developers.slashdot.org/article.pl?sid=02/02/19/1720246">Slashdot</a>.
1958 <br />
1959 For help in setting up your system to use the service, see the
1960 <a href="#faqsqlvalidator">FAQ #6.14</a>.
1961 <br /><br />
1962 </dd>
1964 <dt><b>$cfg['SQLValidator']['username']</b> string<br />
1965 <b>$cfg['SQLValidator']['password']</b> string</dt>
1966 <dd>
1967 The SOAP service allows you to login with <tt>anonymous</tt>
1968 and any password, so we use those by default. Instead, if
1969 you have an account with them, you can put your login details
1970 here, and it will be used in place of the anonymous login.
1971 <br /><br />
1972 </dd>
1974 <dt><b>$cfg['DBG']['enable']</b> boolean</dt>
1975 <dd>
1976 <b>DEVELOPERS ONLY!</b><br />
1977 Enable the DBG extension for debugging phpMyAdmin. Required for profiling
1978 the code.
1979 <br />
1980 For help in setting up your system to this, see the
1981 <a href="#developersdbg">Developers</a> section.
1982 </dd>
1984 <dt><b>$cfg['DBG']['profile']['enable']</b> boolean</dt>
1985 <dd>
1986 <b>DEVELOPERS ONLY!</b><br />
1987 Enable profiling support for phpMyAdmin. This will append a chunk of data
1988 to the end of every page displayed in the main window with profiling
1989 statistics for that page.<br />
1990 You may need to increase the maximum execution time for this to
1991 complete successfully.
1992 </dd>
1994 <dt><b>$cfg['DBG']['profile']['threshold']</b> float (units in milliseconds)</dt>
1995 <dd>
1996 <b>DEVELOPERS ONLY!</b><br />
1997 When profiling data is displayed, this variable controls the threshold of
1998 display for any profiling data, based on the average time each time has
1999 taken. If it is over the threshold it is displayed, otherwise it is not
2000 displayed. This takes a value in milliseconds. In most cases you don't need
2001 to edit this.
2002 </dd>
2004 <dt><b>$cfg['ColumnTypes'] </b>array</dt>
2005 <dd>
2006 All possible types of a MySQL column. In most cases you don't need to
2007 edit this.
2008 <br /><br />
2009 </dd>
2011 <dt><b>$cfg['AttributeTypes'] </b>array</dt>
2012 <dd>
2013 Possible attributes for fields. In most cases you don't need to edit
2014 this.
2015 <br /><br />
2016 </dd>
2018 <dt><b>$cfg['Functions'] </b>array</dt>
2019 <dd>
2020 A list of functions MySQL supports. In most cases you don't need to
2021 edit this.
2022 <br /><br />
2023 </dd>
2025 <dt><b>$cfg['RestrictColumnTypes'] </b>array</dt>
2026 <dd>
2027 Mapping of column types to meta types used for preferring displayed
2028 functions. In most cases you don't need to edit this.
2029 <br /><br />
2030 </dd>
2032 <dt><b>$cfg['RestrictFunctions'] </b>array</dt>
2033 <dd>
2034 Functions preferred for column meta types as defined in
2035 <code>$cfg['RestrictColumnTypes']</code>. In most cases you don't need
2036 to edit this.
2037 <br /><br />
2038 </dd>
2040 <dt><b>$cfg['DefaultFunctions'] </b>array</dt>
2041 <dd>
2042 Functions selected by default when insering/changing row, Functions
2043 are defined for meta types from
2044 <code>$cfg['RestrictColumnTypes']</code> and for
2045 <code>first_timestamp</code>, which is used for first timestamp column
2046 in table.
2047 <br /><br />
2048 </dd>
2050 <dt><b>$cfg['NumOperators'] </b>array</dt>
2051 <dd>
2052 Operators available for search operations on numeric and date fields.
2053 <br /><br />
2054 </dd>
2056 <dt><b>$cfg['TextOperators'] </b>array</dt>
2057 <dd>
2058 Operators available for search operations on character fields.
2059 Note that we put <code>LIKE</code> by default instead of
2060 <code>LIKE %...%</code>, to avoid unintended performance problems
2061 in case of huge tables.
2062 <br /><br />
2063 </dd>
2065 <dt><b>$cfg['EnumOperators'] </b>array</dt>
2066 <dd>
2067 Operators available for search operations on enum fields.
2068 <br /><br />
2069 </dd>
2071 <dt><b>$cfg['NullOperators'] </b>array</dt>
2072 <dd>
2073 Additionnal operators available for search operations when the
2074 field can be null.
2075 <br /><br />
2076 </dd>
2078 </dl>
2080 <!-- TRANSFORMATIONS -->
2081 <a name="transformations"></a><br />
2082 <h2>Transformations</h2>
2085 <a href="#transformationsintro">Introduction</a> &nbsp;-&nbsp;
2086 <a href="#transformationshowto">Usage</a> &nbsp;-&nbsp;
2087 <a href="#transformationsfiles">File structure</a>
2088 </p>
2090 <a name="transformationsintro"></a><br />
2091 <h3>[1. Introduction]</h3>
2093 <p>To enable transformations, you have to setup the column_info table and the proper
2094 directives. Please see the <a href="#config">Configuration section</a> on how to do so.</p>
2095 <br />
2097 <p>You can apply different transformations to the contents of each field. The
2098 transformation will take the content of each field and transform it with
2099 certain rules defined in the selected transformation.</p><br />
2101 <p>Say you have a field 'filename' which contains a filename. Normally you would see
2102 in phpMyAdmin only this filename. Using transformations you can transform that filename
2103 into a HTML link, so you can click inside of the phpMyAdmin structure on the field's
2104 link and will see the file displayed in a new browser window. Using transformation
2105 options you can also specify strings to append/prepend to a string or the format you
2106 want the output stored in.</p><br />
2108 <p>For a general overview of all available transformations and their options, you can
2109 consult your <i>&lt;www.your-host.com&gt;/&lt;your-install-dir&gt;/libraries/transformations/overview.php</i>
2110 installation.</p>
2112 <p><br />For a tutorial on how to effectively use transformations, see our <a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a> on the official phpMyAdmin-homepage.</p>
2114 <a name="transformationshowto"></a><br />
2115 <h3>[2. Usage]</h3>
2117 <p>Go to your <i>tbl_properties.inc.php</i> page (i.e. reached through clicking on the
2118 'properties' link for a table). There click on &quot;Change&quot; (or change
2119 icon) and there you will see three new fields at the end of the line. They are
2120 called 'MIME-type', 'Browser transformation' and 'Transformation options'.</p>
2121 <br />
2123 <ul>
2124 <li>The field 'MIME-type' is a dropdown field. You have the options to leave that field
2125 empty or to use 'auto' [this feature is not yet available]. Please note that
2126 transformations are inactive as long as no MIME-type is selected.</li>
2128 <li>The field 'Browser transformation' is a drop-down field. You can choose from a
2129 hopefully growing amount of pre-defined transformations. See below for information on
2130 how to build your own transformation.<br />
2132 There are global transformations and mimetype-bound transformations. Global transformations
2133 can be used for any mimetype. They will take the mimetype, if necessary, into regard.
2134 Mimetype-bound transformations usually only operate on a certain mimetype. There are
2135 transformations which operate on the main mimetype (like 'image'), which will most likely
2136 take the subtype into regard, and those who only operate on a
2137 specific subtype (like 'image/jpeg').<br />
2139 You can use transformations on mimetypes for which the function was not defined for. There
2140 is no security check for you selected the right transformation, so take care of what the
2141 output will be like.</li>
2143 <li>The field 'Transformation options' is a free-type textfield. You have to enter
2144 transform-function specific options here. Usually the transforms can operate with default
2145 options, but it is generally a good idea to look up the overview to see which options are
2146 necessary.<br />
2148 Much like the ENUM/SET-Fields, you have to split up several options using the format
2149 'a','b','c',...(NOTE THE MISSING BLANKS). This is because internally the options will be
2150 parsed as an array, leaving the first value the first element in the array, and so
2151 forth.<br />
2153 If you want to specify a MIME character set you can define it in the transformation_options.
2154 You have to put that outside of the pre-defined options of the specific mime-transform,
2155 as the last value of the set. Use the format "'; charset=XXX'". If you use a transform,
2156 for which you can specify 2 options and you want to append a character set, enter "'first
2157 parameter','second parameter','charset=us-ascii'". You can, however use the defaults for
2158 the parameters: "'','','charset=us-ascii'".</li>
2159 </ul>
2161 <a name="transformationsfiles"></a><br />
2162 <h3>[3. File structure]</h3>
2164 <p>All mimetypes and their transformations are defined through single files in
2165 the directory 'libraries/transformations/'.</p><br />
2167 <p>They are stored in files to ease up customization and easy adding of new
2168 transformations.</p><br />
2170 <p>Because the user cannot enter own mimetypes, it is kept sure that transformations
2171 always work. It makes no sense to apply a transformation to a mimetype, the
2172 transform-function doesn't know to handle.</p><br />
2174 <p>One can, however, use empty mime-types and global transformations which should work
2175 for many mimetypes. You can also use transforms on a different mimetype they where built
2176 for, but pay attention to option usage as well as what the transformation does to your
2177 field.</p><br />
2179 <p>There is a basic file called '<i>global.inc.php</i>'. This function can be included by
2180 any other transform function and provides some basic functions.</p><br />
2182 <p>There are 5 possible file names:</p>
2184 <ol>
2185 <li>A mimetype+subtype transform:<br /><br />
2187 [mimetype]_[subtype]__[transform].inc.php<br /><br />
2189 Please not that mimetype and subtype are separated via '_', which shall not be
2190 contained in their names. The transform function/filename may contain only
2191 characters which cause no problems in the file system as well as the PHP function
2192 naming convention.<br /><br />
2194 The transform function will the be called 'PMA_transform_[mimetype]_[subtype]__[transform]()'.<br /><br />
2196 <b>Example:</b><br /><br />
2198 text_html__formatted.inc.php<br />
2199 PMA_transform_text_html__formatted()</li>
2201 <li>A mimetype (w/o subtype) transform:<br /><br />
2203 [mimetype]__[transform].inc.php<br /><br />
2205 Please note that there are no single '_' characters.
2206 The transform function/filename may contain only characters which cause no problems
2207 in the file system as well as the PHP function naming convention.<br /><br />
2209 The transform function will the be called 'PMA_transform_[mimetype]__[transform]()'.<br /><br />
2211 <b>Example:</b><br /><br />
2213 text__formatted.inc.php<br />
2214 PMA_transform_text__formatted()</li>
2216 <li>A mimetype+subtype without specific transform function<br /><br />
2218 [mimetype]_[subtype].inc.php<br /><br />
2220 Please note that there are no '__' characters in the filename. Do not use special
2221 characters in the filename causing problems with the file system.<br /><br />
2223 No transformation function is defined in the file itself.<br /><br />
2225 <b>Example:</b><br /><br />
2227 text_plain.inc.php<br />
2228 (No function)</li>
2230 <li>A mimetype (w/o subtype) without specific transform function<br /><br />
2232 [mimetype].inc.php<br /><br />
2234 Please note that there are no '_' characters in the filename. Do not use special
2235 characters in the filename causing problems with the file system.<br /><br />
2237 No transformation function is defined in the file itself.<br /><br />
2239 <b>Example:</b><br /><br />
2241 text.inc.php<br />
2242 (No function)</li>
2244 <li>A global transform function with no specific mimetype<br /><br />
2246 global__[transform].inc.php<br /><br />
2248 The transform function will the be called 'PMA_transform_global__[transform]()'.<br /><br />
2250 <b>Example:</b><br /><br />
2252 global__formatted<br />
2253 PMA_transform_global__formatted()</li>
2254 </ol>
2256 <br />
2257 <p>So generally use '_' to split up mimetype and subtype, and '__' to provide a
2258 transform function.</p><br />
2260 <p>All filenames containing no '__' in themselves are not shown as valid transform
2261 functions in the dropdown.</p><br />
2263 <p>Please see the libraries/transformations/TEMPLATE file for adding your own transform
2264 function. See the libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
2265 without a transform function. Also note the introduction of a function description in
2266 the language files. For each function a $strTransformation_[filename without .inc.php]
2267 has to exist.</p><br />
2269 <p>You can use the template generator to generate new functions and entries in the
2270 language file.</p><br />
2272 <p>To create a new transform function please see libraries/transformations/template_generator.sh.
2273 To create a new, empty mimetype please see libraries/transformations/template_generator_mimetype.sh.</p><br />
2275 <p>A transform function always gets passed three variables:</p>
2276 <ol>
2277 <li><b>$buffer</b> - Contains the text inside of the column. This is the text, you want to transform.</li>
2278 <li><b>$options</b> - Contains any user-passed options to a transform function as an array.</li>
2279 <li><b>$meta</b> - Contains an object with field information to your column. The data is drawn from the output of the
2280 <a href="http://www.php.net/mysql_fetch_field">mysql_fetch_field()</a> function. This means, all object properties described
2281 on the <a href="http://www.php.net/mysql_fetch_field">manual page</a> are available in this variable and can be used to
2282 transform a field accordingly to unsigned/zerofill/not_null/... properties.<br />
2283 The $meta-&gt;mimetype variable contains the original MIME-type of the field (i.e. 'text/plain', 'image/jpeg' etc.)</li>
2284 </ol>
2286 <!-- FAQ -->
2287 <a name="faq"></a><br />
2288 <h2>FAQ - Frequently Asked Questions</h2>
2291 <a href="#faqserver">Server</a> &nbsp;-&nbsp;
2292 <a href="#faqconfig">Configuration</a> &nbsp;-&nbsp;
2293 <a href="#faqlimitations">Limitations</a> &nbsp;-&nbsp;
2294 <a href="#faqmultiuser">Multi-user</a> &nbsp;-&nbsp;
2295 <a href="#faqbrowsers">Browsers</a> &nbsp;-&nbsp;
2296 <a href="#faqusing">Usage tips</a> &nbsp;-&nbsp;
2297 <a href="#faqproject">Project</a> &nbsp;-&nbsp;
2298 <a href="#faqsecurity">Security</a>
2299 </p>
2301 <p><br />
2302 Please have a look at our <a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a> on the official phpMyAdmin homepage for in-depth coverage of phpMyAdmin's features and/or interface.
2303 </p>
2305 <a name="faqserver"></a><br />
2306 <h3>[1. Server]</h3>
2308 <a name="faq1_1"></a>
2309 <h4>
2310 [<a href="#faq1_1">1.1</a>] I'm running PHP 4+ and my server is crashing each time a specific
2311 action is required or phpMyAdmin sends a blank page or a page full of
2312 cryptic characters to my browser, what can I do?
2313 </h4>
2315 There are some known PHP bugs with output buffering and compression.<br />
2316 Try to set the <tt>$cfg['OBGzip']</tt> directive to <tt>FALSE</tt> in your
2317 <i>config.inc.php</i> file and the
2318 <tt>zlib.output_compression</tt> directive to <tt>Off</tt> in your php
2319 configuration file.<br />
2320 Furthermore, we know about such problems connected to the release
2321 candidates of PHP 4.2.0 (tested with PHP 4.2.0 RC1 to RC4) together with
2322 MS Internet Explorer. Please upgrade to the release version PHP 4.2.0.
2323 </p>
2325 <a name="faq1_2"></a>
2326 <h4>
2327 [<a href="#faq1_2">1.2</a>] My Apache server crashes when using phpMyAdmin.
2328 </h4>
2330 You should first try the latest versions of Apache (and possibly MySQL).
2331 <br />
2332 See also the other FAQ entry about PHP bugs with output buffering.
2333 <br />
2334 If your server keeps crashing, please ask for help in the various
2335 Apache support groups.
2336 </p>
2338 <a name="faq1_3"></a>
2339 <h4>
2340 [<a href="#faq1_3">1.3</a>] I'm running phpMyAdmin with "cookie" authentication mode under
2341 PHP 4.2.0 or 4.2.1 loaded as an Apache 2+ module but can't enter the
2342 script: I'm always displayed the login screen.
2343 </h4>
2345 This is a known PHP bug (see this
2346 <a href="http://bugs.php.net/bug.php?id=16626">bug report</a>) from the
2347 official PHP bug database. It means there is and won't be any phpMyAdmin
2348 fix against it because there is no way to code a fix.
2349 </p>
2351 <a name="faq1_4"></a>
2352 <h4>
2353 [<a href="#faq1_4">1.4</a>] Using phpMyAdmin on IIS, I'm displayed the error message:
2354 &quot;The specified CGI application misbehaved by not returning a
2355 complete set of HTTP headers...&quot;.
2356 </h4>
2358 You just forgot to read the <i>install.txt</i> file from the php
2359 distribution. Have a look at the last message in this
2360 <a href="http://bugs.php.net/bug.php?id=12061">bug report</a> from the
2361 official PHP bug database.
2362 </p>
2364 <a name="faq1_5"></a>
2365 <h4>
2366 [<a href="#faq1_5">1.5</a>] Using phpMyAdmin on IIS, I'm facing crashes and/or many error
2367 messages with the HTTP or advanced authentication mode.
2368 </h4>
2370 This is a known problem with the PHP ISAPI filter: it's not so stable.
2371 Please use instead the cookie authentication mode.
2372 </p>
2374 <a name="faq1_6"></a>
2375 <h4>
2376 [<a href="#faq1_6">1.6</a>] I can't use phpMyAdmin on PWS: nothing is displayed!</h4>
2378 This seems to be a PWS bug. Filippo Simoncini found a workaround (at this
2379 time there is no better fix): remove or comment the <tt>DOCTYPE</tt>
2380 declarations (2 lines) from the scripts <i>header.inc.php</i>,
2381 <i>header_printview.inc.php</i>, <i>index.php</i>, <i>left.php</i> and
2382 <i>libraries/common.lib.php</i>.
2383 </p>
2385 <a name="faq1_7"></a>
2386 <h4>
2387 [<a href="#faq1_7">1.7</a>] How can I GZip or Bzip a dump or a CSV export. It does not seem to
2388 work.
2389 </h4>
2391 These features are based on the <tt>gzencode()</tt> and
2392 <tt>bzcompress()</tt> PHP functions to be more independent of the platform
2393 (Unix/Windows, Safe Mode or not, and so on).
2394 So, you must have PHP4&nbsp;>=&nbsp;4.0.4 and Zlib/Bzip2 support
2395 (<tt>--with-zlib</tt> and <tt>--with-bz2</tt>).<br />
2396 We faced PHP crashes when trying to download a dump with MS Internet
2397 Explorer when phpMyAdmin is run with a release candidate of PHP 4.2.0. In
2398 this case you should switch to the release version of PHP 4.2.0.
2399 </p>
2401 <a name="faq1_8"></a>
2402 <h4>
2403 [<a href="#faq1_8">1.8</a>] I cannot insert a text file in a table, and I get an error about
2404 safe mode being in effect.
2405 </h4>
2407 Your uploaded file is saved by PHP in the &quot;upload dir&quot;, as
2408 defined in <i>php.ini</i> by the variable <tt>upload_tmp_dir</tt> (usually
2409 the system default is <i>/tmp</i>).
2410 <br />
2411 We recommend the following setup for Apache servers running in safe mode,
2412 to enable uploads of files while being reasonably secure:
2413 </p>
2414 <ul>
2415 <li>create a separate directory for uploads:
2416 <tt>mkdir /tmp/php</tt></li>
2417 <li>give ownership to the Apache server's user.group:
2418 <tt>chown apache.apache /tmp/php</tt></li>
2419 <li>give proper permission: <tt>chmod 600 /tmp/php</tt></li>
2420 <li>put <tt>upload_tmp_dir = /tmp/php</tt> in <i>php.ini</i></li>
2421 <li>restart Apache</li>
2422 </ul>
2424 <a name="faq1_9"></a>
2425 <h4>
2426 [<a href="#faq1_9">1.9</a>] I'm having troubles when uploading files. In general file uploads
2427 don't work on my system and uploaded files have a <tt>Content-Type:</tt>
2428 header in the first line.
2429 </h4>
2431 It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat 7.0
2432 and you updated your PHP RPM to php-4.0.4pl1-3.i386.rpm, didn't you?
2433 <br />
2434 So the problem is that this package has a serious bug that was corrected
2435 ages ago in PHP (2001-01-28: see
2436 <a href="http://www.php.net/bugs.php?id=8966">PHP's bug tracking system</a>
2437 for more details). The problem is that the bugged package is still
2438 available though it was corrected (see
2439 <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=24933">RedHat's BugZilla</a>
2440 for more details).
2441 <br />
2442 So please download
2443 <a href="http://www.redhat.com/swr/i386/php-4.0.4pl1-9.i386.html">the fixed package (4.0.4pl1-9)</a>
2444 and the problem should go away.
2445 <br />
2446 And that fixes the \r\n problem with file uploads!
2447 </p>
2449 <a name="faq1_10"></a>
2450 <h4>
2451 [<a href="#faq1_10">1.10</a>] I'm having troubles when uploading files with phpMyAdmin running
2452 on a secure server. My browser is Internet Explorer and I'm using the
2453 Apache server.
2454 </h4>
2456 As suggested by &quot;Rob M&quot; in the phpWizard forum, add this line to
2457 your <i>httpd.conf</i>:<br />
2458 &nbsp;&nbsp;&nbsp;&nbsp;<tt>SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown</tt><br />
2459 It seems to clear up many problems between Internet Explorer and SSL.
2460 </p>
2462 <a name="faq1_11"></a>
2463 <h4>
2464 [<a href="#faq1_11">1.11</a>] I get an 'open_basedir restriction' while uploading a file from
2465 the query box.
2466 </h4>
2468 Since version 2.2.4, phpMyAdmin supports servers with open_basedir
2469 restrictions. Assuming that the restriction allows you to open files in the
2470 current directory ('.'), all you have to do is create a 'tmp' directory
2471 under the phpMyAdmin install directory, with permissions 777 and the same
2472 owner as the owner of your phpMyAdmin directory. The uploaded files will
2473 be moved there, and after execution of your SQL commands, removed.
2474 </p>
2476 <a name="faq1_12"></a>
2477 <h4>
2478 [<a href="#faq1_12">1.12</a>] I have lost my MySQL root password, what can I do?
2479 </h4>
2481 The MySQL manual explains how to
2482 <a href="http://www.mysql.com/doc/R/e/Resetting_permissions.html">
2483 reset the permissions</a>.
2484 </p>
2486 <a name="faq1_13"></a>
2487 <h4>
2488 [<a href="#faq1_13">1.13</a>] I get an error 'No SQL query' when trying to execute a bookmark.
2489 </h4>
2491 If PHP does not have read/write access to its <tt>upload_tmp_dir</tt>, it
2492 cannot access the uploaded query.
2493 </p>
2495 <a name="faq1_14"></a>
2496 <h4>
2497 [<a href="#faq1_14">1.14</a>] I get an error 'No SQL query' when trying to submit a query from
2498 the convenient text area.
2499 </h4>
2501 Check the <tt>post_max_size</tt> directive from your PHP configuration file
2502 and try to increase it.
2503 </p>
2505 <a name="faq1_15"></a>
2506 <h4>
2507 [<a href="#faq1_15">1.15</a>] I have problems with <i>mysql.user</i> field names.
2508 </h4>
2510 In older MySQL versions, the <tt>User</tt> and <tt>Password</tt> fields
2511 were named <tt>user</tt> and <tt>password</tt>. Please modify your field
2512 names to align with current standards.
2513 </p>
2515 <a name="faq1_16"></a>
2516 <h4>
2517 [<a href="#faq1_16">1.16</a>] I cannot upload big dump files (memory, http or timeout problems).
2518 </h4>
2520 The first things to check (or ask your host provider to check) are the
2521 values of <tt>upload_max_filesize</tt>, <tt>memory_limit</tt> and
2522 <tt>post_max_size</tt> in the <i>php.ini</i> configuration file.
2523 All of these three settings limit the maximum size of data that can be
2524 submitted and handled by PHP. One user also said that post_max_size
2525 and memory_limit need to be larger than upload_max_filesize.
2526 <br /> <br />
2527 There exist several workarounds if your upload is too big or your
2528 hosting provider is unwilling to change the settings:
2529 </p>
2530 <ul>
2531 <li>Look at the <tt>$cfg['UploadDir']</tt> feature. This allows one to
2532 upload a file to the server via scp, ftp, or your favorite file transfer
2533 method. PhpMyAdmin is then able to import the files from the temporary
2534 directory. More information is available in the <a href="#config">Configuration
2535 section</a> of this document.</li>
2536 <li>Using a utility (such as <a href="http://www.ozerov.de/bigdump.php">
2537 BigDump</a>) to split the files before uploading. We cannot support this
2538 or any third party applications, but are aware of users having success
2539 with it.</li>
2540 <li>If you have shell (command line) access, use MySQL to import the files
2541 directly. You can do this by issuing the &quot;source&quot; command from
2542 within MySQL: <tt>source <i>filename.sql</i></tt>.</li>
2543 </ul>
2545 <a name="faqmysqlversions"></a>
2546 <h4>
2547 [<a href="#faqmysqlversions">1.17</a>] Which MySQL versions does phpMyAdmin support?
2548 </h4>
2550 All MySQL versions from 3.23.32 till 5.0 (except for 4.1.0 and 4.1.1) are
2551 fully supported. Please note that the older your MySQL version is, the more
2552 limitations you will have to face.
2553 <br />
2554 phpMyAdmin may connect to your MySQL server using php's classic
2555 <a href="http://php.net/mysql">MySQL extension</a> as well as the
2556 <a href="http://php.net/mysqli">improved MySQL extension (MySQLi)</a> that
2557 is available in php 5.0.
2558 <br />
2559 Either way, the developers of both extensions recommend to use the classic
2560 extension for MySQL 4.0 and below and MySQLi for MySQL 4.1 and newer.
2561 <br />
2562 When compiling php, we strongly recommend that you manually link the MySQL
2563 extension of your choice to a MySQL client library of at least the same
2564 minor version since the one that is bundled with some php distributions is
2565 rather old and might cause problems (see also FAQ 1.17a).<br />
2566 MySQL&nbsp;5.1 is not yet supported.
2567 </p>
2569 <a name="faq1_17a"></a>
2570 <h4>
2571 [<a href="#faq1_17a">1.17a</a>] I cannot connect to the MySQL server. It always returns the error
2572 message, &quot;Client does not support authentication protocol requested
2573 by server; consider upgrading MySQL client&quot;
2574 </h4>
2576 You tried to access MySQL with an old MySQL client library. The version of
2577 your MySQL client library can be checked in your phpinfo() output.
2578 In general, it should have at least the same minor version as your server
2579 - as mentioned in FAQ 1.17.
2580 <br /><br />
2581 This problem is generally caused by using MySQL version 4.1 or newer. MySQL
2582 changed the authentication hash and your PHP is trying to use the old method.
2583 The proper solution is to use the <a href="http://www.php.net/mysqli">mysqli extension</a>
2584 with the proper client library to match your MySQL installation. Your
2585 chosen extension is specified in <tt>$cfg['Servers'][$i]['extension']</tt>.
2586 More information (and several workarounds) are located in the
2587 <a href="http://dev.mysql.com/doc/mysql/en/old-client.html">MySQL Documentation</a>.
2588 </p>
2590 <a name="faq1_18"></a>
2591 <h4>
2592 [<a href="#faq1_18">1.18</a>] I'm running MySQL&nbsp;&lt;=&nbsp;4.0.1 having
2593 <tt>lower_case_table_names</tt> set to 1. If I create a new table with a
2594 capital letter in its name it is changed to lowercase as it should. But
2595 if I try to DROP this table MySQL is unable to find the corresponding
2596 file.
2597 </h4>
2599 This is a bug of MySQL&nbsp;&lt;=&nbsp;4.0.1. Please upgrade to at least
2600 MySQL&nbsp;4.0.2 or turn off your <tt>lower_case_table_names</tt>
2601 directive.
2602 </p>
2604 <a name="faq1_19"></a>
2605 <h4>
2606 [<a href="#faq1_19">1.19</a>] I can't run the &quot;display relations&quot; feature because the
2607 script seems not to know the font face I'm using!
2608 </h4>
2610 The &quot;FPDF&quot; library we're using for this feature requires some
2611 special files to use font faces.<br />
2612 Please refers to the
2613 <a href="http://www.fpdf.org/" target="_blank">FPDF manual</a> to build
2614 these files.
2615 </p>
2617 <a name="faqmysql"></a>
2618 <h4>
2619 [<a href="#faqmysql">1.20</a>] I receive the error &quot;cannot load MySQL extension, please
2620 check PHP Configuration&quot;.
2621 </h4>
2623 To connect to a MySQL server, PHP needs a set of MySQL functions called
2624 &quot;MySQL extension&quot;.
2625 This extension may be part of the PHP distribution (compiled-in), otherwise
2626 it needs to be loaded dynamically. Its name is probably <i>mysql.so</i> or
2627 <i>php_mysql.dll</i>. phpMyAdmin tried to load the extension but failed.
2628 <br /><br />
2629 Usually, the problem is solved by installing a software package called
2630 &quot;PHP-MySQL&quot; or something similar.
2631 </p>
2633 <a name="faq1_21"></a>
2634 <h4>
2635 [<a href="#faq1_21">1.21</a>] I am running the CGI version of PHP under Unix, and I cannot
2636 login using cookie auth.
2637 </h4>
2639 In <i>php.ini</i>, set <tt>mysql.max_links</tt> higher than 1.
2640 </p>
2642 <a name="faq1_22"></a>
2643 <h4>
2644 [<a href="#faq1_22">1.22</a>] I don't see the &quot;Location of text file&quot; field, so
2645 I cannot upload.
2646 </h4>
2648 This is most likely because in <i>php.ini</i>, your <tt>file_uploads</tt>
2649 parameter is not set to &quot;on&quot;.
2650 </p>
2652 <a name="faq1_23"></a>
2653 <h4>
2654 [<a href="#faq1_23">1.23</a>] I'm running MySQL on a Win32 machine. Each time I create a new
2655 table the table and field names are changed to lowercase!
2656 </h4>
2658 This happens because the MySQL directive <tt>lower_case_table_names</tt>
2659 defaults to 1 (<tt>ON</tt>) in the Win32 version of MySQL. You can change
2660 this behavior by simply changing the directive to 0 (<tt>OFF</tt>):<br />
2661 Just edit your <tt>my.ini</tt> file that should be located in your Windows
2662 directory and add the following line to the group [mysqld]:<br />
2663 <tt>set-variable = lower_case_table_names=0</tt><br />
2664 Next, save the file and restart the MySQL service. You can always check the
2665 value of this directive using the query<br />
2666 <tt>SHOW VARIABLES LIKE 'lower_case_table_names';</tt>
2667 </p>
2669 <a name="faq1_24"></a>
2670 <h4>
2671 [<a href="#faq1_24">1.24</a>] Some characters are being truncated in my queries, or I get
2672 characters randomly added. I am running PHP 4.2.3.
2673 </h4>
2675 This is a
2676 <a href="http://bugs.php.net/bug.php?id=19404">PHP 4.2.3 bug</a>.
2677 </p>
2679 <a name="faq1_25"></a>
2680 <h4>
2681 [<a href="#faq1_25">1.25</a>] I am running Apache with mod_gzip-1.3.26.1a on Windows XP,
2682 and I get problems, such as undefined variables when I run a SQL query.
2683 </h4>
2685 A tip from Jose Fandos: put a comment on the following two lines
2686 in httpd.conf, like this:<br />
2687 <tt># mod_gzip_item_include file \.php$</tt><br />
2688 <tt># mod_gzip_item_include mime "application/x-httpd-php.*"</tt><br />
2689 as this version of mod_gzip on Apache (Windows) has problems handling
2690 PHP scripts. Of course you have to restart Apache.
2691 </p>
2693 <a name="faq1_26"></a>
2694 <h4>
2695 [<a href="#faq1_26">1.26</a>] I just installed phpMyAdmin in my document root of IIS but
2696 I get the error &quot;No input file specified&quot; when trying to
2697 run phpMyAdmin.
2698 </h4>
2700 This is a permission problem. Right-click on the phpmyadmin folder
2701 and choose properties. Under the tab Security, click on &quot;Add&quot;
2702 and select the user &quot;IUSR_machine&quot; from the list. Now set his
2703 permissions and it should work.
2704 </p>
2706 <a name="faq1_27"></a>
2707 <h4>
2708 [<a href="#faq1_27">1.27</a>] I get empty page when I want to view huge page (eg.
2709 db_details_structure.php with plenty of tables).
2710 </h4>
2712 This is a <a href="http://bugs.php.net/21079">PHP bug</a> that occur when
2713 GZIP output buffering is enabled. If you turn off it (by <code>$cfg['OBGzip']
2714 = FALSE</code> in <i>config.inc.php</i>), it should work. This bug will be
2715 fixed in PHP 5.0.0.
2716 </p>
2718 <a name="faq1_28"></a>
2719 <h4>
2720 [<a href="#faq1_28">1.28</a>] My MySQL server sometimes refuses queries and returns the message
2721 'Errorcode: 13'. What does this mean?
2722 </h4>
2724 This can happen due to a MySQL bug when having database / table names with
2725 upper case characters although <tt>lower_case_table_names</tt> is set to 1.
2726 To fix this, turn off this directive, convert all database and table names
2727 to lower case and turn it on again. Alternatively, there's a bug-fix
2728 available starting with MySQL&nbsp;3.23.56 / 4.0.11-gamma.
2729 </p>
2731 <a name="faq1_29"></a>
2732 <h4>
2733 [<a href="#faq1_29">1.29</a>] When I create a table or modify a field, I get an error
2734 and the fields are duplicated.
2735 </h4>
2737 It is possible to configure Apache in such a way that PHP has problems
2738 interpreting .php files.
2739 <br /><br />
2740 The problems occur when two different (and conflicting) set of directives
2741 are used:
2742 <br /><br />
2743 <tt>
2744 SetOutputFilter PHP<br />
2745 SetInputFilter PHP<br />
2746 </tt>
2747 &amp;
2748 <br />
2749 <tt>
2750 AddType application/x-httpd-php .php
2751 </tt>
2752 <br /><br />
2753 In the case we saw, one set of directives was in
2754 <tt>/etc/httpd/conf/httpd.conf</tt>, while
2755 the other set was in <tt>/etc/httpd/conf/addon-modules/php.conf</tt>.<br />
2756 The recommended way is with <tt>AddType</tt>, so just comment out
2757 the first set of lines and restart Apache:
2758 <br /><br />
2759 <tt><b>
2760 #SetOutputFilter PHP<br />
2761 #SetInputFilter PHP<br /></b>
2762 </tt>
2763 </p>
2765 <a name="faq1_30"></a>
2766 <h4>
2767 [<a href="#faq1_30">1.30</a>] I get the error &quot;left.php: Missing hash&quot;.
2768 </h4>
2770 This problem is known to happen when the server is running Turck MMCache
2771 but upgrading MMCache to version 2.3.21 solves the problem.
2772 </p>
2774 <a name="faq1_31"></a>
2775 <h4>
2776 [<a href="#faq1_31">1.31</a>] Does phpMyAdmin support php5?
2777 </h4>
2779 Yes.
2780 <br />
2781 However, phpMyAdmin needs to be backwards compatible to php4. This is why
2782 you won't be able to run phpMyAdmin having enabled E_STRICT in your
2783 error_reporting settings.
2784 </p>
2786 <a name="faq1_32"></a>
2787 <h4>
2788 [<a href="#faq1_32">1.32</a>] Can I use HTTP authentication with IIS?
2789 </h4>
2791 Yes. This procedure was tested with phpMyAdmin 2.6.1, PHP 4.3.9 in ISAPI
2792 mode under IIS 5.1.</p>
2793 <ol>
2794 <li>In your <tt>php.ini</tt> file, set <tt>cgi.rfc2616_headers = 0</tt></li>
2796 <li>In <tt>Web Site Properties -> File/Directory Security -> Anonymous Access</tt> dialog box, check the <tt>Anonymous access</tt> checkbox and uncheck any other checkboxes (i.e. uncheck <tt>Basic authentication</tt>, <tt>Integrated Windows authentication</tt>, and <tt>Digest</tt> if it's enabled.) Click <tt>OK</tt>. </li>
2798 <li>In <tt>Custom Errors</tt>, select the range of <tt>401;1</tt> through <tt>401;5</tt> and click the <tt>Set to Default</tt> button. </li>
2799 </ol>
2801 <a name="faq1_33"></a>
2802 <h4>
2803 [<a href="#faq1_33">1.33</a>] Is there a problem with the mysqli extension when running PHP 5.0.4 on 64-bit systems?
2804 </h4>
2806 Yes. This problem affects phpMyAdmin (&quot;Call to undefined function pma_reloadnavigation&quot;), so upgrade your PHP to the next version.
2807 </p>
2809 <a name="faqconfig"></a><br />
2810 <h3>[2. Configuration]</h3>
2812 <a name="faq2_1"></a>
2813 <h4>
2814 [<a href="#faq2_1">2.1</a>] The error message &quot;Warning: Cannot add header information -
2815 headers already sent by ...&quot; is displayed, what's the problem?
2816 </h4>
2818 Edit your <i>config.inc.php or .php</i> file and ensure there is nothing
2819 (I.E. no blank lines, no spaces, no characters...) neither before the
2820 <tt>&lt;?php</tt> tag at the beginning, neither after the <tt>?&gt;</tt>
2821 tag at the end.
2822 </p>
2824 <a name="faq2_2"></a>
2825 <h4>
2826 [<a href="#faq2_2">2.2</a>] phpMyAdmin can't connect to MySQL. What's wrong?
2827 </h4>
2829 Either there is an error with your PHP setup or your username/password is
2830 wrong. Try to make a small script which uses mysql_connect and see if it
2831 works. If it doesn't, it may be you haven't even compiled MySQL support
2832 into PHP.
2833 </p>
2835 <a name="faq2_3"></a>
2836 <h4>
2837 [<a href="#faq2_3">2.3</a>] The error message &quot;Warning: MySQL Connection Failed: Can't
2838 connect to local MySQL server through socket '/tmp/mysql.sock'
2839 (111)...&quot; is displayed. What can I do?
2840 </h4>
2841 <p><br />
2842 For RedHat users, Harald Legner suggests this on the mailing list:
2843 <br /><br />
2844 On my RedHat-Box the socket of MySQL is <i>/var/lib/mysql/mysql.sock</i>.
2845 In your <i>php.ini</i> you will find a line
2846 <br />
2847 &nbsp;&nbsp;&nbsp;&nbsp;<tt>mysql.default_socket = /tmp/mysql.sock</tt>
2848 <br />
2849 change it to
2850 <br />
2851 &nbsp;&nbsp;&nbsp;&nbsp;<tt>mysql.default_socket = /var/lib/mysql/mysql.sock</tt>
2852 <br />
2853 Then restart apache and it will work.
2854 <br /><br />
2855 Here is a fix suggested by Brad Ummer:
2856 </p>
2857 <ul>
2858 <li>
2859 First, you need to determine what socket is being used by MySQL.
2860 <br />
2861 To do this, telnet to your server and go to the MySQL bin directory. In
2862 this directory there should be a file named <i>mysqladmin</i>. Type
2863 <tt>./mysqladmin variables</tt>, and this should give you a bunch of
2864 info about your MySQL server, including the socket
2865 (<i>/tmp/mysql.sock</i>, for example).
2866 </li>
2867 <li>
2868 Then, you need to tell PHP to use this socket.<br />Assuming you are
2869 using PHP 3.0.10 or better, you can specify the socket to use when you
2870 open the connection. To do this in phpMyAdmin, you need to complete the
2871 socket information in the <i>config.inc.php</i>.<br />
2872 For example:
2873 <tt>$cfg['Servers'][$i]['socket']&nbsp;=&nbsp;'/tmp/mysql.sock';</tt><br /><br />
2874 Please also make sure that the permissions of this file allow to be readable
2875 by your webserver (i.e. '0755').
2876 </li>
2877 </ul>
2879 Have also a look at the
2880 <a href="http://www.mysql.com/doc/C/a/Can_not_connect_to_server.html" target="_blank">
2881 corresponding section of the MySQL documentation</a>.
2882 </p>
2884 <a name="faq2_4"></a>
2885 <h4>
2886 [<a href="#faq2_4">2.4</a>] Nothing is displayed by my browser when I try to run phpMyAdmin,
2887 what can I do?
2888 </h4>
2890 Try to set the <tt>$cfg['OBGZip']</tt> directive to <tt>FALSE</tt> in the
2891 phpMyAdmin configuration file. It helps sometime.<br />
2892 Also have a look at your PHP version number: if it contains
2893 &quot;4.0b...&quot; it means you're running a beta version of PHP. That's
2894 not a so good idea, please upgrade to a plain revision.
2895 </p>
2897 <a name="faq2_5"></a>
2898 <h4>
2899 [<a href="#faq2_5">2.5</a>] Each time I want to insert or change a record or drop a database
2900 or a table, an error 404 (page not found) is displayed or, with HTTP or
2901 cookie authentication, I'm asked to login again. What's wrong?
2902 </h4>
2904 Check the value you set for the <tt>$cfg['PmaAbsoluteUri']</tt> directive
2905 in the phpMyAdmin configuration file.
2906 </p>
2908 <a name="faq2_6"></a>
2909 <h4>
2910 [<a href="#faq2_6">2.6</a>] I get an &quot;Access denied for user: 'root@localhost' (Using
2911 password: YES)&quot;-error when trying to access a MySQL-Server on a
2912 host which is port-forwarded for my localhost.
2913 </h4>
2915 When you are using a port on your localhost, which you redirect via
2916 port-forwarding to another host, MySQL is not resolving the localhost
2917 as expected.<br />
2918 Erik Wasser explains: The solution is: if your host is &quot;localhost&quot;
2919 MySQL (the commandline tool 'mysql' as well) always tries to use the socket
2920 connection for speeding up things. And that doesn't work in this configuration
2921 with port forwarding.<br />
2922 If you enter "127.0.0.1" as hostname, everything is right and MySQL uses the
2923 TCP connection.
2924 </p>
2926 <a name="faqthemes"></a>
2927 <h4>
2928 [<a href="#faqthemes">2.7</a>] Using and creating themes
2929 </h4>
2931 Themes are configured with <tt>$cfg['ThemePath']</tt>,
2932 <tt>$cfg['ThemeManager']</tt> and <tt>$cfg['ThemeDefault']</tt>.<br />
2933 <br />
2934 Under <tt>$cfg['ThemePath']</tt>, you should not delete the directory
2935 &quot;original&quot; or its underlying structure, because this is
2936 the system theme used by phpMyAdmin. &quot;original&quot; contains all
2937 images and styles, for backwards compatibility and for all themes that
2938 would not include images or css-files.<br />
2939 <br />
2940 If <tt>$cfg['ThemeManager']</tt> is enabled, you can select your
2941 favorite theme on the main page. Your selected theme will be stored
2942 in a cookie.<br />
2943 <br />
2944 </p>
2946 To create a theme:
2947 </p>
2948 <ul>
2949 <li>make a new subdirectory (for example &quot;your_theme_name&quot;) under <tt>$cfg['ThemePath']</tt> (by default <tt>themes</tt>)</li>
2950 <li>copy the files and directories from &quot;original&quot; to &quot;your_theme_name&quot;</li>
2951 <li>edit the css-files in &quot;your_theme_name/css&quot;</li>
2952 <li>put your new images in &quot;your_theme_name/img&quot;</li>
2953 <li>edit <tt>layout.inc.php</tt> in &quot;your_theme_name&quot;</li>
2954 <li>edit <tt>info.inc.php</tt> in &quot;your_theme_name&quot; to
2955 contain your chosen theme name, that will be visible in user interface</li>
2956 <li>make a new screenshot of your theme and save it under &quot;your_theme_name/screen.png&quot;</li>
2957 </ul>
2958 <br />
2960 In theme directory there is file <tt>info.inc.php</tt> which contains
2961 theme verbose name, theme generation and theme version. These versions and
2962 generations are enumerated from 1 and do not have any direct dependance on
2963 phpMyAdmin version. Themes within same generation should be backwards
2964 compatible - theme with version 2 should work in phpMyAdmin requiring
2965 version 1. Themes with different generation are incompatible.
2966 </p>
2968 If you do not want to use your own symbols and buttons, remove the
2969 directory &quot;img&quot; in &quot;your_theme_name&quot;. phpMyAdmin will
2970 use the default icons and buttons (from the system-theme &quot;original&quot;).
2971 </p>
2973 <a name="faqmissingparameters"></a>
2974 <h4>
2975 [<a href="#faqmissingparameters">2.8</a>] I get &quot;Missing parameters&quot; errors, what can I do?
2976 </h4>
2978 Here are a few points to check:</p>
2979 <ul>
2980 <li>
2981 In <tt>config.inc.php</tt>, try to leave the
2982 <tt>$cfg['PmaAbsoluteUri']</tt>directive empty. See also FAQ 4.7.
2983 </li>
2984 <li>
2985 Maybe you have a broken PHP installation or you need to upgrade
2986 your Zend Optimizer. See
2987 <a href="http://bugs.php.net/bug.php?id=31134">
2988 http://bugs.php.net/bug.php?id=31134</a>.
2989 </li>
2990 <li>
2991 If you are using Hardened PHP with the ini directive <tt>varfilter.max_request_variables</tt>
2992 set to the default (200) or another low value, you could get this
2993 error if your table has a high number of columns. Adjust this setting
2994 accordingly. (Thanks to Klaus Dorninger for the hint).
2995 </li>
2996 <li>
2997 In the <tt>php.ini</tt> directive <tt>arg_separator.input</tt>, a value
2998 of &quot;;&quot; will cause this error. Replace it with &quot;&amp;;&quot;.
2999 </li>
3000 </ul>
3002 <a name="faqlimitations"></a><br />
3003 <h3>[3. Known limitations]</h3>
3005 <a name="login_bug"></a>
3006 <h4>
3007 [<a href="#login_bug">3.1</a>] When using HTTP authentication, an user who logged out can not
3008 relogin in with the same nick.
3009 </h4>
3011 This is related to the authentication mechanism (protocol) used by
3012 phpMyAdmin. To bypass this problem: just close all the opened
3013 browser windows and then go back to phpMyAdmin. You should be able to
3014 log in again.
3015 </p>
3017 <a name="faq3_2"></a>
3018 <h4>
3019 [<a href="#faq3_2">3.2</a>] When dumping a large table in compressed mode, I get a memory
3020 limit error or a time limit error.
3021 </h4>
3023 Compressed dumps are built in memory and because of this are limited to
3024 php's memory limit. For GZip/BZip2 exports this can be overcome since
3025 2.5.4 using <tt>$cfg['CompressOnFly']</tt> (enabled by default). Zip
3026 exports can not be handled this way, so if you need Zip files for larger
3027 dump, you have to use another way.
3028 </p>
3030 <a name="faq3_3"></a>
3031 <h4>
3032 [<a href="#faq3_3">3.3</a>] With InnoDB tables, I lose foreign key relationships when I rename
3033 or alter a table.
3034 </h4>
3036 This seems to be a InnoDB bug (fixed in MySQL 3.23.50?).
3037 </p>
3039 <a name="faq3_4"></a>
3040 <h4>
3041 [<a href="#faq3_4">3.4</a>] I am unable to import dumps I created with the mysqldump tool
3042 bundled with the MySQL server distribution.
3043 </h4>
3045 The problem is that mysqldump creates invalid comments like this:
3046 </p>
3048 <pre>
3049 -- MySQL dump 8.22
3051 -- Host: localhost Database: database
3052 ---------------------------------------------------------
3053 -- Server version 3.23.54
3054 </pre>
3056 The invalid part of the code is the horizontal line made of dashes that
3057 appears once in every dump created with mysqldump. If you want to run your
3058 dump you have to turn it into valid MySQL. This means, you have to add a
3059 whitespace after the first two dashes of the line or add a # before it:
3060 <br />
3061 <code>
3062 -- -------------------------------------------------------<br />
3063 </code>
3064 or<br />
3065 <code>
3066 #---------------------------------------------------------
3067 </code>
3068 </p>
3070 <a name="faq3_5"></a>
3071 <h4>
3072 [<a href="#faq3_5">3.5</a>] When using nested folders ($cfg['LeftFrameTableSeparator']) there
3073 are some multiple hierarchies displayed in a wrong manner?!
3074 </h4>
3076 Please note that you should not use the separating string multiple times
3077 without any characters between them, or at the beginning/end of your table
3078 name. If you have to, think about using another TableSeparator or disabling
3079 that feature
3080 </p>
3082 <a name="faq3_6"></a>
3083 <h4>
3084 [<a href="#faq3_6">3.6</a>] What is currently not supported in phpMyAdmin about InnoDB?
3085 </h4>
3087 In Relation view, being able to choose a table in another database,
3088 or having more than one index field in the foreign key.<br /><br/>
3089 In Query-by-example (Query), automatic generation of the query
3090 LEFT JOIN from the foreign table.<br /><br/>
3091 In PDF schema editing, automatic layout.
3092 </p>
3094 <a name="faq3_7"></a>
3095 <h4>
3096 [<a href="#faq3_7">3.7</a>] I have table with many (100+) fields and when I try to browse table
3097 I get series of errors like &quot;Warning: unable to parse url&quot;. How
3098 can this be fixed?
3099 </h4>
3101 Your table neither have a primary key nor an unique one, so we must use a
3102 long expression to identify this row. This causes problems to parse_url
3103 function. The workaround is to create a primary or unique key.
3104 <br />
3105 </p>
3107 <a name="faq3_8"></a>
3108 <h4>
3109 [<a href="#faq3_8">3.8</a>] I cannot use (clickable) HTML-forms in fields where I put a <a href="#transformations">MIME-Transformation</a> onto!
3110 </h4>
3112 Due to a surrounding form-container (for multi-row delete checkboxes), no nested forms can be put inside the table where
3113 phpMyAdmin displays the results. You can, however, use any form inside of a table if keep the parent form-container with
3114 the target to tbl_row_delete.php and just put your own input-elements inside. If you use a custom submit input field, the
3115 form will submit itself to the displaying page again, where you can validate the $HTTP_POST_VARS in a transformation.
3117 For a tutorial on how to effectively use transformations, see our <a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a>
3118 on the official phpMyAdmin-homepage.
3119 </p>
3121 <a name="faq3_9"></a>
3122 <h4>
3123 [<a href="#faq3_9">3.9</a>] I get error messages when using "--sql_mode=ANSI" for the MySQL server
3124 </h4>
3126 When MySQL is running in ANSI-compatibility mode, there are some major differences in how SQL is structured (see <a href="http://dev.mysql.com/doc/mysql/en/ANSI_mode.html">http://dev.mysql.com/doc/mysql/en/ANSI_mode.html</a>). Most important of all, the quote-character (") is interpreted as an identifier quote character and not as a string quote character, which makes many internal phpMyAdmin operations into invalid SQL statements. There is no workaround to this behaviour. News to this item will be posted in Bug report <a href="https://sourceforge.net/tracker/index.php?func=detail&amp;aid=816858&amp;group_id=23067&amp;atid=377408">#816858</a>
3127 </p>
3129 <a name="faq3_10"></a>
3130 <h4>
3131 [<a href="#faq3_10">3.10</a>] Homonyms and no primary key: When the results of a SELECT display
3132 more that one column with the same value
3133 (for example <tt>SELECT lastname from employees where firstname like 'A%'</tt> and two &quot;Smith&quot; values are displayed),
3134 if I click Edit I cannot be sure that I am editing the intended row.
3135 </h4>
3137 Please make sure that your table has a primary key, so that phpMyAdmin
3138 can use it for the Edit and Delete links.
3139 </p>
3141 <a name="faq3_11"></a>
3142 <h4>
3143 [<a href="#faq3_11">3.11</a>] The number of records for InnoDB tables is not correct.
3144 </h4>
3146 phpMyAdmin uses a quick method to get the row count, and this method
3147 only returns an approximate count in the case of InnoDB tables. See
3148 <tt>$cfg['MaxExactCount']</tt> for a way to modify those results, but
3149 this could have a serious impact on performance.
3150 </p>
3152 <a name="faq3_12"></a>
3153 <h4>
3154 [<a href="#faq3_12">3.12</a>] What are the phpMyAdmin limitations for MySQL 3?
3155 </h4>
3157 The number of records in queries containing COUNT and GROUP BY is
3158 not correctly calculated. Also, sorting results of a query like
3159 &quot;SELECT * from table GROUP BY&quot; ... is problematic.
3160 </p>
3162 <a name="faq3_13"></a>
3163 <h4>
3164 [<a href="#faq3_13">3.13</a>] I get an error when entering <tt>USE</tt> followed by a db name
3165 containing an hyphen.
3166 </h4>
3168 The tests I have made with current MySQL 4.1.11 API shows that the
3169 API does not accept this syntax for the USE command. Enclosing the
3170 db name with backquotes works. For further confusion, no backquotes
3171 are needed with command-line mysql.
3172 </p>
3174 <a name="faqmultiuser"></a><br />
3175 <h3>[4. ISPs, multi-user installations ]</h3>
3177 <a name="faq4_1"></a>
3178 <h4>
3179 [<a href="#faq4_1">4.1</a>] I'm an ISP. Can I setup one central copy of phpMyAdmin or do I
3180 need to install it for each customer.
3181 </h4>
3183 Since version 2.0.3, you can setup a central copy of phpMyAdmin for all
3184 your users. The development of this feature was kindly sponsored by
3185 NetCologne GmbH.
3186 This requires a properly setup MySQL user management and phpMyAdmin
3187 HTTP or cookie authentication. See the install section on
3188 &quot;Using HTTP authentication&quot;.
3189 </p>
3191 <a name="faq4_2"></a>
3192 <h4>
3193 [<a href="#faq4_2">4.2</a>] What's the preferred way of making phpMyAdmin secure against evil
3194 access.
3195 </h4>
3197 This depends on your system.<br />
3198 If you're running a server which cannot be accessed by other people, it's
3199 sufficient to use the directory protection bundled with your webserver
3200 (with Apache you can use <i>.htaccess</i> files, for example).<br />
3201 If other people have telnet access to your server, you should use
3202 phpMyAdmin's HTTP authentication feature.
3203 <br /><br />
3204 Suggestions:
3205 </p>
3206 <ul>
3207 <li>
3208 Your <i>config.inc.php</i> file should be <tt>chmod 660</tt>.
3209 </li>
3210 <li>
3211 All your phpMyAdmin files should be chown -R phpmy.apache, where phpmy
3212 is a user whose password is only known to you, and apache is the
3213 group under which Apache runs.
3214 </li>
3215 <li>
3216 You should use PHP safe mode, to protect from other users that try
3217 to include your <i>config.inc.php</i> in their scripts.
3218 </li>
3219 </ul>
3221 <a name="faq4_3"></a>
3222 <h4>
3223 [<a href="#faq4_3">4.3</a>] I get errors about not being able to include a file in
3224 <i>/lang</i> or in <i>/libraries</i>.
3225 </h4>
3227 Check <i>php.ini</i>, or ask your sysadmin to check it. The
3228 <tt>include_path</tt> must contain &quot;.&quot; somewhere in it, and
3229 <tt>open_basedir</tt>, if used, must contain &quot;.&quot; and
3230 &quot;./lang&quot; to allow normal operation of phpMyAdmin.
3231 </p>
3233 <a name="faq4_4"></a>
3234 <h4>
3235 [<a href="#faq4_4">4.4</a>] phpMyAdmin always gives &quot;Access denied&quot; when using HTTP
3236 authentication.
3237 </h4>
3239 This could happen for several reasons:
3240 </p>
3241 <ul>
3242 <li>
3243 <tt>$cfg['Servers'][$i]['controluser']</tt> and/or
3244 <tt>$cfg['Servers'][$i]['controlpass']</tt> are wrong.
3245 </li>
3246 <li>
3247 The username/password you specify in the login-dialog are invalid.
3248 </li>
3249 <li>
3250 You have already setup a security mechanism for the
3251 phpMyAdmin-directory, eg. a .htaccess file. This would interfere with
3252 phpMyAdmin's authentication, so remove it.
3253 </li>
3254 </ul>
3256 <a name="faq4_5"></a>
3257 <h4>
3258 [<a href="#faq4_5">4.5</a>] Is it possible to let users create their own databases?
3259 </h4>
3261 Starting with 2.2.5, in the user management page, you can enter a wildcard
3262 database name for a user (for example &quot;joe%&quot;),
3263 and put the privileges you want. For example,
3264 adding <tt>SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER</tt>
3265 would let a user create/manage his/her database(s).
3266 </p>
3268 <a name="faq4_6"></a>
3269 <h4>
3270 [<a href="#faq4_6">4.6</a>] How can I use the Host-based authentication additions?
3271 </h4>
3273 If you have existing rules from an old .htaccess file, you can take them
3274 and add a username between the <tt>'deny'</tt>/<tt>'allow'</tt> and
3275 <tt>'from'</tt> strings. Using the username wildcard of <tt>'%'</tt> would
3276 be a major benefit here if your installation is suited to using it. Then
3277 you can just add those updated lines into the
3278 <tt>$cfg['Servers'][$i]['AllowDeny']['rules']</tt> array.
3279 <br /><br />
3280 If you want a pre-made sample, you can try this fragment. It stops the
3281 'root' user from logging in from any networks other than the private
3282 network IP blocks.
3283 <br />
3284 <tt>
3285 &nbsp;&nbsp;&nbsp;&nbsp;//block root from logging in except from the private networks<br />
3286 &nbsp;&nbsp;&nbsp;&nbsp;$cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';<br />
3287 &nbsp;&nbsp;&nbsp;&nbsp;$cfg['Servers'][$i]['AllowDeny']['rules'] = array(<br />
3288 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'deny root from all',<br />
3289 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'allow root from localhost',<br />
3290 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'allow root from 10.0.0.0/8',<br />
3291 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'allow root from 192.168.0.0/16',<br />
3292 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'allow root from 172.16.0.0/12',<br />
3293 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;);
3294 </tt>
3295 </p>
3297 <a name="faq4_7"></a>
3298 <h4>
3299 [<a href="#faq4_7">4.7</a>] Authentication window is displayed more than once, why?
3300 </h4>
3302 This happens if you are using a URL to start phpMyAdmin which is
3303 different than the one set in your <tt>$cfg['PmaAbsoluteUri']</tt>.
3304 For example, a missing &quot;www&quot;, or entering with an IP address
3305 while a domain name is defined in the config file.
3306 </p>
3308 <a name="faqbrowsers"></a><br />
3309 <h3>[5. Browsers or client OS]</h3>
3311 <a name="faq5_1"></a>
3312 <h4>
3313 [<a href="#faq5_1">5.1</a>] I get an out of memory error, and my controls are non-functional,
3314 when trying to create a table with more than 14 fields.
3315 </h4>
3317 We could reproduce this problem only under Win98/98SE. Testing under
3318 WinNT4 or Win2K, we could easily create more than 60 fields.
3319 <br />
3320 A workaround is to create a smaller number of fields, then come back to
3321 your table properties and add the other fields.
3322 </p>
3324 <a name="faq5_2"></a>
3325 <h4>
3326 [<a href="#faq5_2">5.2</a>] With Xitami 2.5b4, phpMyAdmin won't process form fields.
3327 </h4>
3329 This is not a phpMyAdmin problem but a Xitami known bug: you'll face it
3330 with each script/website that use forms.<br />
3331 Upgrade or downgrade your Xitami server.
3332 </p>
3334 <a name="faq5_3"></a>
3335 <h4>
3336 [<a href="#faq5_3">5.3</a>] I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).
3337 </h4>
3339 With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except that
3340 the proposed file name for the dump is always 'tbl_dump.php'. Bzip2 dumps
3341 don't seem to work.<br />
3343 With Konqueror 2.2.1: plain dumps work; zip dumps are placed into
3344 the user's temporary directory, so they must be moved before closing
3345 Konqueror, or else they disappear. GZip dumps give an error message.<br />
3347 Testing needs to be done for Konqueror 2.2.2.<br />
3348 </p>
3350 <a name="faq5_4"></a>
3351 <h4>
3352 [<a href="#faq5_4">5.4</a>] I can't use the cookie authentication mode because Internet
3353 Explorer never stores the cookies.
3354 </h4>
3356 MS Internet Explorer seems to be really buggy about cookies, at least till
3357 version 6. And thanks to Andrew Zivolup we've traced also a PHP 4.1.1 bug
3358 in this area!
3359 <br />
3360 Then, if you're running PHP 4.1.1, try to upgrade or downgrade... it may
3361 work!
3362 </p>
3364 <a name="faq5_5"></a>
3365 <h4>
3366 [<a href="#faq5_5">5.5</a>] In Internet Explorer 5.0, I get JavaScript errors when browsing my
3367 rows.
3368 </h4>
3370 Upgrade to at least Internet Explorer 5.5 SP2.<br />
3371 </p>
3373 <a name="faq5_6"></a>
3374 <h4>
3375 [<a href="#faq5_6">5.6</a>] In Internet Explorer 5.0, 5.5 or 6.0, I get an error (like "Page not found")
3376 when trying to modify a row in a table with many fields, or with a text field
3377 </h4>
3379 Your table neither have a primary key nor an unique one, so we must use a
3380 long URL to identify this row. There is a limit on the length of the URL in
3381 those browsers, and this not happen in Netscape, for example. The
3382 workaround is to create a primary or unique key, or use another browser.
3383 <br />
3384 </p>
3386 <a name="faq5_7"></a>
3387 <h4>
3388 [<a href="#faq5_7">5.7</a>] I refresh (reload) my browser, and come back to the welcome
3389 page.
3390 </h4>
3392 Some browsers support right-clicking into the frame you want to refresh,
3393 just do this in the right frame.<br />
3394 </p>
3396 <a name="faq5_8"></a>
3397 <h4>
3398 [<a href="#faq5_8">5.8</a>] With Mozilla 0.9.7 I have problems sending a query modified in the
3399 query box.
3400 </h4>
3402 Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
3403 Mozilla versions.<br />
3404 </p>
3406 <a name="faq5_9"></a>
3407 <h4>
3408 [<a href="#faq5_9">5.9</a>] With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
3409 whitespace in the SQL-Query edit area: the page scrolls down.
3410 </h4>
3412 This is a Mozilla bug (see bug #26882 at
3413 <a href="http://bugzilla.mozilla.org/" target="_blank">BugZilla</a>).<br />
3414 </p>
3416 <a name="faq5_10"></a>
3417 <h4>
3418 [<a href="#faq5_10">5.10</a>] With Netscape 4.75 I get empty rows between each row of data in a
3419 CSV exported file.
3420 </h4>
3422 This is a known Netscape 4.75 bug: it adds some line feeds when exporting
3423 data in octet-stream mode. Since we can't detect the specific Netscape
3424 version, we cannot workaround this bug.
3425 </p>
3427 <a name="faq5_11"></a>
3428 <h4>
3429 [<a href="#faq5_11">5.11</a>] Extended-ASCII characters like German umlauts are displayed
3430 wrong.
3431 </h4>
3433 Please ensure that you have set your browser's character set to the one of the
3434 language file you have selected on phpMyAdmin's start page.
3435 Alternatively, you can try the auto detection mode that is supported by the
3436 recent versions of the most browsers.
3437 </p>
3439 <a name="faq5_12"></a>
3440 <h4>
3441 [<a href="#faq5_12">5.12</a>] Apple OS X: Safari browser changes special characters to
3442 &quot;?&quot;.
3443 </h4>
3445 This issue has been reported by a OS X user, who adds that Chimera,
3446 Netscape and Mozilla do not have this problem.
3447 </p>
3449 <a name="faq5_13"></a>
3450 <h4>
3451 [<a href="#faq5_13">5.13</a>] With Internet Explorer 5.5 or 6, and HTTP authentication type,
3452 I cannot manage two servers: I login to the first one, then the other one,
3453 but if I switch back to the first, I have to login on each operation.
3454 </h4>
3456 This is a bug in Internet Explorer, other browsers do not behave this way.
3457 </p>
3459 <a name="faq5_14"></a>
3460 <h4>
3461 [<a href="#faq5_14">5.14</a>] Using Opera6, I can manage to get to the authentication, but nothing
3462 happens after that, only a blank screen.
3463 </h4>
3465 Having $cfg['QueryFrameJS'] set to <tt>TRUE</tt>, this leads to a bug in Opera6, because it
3466 is not able to interpret frameset definitiions written by JavaScript. Please upgrade
3467 to Opera7 at least.
3468 </p>
3470 <a name="faq5_15"></a>
3471 <h4>
3472 [<a href="#faq5_15">5.15</a>] I have display problems with Safari.
3473 </h4>
3475 Please upgrade to at least version 1.2.3.
3476 </p>
3478 <a name="faq5_16"></a>
3479 <h4>
3480 [<a href="#faq5_16">5.16</a>] With Internet Explorer, I get &quot;Access is denied&quot;
3481 Javascript errors. Or I cannot make phpMyAdmin work under Windows.
3482 </h4>
3484 Please check the following points:</p>
3485 <ul>
3486 <li>
3487 Maybe you have defined your <tt>PmaAbsoluteUri</tt> setting
3488 in <tt>config.inc.php</tt> to an IP address and you are starting
3489 phpMyAdmin with a URL containing a domain name, or the reverse situation.
3490 </li>
3491 <li>
3492 Security settings in IE and/or Microsoft Security Center are
3493 too high, thus blocking scripts execution.
3494 </li>
3495 <li>
3496 The Windows Firewall is blocking Apache and MySQL. You must
3497 allow http ports (80 or 443) and MySQL port (usually 3306)
3498 in the &quot;in&quot; and &quot;out&quot; directions.
3499 </li>
3500 </ul>
3502 <a name="faq5_17"></a>
3503 <h4>
3504 [<a href="#faq5_17">5.17</a>] With Firefox, I cannot delete rows of data or drop a database.
3505 </h4>
3506 <p> Many users have confirmed that the Tabbrowser Extensions plugin they
3507 installed in their Firefox is causing the problem.
3508 </p>
3510 <a name="faqusing"></a><br />
3511 <h3>[6. Using phpMyAdmin]</h3>
3513 <a name="faq6_1"></a>
3514 <h4>
3515 [<a href="#faq6_1">6.1</a>] I can't insert new rows into a table / I can't create a table
3516 - MySQL brings up a SQL-error.
3517 </h4>
3519 Examine the SQL error with care. Often the problem is caused by
3520 specifying a wrong field-type.<br />
3521 Common errors include:
3522 </p>
3523 <ul>
3524 <li>Using <tt>VARCHAR</tt> without a size argument</li>
3525 <li>Using <tt>TEXT</tt> or <tt>BLOB</tt> with a size argument</li>
3526 </ul>
3528 Also, look at the syntax chapter in the MySQL manual to confirm that your
3529 syntax is correct.
3530 </p>
3532 <a name="faq6_2"></a>
3533 <h4>
3534 [<a href="#faq6_2">6.2</a>] When I create a table, I click the Index checkbox for 2 fields and
3535 phpMyAdmin generates only one index with those 2 fields.
3536 </h4>
3538 In phpMyAdmin 2.2.0 and 2.2.1, this is the way to create a multi-fields
3539 index. If you want two indexes, create the first one when creating the
3540 table, save, then display the table properties and click the Index link to
3541 create the other index.
3542 </p>
3544 <a name="faq6_3"></a>
3545 <h4>
3546 [<a href="#faq6_3">6.3</a>] How can I insert a null value into my table?
3547 </h4>
3549 Since version 2.2.3, you have a checkbox for each field that can be null.
3550 Before 2.2.3, you had to enter &quot;null&quot;, without the quotes, as the
3551 field's value. Since version 2.5.5, you have to use the checkbox to get
3552 a real NULL value, so if you enter &quot;NULL&quot; this means you want
3553 a literal NULL in the field, and not a NULL value (this works in PHP4).
3554 </p>
3556 <a name="faq6_4"></a>
3557 <h4>
3558 [<a href="#faq6_4">6.4</a>] How can I backup my database or table?
3559 </h4>
3561 Click on a database or table name in the left frame, the properties will be
3562 displayed. Then on the menu, click &quot;Export&quot;, you can dump
3563 the structure, the data, or both. This will generate standard SQL
3564 statements that can be used to recreate your database/table.
3565 <br /><br />
3566 You will need to choose &quot;Save as file&quot;, so that phpMyAdmin can
3567 transmit the resulting dump to your station. Depending on your PHP
3568 configuration, you will see options to compress the dump. See also the
3569 <tt>$cfg['ExecTimeLimit']</tt> configuration variable.
3570 <br /><br />
3571 For additional help on this subject, look for the word &quot;dump&quot; in
3572 this document.
3573 </p>
3575 <a name="faq6_5"></a>
3576 <h4>
3577 [<a href="#faq6_5">6.5</a>] How can I restore (upload) my database or table using a dump?
3578 How can I run a &quot;.sql&quot; file.
3579 </h4>
3581 Click on a database name in the left frame, the properties will be
3582 local displayed. Then in the &quot;Run SQL query&quot; section, type in
3583 your dump filename, or use the Browse button. Then click Go.
3584 <br /><br />
3585 For additional help on this subject, look for the word &quot;upload&quot;
3586 in this document.
3587 </p>
3589 <a name="faq6_6"></a>
3590 <h4>
3591 [<a href="#faq6_6">6.6</a>] How can I use the relation table in Query-by-example?
3592 </h4>
3594 Here is an example with the tables persons, towns and countries, all
3595 located in the database mydb. If you don't have a <tt>pma_relation</tt>
3596 table, create it as explained in the configuration section. Then create the
3597 example tables:
3598 <br /><br />
3599 <tt>
3600 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE REL_countries (<br />
3601 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;country_code char(1) NOT NULL default '',<br />
3602 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;description varchar(10) NOT NULL default '',<br />
3603 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (country_code)<br />
3604 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM;<br />
3605 <br />
3606 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_countries VALUES ('C', 'Canada');<br />
3607 <br />
3608 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE REL_persons (<br />
3609 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id tinyint(4) NOT NULL auto_increment,<br />
3610 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;person_name varchar(32) NOT NULL default '',<br />
3611 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;town_code varchar(5) default '0',<br />
3612 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;country_code char(1) NOT NULL default '',<br />
3613 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (id)<br />
3614 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM;<br />
3615 <br />
3616 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');<br />
3617 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');<br />
3618 <br />
3619 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE REL_towns (<br />
3620 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;town_code varchar(5) NOT NULL default '0',<br />
3621 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;description varchar(30) NOT NULL default '',<br />
3622 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (town_code)<br />
3623 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM;<br />
3624 <br />
3625 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');<br />
3626 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_towns VALUES ('M', 'Montr&eacute;al');<br />
3627 <br />
3628 </tt>
3629 To setup appropriate links and display information:
3630 </p>
3631 <ul>
3632 <li>on table &quot;REL_persons&quot; click Structure, then Relation view</li>
3633 <li>in Links, for &quot;town_code&quot; choose &quot;REL_towns-&gt;code&quot;</li>
3634 <li>in Links, for &quot;country_code&quot; choose &quot;REL_countries-&gt;country_code&quot;</li>
3635 <li>on table &quot;REL_towns&quot; click Structure, then Relation view</li>
3636 <li>in &quot;Choose field to display&quot;, choose &quot;description&quot;</li>
3637 <li>repeat the two previous steps for table &quot;REL_countries&quot;</li>
3638 </ul>
3641 Then test like this:
3642 </p>
3643 <ul>
3644 <li>Click on your db name in the left frame</li>
3645 <li>Choose &quot;Query&quot;</li>
3646 <li>Use tables: persons, towns, countries</li>
3647 <li>Click &quot;Update query&quot;</li>
3648 <li>In the fields row, choose persons.person_name and click the
3649 &quot;Show&quot; tickbox </li>
3650 <li>Do the same for towns.description and countries.descriptions in the
3651 other 2 columns</li>
3652 <li>Click &quot;Update query&quot; and you will see in the query box that
3653 the correct joins have been generated</li>
3654 <li>Click &quot;Submit query&quot;</li>
3655 </ul>
3656 <br />
3658 <a name="faqdisplay"></a>
3659 <h4>
3660 [<a href="#faqdisplay">6.7</a>] How can I use the &quot;display field&quot; feature?
3661 </h4>
3663 Starting from the previous example, create the pma_table_info as explained
3664 in the configuration section, then browse your persons table,
3665 and move the mouse over a town code or country code.
3666 <br /><br />
3667 See also <a href="#faq6_21">FAQ 6.21</a> for an additionnal feature that &quot;display field&quot;
3668 enables: drop-down list of possible values.
3669 </p>
3671 <a name="faqpdf"></a>
3672 <h4>
3673 [<a href="#faqpdf">6.8</a>] How can I produce a PDF schema of my database?
3674 </h4>
3676 First the configuration variables &quot;relation&quot;,
3677 &quot;table_coords&quot; and &quot;pdf_pages&quot; have to be filled in.
3678 <br /><br />
3679 Then you need to think about your schema layout. Which tables will go on
3680 which pages?
3681 </p>
3682 <ul>
3683 <li>Select your database in the left frame.</li>
3684 <li>Choose &quot;Operations&quot; in the navigation bar at the top.</li>
3685 <li>Choose &quot;Edit PDF Pages&quot; near the bottom of the page.</li>
3686 <li>Enter a name for the first PDF page and click Go. If you like, you
3687 can use the &quot;automatic layout,&quot; which will put all your
3688 linked tables onto the new page.</li>
3689 <li>Select the name of the new page (making sure the Edit radio button
3690 is selected) and click Go.</li>
3691 <li>Select a table from the list, enter its coordinates and click Save.<br />
3692 Coordinates are relative; your diagram will
3693 be automatically scaled to fit the page. When initially placing tables
3694 on the page, just pick any coordinates -- say, 50x50. After clicking
3695 Save, you can then use the <a href="#wysiwyg">graphical editor</a> to
3696 position the element correctly.</li>
3697 <li>When you'd like to look at your PDF, first be sure to click the Save
3698 button beneath the list of tables and coordinates, to save any changes
3699 you made there. Then scroll all the way down, select the PDF options
3700 you want, and click Go.</li>
3701 <li>Internet Explorer for Windows may suggest an incorrect filename when
3702 you try to save a generated PDF. When saving a generated PDF, be
3703 sure that the filename ends in &quot;.pdf&quot;, for example
3704 &quot;schema.pdf&quot;. Browsers on other operating systems, and other
3705 browsers on Windows, do not have this problem.</li>
3706 </ul>
3708 <a name="faq6_9"></a>
3709 <h4>
3710 [<a href="#faq6_9">6.9</a>] phpMyAdmin is changing the type of one of my columns!
3711 </h4>
3713 No, it's MySQL that is doing
3714 <a href="http://www.mysql.com/doc/S/i/Silent_column_changes.html">silent column type changing</a>.
3715 </p>
3717 <a name="underscore"></a>
3718 <h4>
3719 [<a href="#underscore">6.10</a>] When creating a privilege, what happens with underscores in
3720 the database name?
3721 </h4>
3723 If you do not put a backslash before the underscore, this is a wildcard
3724 grant, and the underscore means &quot;any character&quot;. So, if the
3725 database name is &quot;john_db&quot;, the user would get rights to john1db,
3726 john2db...<br /><br />
3727 If you put a backslash before the underscore, it means that the database
3728 name will have a real underscore.
3729 </p>
3731 <a name="faq6_11"></a>
3732 <h4>
3733 [<a href="#faq6_11">6.11</a>] What is the curious symbol &oslash; in the statistics pages?
3734 </h4>
3736 It means &quot;average&quot;.
3737 </p>
3739 <a name="faqexport"></a>
3740 <h4>
3741 [<a href="#faqexport">6.12</a>] I want to understand some Export options.
3742 </h4>
3743 <p><b>Structure:</b></p>
3744 <ul>
3745 <li>&quot;Add DROP TABLE&quot; will add a line telling MySQL to
3746 <a href="http://dev.mysql.com/doc/mysql/en/drop-table.html">drop the table</a>,
3747 if it already exists during the import. It does NOT drop the table after
3748 your export, it only affects the import file.</li>
3749 <li>&quot;If Not Exists&quot; will only create the table if it doesn't exist. Otherwise,
3750 you may get an error if the table name exists but has a different structure.</li>
3751 <li>&quot;Add AUTO_INCREMENT value&quot; ensures that AUTO_INCREMENT value
3752 (if any) will be included in backup.</li>
3753 <li>&quot;Enclose table and field names with backquotes&quot; ensures that
3754 field and table names formed with special characters are protected.</li>
3755 <li>&quot;Add into comments&quot; includes column comments, relations, and MIME
3756 types set in the pmadb in the dump as SQL comments (<i>/* xxx */</i>).</li>
3757 </ul>
3758 <p><b>Data:</b></p>
3759 <ul>
3760 <li>&quot;Complete inserts&quot; adds the column names on every INSERT command,
3761 for better documentation (but resulting file is bigger).</li>
3762 <li>&quot;Extended inserts&quot; provides a shorter dump file by using only
3763 once the INSERT verb and the table name.</li>
3764 <li>&quot;Delayed inserts&quot; are best explained in the
3765 <a href="http://dev.mysql.com/doc/mysql/en/insert-delayed.html">MySQL manual</a>.</li>
3766 <li>&quot;Ignore inserts&quot; treats errors as a warning instead. Again, more info
3767 is provided in the <a href="http://dev.mysql.com/doc/mysql/en/insert.html">MySQL
3768 manual</a>, but basically with this selected, invalid values are adjusted and inserted
3769 rather than causing the entire statement to fail.</li>
3770 </ul>
3772 <a name="faq6_13"></a>
3773 <h4>
3774 [<a href="#faq6_13">6.13</a>] I would like to create a database with a dot in its name.
3775 </h4>
3777 This is a bad idea, because in MySQL the syntax &quot;database.table&quot;
3778 is the normal way to reference a database and table name. Worse, MySQL
3779 will usually let you create a database with a dot, but then you cannot
3780 work with it, nor delete it.<br />
3781 </p>
3783 <a name="faqsqlvalidator"></a>
3784 <h4>
3785 [<a href="#faqsqlvalidator">6.14</a>] How do I set up the SQL Validator?
3786 </h4>
3788 To use it, you need a very recent version of PHP, 4.3.0 recommended, with
3789 XML, PCRE and PEAR support. On your system command line, run
3790 <tt>"pear install Net_Socket Net_URL HTTP_Request Mail_Mime Net_DIME
3791 SOAP"</tt> to get the necessary PEAR modules for usage.
3792 <br />
3793 On a more recent pear version, I had problems with the state of Net_DIME
3794 being beta, so this single command
3795 <tt>"pear -d preferred_state=beta install -a SOAP"</tt> installed
3796 all the needed modules.
3797 <br />
3798 If you use the Validator, you should be aware that any SQL statement you
3799 submit will be stored anonymously (database/table/column names,
3800 strings, numbers replaced with generic values). The Mimer SQL
3801 Validator itself, is &copy; 2001 Upright Database Technology.
3802 We utilize it as free SOAP service.
3803 </p>
3805 <a name="faq6_15"></a>
3806 <h4>
3807 [<a href="#faq6_15">6.15</a>] I want to add a BLOB field and put an index on it, but MySQL
3808 says &quot;BLOB column '...' used in key specification without a key
3809 length&quot;.
3810 </h4>
3812 The right way to do this, is to create the field without any indexes,
3813 then display the table structure and use the &quot;Create an index&quot;
3814 dialog. On this page, you will be able to choose your BLOB field, and
3815 set a size to the index, which is the condition to create an index on
3816 a BLOB field.
3817 <br />
3818 </p>
3820 <a name="faq6_16"></a>
3821 <h4>
3822 [<a href="#faq6_16">6.16</a>] How can I simply move in page with plenty editing fields?
3823 </h4>
3825 You can use Ctrl+arrows (Option+Arrows in Safari) for moving on most pages
3826 with many editing fields (table structure changes, row editing, etc.)
3827 (must be enabled in configuration - see.
3828 <a href="#CtrlArrowsMoving">$cfg['CtrlArrowsMoving']</a>). You can also have
3829 a look at the directive
3830 <a href="#DefaultPropDisplay">$cfg['DefaultPropDisplay']</a> ('vertical') and
3831 see if this eases up editing for you.
3832 <br />
3833 </p>
3835 <a name="faq6_17"></a>
3836 <h4>
3837 [<a href="#faq6_17">6.17</a>] Transformations: I can't enter my own mimetype! WTF is this feature
3838 then useful for?
3839 </h4>
3841 Slow down :). Defining mimetypes is of no use, if you can't put transformations on them.
3842 Otherwise you could just put a comment on the field. Because entering your own mimetype will
3843 cause serious syntax checking issues and validation, this introduces a high-risk false-user-input
3844 situation. Instead you have to initialize mimetypes using functions or empty mimetype definitions.
3845 <br />
3846 Plus, you have a whole overview of available mimetypes. Who knows all those mimetypes by heart so
3847 he/she can enter it at will?
3848 <br />
3849 </p>
3851 <a name="faqbookmark"></a>
3852 <h4>
3853 [<a href="#faqbookmark">6.18</a>] Bookmarks: Where can I store bookmarks? Why can't I see any bookmarks below the query box?
3854 What is this variable for?
3855 </h4>
3857 Any query you have executed can be stored as a bookmark on the page where the results are displayed.
3858 You will find a button labeled 'Bookmark this query' just at the end of the page.<br />
3859 As soon as you have stored a bookmark, it is related to the database you run the query on. You can
3860 now access a bookmark dropdown on each page, the query box appears on for that database.<br />
3861 <br />
3862 Since phpMyAdmin 2.5.0 you are also able to store variables for the bookmarks. Just use the string
3863 <b>/*[VARIABLE]*/</b> anywhere in your query. Everything which is put into the <i>value</i> input
3864 box on the query box page will replace the string &quot;/*[VARIABLE]*/&quot; in your stored query.
3865 Just be aware of that you HAVE to create a valid query, otherwise your query won't be even able to be
3866 stored in the database.<br />
3867 Also remember, that everything else inside the <b>/*[VARIABLE]*/</b> string for your query will remain
3868 the way it is, but will be stripped of the /**/ chars. So you can use:<br /><br />
3869 <code>/*, [VARIABLE] AS myname */</code><br /><br />
3870 which will be expanded to<br /><br />
3871 <code>, VARIABLE as myname</code><br /><br />
3872 in your query, where VARIABLE is the string you entered in the input box. If an empty string is
3873 provided, no replacements are made.<br />
3874 <br />
3875 A more complex example. Say you have stored this query:<br /><br />
3876 <code>SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE '%[VARIABLE]%' */</code><br /><br />
3877 Say, you now enter &quot;phpMyAdmin&quot; as the variable for the stored query, the full query will
3878 be:<br /><br />
3879 <code>SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE '%phpMyAdmin%'</code>
3880 <br />
3881 <br />
3882 You can use multiple occurences of <b>/*[VARIABLE]*/</b> in a single query.<br />
3883 <b>NOTE THE ABSENCE OF SPACES</b> inside the &quot;/**/&quot; construct. Any spaces inserted there
3884 will be later also inserted as spaces in your query and may lead to unexpected results especially when
3885 using the variable expansion inside of a &quot;LIKE ''&quot; expression.<br />
3886 Your initial query which is going to be stored as a bookmark has to yield at least one result row so
3887 you can store the bookmark. You may have that to work around using well positioned &quot;/**/&quot;
3888 comments.<br />
3889 </p>
3891 <a name="faq6_19"></a>
3892 <h4>
3893 [<a href="#faq6_19">6.19</a>] How can I create simple LaTeX document to include exported table?
3894 </h4>
3896 You can simply include table in your LaTeX documents, minimal sample
3897 document should look like following one (assuming you have table
3898 exported in file <code>table.tex</code>):
3899 </p>
3901 <pre>
3902 \documentclass{article} % or any class you want
3903 \usepackage{longtable} % for displaying table
3904 \begin{document} % start of document
3905 \include{table} % including exported table
3906 \end{document} % end of document
3907 </pre>
3909 <a name="faq6_20"></a>
3910 <h4>
3911 [<a href="#faq6_20">6.20</a>] In MySQL 4, I see a lot of databases which are not mine, and cannot
3912 access them.
3913 </h4>
3915 Upgrading to MySQL 4 usually gives users those global privileges: CREATE
3916 TEMPORARY TABLES, SHOW DATABASES, LOCK TABLES. Those privileges also
3917 enables users to see all the database names, until you upgrade the grant
3918 tables
3919 <a href="http://dev.mysql.com/doc/mysql/en/Upgrading-grant-tables.html">
3920 as described in the MySQL manual</a>.
3921 See this <a href="http://bugs.mysql.com/179">bug report</a>. <br /><br />
3922 So if your users do not need those privileges, you can remove them and their
3923 databases list will shorten.
3924 </p>
3926 <a name="faq6_21"></a>
3927 <h4>
3928 [<a href="#faq6_21">6.21</a>] In edit/insert mode, how can I see a list of possible values for
3929 a field, based on some foreign table?
3930 </h4>
3932 You have to setup appropriate links between the tables, and also
3933 setup the &quot;display field&quot; in the foreign table. See <a href="#faq6_6">FAQ
3934 6.6</a> for an example. Then, if there are 200 values or less in the
3935 foreign table, a drop-down list of values will be available.
3936 You will see two lists of values, the first list containing the key
3937 and the display field, the second list containing the display field
3938 and the key. The reason for this is to be able to type the first
3939 letter of either the key or the display field.
3940 <br /><br />
3941 For 200 values or more, a distinct window will appear, to browse foreign
3942 key values and choose one.
3944 </p>
3946 <a name="faq6_22"></a>
3947 <h4>
3948 [<a href="#faq6_22">6.22</a>] Bookmarks: Can I execute a default bookmark automatically
3949 when entering Browse mode for a table?
3950 </h4>
3952 Yes. If a bookmark has the same label as a table name, it will be
3953 executed.
3954 </p>
3956 <a name="faq6_23"></a>
3957 <h4>
3958 [<a href="#faq6_23">6.23</a>] Export: I heard phpMyAdmin can export Microsoft Excel files, how
3959 can I enable that?
3960 </h4>
3962 Current version does support direct export ot Microsoft Excel and Word
3963 versions 2000 and newer. If you need export older versions, you can use
3964 CSV suitable for Microsoft Excel, which works out of the box or you can
3965 try native <b>experimental</b> MS Excel exporter. <b>This export has
3966 several problems, most important are limitation of cell content to 255
3967 chars and no support for charsets, so think carefully whether you want to
3968 enable this.</b>. For enabling this you need to set $cfg['TempDir'] to
3969 place where web server user can write (for example <tt>'./tmp'</tt>) and
3970 install PEAR module Spreadsheet_Excel_Writer into php include path. The
3971 installation can be done by following command:
3972 </p>
3973 <pre>
3974 pear -d preferred_state=beta install -a Spreadsheet_Excel_Writer
3975 </pre>
3977 First part of switches set we want to install beta version of that module
3978 (no stable version available yet) and then we tell pear we want to satisfy
3979 dependencies.
3980 </p>
3982 If you are running in PHP safe mode, you will have to set
3983 in <tt>php.ini</tt> the <tt>safe_mode_include_dir</tt> to the directory
3984 where your PEAR modules are located, for example:
3985 </p>
3986 <pre>
3987 safe_mode_include_dir = /usr/local/lib/php
3988 </pre>
3990 To create the temporary directory on a UNIX-based system, you can do:
3991 </p>
3992 <pre>
3993 cd phpMyAdmin
3994 mkdir tmp
3995 chmod o+rwx tmp
3996 </pre>
3998 <a name="faq6_24"></a>
3999 <h4>
4000 [<a href="#faq6_24">6.24</a>] Now that phpMyAdmin supports native MySQL 4.1.x column comments,
4001 what happens to my column comments stored in pmadb?
4002 </h4>
4003 <p> Automatic migration of a table's pmadb-style column comments to the native
4004 ones is done whenever you enter Structure page for this table.
4005 </p>
4006 <a name="faqproject"></a><br />
4007 <h3>[7. phpMyAdmin project]</h3>
4009 <a name="faq7_1"></a>
4010 <h4>
4011 [<a href="#faq7_1">7.1</a>] I have found a bug. How do I inform developers?
4012 </h4>
4014 Our Bug Tracker is located at
4015 <a href="http://sourceforge.net/projects/phpmyadmin/">http://sourceforge.net/projects/phpmyadmin/</a>
4016 under the Bugs section.
4017 <br /><br />
4018 But please first discuss your bug with other users:
4019 <br />
4020 <a href="http://sourceforge.net/projects/phpmyadmin/">
4021 http://sourceforge.net/projects/phpmyadmin/</a> (and choose Forums)
4022 </p>
4024 <a name="faq7_2"></a>
4025 <h4>
4026 [<a href="#faq7_2">7.2</a>] I want to translate the messages to a new language or upgrade an
4027 existing language, where do I start?
4028 </h4>
4030 Always use the current CVS version of your language file.
4031 For a new language, start from <i>english-iso-8859-1.inc.php</i>. If you
4032 don't know how to get the CVS version, please ask one of the developers.
4033 <br />
4034 Please note that we try not to use HTML entities like &amp;eacute; in
4035 the translations, since we define the right character set in the file.
4036 With HTML entities, the text on JavaScript messages would not
4037 display correctly.
4038 However there are some entities that need to be there, for quotes
4039 ,non-breakable spaces, ampersands, less than, greater than.
4040 <br />
4041 You can then put your translations, as a zip file to avoid losing special
4042 characters, on the sourceforge.net translation tracker.
4043 <br />
4044 It would be a good idea to subscribe to the phpmyadmin-translators mailing
4045 list, because this is where we ask for translations of new messages.
4046 <br />
4047 </p>
4049 <a name="faq7_3"></a>
4050 <h4>
4051 [<a href="#faq7_3">7.3</a>] I would like to help out with the development of phpMyAdmin. How
4052 should I proceed?
4053 </h4>
4055 The following method is preferred for new developers:
4056 </p>
4057 <ol>
4058 <li>
4059 fetch the current CVS tree over anonymous CVS:<br />
4060 <tt>cvs -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin login</tt><br />
4061 [Password: simply press the Enter key]<br />
4062 <tt>cvs -z3 -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin checkout phpMyAdmin</tt><br />
4063 [This will create a new sub-directory named phpMyAdmin]
4064 </li>
4065 <li>
4066 add your stuff
4067 </li>
4068 <li>
4069 put the modified files (tar'ed and gzip'ed) inside the patch tracker of
4071 <a href="http://sourceforge.net/projects/phpmyadmin/" target="_blank">phpMyAdmin SourceForge account</a>.
4072 </li>
4073 </ol>
4075 Write access to the CVS tree is granted only to experienced developers who
4076 have already contributed something useful to phpMyAdmin.<br />
4077 Also, have a look at the
4078 <a href="#developers">Developers section</a>.
4079 </p>
4080 <a name="faqsecurity"></a><br />
4081 <h3>[8. Security ]</h3>
4083 <a name="faq8_1"></a>
4084 <h4>
4085 [<a href="#faq8_1">8.1</a>] Security alert, dated 2003-06-18.
4086 </h4>
4088 Last update of this FAQ: 2003-07-22.
4089 <br /><br />
4090 The phpMyAdmin development team received notice of this security alert:
4091 <a href="http://www.securityfocus.com/archive/1/325641" target="_blank">http://www.securityfocus.com/archive/1/325641.</a>
4092 <br /><br />
4094 The team regrets that the author did not communicate with us before
4095 sending this alert. However, here is our current reply to the points mentionned:
4096 </p>
4098 <ul>
4099 <li>&quot;Directory transversal attack&quot;
4100 <br /><br />
4102 This problem had been fixed in version 2.5.0, even if the author reports
4103 the 2.5.2 development version as vulnerable, which we could not reproduce.
4104 <br /><br />
4105 </li>
4106 <li>&quot;Remote local file retrieving&quot;
4107 <br /><br />
4108 This is a misleading title, as the author tells in his text:
4109 &quot;Note that you can't request files ( only dirs )&quot;.
4110 <br /><br />
4111 </li>
4113 <li>&quot;Remote internal directory listing&quot;
4114 <br /><br />
4115 It was possible to retrieve the list of phpMyAdmin's directory (which we
4116 doubt can cause any damage), but we fixed this in the
4117 2.5.2 version.
4118 <br /><br />
4119 </li>
4121 <li>&quot;XSS and Path disclosures&quot;
4122 <br /><br />
4123 Most of the XSS problems have been fixed in version 2.5.0. The rest
4124 have been fixed in the 2.5.2 version.
4125 <br /><br />
4126 We believe that the Path disclosures problems have also been fixed
4127 in version 2.5.2.
4128 <br /><br />
4129 </li>
4130 <li>&quot;Information encoding weakness&quot;
4131 <br /><br />
4132 We believe that an exploit for this weakness would be difficult
4133 to achieve. However version 2.5.2 now encrypts the password
4134 with the well-known blowfish algorithm.
4135 <br /><br />
4136 </li>
4137 </ul>
4139 <a name="faq8_2"></a>
4140 <h4>
4141 [<a href="#faq8_2">8.2</a>] Security alert, dated 2004-06-29.
4142 </h4>
4144 Last update of this FAQ: 2004-06-30.
4145 <br /><br />
4146 The phpMyAdmin development team received notice of this security alert:
4147 <a href="http://securityfocus.com/archive/1/367486/2004-06-26/2004-07-02/0" target="_blank">http://securityfocus.com/archive/1/367486/2004-06-26/2004-07-02/0</a>
4148 <br /><br />
4149 We would like to put emphasis on the disappointment we feel when a
4150 bugreporter does not contact the authors of a software first, before
4151 posting any exploits. The common way to report this, is to give the
4152 developers a reasonable amount of time to respond to an exploit before
4153 it is made public.
4154 <br /><br />
4155 We acknowledge that phpMyAdmin versions 2.5.1 to 2.5.7 are vulnerable
4156 to this problem, if each of the following conditions are met:
4157 </p>
4158 <ul>
4159 <li>
4160 The Web server hosting phpMyAdmin is not running in safe mode.
4161 </li>
4162 <li>
4163 In config.inc.php, <tt>$cfg['LeftFrameLight']</tt> is set to FALSE
4164 (the default value of this parameter is <tt>TRUE</tt>).
4165 </li>
4166 <li>
4167 There is no firewall blocking requests from the Web server to the
4168 attacking host.
4169 </li>
4170 </ul>
4172 <br />
4173 Version 2.5.7-pl1 was released with a fix for this vulnerability.
4174 </p>
4176 <a name="faq8_3"></a>
4177 <h4>
4178 [<a href="#faq8_3">8.3</a>] About new security alerts
4179 </h4>
4181 Please refer to
4182 <a href="http://www.phpmyadmin.net">http://www.phpmyadmin.net</a>
4183 for the complete list of security alerts.
4184 </p>
4186 <!-- DEVELOPERS -->
4187 <a name="developers"></a><br />
4188 <h2>Developers Information</h2>
4191 phpMyAdmin is Open Source, so you're invited to contribute to it. Many
4192 great features have been written by other people and you too can help to
4193 make phpMyAdmin a useful tool.
4194 </p>
4197 If you're planning to contribute source, please read the following
4198 information:
4199 </p>
4200 <ul>
4201 <li>
4202 All files include <i>header.inc.php</i> (layout),
4203 <i>libraries/common.lib.php</i> (common functions) and
4204 <i>config.inc.php</i>.
4205 <br />
4206 Only configuration data should go in <i>config.inc.php</i>. Please keep
4207 it free from other code.
4208 <br />
4209 Commonly used functions should be added to
4210 <i>libraries/common.lib.php</i> and more specific ones may be added
4211 within a library stored into the <i>libraries</i> sub-directory.
4212 </li>
4213 <li>
4214 Obviously, you're free to use whatever coding style you want. But
4215 please try to keep your code as simple as possible: beginners are
4216 using phpMyAdmin as an example application.<br />
4217 As far as possible, we want the scripts to be XHTML1.0 and CSS2
4218 compliant on one hand, they fit the
4219 <a href="http://pear.php.net/" target="_blank">PEAR coding standards</a>
4220 on the other hand. Please pay attention to this.
4221 </li>
4222 <li>
4223 Please try to keep up the file-naming conventions. Table-related stuff
4224 goes to <i>tbl_*.php</i>, db-related code to <i>db_*.php</i>,
4225 server-related tools to <i>server_*.php</i> and so on.
4226 </li>
4227 <li>
4228 Please don't use verbose strings in your code, instead add the string
4229 (at least) to <i>english-iso-8859-1.inc.php</i> and print() it out.
4230 </li>
4231 <li>
4232 If you want to be really helpful, write an entry for the ChangeLog.
4233 </li>
4234 <li id="developersdbg">
4235 The DBG extension (<a href="http://dd.cron.ru/dbg/" target="_blank">PHP
4236 Debugger DBG</a>) is now supported by phpMyAdmin for developers to
4237 better debug and profile their code.<br />
4238 Please see the <tt>$cfg['DBG']*</tt> configuration options for more
4239 information.<br />
4240 This is in memoriam of the Space Shuttle Columbia (STS-107) which was
4241 lost during its re-entry into Earth's atmosphere and in memory of the
4242 brave men and women who gave their lives for the people of Earth.
4243 </li>
4245 </ul>
4247 <!-- CREDITS -->
4248 <a name="credits"></a><br />
4249 <h2>Credits</h2>
4251 <pre>
4253 phpMyAdmin - Credits
4254 ====================
4256 CREDITS, in chronological order
4257 -------------------------------
4259 - Tobias Ratschiller &lt;tobias_at_ratschiller.com&gt;
4260 * creator of the phpmyadmin project
4261 * maintainer from 1998 to summer 2000
4263 - Marc Delisle &lt;DelislMa_at_CollegeSherbrooke.qc.ca&gt;
4264 * multi-language version
4265 * various fixes and improvements
4266 * SQL analyser (most of it)
4267 * current project maintainer
4269 - Olivier M&uuml;ller &lt;om_at_omnis.ch&gt;
4270 * started SourceForge phpMyAdmin project in March 2001
4271 * sync'ed different existing CVS trees with new features and bugfixes
4272 * multi-language improvements, dynamic language selection
4273 * current project maintainer
4274 * many bugfixes and improvements
4276 - Lo&iuml;c Chapeaux &lt;lolo_at_phpheaven.net&gt;
4277 * rewrote and optimized javascript, DHTML and DOM stuff
4278 * rewrote the scripts so they fit the PEAR coding standards and
4279 generate XHTML1.0 and CSS2 compliant codes
4280 * improved the language detection system
4281 * many bugfixes and improvements
4283 - Robin Johnson &lt;robbat2_at_users.sourceforge.net&gt;
4284 * database maintenance controls
4285 * table type code
4286 * Host authentication IP Allow/Deny
4287 * DB-based configuration (Not completed)
4288 * SQL parser and pretty-printer
4289 * SQL validator
4290 * many bugfixes and improvements
4292 - Armel Fauveau &lt;armel.fauveau_at_globalis-ms.com&gt;
4293 * bookmarks feature
4294 * multiple dump feature
4295 * gzip dump feature
4296 * zip dump feature
4298 - Geert Lund &lt;glund_at_silversoft.dk&gt;
4299 * various fixes
4300 * moderator of the phpMyAdmin former users forum at phpwizard.net
4302 - Korakot Chaovavanich &lt;korakot_at_iname.com&gt;
4303 * &quot;insert as new row&quot; feature
4305 - Pete Kelly &lt;webmaster_at_trafficg.com&gt;
4306 * rewrote and fix dump code
4307 * bugfixes
4309 - Steve Alberty &lt;alberty_at_neptunlabs.de&gt;
4310 * rewrote dump code for PHP4
4311 * mySQL table statistics
4312 * bugfixes
4314 - Benjamin Gandon &lt;gandon_at_isia.cma.fr&gt;
4315 * main author of the version 2.1.0.1
4316 * bugfixes
4318 - Alexander M. Turek &lt;me_at_derrabus.de&gt;
4319 * MySQL 4.0 / 4.1 / 5.0 compatibility
4320 * abstract database interface (PMA_DBI) with MySQLi support
4321 * privileges administration
4322 * XML exports
4323 * various features and fixes
4324 * German language file updates
4326 - Mike Beck &lt;mike.beck_at_web.de&gt;
4327 * automatic joins in QBE
4328 * links column in printview
4329 * Relation view
4331 - Michal &#268;iha&#345; &lt;michal_at_cihar.com&gt;
4332 * enhanced index creation/display feature
4333 * feature to use a different charset for HTML than for MySQL
4334 * improvements of export feature
4335 * various features and fixes
4336 * Czech language file updates
4338 - Christophe Gesch&eacute; from the &quot;MySQL Form Generator for PHPMyAdmin&quot;
4339 (http://sourceforge.net/projects/phpmysqlformgen/)
4340 * suggested the patch for multiple table printviews
4342 - Garvin Hicking &lt;me_at_supergarv.de&gt;
4343 * built the patch for vertical display of table rows
4344 * built the Javascript based Query window + SQL history
4345 * Improvement of column/db comments
4346 * (MIME)-Transformations for columns
4347 * Use custom alias names for Databases in left frame
4348 * hierarchical/nested table display
4349 * PDF-scratchboard for WYSIWYG-distribution of PDF relations
4350 * new icon sets
4351 * vertical display of column properties page
4352 * some bugfixes, features, support, German language additions
4354 - Yukihiro Kawada &lt;kawada_at_den.fujifilm.co.jp&gt;
4355 * japanese kanji encoding conversion feature
4357 - Piotr Roszatycki &lt;d3xter_at_users.sourceforge.net&gt; and Dan Wilson
4358 * the Cookie authentication mode
4360 - Axel Sander &lt;n8falke_at_users.sourceforge.net&gt;
4361 * table relation-links feature
4363 - Maxime Delorme &lt;delorme.maxime_at_free.fr&gt;
4364 * PDF schema output, thanks also to Olivier Plathey for the
4365 &quot;FPDF&quot; library (see <a href="http://www.fpdf.org/">http://www.fpdf.org/</a>) and Steven Wittens
4366 for the &quot;UFPDF&quot; library (see <a href="http://www.acko.net/node/56">http://www.acko.net/node/56</a>).
4368 - Olof Edlund &lt;olof.edlund_at_upright.se&gt;
4369 * SQL validator server
4371 - Ivan R. Lanin &lt;ivanlanin_at_users.sourceforge.net&gt;
4372 * phpMyAdmin logo (until June 2004)
4374 - Mike Cochrane &lt;mike_at_graftonhall.co.nz&gt;
4375 * blowfish library from the Horde project
4377 - Marcel Tschopp &lt;ne0x_at_users.sourceforge.net&gt;
4378 * mysqli support
4379 * many bugfixes and improvements
4381 - Michael Keck &lt;mkkeck_at_users.sourceforge.net&gt;
4382 * redesign for 2.6.0
4383 * phpMyAdmin sailboat logo (June 2004)
4385 - Mathias Landh&auml;u&szlig;er
4386 * Representation at conferences
4388 And also to the following people who have contributed minor changes,
4389 enhancements, bugfixes or support for a new language since version 2.1.0:
4391 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
4392 P&eacute;ter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
4393 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kl&auml;ger,
4394 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
4395 Bernard M. Piller, Laurent Haas, &quot;Sakamoto&quot;, Yuval Sarna,
4396 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
4397 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
4398 Luís V., Martijn W. van der Lee,
4399 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
4400 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, &quot;Manuzhai&quot;.
4403 Original Credits of Version 2.1.0
4404 ---------------------------------
4406 This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
4407 to create a web-based interface to MySQL using PHP3. Although I have not
4408 used any of his source-code, there are some concepts I've borrowed from
4409 him. phpMyAdmin was created because Peter told me he wasn't going to
4410 further develop his (great) tool.
4411 Thanks go to
4412 - Amalesh Kempf &lt;ak-lsml_at_living-source.com&gt; who contributed the
4413 code for the check when dropping a table or database. He also suggested
4414 that you should be able to specify the primary key on tbl_create.php3. To
4415 version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
4416 well as a bug-report. Plus many smaller improvements.
4417 - Jan Legenhausen &lt;jan_at_nrw.net&gt;: He made many of the changes that
4418 were introduced in 1.3.0 (including quite significant ones like the
4419 authentication). For 1.4.1 he enhanced the table-dump feature. Plus
4420 bug-fixes and help.
4421 - Marc Delisle &lt;DelislMa_at_CollegeSherbrooke.qc.ca&gt; made phpMyAdmin
4422 language-independent by outsourcing the strings to a separate file. He
4423 also contributed the French translation.
4424 - Alexandr Bravo &lt;abravo_at_hq.admiral.ru&gt; who contributed
4425 tbl_select.php3, a feature to display only some fields from a table.
4426 - Chris Jackson &lt;chrisj_at_ctel.net&gt; added support for MySQL
4427 functions in tbl_change.php3. He also added the
4428 &quot;Query by Example&quot; feature in 2.0.
4429 - Dave Walton &lt;walton_at_nordicdms.com&gt; added support for multiple
4430 servers and is a regular contributor for bug-fixes.
4431 - Gabriel Ash &lt;ga244_at_is8.nyu.edu&gt; contributed the random access
4432 features for 2.0.6.
4433 The following people have contributed minor changes, enhancements, bugfixes
4434 or support for a new language:
4435 Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
4436 Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
4437 Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
4438 G. Wieggers.
4440 And thanks to everyone else who sent me email with suggestions, bug-reports
4441 and or just some feedback.
4442 </pre>
4446 <a name="bottom"></a><br />
4447 <p align="right">
4448 <a href="http://validator.w3.org/check/referer" target="w3c">
4449 <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" border="0" height="31" width="88" /></a>
4450 &nbsp;&nbsp;&nbsp;&nbsp;
4451 <a href="http://jigsaw.w3.org/css-validator/" target="w3c">
4452 <img src="http://www.w3.org/Icons/valid-css" alt="Valid CSS!" border="0" width="88" height="31" /></a>
4453 </p>
4455 </body>
4456 </html>