2 ______________________________________________________________________
4 Top - Requirements - Introduction - Installation -
6 Transformations - FAQ - Developers - Credits - Translators
7 ______________________________________________________________________
9 phpMyAdmin 2.5.0-rc1 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.430 2003/04/13
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 The following example assumes you want to use pma as the
151 controluser and pmapass as the controlpass, but this is only an
152 example: use something else in your file!
153 Of course you have to replace localhost by the webserver's host if
154 it's not the same as the MySQL server's one.
156 GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY 'pmapass';
158 Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
159 Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
160 File_priv, Grant_priv, References_priv, Index_priv, Alter_priv,
161 Show_db_priv, Super_priv, Create_tmp_table_priv, Lock_tables_priv,
162 Execute_priv, Repl_slave_priv, Repl_client_priv
163 ) ON mysql.user TO 'pma'@'localhost';
164 GRANT SELECT ON mysql.db TO 'pma'@'localhost';
165 GRANT SELECT ON mysql.host TO 'pma'@'localhost';
166 GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv)
167 ON mysql.tables_priv TO 'pma'@'localhost';
169 If you are using an old MySQL version (below 4.0.2), please use
170 this query instead of the second one:
173 Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
174 Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
175 File_priv, Grant_priv, References_priv, Index_priv, Alter_priv
176 ) ON mysql.user TO 'pma'@'localhost';
178 ... and if you want to use the many new relation and bookmark
181 GRANT SELECT, INSERT, UPDATE, DELETE ON <pma_db> TO 'pma'@'localhost';
183 (this of course requires you to have a special DB for phpMyAdmin,
184 the contents will be explained later)
185 Of course, the above queries only work if your MySQL version
186 supports the GRANT command. This is the case since 3.22.11.
187 * Then each of the true users should be granted a set of privileges
188 on a set of particular databases. Normally you shouldn't give
189 global privileges to an ordinary user, unless you understand the
190 impact of those privileges (for example, you are creating a
192 For example, to grant the user real_user with all privileges on
193 the database user_base:
194 GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost
195 IDENTIFIED BY 'real_password';
196 What the user may now do is controlled entirely by the MySQL user
198 With HTTP or cookie authentication mode, you don't need to fill
199 the user/password fields inside the $cfg['Servers'] array.
201 'http' authentication mode:
202 * Was called 'advanced' in versions before 2.2.3.
203 * Introduced in 1.3.0, it uses Basic HTTP authentication method and
204 allows you to login as any valid MySQL user.
205 * Is only supported with PHP running as an Apache module, not with
208 'cookie' authentication mode:
209 * You can use this method as a replacement for the HTTP
210 authentication (for example, if you're running IIS).
211 * Obviously, the user must enable cookies in the browser.
212 * With this mode, the use can truly logout of phpMyAdmin and login
213 back with the same username.
215 'config' authentication mode:
216 * This mode is the less secure one because it requires you to fill
217 the $cfg['Servers'][$i]['user'] and
218 $cfg['Servers'][$i]['password'] fields.
219 But you don't need to setup a "controluser" here: using the
220 $cfg['Servers'][$i]['only_db'] might be enough.
221 * In the ISP FAQ section, there is an entry explaining how to
222 protect your configuration file.
223 * For additional security in this mode, you may wish to consider the
224 Host authentication $cfg['Servers'][$i]['AllowDeny']['order'] and
225 $cfg['Servers'][$i]['AllowDeny']['rules'] configuration
230 Warning for Mac users: PHP seems not to like Mac end of lines
231 character ("\r"). So ensure you choose the option that allows to use
232 the *nix end of line character ("\n") in your text editor before
233 registering a script you have modified.
235 All configurable data is placed in config.inc.php3.
237 $cfg['PmaAbsoluteUri'] string
238 Sets here the complete URL (with full path) to your phpMyAdmin
240 http://www.your_web.net/path_to_your_phpMyAdmin_directory/.
241 phpMyAdmin needs this setting, because of requirements of the
242 HTTP protocol, explained in RFC2616, section 14.30.
243 Don't forget the slash at the end of your URL. The URL must
244 contain characters that are valid for a URL, and on some
245 servers, the path is case-sensitive.
246 Starting with version 2.3.0, you can try to leave this
247 parameter empty, because the program tries to auto-detect its
248 proper value. Additional details are in the configuration file.
249 Alternatively, this setting can be dynamically completed. For
250 example, you can try to use such a kind of code:
252 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
253 . $_SERVER['HTTP_HOST']
254 . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
255 . substr($_SERVER['PHP_SELF'], 0, strrpos($_SERVER['PHP_SELF'], '/')+1);
259 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
260 . $_SERVER['SERVER_NAME']
261 . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
262 . substr($_SERVER['SCRIPT_NAME'], 0, strrpos($_SERVER['SCRIPT_NAME'], '/')+1);
265 Please note that the $_SERVER array doesn't exist in
266 PHP < 4.1.0. Try to replace $_SERVER by $HTTP_SERVER_VARS or
267 $GLOBALS in this case.
269 $cfg['PmaAbsoluteUri_DisableWarning'] boolean
270 By default, when you leave $cfg['PmaAbsoluteUri'] empty, and
271 the system detects your absolute URI automatically, we display
272 a warning to remind you. If you have tested the automatic
273 detection, and it works perfectly for your setup, then you can
274 set this variable to squelch the warning.
276 $cfg['PmaNoRelation_DisableWarning'] boolean
277 Starting with version 2.3.0 phpMyAdmin offers a lot of features
278 to work with master / foreign - tables (see
279 $cfg['Servers'][$i]['pmadb']).
280 If you tried to set this up and it does not work for you, have
281 a look on the "Structure" page of one database where you would
282 like to use it. You will find a link that will analyze why
283 those features have been disabled.
284 If you do not want to use those features set this variable to
285 TRUE to stop this message from appearing.
287 $cfg['Servers'] array
288 Since version 1.4.2, phpMyAdmin supports the administration of
289 multiple MySQL servers. Therefore, a $cfg['Servers']-array has
290 been added which contains the login information for the
291 different servers. The first $cfg['Servers'][$i]['host']
292 contains the hostname of the first server, the second
293 $cfg['Servers'][$i]['host'] the hostname of the second server,
294 etc. If you have only one server to administer, simply leave
295 free the hostname of the other $cfg['Server']-entries.
297 $cfg['Servers'][$i]['host'] string
298 The hostname of your $i-th MySQL-server. E.g. localhost.
300 $cfg['Servers'][$i]['port'] string
301 The port-number of your $i-th MySQL-server. Default is 3306
304 $cfg['Servers'][$i]['socket'] string
305 The path to the socket to use. Leave blank for default.
306 To use the socket feature you must run PHP 3.0.10 or more.
308 $cfg['Servers'][$i]['connect_type'] string
309 What type connection to use with the MySQL server. Your options
310 are 'socket' & 'tcp'. It defaults to 'tcp' as that is nearly
311 guaranteed to be available on all MySQL servers, while sockets
312 are not supported on some platforms.
313 To use the socket mode, your MySQL server must be on the same
314 machine as the Web server.
316 $cfg['Servers'][$i]['compress'] boolean
317 Whether to use a compressed protocol for the MySQL server
318 connection or not (experimental).
319 This feature requires PHP >= 4.3.0.
321 $cfg['Servers'][$i]['controluser'] string
322 $cfg['Servers'][$i]['controlpass'] string
323 When using HTTP or cookie authentication modes (or 'config'
324 authentication mode since phpMyAdmin 2.2.1), you need to supply
325 the details of a MySQL account that has SELECT privilege on the
326 mysql.user (all columns except "Password"), mysql.db (all
327 columns) & mysql.tables_priv (all columns except "Grantor" &
328 "Timestamp") tables. This account is used to check what
329 databases the user will see at login.
330 Please see the install section on "Using HTTP authentication"
331 for more information.
332 Note that if you try login to phpMyAdmin with this
333 "controluser", you could get some errors, depending the exact
334 privileges you gave to the "controluser". phpMyAdmin does not
335 support a direct login with the "controluser".
336 In versions before 2.2.5, those were called "stduser/stdpass".
338 $cfg['Servers'][$i]['auth_type'] string ['http'|'cookie'|'config']
339 Whether config or cookie or http authentication should be used
342 + 'config' authentication ($auth_type = 'config') is the plain
343 old way: username and password are stored in config.inc.php3.
344 + 'cookie' authentication mode ($auth_type = 'cookie') as
345 introduced in 2.2.3 allows you to log in as any valid MySQL
346 user with the help of... cookies. Log name and password are
347 stored in cookies during the session and password is deleted
349 + 'http' authentication (was called 'advanced' in older
350 versions) ($auth_type = 'http') as introduced in 1.3.0 allows
351 you to log in as any valid MySQL user via HTTP-Auth.
353 Please see the install section on "Using authentication modes"
354 for more information.
356 $cfg['Servers'][$i]['user'] string
357 $cfg['Servers'][$i]['password'] string
358 The user/password-pair which phpMyAdmin will use to connect to
359 this MySQL-server. This user/password pair is not needed when
360 HTTP or cookie authentication is used, and should be empty.
362 $cfg['Servers'][$i]['only_db'] string or array
363 If set to a(an array of) database name(s), only this(these)
364 database(s) will be shown to the user. Since phpMyAdmin 2.2.1,
365 this/these database(s) name(s) may contain MySQL wildcards
366 characters ("_" and "%"): if you want to use literal instances
367 of these characters, escape them (I.E. use 'my\_db' and not
369 This setting is an efficient way to lower the server charge
370 since the latter does not need to send MySQL requests to build
371 the available database list. But it does not replace the
372 privileges rules of the MySQL database server. If set, it just
373 means only these databases will be displayed but not at all
374 other databases can't be used.
376 $cfg['Servers'][$i]['verbose'] string
377 Only useful when using phpMyAdmin with multiple server entries.
378 If set, this string will be displayed instead of the hostname
379 in the pull-down menu on the main page. This can be useful if
380 you want to show only certain databases on your system, for
383 $cfg['Servers'][$i]['pmadb'] string
384 Starting with version 2.3.0 phpMyAdmin offers a lot of features
385 to work with master / foreign - tables. To use those as well as
386 the bookmark feature you need special tables with a predefined
387 structure, which we explain below.
388 If you are the only user of this phpMyAdmin installation, you
389 can use your current database to store those special tables; in
390 this case, just put your current database name in
391 $cfg['Servers'][$i]['pmadb'].
392 If you are setting up a multi-user phpMyAdmin installation, you
393 will need to create a new database and setup special
394 privileges, so, as superuser:
396 + create a new database for phpMyAdmin:
397 CREATE DATABASE phpmyadmin;
398 Note that "controluser" must have SELECT, INSERT, UPDATE and
399 DELETE privileges on this database. Here is a query to set up
400 those privileges (using "phpmyadmin" as the database name,
401 and "pma" as the controluser):
402 GRANT SELECT,INSERT,UPDATE,DELETE ON phpmyadmin.* to
404 do not give any other user rights on this database.
405 + enter the database name in $cfg['Servers'][$i]['pmadb']
407 $cfg['Servers'][$i]['bookmarktable'] string
408 Since release 2.2.0 phpMyAdmin allows to bookmark queries. This
409 can be useful for queries you often run.
410 To allow the usage of this functionality you have to:
412 + set up "pmadb" as described above
413 + within this database create a table following this scheme:
414 CREATE TABLE `PMA_bookmark` (
415 id int(11) DEFAULT '0' NOT NULL auto_increment,
416 dbase varchar(255) NOT NULL,
417 user varchar(255) NOT NULL,
418 label varchar(255) NOT NULL,
421 ) TYPE=MyISAM COMMENT='Bookmarks';
422 + enter the table name in $cfg['Servers'][$i]['bookmarktable']
424 $cfg['Servers'][$i]['relation'] string
425 Since release 2.2.4 you can describe, in a special 'relation'
426 table, which field is a key in another table (a foreign key).
427 phpMyAdmin currently uses this to
429 + make clickable, when you browse the master table, the data
430 values that point to the foreign table;
431 + display in an optional tool-tip the "display field" when
432 browsing the master table, if you move the mouse to a column
433 containing a foreign key (use also the 'table_info' table);
434 + display links on the table properties page, to check
435 referential integrity (display missing foreign keys) for each
437 + in query-by-example, create automatic joins (see an example
438 in the FAQ, section "Using phpMyAdmin");
439 + enable you to get a PDF schema of your database (also uses
440 the table_coords table).
442 The keys can be numeric or character.
443 To allow the usage of this functionality the superuser has to:
445 + set up "pmadb" as described above
446 + within this database create a table following this scheme:
447 CREATE TABLE `PMA_relation` (
448 `master_db` varchar(64) NOT NULL default '',
449 `master_table` varchar(64) NOT NULL default '',
450 `master_field` varchar(64) NOT NULL default '',
451 `foreign_db` varchar(64) NOT NULL default '',
452 `foreign_table` varchar(64) NOT NULL default '',
453 `foreign_field` varchar(64) NOT NULL default '',
454 PRIMARY KEY (`master_db`, `master_table`,
456 KEY foreign_field (foreign_db, foreign_table)
457 ) TYPE=MyISAM COMMENT='Relation table';
458 + put the relation table name in
459 $cfg['Servers'][$i]['relation']
460 + now as normal user open phpMyAdmin and for each one of your
461 tables where you want to use this feature, click
462 "Structure/Relation view/" and choose foreign fields.
464 Please note that in the current (2.3.0) version, master_db must
465 be the same as foreign_db. Those fields have been put in future
466 development of the cross-db relations.
468 $cfg['Servers'][$i]['table_info'] string
469 Since release 2.3.0 you can describe, in a special 'table_info'
470 table, which field is to be displayed as a tool-tip when moving
471 the cursor over the corresponding key.
472 This configuration variable will hold the name of this special
473 table. To allow the usage of this functionality the superuser
476 + set up "pmadb" as described above
477 + within this database create a table following this scheme:
478 CREATE TABLE `PMA_table_info` (
479 `db_name` varchar(64) NOT NULL default '',
480 `table_name` varchar(64) NOT NULL default '',
481 `display_field` varchar(64) NOT NULL default '',
482 PRIMARY KEY (`db_name`, `table_name`)
483 ) TYPE=MyISAM COMMENT='Table information for
485 + put the table name in $cfg['Servers'][$i]['table_info']
486 + then for each table where you want to use this feature, click
487 "Structure/Relation view/Choose field to display" to choose
490 Usage tip: Display field.
492 $cfg['Servers'][$i]['table_coords'] string
493 $cfg['Servers'][$i]['pdf_pages'] string
494 Since release 2.3.0 you can have phpMyAdmin create PDF pages
495 showing the relations between your tables. To do this it needs
496 two tables "pdf_pages" (storing information about the available
497 PDF pages) and "table_coords" (storing coordinates where each
498 table will be placed on a PDF schema output).
499 You must be using the "relation" feature and have a table of
500 PDF pages (see $cfg['Servers'][$i]['pdf_pages']) to create PDF
502 To allow the usage of this functionality the superuser has to:
504 + set up "pmadb" as described above
505 + within this database create a table following this scheme:
506 CREATE TABLE `PMA_table_coords` (
507 `db_name` varchar(64) NOT NULL default '',
508 `table_name` varchar(64) NOT NULL default '',
509 `pdf_page_number` int NOT NULL default '0',
510 `x` float unsigned NOT NULL default '0',
511 `y` float unsigned NOT NULL default '0',
512 PRIMARY KEY (`db_name`, `table_name`,
514 ) TYPE=MyISAM COMMENT='Table coordinates for phpMyAdmin
516 + also within this database create:
517 CREATE TABLE `PMA_pdf_pages` (
518 `db_name` varchar(64) NOT NULL default '',
519 `page_nr` int(10) unsigned NOT NULL auto_increment,
520 `page_descr` varchar(50) NOT NULL default '',
521 PRIMARY KEY (page_nr),
523 ) TYPE=MyISAM COMMENT='PDF Relationpages for PMA';
524 + put the first table name in
525 $cfg['Servers'][$i]['table_coords'] and the second table name
526 in $cfg['Servers'][$i]['pdf_pages']
528 Usage tips: PDF output.
530 $cfg['Servers'][$i]['column_info'] string
531 Since release 2.3.0 you can store comments to describe each
532 column for each table. These will then be shown on the
534 Starting with release 2.5.0, comments are consequently used on
535 the table property pages and table browse view, showing up as
536 tool-tips above the column name (properties page) or embedded
537 within the header of table in browse view. They can also be
538 shown in a table dump. Please see the relevant configuration
540 Also new in release 2.5.0 is a mime-transformation system which
541 is also based on the following table structure. See
542 Transformations for further information. To use the
543 mime-transformation system, your column_info table has to have
544 the three new fields 'mimetype', 'transformation',
545 'transformation_options'.
546 To allow the usage of this functionality the superuser has to:
548 + set up "pmadb" as described above
549 + within this database create a table following this scheme:
550 CREATE TABLE `PMA_column_info` (
551 id int(5) unsigned NOT NULL auto_increment,
552 db_name varchar(64) NOT NULL default '',
553 table_name varchar(64) NOT NULL default '',
554 column_name varchar(64) NOT NULL default '',
555 `comment` varchar(255) NOT NULL default '',
556 mimetype varchar(255) NOT NULL default '',
557 transformation varchar(255) NOT NULL default '',
558 transformation_options varchar(255) NOT NULL default
561 UNIQUE KEY db_name (db_name, table_name, column_name)
562 ) TYPE=MyISAM COMMENT='Comments for Columns';
563 + put the table name in $cfg['Servers'][$i]['column_info']
564 + To update your PRE-2.5.0 Column_comments Table use this:
565 ALTER TABLE `PMA_column_comments`
566 ADD `mimetype` VARCHAR( 255 ) NOT NULL ,
567 ADD `transformation` VARCHAR( 255 ) NOT NULL ,
568 ADD `transformation_options` VARCHAR( 255 ) NOT NULL ;
569 and remember that the Variable in config.inc.php has been
571 $cfg['Servers'][$i]['column_comments'] to
572 $cfg['Servers'][$i]['column_info']
574 $cfg['Servers'][$i]['history'] string
575 Since release 2.5.0 you can store your SQL history, which means
576 all queries you entered manually into the phpMyAdmin interface.
577 If you don't want to use a table- based history, you can use
578 the JavaScript-based history. Using that, all your history
579 items are deleted when closing the window.
580 Using $cfg['QueryHistoryMax'] you can specify an amount of
581 history items you want to have on hold. On every login, this
582 list gets cut to the maximum amount.
583 The query history is only available if you use the
584 JavaScript-based query window, see $cfg['QueryFrame'].
585 To allow the usage of this functionality the superuser has to:
587 + set up "pmadb" as described above
588 + within this database create a table following this scheme:
589 CREATE TABLE `PMA_history` (
590 `id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
591 `username` VARCHAR( 64 ) NOT NULL ,
592 `db` VARCHAR( 64 ) NOT NULL ,
593 `table` VARCHAR( 64 ) NOT NULL ,
594 `timevalue` TIMESTAMP NOT NULL ,
595 `sqlquery` TEXT NOT NULL ,
596 PRIMARY KEY ( `id` ) ,
597 INDEX ( `username` , `db` , `table` , `timevalue` )
598 ) TYPE=MyISAM COMMENT='SQL history';
599 + put the table name in $cfg['Servers'][$i]['history']
601 $cfg['Servers'][$i]['verbose_check'] string
602 Because release 2.5.0 introduced the new MIME-transformation
603 support, the column_info table got enhanced with three new
604 fields. If the above variable is set to TRUE (default)
605 phpMyAdmin will check if you have the latest table structure
606 available. If not, it will emit a warning to the superuser.
607 You can disable this checking behavior by setting the variable
608 to false, which should offer a performance increase.
609 Recommended to set to FALSE, when you are sure, your table
610 structure is up to date.
612 $cfg['Servers'][$i]['AllowDeny']['order'] string
613 If your rule order is empty, then IP authentication is
615 If your rule order is set to 'deny,allow' then the system
616 applies all deny rules followed by allow rules. Access is
617 allowed by default. Any client which does not match a Deny
618 command or does match an Allow command will be allowed access
620 If your rule order is set to 'allow,deny' then the system
621 applies all allow rules followed by deny rules. Access is
622 denied by default. Any client which does not match an Allow
623 directive or does match a Deny directive will be denied access
625 If your rule order is set to 'explicit', the authentication is
626 performed in a similar fashion to rule order 'deny,allow', with
627 the added restriction that your host/username combination must
628 be listed in the allow rules, and not listed in the deny rules.
629 This is the most secure means of using Allow/Deny rules, and
630 was available in Apache by specifying allow and deny rules
631 without setting any order.
633 $cfg['Servers'][$i]['AllowDeny']['rules'] array of strings
634 The general format for the rules is as such:
635 <'allow' | 'deny'> <username> [from] <ipmask>
636 If you wish to match all users, it is possible to use a '%' as
637 a wildcard in the username field.
638 There are a few shortcuts you can use in the ipmask field as
641 'localhost' -> 127.0.0.1/8
642 Having an empty rule list is equivalent to either using 'allow
643 % from all' if your rule order is set to 'deny,allow' or 'deny
644 % from all' if your rule order is set to 'allow,deny' or
646 For the IP matching system, the following work:
647 xxx.xxx.xxx.xxx (an exact IP address)
648 xxx.xxx.xxx.[yyy-zzz] (an IP address range)
649 xxx.xxx.xxx.xxx/nn (CIDR, Classless Inter-Domain Routing type
651 But the following does not work:
652 xxx.xxx.xxx.xx[yyy-zzz] (partial IP address range)
654 $cfg['ServerDefault'] integer
655 If you have more than one server configured, you can set
656 $cfg['ServerDefault'] to any one of them to autoconnect to that
657 server when phpMyAdmin is started, or set it to 0 to be given a
658 list of servers without logging in.
659 If you have only one server configured, $cfg['ServerDefault']
660 MUST be set to that server.
662 $cfg['OBGzip'] boolean
663 Defines whether to use GZip output buffering for increased
664 speed in HTTP transfers.
666 $cfg['PersistentConnections'] boolean
667 Whether persistent connections should be used or not
668 (mysql_connect or mysql_pconnect).
670 $cfg['ExecTimeLimit'] integer [number of seconds]
671 Set the number of seconds a script is allowed to run. If
672 seconds is set to zero, no time limit is imposed.
673 This setting is used while importing/exporting dump files but
674 has no effect when PHP is running in safe mode.
676 $cfg['SkipLockedTables'] boolean
677 Mark used tables and make it possible to show databases with
678 locked tables (since 3.23.30).
680 $cfg['ShowSQL'] boolean
681 Defines whether SQL-queries generated by phpMyAdmin should be
684 $cfg['AllowUserDropDatabase'] boolean
685 Defines whether normal users (non-administrator) are allowed to
686 delete their own database or not. If set as FALSE, the link
687 "Drop Database" will not be shown, and even a "DROP DATABASE
688 mydatabase" will be rejected. Quite practical for ISP's with
691 $cfg['Confirm'] boolean
692 Whether a warning ("Are your really sure..") should be
693 displayed when you're about to loose data.
695 $cfg['LoginCookieRecall'] boolean
696 Define whether the previous login should be recalled or not in
697 cookie authentication mode.
699 $cfg['UseDbSearch'] boolean
700 Define whether the "search string inside database" is enabled
703 $cfg['LeftFrameLight'] boolean
704 Defines whether to use select-based menu and display only the
705 current tables in the left frame (smaller page).
707 $cfg['ShowTooltip'] boolean
708 Defines whether to display table comment as tool-tip in left
711 $cfg['ShowTooltipAliasDB'] boolean
712 If tool-tips are enabled and a DB comment is set, this will
713 flip the comment and the real name. That means, if you have a
714 table called 'user0001' and add the comment 'MyName' on it, you
715 will see the name 'MyName' used consequently in the left frame
716 and the tool-tip shows the real name of the DB.
718 $cfg['ShowTooltipAliasTB'] boolean
719 Same as $cfg['ShowTooltipAliasDB'], except this works for table
722 $cfg['ShowStats'] boolean
723 Defines whether to display space usage and statistics about
724 databases and tables or not.
725 Note that statistics requires at least MySQL 3.23.3 and that,
726 at this date, MySQL doesn't return such information for
729 $cfg['ShowMysqlInfo'] boolean
730 $cfg['ShowMysqlVars'] boolean
731 $cfg['ShowPhpInfo'] boolean
732 $cfg['ShowChgPassword'] boolean
733 Defines whether to display the "MySQL runtime information",
734 "MySQL system variables", "PHP information" and "Change
735 password " links or not for simple users at the starting main
736 (right) frame. This setting does not check MySQL commands
738 Please note that to block the usage of phpinfo() in scripts,
739 you have to put this in your php.ini:
740 disable_functions = phpinfo()
741 Also note that enabling the "Change password " link has no
742 effect with "config" authentication mode: because of the hard
743 coded password value in the configuration file, end users can't
744 be allowed to change their passwords.
746 $cfg['SuggestDBName'] boolean
747 Defines whether to suggest a database name on the "Create
748 Database" form or to keep the textfield empty.
750 $cfg['ShowBlob'] boolean
751 Defines whether BLOB fields are shown when browsing a table's
754 $cfg['NavigationBarIconic'] boolean
755 Defines whether navigation bar buttons contain text or symbols
758 $cfg['ShowAll'] boolean
759 Defines whether an user should be displayed a "show all
760 (records)" button in browse mode or not.
762 $cfg['MaxRows'] integer
763 Number of rows displayed when browsing a result set. If the
764 result set contains more rows, Previous/Next links will be
767 $cfg['Order'] string [DESC|ASC|SMART]
768 Defines whether fields are displayed in ascending (ASC) order,
769 in descending (DESC) order or in a "smart" (SMART) order - I.E.
770 descending order for fields of type TIME, DATE, DATETIME &
771 TIMESTAMP, ascending order else- by default.
773 $cfg['ProtectBinary'] boolean or string
774 Defines whether BLOB or BINARY fields are protected from
775 edition when browsing a table's content or not. Valid values
777 - FALSE to allow edition of all fields;
778 - blob to allow edition of all fields except BLOBS;
779 - all to disallow edition of all BINARY or BLOB fields.
781 $cfg['ShowFunctionFields'] boolean
782 Defines whether MySQL functions fields should be displayed or
783 not in edit/insert mode.
785 $cfg['CharEditing'] string
786 Defines which type of editing controls should be used for CHAR
787 and VARCHAR fields. Possible values are:
789 + input - this allows to limit size of text to size of field in
790 MySQL, but has problems with newlines in fields
791 + textarea - no problems with newlines in fields, but also no
794 Default is old behavior so input.
796 $cfg['ZipDump'] boolean
797 $cfg['GZipDump'] boolean
798 $cfg['BZipDump'] boolean
799 Defines whether to allow the use of zip/GZip/BZip2 compression
800 when creating a dump file or not.
802 $cfg['LightTabs'] string
803 If set to True, do use less graphically intense tabs on the top
806 $cfg['DefaultTabServer'] string
807 Defines the tab displayed by default on server view. Possible
808 values: "main.php3" (recommended for multi-user setups),
809 "server_databases.php3", "server_status.php3",
810 "server_variables.php3", "server_privileges.php3" or
811 "server_processlist.php3".
813 $cfg['DefaultTabDatabase'] string
814 Defines the tab displayed by default on database view. Possible
815 values: "db_details_structure.php3", "db_details.php3" or
818 $cfg['DefaultTabTable'] string
819 Defines the tab displayed by default on table view. Possible
820 values: "tbl_properties_structure.php3", "tbl_properties.php3",
821 "tbl_select.php3" or "tbl_change.php3".
823 $cfg['MySQLManualBase'] string
824 If set to an URL which points to the MySQL documentation (type
825 depends on $cfg['MySQLManualType']), appropriate help links are
827 See MySQL Documentation page for more information about MySQL
828 manuals and their types.
830 $cfg['MySQLManualType'] string
831 Type of MySQL documentation:
833 + old - old style used in phpMyAdmin 2.3.0 and sooner
834 + searchable - "Searchable, with user comments"
835 + chapters - "HTML, one page per chapter"
836 + big - "HTML, all on one page"
837 + none - do not show documentation links
839 $cfg['DefaultLang'] string
840 Defines the default language to use, if not browser-defined or
842 See the select_lang.inc.php3 script to know the valid values
846 Force: always use this language (must be defined in the
847 select_lang.inc.php3 script).
849 $cfg['DefaultCharset'] string
850 Default character set to use for recoding of MySQL queries.
851 This must be enabled and it's described by
852 $cfg['AllowAnywhereRecoding'] option.
853 You can give here any character set which is in
854 $cfg['AvailableCharsets'] array and this is just default
855 choice, user can select any of them.
857 $cfg['AllowAnywhereRecoding'] boolean
858 Allow character set recoding of MySQL queries. You need recode
859 or iconv support (compiled in or module) in PHP to allow MySQL
860 queries recoding and used language file must have it enabled
861 (by default only these which are in Unicode, just to avoid
862 losing some characters).
864 $cfg['RecodingEngine'] string
865 You can select here which functions will be used for character
866 set conversion. Possible values are:
868 + auto - automatically use available one (first is tested
870 + iconv - use iconv or libiconv functions
871 + recode - use recode_string function
875 $cfg['AvailableCharsets'] array
876 Available character sets for MySQL conversion. You can add your
877 own (any of supported by recode/iconv) or remove these which
878 you don't use. Character sets will be shown in same order as
879 here listed, so if you frequently use some of these move them
882 $cfg['LeftWidth'] integer
883 Left frame width in pixel.
885 $cfg['LeftBgColor'] string [HTML color]
886 $cfg['RightBgColor'] string [HTML color]
887 The background colors (HTML) used for both the frames.
889 $cfg['RightBgImage'] string
890 The URI of the background image used for the right frame. It
891 can be absolute as well as relative from your phpMyAdmin
894 $cfg['LeftPointerColor'] string [HTML color]
895 The color (HTML) used for the pointer in the left frame (does
896 not work with Netscape 4).
898 $cfg['Border'] integer
899 The size of a table's border.
901 $cfg['ThBgcolor'] string [HTML color]
902 The color (HTML) used for table headers.
904 $cfg['BgcolorOne'] string [HTML color]
905 The color (HTML) #1 for table rows.
907 $cfg['BgcolorTwo'] string [HTML color]
908 The color (HTML) #2 for table rows.
910 $cfg['BrowsePointerColor'] string [HTML color]
911 $cfg['BrowseMarkerColor'] string [HTML color]
912 The colors (HTML) uses for the pointer and the marker in browse
913 mode (does not work with Netscape 4).
914 The former feature highlights the row over which your mouse is
915 passing and the latter lets you visually mark/unmark rows by
917 You can disable both of these features by emptying the
918 respective directive.
920 $cfg['TextareaCols'] integer
921 $cfg['TextareaRows'] integer
922 $cfg['CharTextareaCols'] integer
923 $cfg['CharTextareaRows'] integer
924 Number of columns and rows for the textareas.
925 This value will be emphasized (*2) for SQL query textareas and
926 (*1.25) for SQL textareas inside the query window.
927 The Char* values are used for CHAR and VARCHAR editing (if
928 configured via $cfg['CharEditing']).
930 $cfg['TextareaAutoSelect'] boolean
931 Defines if the whole textarea of the query box will be selected
934 $cfg['LimitChars'] integer
935 Maximal number of Chars showed in a TEXT OR a BLOB field on
936 browse view. Can be turned off by a toggle button on the browse
939 $cfg['ModifyDeleteAtLeft'] boolean
940 $cfg['ModifyDeleteAtRight'] boolean
941 Defines the place where modify and delete links would be put
942 when tables contents are displayed (you may have them displayed
943 both at the left and at the right). "Left" and "right" are
944 parsed as "top" and "bottom" with vertical display mode.
946 $cfg['DefaultDisplay'] string
947 $cfg['HeaderFlipType'] string
948 There are 3 display modes: horizontal, horizontalflipped and
949 vertical. Define which one is displayed by default. The first
950 mode displays each row on a horizontal line, the second rotates
951 the headers by 90 degrees, so you can use descriptive headers
952 even though fields only contain small values and still print
953 them out. The vertical mode sorts each row on a vertical
955 The HeaderFlipType can be set to 'css' or 'faked'. When using
956 'css' the rotation of the header for horizontalflipped is done
957 via CSS. If set to 'faked' PGP does the transformation for you,
958 but of course this does not look as good as CSS.
960 $cfg['DefaultPropDisplay'] string
961 When editing/creating new columns in a table all fields
962 normally get lined up one field a line. (default:
963 'horizontal'). If you set this to 'vertical' you can have each
964 field lined up vertically beneath each other. You can save up a
965 lot of place on the horizontal direction and no longer have to
968 $cfg['ShowBrowseComments'] boolean
969 $cfg['ShowPropertyComments'] boolean
970 By setting the corresponding variable to TRUE you can enable
971 the display of column comments in Browse or Property display.
972 In browse mode, the comments are show inside the header. In
973 property mode, comments are displayed using a CSS-formatted
974 dashed-line below the name of the field. The comment is shown
975 as a tool-tip for that field.
977 $cfg['UploadDir'] string
978 The name of the directory, ending with a slash, where SQL files
979 have been uploaded by other means than phpMyAdmin (for example,
980 ftp). Those files are available under a drop-down box when you
981 click the database name, then the SQL tab.
982 Please note that the file names must have the suffix ".sql".
983 This feature is useful when your file is too big to be uploaded
984 via HTTP, or when file uploads are disabled in PHP.
985 Please note that if PHP is running in safe mode, this directory
986 must be owned by the same user as the owner of the phpMyAdmin
989 $cfg['RepeatCells'] integer
990 Repeat the headers every X cells, or 0 to deactivate.
992 $cfg['QueryFrame'] boolean
993 $cfg['QueryFrameJS'] boolean
994 $cfg['QueryFrameDebug'] boolean
995 $cfg['QueryWindowWidth'] integer
996 $cfg['QueryWindowHeight'] integer
997 $cfg['QueryHistoryDB'] boolean
998 $cfg['QueryWindowDefTab'] string
999 $cfg['QueryHistoryMax'] integer
1000 All those variables affect the new query frame/window. When
1001 $cfg['QueryFrame'] is set to true a new frame is embedded on
1002 the left with a small area. Clicking on that results in opening
1003 a direct interface to enter SQL queries.
1004 When $cfg['QueryFrameJS'] is set to true, clicking on that link
1005 opens a new custom sized browser window
1006 ($cfg['QueryWindowWidth'], $cfg['QueryWindowWidth'] - both
1007 integers for the size in pixels). If set to false, clicking on
1008 the link only opens the SQL input in the mainframe.
1009 The usage of the JavaScript query window is recommended if you
1010 have a JavaScript enabled browser. Basic functions are used to
1011 exchange quite a few variables, so most 4th generation browsers
1012 should be capable to use that feature. It currently is only
1013 tested with Internet Explorer 6 and Mozilla 1.x.
1014 If $cfg['QueryHistoryDB'] is set to TRUE, all your Queries are
1015 logged to a table, which has to be created by you (see
1016 $cfg['Servers'][$i]['history']). If set to FALSE, all your
1017 queries will be appended to the form, but only as long as your
1018 window is opened they remain saved.
1019 When using the JavaScript based query window, it will always
1020 get updated when you click on a new table/db to browse and will
1021 focus if you click on "Edit SQL" after using a query.
1022 If $cfg['QueryHistoryDB'] is set to TRUE you can specify the
1023 amount of saved history items using $cfg['QueryHistoryMax'].
1024 The query window also has a custom tabbed look to group the
1025 features. Using the variable $cfg['QueryWindowDefTab'] you can
1026 specify the default tab to be used when opening the query
1027 window. It can be set to either 'sql', 'files', 'history' or
1029 The variable $cfg['QueryFrameDebug'] can be used by developers
1030 for easier future feature integration.
1032 $cfg['BrowseMIME'] boolean
1033 Enable MIME-transformations.
1035 $cfg['MaxExactCount'] integer
1036 Determines for how large tables phpMyAdmin should get exact row
1037 count by SELECT COUNT. If approximate row cound is smaller than
1038 this value, SELECT COUNT will be used, otherwise only value
1039 returned by SHOW TABLE STATUS.
1041 $cfg['SQP']['fmtType'] string [html|none]
1042 The main use of the new SQL Parser is to pretty-print SQL
1043 queries. By default we use HTML to format the query, but you
1044 can disable this by setting this variable to 'none'
1046 $cfg['SQP']['fmtInd'] float
1047 $cfg['SQP']['fmtIndUnit'] string [em|px|pt|ex]
1048 For the pretty-printing of SQL queries, under some cases the
1049 part of a query inside a bracket is indented. By changing
1050 $cfg['SQP']['fmtInd'] you can change the amount of this indent.
1051 Related in purpose is $cfg['SQP']['fmtIndUnit'] which specifies
1052 the units of the indent amount that you specified. This is used
1055 $cfg['SQP']['fmtColor'] array of string tuples
1056 This array is used to define the colours for each type of
1057 element of the pretty-printed SQL queries. The tuple format is
1058 class => [HTML colour code | empty string]
1059 If you specify an empty string for the color of a class, it is
1060 ignored in creating the stylesheet. You should not alter the
1061 class names, only the colour strings.
1064 + comment Applies to all comment sub-classes
1065 + comment_mysql Comments as "#...\n"
1066 + comment_ansi Comments as "-- ...\n"
1067 + comment_c Comments as "/*...*/"
1068 + digit Applies to all digit sub-classes
1069 + digit_hex Hexadecimal numbers
1070 + digit_integer Integer numbers
1071 + digit_float Floating point numbers
1072 + punct Applies to all punctuation sub-classes
1073 + punct_bracket_open_round Opening brackets"("
1074 + punct_bracket_close_round Closing brackets ")"
1075 + punct_listsep List item seperator ","
1076 + punct_qualifier Table/Column Qualifier "."
1077 + punct_queryend End of query marker ";"
1078 + alpha Applies to all alphabetic classes
1079 + alpha_columnType Identifiers matching a column type
1080 + alpha_columnAttrib Identifiers matching a
1081 database/table/column attribute
1082 + alpha_functionName Identifiers matching a MySQL function name
1083 + alpha_reservedWord Identifiers matching any other reserved
1085 + alpha_variable Identifiers matching a SQL variable "@foo"
1086 + alpha_identifier All other identifiers
1087 + quote Applies to all quotation mark classes
1088 + quote_double Double quotes "
1089 + quote_single Single quotes '
1090 + quote_backtick Backtick quotes `
1092 $cfg['SQLValidator']['use'] boolean
1093 phpMyAdmin now supports use of the Mimer SQL Validator service,
1094 as originally published on Slashdot.
1095 For help in setting up your system to use the service, see the
1098 $cfg['SQLValidator']['username'] string
1099 $cfg['SQLValidator']['password'] string
1100 The SOAP service allows you to login with anonymous and any
1101 password, so we use those by default.. Instead, if you have an
1102 account with them, you can put your login details here, and it
1103 will be used in place of the anonymous login.
1105 $cfg['DBG']['enable'] boolean
1107 Enable the DBG extension for debugging phpMyAdmin. Required for
1109 For help in setting up your system to this, see the Developers
1112 $cfg['DBG']['profile']['enable'] boolean
1114 Enable profiling support for phpMyAdmin. This will append a
1115 chunk of data to the end of every page displayed in the main
1116 window with profiling statistics for that page.
1117 You may need need to increase the maximum execution time for
1118 this to complete successfully.
1120 $cfg['DBG']['profile']['threshold'] float (units in milliseconds)
1122 When profiling data is displayed, this variable controls the
1123 threshold of display for any profiling data, based on the
1124 average time each time has taken. If it is over the threshold
1125 it is displayed, otherwise it is not displayed. This takes a
1126 value in milliseconds. In most cases you don't need to edit
1129 $cfg['ColumnTypes'] array
1130 All possible types of a MySQL column. In most cases you don't
1133 $cfg['AttributeTypes'] array
1134 Possible attributes for fields. In most cases you don't need to
1137 $cfg['Functions'] array
1138 A list of functions MySQL supports. In most cases you don't
1143 Introduction - Usage - File structure -
1147 To enable transformations, you have to setup the column_info table and
1148 the proper directives. Please see the Configuration section on how to
1151 You can apply different transformations to the contents of each field.
1152 The transformation will take the content of each field and transform
1153 it with certain rules defined in the selected transformation.
1155 Say you have a field 'filename' which contains a filename. Normally
1156 you would see in phpMyAdmin only this filename. Using transformations
1157 you can transform that filename into a HTML link, so you can click
1158 inside of the phpMyAdmin structure on the field's link and will see
1159 the file displayed in a new browser window. Using transformation
1160 options you can also specify strings to append/prepend to a string or
1161 the format you want the output stored in.
1163 For a general overview of all available transformations and their
1164 options, you can consult your
1165 <www.your-host.com>/<your-install-dir>/libraries/transformations/overv
1166 iew.php3 installation.
1170 Go to your tbl_properties.inc.php3 page (i.e. reached through clicking
1171 on the 'properties' link for a table). There you will see three new
1172 fields at the end of the line. They are called 'MIME-type', 'Browser
1173 transformation' and 'Transformation options'.
1174 * The field 'MIME-type' is a dropdown field. You have the options to
1175 leave that field empty or to use 'auto' [this feature is not yet
1176 available]. Please note that transformations are inactive as long
1177 as no mime-type is selected.
1178 * The field 'Browser transformation' is a drop-down field. You can
1179 choose from a hopefully growing amount of pre-defined
1180 transformations. See below for information on how to build your
1182 There are global transformations and mimetype-bound
1183 transformations. Global transformations can be used for any
1184 mimetype. They will take the mimetype, if necessary, into regard.
1185 Mimetype-bound transformations usually only operate on a certain
1186 mimetype. There are transformations which operate on the main
1187 mimetype (like 'image'), which will most likely take the subtype
1188 into regard, and those who only operate on a specific subtype
1189 (like 'image/jpeg').
1190 You can use transformations on mimetypes for which the function
1191 was not defined for. There is no security check for you selected
1192 the right transformation, so take care of what the output will be
1194 * The field 'Transformation options' is a free-type textfield. You
1195 have to enter transform-function specific options here. Usually
1196 the transforms can operate with default options, but it is
1197 generally a good idea to look up the overview to see which options
1199 Much like the ENUM/SET-Fields, you have to split up several
1200 options using the format 'a','b','c',...(NOTE THE MISSING BLANKS).
1201 This is because internally the options will be parsed as an array,
1202 leaving the first value the first element in the array, and so
1204 If you want to specify a MIME character set you can define it in
1205 the transformation_options. You have to put that outside of the
1206 pre-defined options of the specific mime-transform, as the last
1207 value of the set. Use the format "'; charset=XXX'". If you use a
1208 transform, for which you can specify 2 options and you want to
1209 append a character set, enter "'first parameter','second
1210 parameter','charset=us-ascii'". You can, however use the defaults
1211 for the parameters: "'','','charset=us-ascii'".
1215 All mimetypes and their transformations are defined through single
1216 files in the directory 'libraries/transformations/'.
1218 They are stored in files to ease up customization and easy adding of
1219 new transformations.
1221 Because the user cannot enter own mimetypes, it is kept sure that
1222 transformations always work. It makes no sense to apply a
1223 transformation to a mimetype, the transform-function doesn't know to
1226 One can, however, use empty mime-types and global transformations
1227 which should work for many mimetypes. You can also use transforms on a
1228 different mimetype they where built for, but pay attention to option
1229 usage as well as what the transformation does to your field.
1231 There is a basic file called 'global.inc.php3'. This function can be
1232 included by any other transform function and provides some basic
1235 There are 5 possible file names:
1236 1. A mimetype+subtype transform:
1237 [mimetype]_[subtype]__[transform].inc.php3
1238 Please not that mimetype and subtype are separated via '_', which
1239 shall not be contained in their names. The transform
1240 function/filename may contain only characters which cause no
1241 problems in the file system as well as the PHP function naming
1243 The transform function will the be called
1244 'PMA_transform_[mimetype]_[subtype]__[transform]()'.
1246 text_html__formatted.inc.php3
1247 PMA_transform_text_html__formatted()
1248 2. A mimetype (w/o subtype) transform:
1249 [mimetype]__[transform].inc.php3
1250 Please note that there are no single '_' characters. The transform
1251 function/filename may contain only characters which cause no
1252 problems in the file system as well as the PHP function naming
1254 The transform function will the be called
1255 'PMA_transform_[mimetype]__[transform]()'.
1257 text__formatted.inc.php3
1258 PMA_transform_text__formatted()
1259 3. A mimetype+subtype without specific transform function
1260 [mimetype]_[subtype].inc.php3
1261 Please note that there are no '__' characters in the filename. Do
1262 not use special characters in the filename causing problems with
1264 No transformation function is defined in the file itself.
1268 4. A mimetype (w/o subtype) without specific transform function
1270 Please note that there are no '_' characters in the filename. Do
1271 not use special characters in the filename causing problems with
1273 No transformation function is defined in the file itself.
1277 5. A global transform function with no specific mimetype
1278 global__[transform].inc.php3
1279 The transform function will the be called
1280 'PMA_transform_global__[transform]()'.
1283 PMA_transform_global__formatted()
1285 So generally use '_' to split up mimetype and subtype, and '__' to
1286 provide a transform function.
1288 All filenames containing no '__' in themselves are not shown as valid
1289 transform functions in the dropdown.
1291 Please see the libraries/transformations/TEMPLATE file for adding your
1292 own transform function. See the
1293 libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
1294 without a transform function. Also note the introduction of a function
1295 description in the language files. For each function a
1296 $strTransformation_[filename without .inc.php3] has to exist.
1298 You can use the template generator to generate new functions and
1299 entries in the language file.
1301 To create a new transform function please see
1302 libraries/transformations/template_generator.sh. To create a new,
1303 empty mimetype please see
1304 libraries/transformations/template_generator_mimetype.sh.
1306 FAQ - Frequently Asked Questions
1308 Server - Configuration - Limitations - Multi-user - Browsers
1309 - Usage tips - Project -
1313 [1.1] I'm running PHP 4+ and my server is crashing each time a specific
1314 action is required or phpMyAdmin sends a blank page or a page full of
1315 cryptic characters to my browser, what can I do?
1317 There are some known PHP bugs with output buffering and compression.
1318 Try to set the $cfg['OBGzip'] directive to FALSE in your
1319 config.inc.php or .php3 file and the zlib.output_compression directive
1320 to Off in your php configuration file.
1321 Furthermore, we know about such problems connected to the release
1322 candidates of PHP 4.2.0 (tested with PHP 4.2.0 RC1 to RC4) together
1323 with MS Internet Explorer. Please upgrade to the release version PHP
1326 [1.2] My Apache server crashes when using phpMyAdmin.
1328 You should first try the latest versions of Apache (and possibly
1330 See also the other FAQ entry about PHP bugs with output buffering.
1331 If your server keeps crashing, please ask for help in the various
1332 Apache support groups.
1334 [1.3] I'm running phpMyAdmin with "cookie" authentication mode under PHP
1335 4.2.0 or 4.2.1 loaded as an Apache 2+ module but can't enter the script:
1336 I'm always displayed the login screen.
1338 This is a known PHP bug (see this bug report) from the official PHP
1339 bug database. It means there is and won't be any phpMyAdmin fix
1340 against it because there is no way to code a fix.
1342 [1.4] Using phpMyAdmin on IIS, I'm displayed the error message: "The
1343 specified CGI application misbehaved by not returning a complete set of
1346 You just forgot to read the install.txt file from the php
1347 distribution. Have a look at the last message in this bug report from
1348 the official PHP bug database.
1350 [1.5] Using phpMyAdmin on IIS, I'm facing crashes and/or many error
1351 messages with the HTTP or advanced authentication mode.
1353 This is a known problem with the PHP ISAPI filter: it's not so stable.
1354 For some more information and complete testings see the messages
1355 posted by André B. aka "djdeluxe76" in this thread from the phpWizard
1357 Please use instead the cookie authentication mode.
1359 [1.6] I can't use phpMyAdmin on PWS: nothing is displayed!
1361 This seems to be a PWS bug. Filippo Simoncini found a workaround (at
1362 this time there is no better fix): remove or comment the DOCTYPE
1363 declarations (2 lines) from the scripts header.inc.php3,
1364 header_printview.inc.php3, index.php3, left.php3 and
1365 libraries/common.lib.php3.
1367 [1.7] How can I GZip or Bzip a dump or a CSV export. It does not seem to
1370 These features are based on the gzencode() and bzcompress() PHP
1371 functions to be more independent of the platform (Unix/Windows, Safe
1372 Mode or not, and so on). So, you must have PHP4 >= 4.0.4 and
1373 Zlib/Bzip2 support (--with-zlib and --with-bz2).
1374 We faced PHP crashes when trying to download a dump with MS Internet
1375 Explorer when phpMyAdmin is run with a release candidate of PHP 4.2.0.
1376 In this case you should switch to the release version of PHP 4.2.0.
1378 [1.8] I cannot insert a text file in a table, and I get an error about safe
1379 mode being in effect.
1381 Your uploaded file is saved by PHP in the "upload dir", as defined in
1382 php.ini by the variable upload_tmp_dir (usually the system default is
1384 We recommend the following setup for Apache servers running in safe
1385 mode, to enable uploads of files while being reasonably secure:
1386 * create a separate directory for uploads: mkdir /tmp/php
1387 * give ownership to the Apache server's user.group: chown
1388 apache.apache /tmp/php
1389 * give proper permission: chmod 600 /tmp/php
1390 * put upload_tmp_dir = /tmp/php in php.ini
1393 [1.9] I'm having troubles when uploading files. In general file uploads
1394 don't work on my system and uploaded files have a Content-Type: header in
1397 It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat
1398 7.0 and you updated your PHP RPM to php-4.0.4pl1-3.i386.rpm, didn't
1400 So the problem is that this package has a serious bug that was
1401 corrected ages ago in PHP (2001-01-28: see PHP's bug tracking system
1402 for more details). The problem is that the bugged package is still
1403 available though it was corrected (see RedHat's BugZilla for more
1405 So please download the fixed package (4.0.4pl1-9) and the problem
1407 And that fixes the \r\n problem with file uploads!
1409 [1.10] I'm having troubles when uploading files with phpMyAdmin running on
1410 a secure server. My browser is Internet Explorer and I'm using the Apache
1413 As suggested by "Rob M" in the phpWizard forum, add this line to your
1415 SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown
1416 It seems to clear up many problems between Internet Explorer and SSL.
1418 [1.11] I get an 'open_basedir restriction' while uploading a file from the
1421 Since version 2.2.4, phpMyAdmin supports servers with open_basedir
1422 restrictions. Assuming that the restriction allows you to open files
1423 in the current directory ('.'), all you have to do is create a 'tmp'
1424 directory under the phpMyAdmin install directory, with permissions 777
1425 and the same owner as the owner of your phpMyAdmin directory. The
1426 uploaded files will be moved there, and after execution of your SQL
1429 [1.12] I have lost my MySQL root password, what can I do?
1431 The MySQL manual explains how to reset the permissions.
1433 [1.13] I get an error 'No SQL query' when trying to execute a bookmark.
1435 If PHP does not have read/write access to its upload_tmp_dir, it
1436 cannot access the uploaded query.
1438 [1.14] I get an error 'No SQL query' when trying to submit a query from the
1439 convenient text area.
1441 Check the post_max_size directive from your PHP configuration file and
1444 [1.15] I have problems with mysql.user field names.
1446 In older MySQL versions, the User and Password fields were named user
1447 and password. Please modify your field names to align with current
1450 [1.16] I cannot upload big dump files.
1452 The first things to check (or ask your host provider to check) are the
1453 values of upload_max_filesize, memory_limit and post_max_size in the
1454 php.ini configuration file.
1455 All of these three settings limit the maximum size of data that can be
1456 submitted and handled by PHP. One user also said that post_max_size
1457 and memory_limit need to be larger than upload_max_filesize.
1459 [1.17] Does phpMyAdmin support MySQL 4.1?
1461 Because of a major change in the definition syntax of string field
1462 types, this version of phpMyAdmin probably won't work correctly with
1463 MySQL >= 4.1.0! We will work on the support as soon as MySQL 4.1.0 is
1466 [1.18] I'm running MySQL <= 4.0.1 having lower_case_table_names set to 1.
1467 If I create a new table with a capital letter in its name it is changed to
1468 lowercase as it should. But if I try to DROP this table MySQL is unable to
1469 find the corresponding file.
1471 This is a bug of MySQL <= 4.0.1. Please upgrade to at least
1472 MySQL 4.0.2 or turn off your lower_case_table_names directive.
1474 [1.19] I can't run the "display relations" feature because the script seems
1475 not to know the font face I'm using!
1477 The "FPDF" library we're using for this feature requires some special
1478 files to use font faces.
1479 Please refers to the FPDF manual to build these files.
1481 [1.20] I receive the error "cannot load MySQL extension, please check PHP
1484 To connect to a MySQL server, PHP needs a set of MySQL functions
1485 called "MySQL extension". This extension may be part of the PHP server
1486 (compiled-in), otherwise it needs to be loaded dynamically. Its name
1487 is probably mysql.so or mysql.dll. phpMyAdmin tried to load the
1488 extension but failed.
1489 Usually, the problem is solved by installing a software package called
1490 "PHP-MySQL" or something similar.
1492 [1.21] I am running the CGI version of PHP under Unix, and I cannot login
1495 In php.ini, set mysql.max_links higher than 1.
1497 [1.22] I don't see the "Location of text file" field, so I cannot upload.
1499 This is most likely because in php.ini, your file_uploads parameter is
1502 [1.23] I'm running MySQL on a Win32 machine. Each time I create a new table
1503 the table and field names are changed to lowercase!
1505 This happens because the MySQL directive lower_case_table_names
1506 defaults to 1 (ON) in the Win32 version of MySQL. You can change this
1507 behavior by simply changing the directive to 0 (OFF):
1508 Just edit you my.ini file that should be located in your Windows
1509 directory and add the following line to the group [mysqld]:
1510 set-variable = lower_case_table_names=0
1511 Next, save the file and restart the MySQL service. You can always
1512 check the value of this directive using the query
1513 SHOW VARIABLES LIKE 'lower_case_table_names';
1515 [1.24] Some characters are being truncated in my queries, or I get
1516 characters randomly added. I am running PHP 4.2.3.
1518 This is a PHP 4.2.3 bug.
1520 [1.25] I am running Apache with mod_gzip-1.3.26.1a on Windows XP, and I get
1521 problems, such as undefined variables when I run a SQL query.
1523 A tip from Jose Fandos: put a comment on the following two lines in
1524 httpd.conf, like this:
1525 # mod_gzip_item_include file \.php$
1526 # mod_gzip_item_include mime "application/x-httpd-php.*"
1527 as this version of mod_gzip on Apache (Windows) has problems handling
1528 PHP scripts. Of course you have to restart Apache.
1530 [1.26] I just installed phpMyAdmin in my document root of IIS but I get the
1531 error "No input file specified" when trying to run phpMyAdmin.
1533 This is a permission problem. Right-click on the phpmyadmin folder and
1534 choose properties. Under the tab Security, click on "Add" and select
1535 the user "IUSER_machine" from the list. Now set his permissions and it
1538 [1.27] I get empty page when I want to view huge page (eg.
1539 db_details_structure.php3 with plenty of dabases).
1541 This is a PHP bug that occur when GZIP output buffering enabled. If
1542 you turn off it (by $cfg['OBGzip'] = FALSE in config.inc.php3), it
1543 should work. This bug will be fixed in PHP 5.0.0.
1545 [1.28] My MySQL server sometimes refuses queries and returns the message
1546 'Errorcode: 13'. What does this mean?
1548 This can happen due to a MySQL bug when having database / table names
1549 with upper case characters although lower_case_table_names is set to
1550 1. To fix this, turn off this directive, convert all database and
1551 table names to lower case and turn it on again. Alternatively, there's
1552 a bug-fix available starting with MySQL 3.23.56 / 4.0.11-gamma.
1554 [1.29] When I create a table or modify a field, I get an error and the
1555 fields are duplicated.
1557 It is possible to configure Apache in such a way that PHP has problems
1558 interpreting .php files.
1559 The problems occur when two different (and conflicting) set of
1560 directives are used:
1564 AddType application/x-httpd-php .php
1565 In the case we saw, one set of directives was in httpd.conf, while the
1566 other set was in php.conf.
1567 The recommended way is with AddType, so just comment out the first set
1568 of lines and restart Apache:
1569 #SetOutputFilter PHP
1574 [2.1] The error message "Warning: Cannot add header information - headers
1575 already sent by ..." is displayed, what's the problem?
1577 Edit your config.inc.php or .php3 file and ensure there is nothing
1578 (I.E. no blank lines, no spaces, no characters...) neither before the
1579 <?php tag at the beginning, neither after the ?> tag at the end.
1581 [2.2] phpMyAdmin can't connect to MySQL. What's wrong?
1583 Either there is an error with your PHP setup or your username/password
1584 is wrong. Try to make a small script which uses mysql_connect and see
1585 if it works. If it doesn't, it may be you haven't even compiled MySQL
1588 [2.3] The error message "Warning: MySQL Connection Failed: Can't connect to
1589 local MySQL server through socket '/tmp/mysql.sock' (111)..." is displayed.
1592 For RedHat users, Harald Legner suggests this on the mailing list:
1593 On my RedHat-Box the socket of MySQL is /var/lib/mysql/mysql.sock. In
1594 your php.ini you will find a line
1595 mysql.default_socket = /tmp/mysql.sock
1597 mysql.default_socket = /var/lib/mysql/mysql.sock
1598 Then restart apache and it will work.
1599 Here is a fix suggested by Brad Ummer in the phpwizard forum:
1600 * First, you need to determine what socket is being used by MySQL.
1601 To do this, telnet to your server and go to the MySQL bin
1602 directory. In this directory there should be a file named
1603 mysqladmin. Type ./mysqladmin variables, and this should give you
1604 a bunch of info about your MySQL server, including the socket
1605 (/tmp/mysql.sock, for example).
1606 * Then, you need to tell PHP to use this socket.
1607 Assuming you are using PHP 3.0.10 or better, you can specify the
1608 socket to use when you open the connection. To do this in
1609 phpMyAdmin, you need to complete the socket information in the
1611 For example: $cfg['Servers'][$i]['socket'] = '/tmp/mysql.sock';
1613 Have also a look at the corresponding section of the MySQL
1616 [2.4] Nothing is displayed by my browser when I try to run phpMyAdmin, what
1619 Try to set the $cfg['OBGZip'] directive to FALSE in the phpMyAdmin
1620 configuration file. It helps sometime.
1621 Also have a look at your PHP version number: if it contains "4.0b..."
1622 it means you're running a beta version of PHP. That's not a so good
1623 idea, please upgrade to a plain revision.
1625 [2.5] Each time I want to insert or change a record or drop a database or a
1626 table, an error 404 (page not found) is displayed or, with HTTP or cookie
1627 authentication, I'm asked to login again. What's wrong?
1629 Check the value you set for the $cfg['PmaAbsoluteUri'] directive in
1630 the phpMyAdmin configuration file.
1632 [2.6] I get an "Access denied for user: 'root@localhost' (Using password:
1633 YES)"-error when trying to access a MySQL-Server on a host which is
1634 port-forwarded for my localhost
1636 When you are using a port on your localhost, which you redirect via
1637 port-forwarding to another host, MySQL is not resolving the localhost
1639 Erik Wasser explains: The solution is: if your host is "localhost"
1640 MySQL (the commandline tool 'mysql' as well) always tries to use the
1641 socket connection for speeding up things. And that doesn't work in
1642 this configuration with port forwarding.
1643 If you enter "127.0.0.1" as hostname, everything is right and MySQL
1644 uses the TCP connection.
1646 [3. Known limitations]
1648 [3.1] When using HTTP authentication, an user who logged out can not
1649 relogin in with the same nick.
1651 This is related to the authentication mechanism (protocol) used by
1652 phpMyAdmin. We plan to change it as soon as we may find enough free
1653 time to do it, but you can bypass this problem: just close all the
1654 opened browser windows and then go back to phpMyAdmin. You should be
1655 able to log in again.
1657 [3.2] When dumping a large table in compressed mode, I get a memory limit
1658 error or a time limit error.
1660 As of version 2.2.4, we build the compressed dump in memory, so large
1661 tables dumps may hang. The only alternative we can think about (using
1662 system calls to mysqldump then gzip or bzip2) would not be applicable
1663 in environments where PHP is in safe mode: access to system programs
1664 is is limited by the system administrator, and time limit is enforced.
1666 [3.3] With InnoDB tables, I lose foreign key relationships when I rename or
1669 This seems to be a InnoDB bug (fixed in MySQL 3.23.50?). However, keep
1670 in mind that phpMyAdmin as of version 2.3.0 does not support InnoDB.
1672 [3.4] I am unable to import dumps I created with the mysqldump tool bundled
1673 with the MySQL server distribution.
1675 The problem is that mysqldump creates invalid comments like this:
1678 -- Host: localhost Database: database
1679 ---------------------------------------------------------
1680 -- Server version 3.23.54
1682 The invalid part of the code is the horizontal line made of dashes
1683 that appears once in every dump created with mysqldump. If you want to
1684 run your dump you have to turn it into valid MySQL. This means, you
1685 have to add a whitespace after the first to dashes of the line or add
1687 -- -------------------------------------------------------
1689 #---------------------------------------------------------
1691 [4. ISPs, multi-user installations ]
1693 [4.1] I'm an ISP. Can I setup one central copy of phpMyAdmin or do I need
1694 to install it for each customer.
1696 Since version 2.0.3, you can setup a central copy of phpMyAdmin for
1697 all your users. The development of this feature was kindly sponsored
1698 by NetCologne GmbH. This requires a properly setup MySQL user
1699 management and phpMyAdmin HTTP or cookie authentication. See the
1700 install section on "Using HTTP authentication".
1702 [4.2] What's the preferred way of making phpMyAdmin secure against evil
1705 This depends on your system.
1706 If you're running a server which cannot be accessed by other people,
1707 it's sufficient to use the directory protection bundled with your
1708 webserver (with Apache you can use .htaccess files, for example).
1709 If other people have telnet access to your server, you should use
1710 phpMyAdmin's HTTP authentication feature.
1712 * Your config.inc.php3 file should be chmod 660.
1713 * All your phpMyAdmin files should be chown phpmy.apache, where
1714 phpmy is a user whose password is only known to you, and apache is
1715 the group under which Apache runs.
1716 * You should use PHP safe mode, to protect from other users that try
1717 to include your config.inc.php3 in their scripts.
1719 [4.3] I get errors about not being able to include a file in /lang or in
1722 Check php.ini, or ask your sysadmin to check it. The include_path must
1723 contain "." somewhere in it, and open_basedir, if used, must contain
1724 "." and "./lang" to allow normal operation of phpMyAdmin.
1726 [4.4] phpMyAdmin always gives "Access denied" when using HTTP
1729 This could happen for several reasons:
1730 * $cfg['Servers'][$i]['controluser'] and/or
1731 $cfg['Servers'][$i]['controlpass'] are wrong.
1732 * The username/password you specify in the login-dialog are invalid.
1733 * You have already setup a security mechanism for the
1734 phpMyAdmin-directory, eg. a .htaccess file. This would interfere
1735 with phpMyAdmin's authentication, so remove it.
1737 [4.5] Is it possible to let users create their own databases?
1739 Starting with 2.2.5, in the user management page, you can enter a
1740 wildcard database name for a user (for example "joe%"), and put the
1741 privileges you want. For example, adding SELECT, INSERT, UPDATE,
1742 DELETE, CREATE, DROP, INDEX, ALTER would let a user create/manage
1743 his/her database(s).
1745 [4.6] How can I use the Host-based authentication additions?
1747 If you have existing rules from an old .htaccess file, you can take
1748 them and add a username between the 'deny'/'allow' and 'from' strings.
1749 Using the username wildcard of '%' would be a major benefit here if
1750 your installation is suited to using it. Then you can just add those
1751 updated lines into the $cfg['Servers'][$i]['AllowDeny']['rules']
1753 If you want a pre-made sample, you can try this fragment. It stops the
1754 'root' user from logging in from any networks other than the private
1756 //block root from logging in except from the private networks
1757 $cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';
1758 $cfg['Servers'][$i]['AllowDeny']['rules'] = array(
1759 'deny root from all',
1760 'allow root from localhost',
1761 'allow root from 10.0.0.0/8',
1762 'allow root from 192.168.0.0/16',
1763 'allow root from 172.16.0.0/12',
1766 [5. Browsers or client OS]
1768 [5.1] I get an out of memory error, and my controls are non-functional,
1769 when trying to create a table with more than 14 fields.
1771 We could reproduce this problem only under Win98/98SE. Testing under
1772 WinNT4 or Win2K, we could easily create more than 60 fields.
1773 A workaround is to create a smaller number of fields, then come back
1774 to your table properties and add the other fields.
1776 [5.2] With Xitami 2.5b4, phpMyAdmin won't process form fields.
1778 This is not a phpMyAdmin problem but a Xitami known bug: you'll face
1779 it with each script/website that use forms.
1780 Upgrade or downgrade your Xitami server.
1782 [5.3] I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).
1784 With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except
1785 that the proposed file name for the dump is always 'tbl_dump.php'.
1786 Bzip2 dumps don't seem to work.
1787 With Konqueror 2.2.1: plain dumps work; zip dumps are placed into the
1788 user's temporary directory, so they must be moved before closing
1789 Konqueror, or else they disappear. GZip dumps give an error message.
1790 Testing needs to be done for Konqueror 2.2.2.
1792 [5.4] I can't use the cookie authentication mode because Internet Explorer
1793 never stores the cookies.
1795 MS Internet Explorer seems to be really buggy about cookies, at least
1796 till version 6. And thanks to Andrew Zivolup we've traced also a PHP
1797 4.1.1 bug in this area!
1798 Then, if you're running PHP 4.1.1, try to upgrade or downgrade... it
1801 [5.5] In Internet Explorer 5.0, I get JavaScript errors when browsing my
1804 Upgrade to at least Internet Explorer 5.5 SP2.
1806 [5.6] In Internet Explorer 5.0, 5.5 or 6.0, I get an error when trying to
1807 modify a row in a table with many fields, or with a text field
1809 Your table neither have a primary key nor an unique one, so we must
1810 use a long URL to identify this row. There is a limit on the length of
1811 the URL in those browsers, and this not happen in Netscape, for
1812 example. The workaround is to create a primary or unique key, or use
1815 [5.7] I refresh (reload) my browser, and come back to the welcome page.
1817 Some browsers support right-clicking into the frame you want to
1818 refresh, just do this in the right frame.
1820 [5.8] With Mozilla 0.9.7 I have problems sending a query modified in the
1823 Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
1826 [5.9] With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
1827 whitespace in the SQL-Query edit area: the page scrolls down.
1829 This is a Mozilla bug (see bug #26882 at BugZilla).
1831 [5.10] With Netscape 4.75 I get empty rows between each row of data in a
1834 This is a known Netscape 4.75 bug: it adds some line feeds when
1835 exporting data in octet-stream mode. Since we can't detect the
1836 specific Netscape version, we cannot workaround this bug.
1838 [5.11] Extended-ASCII characters like German umlauts are displayed wrong.
1840 Please ensure that you have set your browser's character set to the
1841 one of the language file you have selected on phpMyAdmin's start page.
1842 Alternatively, you can try the auto detection mode that is supported
1843 by the recent versions of the most browsers.
1845 [5.12] Apple OS X: Safari browser changes special characters to "?".
1847 This issue has been reported by a OS X user, who adds that Chimera,
1848 Netscape and Mozilla do not have this problem.
1850 [5.13] With Internet Explorer 5.5 or 6, and HTTP authentication type, I
1851 cannot manage two servers: I login to the first one, then the other one,
1852 but if I switch back to the first, I have to login on each operation.
1854 This is a bug in Internet Explorer, other browsers do not behave this
1857 [6. Using phpMyAdmin]
1859 [6.1] I can't insert new rows into a table / I can't create a table - MySQL
1860 brings up a SQL-error.
1862 Examine the SQL error with care. Often the problem is caused by
1863 specifying a wrong field-type.
1864 Common errors include:
1865 * Using VARCHAR without a size argument
1866 * Using TEXT or BLOB with a size argument
1868 Also, look at the syntax chapter in the MySQL manual to confirm that
1869 your syntax is correct.
1871 [6.2] When I create a table, I click the Index checkbox for 2 fields and
1872 phpMyAdmin generates only one index with those 2 fields.
1874 In phpMyAdmin 2.2.0 and 2.2.1, this is the way to create a
1875 multi-fields index. If you want two indexes, create the first one when
1876 creating the table, save, then display the table properties and click
1877 the Index link to create the other index.
1879 [6.3] How can I insert a null value into my table?
1881 Since version 2.2.3, you have a checkbox for each field that can be
1882 null. Before 2.2.3, you had to enter "null", without the quotes, as
1885 [6.4] How can I backup my database or table?
1887 Click on a database or table name in the left frame, the properties
1888 will be displayed. Then on the menu, click "Export", you can dump the
1889 structure, the data, or both. This will generate standard SQL
1890 statements that can be used to recreate your database/table.
1891 You will need to choose "Save as file", so that phpMyAdmin can
1892 transmit the resulting dump to your station. Depending on your PHP
1893 configuration, you will see options to compress the dump. See also the
1894 $cfg['ExecTimeLimit'] configuration variable.
1895 For additional help on this subject, look for the word "dump" in this
1898 [6.5] How can I restore (upload) my database or table using a dump? How can
1899 I run a ".sql" file.
1901 Click on a database name in the left frame, the properties will be
1902 local displayed. Then in the "Run SQL query" section, type in your
1903 dump filename, or use the Browse button. Then click Go.
1904 For additional help on this subject, look for the word "upload" in
1907 [6.6] How can I use the relation table in Query-by-example?
1909 Here is an example with the tables persons, towns and countries, all
1910 located in the database mydb. If you don't have a PMA_relation table,
1911 create it as explained in the configuration section. Then create the
1913 CREATE TABLE REL_countries (
1914 country_code char(1) NOT NULL default '',
1915 description varchar(10) NOT NULL default '',
1916 PRIMARY KEY (country_code)
1918 INSERT INTO REL_countries VALUES ('C', 'Canada');
1919 CREATE TABLE REL_persons (
1920 id tinyint(4) NOT NULL auto_increment,
1921 person_name varchar(32) NOT NULL default '',
1922 town_code varchar(5) default '0',
1923 country_code char(1) NOT NULL default '',
1926 INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');
1927 INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');
1928 CREATE TABLE REL_towns (
1929 town_code varchar(5) NOT NULL default '0',
1930 description varchar(30) NOT NULL default '',
1931 PRIMARY KEY (town_code)
1933 INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');
1934 INSERT INTO REL_towns VALUES ('M', 'Montréal');
1935 To setup appropriate links and display information:
1936 * on table "REL_persons" click Structure, then Relation view
1937 * in Links, for "town_code" choose "REL_towns->code"
1938 * in Links, for "country_code" choose "REL_countries->country_code"
1939 * on table "REL_towns" click Structure, then Relation view
1940 * in "Choose field to display", choose "description"
1941 * repeat the two previous steps for table "REL_countries"
1943 Then test like this:
1944 * Click on your db name in the left frame
1946 * Use tables: persons, towns, countries
1947 * Click "Update query"
1948 * In the fields row, choose persons.person_name and click the "Show"
1950 * Do the same for towns.description and countries.descriptions in
1952 * Click "Update query" and you will see in the query box that the
1953 correct joins have been generated
1954 * Click "Submit query"
1956 [6.7] How can I use the "display field" feature?
1958 Starting from the previous example, create the PMA_table_info as
1959 explained in the configuration section, then browse your persons
1960 table, and move the mouse over a town code or country code.
1962 [6.8] How can I produce a PDF schema of my database?
1964 First you have to fill the "relation", "table_coords" and "pdf_pages"
1965 configuration variables.
1966 Then, think about your schema layout: which tables will go on which
1968 * Click on your db name in the left frame
1969 * Choose "Structure" in the navigation on top
1970 * Choose "Edit PDF Pages" which should be somewhere at the bottom of
1972 * Enter the name for a first pdf page and submit
1973 * Choose this page to edit
1974 * Now add a table you want to show on this page and it's coordinates
1976 First you will have to guess this coordinates of course, so just
1977 expect to have an area of about 297 * 210 and put the tables
1978 coordinates somewhere in there, you will be able to have a look at
1979 what happened and change them later.
1980 For example, x=100 and y=200 means that the table will be at 200
1981 mm down and 100 mm right from the upper left corner.
1982 Actually if you have a width of more than 300 or a height of more
1983 than 200 than it will automatically be scaled but 300*100 is a
1984 good start to have an idea of what coordinates to use.
1985 * After every table you submitted you will have the possibility to
1987 * When you have entered enough tables Click on your db name in the
1989 * Now, again at the bottom of the page you should be able to choose
1990 "Display PDF schema"
1991 For testing it might be useful to show the grid as well, so you
1992 can see the coordinates used.
1993 Maybe also choose color and submit.
1994 * Save the file he will offer you to something like Schema.pdf
1995 (Internet Explorer has some bug there which might make it offer it
1996 without an extension. Under Windows it is important to have the
1997 extension ".pdf", under other OSes you should be fine just saving
1998 the file under the name it offers).
2000 [6.9] phpMyAdmin is changing the type of one of my columns!
2002 No, it's MySQL that is doing silent column type changing.
2004 [6.10] My database has an underscore in it's name, and when I grant
2005 privileges to a user for this database, a backslash is added before the
2008 This is normal and means that the grant is done only for this
2009 database. If there was no backslash, this would be a wildcard grant,
2010 and the underscore would mean "any character". So, if the database
2011 name is "john_db", the user would get rights to john1db, john2db...
2012 instead of just john_db.
2013 If you really want to grant using a wildcard, there is a dialog box "
2014 Database (wildcards allowed)" for this.
2016 [6.11] What is the curious symbol ø in the statistics pages?
2020 [6.12] I want to understand some Export options.
2022 "Complete inserts" adds the column names on every INSERT command, for
2023 better documentation (but resulting file is bigger).
2024 "Extended inserts" provides a shorter dump file by using only once the
2025 INSERT verb and the table name.
2026 "Enclose table and field names with backquotes" ensures that field and
2027 table names formed with special characters are protected.
2028 "Include column comments as inline SQL-comments" includes any column
2029 comments set in the PMA-DB in the dump as SQL comments (/* xxx */).
2031 [6.13] I would like to create a database with a dot in its name.
2033 This is a bad idea, because in MySQL the syntax "database.table" is
2034 the normal way to reference a database and table name. Worse, MySQL
2035 will usually let you create a database with a dot, but then you cannot
2036 work with it, nor delete it.
2038 [6.14] How do I set up the SQL Validator?
2040 To use it, you need a very recent version of PHP, 4.3.0 recommended,
2041 with XML, PCRE and PEAR support. On your system command line, run
2042 "pear install Net_Socket Net_URL HTTP_Request Mail_Mime Net_DIME SOAP"
2043 to get the necessary PEAR modules for usage.
2044 If you use it, you should be aware that any SQL statement you submit
2045 will be stored anonymously (database/table/column names, strings,
2046 numbers replaced with generic values). The Mimer SQL Validator itself,
2047 is © 2001 Upright Database Technology. We utilize it as free SOAP
2050 [6.15] I want to add a BLOB field and put an index on it, but MySQL says
2051 "BLOB column '...' used in key specification without a key length".
2053 The right way to do this, is to create the field without any indexes,
2054 then display the table structure and use the "Create an index" dialog.
2055 On this page, you will be able to choose your BLOB field, and set a
2056 size to the index, which is the condition to create an index on a BLOB
2059 [6.16] How can I simply move in page with plenty editing fields?
2061 You can use Ctrl+arrows for moving on most pages with plenty editing
2062 fields (table structure changes, row editing, etc.). You can also have
2063 a look at the directive $cfg['DefaultPropDisplay'] ('vertical') and
2064 see if this eases up editing for you.
2066 [6.17] Transformations: I can't enter my own mimetype! WTF is this feature
2069 Slow down :). Defining mimetypes is of no use, if you can't put
2070 transformations on them. Otherwise you could just put a comment on the
2071 field. Because entering your own mimetype will cause serious syntax
2072 checking issues and validation, this introduces a high-risk
2073 false-user-input situation. Instead you have to initialize mimetypes
2074 using functions or empty mimetype definitions.
2075 Plus, you have a whole overview of available mimetypes. Who knows all
2076 those mimetypes by heart so he/she can enter it at will?
2078 [6.17] Bookmarks: Where can I store bookmarks? Why can't I see any
2079 bookmarks below the query box? What is this variable for?
2081 Any query you have executed can be stored as a bookmark on the page
2082 where the results are displayed. You will find a button labeled
2083 'Bookmark this query' just at the end of the page.
2084 As soon as you have stored a bookmark, it is related to the database
2085 you run the query on. You can now access a bookmark dropdown on each
2086 page, the query box appears on for that database.
2087 Since phpMyAdmin 2.5.0 you are also able to store variables for the
2088 bookmarks. Just use the string /*[VARIABLE]*/ anywhere in your query.
2089 Everything which is put into the value input box on the query box page
2090 will replace the string "/*[VARIABLE]*/" in your stored query. Just be
2091 aware of that you HAVE to create a valid query, otherwise your query
2092 won't be even able to be stored in the database.
2093 Also remember, that everything else inside the /*[VARIABLE]*/ string
2094 for your query will remain the way it is, but will be stripped of the
2095 /**/ chars. So you can use:
2096 /*, [VARIABLE] AS myname */
2097 which will be expanded to
2098 , VARIABLE as myname
2099 in your query, where VARIABLE is the string you entered in the input
2100 box. If an empty string is provided, no replacements are made.
2101 A more complex example. Say you have stored this query:
2102 SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE
2104 Say, you now enter "phpMyAdmin" as the variable for the stored query,
2105 the full query will be:
2106 SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE
2108 You can use multiple occurences of /*[VARIABLE]*/ in a single query.
2109 NOTE THE ABSENCE OF SPACES inside the "/**/" construct. Any spaces
2110 inserted there will be later also inserted as spaces in your query and
2111 may lead to unexpected results especially when using the variable
2112 expansion inside of a "LIKE ''" expression.
2113 Your initial query which is going to be stored as a bookmark has to
2114 yield at least one result row so you can store the bookmark. You may
2115 have that to work around using well positioned "/**/" comments.
2117 [7. phpMyAdmin project]
2119 [7.1] I have found a bug. How do I inform developers?
2121 Our Bug Tracker is located at
2122 http://sourceforge.net/projects/phpmyadmin/ under the Bugs section.
2123 But please first discuss your bug with other users:
2124 http://sourceforge.net/projects/phpmyadmin/ (and choose Forums)
2126 [7.2] I want to translate the messages to a new language or upgrade an
2127 existing language, where do I start?
2129 Always use the current CVS version of your language file. For a new
2130 language, start from english-iso-8859-1.inc.php3. If you don't know
2131 how to get the CVS version, please ask one of the developers.
2132 Please note that we try not to use HTML entities like é in the
2133 translations, since we define the right character set in the file.
2134 With HTML entities, the text on JavaScript messages would not display
2135 correctly. However there are some entities that need to be there, for
2136 quotes ,non-breakable spaces, ampersands, less than, greater than.
2137 You can then put your translations, as a zip file to avoid losing
2138 special characters, on the sourceforge.net translation tracker.
2139 It would be a good idea to subscribe to the phpmyadmin-translators
2140 mailing list, because this is where we ask for translations of new
2143 [7.3] I would like to help out with the development of phpMyAdmin. How
2146 The following method is preferred for new developers:
2147 1. fetch the current CVS tree over anonymous CVS:
2149 -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmy
2151 [Password: simply press the Enter key]
2153 -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmy
2154 admin checkout phpMyAdmin
2155 [This will create a new sub-directory named phpMyAdmin]
2157 3. put the modified files (tar'ed and gzip'ed) inside the patch
2158 tracker of the phpMyAdmin SourceForge account.
2160 Write access to the CVS tree is granted only to experienced developers
2161 who have already contributed something useful to phpMyAdmin.
2162 Also, have a look at the Developers section.
2164 Developers Information
2166 phpMyAdmin is Open Source, so you're invited to contribute to it. Many
2167 great features have been written by other people and you too can help
2168 to make phpMyAdmin a useful tool.
2170 If you're planning to contribute source, please read the following
2172 * All files include header.inc.php3 (layout),
2173 libraries/common.lib.php3 (common functions) and config.inc.php3.
2174 All configuration data belongs in config.inc.php3. Please keep it
2175 free from other code.
2176 Commonly used functions should be added to
2177 libraries/common.lib.php3 and more specific ones may be added
2178 within a library stored into the libraries sub-directory.
2179 * Obviously, you're free to use whatever coding style you want. But
2180 please try to keep your code as simple as possible: beginners are
2181 using phpMyAdmin as an example application.
2182 As far as possible, we want the scripts to be XHTML1.0 and CSS2
2183 compliant on one hand, they fit the PEAR coding standards on the
2184 other hand. Please pay attention to this.
2185 * Please try to keep up the file-naming conventions. Table-related
2186 stuff goes to tbl_*.php3, db-related code to db_*.php3,
2187 server-related tools to server_*.php3 and so on.
2188 * Please don't use verbose strings in your code, instead add the
2189 string (at least) to english-iso-8859-1.inc.php3 and print() it
2191 * If you want to be really helpful, write an entry for the
2193 * The DBG extension (PHP Debugger DBG) is now supported by
2194 phpMyAdmin for developers to better debug and profile their code.
2195 Please see the $cfg['DBG']* configuration options for more
2197 This is in memoriam of the Space Shuttle Columbia (STS-107) which
2198 was lost during its re-entry into Earth's atmosphere and in memory
2199 of the brave men and women who gave their lives for the people of
2205 phpMyAdmin - Credits
2206 ====================
2208 CREDITS, in chronological order
2209 -------------------------------
2211 - Tobias Ratschiller <tobias.ratschiller_at_maguma.com>
2212 * creator of the phpmyadmin project
2213 * maintainer from 1998 to summer 2000
2215 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca>
2216 * multi-language version
2217 * various fixes and improvements
2218 * project co-administrator
2220 - Olivier Müller <om_at_omnis.ch>
2221 * started SourceForge phpMyAdmin project in March 2001
2222 * sync'ed different existing CVS trees with new features and bugfixes
2223 * multi-language improvements, dynamic language selection
2224 * current project maintainer
2225 * many bugfixes and improvements
2227 - Loïc Chapeaux <lolo_at_phpheaven.net>
2228 * rewrote and optimized javascript, DHTML and DOM stuff
2229 * rewrote the scripts so they fit the PEAR coding standards and
2230 generate XHTML1.0 and CSS2 compliant codes
2231 * improved the language detection system
2232 * many bugfixes and improvements
2234 - Robin Johnson <robbat2_at_users.sourceforge.net>
2235 * database maintence controls
2237 * Host authentication IP Allow/Deny
2238 * DB-based configuration (Not completed)
2241 * many bugfixes and improvements
2243 - Armel Fauveau <armel.fauveau_at_globalis-ms.com>
2245 * multiple dump feature
2249 - Geert Lund <glund_at_silversoft.dk>
2251 * moderator of the phpMyAdmin users forum at phpwizard.net
2253 - Korakot Chaovavanich <korakot_at_iname.com>
2254 * "insert as new row" feature
2256 - Pete Kelly <webmaster_at_trafficg.com>
2257 * rewrote and fix dump code
2260 - Steve Alberty <alberty_at_neptunlabs.de>
2261 * rewrote dump code for PHP4
2262 * mySQL table statistics
2265 - Benjamin Gandon <gandon_at_isia.cma.fr>
2266 * main author of the version 2.1.0.1
2269 - Alexander M. Turek <rabus_at_bugfixes.info>
2271 * MySQL 4 related features
2272 * various small features and fixes
2273 * German language file updates
2275 - Mike Beck <mike.beck_at_ibmiller.de>
2276 * automatic joins in QBE
2277 * links column in printview
2280 - Michal Cihar <nijel_at_users.sourceforge.net>
2281 * enhanced index creation/display feature
2282 * feature to use a different charset for HTML than for MySQL
2283 * Czech language file updates
2285 - Christophe Gesché from the "MySQL Form Generator for PHPMyAdmin"
2286 (http://sourceforge.net/projects/phpmysqlformgen/)
2287 * suggested the patch for multiple table printviews
2289 - Garvin Hicking <hicking_at_faktor-e.de>
2290 * built the patch for vertical display of table rows
2291 * built the Javascript based Query window + SQL history
2292 * Improvement of column/db comments
2293 * (MIME)-Transformations for columns
2294 * Use custom alias names for Databases in left frame
2295 * vertical display of column properties page
2296 * some bugfixes, smaller features
2298 - Yukihiro Kawada <kawada_at_den.fujifilm.co.jp>
2299 * japanese kanji encoding conversion feature
2301 - Piotr Roszatycki <d3xter_at_users.sourceforge.net> and Dan Wilson
2302 * the Cookie authentication mode
2304 - Axel Sander <n8falke_at_users.sourceforge.net>
2305 * table relation-links feature
2307 - Maxime Delorme <delorme.maxime_at_free.fr>
2308 * PDF schema output, thanks also to Olivier Plathey for the
2309 "FPDF" library (see http://www.fpdf.org/).
2311 - Olof Edlund <olof.edlund_at_upright.se>
2312 * SQL validator server
2314 - Ivan R. Lanin <ivanlanin_at_users.sourceforfe.net>
2317 And also to the following people who have contributed minor changes,
2318 enhancements, bugfixes or support for a new language since version 2.1.0:
2320 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
2321 Péter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
2322 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kläger,
2323 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
2324 Bernard M. Piller, Laurent Haas, "Sakamoto", Yuval Sarna,
2325 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
2326 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
2327 Luís V., Martijn W. van der Lee,
2328 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
2329 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, "Manuzhai".
2332 Original Credits of Version 2.1.0
2333 ---------------------------------
2335 This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
2336 to create a web-based interface to MySQL using PHP3. Although I have not
2337 used any of his source-code, there are some concepts I've borrowed from
2338 him. phpMyAdmin was created because Peter told me he wasn't going to
2339 further develop his (great) tool.
2341 - Amalesh Kempf <ak-lsml_at_living-source.com> who contributed the
2342 code for the check when dropping a table or database. He also suggested
2343 that you should be able to specify the primary key on tbl_create.php3. To
2344 version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
2345 well as a bug-report. Plus many smaller improvements.
2346 - Jan Legenhausen <jan_at_nrw.net>: He made many of the changes that
2347 were introduced in 1.3.0 (including quite significant ones like the
2348 authentication). For 1.4.1 he enhanced the table-dump feature. Plus
2350 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca> made phpMyAdmin
2351 language-independent by outsourcing the strings to a separate file. He
2352 also contributed the French translation.
2353 - Alexandr Bravo <abravo_at_hq.admiral.ru> who contributed
2354 tbl_select.php3, a feature to display only some fields from a table.
2355 - Chris Jackson <chrisj_at_ctel.net> added support for MySQL
2356 functions in tbl_change.php3. He also added the
2357 "Query by Example" feature in 2.0.
2358 - Dave Walton <walton_at_nordicdms.com> added support for multiple
2359 servers and is a regular contributor for bug-fixes.
2360 - Gabriel Ash <ga244_at_is8.nyu.edu> contributed the random access
2362 The following people have contributed minor changes, enhancements, bugfixes
2363 or support for a new language:
2364 Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
2365 Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
2366 Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
2369 And thanks to everyone else who sent me email with suggestions, bug-reports
2370 and or just some feedback.
2372 Valid XHTML 1.0! Valid CSS!