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">
6 vim: expandtab ts=4 sw=4 sts=4 tw=78
10 <meta http-equiv=
"Content-Type" content=
"text/html; charset=iso-8859-1" />
11 <title>phpMyAdmin
2.5.0-dev - Documentation
</title>
12 <link rel=
"stylesheet" type=
"text/css" href=
"docs.css" />
16 <a name=
"top"></a><br />
19 <hr noshade=
"noshade" width=
"100%" />
20 <a href=
"#top">Top
</a> -
21 <a href=
"#require">Requirements
</a> -
22 <a href=
"#intro">Introduction
</a> -
23 <a href=
"#setup">Installation
</a> -
24 <a href=
"#config">Configuration
</a>
26 <a href=
"#transformations">Transformations
</a> -
27 <a href=
"#faq">FAQ
</a> -
28 <a href=
"#developers">Developers
</a> -
29 <a href=
"#credits">Credits
</a> -
30 <a href=
"translators.html">Translators
</a>
31 <hr noshade=
"noshade" width=
"100%" />
34 <h1>phpMyAdmin
2.5.0-dev Documentation
</h1>
40 <a href=
"http://www.phpmyadmin.net/">
41 SourceForge phpMyAdmin project page
[ http://www.phpmyadmin.net/ ]
47 <li>Version history:
<a href=
"ChangeLog">ChangeLog
</a></li>
48 <li>General notes:
<a href=
"README">README
</a></li>
49 <li>License:
<a href=
"LICENSE">LICENSE
</a></li>
53 Documentation version:
60 <a name=
"require"></a><br />
65 PHP3 or PHP4: phpMyAdmin widely uses the 'str_replace()' PHP function
66 that was added in PHP
3.0.6, but was buggy up until
68 Then
<span class=
"important">you should not run this script with
69 PHP3
< 3.0.8</span>.
<br />
70 PHP also needs to be
<span class=
"important">compiled with MySQL
72 If you want to display inline thumbnails of JPEGs, you also need
76 MySQL (tested with
3.21.x,
3.22.x,
3.23.x and
4.0.x);
<br />
77 <span class=
"important">Note: Because of a major change in the definition
78 syntax of string field types, this version of phpMyAdmin probably won't
79 work correctly with MySQL
>=
4.1.0!
</span>
88 <a name=
"intro"></a><br />
92 phpMyAdmin can manage a whole MySQL server (needs a super-user) as well as
93 a single database. To accomplish the latter you'll need a properly set up
94 MySQL user who can read/write only the desired database. It's up to you to
95 look up the appropriate part in the MySQL manual.
<br />
96 Currently phpMyAdmin can:
100 <li>create and drop databases
</li>
101 <li>create, copy, drop, rename and alter tables
</li>
102 <li>do table maintenance
</li>
103 <li>delete, edit and add fields
</li>
104 <li>execute any SQL-statement, even batch-queries
</li>
105 <li>manage keys on fields
</li>
106 <li>load text files into tables
</li>
107 <li>create (*) and read dumps of tables
</li>
108 <li>export (*) data to CSV, XML and Latex formats
</li>
109 <li>administer multiple servers
</li>
110 <li>manage MySQL users and privileges
</li>
111 <li>check referential integrity
</li>
112 <li>using Query-by-example (QBE), create complex queries automatically connecting required tables
</li>
113 <li>create PDF graphics of your Database layout
</li>
114 <li>search globally in a database or a subset of it
</li>
115 <li>transform stored data into any format using a set of predefined functions,
116 like displaying BLOB-data as image or download-link or ...
</li>
119 <a href=
"./translators.html">42 different languages
</a>
125 phpMyAdmin can compress (Zip, GZip -RFC
1952- or Bzip2 formats) dumps
126 and CSV exports if you use PHP4
>=
4.0.4 with Zlib support
127 (
<tt>--with-zlib
</tt>) and/or Bzip2 support (
<tt>--with-bz2
</tt>).
131 <!-- INSTALLATION -->
132 <a name=
"setup"></a><br />
133 <h2>Installation
</h2>
136 <span class=
"important">NOTE: phpMyAdmin does not apply any special security
137 methods to the MySQL database server. It is still the system administrator's job to
138 grant permissions on the MySQL databases properly.
</span>phpMyAdmin's
139 "Privileges
" page can be used for this.
143 <span class=
"important">Warning for Mac users:
</span>if you are on a MacOS
144 version before OS X, StuffIt unstuffs with Mac formats.
<br />
145 So you'll have to resave as in BBEdit to Unix style ALL phpMyAdmin scripts
146 before uploading them to your server, as PHP seems not to like Mac-style
147 end of lines character (
"<tt>\r
</tt>").
151 <span class=
"important">Documentation warning:
</span> when you see in this
152 document a
<i>.php3
</i> file extension, please transpose to
<i>.php
</i>
153 if you are using a kit with files having this extension.
156 <p><b>Quick Install:
</b></p>
158 <li> Choose and download a distribution kit with the files having the
159 extension (
<i>.php3
</i> or
<i>.php
</i>) depending on the way your
160 web/PHP server interprets those extensions.
</li>
161 <li> Untar or unzip the distribution (be sure to unzip the subdirectories):
162 <tt>tar -xzvf phpMyAdmin_x.x.x.tar.gz
</tt> in your webserver's
163 document root. If you don't have direct access to your document root,
164 put the files in a directory on your local machine, and, after step
3,
165 transfer the directory on your web server using, for example, ftp.
</li>
166 <li> Open the file config.inc.php3 in your favorite editor and change
167 the values for host, user, password and authentication mode to fit
168 your environment. Here,
"host
" means the MySQL server.
169 Also insert the correct value for
<tt>$cfg['PmaAbsoluteUri']
</tt>.
171 <a href=
"#config">Configuration section
</a> for an
172 explanation of all values.
</li>
173 <li> It is recommended that you protect the directory in which you
174 installed phpMyAdmin (unless it's on a closed intranet, or you wish to
175 use HTTP or cookie authentication), for example with HTTP-AUTH (in a
176 <i>.htaccess
</i> file). See the
177 <a href=
"#faq">FAQ section
</a> for additional
180 <i><www.your-host.com
>/
<your-install-dir
>/index.php3
</i>
181 in your browser. phpMyAdmin should now display a welcome screen
182 and your databases, or a login dialog if using HTTP or cookie
183 authentication mode.
</li>
184 <li> For a whole set of new features (bookmarks, comments, SQL-history, PDP-generation)
185 you need to create a set of tables in your database. Please look at your scripts/
186 directory, where you should find a file called
<i>create_tables.sql
</i>.
187 You can already use your phpMyAdmin to create the tables for you. Please be
188 aware that you may have to have special (administrator) privileges to create
189 the database and tables. After having imported the
<i>create_tables.sql
</i> file,
190 you should specify the table names in your config.inc.php3 file. The directives
191 used for that can be found in the
<a href=
"#config">Configuration section
</a>.
</li>
195 <p><b>Upgrading from an older version:
</b></p>
197 <li>Please do not copy your older config.inc.php3 over the new one: it may
198 offer new configuration variables, and the new version may depend on
199 these for normal behavior. It is suggested instead to insert your site
200 values in the new one.
</li>
203 <p><b>Using authentication modes:
</b></p>
205 <li>HTTP and cookie authentication modes are recommended in a
<b>multi-user
206 environment
</b> where you want to give users access to their own
207 database and don't want them to play around with others.
209 Nevertheless be aware that MS Internet Explorer seems to be really
210 buggy about cookies, at least till version
6. And PHP
4.1.1 is also a
211 bit buggy in this area!
<br />
212 Even in a
<b>single-user environment
</b>, you might prefer to use
213 HTTP or cookie mode so that your user/password pair are not in clear
214 in the configuration file.
<br /><br /></li>
216 <li>HTTP and cookie authentication modes are more secure: the MySQL
217 password does not need to be set in the phpMyAdmin configuration file
218 (except for the
"controluser
" -see the
219 <a href=
"#config">Configuration section
</a>).
221 However, keep in mind that the password travels in plain text, unless
222 you are using the HTTPS protocol.
224 In cookie mode, we send the password in a temporary cookie, so most
225 browsers should not store the password in their cookie file.
229 For 'HTTP' and 'cookie' modes, phpMyAdmin needs a controluser that has
230 <b>only
</b> the
<tt>SELECT
</tt> privilege on the
<i>mysql.user (all
231 columns except
"Password
")
</i>,
<i>mysql.db (all columns)
</i>
232 & <i>mysql.tables_priv (all columns except
"Grantor
"
233 & "Timestamp
")
</i>tables.
<br />
234 You must specify the details for the controluser in the
235 <i>config.inc.php3
</i> file under the
236 <tt>$cfg['Servers'][$i]['controluser']
</tt>&
237 <tt>$cfg['Servers'][$i]['controlpass']
</tt> settings.
<br />
238 This example assumes you want to use
<tt>pma
</tt> as the controluser
239 and
<tt>pmapass
</tt> as the controlpass, but
<b>this is only an example:
240 use something else in your file:
</b>
243 GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY 'pmapass';
244 GRANT SELECT (Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv, Create_priv,
245 Drop_priv, Reload_priv, Shutdown_priv, Process_priv, File_priv,
246 Grant_priv, References_priv, Index_priv, Alter_priv)
247 ON mysql.user TO 'pma'@'localhost';
248 GRANT SELECT ON mysql.db TO 'pma'@'localhost';
249 GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv)
250 ON mysql.tables_priv TO 'pma'@'localhost';
253 ... and if you want to use the many new relation and bookmark
257 GRANT SELECT, INSERT, UPDATE, DELETE ON
<pma_db
> TO 'pma'@'localhost';
259 (this of course requires you to have a special DB for
260 phpMyAdmin, the contents will be explained later)
263 Then each of the
<i>true
</i> users should be granted a set of
264 privileges on a set of particular databases. Normally you shouldn't
265 give global privileges to an ordinary user, unless you understand
266 the impact of those privileges (for example, you are creating
268 For example, to grant the user
<i>real_user
</i> with
269 all privileges on the database
<i>user_base
</i>:
<br />
270 <tt>GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost IDENTIFIED BY 'real_password';
</tt>
272 What the user may now do is controlled entirely by the MySQL user
273 management system.
<br />
274 With HTTP or cookie authentication mode, you don't need to fill the user/password
275 fields inside the
<tt>$cfg['Servers']
</tt> array.
<br />
279 <p><b>'http' authentication mode:
</b></p>
281 <li>Was called 'advanced' in versions before
2.2.3.
</li>
282 <li>Introduced in
1.3.0, it uses Basic HTTP authentication method and
283 allows you to login as any valid MySQL user.
</li>
284 <li>Is only supported with PHP running as an Apache module, not with
288 <p><b>'cookie' authentication mode:
</b></p>
290 <li>You can use this method as a replacement for the HTTP
291 authentication (for example, if you're running IIS).
293 <li>Obviously, the user must enable cookies in the browser.
</li>
294 <li>With this mode, the use can truly logout of phpMyAdmin and login back
295 with the same username.
</li>
298 <p><b>'config' authentication mode:
</b></p>
300 <li>This mode is the less secure one because it requires you to fill the
301 <tt>$cfg['Servers'][$i]['user']
</tt> and
302 <tt>$cfg['Servers'][$i]['password']
</tt> fields.
<br />
303 But you don't need to setup a
"controluser
" here:
304 using the
<tt>$cfg['Servers'][$i]['only_db']
</tt> might be enough.
</li>
305 <li>In the ISP FAQ section, there is an entry explaining how to protect
306 your configuration file.
<br /></li>
307 <li>For additional security in this mode, you may wish to consider the
308 Host authentication
<tt>$cfg['Servers'][$i]['AllowDeny']['order']
</tt>
309 and
<tt>$cfg['Servers'][$i]['AllowDeny']['rules']
</tt> configuration
314 <!-- CONFIGURATION -->
315 <a name=
"config"></a><br />
316 <h2>Configuration
</h2>
319 <span class=
"important">Warning for Mac users:
</span> PHP seems not to like
320 Mac end of lines character (
"<tt>\r
</tt>"). So ensure you choose
321 the option that allows to use the *nix end of line character
322 (
"<tt>\n
</tt>") in your text editor before registering a script
326 <p>All configurable data is placed in
<i>config.inc.php3
</i>.
</p>
328 <dt><b>$cfg['PmaAbsoluteUri']
</b> string
</dt>
330 Sets here the complete URL (with full path) to your phpMyAdmin version.
331 E.g.
<tt>http://www.your_web.net/path_to_your_phpMyAdmin_directory/
</tt>.
333 phpMyAdmin needs this setting, because of requirements of the HTTP
334 protocol, explained in RFC2616, section
14.30.
336 Don't forget the slash at the end of your URL. The URL must contain
337 characters that are valid for a URL, and on some servers, the path
340 Starting with version
2.3.0, you can try to leave this parameter
341 empty, because the program tries to auto-detect its proper value.
342 Additional details are in the configuration file.
344 Alternatively, this setting can be dynamically completed. For example,
345 you can try to use such a kind of code:
347 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
348 . $_SERVER['HTTP_HOST']
349 . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
350 . substr($_SERVER['PHP_SELF'],
0, strrpos($_SERVER['PHP_SELF'], '/')+
1);
354 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
355 . $_SERVER['SERVER_NAME']
356 . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
357 . substr($_SERVER['SCRIPT_NAME'],
0, strrpos($_SERVER['SCRIPT_NAME'], '/')+
1);
359 Please note that the
<tt>$_SERVER
</tt> array doesn't exist in
360 PHP
< 4.1.0. Try to replace
<tt>$_SERVER
</tt> by
361 <tt>$HTTP_SERVER_VARS
</tt> or
<tt>$GLOBALS
</tt> in this case.
364 <dt><b>$cfg['PmaAbsoluteUri_DisableWarning']
</b> boolean
</dt>
366 By default, when you leave $cfg['PmaAbsoluteUri'] empty, and the system
367 detects your absolute URI automatically, we display a warning to remind
368 you. If you have tested the automatic detection, and it works perfectly
369 for your setup, then you can set this variable to squelch the warning.
373 <dt><b>$cfg['PmaNoRelation_DisableWarning']
</b> boolean
</dt>
375 Starting with version
2.3.0 phpMyAdmin offers a lot of features to work
376 with master / foreign - tables (see
377 <a href=
"#pmadb">$cfg['Servers'][$i]['pmadb']
</a>).
379 If you tried to set this up and it does not work for you, have a look on
380 the
"Structure
" page of one database where you would like to
381 use it. You will find a link that will analyze why those features have
383 If you do not want to use those features set this variable to
384 <tt>TRUE
</tt> to stop this message from appearing.
388 <dt><b>$cfg['Servers']
</b> array
</dt>
390 Since version
1.4.2, phpMyAdmin supports the administration of multiple
392 Therefore, a $cfg['Servers']-array has been added which contains
393 the login information for the different servers. The first
394 <tt>$cfg['Servers'][$i]['host']
</tt> contains the hostname of the first
395 server, the second
<tt>$cfg['Servers'][$i]['host']
</tt> the hostname of
396 the second server, etc.
397 If you have only one server to administer, simply leave free the
398 hostname of the other $cfg['Server']-entries.
402 <dt><b>$cfg['Servers'][$i]['host']
</b> string
</dt>
404 The hostname of your $i-th MySQL-server. E.g. localhost.
408 <dt><b>$cfg['Servers'][$i]['port']
</b> string
</dt>
410 The port-number of your $i-th MySQL-server. Default is
3306 (leave
415 <dt><b>$cfg['Servers'][$i]['socket']
</b> string
</dt>
417 The path to the socket to use. Leave blank for default.
<br />
418 To use the socket feature you must run PHP
3.0.10 or more.
422 <dt><b>$cfg['Servers'][$i]['connect_type']
</b> string
</dt>
424 What type connection to use with the MySQL server. Your options are
425 <tt>'socket'
</tt> & <tt>'tcp'
</tt>. It defaults to 'tcp' as that
426 is nearly guaranteed to be available on all MySQL servers, while
427 sockets are not supported on some platforms.
429 To use the socket mode, your MySQL server must be on the same machine
434 <dt><b>$cfg['Servers'][$i]['compress']
</b> boolean
</dt>
436 Whether to use a compressed protocol for the MySQL server connection
437 or not (experimental).
<br />
438 This feature requires PHP
>=
4.3.0.
442 <b>$cfg['Servers'][$i]['controluser']
</b> string
<br />
443 <b>$cfg['Servers'][$i]['controlpass']
</b> string
446 When using HTTP or cookie authentication modes (or 'config'
447 authentication mode since phpMyAdmin
2.2.1), you need to supply the
448 details of a MySQL account that has
<tt>SELECT
</tt> privilege on the
449 <i>mysql.user (all columns except
"Password
")
</i>,
450 <i>mysql.db (all columns)
</i> & <i>mysql.tables_priv (all columns
451 except
"Grantor
" & "Timestamp
")
</i>tables.
452 This account is used to check what databases the user will see at
454 Please see the
<a href=
"#setup">install section
</a>
455 on
"Using HTTP authentication
" for more information.
457 Note that if you try login to phpMyAdmin with this
458 "controluser
", you could get some errors, depending the exact
459 privileges you gave to the
"controluser
". phpMyAdmin does not
460 support a direct login with the
"controluser
".
462 In versions before
2.2.5, those were called
463 "stduser/stdpass
".
467 <dt><b>$cfg['Servers'][$i]['auth_type']
</b> string
<tt>['http'|'cookie'|'config']
</tt></dt>
469 Whether config or cookie or http authentication should be used for this
474 'config' authentication
475 (
<tt>$auth_type
=
'config'
</tt>) is the plain old
476 way: username and password are stored in
477 <i>config.inc.php3
</i>.
480 'cookie' authentication mode
481 (
<tt>$auth_type
=
'cookie'
</tt>) as introduced in
482 2.2.3 allows you to log in as any valid MySQL user with the
483 help of... cookies. Log name and password are stored in
484 cookies during the session and password is deleted when it
488 'http' authentication (was called 'advanced' in older versions)
489 (
<tt>$auth_type
=
'http'
</tt>) as introduced in
1.3.0
490 allows you to log in as any valid MySQL user via HTTP-Auth.
494 Please see the install section on
"Using authentication modes
"
495 for more information.
500 <b>$cfg['Servers'][$i]['user']
</b> string
<br />
501 <b>$cfg['Servers'][$i]['password']
</b> string
504 The user/password-pair which phpMyAdmin will use to connect to this
505 MySQL-server. This user/password pair is not needed when HTTP or cookie
506 authentication is used, and should be empty.
<br /><br />
509 <dt><b>$cfg['Servers'][$i]['only_db']
</b> string or array
</dt>
511 If set to a(an array of) database name(s), only this(these) database(s)
512 will be shown to the user. Since phpMyAdmin
2.2.1, this/these
513 database(s) name(s) may contain MySQL wildcards characters
514 (
"_
" and
"%
"): if you want to use literal instances
515 of these characters, escape them (I.E. use
<tt>'my\_db'
</tt> and not
516 <tt>'my_db'
</tt>).
<br />
517 This setting is an efficient way to lower the server charge since the
518 latter does not need to send MySQL requests to build the available
519 database list. But
<span class=
"important">it does not replace the
520 privileges rules of the MySQL database server
</span>. If set, it just
521 means only these databases will be displayed but
522 <span class=
"important">not at all other databases can't be used.
</span>
526 <dt><b>$cfg['Servers'][$i]['verbose']
</b> string
</dt>
528 Only useful when using phpMyAdmin with multiple server entries. If set,
529 this string will be displayed instead of the hostname in the pull-down
530 menu on the main page. This can be useful if you want to show only
531 certain databases on your system, for example.
536 <a name=
"pmadb"></a><br />
537 <b>$cfg['Servers'][$i]['pmadb']
</b> string
540 Starting with version
2.3.0 phpMyAdmin offers a lot of features
541 to work with master / foreign - tables. To use those as well as
542 the bookmark feature you need special tables with a
543 predefined structure, which we explain below.
<br />
544 If you are the only user of this phpMyAdmin installation, you can
545 use your current database to store those special tables; in this
546 case, just put your current database name in
547 <tt>$cfg['Servers'][$i]['pmadb']
</tt>.
549 If you are setting up a multi-user phpMyAdmin installation,
550 you will need to create a new database and setup special privileges,
555 create a new database for phpMyAdmin:
<br />
556 <tt> CREATE DATABASE phpmyadmin;
</tt><br />
557 Note that
"controluser
" must have
558 <tt>SELECT, INSERT, UPDATE
</tt> and
<tt>DELETE
</tt>
559 privileges on this database. Here is a query to set up
560 those privileges (using
"phpmyadmin
"
561 as the database name, and
"pma
" as the
564 GRANT SELECT,INSERT,UPDATE,DELETE ON phpmyadmin.* to 'pma'@'localhost';
566 do
<b>not
</b> give any other user rights on this database.
569 enter the database name in
<tt>$cfg['Servers'][$i]['pmadb']
</tt>
575 <a name=
"bookmark"></a><br />
576 <b>$cfg['Servers'][$i]['bookmarktable']
</b> string
579 Since release
2.2.0 phpMyAdmin allows to bookmark queries. This can be
580 useful for queries you often run.
<br /><br />
582 To allow the usage of this functionality you have to:
584 <li>set up
"pmadb
" as described above
</li>
585 <li>within this database create a table following this scheme:
588 CREATE TABLE `PMA_bookmark` (
<br />
589 id int(
11) DEFAULT '
0' NOT NULL auto_increment,
<br />
590 dbase varchar(
255) NOT NULL,
<br />
591 user varchar(
255) NOT NULL,
<br />
592 label varchar(
255) NOT NULL,
<br />
593 query text NOT NULL,
<br />
594 PRIMARY KEY (id)
<br />
595 ) TYPE=MyISAM COMMENT='Bookmarks';
<br />
598 <li>enter the table name in
599 <tt>$cfg['Servers'][$i]['bookmarktable']
</tt></li>
604 <a name=
"relation"></a><br />
605 <b>$cfg['Servers'][$i]['relation']
</b> string
608 Since release
2.2.4 you can describe, in a special 'relation' table,
609 which field is a key in another table (a foreign key). phpMyAdmin
610 currently uses this to
613 make clickable, when you browse the master table, the data values
614 that point to the foreign table;
617 display in an optional tool-tip the
"display field
"
618 when browsing the master table, if you move the mouse to a column
619 containing a foreign key (use also the 'table_info' table);
622 display links on the table properties page, to check referential
623 integrity (display missing foreign keys) for each described key;
626 in query-by-example, create automatic joins (see an example in
627 the FAQ, section
"Using phpMyAdmin
");
630 enable you to get a PDF schema of your database (also uses the
636 The keys can be numeric or character.
639 To allow the usage of this functionality the superuser has to:
641 <li>set up
"pmadb
" as described above
</li>
643 within this database create a table following this scheme:
646 CREATE TABLE `PMA_relation` (
<br />
647 `master_db` varchar(
64) NOT NULL default '',
<br />
648 `master_table` varchar(
64) NOT NULL default '',
<br />
649 `master_field` varchar(
64) NOT NULL default '',
<br />
650 `foreign_db` varchar(
64) NOT NULL default '',
<br />
651 `foreign_table` varchar(
64) NOT NULL default '',
<br />
652 `foreign_field` varchar(
64) NOT NULL default '',
<br />
653 PRIMARY KEY (`master_db`, `master_table`, `master_field`),
<br />
654 KEY foreign_field (foreign_db, foreign_table)
<br />
655 ) TYPE=MyISAM COMMENT='Relation table';
<br />
659 put the relation table name in
660 <tt>$cfg['Servers'][$i]['relation']
</tt>
663 now as normal user open phpMyAdmin and for each one of your
664 tables where you want to use this feature, click
665 "Structure/Relation view/
" and choose foreign fields.
668 Please note that in the current (
2.3.0) version,
<tt>master_db
</tt>
669 must be the same as
<tt>foreign_db
</tt>. Those fields have been put in
670 future development of the cross-db relations.
<br /><br />
674 <a name=
"table_info"></a><br />
675 <b>$cfg['Servers'][$i]['table_info']
</b> string
678 Since release
2.3.0 you can describe, in a special 'table_info'
679 table, which field is to be displayed as a tool-tip when moving the
680 cursor over the corresponding key.
682 This configuration variable will hold the name of this special
684 To allow the usage of this functionality the superuser has to:
686 <li>set up
"pmadb
" as described above
</li>
687 <li>within this database create a table following this scheme:
690 CREATE TABLE `PMA_table_info` (
<br />
691 `db_name` varchar(
64) NOT NULL default '',
<br />
692 `table_name` varchar(
64) NOT NULL default '',
<br />
693 `display_field` varchar(
64) NOT NULL default '',
<br />
694 PRIMARY KEY (`db_name`, `table_name`)
<br />
695 ) TYPE=MyISAM COMMENT='Table information for phpMyAdmin';
<br />
699 put the table name in
700 <tt>$cfg['Servers'][$i]['table_info']
</tt>
703 then for each table where you want to use this feature,
704 click
"Structure/Relation view/Choose field to display
"
708 Usage tip:
<a href=
"#faqdisplay">Display field
</a>.
713 <a name=
"table_coords"></a><br />
714 <b>$cfg['Servers'][$i]['table_coords']
</b> string
<br />
715 <b>$cfg['Servers'][$i]['pdf_pages']
</b> string
718 Since release
2.3.0 you can have phpMyAdmin create PDF pages showing
719 the relations between your tables. To do this it needs two tables
720 "pdf_pages
" (storing information about the available PDF
721 pages) and
"table_coords
" (storing coordinates where each
722 table will be placed on a PDF schema output).
724 You must be using the
"relation
" feature and have a table of
725 PDF pages (see
<tt>$cfg['Servers'][$i]['pdf_pages']
</tt>) to create PDF
728 To allow the usage of this functionality the superuser has to:
730 <li>set up
"pmadb
" as described above
</li>
732 within this database create a table following this scheme:
735 CREATE TABLE `PMA_table_coords` (
<br />
736 `db_name` varchar(
64) NOT NULL default '',
<br />
737 `table_name` varchar(
64) NOT NULL default '',
<br />
738 `pdf_page_number` int NOT NULL default '
0',
<br />
739 `x` float unsigned NOT NULL default '
0',
<br />
740 `y` float unsigned NOT NULL default '
0',
<br />
741 PRIMARY KEY (`db_name`, `table_name`, `pdf_page_number`)
<br />
742 ) TYPE=MyISAM COMMENT='Table coordinates for phpMyAdmin PDF output';
<br />
746 also within this database create:
<br />
748 CREATE TABLE `PMA_pdf_pages` (
<br />
749 `db_name` varchar(
64) NOT NULL default '',
<br />
750 `page_nr` int(
10) unsigned NOT NULL auto_increment,
<br />
751 `page_descr` varchar(
50) NOT NULL default '',
<br />
752 PRIMARY KEY (page_nr),
<br />
753 KEY (db_name)
<br />
754 ) TYPE=MyISAM COMMENT='PDF Relationpages for PMA';
<br />
758 put the first table name in
759 <tt>$cfg['Servers'][$i]['table_coords']
</tt>
760 and the second table name in
761 <tt>$cfg['Servers'][$i]['pdf_pages']
</tt>
764 Usage tips:
<a href=
"#faqpdf">PDF output
</a>.
769 <a name=
"col_com"></a><br />
770 <b>$cfg['Servers'][$i]['column_info']
</b> string
773 <!-- This part requires a content update! -->
774 Since release
2.3.0 you can store comments to describe each column
775 for each table. These will then be shown on the
"printview
".
777 Starting with release
2.5.0, comments are consequently used on the table property
778 pages and table browse view, showing up as tool-tips above the column name (properties page)
779 or embedded within the header of table in browse view. They can also be shown
780 in a table dump. Please see the relevant configuration directives later on.
782 Also new in release
2.5.0 is a mime-transformation system which is also based on
783 the following table structure. See
<a href=
"#transformations">Transformations
</a>
784 for further information. To use the mime-transformation system, your column_info
785 table has to have the three new fields 'mimetype', 'transformation', 'transformation_options'.
787 To allow the usage of this functionality the superuser has to:
789 <li>set up
"pmadb
" as described above
</li>
791 within this database create a table following this scheme:
794 CREATE TABLE `PMA_column_info` (
<br />
795 id int(
5) unsigned NOT NULL auto_increment,
<br />
796 db_name varchar(
64) NOT NULL default '',
<br />
797 table_name varchar(
64) NOT NULL default '',
<br />
798 column_name varchar(
64) NOT NULL default '',
<br />
799 `comment` varchar(
255) NOT NULL default '',
<br />
800 mimetype varchar(
255) NOT NULL default '',
<br />
801 transformation varchar(
255) NOT NULL default '',
<br />
802 transformation_options varchar(
255) NOT NULL default '',
<br />
803 PRIMARY KEY (id),
<br />
804 UNIQUE KEY db_name (db_name, table_name, column_name)
<br />
805 ) TYPE=MyISAM COMMENT='Comments for Columns';
<br />
809 put the table name in
810 <tt>$cfg['Servers'][$i]['column_info']
</tt>
813 To update your PRE-
2.5.0 Column_comments Table use this:
<br />
815 ALTER TABLE `PMA_column_comments`
<br />
816 ADD `mimetype` VARCHAR(
255 ) NOT NULL ,
<br />
817 ADD `transformation` VARCHAR(
255 ) NOT NULL ,
<br />
818 ADD `transformation_options` VARCHAR(
255 ) NOT NULL ;
<br />
820 and remember that the Variable in config.inc.php has been renamed
821 from
<br />$cfg['Servers'][$i]['column_comments'] to $cfg['Servers'][$i]['column_info']
827 <a name=
"history"></a><br />
828 <b>$cfg['Servers'][$i]['history']
</b> string
831 Since release
2.5.0 you can store your SQL history, which means all queries you
832 entered manually into the phpMyAdmin interface. If you don't want to use a table-
833 based history, you can use the JavaScript-based history. Using that, all your
834 history items are deleted when closing the window.
<br /><br />
836 Using
<b>$cfg['QueryHistoryMax']
</b> you can specify an amount of history items
837 you want to have on hold. On every login, this list gets cut to the maximum amount.
840 The query history is only available if you use the JavaScript-based query window,
841 see
<b>$cfg['QueryFrame']
</b>.
844 To allow the usage of this functionality the superuser has to:
846 <li>set up
"pmadb
" as described above
</li>
848 within this database create a table following this scheme:
851 CREATE TABLE `PMA_history` (
<br />
852 `id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
<br />
853 `username` VARCHAR(
64 ) NOT NULL ,
<br />
854 `db` VARCHAR(
64 ) NOT NULL ,
<br />
855 `table` VARCHAR(
64 ) NOT NULL ,
<br />
856 `timevalue` TIMESTAMP NOT NULL ,
<br />
857 `sqlquery` TEXT NOT NULL ,
<br />
858 PRIMARY KEY ( `id` ) ,
<br />
859 INDEX ( `username` , `db` , `table` , `timevalue` )
<br />
860 ) TYPE=MyISAM COMMENT='SQL history';
<br />
864 put the table name in
865 <tt>$cfg['Servers'][$i]['history']
</tt>
871 <a name=
"history"></a><br />
872 <b>$cfg['Servers'][$i]['verbose_check']
</b> string
875 Because release
2.5.0 introduced the new MIME-transformation support, the
876 column_info table got enhanced with three new fields. If the above variable is
877 set to TRUE (default) phpMyAdmin will check if you have the latest table structure
878 available. If not, it will emit a warning to the superuser.
<br /><br />
880 You can disable this checking behavior by setting the variable to false, which
881 should offer a performance increase.
<br /><br />
883 Recommended to set to FALSE, when you are sure, your table structure is up to date.
888 <b>$cfg['Servers'][$i]['AllowDeny']['order']
</b> string
891 If your rule order is empty, then IP authentication is disabled.
893 If your rule order is set to
<tt>'deny,allow'
</tt> then the system
894 applies all deny rules followed by allow rules.
895 Access is allowed by default. Any client which does not match a Deny
896 command or does match an Allow command will be allowed access to the
899 If your rule order is set to
<tt>'allow,deny'
</tt> then the system
900 applies all allow rules followed by deny rules. Access is denied by
901 default. Any client which does not match an Allow directive or does
902 match a Deny directive will be denied access to the server.
904 If your rule order is set to 'explicit', the authentication is
905 performed in a similar fashion to rule order 'deny,allow', with the
906 added restriction that your host/username combination
<b>must
</b> be
907 listed in the
<i>allow
</i> rules, and not listed in the
<i>deny
</i>
908 rules. This is the
<b>most
</b> secure means of using Allow/Deny rules,
909 and was available in Apache by specifying allow and deny rules without
915 <b>$cfg['Servers'][$i]['AllowDeny']['rules']
</b> array of strings
918 The general format for the rules is as such:
<br />
920
921 <'allow' | 'deny'
> <username
> [from]
<ipmask
>
925 If you wish to match all users, it is possible to use a
<tt>'%'
</tt> as
926 a wildcard in the
<i>username
</i> field.
<br />
927 There are a few shortcuts you can use in the
<i>ipmask
</i> field as
930 'all' -
> 0.0.0.0/
0<br />
931 'localhost' -
> 127.0.0.1/
8
935 Having an empty rule list is equivalent to either using
936 <tt>'allow % from all'
</tt> if your rule order is set to
937 <tt>'deny,allow'
</tt> or
<tt>'deny % from all'
</tt> if your rule order
938 is set to
<tt>'allow,deny'
</tt> or
<tt>'explicit'
</tt>.
941 For the IP matching system, the following work:
<br />
942 <tt>xxx.xxx.xxx.xxx
</tt> (an exact IP address)
<br />
943 <tt>xxx.xxx.xxx.[yyy-zzz]
</tt> (an IP address range)
<br />
944 <tt>xxx.xxx.xxx.xxx/nn
</tt> (CIDR, Classless Inter-Domain Routing type IP addresses)
<br />
945 But the following does not work:
<br />
946 <tt>xxx.xxx.xxx.xx[yyy-zzz]
</tt> (partial IP address range)
950 <dt><b>$cfg['ServerDefault']
</b> integer
</dt>
952 If you have more than one server configured, you can set
953 <tt>$cfg['ServerDefault']
</tt> to any one of them to autoconnect to
954 that server when phpMyAdmin is started, or set it to
0 to be given a
955 list of servers without logging in.
<br />
956 If you have only one server configured,
<tt>$cfg['ServerDefault']
</tt>
957 MUST be set to that server.
961 <dt><b>$cfg['OBGzip']
</b>boolean
</dt>
963 Defines whether to use GZip output buffering for increased
964 speed in HTTP transfers.
968 <dt><b>$cfg['PersistentConnections']
</b>boolean
</dt>
970 Whether persistent connections should be used or not (mysql_connect or
975 <dt><b>$cfg['ExecTimeLimit']
</b>integer [number of seconds]
</dt>
977 Set the number of seconds a script is allowed to run. If seconds is set
978 to zero, no time limit is imposed.
<br />
979 This setting is used while importing/exporting dump files but has no
980 effect when PHP is running in safe mode.
984 <dt><b>$cfg['SkipLockedTables']
</b>boolean
</dt>
986 Mark used tables and make it possible to show databases with locked
987 tables (since
3.23.30).
991 <dt><b>$cfg['ShowSQL']
</b>boolean
</dt>
993 Defines whether SQL-queries generated by phpMyAdmin should be displayed
998 <dt><b>$cfg['AllowUserDropDatabase']
</b>boolean
</dt>
1000 Defines whether normal users (non-administrator) are allowed to
1001 delete their own database or not. If set as FALSE, the link
"Drop
1002 Database
" will not be shown, and even a
"DROP DATABASE
1003 mydatabase
" will be rejected. Quite practical for ISP's with many
1008 <dt><b>$cfg['Confirm']
</b>boolean
</dt>
1010 Whether a warning (
"Are your really sure..
") should be
1011 displayed when you're about to loose data.
1015 <dt><b>$cfg['LoginCookieRecall']
</b>boolean
</dt>
1017 Define whether the previous login should be recalled or not in cookie
1018 authentication mode.
1022 <dt><b>$cfg['UseDbSearch']
</b>boolean
</dt>
1024 Define whether the
"search string inside database" is enabled or not.
1028 <dt><b>$cfg['LeftFrameLight']
</b> boolean
</dt>
1030 Defines whether to use select-based menu and display only the current
1031 tables in the left frame (smaller page).
1035 <dt><b>$cfg['ShowTooltip']
</b>boolean
</dt>
1037 Defines whether to display table comment as tool-tip in left frame or
1042 <dt><b>$cfg['ShowTooltipAliasDB']
</b>boolean
</dt>
1044 If tool-tips are enabled and a DB comment is set, this will flip the comment
1045 and the real name. That means, if you have a table called 'user0001' and add
1046 the comment 'MyName' on it, you will see the name 'MyName' used consequently
1047 in the left frame and the tool-tip shows the real name of the DB.
1051 <dt><b>$cfg['ShowTooltipAliasTB']
</b>boolean
</dt>
1053 Same as $cfg['ShowTooltipAliasDB'], except this works for table names.
1057 <dt><b>$cfg['ShowStats']
</b>boolean
</dt>
1059 Defines whether to display space usage and statistics about databases
1060 and tables or not.
<br />
1061 Note that statistics requires at least MySQL
3.23.3 and that, at this
1062 date, MySQL doesn't return such information for Berkeley DB tables.
1067 <b>$cfg['ShowMysqlInfo']
</b>boolean
<br />
1068 <b>$cfg['ShowMysqlVars']
</b>boolean
<br />
1069 <b>$cfg['ShowPhpInfo']
</b>boolean
<br />
1070 <b>$cfg['ShowChgPassword']
</b>boolean
1073 Defines whether to display the
"MySQL runtime information
",
1074 "MySQL system variables
",
"PHP information
" and
1075 "Change password
" links or not for simple users at the
1076 starting main (right) frame. This setting does not check MySQL commands
1080 Please note that to block the usage of phpinfo() in scripts, you
1081 have to put this in your php.ini:
<br />
1082 <tt>disable_functions = phpinfo()
</tt>
1085 Also note that enabling the
"Change password
" link has no
1086 effect with
"config
" authentication mode: because of the hard
1087 coded password value in the configuration file, end users can't be
1088 allowed to change their passwords.
1092 <dt><b>$cfg['SuggestDBName']
</b> boolean
</dt>
1094 Defines whether to suggest a database name on the
1095 "Create Database
" form or to keep the textfield empty.
1099 <dt><b>$cfg['ShowBlob']
</b>boolean
</dt>
1101 Defines whether
<tt>BLOB
</tt> fields are shown when browsing a table's
1106 <dt><b>$cfg['NavigationBarIconic']
</b>boolean
</dt>
1108 Defines whether navigation bar buttons contain text or symbols only.
1112 <dt><b>$cfg['ShowAll']
</b>boolean
</dt>
1114 Defines whether an user should be displayed a
1115 "show all (records)
" button in browse mode or not.
1119 <dt><b>$cfg['MaxRows']
</b>integer
</dt>
1121 Number of rows displayed when browsing a result set. If the result set
1122 contains more rows, Previous/Next links will be shown.
1126 <dt><b>$cfg['Order']
</b>string [
<tt>DESC
</tt>|
<tt>ASC
</tt>|
<tt>SMART
</tt>]
</dt>
1128 Defines whether fields are displayed in ascending (
<tt>ASC
</tt>) order,
1129 in descending (
<tt>DESC
</tt>) order or in a
"smart
"
1130 (
<tt>SMART
</tt>) order - I.E. descending order for fields of type TIME,
1131 DATE, DATETIME
& TIMESTAMP, ascending order else- by default.
1135 <dt><b>$cfg['ProtectBinary']
</b>boolean or string
</dt>
1137 Defines whether
<tt>BLOB
</tt> or
<tt>BINARY
</tt> fields are protected
1138 from edition when browsing a table's content or not.
1139 Valid values are:
<br />
1140 -
<tt>FALSE
</tt> to allow edition of all fields;
<br />
1141 -
<tt>blob
</tt> to allow edition of all fields except
<tt>BLOBS
</tt>;
1143 -
<tt>all
</tt> to disallow edition of all
<tt>BINARY
</tt> or
1144 <tt>BLOB
</tt> fields.
1148 <dt><b>$cfg['ShowFunctionFields']
</b>boolean
</dt>
1150 Defines whether MySQL functions fields should be displayed or not in
1155 <dt><b>$cfg['CharEditing']
</b>string
</dt>
1157 Defines which type of editing controls should be used for CHAR and
1158 VARCHAR fields. Possible values are:
1161 input - this allows to limit size of text to size of field in
1162 MySQL, but has problems with newlines in fields
1165 textarea - no problems with newlines in fields, but also no
1169 Default is old behavior so input.
1174 <b>$cfg['ZipDump']
</b>boolean
<br />
1175 <b>$cfg['GZipDump']
</b>boolean
<br />
1176 <b>$cfg['BZipDump']
</b>boolean
1179 Defines whether to allow the use of zip/GZip/BZip2 compression when
1180 creating a dump file or not.
1184 <dt><b>$cfg['LightTabs']
</b>string
</dt>
1186 If set to True, do use less graphically intense tabs on the top of the mainframe.
1190 <dt><b>$cfg['DefaultTabServer']
</b>string
</dt>
1192 Defines the tab displayed by default on server view. Possible
1193 values:
"main.php3
" (recommended for multi-user setups),
1194 "server_databases.php3
",
"server_status.php3
",
1195 "server_variables.php3
",
"server_privileges.php3
" or
1196 "server_processlist.php3
".
1200 <dt><b>$cfg['DefaultTabDatabase']
</b>string
</dt>
1202 Defines the tab displayed by default on database view. Possible
1203 values:
"db_details_structure.php3
",
1204 "db_details.php3
" or
"db_search.php3
".
1208 <dt><b>$cfg['DefaultTabTable']
</b>string
</dt>
1210 Defines the tab displayed by default on table view. Possible
1211 values:
"tbl_properties_structure.php3
",
1212 "tbl_properties.php3
",
"tbl_select.php3
" or
1213 "tbl_change.php3
".
1217 <dt><b>$cfg['MySQLManualBase']
</b> string
</dt>
1219 If set to an URL which points to the MySQL documentation (type depends
1220 on
<tt>$cfg['MySQLManualType']
</tt>), appropriate help links are
1223 See
<a href=
"http://www.mysql.com/documentation/index.html">MySQL
1224 Documentation page
</a> for more information about MySQL manuals and
1229 <dt><b>$cfg['MySQLManualType']
</b> string
</dt>
1231 Type of MySQL documentation:
1233 <li>old - old style used in phpMyAdmin
2.3.0 and sooner
</li>
1234 <li>searchable -
"Searchable, with user comments
"</li>
1235 <li>chapters -
"HTML, one page per chapter
"</li>
1236 <li>big -
"HTML, all on one page
"</li>
1237 <li>none - do not show documentation links
</li>
1242 <dt><b>$cfg['DefaultLang']
</b>string
</dt>
1244 Defines the default language to use, if not browser-defined or
1246 See the
<i>select_lang.inc.php3
</i> script to know the valid values for
1251 <dt><b>$cfg['Lang']
</b>string
</dt>
1253 Force: always use this language (must be defined in the
1254 <i>select_lang.inc.php3
</i> script).
1258 <dt><b>$cfg['DefaultCharset']
</b>string
</dt>
1260 Default character set to use for recoding of MySQL queries. This must be
1261 enabled and it's described by
<tt>$cfg['AllowAnywhereRecoding']
</tt>
1263 You can give here any character set which is in
1264 <tt>$cfg['AvailableCharsets']
</tt> array and this is just default
1265 choice, user can select any of them.
1269 <dt><b>$cfg['AllowAnywhereRecoding']
</b>boolean
</dt>
1271 Allow character set recoding of MySQL queries. You need recode or iconv
1272 support (compiled in or module) in PHP to allow MySQL queries recoding
1273 and used language file must have it enabled (by default only these
1274 which are in Unicode, just to avoid losing some characters).
1278 <dt><b>$cfg['RecodingEngine']
</b>string
</dt>
1280 You can select here which functions will be used for character set
1282 Possible values are:
<br />
1284 <li>auto - automatically use available one (first is tested
1285 iconv, then recode)
</li>
1286 <li>iconv - use iconv or libiconv functions
</li>
1287 <li>recode - use recode_string function
</li>
1293 <dt><b>$cfg['AvailableCharsets']
</b>array
</dt>
1295 Available character sets for MySQL conversion. You can add your own (any of
1296 supported by recode/iconv) or remove these which you don't use.
1297 Character sets will be shown in same order as here listed, so if you
1298 frequently use some of these move them to the top.
1302 <dt><b>$cfg['LeftWidth']
</b>integer
</dt>
1304 Left frame width in pixel.
1309 <b>$cfg['LeftBgColor']
</b>string [HTML color]
<br />
1310 <b>$cfg['RightBgColor']
</b>string [HTML color]
1313 The background colors (HTML) used for both the frames.
1318 <b>$cfg['RightBgImage']
</b>string
1321 The URI of the background image used for the right frame. It can be
1322 absolute as well as relative from your phpMyAdmin directory.
1325 <dt><b>$cfg['LeftPointerColor']
</b>string [HTML color]
</dt>
1327 The color (HTML) used for the pointer in the left frame (does not work
1332 <dt><b>$cfg['Border']
</b>integer
</dt>
1334 The size of a table's border.
1338 <dt><b>$cfg['ThBgcolor']
</b>string [HTML color]
</dt>
1340 The color (HTML) used for table headers.
1344 <dt><b>$cfg['BgcolorOne']
</b>string [HTML color]
</dt>
1346 The color (HTML) #
1 for table rows.
1350 <dt><b>$cfg['BgcolorTwo']
</b>string [HTML color]
</dt>
1352 The color (HTML) #
2 for table rows.
1357 <b>$cfg['BrowsePointerColor']
</b>string [HTML color]
<br />
1358 <b>$cfg['BrowseMarkerColor']
</b>string [HTML color]
1361 The colors (HTML) uses for the pointer and the marker in browse mode
1362 (does not work with Netscape
4).
<br />
1363 The former feature highlights the row over which your mouse is passing
1364 and the latter lets you visually mark/unmark rows by clicking on
1366 You can disable both of these features by emptying the respective
1372 <b>$cfg['TextareaCols']
</b>integer
<br />
1373 <b>$cfg['TextareaRows']
</b>integer
<br />
1374 <b>$cfg['CharTextareaCols']
</b>integer
<br />
1375 <b>$cfg['CharTextareaRows']
</b>integer
1378 Number of columns and rows for the textareas.
<br />
1379 This value will be emphasized (*
2) for SQL query textareas and (*
1.25) for
1380 SQL textareas inside the query window.
<br />
1381 The Char* values are used for CHAR and VARCHAR editing (if configured
1382 via $cfg['CharEditing']).
1387 <b>$cfg['TextareaAutoSelect']
</b>boolean
<br />
1390 Defines if the whole textarea of the query box will be selected on
1395 <dt><b>$cfg['LimitChars']
</b>integer
</dt>
1397 Maximal number of Chars showed in a
<tt>TEXT
</tt> OR a
<tt>BLOB
</tt>
1398 field on browse view. Can be turned off by a toggle button on the
1404 <b>$cfg['ModifyDeleteAtLeft']
</b>boolean
<br />
1405 <b>$cfg['ModifyDeleteAtRight']
</b>boolean
1408 Defines the place where modify and delete links would be put when
1409 tables contents are displayed (you may have them displayed both at the
1410 left and at the right).
1411 "Left
" and
"right
" are parsed as
"top
"
1412 and
"bottom
" with vertical display mode.
1416 <dt><b>$cfg['DefaultDisplay']
</b>string
<br />
1417 <b>$cfg['HeaderFlipType']
</b>string
1420 There are
3 display modes: horizontal, horizontalflipped and vertical. Define
1421 which one is displayed by default. The first mode displays each row on a
1422 horizontal line, the second rotates the headers by
90 degrees, so you can use
1423 descriptive headers even though fields only contain small values and still
1424 print them out. The vertical mode sorts each row on a vertical lineup.
<br /><br />
1425 The HeaderFlipType can be set to 'css' or 'faked'. When using 'css' the rotation
1426 of the header for horizontalflipped is done via CSS. If set to 'faked' PGP
1427 does the transformation for you, but of course this does not look as good as CSS.
1431 <dt><b>$cfg['DefaultPropDisplay']
</b>string
</dt>
1433 When editing/creating new columns in a table all fields normally get lined up
1434 one field a line. (default: 'horizontal'). If you set this to 'vertical' you
1435 can have each field lined up vertically beneath each other. You can save up
1436 a lot of place on the horizontal direction and no longer have to scroll.
1440 <dt><b>$cfg['ShowBrowseComments']
</b>boolean
<br />
1441 <b>$cfg['ShowPropertyComments']
</b>boolean
<br />
1444 By setting the corresponding variable to TRUE you can enable the display of
1445 column comments in Browse or Property display. In browse mode, the comments
1446 are show inside the header. In property mode, comments are displayed using
1447 a CSS-formatted dashed-line below the name of the field. The comment is shown
1448 as a tool-tip for that field.
1452 <dt><b>$cfg['UploadDir']
</b>string
</dt>
1454 The name of the directory, ending with a slash, where SQL files have
1455 been uploaded by other means than phpMyAdmin (for example, ftp).
1456 Those files are available under a drop-down box when you click the
1457 database name, then the SQL tab.
1459 Please note that the file names must have the suffix
".sql
".
1461 This feature is useful when your file is too big to be uploaded via
1462 HTTP, or when file uploads are disabled in PHP.
1464 Please note that if PHP is running in safe mode, this directory must
1465 be owned by the same user as the owner of the phpMyAdmin scripts.
1469 <dt><b>$cfg['RepeatCells']
</b>integer
</dt>
1471 Repeat the headers every X cells, or
0 to deactivate.
1475 <dt><b>$cfg['QueryFrame']
</b>boolean
<br />
1476 <b>$cfg['QueryFrameJS']
</b>boolean
<br />
1477 <b>$cfg['QueryFrameDebug']
</b>boolean
<br />
1478 <b>$cfg['QueryWindowWidth']
</b>integer
<br />
1479 <b>$cfg['QueryWindowHeight']
</b>integer
<br />
1480 <b>$cfg['QueryHistoryDB']
</b>boolean
<br />
1481 <b>$cfg['QueryWindowDefTab']
</b>string
<br />
1482 <b>$cfg['QueryHistoryMax']
</b>integer
1485 All those variables affect the new query frame/window. When $cfg['QueryFrame']
1486 is set to true a new frame is embedded on the left with a small area. Clicking
1487 on that results in opening a direct interface to enter SQL queries.
<br /><br />
1488 When $cfg['QueryFrameJS'] is set to true, clicking on that link opens a new
1489 custom sized browser window ($cfg['QueryWindowWidth'], $cfg['QueryWindowWidth'] -
1490 both integers for the size in pixels). If set to false, clicking on the link
1491 only opens the SQL input in the mainframe.
<br /><br />
1492 The usage of the JavaScript query window is recommended if you have a JavaScript
1493 enabled browser. Basic functions are used to exchange quite a few variables, so
1494 most
4th generation browsers should be capable to use that feature. It currently
1495 is only tested with Internet Explorer
6 and Mozilla
1.x.
<br /><br />
1496 If $cfg['QueryHistoryDB'] is set to TRUE, all your Queries are logged to a table,
1497 which has to be created by you (see
<a href=
"history">$cfg['Servers'][$i]['history']
</a>).
1498 If set to FALSE, all your queries will be appended to the form, but only as long
1499 as your window is opened they remain saved.
<br /><br />
1500 When using the JavaScript based query window, it will always get updated when you
1501 click on a new table/db to browse and will focus if you click on
"Edit SQL" after
1502 using a query.
<br /><br />
1503 If $cfg['QueryHistoryDB'] is set to TRUE you can specify the amount of saved
1504 history items using $cfg['QueryHistoryMax'].
<br /><br />
1505 The query window also has a custom tabbed look to group the features. Using the
1506 variable $cfg['QueryWindowDefTab'] you can specify the default tab to be used
1507 when opening the query window. It can be set to either 'sql', 'files', 'history'
1508 or 'full'.
<br /><br />
1509 The variable $cfg['QueryFrameDebug'] can be used by developers for easier future
1510 feature integration.
1514 <dt><b>$cfg['BrowseMIME']
</b>boolean
</dt>
1516 Enable
<a href=
"#transformations">MIME-transformations
</a>.
1520 <dt><b>$cfg['SQP']['enable']
</b> boolean
</dt>
1522 As of phpMyAdmin
2.3.0, we now have a fully functional SQL Parser system.
1523 It is enabled by default, as it is used to format the SQL queries.
1525 As of
2.3.1, it will become an integral part of phpMyAdmin, as it will
1526 analyze certain queries to improve the behavior of phpMyAdmin. But as
1527 it is very new, and not yet heavily used, we offer you an option to
1532 <dt><b>$cfg['SQP']['fmtType']
</b> string [
<tt>html
</tt>|
<tt>none
</tt>]
</dt>
1534 The main use of the new SQL Parser is to pretty-print SQL queries. By
1535 default we use HTML to format the query, but you can disable this by
1536 setting this variable to
<tt>'none'
</tt>
1540 <dt><b>$cfg['SQP']['fmtInd']
</b> float
<br />
1541 <b>$cfg['SQP']['fmtIndUnit']
</b> string [
<tt>em
</tt>|
<tt>px
</tt>|
<tt>pt
</tt>|
<tt>ex
</tt>]
</dt>
1543 For the pretty-printing of SQL queries, under some cases the part of a
1544 query inside a bracket is indented. By changing
1545 <tt>$cfg['SQP']['fmtInd']
</tt> you can change the amount of this indent.
1546 <br />Related in purpose is
<tt>$cfg['SQP']['fmtIndUnit']
</tt> which
1547 specifies the units of the indent amount that you specified. This is
1548 used via stylesheets.
1552 <dt><b>$cfg['SQP']['fmtColor']
</b> array of string tuples
</dt>
1554 This array is used to define the colours for each type of element of
1555 the pretty-printed SQL queries. The tuple format is
<br />
1556 <i>class
</i> =
> [
<i>HTML colour code
</i> |
<i>empty string
</i>]
<br />
1557 If you specify an empty string for the color of a class, it is ignored
1558 in creating the stylesheet.
1559 You should not alter the class names, only the colour strings.
<br />
1560 <b>Class name key:
</b><br />
1562 <li><b>comment
</b> Applies to all comment sub-classes
</li>
1563 <li><b>comment_mysql
</b> Comments as
<tt>"#...\n"</tt></li>
1564 <li><b>comment_ansi
</b> Comments as
<tt>"-- ...\n"</tt></li>
1565 <li><b>comment_c
</b> Comments as
<tt>"/*...*/"</tt></li>
1566 <li><b>digit
</b> Applies to all digit sub-classes
</li>
1567 <li><b>digit_hex
</b> Hexadecimal numbers
</li>
1568 <li><b>digit_integer
</b> Integer numbers
</li>
1569 <li><b>digit_float
</b> Floating point numbers
</li>
1570 <li><b>punct
</b> Applies to all punctuation sub-classes
</li>
1571 <li><b>punct_bracket_open_round
</b> Opening brackets
<tt>"("</tt></li>
1572 <li><b>punct_bracket_close_round
</b> Closing brackets
<tt>")"</tt></li>
1573 <li><b>punct_listsep
</b> List item seperator
<tt>","</tt></li>
1574 <li><b>punct_qualifier
</b> Table/Column Qualifier
<tt>"."</tt> </li>
1575 <li><b>punct_queryend
</b> End of query marker
<tt>";"</tt></li>
1576 <li><b>alpha
</b> Applies to all alphabetic classes
</li>
1577 <li><b>alpha_columnType
</b> Identifiers matching a column type
</li>
1578 <li><b>alpha_columnAttrib
</b> Identifiers matching a database/table/column attribute
</li>
1579 <li><b>alpha_functionName
</b> Identifiers matching a MySQL function name
</li>
1580 <li><b>alpha_reservedWord
</b> Identifiers matching any other reserved word
</li>
1581 <li><b>alpha_variable
</b> Identifiers matching a SQL variable
<tt>"@foo"</tt></li>
1582 <li><b>alpha_identifier
</b> All other identifiers
</li>
1583 <li><b>quote
</b> Applies to all quotation mark classes
</li>
1584 <li><b>quote_double
</b> Double quotes
<tt>"</tt></li>
1585 <li><b>quote_single</b> Single quotes <tt>'</tt></li>
1586 <li><b>quote_backtick</b> Backtick quotes <tt>`</tt></li>
1590 <dt><b>$cfg['SQLValidator']['use']</b> boolean</dt>
1592 phpMyAdmin now supports use of the <a href="http://developer.mimer.com/validator/index.htm
">Mimer SQL Validator</a> service,
1593 as originally published on
1594 <a href="http://developers.slashdot.org/article.pl?sid=
02/
02/
19/
1720246">Slashdot</a>.
1596 For help in setting up your system to use the service, see the
1597 <a href="#faqsqlvalidator
">FAQ #6.14</a>.
1601 <dt><b>$cfg['SQLValidator']['username']</b> string<br />
1602 <b>$cfg['SQLValidator']['password']</b> string</dt>
1604 The SOAP service allows you to login with <tt>anonymous</tt>
1605 and any password, so we use those by default.. Instead, if
1606 you have an account with them, you can put your login details
1607 here, and it will be used in place of the anonymous login.
1611 <dt><b>$cfg['DBG']['enable']</b> boolean</dt>
1613 <b>DEVELOPERS ONLY!</b><br />
1614 Enable the DBG extension for debugging phpMyAdmin. Required for profiling
1617 For help in setting up your system to this, see the
1618 <a href="#developersdbg
">Developers</a> section.
1621 <dt><b>$cfg['DBG']['profile']['enable']</b> boolean</dt>
1623 <b>DEVELOPERS ONLY!</b><br />
1624 Enable profiling support for phpMyAdmin. This will append a chunk of data
1625 to the end of every page displayed in the main window with profiling
1626 statistics for that page.<br />
1627 You may need need to increase the maximum execution time for this to
1628 complete successfully.
1631 <dt><b>$cfg['DBG']['profile']['threshold']</b> float (units in milliseconds)</dt>
1633 <b>DEVELOPERS ONLY!</b><br />
1634 When profiling data is displayed, this variable controls the threshold of
1635 display for any profiling data, based on the average time each time has
1636 taken. If it is over the threshold it is displayed, otherwise it is not
1637 displayed. This takes a value in milliseconds. In most cases you don't need
1641 <dt><b>$cfg['ColumnTypes'] </b>array</dt>
1643 All possible types of a MySQL column. In most cases you don't need to
1648 <dt><b>$cfg['AttributeTypes'] </b>array</dt>
1650 Possible attributes for fields. In most cases you don't need to edit
1655 <dt><b>$cfg['Functions'] </b>array</dt>
1657 A list of functions MySQL supports. In most cases you don't need to
1664 <!-- TRANSFORMATIONS -->
1665 <a name="transformations
"></a><br />
1666 <h2>Transformations</h2>
1669 <a href="#transformationsintro
">Introduction</a> -
1670 <a href="#transformationshowto
">Usage</a> -
1671 <a href="#transformationsfiles
">File structure</a> -
1674 <a name="transformationsintro
"></a><br />
1675 <h3>[1. Introduction]</h3>
1677 <p>To enable transformations, you have to setup the column_info table and the proper
1678 directives. Please see the <a href="#config
">Configuration section</a> on how to do so.</p>
1681 <p>You can apply different transformations to the contents of each field. The
1682 transformation will take the content of each field and transform it with
1683 certain rules defined in the selected transformation.</p><br />
1685 <p>Say you have a field 'filename' which contains a filename. Normally you would see
1686 in phpMyAdmin only this filename. Using transformations you can transform that filename
1687 into a HTML link, so you can click inside of the phpMyAdmin structure on the field's
1688 link and will see the file displayed in a new browser window. Using transformation
1689 options you can also specify strings to append/prepend to a string or the format you
1690 want the output stored in.</p><br />
1692 <p>For a general overview of all available transformations and their options, you can
1693 consult your <i><www.your-host.com>/<your-install-dir>/libraries/transformations/overview.php3</i>
1694 installation.</p><br />
1697 <a name="transformationshowto
"></a><br />
1700 <p>Go to your tbl_properties.inc.php3 page (i.e. reached through clicking on the
1701 'properties' link for a table). There you will see three new fields at the end of the
1702 line. They are called 'MIME-type', 'Browser transformation' and 'Transformation options'.</p>
1706 <li>The field 'MIME-type' is a dropdown field. You have the options to leave that field
1707 empty or to use 'auto' [this feature is not yet available]. Please note that
1708 transformations are inactive as long as no mime-type is selected.</li><br /><br />
1710 <li>The field 'Browser transformation' is a drop-down field. You can choose from a
1711 hopefully growing amount of pre-defined transformations. See below for information on
1712 how to build your own transformation.<br /><br />
1714 There are global transformations and mimetype-bound transformations. Global transformations
1715 can be used for any mimetype. They will take the mimetype, if necessary, into regard.
1716 Mimetype-bound transformations usually only operate on a certain mimetype. There are
1717 transformations which operate on the main mimetype (like 'image'), which will most likely
1718 take the subtype into regard, and those who only operate on a
1719 specific subtype (like 'image/jpeg').<br /><br />
1721 You can use transformations on mimetypes for which the function was not defined for. There
1722 is no security check for you selected the right transformation, so take care of what the
1723 output will be like.</li><br /><br />
1725 <li>The field 'Transformation options' is a free-type textfield. You have to enter
1726 transform-function specific options here. Usually the transforms can operate with default
1727 options, but it is generally a good idea to look up the overview to see which options are
1728 necessary.<br /><br />
1730 Much like the ENUM/SET-Fields, you have to split up several options using the format
1731 'a','b','c',...(NOTE THE MISSING BLANKS). This is because internally the options will be
1732 parsed as an array, leaving the first value the first element in the array, and so
1735 If you want to specify a MIME character set you can define it in the transformation_options.
1736 You have to put that outside of the pre-defined options of the specific mime-transform,
1737 as the last value of the set. Use the format "'; charset=XXX'
". If you use a transform,
1738 for which you can specify 2 options and you want to append a character set, enter "'first
1739 parameter','second parameter','charset=us-ascii'
". You can, however use the defaults for
1740 the parameters: "'','','charset=us-ascii'
".</li><br /><br />
1743 <a name="transformationsfiles
"></a><br />
1744 <h3>[3. File structure]</h3>
1746 <p>All mimetypes and their transformations are defined through single files in
1747 the directory 'libraries/transformations/'.</p><br />
1749 <p>They are stored in files to ease up customization and easy adding of new
1750 transformations.</p><br />
1752 <p>Because the user cannot enter own mimetypes, it is kept sure that transformations
1753 always work. It makes no sense to apply a transformation to a mimetype, the
1754 transform-function doesn't know to handle.</p><br />
1756 <p>One can, however, use empty mime-types and global transformations which should work
1757 for many mimetypes. You can also use transforms on a different mimetype they where built
1758 for, but pay attention to option usage as well as what the transformation does to your
1761 <p>There is a basic file called 'global.inc.php3'. This function can be included by
1762 any other transform function and provides some basic functions.</p><br />
1764 <p>There are 5 possible file names:</p>
1767 <li>A mimetype+subtype transform:<br /><br />
1769 [mimetype]_[subtype]__[transform].inc.php3<br /><br />
1771 Please not that mimetype and subtype are separated via '_', which shall not be
1772 contained in their names. The transform function/filename may contain only
1773 characters which cause no problems in the file system as well as the PHP function
1774 naming convention.<br /><br />
1776 The transform function will the be called 'PMA_transform_[mimetype]_[subtype]__[transform]()'.<br /><br />
1778 <b>Example:</b><br /><br />
1780 text_html__formatted.inc.php3<br />
1781 PMA_transform_text_html__formatted()</li><br /><br />
1783 <li>A mimetype (w/o subtype) transform:<br /><br />
1785 [mimetype]__[transform].inc.php3<br /><br />
1787 Please note that there are no single '_' characters.
1788 The transform function/filename may contain only characters which cause no problems
1789 in the file system as well as the PHP function naming convention.<br /><br />
1791 The transform function will the be called 'PMA_transform_[mimetype]__[transform]()'.<br /><br />
1793 <b>Example:</b><br /><br />
1795 text__formatted.inc.php3<br />
1796 PMA_transform_text__formatted()</li><br /><br />
1798 <li>A mimetype+subtype without specific transform function<br /><br />
1800 [mimetype]_[subtype].inc.php3<br /><br />
1802 Please note that there are no '__' characters in the filename. Do not use special
1803 characters in the filename causing problems with the file system.<br /><br />
1805 No transformation function is defined in the file itself.<br /><br />
1807 <b>Example:</b><br /><br />
1809 text_plain.inc.php3<br />
1810 (No function)</li><br /><br />
1812 <li>A mimetype (w/o subtype) without specific transform function<br /><br />
1814 [mimetype].inc.php3<br /><br />
1816 Please note that there are no '_' characters in the filename. Do not use special
1817 characters in the filename causing problems with the file system.<br /><br />
1819 No transformation function is defined in the file itself.<br /><br />
1821 <b>Example:</b><br /><br />
1824 (No function)</li><br /><br />
1826 <li>A global transform function with no specific mimetype<br /><br />
1828 global__[transform].inc.php3<br /><br />
1830 The transform function will the be called 'PMA_transform_global__[transform]()'.<br /><br />
1832 <b>Example:</b><br /><br />
1834 global__formatted<br />
1835 PMA_transform_global__formatted()</li>
1839 <p>So generally use '_' to split up mimetype and subtype, and '__' to provide a
1840 transform function.</p><br />
1842 <p>All filenames containing no '__' in themselves are not shown as valid transform
1843 functions in the dropdown.</p><br />
1845 <p>Please see the libraries/transformations/TEMPLATE file for adding your own transform
1846 function. See the libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
1847 without a transform function. Also note the introduction of a function description in
1848 the language files. For each function a $strTransformation_[filename without .inc.php3]
1849 has to exist.</p><br />
1851 <p>You can use the template generator to generate new functions and entries in the
1852 language file.</p><br />
1854 <p>To create a new transform function please see libraries/transformations/template_generator.sh.
1855 To create a new, empty mimetype please see libraries/transformations/template_generator_mimetype.sh.</p><br />
1858 <a name="faq
"></a><br />
1859 <h2>FAQ - Frequently Asked Questions</h2>
1862 <a href="#faqserver
">Server</a> -
1863 <a href="#faqconfig
">Configuration</a> -
1864 <a href="#faqlimitations
">Limitations</a> -
1865 <a href="#faqmultiuser
">Multi-user</a> -
1866 <a href="#faqbrowsers
">Browsers</a> -
1867 <a href="#faqusing
">Usage tips</a> -
1868 <a href="#faqproject
">Project</a> -
1871 <a name="faqserver
"></a><br />
1872 <h3>[1. Server]</h3>
1875 [1.1] I'm running PHP 4+ and my server is crashing each time a specific
1876 action is required or phpMyAdmin sends a blank page or a page full of
1877 cryptic characters to my browser, what can I do?
1880 There are some known PHP bugs with output buffering and compression.<br />
1881 Try to set the <tt>$cfg['OBGzip']</tt> directive to <tt>FALSE</tt> in your
1882 <i>config.inc.php or .php3</i> file and the
1883 <tt>zlib.output_compression</tt> directive to <tt>Off</tt> in your php
1884 configuration file.<br />
1885 Furthermore, we know about such problems connected to the release
1886 candidates of PHP 4.2.0 (tested with PHP 4.2.0 RC1 to RC4) together with
1887 MS Internet Explorer. Please upgrade to the release version PHP 4.2.0.
1891 [1.2] My Apache server crashes when using phpMyAdmin.
1894 You should first try the latest versions of Apache (and possibly MySQL).
1896 See also the other FAQ entry about PHP bugs with output buffering.
1898 If your server keeps crashing, please ask for help in the various
1899 Apache support groups.
1903 [1.3] I'm running phpMyAdmin with "cookie
" authentication mode under
1904 PHP 4.2.0 or 4.2.1 loaded as an Apache 2+ module but can't enter the
1905 script: I'm always displayed the login screen.
1908 This is a known PHP bug (see this
1909 <a href="http://bugs.php.net/bug.php?id=
16626">bug report</a>) from the
1910 official PHP bug database. It means there is and won't be any phpMyAdmin
1911 fix against it because there is no way to code a fix.
1915 [1.4] Using phpMyAdmin on IIS, I'm displayed the error message:
1916 "The specified CGI application misbehaved by not returning a
1917 complete set of HTTP headers...".
1920 You just forgot to read the <i>install.txt</i> file from the php
1921 distribution. Have a look at the last message in this
1922 <a href="http://bugs.php.net/bug.php?id=
12061">bug report</a> from the
1923 official PHP bug database.
1927 [1.5] Using phpMyAdmin on IIS, I'm facing crashes and/or many error
1928 messages with the HTTP or advanced authentication mode.
1931 This is a known problem with the PHP ISAPI filter: it's not so stable. For
1932 some more information and complete testings see the messages posted by
1933 André B. aka "djdeluxe76" in
1934 <a href="http://www.phpwizard.net/phorum/read.php?f=
1&i=
6624&t=
6300">this thread</a>
1935 from the phpWizard forum.<br />
1936 Please use instead the cookie authentication mode.
1940 [1.6] I can't use phpMyAdmin on PWS: nothing is displayed!</h4>
1942 This seems to be a PWS bug. Filippo Simoncini found a workaround (at this
1943 time there is no better fix): remove or comment the <tt>DOCTYPE</tt>
1944 declarations (2 lines) from the scripts <i>header.inc.php3</i>,
1945 <i>header_printview.inc.php3</i>, <i>index.php3</i>, <i>left.php3</i> and
1946 <i>libraries/common.lib.php3</i>.
1950 [1.7] How can I GZip or Bzip a dump or a CSV export. It does not seem to
1954 These features are based on the <tt>gzencode()</tt> and
1955 <tt>bzcompress()</tt> PHP functions to be more independent of the platform
1956 (Unix/Windows, Safe Mode or not, and so on).
1957 So, you must have PHP4 >= 4.0.4 and Zlib/Bzip2 support
1958 (<tt>--with-zlib</tt> and <tt>--with-bz2</tt>).<br />
1959 We faced PHP crashes when trying to download a dump with MS Internet
1960 Explorer when phpMyAdmin is run with a release candidate of PHP 4.2.0. In
1961 this case you should switch to the release version of PHP 4.2.0.
1965 [1.8] I cannot insert a text file in a table, and I get an error about
1966 safe mode being in effect.
1969 Your uploaded file is saved by PHP in the "upload dir", as
1970 defined in <i>php.ini</i> by the variable <tt>upload_tmp_dir</tt> (usually
1971 the system default is <i>/tmp</i>).
1973 We recommend the following setup for Apache servers running in safe mode,
1974 to enable uploads of files while being reasonably secure:
1977 <li>create a separate directory for uploads:
1978 <tt>mkdir /tmp/php</tt></li>
1979 <li>give ownership to the Apache server's user.group:
1980 <tt>chown apache.apache /tmp/php</tt></li>
1981 <li>give proper permission: <tt>chmod 600 /tmp/php</tt></li>
1982 <li>put <tt>upload_tmp_dir = /tmp/php</tt> in php.ini</li>
1983 <li>restart Apache</li>
1987 [1.9] I'm having troubles when uploading files. In general file uploads
1988 don't work on my system and uploaded files have a <tt>Content-Type:</tt>
1989 header in the first line.
1992 It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat 7.0
1993 and you updated your PHP RPM to php-4.0.4pl1-3.i386.rpm, didn't you?
1995 So the problem is that this package has a serious bug that was corrected
1996 ages ago in PHP (2001-01-28: see
1997 <a href="http://www.php.net/bugs.php?id=
8966">PHP's bug tracking system</a>
1998 for more details). The problem is that the bugged package is still
1999 available though it was corrected (see
2000 <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=
24933">RedHat's BugZilla</a>
2004 <a href="http://www.redhat.com/swr/i386/php-
4.0.4pl1-
9.i386.html
">the fixed package (4.0.4pl1-9)</a>
2005 and the problem should go away.
2007 And that fixes the \r\n problem with file uploads!
2011 [1.10] I'm having troubles when uploading files with phpMyAdmin running
2012 on a secure server. My browser is Internet Explorer and I'm using the
2016 As suggested by "Rob M" in the phpWizard forum, add this line to
2017 your <i>httpd.conf</i>:<br />
2018 <tt>SetEnvIf User-Agent ".*MSIE.*
" nokeepalive ssl-unclean-shutdown</tt><br />
2019 It seems to clear up many problems between Internet Explorer and SSL.
2023 [1.11] I get an 'open_basedir restriction' while uploading a file from
2027 Since version 2.2.4, phpMyAdmin supports servers with open_basedir
2028 restrictions. Assuming that the restriction allows you to open files in the
2029 current directory ('.'), all you have to do is create a 'tmp' directory
2030 under the phpMyAdmin install directory, with permissions 777 and the same
2031 owner as the owner of your phpMyAdmin directory. The uploaded files will
2032 be moved there, and after execution of your SQL commands, removed.
2036 [1.12] I have lost my MySQL root password, what can I do?
2039 The MySQL manual explains how to
2040 <a href="http://www.mysql.com/doc/R/e/Resetting_permissions.html
">
2041 reset the permissions</a>.
2045 [1.13] I get an error 'No SQL query' when trying to execute a bookmark.
2048 If PHP does not have read/write access to its <tt>upload_tmp_dir</tt>, it
2049 cannot access the uploaded query.
2053 [1.14] I get an error 'No SQL query' when trying to submit a query from
2054 the convenient text area.
2057 Check the <tt>post_max_size</tt> directive from your PHP configuration file
2058 and try to increase it.
2062 [1.15] I have problems with <i>mysql.user</i> field names.
2065 In older MySQL versions, the <tt>User</tt> and <tt>Password</tt> fields
2066 were named <tt>user</tt> and <tt>password</tt>. Please modify your field
2067 names to align with current standards.
2070 [1.16] I cannot upload big dump files.
2073 The first things to check (or ask your host provider to check) are the
2074 values of <tt>upload_max_filesize</tt>, <tt>memory_limit</tt> and
2075 <tt>post_max_size</tt> in the <i>php.ini</i> configuration file.
2077 All of these three settings limit the maximum size of data that can be
2078 submitted and handled by PHP. One user also said that post_max_size
2079 and memory_limit need to be larger than upload_max_filesize.
2083 [1.17] Does phpMyAdmin support MySQL 4.1?
2086 Because of a major change in the definition syntax of string field types,
2087 this version of phpMyAdmin probably won't work correctly with
2088 MySQL >= 4.1.0! We will work on the support as soon as
2089 MySQL 4.1.0 is released.
2093 [1.18] I'm running MySQL <= 4.0.1 having
2094 <tt>lower_case_table_names</tt> set to 1. If I create a new table with a
2095 capital letter in its name it is changed to lowercase as it should. But
2096 if I try to DROP this table MySQL is unable to find the corresponding
2100 This is a bug of MySQL <= 4.0.1. Please upgrade to at least
2101 MySQL 4.0.2 or turn off your <tt>lower_case_table_names</tt>
2106 [1.19] I can't run the "display relations" feature because the
2107 script seems not to know the font face I'm using!
2110 The "FPDF" library we're using for this feature requires some
2111 special files to use font faces.<br />
2112 Please refers to the
2113 <a href="http://www.fpdf.org/
" target="_blank
">FPDF manual</a> to build
2117 <a name="faqmysql
"></a><br />
2119 [1.20] I receive the error "cannot load MySQL extension, please
2120 check PHP Configuration".
2123 To connect to a MySQL server, PHP needs a set of MySQL functions called
2124 "MySQL extension".
2125 This extension may be part of the PHP server (compiled-in), otherwise it
2126 needs to be loaded dynamically. Its name is probably <i>mysql.so</i> or
2127 <i>mysql.dll</i>. phpMyAdmin tried to load the extension but failed.
2129 Usually, the problem is solved by installing a software package called
2130 "PHP-MySQL" or something similar.
2134 [1.21] I am running the CGI version of PHP under Unix, and I cannot
2135 login using cookie auth.
2138 In <i>php.ini</i>, set <tt>mysql.max_links</tt> higher than 1.
2142 [1.22] I don't see the "Location of text file" field, so
2146 This is most likely because in <i>php.ini</i>, your <tt>file_uploads</tt>
2147 parameter is not set to "on".
2151 [1.23] I'm running MySQL on a Win32 machine. Each time I create a new
2152 table the table and field names are changed to lowercase!
2155 This happens because the MySQL directive <tt>lower_case_table_names</tt>
2156 defaults to 1 (<tt>ON</tt>) in the Win32 version of MySQL. You can change
2157 this behavior by simply changing the directive to 0 (<tt>OFF</tt>):<br />
2158 Just edit you <tt>my.ini</tt> file that should be located in your Windows
2159 directory and add the following line:<br />
2160 <tt>set-variable = lower-case-table-names=0</tt><br />
2161 Next, save the file and restart the MySQL service. You can always check the
2162 value of this directive using the query<br />
2163 <tt>SHOW VARIABLES LIKE 'lower_case_table_names';</tt>
2167 [1.24] Some characters are being truncated in my queries, or I get
2168 characters randomly added. I am running PHP 4.2.3.
2172 <a href="http://bugs.php.net/bug.php?id=
19404">PHP 4.2.3 bug</a>.
2176 [1.25] I am running Apache with mod_gzip-1.3.26.1a on Windows XP,
2177 and I get problems, such as undefined variables when I run a SQL query.
2180 A tip from Jose Fandos: put a comment on the following two lines
2181 in httpd.conf, like this:<br />
2182 <tt># mod_gzip_item_include file \.php$</tt><br />
2183 <tt># mod_gzip_item_include mime "application/x-httpd-php.*
"</tt><br />
2184 as this version of mod_gzip on Apache (Windows) has problems handling
2185 PHP scripts. Of course you have to restart Apache.
2189 [1.26] I just installed phpMyAdmin in my document root of IIS but
2190 I get the error "No input file specified" when trying to
2194 This is a permission problem. Right-click on the phpmyadmin folder
2195 and choose properties. Under the tab Security, click on "Add"
2196 and select the user "IUSER_machine" from the list. Now set his
2197 permissions and it should work.
2201 [1.27] I get empty page when I want to view huge page (eg.
2202 db_details_structure.php3 with plenty of dabases).
2205 This is a <a href="http://bugs.php.net/
21079">PHP bug</a> that occur when
2206 GZIP output buffering enabled. If you turn off it (by <code>$cfg['OBGzip']
2207 = FALSE</code> in config.inc.php3), it should work. This bug will be fixed
2212 [1.28] My MySQL server sometimes refuses queries and returns the message
2213 'Errorcode: 13'. What does this mean?
2216 This can happen due to a MySQL bug when having database / table names with
2217 upper case characters although <tt>lower_case_table_names</tt> is set to 1.
2218 To fix this, turn off this directive, convert all database and table names
2219 to lower case and turn it on again. Alternatively, there's a bug-fix
2220 available starting with MySQL 3.23.56 / 4.0.11-gamma.
2223 <a name="faq-
1-
29"></a>
2225 [1.29] When I create a table or modify a field, I get an error
2226 and the fields are duplicated.
2229 It is possible to configure Apache in such a way that PHP has problems
2230 interpreting .php files.
2232 The problems occur when two different (and conflicting) set of directives
2236 SetOutputFilter PHP<br />
2237 SetInputFilter PHP<br />
2242 AddType application/x-httpd-php .php
2245 In the case we saw, one set of directives was in <tt>httpd.conf</tt>, while
2246 the other set was in <tt>php.conf</tt>.<br />
2247 The recommended way is with <tt>AddType</tt>, so just comment out
2248 the first set of lines and restart Apache:
2251 #SetOutputFilter PHP<br />
2252 #SetInputFilter PHP<br /></b>
2256 <a name="faqconfig
"></a><br />
2257 <h3>[2. Configuration]</h3>
2260 [2.1] The error message "Warning: Cannot add header information -
2261 headers already sent by ..." is displayed, what's the problem?
2264 Edit your <i>config.inc.php or .php3</i> file and ensure there is nothing
2265 (I.E. no blank lines, no spaces, no characters...) neither before the
2266 <tt><?php</tt> tag at the beginning, neither after the <tt>?></tt>
2271 [2.2] phpMyAdmin can't connect to MySQL. What's wrong?
2274 Either there is an error with your PHP setup or your username/password is
2275 wrong. Try to make a small script which uses mysql_connect and see if it
2276 works. If it doesn't, it may be you haven't even compiled MySQL support
2281 [2.3] The error message "Warning: MySQL Connection Failed: Can't
2282 connect to local MySQL server through socket '/tmp/mysql.sock'
2283 (111)..." is displayed. What can I do?
2286 For RedHat users, Harald Legner suggests this on the mailing list:
2288 On my RedHat-Box the socket of MySQL is <i>/var/lib/mysql/mysql.sock</i>.
2289 In your php.ini you will find a line
2291 <tt>mysql.default_socket = /tmp/mysql.sock</tt>
2295 <tt>mysql.default_socket = /var/lib/mysql/mysql.sock</tt>
2297 Then restart apache and it will work.
2299 Here is a fix suggested by Brad Ummer in the phpwizard forum:
2303 First, you need to determine what socket is being used by MySQL.
2305 To do this, telnet to your server and go to the MySQL bin directory. In
2306 this directory there should be a file named <i>mysqladmin</i>. Type
2307 <tt>./mysqladmin variables</tt>, and this should give you a bunch of
2308 info about your MySQL server, including the socket
2309 (<i>/tmp/mysql.sock</i>, for example).
2312 Then, you need to tell PHP to use this socket.<br />Assuming you are
2313 using PHP 3.0.10 or better, you can specify the socket to use when you
2314 open the connection. To do this in phpMyAdmin, you need to complete the
2315 socket information in the config.inc.php3.<br />
2317 <tt>$cfg['Servers'][$i]['socket'] = '/tmp/mysql.sock';</tt>
2321 Have also a look at the
2322 <a href="http://www.mysql.com/doc/C/a/Can_not_connect_to_server.html
" target="_blank
">
2323 corresponding section of the MySQL documentation</a>.
2327 [2.4] Nothing is displayed by my browser when I try to run phpMyAdmin,
2331 Try to set the <tt>$cfg['OBGZip']</tt> directive to <tt>FALSE</tt> in the
2332 phpMyAdmin configuration file. It helps sometime.<br />
2333 Also have a look at your PHP version number: if it contains
2334 "4.0b..." it means you're running a beta version of PHP. That's
2335 not a so good idea, please upgrade to a plain revision.
2339 [2.5] Each time I want to insert or change a record or drop a database
2340 or a table, an error 404 (page not found) is displayed or, with HTTP or
2341 cookie authentication, I'm asked to login again. What's wrong?
2344 Check the value you set for the <tt>$cfg['PmaAbsoluteUri']</tt> directive
2345 in the phpMyAdmin configuration file.
2349 [2.6] I get an "Access denied for user: 'root@localhost' (Using
2350 password: YES)"-error when trying to access a MySQL-Server on a
2351 host which is port-forwarded for my localhost
2354 When you are using a port on your localhost, which you redirect via
2355 port-forwarding to another host, MySQL is not resolving the localhost
2357 Erik Wasser explains: The solution is: if your host is "localhost"
2358 MySQL (the commandline tool 'mysql' as well) always tries to use the socket
2359 connection for speeding up things. And that doesn't work in this configuration
2360 with port forwarding.<br />
2361 If you enter "127.0.0.1" as hostname, everything is right and MySQL uses the
2366 <a name="faqlimitations
"></a><br />
2367 <h3>[3. Known limitations]</h3>
2368 <a name="login_bug
"></a><br />
2370 [3.1] When using HTTP authentication, an user who logged out can not
2371 relogin in with the same nick.
2374 This is related to the authentication mechanism (protocol) used by
2375 phpMyAdmin. We plan to change it as soon as we may find enough free time
2376 to do it, but you can bypass this problem: just close all the opened
2377 browser windows and then go back to phpMyAdmin. You should be able to
2382 [3.2] When dumping a large table in compressed mode, I get a memory
2383 limit error or a time limit error.
2386 As of version 2.2.4, we build the compressed dump in memory, so large
2387 tables dumps may hang. The only alternative we can think about (using
2388 system calls to mysqldump then gzip or bzip2) would not be applicable in
2389 environments where PHP is in safe mode: access to system programs is
2390 is limited by the system administrator, and time limit is enforced.
2394 [3.3] With InnoDB tables, I lose foreign key relationships when I rename
2398 This seems to be a InnoDB bug (fixed in MySQL 3.23.50?). However, keep in
2399 mind that phpMyAdmin as of version 2.3.0 does not support InnoDB.
2403 [3.4] I am unable to import dumps I created with the mysqldump tool
2404 bundled with the MySQL server distribution.
2407 The problem is that mysqldump creates invalid comments like this:
2412 -- Host: localhost Database: database
2413 ---------------------------------------------------------
2414 -- Server version 3.23.54
2417 The invalid part of the code is the horizontal line made of dashes that
2418 appears once in every dump created with mysqldump. If you want to run your
2419 dump you have to turn it into valid MySQL. This means, you have to add a
2420 whitespace after the first to dashes of the line or add a # before it:
2423 -- -------------------------------------------------------<br />
2427 #---------------------------------------------------------
2432 <a name="faqmultiuser
"></a><br />
2433 <h3>[4. ISPs, multi-user installations ]</h3>
2436 [4.1] I'm an ISP. Can I setup one central copy of phpMyAdmin or do I
2437 need to install it for each customer.
2440 Since version 2.0.3, you can setup a central copy of phpMyAdmin for all
2441 your users. The development of this feature was kindly sponsored by
2443 This requires a properly setup MySQL user management and phpMyAdmin
2444 HTTP or cookie authentication. See the install section on
2445 "Using HTTP authentication".
2449 [4.2] What's the preferred way of making phpMyAdmin secure against evil
2453 This depends on your system.<br />
2454 If you're running a server which cannot be accessed by other people, it's
2455 sufficient to use the directory protection bundled with your webserver
2456 (with Apache you can use <i>.htaccess</i> files, for example).<br />
2457 If other people have telnet access to your server, you should use
2458 phpMyAdmin's HTTP authentication feature.
2464 Your <i>config.inc.php3</i> file should be <tt>chmod 660</tt>.
2467 All your phpMyAdmin files should be chown phpmy.apache, where phpmy
2468 is a user whose password is only known to you, and apache is the
2469 group under which Apache runs.
2472 You should use PHP safe mode, to protect from other users that try
2473 to include your <i>config.inc.php3</i> in their scripts.
2478 [4.3] I get errors about not being able to include a file in
2479 <i>/lang</i> or in <i>/libraries</i>.
2482 Check <i>php.ini</i>, or ask your sysadmin to check it. The
2483 <tt>include_path</tt> must contain "." somewhere in it, and
2484 <tt>open_basedir</tt>, if used, must contain "." and
2485 "./lang" to allow normal operation of phpMyAdmin.
2488 [4.4] phpMyAdmin always gives "Access denied" when using HTTP
2492 This could happen for several reasons:
2496 <tt>$cfg['Servers'][$i]['controluser']</tt> and/or
2497 <tt>$cfg['Servers'][$i]['controlpass']</tt> are wrong.
2500 The username/password you specify in the login-dialog are invalid.
2503 You have already setup a security mechanism for the
2504 phpMyAdmin-directory, eg. a .htaccess file. This would interfere with
2505 phpMyAdmin's authentication, so remove it.
2510 [4.5] Is it possible to let users create their own databases?
2513 Starting with 2.2.5, in the user management page, you can enter a wildcard
2514 database name for a user, and put the privileges you want. For example,
2515 adding <tt>SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER</tt>
2516 would let a user create/manage his/her database(s).
2520 [4.6] How can I use the Host-based authentication additions?
2523 If you have existing rules from an old .htaccess file, you can take them
2524 and add a username between the <tt>'deny'</tt>/<tt>'allow'</tt> and
2525 <tt>'from'</tt> strings. Using the username wildcard of <tt>'%'</tt> would
2526 be a major benefit here if your installation is suited to using it. Then
2527 you can just add those updated lines into the
2528 <tt>$cfg['Servers'][$i]['AllowDeny']['rules']</tt> array.
2530 If you want a pre-made sample, you can try this fragment. It stops the
2531 'root' user from logging in from any networks other than the private
2535 //block root from logging in except from the private networks<br />
2536 $cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';<br />
2537 $cfg['Servers'][$i]['AllowDeny']['rules'] = array(<br />
2538 'deny root from all',<br />
2539 'allow root from localhost',<br />
2540 'allow root from 10.0.0.0/8',<br />
2541 'allow root from 192.168.0.0/16',<br />
2542 'allow root from 172.16.0.0/12',<br />
2543 );
2547 <a name="faqbrowsers
"></a><br />
2548 <h3>[5. Browsers or client OS]</h3>
2551 [5.1] I get an out of memory error, and my controls are non-functional,
2552 when trying to create a table with more than 14 fields.
2555 We could reproduce this problem only under Win98/98SE. Testing under
2556 WinNT4 or Win2K, we could easily create more than 60 fields.
2558 A workaround is to create a smaller number of fields, then come back to
2559 your table properties and add the other fields.
2563 [5.2] With Xitami 2.5b4, phpMyAdmin won't process form fields.
2566 This is not a phpMyAdmin problem but a Xitami known bug: you'll face it
2567 with each script/website that use forms.<br />
2568 Upgrade or downgrade your Xitami server.
2572 [5.3] I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).
2575 With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except that
2576 the proposed file name for the dump is always 'tbl_dump.php'. Bzip2 dumps
2577 don't seem to work.<br />
2579 With Konqueror 2.2.1: plain dumps work; zip dumps are placed into
2580 the user's temporary directory, so they must be moved before closing
2581 Konqueror, or else they disappear. GZip dumps give an error message.<br />
2583 Testing needs to be done for Konqueror 2.2.2.<br />
2587 [5.4] I can't use the cookie authentication mode because Internet
2588 Explorer never stores the cookies.
2591 MS Internet Explorer seems to be really buggy about cookies, at least till
2592 version 6. And thanks to Andrew Zivolup we've traced also a PHP 4.1.1 bug
2595 Then, if you're running PHP 4.1.1, try to upgrade or downgrade... it may
2600 [5.5] In Internet Explorer 5.0, I get JavaScript errors when browsing my
2604 Upgrade to at least Internet Explorer 5.5 SP2.<br />
2608 [5.6] In Internet Explorer 5.0, 5.5 or 6.0, I get an error when trying
2609 to modify a row in a table with many fields, or with a text field
2612 Your table neither have a primary key nor an unique one, so we must use a
2613 long URL to identify this row. There is a limit on the length of the URL in
2614 those browsers, and this not happen in Netscape, for example. The
2615 workaround is to create a primary or unique key, or use another browser.
2620 [5.7] I refresh (reload) my browser, and come back to the welcome
2624 Some browsers support right-clicking into the frame you want to refresh,
2625 just do this in the right frame.<br />
2629 [5.8] With Mozilla 0.9.7 I have problems sending a query modified in the
2633 Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
2634 Mozilla versions.<br />
2638 [5.9] With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
2639 whitespace in the SQL-Query edit area: the page scrolls down.
2642 This is a Mozilla bug (see bug #26882 at
2643 <a href="http://bugzilla.mozilla.org/
" target="_blank
">BugZilla</a>).<br />
2647 [5.10] With Netscape 4.75 I get empty rows between each row of data in a
2651 This is a known Netscape 4.75 bug: it adds some line feeds when exporting
2652 data in octet-stream mode. Since we can't detect the specific Netscape
2653 version, we cannot workaround this bug.
2657 [5.11] Extended-ASCII characters like German umlauts are displayed
2661 Please ensure that you have set your browser's character set to the one of the
2662 language file you have selected on phpMyAdmin's start page.
2663 Alternatively, you can try the auto detection mode that is supported by the
2664 recent versions of the most browsers.
2668 [5.12] Apple OS X: Safari browser changes special characters to
2672 This issue has been reported by a OS X user, who adds that Chimera,
2673 Netscape and Mozilla do not have this problem.
2677 [5.13] With Internet Explorer 5.5 or 6, and HTTP authentication type,
2678 I cannot manage two servers: I login to the first one, then the other one,
2679 but if I switch back to the first, I have to login on each operation.
2682 This is a bug in Internet Explorer, other browsers do not behave this way.
2685 <a name="faqusing
"></a><br />
2686 <h3>[6. Using phpMyAdmin]</h3>
2689 [6.1] I can't insert new rows into a table / I can't create a table
2690 - MySQL brings up a SQL-error.
2693 Examine the SQL error with care. Often the problem is caused by
2694 specifying a wrong field-type.<br />
2695 Common errors include:
2698 <li>Using <tt>VARCHAR</tt> without a size argument</li>
2699 <li>Using <tt>TEXT</tt> or <tt>BLOB</tt> with a size argument</li>
2702 Also, look at the syntax chapter in the MySQL manual to confirm that your
2707 [6.2] When I create a table, I click the Index checkbox for 2 fields and
2708 phpMyAdmin generates only one index with those 2 fields.
2711 In phpMyAdmin 2.2.0 and 2.2.1, this is the way to create a multi-fields
2712 index. If you want two indexes, create the first one when creating the
2713 table, save, then display the table properties and click the Index link to
2714 create the other index.
2718 [6.3] How can I insert a null value into my table?
2721 Since version 2.2.3, you have a checkbox for each field that can be null.
2722 Before 2.2.3, you had to enter "null", without the quotes, as the
2727 [6.4] How can I backup my database or table?
2730 Click on a database or table name in the left frame, the properties will be
2731 displayed. Then on the menu, click "Export", you can dump
2732 the structure, the data, or both. This will generate standard SQL
2733 statements that can be used to recreate your database/table.
2735 You will need to choose "Save as file", so that phpMyAdmin can
2736 transmit the resulting dump to your station. Depending on your PHP
2737 configuration, you will see options to compress the dump. See also the
2738 <tt>$cfg['ExecTimeLimit']</tt> configuration variable.
2740 For additional help on this subject, look for the word "dump" in
2745 [6.5] How can I restore (upload) my database or table using a dump?
2746 How can I run a ".sql" file.
2749 Click on a database name in the left frame, the properties will be
2750 local displayed. Then in the "Run SQL query" section, type in
2751 your dump filename, or use the Browse button. Then click Go.
2753 For additional help on this subject, look for the word "upload"
2758 [6.6] How can I use the relation table in Query-by-example?
2761 Here is an example with the tables persons, towns and countries, all
2762 located in the database mydb. If you don't have a <tt>PMA_relation</tt>
2763 table, create it as explained in the configuration section. Then create the
2767 CREATE TABLE REL_countries (<br />
2768 country_code char(1) NOT NULL default '',<br />
2769 description varchar(10) NOT NULL default '',<br />
2770 PRIMARY KEY (country_code)<br />
2771 ) TYPE=MyISAM;<br />
2773 INSERT INTO REL_countries VALUES ('C', 'Canada');<br />
2775 CREATE TABLE REL_persons (<br />
2776 id tinyint(4) NOT NULL auto_increment,<br />
2777 person_name varchar(32) NOT NULL default '',<br />
2778 town_code varchar(5) default '0',<br />
2779 country_code char(1) NOT NULL default '',<br />
2780 PRIMARY KEY (id)<br />
2781 ) TYPE=MyISAM;<br />
2783 INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');<br />
2784 INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');<br />
2786 CREATE TABLE REL_towns (<br />
2787 town_code varchar(5) NOT NULL default '0',<br />
2788 description varchar(30) NOT NULL default '',<br />
2789 PRIMARY KEY (town_code)<br />
2790 ) TYPE=MyISAM;<br />
2792 INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');<br />
2793 INSERT INTO REL_towns VALUES ('M', 'Montréal');<br />
2796 To setup appropriate links and display information:
2799 <li>on table "REL_persons" click Structure, then Relation view</li>
2800 <li>in Links, for "town_code" choose "REL_towns->code"</li>
2801 <li>in Links, for "country_code" choose "REL_countries->country_code"</li>
2802 <li>on table "REL_towns" click Structure, then Relation view</li>
2803 <li>in "Choose field to display", choose "description"</li>
2804 <li>repeat the two previous steps for table "REL_countries"</li>
2808 Then test like this:
2811 <li>Click on your db name in the left frame</li>
2812 <li>Choose "Query"</li>
2813 <li>Use tables: persons, towns, countries</li>
2814 <li>Click "Update query"</li>
2815 <li>In the fields row, choose persons.person_name and click the
2816 "Show" tickbox </li>
2817 <li>Do the same for towns.description and countries.descriptions in the
2818 other 2 columns</li>
2819 <li>Click "Update query" and you will see in the query box that
2820 the correct joins have been generated</li>
2821 <li>Click "Submit query"</li>
2825 <a name="faqdisplay
"></a><br />
2827 [6.7] How can I use the "display field" feature?
2830 Starting from the previous example, create the PMA_table_info as explained
2831 in the configuration section, then browse your persons table,
2832 and move the mouse over a town code or country code.
2835 <a name="faqpdf
"></a><br />
2837 [6.8] How can I produce a PDF schema of my database?
2840 First you have to fill the "relation", "table_coords"
2841 and "pdf_pages" configuration variables.
2843 Then, think about your schema layout: which tables will go on which pages.
2846 <li>Click on your db name in the left frame</li>
2847 <li>Choose "Structure" in the navigation on top</li>
2848 <li>Choose "Edit PDF Pages" which should be somewhere at the
2849 bottom of the page</li>
2850 <li>Enter the name for a first pdf page and submit</li>
2851 <li>Choose this page to edit</li>
2852 <li>Now add a table you want to show on this page and it's coordinates and
2854 First you will have to guess this coordinates of course, so just expect
2855 to have an area of about 297 * 210 and put the tables coordinates
2856 somewhere in there, you will be able to have a look at what happened
2857 and change them later.<br />
2858 For example, x=100 and y=200 means that the table will be at 200 mm
2859 down and 100 mm right from the upper left corner.<br />
2860 Actually if you have a width of more than 300 or a height of more than
2861 200 than it will automatically be scaled but 300*100 is a good start to
2862 have an idea of what coordinates to use.</li>
2863 <li>After every table you submitted you will have the possibility to submit
2865 <li>When you have entered enough tables Click on your db name in the left
2867 <li>Now, again at the bottom of the page you should be able to choose
2868 "Display PDF schema"<br />
2869 For testing it might be useful to show the grid as well, so you can see
2870 the coordinates used.<br />
2871 Maybe also choose color and submit.</li>
2872 <li>Save the file he will offer you to something like <i>Schema.pdf</i>
2873 (Internet Explorer has some bug there which might make it offer it
2874 without an extension. Under Windows it is important to have the
2875 extension ".pdf", under other OSes you should be fine just
2876 saving the file under the name it offers).</li>
2880 [6.9] phpMyAdmin is changing the type of one of my columns!
2883 No, it's MySQL that is doing
2884 <a href="http://www.mysql.com/doc/S/i/Silent_column_changes.html
">silent column type changing</a>.
2887 <a name="underscore
"></a><br />
2889 [6.10] My database has an underscore in it's name, and when I grant
2890 privileges to a user for this database, a backslash is added before the
2894 This is normal and means that the grant is done only for this database. If
2895 there was no backslash, this would be a wildcard grant, and the
2896 underscore would mean "any character". So, if the database name
2897 is "john_db", the user would get rights to john1db, john2db...
2898 instead of just john_db.<br /><br />
2899 If you really want to grant using a wildcard, there is a dialog box "
2900 Database (wildcards allowed)" for this.
2904 [6.11] What is the curious symbol ø in the statistics pages?
2907 It means "average".
2910 <a name="faqexport
"></a><br />
2912 [6.12] I want to understand some Export options.
2915 "Complete inserts" adds the column names on every INSERT command,
2916 for better documentation (but resulting file is bigger).<br />
2917 "Extended inserts" provides a shorter dump file by using only
2918 once the INSERT verb and the table name.<br />
2919 "Enclose table and field names with backquotes" ensures that
2920 field and table names formed with special characters are protected.<br />
2921 "Include column comments as inline SQL-comments" includes any
2922 column comments set in the PMA-DB in the dump as SQL comments (<i>/* xxx */</i>).<br /></p>
2925 [6.13] I would like to create a database with a dot in its name.
2928 This is a bad idea, because in MySQL the syntax "database.table"
2929 is the normal way to reference a database and table name. Worse, MySQL
2930 will usually let you create a database with a dot, but then you cannot
2931 work with it, nor delete it.<br />
2934 <a name="faqsqlvalidator
"></a><br />
2936 [6.14] How do I set up the SQL Validator?
2939 To use it, you need a very recent version of PHP, 4.3.0 recommended, with
2940 XML, PCRE and PEAR support. On your system command line, run
2941 <tt>"pear install Net_Socket Net_URL HTTP_Request Mail_Mime Net_DIME
2942 SOAP
"</tt> to get the necessary PEAR modules for usage.
2944 If you use it, you should be aware that any SQL statement you
2945 submit will be stored anonymously (database/table/column names,
2946 strings, numbers replaced with generic values). The Mimer SQL
2947 Validator itself, is © 2001 Upright Database Technology.
2948 We utilize it as free SOAP service.
2952 [6.15] I want to add a BLOB field and put an index on it, but MySQL
2953 says "BLOB column '...' used in key specification without a key
2957 The right way to do this, is to create the field without any indexes,
2958 then display the table structure and use the "Create an index"
2959 dialog. On this page, you will be able to choose your BLOB field, and
2960 set a size to the index, which is the condition to create an index on
2966 [6.16] How can I simply move in page with plenty editing fields?
2969 You can use Ctrl+arrows for moving on most pages with plenty editing
2970 fields (table structure changes, row editing, etc.). You can also have
2971 a look at the directive $cfg['DefaultPropDisplay'] ('vertical') and see
2972 if this eases up editing for you.
2977 [6.17] Transformations: I can't enter my own mimetype! WTF is this feature
2981 Slow down :). Defining mimetypes is of no use, if you can't put transformations on them.
2982 Otherwise you could just put a comment on the field. Because entering your own mimetype will
2983 cause serious syntax checking issues and validation, this introduces a high-risk false-user-input
2984 situation. Instead you have to initialize mimetypes using functions or empty mimetype definitions.
2986 Plus, you have a whole overview of available mimetypes. Who knows all those mimetypes by heart so
2987 he/she can enter it at will?
2991 <a name="faqbookmark
"></a>
2993 [6.17] Bookmarks: Where can I store bookmarks? Why can't I see any bookmarks below the query box?
2994 What is this variable for?
2997 Any query you have executed can be stored as a bookmark on the page where the results are displayed.
2998 You will find a button labeled 'Bookmark this query' just at the end of the page.<br />
2999 As soon as you have stored a bookmark, it is related to the database you run the query on. You can
3000 now access a bookmark dropdown on each page, the query box appears on for that database.<br />
3002 Since phpMyAdmin 2.5.0 you are also able to store variables for the bookmarks. Just use the string
3003 <b>/*[VARIABLE]*/</b> anywhere in your query. Everything which is put into the <i>value</i> input
3004 box on the query box page will replace the string "/*[VARIABLE]*/" in your stored query.
3005 Just be aware of that you HAVE to create a valid query, otherwise your query won't be even able to be
3006 stored in the database.<br />
3007 Also remember, that everything else inside the <b>/*[VARIABLE]*/</b> string for your query will remain
3008 the way it is, but will be stripped of the /**/ chars. So you can use:<br /><br />
3009 <code>/*, [VARIABLE] AS myname */</code><br /><br />
3010 which will be expanded to<br /><br />
3011 <code>, VARIABLE as myname</code><br /><br />
3012 in your query, where VARIABLE is the string you entered in the input box. If an empty string is
3013 provided, no replacements are made.<br />
3015 A more complex example. Say you have stored this query:<br /><br />
3016 <code>SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE '%[VARIABLE]%' */</code><br /><br />
3017 Say, you now enter "phpMyAdmin" as the variable for the stored query, the full query will
3019 <code>SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE '%phpMyAdmin%'</code>
3022 You can use multiple occurences of <b>/*[VARIABLE]*/</b> in a single query.<br />
3023 <b>NOTE THE ABSENCE OF SPACES</b> inside the "/**/" construct. Any spaces inserted there
3024 will be later also inserted as spaces in your query and may lead to unexpected results especially when
3025 using the variable expansion inside of a "LIKE ''" expression.<br />
3026 Your initial query which is going to be stored as a bookmark has to yield at least one result row so
3027 you can store the bookmark. You may have that to work around using well positioned "/**/"
3031 <a name="faqproject
"></a><br />
3032 <h3>[7. phpMyAdmin project]</h3>
3035 [7.1] I have found a bug. How do I inform developers?
3038 Our Bug Tracker is located at
3039 <a href="http://sourceforge.net/projects/phpmyadmin/
">http://sourceforge.net/projects/phpmyadmin/</a>
3040 under the Bugs section.
3042 But please first discuss your bug with other users:
3044 <a href="http://sourceforge.net/projects/phpmyadmin/
">
3045 http://sourceforge.net/projects/phpmyadmin/</a> (and choose Forums)
3049 [7.2] I want to translate the messages to a new language or upgrade an
3050 existing language, where do I start?
3053 Always use the current CVS version of your language file.
3054 For a new language, start from <i>english-iso-8859-1.inc.php3</i>. If you
3055 don't know how to get the CVS version, please ask one of the developers.
3057 Please note that we try not to use HTML entities like &eacute; in
3058 the translations, since we define the right character set in the file.
3059 With HTML entities, the text on JavaScript messages would not
3061 However there are some entities that need to be there, for quotes
3062 ,non-breakable spaces, ampersands, less than, greater than.
3064 You can then put your translations, as a zip file to avoid losing special
3065 characters, on the sourceforge.net translation tracker.
3067 It would be a good idea to subscribe to the phpmyadmin-translators mailing
3068 list, because this is where we ask for translations of new messages.
3073 [7.3] I would like to help out with the development of phpMyAdmin. How
3077 The following method is preferred for new developers:
3081 fetch the current CVS tree over anonymous CVS:<br />
3082 <tt>cvs -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin login</tt><br />
3083 [Password: simply press the Enter key]<br />
3084 <tt>cvs -z3 -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin checkout phpMyAdmin</tt><br />
3085 [This will create a new sub-directory named phpMyAdmin]
3091 put the modified files (tar'ed and gzip'ed) inside the patch tracker of
3093 <a href="http://sourceforge.net/projects/phpmyadmin/
" target="_blank
">phpMyAdmin SourceForge account</a>.
3097 Write access to the CVS tree is granted only to experienced developers who
3098 have already contributed something useful to phpMyAdmin.<br />
3099 Also, have a look at the
3100 <a href="#developers
">Developers section</a>.
3104 <a name="developers
"></a><br />
3105 <h2>Developers Information</h2>
3108 phpMyAdmin is Open Source, so you're invited to contribute to it. Many
3109 great features have been written by other people and you too can help to
3110 make phpMyAdmin a useful tool.
3114 If you're planning to contribute source, please read the following
3119 All files include <i>header.inc.php3</i> (layout),
3120 <i>libraries/common.lib.php3</i> (common functions) and
3121 <i>config.inc.php3</i>.
3123 All configuration data belongs in <i>config.inc.php3</i>. Please keep
3124 it free from other code.
3126 Commonly used functions should be added to
3127 <i>libraries/common.lib.php3</i> and more specific ones may be added
3128 within a library stored into the <i>libraries</i> sub-directory.
3131 Obviously, you're free to use whatever coding style you want. But
3132 please try to keep your code as simple as possible: beginners are
3133 using phpMyAdmin as an example application.<br />
3134 As far as possible, we want the scripts to be XHTML1.0 and CSS2
3135 compliant on one hand, they fit the
3136 <a href="http://pear.php.net/
" target="_blank
">PEAR coding standards</a>
3137 on the other hand. Please pay attention to this.
3140 Please try to keep up the file-naming conventions. Table-related stuff
3141 goes to <i>tbl_*.php3</i>, db-related code to <i>db_*.php3</i>,
3142 server-related tools to <i>server_*.php3</i> and so on.
3145 Please don't use verbose strings in your code, instead add the string
3146 (at least) to <i>english-iso-8859-1.inc.php3</i> and print() it out.
3149 If you want to be really helpful, write an entry for the ChangeLog.
3151 <li id="developersdbg
">
3152 The DBG extension (<a href="http://dd.cron.ru/dbg/
" target="_blank
">PHP
3153 Debugger DBG</a>) is now supported by phpMyAdmin for developers to
3154 better debug and profile their code.<br />
3155 Please see the <tt>$cfg['DBG']*</tt> configuration options for more
3157 This is in memoriam of the Space Shuttle Columbia (STS-107) which was
3158 lost during its re-entry into Earth's atmosphere and in memory of the
3159 brave men and women who gave their lives for the people of Earth.
3165 <a name="credits
"></a><br />
3170 phpMyAdmin - Credits
3171 ====================
3173 CREDITS, in chronological order
3174 -------------------------------
3176 - Tobias Ratschiller <tobias.ratschiller_at_maguma.com>
3177 * creator of the phpmyadmin project
3178 * maintainer from 1998 to summer 2000
3180 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca>
3181 * multi-language version
3182 * various fixes and improvements
3183 * project co-administrator
3185 - Olivier Müller <om_at_omnis.ch>
3186 * started SourceForge phpMyAdmin project in March 2001
3187 * sync'ed different existing CVS trees with new features and bugfixes
3188 * multi-language improvements, dynamic language selection
3189 * current project maintainer
3190 * many bugfixes and improvements
3192 - Loïc Chapeaux <lolo_at_phpheaven.net>
3193 * rewrote and optimized javascript, DHTML and DOM stuff
3194 * rewrote the scripts so they fit the PEAR coding standards and
3195 generate XHTML1.0 and CSS2 compliant codes
3196 * improved the language detection system
3197 * many bugfixes and improvements
3199 - Robin Johnson <robbat2_at_users.sourceforge.net>
3200 * database maintence controls
3202 * Host authentication IP Allow/Deny
3203 * DB-based configuration (Not completed)
3206 * many bugfixes and improvements
3208 - Armel Fauveau <armel.fauveau_at_globalis-ms.com>
3210 * multiple dump feature
3214 - Geert Lund <glund_at_silversoft.dk>
3216 * moderator of the phpMyAdmin users forum at phpwizard.net
3218 - Korakot Chaovavanich <korakot_at_iname.com>
3219 * "insert as new row" feature
3221 - Pete Kelly <webmaster_at_trafficg.com>
3222 * rewrote and fix dump code
3225 - Steve Alberty <alberty_at_neptunlabs.de>
3226 * rewrote dump code for PHP4
3227 * mySQL table statistics
3230 - Benjamin Gandon <gandon_at_isia.cma.fr>
3231 * main author of the version 2.1.0.1
3234 - Alexander M. Turek <rabus_at_bugfixes.info>
3236 * MySQL 4 related features
3237 * various small features and fixes
3238 * German language file updates
3240 - Mike Beck <mike.beck_at_ibmiller.de>
3241 * automatic joins in QBE
3242 * links column in printview
3245 - Michal Cihar <nijel_at_users.sourceforge.net>
3246 * enhanced index creation/display feature
3247 * feature to use a different charset for HTML than for MySQL
3248 * Czech language file updates
3250 - Christophe Gesché from the "MySQL Form Generator for PHPMyAdmin"
3251 (http://sourceforge.net/projects/phpmysqlformgen/)
3252 * suggested the patch for multiple table printviews
3254 - Garvin Hicking <hicking_at_faktor-e.de>
3255 * built the patch for vertical display of table rows
3256 * built the Javascript based Query window + SQL history
3257 * Improvement of column/db comments
3258 * (MIME)-Transformations for columns
3259 * Use custom alias names for Databases in left frame
3260 * vertical display of column properties page
3261 * some bugfixes, smaller features
3263 - Yukihiro Kawada <kawada_at_den.fujifilm.co.jp>
3264 * japanese kanji encoding conversion feature
3266 - Piotr Roszatycki <d3xter_at_users.sourceforge.net> and Dan Wilson
3267 * the Cookie authentication mode
3269 - Axel Sander <n8falke_at_users.sourceforge.net>
3270 * table relation-links feature
3272 - Maxime Delorme <delorme.maxime_at_free.fr>
3273 * PDF schema output, thanks also to Olivier Plathey for the
3274 "FPDF" library (see http://www.fpdf.org/).
3276 - Olof Edlund <olof.edlund_at_upright.se>
3277 * SQL validator server
3279 - Ivan R. Lanin <ivanlanin_at_users.sourceforfe.net>
3282 And also to the following people who have contributed minor changes,
3283 enhancements, bugfixes or support for a new language since version 2.1.0:
3285 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
3286 Péter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
3287 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kläger,
3288 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
3289 Bernard M. Piller, Laurent Haas, "Sakamoto", Yuval Sarna,
3290 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
3291 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
3292 Luís V., Martijn W. van der Lee,
3293 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
3294 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, "Manuzhai".
3297 Original Credits of Version 2.1.0
3298 ---------------------------------
3300 This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
3301 to create a web-based interface to MySQL using PHP3. Although I have not
3302 used any of his source-code, there are some concepts I've borrowed from
3303 him. phpMyAdmin was created because Peter told me he wasn't going to
3304 further develop his (great) tool.
3306 - Amalesh Kempf <ak-lsml_at_living-source.com> who contributed the
3307 code for the check when dropping a table or database. He also suggested
3308 that you should be able to specify the primary key on tbl_create.php3. To
3309 version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
3310 well as a bug-report. Plus many smaller improvements.
3311 - Jan Legenhausen <jan_at_nrw.net>: He made many of the changes that
3312 were introduced in 1.3.0 (including quite significant ones like the
3313 authentication). For 1.4.1 he enhanced the table-dump feature. Plus
3315 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca> made phpMyAdmin
3316 language-independent by outsourcing the strings to a separate file. He
3317 also contributed the French translation.
3318 - Alexandr Bravo <abravo_at_hq.admiral.ru> who contributed
3319 tbl_select.php3, a feature to display only some fields from a table.
3320 - Chris Jackson <chrisj_at_ctel.net> added support for MySQL
3321 functions in tbl_change.php3. He also added the
3322 "Query by Example" feature in 2.0.
3323 - Dave Walton <walton_at_nordicdms.com> added support for multiple
3324 servers and is a regular contributor for bug-fixes.
3325 - Gabriel Ash <ga244_at_is8.nyu.edu> contributed the random access
3327 The following people have contributed minor changes, enhancements, bugfixes
3328 or support for a new language:
3329 Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
3330 Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
3331 Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
3334 And thanks to everyone else who sent me email with suggestions, bug-reports
3335 and or just some feedback.
3340 <a name="bottom
"></a><br />
3342 <a href="http://validator.w3.org/check/referer
" target="w3c
">
3343 <img src="http://www.w3.org/Icons/valid-xhtml10
" alt="Valid XHTML
1.0!
" border="0" height="31" width="88" /></a>
3344
3345 <a href="http://jigsaw.w3.org/css-validator/
" target="w3c
">
3346 <img src="http://www.w3.org/Icons/valid-css
" alt="Valid CSS!
" border="0" width="88" height="31" /></a>