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