2 ______________________________________________________________________
4 Top - Requirements - Introduction - Installation -
6 Transformations - FAQ - Developers - Credits - Translators
7 ______________________________________________________________________
9 phpMyAdmin 2.5.0-dev Documentation
11 * SourceForge phpMyAdmin project page [ http://www.phpmyadmin.net/
14 + Version history: ChangeLog
15 + General notes: README
17 * Documentation version: $Id: Documentation.html,v 1.421 2003/03/18
22 * PHP3 or PHP4: phpMyAdmin widely uses the 'str_replace()' PHP
23 function that was added in PHP 3.0.6, but was buggy up until
24 PHP 3.0.8. Then you should not run this script with PHP3 < 3.0.8.
25 PHP also needs to be compiled with MySQL support;
26 If you want to display inline thumbnails of JPEGs, you also need
28 * MySQL (tested with 3.21.x, 3.22.x, 3.23.x and 4.0.x);
29 Note: Because of a major change in the definition syntax of string
30 field types, this version of phpMyAdmin probably won't work
31 correctly with MySQL >= 4.1.0!
32 * a web-browser (doh!).
36 phpMyAdmin can manage a whole MySQL server (needs a super-user) as
37 well as a single database. To accomplish the latter you'll need a
38 properly set up MySQL user who can read/write only the desired
39 database. It's up to you to look up the appropriate part in the MySQL
41 Currently phpMyAdmin can:
42 * create and drop databases
43 * create, copy, drop, rename and alter tables
44 * do table maintenance
45 * delete, edit and add fields
46 * execute any SQL-statement, even batch-queries
47 * manage keys on fields
48 * load text files into tables
49 * create (*) and read dumps of tables
50 * export (*) data to CSV, XML and Latex formats
51 * administer multiple servers
52 * manage MySQL users and privileges
53 * check referential integrity
54 * using Query-by-example (QBE), create complex queries automatically
55 connecting required tables
56 * create PDF graphics of your Database layout
57 * search globally in a database or a subset of it
58 * transform stored data into any format using a set of predefined
59 functions, like displaying BLOB-data as image or download-link or
61 * communicate in 42 different languages
63 (*) phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats)
64 dumps and CSV exports if you use PHP4 >= 4.0.4 with Zlib support
65 (--with-zlib) and/or Bzip2 support (--with-bz2).
69 NOTE: phpMyAdmin does not apply any special security methods to the
70 MySQL database server. It is still the system administrator's job to
71 grant permissions on the MySQL databases properly. phpMyAdmin's
72 "Privileges" page can be used for this.
74 Warning for Mac users:if you are on a MacOS version before OS X,
75 StuffIt unstuffs with Mac formats.
76 So you'll have to resave as in BBEdit to Unix style ALL phpMyAdmin
77 scripts before uploading them to your server, as PHP seems not to like
78 Mac-style end of lines character ("\r").
80 Documentation warning: when you see in this document a .php3 file
81 extension, please transpose to .php if you are using a kit with files
82 having this extension.
85 1. Choose and download a distribution kit with the files having the
86 extension (.php3 or .php) depending on the way your web/PHP server
87 interprets those extensions.
88 2. Untar or unzip the distribution (be sure to unzip the
89 subdirectories): tar -xzvf phpMyAdmin_x.x.x.tar.gz in your
90 webserver's document root. If you don't have direct access to your
91 document root, put the files in a directory on your local machine,
92 and, after step 3, transfer the directory on your web server
93 using, for example, ftp.
94 3. Open the file config.inc.php3 in your favorite editor and change
95 the values for host, user, password and authentication mode to fit
96 your environment. Here, "host" means the MySQL server. Also insert
97 the correct value for $cfg['PmaAbsoluteUri']. Have a look at
98 Configuration section for an explanation of all values.
99 4. It is recommended that you protect the directory in which you
100 installed phpMyAdmin (unless it's on a closed intranet, or you
101 wish to use HTTP or cookie authentication), for example with
102 HTTP-AUTH (in a .htaccess file). See the FAQ section for
103 additional information.
104 5. Open the file <www.your-host.com>/<your-install-dir>/index.php3 in
105 your browser. phpMyAdmin should now display a welcome screen and
106 your databases, or a login dialog if using HTTP or cookie
108 6. For a whole set of new features (bookmarks, comments, SQL-history,
109 PDP-generation) you need to create a set of tables in your
110 database. Please look at your scripts/ directory, where you should
111 find a file called create_tables.sql. You can already use your
112 phpMyAdmin to create the tables for you. Please be aware that you
113 may have to have special (administrator) privileges to create the
114 database and tables. After having imported the create_tables.sql
115 file, you should specify the table names in your config.inc.php3
116 file. The directives used for that can be found in the
117 Configuration section.
119 Upgrading from an older version:
120 * Please do not copy your older config.inc.php3 over the new one: it
121 may offer new configuration variables, and the new version may
122 depend on these for normal behavior. It is suggested instead to
123 insert your site values in the new one.
125 Using authentication modes:
126 * HTTP and cookie authentication modes are recommended in a
127 multi-user environment where you want to give users access to
128 their own database and don't want them to play around with others.
129 Nevertheless be aware that MS Internet Explorer seems to be really
130 buggy about cookies, at least till version 6. And PHP 4.1.1 is
131 also a bit buggy in this area!
132 Even in a single-user environment, you might prefer to use HTTP or
133 cookie mode so that your user/password pair are not in clear in
134 the configuration file.
135 * HTTP and cookie authentication modes are more secure: the MySQL
136 password does not need to be set in the phpMyAdmin configuration
137 file (except for the "controluser" -see the Configuration
139 However, keep in mind that the password travels in plain text,
140 unless you are using the HTTPS protocol.
141 In cookie mode, we send the password in a temporary cookie, so
142 most browsers should not store the password in their cookie file.
143 * For 'HTTP' and 'cookie' modes, phpMyAdmin needs a controluser that
144 has only the SELECT privilege on the mysql.user (all columns
145 except "Password"), mysql.db (all columns) & mysql.tables_priv
146 (all columns except "Grantor" & "Timestamp") tables.
147 You must specify the details for the controluser in the
148 config.inc.php3 file under the $cfg['Servers'][$i]['controluser']&
149 $cfg['Servers'][$i]['controlpass'] settings.
150 This example assumes you want to use pma as the controluser and
151 pmapass as the controlpass, but this is only an example: use
152 something else in your file:
154 GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY 'pmapass';
155 GRANT SELECT (Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv, Create_priv,
156 Drop_priv, Reload_priv, Shutdown_priv, Process_priv, File_priv,
157 Grant_priv, References_priv, Index_priv, Alter_priv)
158 ON mysql.user TO 'pma'@'localhost';
159 GRANT SELECT ON mysql.db TO 'pma'@'localhost';
160 GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv)
161 ON mysql.tables_priv TO 'pma'@'localhost';
163 ... and if you want to use the many new relation and bookmark
166 GRANT SELECT, INSERT, UPDATE, DELETE ON <pma_db> TO 'pma'@'localhost';
168 (this of course requires you to have a special DB for phpMyAdmin,
169 the contents will be explained later)
170 * Then each of the true users should be granted a set of privileges
171 on a set of particular databases. Normally you shouldn't give
172 global privileges to an ordinary user, unless you understand the
173 impact of those privileges (for example, you are creating a
175 For example, to grant the user real_user with all privileges on
176 the database user_base:
177 GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost
178 IDENTIFIED BY 'real_password';
179 What the user may now do is controlled entirely by the MySQL user
181 With HTTP or cookie authentication mode, you don't need to fill
182 the user/password fields inside the $cfg['Servers'] array.
184 'http' authentication mode:
185 * Was called 'advanced' in versions before 2.2.3.
186 * Introduced in 1.3.0, it uses Basic HTTP authentication method and
187 allows you to login as any valid MySQL user.
188 * Is only supported with PHP running as an Apache module, not with
191 'cookie' authentication mode:
192 * You can use this method as a replacement for the HTTP
193 authentication (for example, if you're running IIS).
194 * Obviously, the user must enable cookies in the browser.
195 * With this mode, the use can truly logout of phpMyAdmin and login
196 back with the same username.
198 'config' authentication mode:
199 * This mode is the less secure one because it requires you to fill
200 the $cfg['Servers'][$i]['user'] and
201 $cfg['Servers'][$i]['password'] fields.
202 But you don't need to setup a "controluser" here: using the
203 $cfg['Servers'][$i]['only_db'] might be enough.
204 * In the ISP FAQ section, there is an entry explaining how to
205 protect your configuration file.
206 * For additional security in this mode, you may wish to consider the
207 Host authentication $cfg['Servers'][$i]['AllowDeny']['order'] and
208 $cfg['Servers'][$i]['AllowDeny']['rules'] configuration
213 Warning for Mac users: PHP seems not to like Mac end of lines
214 character ("\r"). So ensure you choose the option that allows to use
215 the *nix end of line character ("\n") in your text editor before
216 registering a script you have modified.
218 All configurable data is placed in config.inc.php3.
220 $cfg['PmaAbsoluteUri'] string
221 Sets here the complete URL (with full path) to your phpMyAdmin
223 http://www.your_web.net/path_to_your_phpMyAdmin_directory/.
224 phpMyAdmin needs this setting, because of requirements of the
225 HTTP protocol, explained in RFC2616, section 14.30.
226 Don't forget the slash at the end of your URL. The URL must
227 contain characters that are valid for a URL, and on some
228 servers, the path is case-sensitive.
229 Starting with version 2.3.0, you can try to leave this
230 parameter empty, because the program tries to auto-detect its
231 proper value. Additional details are in the configuration file.
232 Alternatively, this setting can be dynamically completed. For
233 example, you can try to use such a kind of code:
235 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
236 . $_SERVER['HTTP_HOST']
237 . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
238 . substr($_SERVER['PHP_SELF'], 0, strrpos($_SERVER['PHP_SELF'], '/')+1);
242 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
243 . $_SERVER['SERVER_NAME']
244 . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
245 . substr($_SERVER['SCRIPT_NAME'], 0, strrpos($_SERVER['SCRIPT_NAME'], '/')+1);
248 Please note that the $_SERVER array doesn't exist in
249 PHP < 4.1.0. Try to replace $_SERVER by $HTTP_SERVER_VARS or
250 $GLOBALS in this case.
252 $cfg['PmaAbsoluteUri_DisableWarning'] boolean
253 By default, when you leave $cfg['PmaAbsoluteUri'] empty, and
254 the system detects your absolute URI automatically, we display
255 a warning to remind you. If you have tested the automatic
256 detection, and it works perfectly for your setup, then you can
257 set this variable to squelch the warning.
259 $cfg['PmaNoRelation_DisableWarning'] boolean
260 Starting with version 2.3.0 phpMyAdmin offers a lot of features
261 to work with master / foreign - tables (see
262 $cfg['Servers'][$i]['pmadb']).
263 If you tried to set this up and it does not work for you, have
264 a look on the "Structure" page of one database where you would
265 like to use it. You will find a link that will analyze why
266 those features have been disabled.
267 If you do not want to use those features set this variable to
268 TRUE to stop this message from appearing.
270 $cfg['Servers'] array
271 Since version 1.4.2, phpMyAdmin supports the administration of
272 multiple MySQL servers. Therefore, a $cfg['Servers']-array has
273 been added which contains the login information for the
274 different servers. The first $cfg['Servers'][$i]['host']
275 contains the hostname of the first server, the second
276 $cfg['Servers'][$i]['host'] the hostname of the second server,
277 etc. If you have only one server to administer, simply leave
278 free the hostname of the other $cfg['Server']-entries.
280 $cfg['Servers'][$i]['host'] string
281 The hostname of your $i-th MySQL-server. E.g. localhost.
283 $cfg['Servers'][$i]['port'] string
284 The port-number of your $i-th MySQL-server. Default is 3306
287 $cfg['Servers'][$i]['socket'] string
288 The path to the socket to use. Leave blank for default.
289 To use the socket feature you must run PHP 3.0.10 or more.
291 $cfg['Servers'][$i]['connect_type'] string
292 What type connection to use with the MySQL server. Your options
293 are 'socket' & 'tcp'. It defaults to 'tcp' as that is nearly
294 guaranteed to be available on all MySQL servers, while sockets
295 are not supported on some platforms.
296 To use the socket mode, your MySQL server must be on the same
297 machine as the Web server.
299 $cfg['Servers'][$i]['compress'] boolean
300 Whether to use a compressed protocol for the MySQL server
301 connection or not (experimental).
302 This feature requires PHP >= 4.3.0.
304 $cfg['Servers'][$i]['controluser'] string
305 $cfg['Servers'][$i]['controlpass'] string
306 When using HTTP or cookie authentication modes (or 'config'
307 authentication mode since phpMyAdmin 2.2.1), you need to supply
308 the details of a MySQL account that has SELECT privilege on the
309 mysql.user (all columns except "Password"), mysql.db (all
310 columns) & mysql.tables_priv (all columns except "Grantor" &
311 "Timestamp") tables. This account is used to check what
312 databases the user will see at login.
313 Please see the install section on "Using HTTP authentication"
314 for more information.
315 Note that if you try login to phpMyAdmin with this
316 "controluser", you could get some errors, depending the exact
317 privileges you gave to the "controluser". phpMyAdmin does not
318 support a direct login with the "controluser".
319 In versions before 2.2.5, those were called "stduser/stdpass".
321 $cfg['Servers'][$i]['auth_type'] string ['http'|'cookie'|'config']
322 Whether config or cookie or http authentication should be used
325 + 'config' authentication ($auth_type = 'config') is the plain
326 old way: username and password are stored in config.inc.php3.
327 + 'cookie' authentication mode ($auth_type = 'cookie') as
328 introduced in 2.2.3 allows you to log in as any valid MySQL
329 user with the help of... cookies. Log name and password are
330 stored in cookies during the session and password is deleted
332 + 'http' authentication (was called 'advanced' in older
333 versions) ($auth_type = 'http') as introduced in 1.3.0 allows
334 you to log in as any valid MySQL user via HTTP-Auth.
336 Please see the install section on "Using authentication modes"
337 for more information.
339 $cfg['Servers'][$i]['user'] string
340 $cfg['Servers'][$i]['password'] string
341 The user/password-pair which phpMyAdmin will use to connect to
342 this MySQL-server. This user/password pair is not needed when
343 HTTP or cookie authentication is used, and should be empty.
345 $cfg['Servers'][$i]['only_db'] string or array
346 If set to a(an array of) database name(s), only this(these)
347 database(s) will be shown to the user. Since phpMyAdmin 2.2.1,
348 this/these database(s) name(s) may contain MySQL wildcards
349 characters ("_" and "%"): if you want to use literal instances
350 of these characters, escape them (I.E. use 'my\_db' and not
352 This setting is an efficient way to lower the server charge
353 since the latter does not need to send MySQL requests to build
354 the available database list. But it does not replace the
355 privileges rules of the MySQL database server. If set, it just
356 means only these databases will be displayed but not at all
357 other databases can't be used.
359 $cfg['Servers'][$i]['verbose'] string
360 Only useful when using phpMyAdmin with multiple server entries.
361 If set, this string will be displayed instead of the hostname
362 in the pull-down menu on the main page. This can be useful if
363 you want to show only certain databases on your system, for
366 $cfg['Servers'][$i]['pmadb'] string
367 Starting with version 2.3.0 phpMyAdmin offers a lot of features
368 to work with master / foreign - tables. To use those as well as
369 the bookmark feature you need special tables with a predefined
370 structure, which we explain below.
371 If you are the only user of this phpMyAdmin installation, you
372 can use your current database to store those special tables; in
373 this case, just put your current database name in
374 $cfg['Servers'][$i]['pmadb'].
375 If you are setting up a multi-user phpMyAdmin installation, you
376 will need to create a new database and setup special
377 privileges, so, as superuser:
379 + create a new database for phpMyAdmin:
380 CREATE DATABASE phpmyadmin;
381 Note that "controluser" must have SELECT, INSERT, UPDATE and
382 DELETE privileges on this database. Here is a query to set up
383 those privileges (using "phpmyadmin" as the database name,
384 and "pma" as the controluser):
385 GRANT SELECT,INSERT,UPDATE,DELETE ON phpmyadmin.* to
387 do not give any other user rights on this database.
388 + enter the database name in $cfg['Servers'][$i]['pmadb']
390 $cfg['Servers'][$i]['bookmarktable'] string
391 Since release 2.2.0 phpMyAdmin allows to bookmark queries. This
392 can be useful for queries you often run.
393 To allow the usage of this functionality you have to:
395 + set up "pmadb" as described above
396 + within this database create a table following this scheme:
397 CREATE TABLE `PMA_bookmark` (
398 id int(11) DEFAULT '0' NOT NULL auto_increment,
399 dbase varchar(255) NOT NULL,
400 user varchar(255) NOT NULL,
401 label varchar(255) NOT NULL,
404 ) TYPE=MyISAM COMMENT='Bookmarks';
405 + enter the table name in $cfg['Servers'][$i]['bookmarktable']
407 $cfg['Servers'][$i]['relation'] string
408 Since release 2.2.4 you can describe, in a special 'relation'
409 table, which field is a key in another table (a foreign key).
410 phpMyAdmin currently uses this to
412 + make clickable, when you browse the master table, the data
413 values that point to the foreign table;
414 + display in an optional tool-tip the "display field" when
415 browsing the master table, if you move the mouse to a column
416 containing a foreign key (use also the 'table_info' table);
417 + display links on the table properties page, to check
418 referential integrity (display missing foreign keys) for each
420 + in query-by-example, create automatic joins (see an example
421 in the FAQ, section "Using phpMyAdmin");
422 + enable you to get a PDF schema of your database (also uses
423 the table_coords table).
425 The keys can be numeric or character.
426 To allow the usage of this functionality the superuser has to:
428 + set up "pmadb" as described above
429 + within this database create a table following this scheme:
430 CREATE TABLE `PMA_relation` (
431 `master_db` varchar(64) NOT NULL default '',
432 `master_table` varchar(64) NOT NULL default '',
433 `master_field` varchar(64) NOT NULL default '',
434 `foreign_db` varchar(64) NOT NULL default '',
435 `foreign_table` varchar(64) NOT NULL default '',
436 `foreign_field` varchar(64) NOT NULL default '',
437 PRIMARY KEY (`master_db`, `master_table`,
439 KEY foreign_field (foreign_db, foreign_table)
440 ) TYPE=MyISAM COMMENT='Relation table';
441 + put the relation table name in
442 $cfg['Servers'][$i]['relation']
443 + now as normal user open phpMyAdmin and for each one of your
444 tables where you want to use this feature, click
445 "Structure/Relation view/" and choose foreign fields.
447 Please note that in the current (2.3.0) version, master_db must
448 be the same as foreign_db. Those fields have been put in future
449 development of the cross-db relations.
451 $cfg['Servers'][$i]['table_info'] string
452 Since release 2.3.0 you can describe, in a special 'table_info'
453 table, which field is to be displayed as a tool-tip when moving
454 the cursor over the corresponding key.
455 This configuration variable will hold the name of this special
456 table. To allow the usage of this functionality the superuser
459 + set up "pmadb" as described above
460 + within this database create a table following this scheme:
461 CREATE TABLE `PMA_table_info` (
462 `db_name` varchar(64) NOT NULL default '',
463 `table_name` varchar(64) NOT NULL default '',
464 `display_field` varchar(64) NOT NULL default '',
465 PRIMARY KEY (`db_name`, `table_name`)
466 ) TYPE=MyISAM COMMENT='Table information for
468 + put the table name in $cfg['Servers'][$i]['table_info']
469 + then for each table where you want to use this feature, click
470 "Structure/Relation view/Choose field to display" to choose
473 Usage tip: Display field.
475 $cfg['Servers'][$i]['table_coords'] string
476 $cfg['Servers'][$i]['pdf_pages'] string
477 Since release 2.3.0 you can have phpMyAdmin create PDF pages
478 showing the relations between your tables. To do this it needs
479 two tables "pdf_pages" (storing information about the available
480 PDF pages) and "table_coords" (storing coordinates where each
481 table will be placed on a PDF schema output).
482 You must be using the "relation" feature and have a table of
483 PDF pages (see $cfg['Servers'][$i]['pdf_pages']) to create PDF
485 To allow the usage of this functionality the superuser has to:
487 + set up "pmadb" as described above
488 + within this database create a table following this scheme:
489 CREATE TABLE `PMA_table_coords` (
490 `db_name` varchar(64) NOT NULL default '',
491 `table_name` varchar(64) NOT NULL default '',
492 `pdf_page_number` int NOT NULL default '0',
493 `x` float unsigned NOT NULL default '0',
494 `y` float unsigned NOT NULL default '0',
495 PRIMARY KEY (`db_name`, `table_name`,
497 ) TYPE=MyISAM COMMENT='Table coordinates for phpMyAdmin
499 + also within this database create:
500 CREATE TABLE `PMA_pdf_pages` (
501 `db_name` varchar(64) NOT NULL default '',
502 `page_nr` int(10) unsigned NOT NULL auto_increment,
503 `page_descr` varchar(50) NOT NULL default '',
504 PRIMARY KEY (page_nr),
506 ) TYPE=MyISAM COMMENT='PDF Relationpages for PMA';
507 + put the first table name in
508 $cfg['Servers'][$i]['table_coords'] and the second table name
509 in $cfg['Servers'][$i]['pdf_pages']
511 Usage tips: PDF output.
513 $cfg['Servers'][$i]['column_info'] string
514 Since release 2.3.0 you can store comments to describe each
515 column for each table. These will then be shown on the
517 Starting with release 2.5.0, comments are consequently used on
518 the table property pages and table browse view, showing up as
519 tool-tips above the column name (properties page) or embedded
520 within the header of table in browse view. They can also be
521 shown in a table dump. Please see the relevant configuration
523 Also new in release 2.5.0 is a mime-transformation system which
524 is also based on the following table structure. See
525 Transformations for further information. To use the
526 mime-transformation system, your column_info table has to have
527 the three new fields 'mimetype', 'transformation',
528 'transformation_options'.
529 To allow the usage of this functionality the superuser has to:
531 + set up "pmadb" as described above
532 + within this database create a table following this scheme:
533 CREATE TABLE `PMA_column_info` (
534 id int(5) unsigned NOT NULL auto_increment,
535 db_name varchar(64) NOT NULL default '',
536 table_name varchar(64) NOT NULL default '',
537 column_name varchar(64) NOT NULL default '',
538 `comment` varchar(255) NOT NULL default '',
539 mimetype varchar(255) NOT NULL default '',
540 transformation varchar(255) NOT NULL default '',
541 transformation_options varchar(255) NOT NULL default
544 UNIQUE KEY db_name (db_name, table_name, column_name)
545 ) TYPE=MyISAM COMMENT='Comments for Columns';
546 + put the table name in $cfg['Servers'][$i]['column_info']
547 + To update your PRE-2.5.0 Column_comments Table use this:
548 ALTER TABLE `PMA_column_comments`
549 ADD `mimetype` VARCHAR( 255 ) NOT NULL ,
550 ADD `transformation` VARCHAR( 255 ) NOT NULL ,
551 ADD `transformation_options` VARCHAR( 255 ) NOT NULL ;
552 and remember that the Variable in config.inc.php has been
554 $cfg['Servers'][$i]['column_comments'] to
555 $cfg['Servers'][$i]['column_info']
557 $cfg['Servers'][$i]['history'] string
558 Since release 2.5.0 you can store your SQL history, which means
559 all queries you entered manually into the phpMyAdmin interface.
560 If you don't want to use a table- based history, you can use
561 the JavaScript-based history. Using that, all your history
562 items are deleted when closing the window.
563 Using $cfg['QueryHistoryMax'] you can specify an amount of
564 history items you want to have on hold. On every login, this
565 list gets cut to the maximum amount.
566 The query history is only available if you use the
567 JavaScript-based query window, see $cfg['QueryFrame'].
568 To allow the usage of this functionality the superuser has to:
570 + set up "pmadb" as described above
571 + within this database create a table following this scheme:
572 CREATE TABLE `PMA_history` (
573 `id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
574 `username` VARCHAR( 64 ) NOT NULL ,
575 `db` VARCHAR( 64 ) NOT NULL ,
576 `table` VARCHAR( 64 ) NOT NULL ,
577 `timevalue` TIMESTAMP NOT NULL ,
578 `sqlquery` TEXT NOT NULL ,
579 PRIMARY KEY ( `id` ) ,
580 INDEX ( `username` , `db` , `table` , `timevalue` )
581 ) TYPE=MyISAM COMMENT='SQL history';
582 + put the table name in $cfg['Servers'][$i]['history']
584 $cfg['Servers'][$i]['verbose_check'] string
585 Because release 2.5.0 introduced the new MIME-transformation
586 support, the column_info table got enhanced with three new
587 fields. If the above variable is set to TRUE (default)
588 phpMyAdmin will check if you have the latest table structure
589 available. If not, it will emit a warning to the superuser.
590 You can disable this checking behavior by setting the variable
591 to false, which should offer a performance increase.
592 Recommended to set to FALSE, when you are sure, your table
593 structure is up to date.
595 $cfg['Servers'][$i]['AllowDeny']['order'] string
596 If your rule order is empty, then IP authentication is
598 If your rule order is set to 'deny,allow' then the system
599 applies all deny rules followed by allow rules. Access is
600 allowed by default. Any client which does not match a Deny
601 command or does match an Allow command will be allowed access
603 If your rule order is set to 'allow,deny' then the system
604 applies all allow rules followed by deny rules. Access is
605 denied by default. Any client which does not match an Allow
606 directive or does match a Deny directive will be denied access
608 If your rule order is set to 'explicit', the authentication is
609 performed in a similar fashion to rule order 'deny,allow', with
610 the added restriction that your host/username combination must
611 be listed in the allow rules, and not listed in the deny rules.
612 This is the most secure means of using Allow/Deny rules, and
613 was available in Apache by specifying allow and deny rules
614 without setting any order.
616 $cfg['Servers'][$i]['AllowDeny']['rules'] array of strings
617 The general format for the rules is as such:
618 <'allow' | 'deny'> <username> [from] <ipmask>
619 If you wish to match all users, it is possible to use a '%' as
620 a wildcard in the username field.
621 There are a few shortcuts you can use in the ipmask field as
624 'localhost' -> 127.0.0.1/8
625 Having an empty rule list is equivalent to either using 'allow
626 % from all' if your rule order is set to 'deny,allow' or 'deny
627 % from all' if your rule order is set to 'allow,deny' or
629 For the IP matching system, the following work:
630 xxx.xxx.xxx.xxx (an exact IP address)
631 xxx.xxx.xxx.[yyy-zzz] (an IP address range)
632 xxx.xxx.xxx.xxx/nn (CIDR, Classless Inter-Domain Routing type
634 But the following does not work:
635 xxx.xxx.xxx.xx[yyy-zzz] (partial IP address range)
637 $cfg['ServerDefault'] integer
638 If you have more than one server configured, you can set
639 $cfg['ServerDefault'] to any one of them to autoconnect to that
640 server when phpMyAdmin is started, or set it to 0 to be given a
641 list of servers without logging in.
642 If you have only one server configured, $cfg['ServerDefault']
643 MUST be set to that server.
645 $cfg['OBGzip'] boolean
646 Defines whether to use GZip output buffering for increased
647 speed in HTTP transfers.
649 $cfg['PersistentConnections'] boolean
650 Whether persistent connections should be used or not
651 (mysql_connect or mysql_pconnect).
653 $cfg['ExecTimeLimit'] integer [number of seconds]
654 Set the number of seconds a script is allowed to run. If
655 seconds is set to zero, no time limit is imposed.
656 This setting is used while importing/exporting dump files but
657 has no effect when PHP is running in safe mode.
659 $cfg['SkipLockedTables'] boolean
660 Mark used tables and make it possible to show databases with
661 locked tables (since 3.23.30).
663 $cfg['ShowSQL'] boolean
664 Defines whether SQL-queries generated by phpMyAdmin should be
667 $cfg['AllowUserDropDatabase'] boolean
668 Defines whether normal users (non-administrator) are allowed to
669 delete their own database or not. If set as FALSE, the link
670 "Drop Database" will not be shown, and even a "DROP DATABASE
671 mydatabase" will be rejected. Quite practical for ISP's with
674 $cfg['Confirm'] boolean
675 Whether a warning ("Are your really sure..") should be
676 displayed when you're about to loose data.
678 $cfg['LoginCookieRecall'] boolean
679 Define whether the previous login should be recalled or not in
680 cookie authentication mode.
682 $cfg['UseDbSearch'] boolean
683 Define whether the "search string inside database" is enabled
686 $cfg['LeftFrameLight'] boolean
687 Defines whether to use select-based menu and display only the
688 current tables in the left frame (smaller page).
690 $cfg['ShowTooltip'] boolean
691 Defines whether to display table comment as tool-tip in left
694 $cfg['ShowTooltipAliasDB'] boolean
695 If tool-tips are enabled and a DB comment is set, this will
696 flip the comment and the real name. That means, if you have a
697 table called 'user0001' and add the comment 'MyName' on it, you
698 will see the name 'MyName' used consequently in the left frame
699 and the tool-tip shows the real name of the DB.
701 $cfg['ShowTooltipAliasTB'] boolean
702 Same as $cfg['ShowTooltipAliasDB'], except this works for table
705 $cfg['ShowStats'] boolean
706 Defines whether to display space usage and statistics about
707 databases and tables or not.
708 Note that statistics requires at least MySQL 3.23.3 and that,
709 at this date, MySQL doesn't return such information for
712 $cfg['ShowMysqlInfo'] boolean
713 $cfg['ShowMysqlVars'] boolean
714 $cfg['ShowPhpInfo'] boolean
715 $cfg['ShowChgPassword'] boolean
716 Defines whether to display the "MySQL runtime information",
717 "MySQL system variables", "PHP information" and "Change
718 password " links or not for simple users at the starting main
719 (right) frame. This setting does not check MySQL commands
721 Please note that to block the usage of phpinfo() in scripts,
722 you have to put this in your php.ini:
723 disable_functions = phpinfo()
724 Also note that enabling the "Change password " link has no
725 effect with "config" authentication mode: because of the hard
726 coded password value in the configuration file, end users can't
727 be allowed to change their passwords.
729 $cfg['SuggestDBName'] boolean
730 Defines whether to suggest a database name on the "Create
731 Database" form or to keep the textfield empty.
733 $cfg['ShowBlob'] boolean
734 Defines whether BLOB fields are shown when browsing a table's
737 $cfg['NavigationBarIconic'] boolean
738 Defines whether navigation bar buttons contain text or symbols
741 $cfg['ShowAll'] boolean
742 Defines whether an user should be displayed a "show all
743 (records)" button in browse mode or not.
745 $cfg['MaxRows'] integer
746 Number of rows displayed when browsing a result set. If the
747 result set contains more rows, Previous/Next links will be
750 $cfg['Order'] string [DESC|ASC|SMART]
751 Defines whether fields are displayed in ascending (ASC) order,
752 in descending (DESC) order or in a "smart" (SMART) order - I.E.
753 descending order for fields of type TIME, DATE, DATETIME &
754 TIMESTAMP, ascending order else- by default.
756 $cfg['ProtectBinary'] boolean or string
757 Defines whether BLOB or BINARY fields are protected from
758 edition when browsing a table's content or not. Valid values
760 - FALSE to allow edition of all fields;
761 - blob to allow edition of all fields except BLOBS;
762 - all to disallow edition of all BINARY or BLOB fields.
764 $cfg['ShowFunctionFields'] boolean
765 Defines whether MySQL functions fields should be displayed or
766 not in edit/insert mode.
768 $cfg['CharEditing'] string
769 Defines which type of editing controls should be used for CHAR
770 and VARCHAR fields. Possible values are:
772 + input - this allows to limit size of text to size of field in
773 MySQL, but has problems with newlines in fields
774 + textarea - no problems with newlines in fields, but also no
777 Default is old behavior so input.
779 $cfg['ZipDump'] boolean
780 $cfg['GZipDump'] boolean
781 $cfg['BZipDump'] boolean
782 Defines whether to allow the use of zip/GZip/BZip2 compression
783 when creating a dump file or not.
785 $cfg['LightTabs'] string
786 If set to True, do use less graphically intense tabs on the top
789 $cfg['DefaultTabServer'] string
790 Defines the tab displayed by default on server view. Possible
791 values: "main.php3" (recommended for multi-user setups),
792 "server_databases.php3", "server_status.php3",
793 "server_variables.php3", "server_privileges.php3" or
794 "server_processlist.php3".
796 $cfg['DefaultTabDatabase'] string
797 Defines the tab displayed by default on database view. Possible
798 values: "db_details_structure.php3", "db_details.php3" or
801 $cfg['DefaultTabTable'] string
802 Defines the tab displayed by default on table view. Possible
803 values: "tbl_properties_structure.php3", "tbl_properties.php3",
804 "tbl_select.php3" or "tbl_change.php3".
806 $cfg['MySQLManualBase'] string
807 If set to an URL which points to the MySQL documentation (type
808 depends on $cfg['MySQLManualType']), appropriate help links are
810 See MySQL Documentation page for more information about MySQL
811 manuals and their types.
813 $cfg['MySQLManualType'] string
814 Type of MySQL documentation:
816 + old - old style used in phpMyAdmin 2.3.0 and sooner
817 + searchable - "Searchable, with user comments"
818 + chapters - "HTML, one page per chapter"
819 + big - "HTML, all on one page"
820 + none - do not show documentation links
822 $cfg['DefaultLang'] string
823 Defines the default language to use, if not browser-defined or
825 See the select_lang.inc.php3 script to know the valid values
829 Force: always use this language (must be defined in the
830 select_lang.inc.php3 script).
832 $cfg['DefaultCharset'] string
833 Default character set to use for recoding of MySQL queries.
834 This must be enabled and it's described by
835 $cfg['AllowAnywhereRecoding'] option.
836 You can give here any character set which is in
837 $cfg['AvailableCharsets'] array and this is just default
838 choice, user can select any of them.
840 $cfg['AllowAnywhereRecoding'] boolean
841 Allow character set recoding of MySQL queries. You need recode
842 or iconv support (compiled in or module) in PHP to allow MySQL
843 queries recoding and used language file must have it enabled
844 (by default only these which are in Unicode, just to avoid
845 losing some characters).
847 $cfg['RecodingEngine'] string
848 You can select here which functions will be used for character
849 set conversion. Possible values are:
851 + auto - automatically use available one (first is tested
853 + iconv - use iconv or libiconv functions
854 + recode - use recode_string function
858 $cfg['AvailableCharsets'] array
859 Available character sets for MySQL conversion. You can add your
860 own (any of supported by recode/iconv) or remove these which
861 you don't use. Character sets will be shown in same order as
862 here listed, so if you frequently use some of these move them
865 $cfg['LeftWidth'] integer
866 Left frame width in pixel.
868 $cfg['LeftBgColor'] string [HTML color]
869 $cfg['RightBgColor'] string [HTML color]
870 The background colors (HTML) used for both the frames.
872 $cfg['RightBgImage'] string
873 The URI of the background image used for the right frame. It
874 can be absolute as well as relative from your phpMyAdmin
877 $cfg['LeftPointerColor'] string [HTML color]
878 The color (HTML) used for the pointer in the left frame (does
879 not work with Netscape 4).
881 $cfg['Border'] integer
882 The size of a table's border.
884 $cfg['ThBgcolor'] string [HTML color]
885 The color (HTML) used for table headers.
887 $cfg['BgcolorOne'] string [HTML color]
888 The color (HTML) #1 for table rows.
890 $cfg['BgcolorTwo'] string [HTML color]
891 The color (HTML) #2 for table rows.
893 $cfg['BrowsePointerColor'] string [HTML color]
894 $cfg['BrowseMarkerColor'] string [HTML color]
895 The colors (HTML) uses for the pointer and the marker in browse
896 mode (does not work with Netscape 4).
897 The former feature highlights the row over which your mouse is
898 passing and the latter lets you visually mark/unmark rows by
900 You can disable both of these features by emptying the
901 respective directive.
903 $cfg['TextareaCols'] integer
904 $cfg['TextareaRows'] integer
905 $cfg['CharTextareaCols'] integer
906 $cfg['CharTextareaRows'] integer
907 Number of columns and rows for the textareas.
908 This value will be emphasized (*2) for SQL query textareas and
909 (*1.25) for SQL textareas inside the query window.
910 The Char* values are used for CHAR and VARCHAR editing (if
911 configured via $cfg['CharEditing']).
913 $cfg['TextareaAutoSelect'] boolean
914 Defines if the whole textarea of the query box will be selected
917 $cfg['LimitChars'] integer
918 Maximal number of Chars showed in a TEXT OR a BLOB field on
919 browse view. Can be turned off by a toggle button on the browse
922 $cfg['ModifyDeleteAtLeft'] boolean
923 $cfg['ModifyDeleteAtRight'] boolean
924 Defines the place where modify and delete links would be put
925 when tables contents are displayed (you may have them displayed
926 both at the left and at the right). "Left" and "right" are
927 parsed as "top" and "bottom" with vertical display mode.
929 $cfg['DefaultDisplay'] string
930 $cfg['HeaderFlipType'] string
931 There are 3 display modes: horizontal, horizontalflipped and
932 vertical. Define which one is displayed by default. The first
933 mode displays each row on a horizontal line, the second rotates
934 the headers by 90 degrees, so you can use descriptive headers
935 even though fields only contain small values and still print
936 them out. The vertical mode sorts each row on a vertical
938 The HeaderFlipType can be set to 'css' or 'faked'. When using
939 'css' the rotation of the header for horizontalflipped is done
940 via CSS. If set to 'faked' PGP does the transformation for you,
941 but of course this does not look as good as CSS.
943 $cfg['DefaultPropDisplay'] string
944 When editing/creating new columns in a table all fields
945 normally get lined up one field a line. (default:
946 'horizontal'). If you set this to 'vertical' you can have each
947 field lined up vertically beneath each other. You can save up a
948 lot of place on the horizontal direction and no longer have to
951 $cfg['ShowBrowseComments'] boolean
952 $cfg['ShowPropertyComments'] boolean
953 By setting the corresponding variable to TRUE you can enable
954 the display of column comments in Browse or Property display.
955 In browse mode, the comments are show inside the header. In
956 property mode, comments are displayed using a CSS-formatted
957 dashed-line below the name of the field. The comment is shown
958 as a tool-tip for that field.
960 $cfg['UploadDir'] string
961 The name of the directory, ending with a slash, where SQL files
962 have been uploaded by other means than phpMyAdmin (for example,
963 ftp). Those files are available under a drop-down box when you
964 click the database name, then the SQL tab.
965 Please note that the file names must have the suffix ".sql".
966 This feature is useful when your file is too big to be uploaded
967 via HTTP, or when file uploads are disabled in PHP.
968 Please note that if PHP is running in safe mode, this directory
969 must be owned by the same user as the owner of the phpMyAdmin
972 $cfg['RepeatCells'] integer
973 Repeat the headers every X cells, or 0 to deactivate.
975 $cfg['QueryFrame'] boolean
976 $cfg['QueryFrameJS'] boolean
977 $cfg['QueryFrameDebug'] boolean
978 $cfg['QueryWindowWidth'] integer
979 $cfg['QueryWindowHeight'] integer
980 $cfg['QueryHistoryDB'] boolean
981 $cfg['QueryWindowDefTab'] string
982 $cfg['QueryHistoryMax'] integer
983 All those variables affect the new query frame/window. When
984 $cfg['QueryFrame'] is set to true a new frame is embedded on
985 the left with a small area. Clicking on that results in opening
986 a direct interface to enter SQL queries.
987 When $cfg['QueryFrameJS'] is set to true, clicking on that link
988 opens a new custom sized browser window
989 ($cfg['QueryWindowWidth'], $cfg['QueryWindowWidth'] - both
990 integers for the size in pixels). If set to false, clicking on
991 the link only opens the SQL input in the mainframe.
992 The usage of the JavaScript query window is recommended if you
993 have a JavaScript enabled browser. Basic functions are used to
994 exchange quite a few variables, so most 4th generation browsers
995 should be capable to use that feature. It currently is only
996 tested with Internet Explorer 6 and Mozilla 1.x.
997 If $cfg['QueryHistoryDB'] is set to TRUE, all your Queries are
998 logged to a table, which has to be created by you (see
999 $cfg['Servers'][$i]['history']). If set to FALSE, all your
1000 queries will be appended to the form, but only as long as your
1001 window is opened they remain saved.
1002 When using the JavaScript based query window, it will always
1003 get updated when you click on a new table/db to browse and will
1004 focus if you click on "Edit SQL" after using a query.
1005 If $cfg['QueryHistoryDB'] is set to TRUE you can specify the
1006 amount of saved history items using $cfg['QueryHistoryMax'].
1007 The query window also has a custom tabbed look to group the
1008 features. Using the variable $cfg['QueryWindowDefTab'] you can
1009 specify the default tab to be used when opening the query
1010 window. It can be set to either 'sql', 'files', 'history' or
1012 The variable $cfg['QueryFrameDebug'] can be used by developers
1013 for easier future feature integration.
1015 $cfg['BrowseMIME'] boolean
1016 Enable MIME-transformations.
1018 $cfg['SQP']['enable'] boolean
1019 As of phpMyAdmin 2.3.0, we now have a fully functional SQL
1020 Parser system. It is enabled by default, as it is used to
1021 format the SQL queries.
1022 As of 2.3.1, it will become an integral part of phpMyAdmin, as
1023 it will analyze certain queries to improve the behavior of
1024 phpMyAdmin. But as it is very new, and not yet heavily used, we
1025 offer you an option to turn it off.
1027 $cfg['SQP']['fmtType'] string [html|none]
1028 The main use of the new SQL Parser is to pretty-print SQL
1029 queries. By default we use HTML to format the query, but you
1030 can disable this by setting this variable to 'none'
1032 $cfg['SQP']['fmtInd'] float
1033 $cfg['SQP']['fmtIndUnit'] string [em|px|pt|ex]
1034 For the pretty-printing of SQL queries, under some cases the
1035 part of a query inside a bracket is indented. By changing
1036 $cfg['SQP']['fmtInd'] you can change the amount of this indent.
1037 Related in purpose is $cfg['SQP']['fmtIndUnit'] which specifies
1038 the units of the indent amount that you specified. This is used
1041 $cfg['SQP']['fmtColor'] array of string tuples
1042 This array is used to define the colours for each type of
1043 element of the pretty-printed SQL queries. The tuple format is
1044 class => [HTML colour code | empty string]
1045 If you specify an empty string for the color of a class, it is
1046 ignored in creating the stylesheet. You should not alter the
1047 class names, only the colour strings.
1050 + comment Applies to all comment sub-classes
1051 + comment_mysql Comments as "#...\n"
1052 + comment_ansi Comments as "-- ...\n"
1053 + comment_c Comments as "/*...*/"
1054 + digit Applies to all digit sub-classes
1055 + digit_hex Hexadecimal numbers
1056 + digit_integer Integer numbers
1057 + digit_float Floating point numbers
1058 + punct Applies to all punctuation sub-classes
1059 + punct_bracket_open_round Opening brackets"("
1060 + punct_bracket_close_round Closing brackets ")"
1061 + punct_listsep List item seperator ","
1062 + punct_qualifier Table/Column Qualifier "."
1063 + punct_queryend End of query marker ";"
1064 + alpha Applies to all alphabetic classes
1065 + alpha_columnType Identifiers matching a column type
1066 + alpha_columnAttrib Identifiers matching a
1067 database/table/column attribute
1068 + alpha_functionName Identifiers matching a MySQL function name
1069 + alpha_reservedWord Identifiers matching any other reserved
1071 + alpha_variable Identifiers matching a SQL variable "@foo"
1072 + alpha_identifier All other identifiers
1073 + quote Applies to all quotation mark classes
1074 + quote_double Double quotes "
1075 + quote_single Single quotes '
1076 + quote_backtick Backtick quotes `
1078 $cfg['SQLValidator']['use'] boolean
1079 phpMyAdmin now supports use of the Mimer SQL Validator service,
1080 as originally published on Slashdot.
1081 For help in setting up your system to use the service, see the
1084 $cfg['SQLValidator']['username'] string
1085 $cfg['SQLValidator']['password'] string
1086 The SOAP service allows you to login with anonymous and any
1087 password, so we use those by default.. Instead, if you have an
1088 account with them, you can put your login details here, and it
1089 will be used in place of the anonymous login.
1091 $cfg['DBG']['enable'] boolean
1093 Enable the DBG extension for debugging phpMyAdmin. Required for
1095 For help in setting up your system to this, see the Developers
1098 $cfg['DBG']['profile']['enable'] boolean
1100 Enable profiling support for phpMyAdmin. This will append a
1101 chunk of data to the end of every page displayed in the main
1102 window with profiling statistics for that page.
1103 You may need need to increase the maximum execution time for
1104 this to complete successfully.
1106 $cfg['DBG']['profile']['threshold'] float (units in milliseconds)
1108 When profiling data is displayed, this variable controls the
1109 threshold of display for any profiling data, based on the
1110 average time each time has taken. If it is over the threshold
1111 it is displayed, otherwise it is not displayed. This takes a
1112 value in milliseconds. In most cases you don't need to edit
1115 $cfg['ColumnTypes'] array
1116 All possible types of a MySQL column. In most cases you don't
1119 $cfg['AttributeTypes'] array
1120 Possible attributes for fields. In most cases you don't need to
1123 $cfg['Functions'] array
1124 A list of functions MySQL supports. In most cases you don't
1129 Introduction - Usage - File structure -
1133 To enable transformations, you have to setup the column_info table and
1134 the proper directives. Please see the Configuration section on how to
1137 You can apply different transformations to the contents of each field.
1138 The transformation will take the content of each field and transform
1139 it with certain rules defined in the selected transformation.
1141 Say you have a field 'filename' which contains a filename. Normally
1142 you would see in phpMyAdmin only this filename. Using transformations
1143 you can transform that filename into a HTML link, so you can click
1144 inside of the phpMyAdmin structure on the field's link and will see
1145 the file displayed in a new browser window. Using transformation
1146 options you can also specify strings to append/prepend to a string or
1147 the format you want the output stored in.
1149 For a general overview of all available transformations and their
1150 options, you can consult your
1151 <www.your-host.com>/<your-install-dir>/libraries/transformations/overv
1152 iew.php3 installation.
1156 Go to your tbl_properties.inc.php3 page (i.e. reached through clicking
1157 on the 'properties' link for a table). There you will see three new
1158 fields at the end of the line. They are called 'MIME-type', 'Browser
1159 transformation' and 'Transformation options'.
1160 * The field 'MIME-type' is a dropdown field. You have the options to
1161 leave that field empty or to use 'auto' [this feature is not yet
1162 available]. Please note that transformations are inactive as long
1163 as no mime-type is selected.
1164 * The field 'Browser transformation' is a drop-down field. You can
1165 choose from a hopefully growing amount of pre-defined
1166 transformations. See below for information on how to build your
1168 There are global transformations and mimetype-bound
1169 transformations. Global transformations can be used for any
1170 mimetype. They will take the mimetype, if necessary, into regard.
1171 Mimetype-bound transformations usually only operate on a certain
1172 mimetype. There are transformations which operate on the main
1173 mimetype (like 'image'), which will most likely take the subtype
1174 into regard, and those who only operate on a specific subtype
1175 (like 'image/jpeg').
1176 You can use transformations on mimetypes for which the function
1177 was not defined for. There is no security check for you selected
1178 the right transformation, so take care of what the output will be
1180 * The field 'Transformation options' is a free-type textfield. You
1181 have to enter transform-function specific options here. Usually
1182 the transforms can operate with default options, but it is
1183 generally a good idea to look up the overview to see which options
1185 Much like the ENUM/SET-Fields, you have to split up several
1186 options using the format 'a','b','c',...(NOTE THE MISSING BLANKS).
1187 This is because internally the options will be parsed as an array,
1188 leaving the first value the first element in the array, and so
1190 If you want to specify a MIME character set you can define it in
1191 the transformation_options. You have to put that outside of the
1192 pre-defined options of the specific mime-transform, as the last
1193 value of the set. Use the format "'; charset=XXX'". If you use a
1194 transform, for which you can specify 2 options and you want to
1195 append a character set, enter "'first parameter','second
1196 parameter','charset=us-ascii'". You can, however use the defaults
1197 for the parameters: "'','','charset=us-ascii'".
1201 All mimetypes and their transformations are defined through single
1202 files in the directory 'libraries/transformations/'.
1204 They are stored in files to ease up customization and easy adding of
1205 new transformations.
1207 Because the user cannot enter own mimetypes, it is kept sure that
1208 transformations always work. It makes no sense to apply a
1209 transformation to a mimetype, the transform-function doesn't know to
1212 One can, however, use empty mime-types and global transformations
1213 which should work for many mimetypes. You can also use transforms on a
1214 different mimetype they where built for, but pay attention to option
1215 usage as well as what the transformation does to your field.
1217 There is a basic file called 'global.inc.php3'. This function can be
1218 included by any other transform function and provides some basic
1221 There are 5 possible file names:
1222 1. A mimetype+subtype transform:
1223 [mimetype]_[subtype]__[transform].inc.php3
1224 Please not that mimetype and subtype are separated via '_', which
1225 shall not be contained in their names. The transform
1226 function/filename may contain only characters which cause no
1227 problems in the file system as well as the PHP function naming
1229 The transform function will the be called
1230 'PMA_transform_[mimetype]_[subtype]__[transform]()'.
1232 text_html__formatted.inc.php3
1233 PMA_transform_text_html__formatted()
1234 2. A mimetype (w/o subtype) transform:
1235 [mimetype]__[transform].inc.php3
1236 Please note that there are no single '_' characters. The transform
1237 function/filename may contain only characters which cause no
1238 problems in the file system as well as the PHP function naming
1240 The transform function will the be called
1241 'PMA_transform_[mimetype]__[transform]()'.
1243 text__formatted.inc.php3
1244 PMA_transform_text__formatted()
1245 3. A mimetype+subtype without specific transform function
1246 [mimetype]_[subtype].inc.php3
1247 Please note that there are no '__' characters in the filename. Do
1248 not use special characters in the filename causing problems with
1250 No transformation function is defined in the file itself.
1254 4. A mimetype (w/o subtype) without specific transform function
1256 Please note that there are no '_' characters in the filename. Do
1257 not use special characters in the filename causing problems with
1259 No transformation function is defined in the file itself.
1263 5. A global transform function with no specific mimetype
1264 global__[transform].inc.php3
1265 The transform function will the be called
1266 'PMA_transform_global__[transform]()'.
1269 PMA_transform_global__formatted()
1271 So generally use '_' to split up mimetype and subtype, and '__' to
1272 provide a transform function.
1274 All filenames containing no '__' in themselves are not shown as valid
1275 transform functions in the dropdown.
1277 Please see the libraries/transformations/TEMPLATE file for adding your
1278 own transform function. See the
1279 libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
1280 without a transform function. Also note the introduction of a function
1281 description in the language files. For each function a
1282 $strTransformation_[filename without .inc.php3] has to exist.
1284 You can use the template generator to generate new functions and
1285 entries in the language file.
1287 To create a new transform function please see
1288 libraries/transformations/template_generator.sh. To create a new,
1289 empty mimetype please see
1290 libraries/transformations/template_generator_mimetype.sh.
1292 FAQ - Frequently Asked Questions
1294 Server - Configuration - Limitations - Multi-user - Browsers
1295 - Usage tips - Project -
1299 [1.1] I'm running PHP 4+ and my server is crashing each time a specific
1300 action is required or phpMyAdmin sends a blank page or a page full of
1301 cryptic characters to my browser, what can I do?
1303 There are some known PHP bugs with output buffering and compression.
1304 Try to set the $cfg['OBGzip'] directive to FALSE in your
1305 config.inc.php or .php3 file and the zlib.output_compression directive
1306 to Off in your php configuration file.
1307 Furthermore, we know about such problems connected to the release
1308 candidates of PHP 4.2.0 (tested with PHP 4.2.0 RC1 to RC4) together
1309 with MS Internet Explorer. Please upgrade to the release version PHP
1312 [1.2] My Apache server crashes when using phpMyAdmin.
1314 You should first try the latest versions of Apache (and possibly
1316 See also the other FAQ entry about PHP bugs with output buffering.
1317 If your server keeps crashing, please ask for help in the various
1318 Apache support groups.
1320 [1.3] I'm running phpMyAdmin with "cookie" authentication mode under PHP
1321 4.2.0 or 4.2.1 loaded as an Apache 2+ module but can't enter the script:
1322 I'm always displayed the login screen.
1324 This is a known PHP bug (see this bug report) from the official PHP
1325 bug database. It means there is and won't be any phpMyAdmin fix
1326 against it because there is no way to code a fix.
1328 [1.4] Using phpMyAdmin on IIS, I'm displayed the error message: "The
1329 specified CGI application misbehaved by not returning a complete set of
1332 You just forgot to read the install.txt file from the php
1333 distribution. Have a look at the last message in this bug report from
1334 the official PHP bug database.
1336 [1.5] Using phpMyAdmin on IIS, I'm facing crashes and/or many error
1337 messages with the HTTP or advanced authentication mode.
1339 This is a known problem with the PHP ISAPI filter: it's not so stable.
1340 For some more information and complete testings see the messages
1341 posted by André B. aka "djdeluxe76" in this thread from the phpWizard
1343 Please use instead the cookie authentication mode.
1345 [1.6] I can't use phpMyAdmin on PWS: nothing is displayed!
1347 This seems to be a PWS bug. Filippo Simoncini found a workaround (at
1348 this time there is no better fix): remove or comment the DOCTYPE
1349 declarations (2 lines) from the scripts header.inc.php3,
1350 header_printview.inc.php3, index.php3, left.php3 and
1351 libraries/common.lib.php3.
1353 [1.7] How can I GZip or Bzip a dump or a CSV export. It does not seem to
1356 These features are based on the gzencode() and bzcompress() PHP
1357 functions to be more independent of the platform (Unix/Windows, Safe
1358 Mode or not, and so on). So, you must have PHP4 >= 4.0.4 and
1359 Zlib/Bzip2 support (--with-zlib and --with-bz2).
1360 We faced PHP crashes when trying to download a dump with MS Internet
1361 Explorer when phpMyAdmin is run with a release candidate of PHP 4.2.0.
1362 In this case you should switch to the release version of PHP 4.2.0.
1364 [1.8] I cannot insert a text file in a table, and I get an error about safe
1365 mode being in effect.
1367 Your uploaded file is saved by PHP in the "upload dir", as defined in
1368 php.ini by the variable upload_tmp_dir (usually the system default is
1370 We recommend the following setup for Apache servers running in safe
1371 mode, to enable uploads of files while being reasonably secure:
1372 * create a separate directory for uploads: mkdir /tmp/php
1373 * give ownership to the Apache server's user.group: chown
1374 apache.apache /tmp/php
1375 * give proper permission: chmod 600 /tmp/php
1376 * put upload_tmp_dir = /tmp/php in php.ini
1379 [1.9] I'm having troubles when uploading files. In general file uploads
1380 don't work on my system and uploaded files have a Content-Type: header in
1383 It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat
1384 7.0 and you updated your PHP RPM to php-4.0.4pl1-3.i386.rpm, didn't
1386 So the problem is that this package has a serious bug that was
1387 corrected ages ago in PHP (2001-01-28: see PHP's bug tracking system
1388 for more details). The problem is that the bugged package is still
1389 available though it was corrected (see RedHat's BugZilla for more
1391 So please download the fixed package (4.0.4pl1-9) and the problem
1393 And that fixes the \r\n problem with file uploads!
1395 [1.10] I'm having troubles when uploading files with phpMyAdmin running on
1396 a secure server. My browser is Internet Explorer and I'm using the Apache
1399 As suggested by "Rob M" in the phpWizard forum, add this line to your
1401 SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown
1402 It seems to clear up many problems between Internet Explorer and SSL.
1404 [1.11] I get an 'open_basedir restriction' while uploading a file from the
1407 Since version 2.2.4, phpMyAdmin supports servers with open_basedir
1408 restrictions. Assuming that the restriction allows you to open files
1409 in the current directory ('.'), all you have to do is create a 'tmp'
1410 directory under the phpMyAdmin install directory, with permissions 777
1411 and the same owner as the owner of your phpMyAdmin directory. The
1412 uploaded files will be moved there, and after execution of your SQL
1415 [1.12] I have lost my MySQL root password, what can I do?
1417 The MySQL manual explains how to reset the permissions.
1419 [1.13] I get an error 'No SQL query' when trying to execute a bookmark.
1421 If PHP does not have read/write access to its upload_tmp_dir, it
1422 cannot access the uploaded query.
1424 [1.14] I get an error 'No SQL query' when trying to submit a query from the
1425 convenient text area.
1427 Check the post_max_size directive from your PHP configuration file and
1430 [1.15] I have problems with mysql.user field names.
1432 In older MySQL versions, the User and Password fields were named user
1433 and password. Please modify your field names to align with current
1436 [1.16] I cannot upload big dump files.
1438 The first things to check (or ask your host provider to check) are the
1439 values of upload_max_filesize, memory_limit and post_max_size in the
1440 php.ini configuration file.
1441 All of these three settings limit the maximum size of data that can be
1442 submitted and handled by PHP. One user also said that post_max_size
1443 and memory_limit need to be larger than upload_max_filesize.
1445 [1.17] Does phpMyAdmin support MySQL 4.1?
1447 Because of a major change in the definition syntax of string field
1448 types, this version of phpMyAdmin probably won't work correctly with
1449 MySQL >= 4.1.0! We will work on the support as soon as MySQL 4.1.0 is
1452 [1.18] I'm running MySQL <= 4.0.1 having lower_case_table_names set to 1.
1453 If I create a new table with a capital letter in its name it is changed to
1454 lowercase as it should. But if I try to DROP this table MySQL is unable to
1455 find the corresponding file.
1457 This is a bug of MySQL <= 4.0.1. Please upgrade to at least
1458 MySQL 4.0.2 or turn off your lower_case_table_names directive.
1460 [1.19] I can't run the "display relations" feature because the script seems
1461 not to know the font face I'm using!
1463 The "FPDF" library we're using for this feature requires some special
1464 files to use font faces.
1465 Please refers to the FPDF manual to build these files.
1467 [1.20] I receive the error "cannot load MySQL extension, please check PHP
1470 To connect to a MySQL server, PHP needs a set of MySQL functions
1471 called "MySQL extension". This extension may be part of the PHP server
1472 (compiled-in), otherwise it needs to be loaded dynamically. Its name
1473 is probably mysql.so or mysql.dll. phpMyAdmin tried to load the
1474 extension but failed.
1475 Usually, the problem is solved by installing a software package called
1476 "PHP-MySQL" or something similar.
1478 [1.21] I am running the CGI version of PHP under Unix, and I cannot login
1481 In php.ini, set mysql.max_links higher than 1.
1483 [1.22] I don't see the "Location of text file" field, so I cannot upload.
1485 This is most likely because in php.ini, your file_uploads parameter is
1488 [1.23] I'm running MySQL on a Win32 machine. Each time I create a new table
1489 the table and field names are changed to lowercase!
1491 This happens because the MySQL directive lower_case_table_names
1492 defaults to 1 (ON) in the Win32 version of MySQL. You can change this
1493 behavior by simply changing the directive to 0 (OFF):
1494 Just edit you my.ini file that should be located in your Windows
1495 directory and add the following line:
1496 set-variable = lower-case-table-names=0
1497 Next, save the file and restart the MySQL service. You can always
1498 check the value of this directive using the query
1499 SHOW VARIABLES LIKE 'lower_case_table_names';
1501 [1.24] Some characters are being truncated in my queries, or I get
1502 characters randomly added. I am running PHP 4.2.3.
1504 This is a PHP 4.2.3 bug.
1506 [1.25] I am running Apache with mod_gzip-1.3.26.1a on Windows XP, and I get
1507 problems, such as undefined variables when I run a SQL query.
1509 A tip from Jose Fandos: put a comment on the following two lines in
1510 httpd.conf, like this:
1511 # mod_gzip_item_include file \.php$
1512 # mod_gzip_item_include mime "application/x-httpd-php.*"
1513 as this version of mod_gzip on Apache (Windows) has problems handling
1514 PHP scripts. Of course you have to restart Apache.
1516 [1.26] I just installed phpMyAdmin in my document root of IIS but I get the
1517 error "No input file specified" when trying to run phpMyAdmin.
1519 This is a permission problem. Right-click on the phpmyadmin folder and
1520 choose properties. Under the tab Security, click on "Add" and select
1521 the user "IUSER_machine" from the list. Now set his permissions and it
1524 [1.27] I get empty page when I want to view huge page (eg.
1525 db_details_structure.php3 with plenty of dabases).
1527 This is a PHP bug that occur when GZIP output buffering enabled. If
1528 you turn off it (by $cfg['OBGzip'] = FALSE in config.inc.php3), it
1529 should work. This bug will be fixed in PHP 5.0.0.
1531 [1.28] My MySQL server sometimes refuses queries and returns the message
1532 'Errorcode: 13'. What does this mean?
1534 This can happen due to a MySQL bug when having database / table names
1535 with upper case characters although lower_case_table_names is set to
1536 1. To fix this, turn off this directive, convert all database and
1537 table names to lower case and turn it on again. Alternatively, there's
1538 a bug-fix available starting with MySQL 3.23.56 / 4.0.11-gamma.
1540 [1.29] When I create a table or modify a field, I get an error and the
1541 fields are duplicated.
1543 It is possible to configure Apache in such a way that PHP has problems
1544 interpreting .php files.
1545 The problems occur when two different (and conflicting) set of
1546 directives are used:
1550 AddType application/x-httpd-php .php
1551 In the case we saw, one set of directives was in httpd.conf, while the
1552 other set was in php.conf.
1553 The recommended way is with AddType, so just comment out the first set
1554 of lines and restart Apache:
1555 #SetOutputFilter PHP
1560 [2.1] The error message "Warning: Cannot add header information - headers
1561 already sent by ..." is displayed, what's the problem?
1563 Edit your config.inc.php or .php3 file and ensure there is nothing
1564 (I.E. no blank lines, no spaces, no characters...) neither before the
1565 <?php tag at the beginning, neither after the ?> tag at the end.
1567 [2.2] phpMyAdmin can't connect to MySQL. What's wrong?
1569 Either there is an error with your PHP setup or your username/password
1570 is wrong. Try to make a small script which uses mysql_connect and see
1571 if it works. If it doesn't, it may be you haven't even compiled MySQL
1574 [2.3] The error message "Warning: MySQL Connection Failed: Can't connect to
1575 local MySQL server through socket '/tmp/mysql.sock' (111)..." is displayed.
1578 For RedHat users, Harald Legner suggests this on the mailing list:
1579 On my RedHat-Box the socket of MySQL is /var/lib/mysql/mysql.sock. In
1580 your php.ini you will find a line
1581 mysql.default_socket = /tmp/mysql.sock
1583 mysql.default_socket = /var/lib/mysql/mysql.sock
1584 Then restart apache and it will work.
1585 Here is a fix suggested by Brad Ummer in the phpwizard forum:
1586 * First, you need to determine what socket is being used by MySQL.
1587 To do this, telnet to your server and go to the MySQL bin
1588 directory. In this directory there should be a file named
1589 mysqladmin. Type ./mysqladmin variables, and this should give you
1590 a bunch of info about your MySQL server, including the socket
1591 (/tmp/mysql.sock, for example).
1592 * Then, you need to tell PHP to use this socket.
1593 Assuming you are using PHP 3.0.10 or better, you can specify the
1594 socket to use when you open the connection. To do this in
1595 phpMyAdmin, you need to complete the socket information in the
1597 For example: $cfg['Servers'][$i]['socket'] = '/tmp/mysql.sock';
1599 Have also a look at the corresponding section of the MySQL
1602 [2.4] Nothing is displayed by my browser when I try to run phpMyAdmin, what
1605 Try to set the $cfg['OBGZip'] directive to FALSE in the phpMyAdmin
1606 configuration file. It helps sometime.
1607 Also have a look at your PHP version number: if it contains "4.0b..."
1608 it means you're running a beta version of PHP. That's not a so good
1609 idea, please upgrade to a plain revision.
1611 [2.5] Each time I want to insert or change a record or drop a database or a
1612 table, an error 404 (page not found) is displayed or, with HTTP or cookie
1613 authentication, I'm asked to login again. What's wrong?
1615 Check the value you set for the $cfg['PmaAbsoluteUri'] directive in
1616 the phpMyAdmin configuration file.
1618 [2.6] I get an "Access denied for user: 'root@localhost' (Using password:
1619 YES)"-error when trying to access a MySQL-Server on a host which is
1620 port-forwarded for my localhost
1622 When you are using a port on your localhost, which you redirect via
1623 port-forwarding to another host, MySQL is not resolving the localhost
1625 Erik Wasser explains: The solution is: if your host is "localhost"
1626 MySQL (the commandline tool 'mysql' as well) always tries to use the
1627 socket connection for speeding up things. And that doesn't work in
1628 this configuration with port forwarding.
1629 If you enter "127.0.0.1" as hostname, everything is right and MySQL
1630 uses the TCP connection.
1632 [3. Known limitations]
1634 [3.1] When using HTTP authentication, an user who logged out can not
1635 relogin in with the same nick.
1637 This is related to the authentication mechanism (protocol) used by
1638 phpMyAdmin. We plan to change it as soon as we may find enough free
1639 time to do it, but you can bypass this problem: just close all the
1640 opened browser windows and then go back to phpMyAdmin. You should be
1641 able to log in again.
1643 [3.2] When dumping a large table in compressed mode, I get a memory limit
1644 error or a time limit error.
1646 As of version 2.2.4, we build the compressed dump in memory, so large
1647 tables dumps may hang. The only alternative we can think about (using
1648 system calls to mysqldump then gzip or bzip2) would not be applicable
1649 in environments where PHP is in safe mode: access to system programs
1650 is is limited by the system administrator, and time limit is enforced.
1652 [3.3] With InnoDB tables, I lose foreign key relationships when I rename or
1655 This seems to be a InnoDB bug (fixed in MySQL 3.23.50?). However, keep
1656 in mind that phpMyAdmin as of version 2.3.0 does not support InnoDB.
1658 [3.4] I am unable to import dumps I created with the mysqldump tool bundled
1659 with the MySQL server distribution.
1661 The problem is that mysqldump creates invalid comments like this:
1664 -- Host: localhost Database: database
1665 ---------------------------------------------------------
1666 -- Server version 3.23.54
1668 The invalid part of the code is the horizontal line made of dashes
1669 that appears once in every dump created with mysqldump. If you want to
1670 run your dump you have to turn it into valid MySQL. This means, you
1671 have to add a whitespace after the first to dashes of the line or add
1673 -- -------------------------------------------------------
1675 #---------------------------------------------------------
1677 [4. ISPs, multi-user installations ]
1679 [4.1] I'm an ISP. Can I setup one central copy of phpMyAdmin or do I need
1680 to install it for each customer.
1682 Since version 2.0.3, you can setup a central copy of phpMyAdmin for
1683 all your users. The development of this feature was kindly sponsored
1684 by NetCologne GmbH. This requires a properly setup MySQL user
1685 management and phpMyAdmin HTTP or cookie authentication. See the
1686 install section on "Using HTTP authentication".
1688 [4.2] What's the preferred way of making phpMyAdmin secure against evil
1691 This depends on your system.
1692 If you're running a server which cannot be accessed by other people,
1693 it's sufficient to use the directory protection bundled with your
1694 webserver (with Apache you can use .htaccess files, for example).
1695 If other people have telnet access to your server, you should use
1696 phpMyAdmin's HTTP authentication feature.
1698 * Your config.inc.php3 file should be chmod 660.
1699 * All your phpMyAdmin files should be chown phpmy.apache, where
1700 phpmy is a user whose password is only known to you, and apache is
1701 the group under which Apache runs.
1702 * You should use PHP safe mode, to protect from other users that try
1703 to include your config.inc.php3 in their scripts.
1705 [4.3] I get errors about not being able to include a file in /lang or in
1708 Check php.ini, or ask your sysadmin to check it. The include_path must
1709 contain "." somewhere in it, and open_basedir, if used, must contain
1710 "." and "./lang" to allow normal operation of phpMyAdmin.
1712 [4.4] phpMyAdmin always gives "Access denied" when using HTTP
1715 This could happen for several reasons:
1716 * $cfg['Servers'][$i]['controluser'] and/or
1717 $cfg['Servers'][$i]['controlpass'] are wrong.
1718 * The username/password you specify in the login-dialog are invalid.
1719 * You have already setup a security mechanism for the
1720 phpMyAdmin-directory, eg. a .htaccess file. This would interfere
1721 with phpMyAdmin's authentication, so remove it.
1723 [4.5] Is it possible to let users create their own databases?
1725 Starting with 2.2.5, in the user management page, you can enter a
1726 wildcard database name for a user, and put the privileges you want.
1727 For example, adding SELECT, INSERT, UPDATE, DELETE, CREATE, DROP,
1728 INDEX, ALTER would let a user create/manage his/her database(s).
1730 [4.6] How can I use the Host-based authentication additions?
1732 If you have existing rules from an old .htaccess file, you can take
1733 them and add a username between the 'deny'/'allow' and 'from' strings.
1734 Using the username wildcard of '%' would be a major benefit here if
1735 your installation is suited to using it. Then you can just add those
1736 updated lines into the $cfg['Servers'][$i]['AllowDeny']['rules']
1738 If you want a pre-made sample, you can try this fragment. It stops the
1739 'root' user from logging in from any networks other than the private
1741 //block root from logging in except from the private networks
1742 $cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';
1743 $cfg['Servers'][$i]['AllowDeny']['rules'] = array(
1744 'deny root from all',
1745 'allow root from localhost',
1746 'allow root from 10.0.0.0/8',
1747 'allow root from 192.168.0.0/16',
1748 'allow root from 172.16.0.0/12',
1751 [5. Browsers or client OS]
1753 [5.1] I get an out of memory error, and my controls are non-functional,
1754 when trying to create a table with more than 14 fields.
1756 We could reproduce this problem only under Win98/98SE. Testing under
1757 WinNT4 or Win2K, we could easily create more than 60 fields.
1758 A workaround is to create a smaller number of fields, then come back
1759 to your table properties and add the other fields.
1761 [5.2] With Xitami 2.5b4, phpMyAdmin won't process form fields.
1763 This is not a phpMyAdmin problem but a Xitami known bug: you'll face
1764 it with each script/website that use forms.
1765 Upgrade or downgrade your Xitami server.
1767 [5.3] I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).
1769 With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except
1770 that the proposed file name for the dump is always 'tbl_dump.php'.
1771 Bzip2 dumps don't seem to work.
1772 With Konqueror 2.2.1: plain dumps work; zip dumps are placed into the
1773 user's temporary directory, so they must be moved before closing
1774 Konqueror, or else they disappear. GZip dumps give an error message.
1775 Testing needs to be done for Konqueror 2.2.2.
1777 [5.4] I can't use the cookie authentication mode because Internet Explorer
1778 never stores the cookies.
1780 MS Internet Explorer seems to be really buggy about cookies, at least
1781 till version 6. And thanks to Andrew Zivolup we've traced also a PHP
1782 4.1.1 bug in this area!
1783 Then, if you're running PHP 4.1.1, try to upgrade or downgrade... it
1786 [5.5] In Internet Explorer 5.0, I get JavaScript errors when browsing my
1789 Upgrade to at least Internet Explorer 5.5 SP2.
1791 [5.6] In Internet Explorer 5.0, 5.5 or 6.0, I get an error when trying to
1792 modify a row in a table with many fields, or with a text field
1794 Your table neither have a primary key nor an unique one, so we must
1795 use a long URL to identify this row. There is a limit on the length of
1796 the URL in those browsers, and this not happen in Netscape, for
1797 example. The workaround is to create a primary or unique key, or use
1800 [5.7] I refresh (reload) my browser, and come back to the welcome page.
1802 Some browsers support right-clicking into the frame you want to
1803 refresh, just do this in the right frame.
1805 [5.8] With Mozilla 0.9.7 I have problems sending a query modified in the
1808 Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
1811 [5.9] With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
1812 whitespace in the SQL-Query edit area: the page scrolls down.
1814 This is a Mozilla bug (see bug #26882 at BugZilla).
1816 [5.10] With Netscape 4.75 I get empty rows between each row of data in a
1819 This is a known Netscape 4.75 bug: it adds some line feeds when
1820 exporting data in octet-stream mode. Since we can't detect the
1821 specific Netscape version, we cannot workaround this bug.
1823 [5.11] Extended-ASCII characters like German umlauts are displayed wrong.
1825 Please ensure that you have set your browser's character set to the
1826 one of the language file you have selected on phpMyAdmin's start page.
1827 Alternatively, you can try the auto detection mode that is supported
1828 by the recent versions of the most browsers.
1830 [5.12] Apple OS X: Safari browser changes special characters to "?".
1832 This issue has been reported by a OS X user, who adds that Chimera,
1833 Netscape and Mozilla do not have this problem.
1835 [5.13] With Internet Explorer 5.5 or 6, and HTTP authentication type, I
1836 cannot manage two servers: I login to the first one, then the other one,
1837 but if I switch back to the first, I have to login on each operation.
1839 This is a bug in Internet Explorer, other browsers do not behave this
1842 [6. Using phpMyAdmin]
1844 [6.1] I can't insert new rows into a table / I can't create a table - MySQL
1845 brings up a SQL-error.
1847 Examine the SQL error with care. Often the problem is caused by
1848 specifying a wrong field-type.
1849 Common errors include:
1850 * Using VARCHAR without a size argument
1851 * Using TEXT or BLOB with a size argument
1853 Also, look at the syntax chapter in the MySQL manual to confirm that
1854 your syntax is correct.
1856 [6.2] When I create a table, I click the Index checkbox for 2 fields and
1857 phpMyAdmin generates only one index with those 2 fields.
1859 In phpMyAdmin 2.2.0 and 2.2.1, this is the way to create a
1860 multi-fields index. If you want two indexes, create the first one when
1861 creating the table, save, then display the table properties and click
1862 the Index link to create the other index.
1864 [6.3] How can I insert a null value into my table?
1866 Since version 2.2.3, you have a checkbox for each field that can be
1867 null. Before 2.2.3, you had to enter "null", without the quotes, as
1870 [6.4] How can I backup my database or table?
1872 Click on a database or table name in the left frame, the properties
1873 will be displayed. Then on the menu, click "Export", you can dump the
1874 structure, the data, or both. This will generate standard SQL
1875 statements that can be used to recreate your database/table.
1876 You will need to choose "Save as file", so that phpMyAdmin can
1877 transmit the resulting dump to your station. Depending on your PHP
1878 configuration, you will see options to compress the dump. See also the
1879 $cfg['ExecTimeLimit'] configuration variable.
1880 For additional help on this subject, look for the word "dump" in this
1883 [6.5] How can I restore (upload) my database or table using a dump? How can
1884 I run a ".sql" file.
1886 Click on a database name in the left frame, the properties will be
1887 local displayed. Then in the "Run SQL query" section, type in your
1888 dump filename, or use the Browse button. Then click Go.
1889 For additional help on this subject, look for the word "upload" in
1892 [6.6] How can I use the relation table in Query-by-example?
1894 Here is an example with the tables persons, towns and countries, all
1895 located in the database mydb. If you don't have a PMA_relation table,
1896 create it as explained in the configuration section. Then create the
1898 CREATE TABLE REL_countries (
1899 country_code char(1) NOT NULL default '',
1900 description varchar(10) NOT NULL default '',
1901 PRIMARY KEY (country_code)
1903 INSERT INTO REL_countries VALUES ('C', 'Canada');
1904 CREATE TABLE REL_persons (
1905 id tinyint(4) NOT NULL auto_increment,
1906 person_name varchar(32) NOT NULL default '',
1907 town_code varchar(5) default '0',
1908 country_code char(1) NOT NULL default '',
1911 INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');
1912 INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');
1913 CREATE TABLE REL_towns (
1914 town_code varchar(5) NOT NULL default '0',
1915 description varchar(30) NOT NULL default '',
1916 PRIMARY KEY (town_code)
1918 INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');
1919 INSERT INTO REL_towns VALUES ('M', 'Montréal');
1920 To setup appropriate links and display information:
1921 * on table "REL_persons" click Structure, then Relation view
1922 * in Links, for "town_code" choose "REL_towns->code"
1923 * in Links, for "country_code" choose "REL_countries->country_code"
1924 * on table "REL_towns" click Structure, then Relation view
1925 * in "Choose field to display", choose "description"
1926 * repeat the two previous steps for table "REL_countries"
1928 Then test like this:
1929 * Click on your db name in the left frame
1931 * Use tables: persons, towns, countries
1932 * Click "Update query"
1933 * In the fields row, choose persons.person_name and click the "Show"
1935 * Do the same for towns.description and countries.descriptions in
1937 * Click "Update query" and you will see in the query box that the
1938 correct joins have been generated
1939 * Click "Submit query"
1941 [6.7] How can I use the "display field" feature?
1943 Starting from the previous example, create the PMA_table_info as
1944 explained in the configuration section, then browse your persons
1945 table, and move the mouse over a town code or country code.
1947 [6.8] How can I produce a PDF schema of my database?
1949 First you have to fill the "relation", "table_coords" and "pdf_pages"
1950 configuration variables.
1951 Then, think about your schema layout: which tables will go on which
1953 * Click on your db name in the left frame
1954 * Choose "Structure" in the navigation on top
1955 * Choose "Edit PDF Pages" which should be somewhere at the bottom of
1957 * Enter the name for a first pdf page and submit
1958 * Choose this page to edit
1959 * Now add a table you want to show on this page and it's coordinates
1961 First you will have to guess this coordinates of course, so just
1962 expect to have an area of about 297 * 210 and put the tables
1963 coordinates somewhere in there, you will be able to have a look at
1964 what happened and change them later.
1965 For example, x=100 and y=200 means that the table will be at 200
1966 mm down and 100 mm right from the upper left corner.
1967 Actually if you have a width of more than 300 or a height of more
1968 than 200 than it will automatically be scaled but 300*100 is a
1969 good start to have an idea of what coordinates to use.
1970 * After every table you submitted you will have the possibility to
1972 * When you have entered enough tables Click on your db name in the
1974 * Now, again at the bottom of the page you should be able to choose
1975 "Display PDF schema"
1976 For testing it might be useful to show the grid as well, so you
1977 can see the coordinates used.
1978 Maybe also choose color and submit.
1979 * Save the file he will offer you to something like Schema.pdf
1980 (Internet Explorer has some bug there which might make it offer it
1981 without an extension. Under Windows it is important to have the
1982 extension ".pdf", under other OSes you should be fine just saving
1983 the file under the name it offers).
1985 [6.9] phpMyAdmin is changing the type of one of my columns!
1987 No, it's MySQL that is doing silent column type changing.
1989 [6.10] My database has an underscore in it's name, and when I grant
1990 privileges to a user for this database, a backslash is added before the
1993 This is normal and means that the grant is done only for this
1994 database. If there was no backslash, this would be a wildcard grant,
1995 and the underscore would mean "any character". So, if the database
1996 name is "john_db", the user would get rights to john1db, john2db...
1997 instead of just john_db.
1998 If you really want to grant using a wildcard, there is a dialog box "
1999 Database (wildcards allowed)" for this.
2001 [6.11] What is the curious symbol ø in the statistics pages?
2005 [6.12] I want to understand some Export options.
2007 "Complete inserts" adds the column names on every INSERT command, for
2008 better documentation (but resulting file is bigger).
2009 "Extended inserts" provides a shorter dump file by using only once the
2010 INSERT verb and the table name.
2011 "Enclose table and field names with backquotes" ensures that field and
2012 table names formed with special characters are protected.
2013 "Include column comments as inline SQL-comments" includes any column
2014 comments set in the PMA-DB in the dump as SQL comments (/* xxx */).
2016 [6.13] I would like to create a database with a dot in its name.
2018 This is a bad idea, because in MySQL the syntax "database.table" is
2019 the normal way to reference a database and table name. Worse, MySQL
2020 will usually let you create a database with a dot, but then you cannot
2021 work with it, nor delete it.
2023 [6.14] How do I set up the SQL Validator?
2025 To use it, you need a very recent version of PHP, 4.3.0 recommended,
2026 with XML, PCRE and PEAR support. On your system command line, run
2027 "pear install Net_Socket Net_URL HTTP_Request Mail_Mime Net_DIME SOAP"
2028 to get the necessary PEAR modules for usage.
2029 If you use it, you should be aware that any SQL statement you submit
2030 will be stored anonymously (database/table/column names, strings,
2031 numbers replaced with generic values). The Mimer SQL Validator itself,
2032 is © 2001 Upright Database Technology. We utilize it as free SOAP
2035 [6.15] I want to add a BLOB field and put an index on it, but MySQL says
2036 "BLOB column '...' used in key specification without a key length".
2038 The right way to do this, is to create the field without any indexes,
2039 then display the table structure and use the "Create an index" dialog.
2040 On this page, you will be able to choose your BLOB field, and set a
2041 size to the index, which is the condition to create an index on a BLOB
2044 [6.16] How can I simply move in page with plenty editing fields?
2046 You can use Ctrl+arrows for moving on most pages with plenty editing
2047 fields (table structure changes, row editing, etc.). You can also have
2048 a look at the directive $cfg['DefaultPropDisplay'] ('vertical') and
2049 see if this eases up editing for you.
2051 [6.17] Transformations: I can't enter my own mimetype! WTF is this feature
2054 Slow down :). Defining mimetypes is of no use, if you can't put
2055 transformations on them. Otherwise you could just put a comment on the
2056 field. Because entering your own mimetype will cause serious syntax
2057 checking issues and validation, this introduces a high-risk
2058 false-user-input situation. Instead you have to initialize mimetypes
2059 using functions or empty mimetype definitions.
2060 Plus, you have a whole overview of available mimetypes. Who knows all
2061 those mimetypes by heart so he/she can enter it at will?
2063 [6.17] Bookmarks: Where can I store bookmarks? Why can't I see any
2064 bookmarks below the query box? What is this variable for?
2066 Any query you have executed can be stored as a bookmark on the page
2067 where the results are displayed. You will find a button labeled
2068 'Bookmark this query' just at the end of the page.
2069 As soon as you have stored a bookmark, it is related to the database
2070 you run the query on. You can now access a bookmark dropdown on each
2071 page, the query box appears on for that database.
2072 Since phpMyAdmin 2.5.0 you are also able to store variables for the
2073 bookmarks. Just use the string /*[VARIABLE]*/ anywhere in your query.
2074 Everything which is put into the value input box on the query box page
2075 will replace the string "/*[VARIABLE]*/" in your stored query. Just be
2076 aware of that you HAVE to create a valid query, otherwise your query
2077 won't be even able to be stored in the database.
2078 Also remember, that everything else inside the /*[VARIABLE]*/ string
2079 for your query will remain the way it is, but will be stripped of the
2080 /**/ chars. So you can use:
2081 /*, [VARIABLE] AS myname */
2082 which will be expanded to
2083 , VARIABLE as myname
2084 in your query, where VARIABLE is the string you entered in the input
2085 box. If an empty string is provided, no replacements are made.
2086 A more complex example. Say you have stored this query:
2087 SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE
2089 Say, you now enter "phpMyAdmin" as the variable for the stored query,
2090 the full query will be:
2091 SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE
2093 You can use multiple occurences of /*[VARIABLE]*/ in a single query.
2094 NOTE THE ABSENCE OF SPACES inside the "/**/" construct. Any spaces
2095 inserted there will be later also inserted as spaces in your query and
2096 may lead to unexpected results especially when using the variable
2097 expansion inside of a "LIKE ''" expression.
2098 Your initial query which is going to be stored as a bookmark has to
2099 yield at least one result row so you can store the bookmark. You may
2100 have that to work around using well positioned "/**/" comments.
2102 [7. phpMyAdmin project]
2104 [7.1] I have found a bug. How do I inform developers?
2106 Our Bug Tracker is located at
2107 http://sourceforge.net/projects/phpmyadmin/ under the Bugs section.
2108 But please first discuss your bug with other users:
2109 http://sourceforge.net/projects/phpmyadmin/ (and choose Forums)
2111 [7.2] I want to translate the messages to a new language or upgrade an
2112 existing language, where do I start?
2114 Always use the current CVS version of your language file. For a new
2115 language, start from english-iso-8859-1.inc.php3. If you don't know
2116 how to get the CVS version, please ask one of the developers.
2117 Please note that we try not to use HTML entities like é in the
2118 translations, since we define the right character set in the file.
2119 With HTML entities, the text on JavaScript messages would not display
2120 correctly. However there are some entities that need to be there, for
2121 quotes ,non-breakable spaces, ampersands, less than, greater than.
2122 You can then put your translations, as a zip file to avoid losing
2123 special characters, on the sourceforge.net translation tracker.
2124 It would be a good idea to subscribe to the phpmyadmin-translators
2125 mailing list, because this is where we ask for translations of new
2128 [7.3] I would like to help out with the development of phpMyAdmin. How
2131 The following method is preferred for new developers:
2132 1. fetch the current CVS tree over anonymous CVS:
2134 -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmy
2136 [Password: simply press the Enter key]
2138 -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmy
2139 admin checkout phpMyAdmin
2140 [This will create a new sub-directory named phpMyAdmin]
2142 3. put the modified files (tar'ed and gzip'ed) inside the patch
2143 tracker of the phpMyAdmin SourceForge account.
2145 Write access to the CVS tree is granted only to experienced developers
2146 who have already contributed something useful to phpMyAdmin.
2147 Also, have a look at the Developers section.
2149 Developers Information
2151 phpMyAdmin is Open Source, so you're invited to contribute to it. Many
2152 great features have been written by other people and you too can help
2153 to make phpMyAdmin a useful tool.
2155 If you're planning to contribute source, please read the following
2157 * All files include header.inc.php3 (layout),
2158 libraries/common.lib.php3 (common functions) and config.inc.php3.
2159 All configuration data belongs in config.inc.php3. Please keep it
2160 free from other code.
2161 Commonly used functions should be added to
2162 libraries/common.lib.php3 and more specific ones may be added
2163 within a library stored into the libraries sub-directory.
2164 * Obviously, you're free to use whatever coding style you want. But
2165 please try to keep your code as simple as possible: beginners are
2166 using phpMyAdmin as an example application.
2167 As far as possible, we want the scripts to be XHTML1.0 and CSS2
2168 compliant on one hand, they fit the PEAR coding standards on the
2169 other hand. Please pay attention to this.
2170 * Please try to keep up the file-naming conventions. Table-related
2171 stuff goes to tbl_*.php3, db-related code to db_*.php3,
2172 server-related tools to server_*.php3 and so on.
2173 * Please don't use verbose strings in your code, instead add the
2174 string (at least) to english-iso-8859-1.inc.php3 and print() it
2176 * If you want to be really helpful, write an entry for the
2178 * The DBG extension (PHP Debugger DBG) is now supported by
2179 phpMyAdmin for developers to better debug and profile their code.
2180 Please see the $cfg['DBG']* configuration options for more
2182 This is in memoriam of the Space Shuttle Columbia (STS-107) which
2183 was lost during its re-entry into Earth's atmosphere and in memory
2184 of the brave men and women who gave their lives for the people of
2190 phpMyAdmin - Credits
2191 ====================
2193 CREDITS, in chronological order
2194 -------------------------------
2196 - Tobias Ratschiller <tobias.ratschiller_at_maguma.com>
2197 * creator of the phpmyadmin project
2198 * maintainer from 1998 to summer 2000
2200 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca>
2201 * multi-language version
2202 * various fixes and improvements
2203 * project co-administrator
2205 - Olivier Müller <om_at_omnis.ch>
2206 * started SourceForge phpMyAdmin project in March 2001
2207 * sync'ed different existing CVS trees with new features and bugfixes
2208 * multi-language improvements, dynamic language selection
2209 * current project maintainer
2210 * many bugfixes and improvements
2212 - Loïc Chapeaux <lolo_at_phpheaven.net>
2213 * rewrote and optimized javascript, DHTML and DOM stuff
2214 * rewrote the scripts so they fit the PEAR coding standards and
2215 generate XHTML1.0 and CSS2 compliant codes
2216 * improved the language detection system
2217 * many bugfixes and improvements
2219 - Robin Johnson <robbat2_at_users.sourceforge.net>
2220 * database maintence controls
2222 * Host authentication IP Allow/Deny
2223 * DB-based configuration (Not completed)
2226 * many bugfixes and improvements
2228 - Armel Fauveau <armel.fauveau_at_globalis-ms.com>
2230 * multiple dump feature
2234 - Geert Lund <glund_at_silversoft.dk>
2236 * moderator of the phpMyAdmin users forum at phpwizard.net
2238 - Korakot Chaovavanich <korakot_at_iname.com>
2239 * "insert as new row" feature
2241 - Pete Kelly <webmaster_at_trafficg.com>
2242 * rewrote and fix dump code
2245 - Steve Alberty <alberty_at_neptunlabs.de>
2246 * rewrote dump code for PHP4
2247 * mySQL table statistics
2250 - Benjamin Gandon <gandon_at_isia.cma.fr>
2251 * main author of the version 2.1.0.1
2254 - Alexander M. Turek <rabus_at_bugfixes.info>
2256 * MySQL 4 related features
2257 * various small features and fixes
2258 * German language file updates
2260 - Mike Beck <mike.beck_at_ibmiller.de>
2261 * automatic joins in QBE
2262 * links column in printview
2265 - Michal Cihar <nijel_at_users.sourceforge.net>
2266 * enhanced index creation/display feature
2267 * feature to use a different charset for HTML than for MySQL
2268 * Czech language file updates
2270 - Christophe Gesché from the "MySQL Form Generator for PHPMyAdmin"
2271 (http://sourceforge.net/projects/phpmysqlformgen/)
2272 * suggested the patch for multiple table printviews
2274 - Garvin Hicking <hicking_at_faktor-e.de>
2275 * built the patch for vertical display of table rows
2276 * built the Javascript based Query window + SQL history
2277 * Improvement of column/db comments
2278 * (MIME)-Transformations for columns
2279 * Use custom alias names for Databases in left frame
2280 * vertical display of column properties page
2281 * some bugfixes, smaller features
2283 - Yukihiro Kawada <kawada_at_den.fujifilm.co.jp>
2284 * japanese kanji encoding conversion feature
2286 - Piotr Roszatycki <d3xter_at_users.sourceforge.net> and Dan Wilson
2287 * the Cookie authentication mode
2289 - Axel Sander <n8falke_at_users.sourceforge.net>
2290 * table relation-links feature
2292 - Maxime Delorme <delorme.maxime_at_free.fr>
2293 * PDF schema output, thanks also to Olivier Plathey for the
2294 "FPDF" library (see http://www.fpdf.org/).
2296 - Olof Edlund <olof.edlund_at_upright.se>
2297 * SQL validator server
2299 - Ivan R. Lanin <ivanlanin_at_users.sourceforfe.net>
2302 And also to the following people who have contributed minor changes,
2303 enhancements, bugfixes or support for a new language since version 2.1.0:
2305 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
2306 Péter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
2307 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kläger,
2308 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
2309 Bernard M. Piller, Laurent Haas, "Sakamoto", Yuval Sarna,
2310 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
2311 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
2312 Luís V., Martijn W. van der Lee,
2313 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
2314 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, "Manuzhai".
2317 Original Credits of Version 2.1.0
2318 ---------------------------------
2320 This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
2321 to create a web-based interface to MySQL using PHP3. Although I have not
2322 used any of his source-code, there are some concepts I've borrowed from
2323 him. phpMyAdmin was created because Peter told me he wasn't going to
2324 further develop his (great) tool.
2326 - Amalesh Kempf <ak-lsml_at_living-source.com> who contributed the
2327 code for the check when dropping a table or database. He also suggested
2328 that you should be able to specify the primary key on tbl_create.php3. To
2329 version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
2330 well as a bug-report. Plus many smaller improvements.
2331 - Jan Legenhausen <jan_at_nrw.net>: He made many of the changes that
2332 were introduced in 1.3.0 (including quite significant ones like the
2333 authentication). For 1.4.1 he enhanced the table-dump feature. Plus
2335 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca> made phpMyAdmin
2336 language-independent by outsourcing the strings to a separate file. He
2337 also contributed the French translation.
2338 - Alexandr Bravo <abravo_at_hq.admiral.ru> who contributed
2339 tbl_select.php3, a feature to display only some fields from a table.
2340 - Chris Jackson <chrisj_at_ctel.net> added support for MySQL
2341 functions in tbl_change.php3. He also added the
2342 "Query by Example" feature in 2.0.
2343 - Dave Walton <walton_at_nordicdms.com> added support for multiple
2344 servers and is a regular contributor for bug-fixes.
2345 - Gabriel Ash <ga244_at_is8.nyu.edu> contributed the random access
2347 The following people have contributed minor changes, enhancements, bugfixes
2348 or support for a new language:
2349 Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
2350 Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
2351 Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
2354 And thanks to everyone else who sent me email with suggestions, bug-reports
2355 and or just some feedback.
2357 Valid XHTML 1.0! Valid CSS!