| blob | ec1c5a8b1bb4f65af2fd5ce40e13caa2192cb763 |
4 <!-- $Id$ -->
5 <!--
6 vim: expandtab ts=4 sw=4 sts=4 tw=78
7 -->
9 <head>
13 </head>
15 <body>
25 <br />
32 </div>
37 <!-- TOP MENU -->
38 <ul>
39 <li>
41 SourceForge phpMyAdmin project page [ http://www.phpmyadmin.net/ ]
42 </a>
43 </li>
44 <li>
45 Local documents:
46 <ul>
50 </ul>
51 </li>
52 <li>
53 Documentation version:
55 </li>
56 </ul>
59 <!-- REQUIREMENTS -->
63 <ul>
64 <li>
65 PHP3, PHP4 or PHP5: phpMyAdmin widely uses the 'str_replace()' PHP
72 If you want to display inline thumbnails of JPEGs with the original
73 aspect ratio, you also need GD2 support in PHP.
74 </li>
75 <li>
77 </li>
78 <li>
79 a web-browser (doh!).
80 </li>
81 </ul>
84 <!-- INTRODUCTION -->
88 <p>
89 phpMyAdmin can manage a whole MySQL server (needs a super-user) as well as
90 a single database. To accomplish the latter you'll need a properly set up
91 MySQL user who can read/write only the desired database. It's up to you to
92 look up the appropriate part in the MySQL manual.<br />
93 Currently phpMyAdmin can:
94 </p>
96 <ul>
109 <li>using Query-by-example (QBE), create complex queries automatically connecting required tables</li>
112 <li>transform stored data into any format using a set of predefined functions,
113 like displaying BLOB-data as image or download-link or ...</li>
115 <li>
116 communicate in
118 </li>
119 </ul>
122 (*)
123 phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats) dumps
126 </p>
129 <!-- INSTALLATION -->
133 <p>
135 methods to the MySQL database server. It is still the system administrator's job to
136 grant permissions on the MySQL databases properly. </span>phpMyAdmin's
138 </p>
140 <p>
142 version before OS X, StuffIt unstuffs with Mac formats.<br />
143 So you'll have to resave as in BBEdit to Unix style ALL phpMyAdmin scripts
144 before uploading them to your server, as PHP seems not to like Mac-style
146 </p>
148 <p>
151 if you are using a kit with files having this extension.
152 </p>
155 <ol>
156 <li> Choose and download a distribution kit with the files having the
158 web/PHP server interprets those extensions.</li>
159 <li> Untar or unzip the distribution (be sure to unzip the subdirectories):
161 document root. If you don't have direct access to your document root,
162 put the files in a directory on your local machine, and, after step 3,
163 transfer the directory on your web server using, for example, ftp.</li>
164 <li> Open the file config.inc.php3 in your favorite editor and change
165 the values for host, user, password and authentication mode to fit
168 Have a look at
170 explanation of all values.</li>
171 <li> It is recommended that you protect the directory in which you
172 installed phpMyAdmin (unless it's on a closed intranet, or you wish to
173 use HTTP or cookie authentication), for example with HTTP-AUTH (in a
176 information.</li>
177 <li> Open the file
179 in your browser. phpMyAdmin should now display a welcome screen
180 and your databases, or a login dialog if using HTTP or cookie
181 authentication mode.</li>
182 <li> For a whole set of new features (bookmarks, comments, SQL-history, PDF-generation, field contents transformation, etc.)
183 you need to create a set of tables in your database. Please look at your scripts/
185 (If you are using a Windows server, pay special attention to FAQ 1.23).
186 You can already use your phpMyAdmin to create the tables for you. Please be
187 aware that you may have to have special (administrator) privileges to create
189 you should specify the table names in your config.inc.php3 file. The directives
192 </ol>
195 <ul>
196 <li>Please do not copy your older config.inc.php3 over the new one: it may
197 offer new configuration variables, and the new version may depend on
198 these for normal behavior. It is suggested instead to insert your site
199 values in the new one.</li>
200 </ul>
203 <ul>
205 environment</b> where you want to give users access to their own
206 database and don't want them to play around with others.
207 <br />
208 Nevertheless be aware that MS Internet Explorer seems to be really
210 bit buggy in this area!<br />
212 HTTP or cookie mode so that your user/password pair are not in clear
213 in the configuration file.<br /><br /></li>
215 <li>HTTP and cookie authentication modes are more secure: the MySQL
216 password does not need to be set in the phpMyAdmin configuration file
219 <br />
220 However, keep in mind that the password travels in plain text, unless
221 you are using the HTTPS protocol.
222 <br />
223 In cookie mode, the password is stored, encrypted with the blowfish
224 algorithm, in a temporary cookie.
225 <br /><br /></li>
227 <li>
228 For 'HTTP' and 'cookie' modes, phpMyAdmin needs a controluser that has
233 must specify the details for the controluser in the
239 only an example: use something else in your file!</b><br /> Of course
241 not the same as the MySQL server's one.
242 <pre>
244 GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY 'pmapass';
245 GRANT SELECT (
246 Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
247 Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
248 File_priv, Grant_priv, References_priv, Index_priv, Alter_priv,
249 Show_db_priv, Super_priv, Create_tmp_table_priv, Lock_tables_priv,
250 Execute_priv, Repl_slave_priv, Repl_client_priv
251 ) ON mysql.user TO 'pma'@'localhost';
252 GRANT SELECT ON mysql.db TO 'pma'@'localhost';
253 GRANT SELECT ON mysql.host TO 'pma'@'localhost';
254 GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv)
255 ON mysql.tables_priv TO 'pma'@'localhost';
256 </pre>
257 If you are using an old MySQL version (below 4.0.2), please use this
258 query instead of the second one:
259 <pre>
261 GRANT SELECT (
262 Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
263 Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
264 File_priv, Grant_priv, References_priv, Index_priv, Alter_priv
265 ) ON mysql.user TO 'pma'@'localhost';
266 </pre>
267 ... and if you want to use the many new relation and bookmark
268 features:
269 <pre>
272 </pre>
273 (this of course requires you to have a special DB for phpMyAdmin, the
274 contents will be explained later)<br />
275 Of course, the above queries only work if your MySQL version supports
276 the GRANT command. This is the case since 3.22.11.
277 </li>
278 <li>
280 privileges on a set of particular databases. Normally you shouldn't
281 give global privileges to an ordinary user, unless you understand
282 the impact of those privileges (for example, you are creating
283 a superuser).<br />
286 <tt>GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost IDENTIFIED BY 'real_password';</tt>
287 <br />
288 What the user may now do is controlled entirely by the MySQL user
289 management system.<br />
290 With HTTP or cookie authentication mode, you don't need to fill the
292 </li>
293 </ul>
296 <ul>
299 allows you to login as any valid MySQL user.</li>
300 <li>Is only supported with PHP running as an Apache module, not with
301 CGI.</li>
302 </ul>
305 <ul>
306 <li>You can use this method as a replacement for the HTTP
307 authentication (for example, if you're running IIS).
308 </li>
310 <li>With this mode, the use can truly logout of phpMyAdmin and login back
311 with the same username.</li>
312 <li>If you want to login to arbitrary server see
314 </ul>
317 <ul>
318 <li>This mode is the less secure one because it requires you to fill the
323 <li>In the ISP FAQ section, there is an entry explaining how to protect
324 your configuration file.<br /></li>
325 <li>For additional security in this mode, you may wish to consider the
328 directives.</li>
329 </ul>
332 <!-- CONFIGURATION -->
336 <p>
339 the option that allows to use the *nix end of line character
341 you have modified.
342 </p>
345 <dl>
347 <dd>
348 Sets here the complete URL (with full path) to your phpMyAdmin version.
350 <br /><br />
351 phpMyAdmin needs this setting, because of requirements of the HTTP
352 protocol, explained in RFC2616, section 14.30.
353 <br /><br />
354 Don't forget the slash at the end of your URL. The URL must contain
355 characters that are valid for a URL, and on some servers, the path
356 is case-sensitive.
357 <br /><br />
358 Starting with version 2.3.0, you can try to leave this parameter
359 empty, because the program tries to auto-detect its proper value.
360 Additional details are in the configuration file.
361 <br /><br />
362 Alternatively, this setting can be dynamically completed. For example,
363 you can try to use such a kind of code:
364 <pre>
365 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
366 . $_SERVER['HTTP_HOST']
367 . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
370 or
372 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
373 . $_SERVER['SERVER_NAME']
374 . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
376 </pre>
380 <br /><br />
381 </dd>
383 <dd>
384 By default, when you leave $cfg['PmaAbsoluteUri'] empty, and the system
385 detects your absolute URI automatically, we display a warning to remind
386 you. If you have tested the automatic detection, and it works perfectly
387 for your setup, then you can set this variable to squelch the warning.
388 <br /><br />
389 </dd>
392 <dd>
393 Starting with version 2.3.0 phpMyAdmin offers a lot of features to work
394 with master / foreign - tables (see
396 <br />
397 If you tried to set this up and it does not work for you, have a look on
399 use it. You will find a link that will analyze why those features have
400 been disabled.<br />
401 If you do not want to use those features set this variable to
403 <br /><br />
404 </dd>
407 <dd>
408 Starting with version 2.5.2, the 'cookie' auth_type uses blowfish
409 algorithm to encrypt the password.
410 <br />
411 If at least one server configuration uses 'cookie' auth_type, enter
412 here a passphrase that will be used by blowfish.
413 </dd>
416 <dd>
417 Since version 1.4.2, phpMyAdmin supports the administration of multiple
418 MySQL servers.
419 Therefore, a $cfg['Servers']-array has been added which contains
420 the login information for the different servers. The first
423 the second server, etc.
424 If you have only one server to administer, simply leave free the
425 hostname of the other $cfg['Server']-entries.
426 <br /><br />
427 </dd>
430 <dd>
431 The hostname or IP address of your $i-th MySQL-server. E.g. localhost.
432 <br /><br />
433 </dd>
436 <dd>
437 The port-number of your $i-th MySQL-server. Default is 3306 (leave
439 ignores this port number and connects with the socket, so if you want
440 to connect to a port different from the default port, use
442 $cfg['Servers'][$i]['host'].
443 <br /><br />
444 </dd>
447 <dd>
448 The path to the socket to use. Leave blank for default.<br />
449 To use the socket feature you must run PHP 3.0.10 or more.
450 <br /><br />
451 </dd>
454 <dd>
455 What type connection to use with the MySQL server. Your options are
457 is nearly guaranteed to be available on all MySQL servers, while
458 sockets are not supported on some platforms.
459 <br /><br />
460 To use the socket mode, your MySQL server must be on the same machine
461 as the Web server.
462 <br /><br />
463 </dd>
466 <dd>
467 Whether to use a compressed protocol for the MySQL server connection
468 or not (experimental).<br />
470 </dd>
472 <dt>
475 </dt>
476 <dd>
477 When using HTTP or cookie authentication modes (or 'config'
478 authentication mode since phpMyAdmin 2.2.1), you need to supply the
483 This account is used to check what databases the user will see at
484 login.
485 <br />
488 <br /><br />
489 Note that if you try login to phpMyAdmin with this
493 <br /><br />
494 In versions before 2.2.5, those were called
496 <br /><br />
497 </dd>
501 <dd>
502 Whether config or cookie or http authentication should be used for this
503 server.
505 <ul>
506 <li>
507 'config' authentication
509 way: username and password are stored in
511 </li>
512 <li>
513 'cookie' authentication mode
515 2.2.3 allows you to log in as any valid MySQL user with the
516 help of cookies. Log name and password are stored in
517 cookies during the session and password is deleted when it
518 ends. This can also allow you to login in arbitrary server if
520 </li>
521 <li>
522 'http' authentication (was called 'advanced' in older versions)
524 allows you to log in as any valid MySQL user via HTTP-Auth.
525 </li>
526 </ul><br />
529 for more information.
530 <br /><br />
531 </dd>
533 <dt>
536 </dt>
537 <dd>
538 The user/password-pair which phpMyAdmin will use to connect to this
539 MySQL-server. This user/password pair is not needed when HTTP or
540 cookie authentication is used, and should be empty.<br /><br />
541 </dd>
544 <dd>
545 If set to a(an array of) database name(s), only this(these) database(s)
546 will be shown to the user. Since phpMyAdmin 2.2.1, this/these
547 database(s) name(s) may contain MySQL wildcards characters
551 This setting is an efficient way to lower the server charge since the
552 latter does not need to send MySQL requests to build the available
554 privileges rules of the MySQL database server</span>. If set, it just
555 means only these databases will be displayed but
557 <br /><br />
558 An example of using more that one database:
560 </dd>
563 <dd>
564 Only useful when using phpMyAdmin with multiple server entries. If set,
565 this string will be displayed instead of the hostname in the pull-down
566 menu on the main page. This can be useful if you want to show only
567 certain databases on your system, for example.
568 <br /><br />
569 </dd>
571 <dt>
574 </dt>
575 <dd>
576 Starting with version 2.3.0 phpMyAdmin offers a lot of features
577 to work with master / foreign - tables. To use those as well as
578 the bookmark feature you need special tables with a
579 predefined structure, which we explain below.
580 <br /><br />
581 See the Quick Install section in this document for a quick way
582 of creating those tables. Also, if you are using a Windows server,
583 read FAQ 1.23.
584 <br /><br />
585 If you are the only user of this phpMyAdmin installation, you can
586 use your current database to store those special tables; in this
587 case, just put your current database name in
589 <br /><br />
590 If you are setting up a multi-user phpMyAdmin installation,
591 you will need to create a new database and setup special privileges,
592 so, as superuser:
593 <br /><br />
594 <ul>
595 <li>
596 create a new database for phpMyAdmin:<br />
600 privileges on this database. Here is a query to set up
603 controluser):<br />
604 <tt>
605 GRANT SELECT,INSERT,UPDATE,DELETE ON phpmyadmin.* to 'pma'@'localhost';
606 </tt><br />
608 </li>
609 <li>
611 </li>
612 </ul><br />
613 </dd>
615 <dt>
618 </dt>
619 <dd>
620 Since release 2.2.0 phpMyAdmin allows to bookmark queries. This can be
621 useful for queries you often run.<br /><br />
623 To allow the usage of this functionality you have to:
624 <ul>
626 <li>within this database create a table following this scheme:
627 <br />
628 <tt>
637 </tt>
638 </li>
639 <li>enter the table name in
641 </ul><br />
642 </dd>
644 <dt>
647 </dt>
648 <dd>
649 Since release 2.2.4 you can describe, in a special 'relation' table,
650 which field is a key in another table (a foreign key). phpMyAdmin
651 currently uses this to
652 <ul>
653 <li>
654 make clickable, when you browse the master table, the data values
655 that point to the foreign table;
656 </li>
657 <li>
659 when browsing the master table, if you move the mouse to a column
660 containing a foreign key (use also the 'table_info' table);<br />
661 (see FAQ 6.7)
662 </li>
663 <li>
664 in edit/insert mode, display a drop-down list of possible
666 shown)<br />
667 (see FAQ 6.21)
668 <li>
669 display links on the table properties page, to check referential
670 integrity (display missing foreign keys) for each described key;
671 </li>
672 <li>
673 in query-by-example, create automatic joins (see FAQ 6.6)
674 </li>
675 <li>
676 enable you to get a PDF schema of your database (also uses the
677 table_coords table).
678 </li>
679 </ul>
680 <br />
682 The keys can be numeric or character.
683 <br /><br />
685 To allow the usage of this functionality the superuser has to:
686 <ul>
688 <li>
689 within this database create a table following this scheme:
690 <br />
691 <tt>
697 `foreign_table` varchar(64) NOT NULL default '',<br />
698 `foreign_field` varchar(64) NOT NULL default '',<br />
699 PRIMARY KEY (`master_db`, `master_table`, `master_field`),<br />
702 </tt>
703 </li>
704 <li>
705 put the relation table name in
707 </li>
708 <li>
709 now as normal user open phpMyAdmin and for each one of your
710 tables where you want to use this feature, click
712 </li>
713 </ul><br />
716 future development of the cross-db relations.<br /><br />
717 </dd>
719 <dt>
722 </dt>
723 <dd>
724 Since release 2.3.0 you can describe, in a special 'table_info'
725 table, which field is to be displayed as a tool-tip when moving the
726 cursor over the corresponding key.
727 <br />
728 This configuration variable will hold the name of this special
729 table.
730 To allow the usage of this functionality the superuser has to:
731 <ul>
733 <li>within this database create a table following this scheme:
734 <br />
735 <tt>
739 `display_field` varchar(64) NOT NULL default '',<br />
742 </tt>
743 </li>
744 <li>
745 put the table name in
747 </li>
748 <li>
749 then for each table where you want to use this feature,
751 to choose the field.
752 </li>
753 </ul><br />
755 <br /><br />
756 </dd>
758 <dt>
762 </dt>
763 <dd>
764 Since release 2.3.0 you can have phpMyAdmin create PDF pages showing
765 the relations between your tables. To do this it needs two tables
768 table will be placed on a PDF schema output).
769 <br /><br />
772 output.
773 <br /><br />
774 To allow the usage of this functionality the superuser has to:
775 <ul>
777 <li>
778 within this database create a table following this scheme:
779 <br />
780 <tt>
787 PRIMARY KEY (`db_name`, `table_name`, `pdf_page_number`)<br />
788 ) TYPE=MyISAM COMMENT='Table coordinates for phpMyAdmin PDF output';<br />
789 </tt>
790 </li>
791 <li>
792 also within this database create:<br />
793 <tt>
796 `page_nr` int(10) unsigned NOT NULL auto_increment,<br />
801 </tt>
802 </li>
803 <li>
804 put the first table name in
806 and the second table name in
808 </li>
809 </ul><br />
811 <br /><br />
812 </dd>
814 <dt>
817 </dt>
818 <dd>
819 <!-- This part requires a content update! -->
820 Since release 2.3.0 you can store comments to describe each column
822 <br /><br />
823 Starting with release 2.5.0, comments are consequently used on the table property
824 pages and table browse view, showing up as tool-tips above the column name (properties page)
825 or embedded within the header of table in browse view. They can also be shown
826 in a table dump. Please see the relevant configuration directives later on.
827 <br /><br />
828 Also new in release 2.5.0 is a mime-transformation system which is also based on
830 for further information. To use the mime-transformation system, your column_info
831 table has to have the three new fields 'mimetype', 'transformation', 'transformation_options'.
832 <br /><br />
833 To allow the usage of this functionality the superuser has to:
834 <ul>
836 <li>
837 within this database create a table following this scheme:
838 <br />
839 <tt>
847 transformation varchar(255) NOT NULL default '',<br />
848 transformation_options varchar(255) NOT NULL default '',<br />
850 UNIQUE KEY db_name (db_name, table_name, column_name)<br />
852 </tt>
853 </li>
854 <li>
855 put the table name in
857 </li>
858 <li>
860 <tt>
864 ADD `transformation_options` VARCHAR( 255 ) NOT NULL ;<br />
865 </tt>
866 and remember that the Variable in config.inc.php has been renamed
867 from <br />$cfg['Servers'][$i]['column_comments'] to $cfg['Servers'][$i]['column_info']
868 </li>
869 </ul><br />
870 </dd>
872 <dt>
875 </dt>
876 <dd>
877 Since release 2.5.0 you can store your SQL history, which means all queries you
878 entered manually into the phpMyAdmin interface. If you don't want to use a table-
879 based history, you can use the JavaScript-based history. Using that, all your
880 history items are deleted when closing the window.<br /><br />
883 you want to have on hold. On every login, this list gets cut to the maximum amount.
884 <br /><br />
886 The query history is only available if you use the JavaScript-based query window,
888 <br /><br />
890 To allow the usage of this functionality the superuser has to:
891 <ul>
893 <li>
894 within this database create a table following this scheme:
895 <br />
896 <tt>
905 INDEX ( `username` , `db` , `table` , `timevalue` )<br />
907 </tt>
908 </li>
909 <li>
910 put the table name in
912 </li>
913 </ul><br />
914 </dd>
916 <dt>
918 </dt>
919 <dd>
920 Because release 2.5.0 introduced the new MIME-transformation support, the
921 column_info table got enhanced with three new fields. If the above variable is
922 set to TRUE (default) phpMyAdmin will check if you have the latest table structure
923 available. If not, it will emit a warning to the superuser.<br /><br />
925 You can disable this checking behavior by setting the variable to false, which
926 should offer a performance increase.<br /><br />
928 Recommended to set to FALSE, when you are sure, your table structure is up to date.
929 <br /><br />
930 </dd>
932 <dt>
934 </dt>
935 <dd>
936 If your rule order is empty, then IP authentication is disabled.
937 <br /><br />
939 applies all deny rules followed by allow rules.
940 Access is allowed by default. Any client which does not match a Deny
941 command or does match an Allow command will be allowed access to the
942 server.
943 <br /><br />
945 applies all allow rules followed by deny rules. Access is denied by
946 default. Any client which does not match an Allow directive or does
947 match a Deny directive will be denied access to the server.
948 <br /><br />
949 If your rule order is set to 'explicit', the authentication is
950 performed in a similar fashion to rule order 'deny,allow', with the
954 and was available in Apache by specifying allow and deny rules without
955 setting any order.
956 <br /><br />
957 </dd>
959 <dt>
961 </dt>
962 <dd>
963 The general format for the rules is as such:<br />
964 <tt>
965
967 </tt>
968 <br /><br />
973 well:<br />
974 <tt>
977 </tt>
978 <br /><br />
980 Having an empty rule list is equivalent to either using
984 <br /><br />
986 For the IP matching system, the following work:<br />
990 But the following does not work:<br />
992 <br /><br />
993 </dd>
996 <dd>
997 If you have more than one server configured, you can set
999 that server when phpMyAdmin is started, or set it to 0 to be given a
1000 list of servers without logging in.<br />
1002 MUST be set to that server.
1003 <br /><br />
1004 </dd>
1007 <dd>
1008 Defines whether to use GZip output buffering for increased
1009 speed in HTTP transfers.<br />
1010 Set to true/false for enabling/disabling. When set to 'auto' (string),
1011 phpMyAdmin tries to enable output buffering and will automatically disable
1012 it, if your browser has some problems with buffering. IE6 with a certain patch
1013 is known to cause data corruption having enabled buffering.
1014 <br /><br />
1015 </dd>
1018 <dd>
1019 Whether persistent connections should be used or not (mysql_connect or
1020 mysql_pconnect).
1021 <br /><br />
1022 </dd>
1025 <dd>
1026 Set the number of seconds a script is allowed to run. If seconds is set
1027 to zero, no time limit is imposed.<br />
1028 This setting is used while importing/exporting dump files but has no
1029 effect when PHP is running in safe mode.
1030 <br /><br />
1031 </dd>
1034 <dd>
1035 Mark used tables and make it possible to show databases with locked
1036 tables (since 3.23.30).
1037 <br /><br />
1038 </dd>
1041 <dd>
1042 Defines whether SQL-queries generated by phpMyAdmin should be displayed
1043 or not.
1044 <br /><br />
1045 </dd>
1048 <dd>
1049 Defines whether normal users (non-administrator) are allowed to
1050 delete their own database or not. If set as FALSE, the link "Drop
1052 mydatabase" will be rejected. Quite practical for ISP's with many
1053 customers.
1054 <br /><br />
1055 </dd>
1058 <dd>
1060 displayed when you're about to loose data.
1061 <br /><br />
1062 </dd>
1065 <dd>
1066 Define whether the previous login should be recalled or not in cookie
1067 authentication mode.
1068 <br /><br />
1069 </dd>
1072 <dd>
1073 Define whether the "search string inside database" is enabled or not.
1074 <br /><br />
1075 </dd>
1078 <dd>
1079 Define whether phpMyAdmin will continue executing a multi-query
1080 statement if one of the queries fails. Default is to abort execution.
1081 <br /><br />
1082 </dd>
1085 <dd>
1086 Define whether phpMyAdmin will output the results of each query of a
1087 multi-query statement embedded into the SQL output as inline comments.
1088 Defaults to TRUE.
1089 <br /><br />
1090 </dd>
1093 <dd>
1094 If enabled allows you to login to arbitrary server using cookie auth.
1095 <br /><br />
1097 MySQL servers behind firewall where your http server is placed.
1098 <br /><br />
1099 </dd>
1102 <dd>
1103 Defines whether to use select-based menu and display only the current
1104 tables in the left frame (smaller page).
1105 Only in Non-Lightmode you can use the feature to display nested folders
1106 using $cfg['LeftFrameTableSeparator']
1107 <br /><br />
1108 </dd>
1111 <dd>
1112 Defines a string to be used to nest table spaces. Defaults to '__'.
1113 This means if you have tables like 'first__second__third' this will be
1115 If set to FALSE or empty, the feature is disabled. NOTE: You shall
1116 not use this Separator in a table name at the beginning or end of a
1117 table name, or multiple times after another without any other
1118 characters in between.
1119 <br /><br />
1120 </dd>
1123 <dd>
1124 Defines how many sublevels should be displayed when splitting
1125 up tables by the above Separator.
1126 <br /><br />
1127 </dd>
1130 <dd>
1131 Defines whether to display table comment as tool-tip in left frame or
1132 not.
1133 <br /><br />
1134 </dd>
1137 <dd>
1138 If tool-tips are enabled and a DB comment is set, this will flip the
1139 comment and the real name. That means, if you have a table called
1140 'user0001' and add the comment 'MyName' on it, you will see the name
1141 'MyName' used consequently in the left frame and the tool-tip shows
1142 the real name of the DB.
1143 <br /><br />
1144 </dd>
1147 <dd>
1148 Same as $cfg['ShowTooltipAliasDB'], except this works for table names.
1149 <br /><br />
1150 </dd>
1153 <dd>
1154 Defines whether to display space usage and statistics about databases
1155 and tables or not.<br />
1156 Note that statistics requires at least MySQL 3.23.3 and that, at this
1157 date, MySQL doesn't return such information for Berkeley DB tables.
1158 <br /><br />
1159 </dd>
1161 <dt>
1166 </dt>
1167 <dd>
1171 starting main (right) frame. This setting does not check MySQL
1172 commands entered directly.
1173 <br /><br />
1175 Please note that to block the usage of phpinfo() in scripts, you
1176 have to put this in your php.ini:<br />
1178 <br /><br />
1182 hard coded password value in the configuration file, end users can't
1183 be allowed to change their passwords.
1184 <br /><br />
1185 </dd>
1188 <dd>
1189 Defines whether to suggest a database name on the
1191 <br /><br />
1192 </dd>
1195 <dd>
1197 content or not.
1198 <br /><br />
1199 </dd>
1202 <dd>
1203 Defines whether navigation bar buttons contain text or symbols only.
1204 <br /><br />
1205 </dd>
1208 <dd>
1209 Defines whether an user should be displayed a
1211 <br /><br />
1212 </dd>
1215 <dd>
1216 Number of rows displayed when browsing a result set. If the result set
1217 contains more rows, Previous/Next links will be shown.
1218 <br /><br />
1219 </dd>
1222 <dd>
1226 DATE, DATETIME & TIMESTAMP, ascending order else- by default.
1227 <br /><br />
1228 </dd>
1231 <dd>
1233 from edition when browsing a table's content or not.
1234 Valid values are:<br />
1237 <br />
1240 <br /><br />
1241 </dd>
1244 <dd>
1245 Defines whether MySQL functions fields should be displayed or not in
1246 edit/insert mode.
1247 <br /><br />
1248 </dd>
1251 <dd>
1252 Defines which type of editing controls should be used for CHAR and
1253 VARCHAR fields. Possible values are:
1254 <ul>
1255 <li>
1256 input - this allows to limit size of text to size of field in
1257 MySQL, but has problems with newlines in fields
1258 </li>
1259 <li>
1260 textarea - no problems with newlines in fields, but also no
1261 length limitations
1262 </li>
1263 </ul>
1264 Default is old behavior so input.
1265 <br /><br />
1266 </dd>
1268 <dt>
1272 </dt>
1273 <dd>
1274 Defines whether to allow the use of zip/GZip/BZip2 compression when
1275 creating a dump file or not.
1276 <br /><br />
1277 </dd>
1279 <dt>
1281 </dt>
1282 <dd>
1283 Defines whether to allow ont the fly compression for GZip/BZip2
1284 compressed exports. This doesn't affect smaller dumps and allows to
1285 create larger dumps, that won't fit otherwise in memory due to php
1286 memory limit. Produced files contain more GZip/BZip2 headers, but all
1287 normal programs handles this correctly.
1288 <br /><br />
1289 </dd>
1292 <dd>
1293 If set to True, do use less graphically intense tabs on the top of the
1294 mainframe.
1295 <br /><br />
1296 </dd>
1299 <dd>
1300 If set to True, will display icons instead of text for db and table
1301 properties links (like 'Browse', 'Select', 'Insert', ...).<br />
1302 Can be set to 'both' if you want icons AND text.<br />
1303 When set to False, will only show text.
1304 <br /><br />
1305 </dd>
1308 <dd>
1309 How many columns will be utilized to display the tables on the
1310 database property view? Default is 1 column. When setting this to a
1311 value larger than 1, the type of the database will be omitted for more
1312 display space.
1313 <br /><br />
1314 </dd>
1318 <dd>
1319 Defines the tab displayed by default on server view. Possible
1324 <br /><br />
1325 </dd>
1328 <dd>
1329 Defines the tab displayed by default on database view. Possible
1332 <br /><br />
1333 </dd>
1336 <dd>
1337 Defines the tab displayed by default on table view. Possible
1341 <br /><br />
1342 </dd>
1345 <dd>
1346 If set to an URL which points to the MySQL documentation (type depends
1348 generated.
1349 <br />
1351 Documentation page</a> for more information about MySQL manuals and
1352 their types.
1353 <br /><br />
1354 </dd>
1357 <dd>
1358 Type of MySQL documentation:
1359 <ul>
1365 </ul>
1366 <br /><br />
1367 </dd>
1370 <dd>
1371 Defines the default language to use, if not browser-defined or
1372 user-defined.<br />
1374 this setting.
1375 <br /><br />
1376 </dd>
1379 <dd>
1380 Force: always use this language (must be defined in the
1382 <br /><br />
1383 </dd>
1386 <dd>
1387 Default character set to use for recoding of MySQL queries. This must be
1389 option.<br />
1390 You can give here any character set which is in
1392 choice, user can select any of them.
1393 <br /><br />
1394 </dd>
1397 <dd>
1398 Allow character set recoding of MySQL queries. You need recode or iconv
1399 support (compiled in or module) in PHP to allow MySQL queries recoding
1400 and used language file must have it enabled (by default only these
1401 which are in Unicode, just to avoid losing some characters).
1402 <br /><br />
1403 </dd>
1406 <dd>
1407 You can select here which functions will be used for character set
1408 conversion.
1409 Possible values are:<br />
1410 <ul>
1411 <li>auto - automatically use available one (first is tested
1412 iconv, then recode)</li>
1415 </ul>
1416 Default is auto.
1417 <br /><br />
1418 </dd>
1421 <dd>
1422 Specify some parameters for iconv used in charset conversion. See
1424 documentation</a> for details.
1425 <br /><br />
1426 </dd>
1429 <dd>
1430 Available character sets for MySQL conversion. You can add your own (any of
1431 supported by recode/iconv) or remove these which you don't use.
1432 Character sets will be shown in same order as here listed, so if you
1433 frequently use some of these move them to the top.
1434 <br /><br />
1435 </dd>
1438 <dd>
1440 MIME transformations.<br />
1441 Possible values are:<br />
1442 <ul>
1443 <li>
1444 auto - automatically detect, this is a bit expensive
1446 according to your server real possibilities
1447 </li>
1450 </ul>
1451 Default is auto.
1452 <br /><br />
1453 </dd>
1456 <dd>
1457 Left frame width in pixel.
1458 <br /><br />
1459 </dd>
1461 <dt>
1464 </dt>
1465 <dd>
1466 The background colors (HTML) used for both the frames.
1467 <br /><br />
1468 </dd>
1470 <dt>
1472 </dt>
1473 <dd>
1474 The URI of the background image used for the right frame. It can be
1475 absolute as well as relative from your phpMyAdmin directory.
1476 </dd>
1479 <dd>
1480 The color (HTML) used for the pointer in the left frame (does not work
1481 with Netscape 4).
1482 <br /><br />
1483 </dd>
1486 <dd>
1487 The size of a table's border.
1488 <br /><br />
1489 </dd>
1492 <dd>
1493 The color (HTML) used for table headers.
1494 <br /><br />
1495 </dd>
1498 <dd>
1499 The color (HTML) #1 for table rows.
1500 <br /><br />
1501 </dd>
1504 <dd>
1505 The color (HTML) #2 for table rows.
1506 <br /><br />
1507 </dd>
1509 <dt>
1512 </dt>
1513 <dd>
1514 The colors (HTML) uses for the pointer and the marker in browse mode
1516 The former feature highlights the row over which your mouse is passing
1517 and the latter lets you visually mark/unmark rows by clicking on
1518 them.<br />
1519 You can disable both of these features by emptying the respective
1520 directive.
1521 <br /><br />
1522 </dd>
1524 <dt>
1529 </dt>
1530 <dd>
1531 Number of columns and rows for the textareas.<br />
1533 SQL textareas inside the query window.<br />
1534 The Char* values are used for CHAR and VARCHAR editing (if configured
1535 via $cfg['CharEditing']).
1536 <br /><br />
1537 </dd>
1539 <dt>
1541 </dt>
1542 <dd>
1543 Defines whether textarea for LONGTEXT fields should have double size.
1544 <br /><br />
1545 </dd>
1547 <dt>
1549 </dt>
1550 <dd>
1551 Defines if the whole textarea of the query box will be selected on
1552 click.
1553 <br /><br />
1554 </dd>
1556 <dt>
1558 </dt>
1559 <dd>
1560 Enable Ctrl+Arrows moving between fields when editing?
1561 <br /><br />
1562 </dd>
1565 <dd>
1566 Maximal number of Chars showed in any non-numeric
1567 field on browse view. Can be turned off by a toggle button on the
1568 browse page.
1569 <br /><br />
1570 </dd>
1572 <dt>
1575 </dt>
1576 <dd>
1577 Defines the place where modify and delete links would be put when
1578 tables contents are displayed (you may have them displayed both at the
1579 left and at the right).
1582 <br /><br />
1583 </dd>
1587 </dt>
1588 <dd>
1589 There are 3 display modes: horizontal, horizontalflipped and vertical.
1590 Define which one is displayed by default. The first mode displays each
1591 row on a horizontal line, the second rotates the headers by 90
1592 degrees, so you can use descriptive headers even though fields only
1593 contain small values and still print them out. The vertical mode sorts
1594 each row on a vertical lineup.
1595 <br /><br />
1596 The HeaderFlipType can be set to 'css' or 'faked'. When using 'css'
1597 the rotation of the header for horizontalflipped is done via CSS. If
1598 set to 'faked' PGP does the transformation for you, but of course this
1599 does not look as good as CSS.
1600 <br /><br />
1601 </dd>
1604 <dd>
1605 When editing/creating new columns in a table all fields normally get
1606 lined up one field a line. (default: 'horizontal'). If you set this to
1607 'vertical' you can have each field lined up vertically beneath each
1608 other. You can save up a lot of place on the horizontal direction and
1609 no longer have to scroll.
1610 <br /><br />
1611 </dd>
1615 </dt>
1616 <dd>
1617 By setting the corresponding variable to TRUE you can enable the
1618 display of column comments in Browse or Property display. In browse
1619 mode, the comments are show inside the header. In property mode,
1620 comments are displayed using a CSS-formatted dashed-line below the
1621 name of the field. The comment is shown as a tool-tip for that field.
1622 <br /><br />
1623 </dd>
1626 <dd>
1627 The name of the directory, where SQL files have been uploaded by other
1628 means than phpMyAdmin (for example, ftp). Those files are available
1629 under a drop-down box when you click the database name, then the SQL
1630 tab.
1631 <br /><br />
1634 compressed formats is enabled).
1635 <br /><br />
1636 This feature is useful when your file is too big to be uploaded via
1637 HTTP, or when file uploads are disabled in PHP.
1638 <br /><br />
1639 Please note that if PHP is running in safe mode, this directory must
1640 be owned by the same user as the owner of the phpMyAdmin scripts.
1641 <br /><br />
1642 </dd>
1645 <dd>
1646 The name of the directory, where docSQL files can be uploaded for
1647 import into phpMyAdmin.
1648 <br /><br />
1649 Please note that if PHP is running in safe mode, this directory must
1650 be owned by the same user as the owner of the phpMyAdmin scripts.
1651 <br /><br />
1652 </dd>
1655 <dd>
1656 The name of the directory, where dumps can be saved.
1657 <br /><br />
1658 Please note that the directory has to be writable for user running
1659 webserver.
1660 <br /><br />
1661 Please note that if PHP is running in safe mode, this directory must
1662 be owned by the same user as the owner of the phpMyAdmin scripts.
1663 <br /><br />
1664 </dd>
1667 <dd>
1668 In this array are defined default parameters for export, names of
1669 items are simmilar to texts seen on export page, so you can easily
1670 identify what they mean.
1671 <br /><br />
1672 </dd>
1675 <dd>
1676 Repeat the headers every X cells, or 0 to deactivate.
1677 <br /><br />
1678 </dd>
1688 </dt>
1689 <dd>
1690 All those variables affect the new query frame/window. When
1691 $cfg['QueryFrame'] is set to true a new frame is embedded on the left
1692 with a small area. Clicking on that results in opening a direct
1693 interface to enter SQL queries.
1694 <br /><br />
1695 When $cfg['QueryFrameJS'] is set to true, clicking on that link opens
1696 a new custom sized browser window ($cfg['QueryWindowWidth'],
1697 $cfg['QueryWindowWidth'] - both integers for the size in pixels). If
1698 set to false, clicking on the link only opens the SQL input in the
1699 mainframe.
1700 <br /><br />
1701 The usage of the JavaScript query window is recommended if you have a
1702 JavaScript enabled browser. Basic functions are used to exchange quite
1703 a few variables, so most 4th generation browsers should be capable to
1704 use that feature. It currently is only tested with Internet Explorer 6
1705 and Mozilla 1.x.
1706 <br /><br />
1707 If $cfg['QueryHistoryDB'] is set to TRUE, all your Queries are logged
1708 to a table, which has to be created by you (see <a
1710 all your queries will be appended to the form, but only as long as
1711 your window is opened they remain saved.
1712 <br /><br />
1713 When using the JavaScript based query window, it will always get
1714 updated when you click on a new table/db to browse and will focus if
1715 you click on "Edit SQL" after using a query. You can suppress updating
1716 the query window by checking the box "Do not overwrite this query from
1717 outside the window" below the query textarea. Then you can browse
1718 tables/databases in the background without losing the contents of the
1719 textarea, so this is especially useful when composing a query with
1720 tables you first have to look in. The checkbox will get automatically
1721 checked whenever you change the contents of the textarea. Please
1722 uncheck the button whenever you definitely want the query window to
1723 get updated even though you have made alterations.
1724 <br /><br />
1725 If $cfg['QueryHistoryDB'] is set to TRUE you can specify the amount of
1726 saved history items using $cfg['QueryHistoryMax'].
1727 <br /><br />
1728 The query window also has a custom tabbed look to group the features.
1729 Using the variable $cfg['QueryWindowDefTab'] you can specify the
1730 default tab to be used when opening the query window. It can be set to
1731 either 'sql', 'files', 'history' or 'full'.
1732 <br /><br />
1733 The variable $cfg['QueryFrameDebug'] can be used by developers for
1734 easier future feature integration.
1735 <br /><br />
1736 </dd>
1739 <dd>
1741 <br /><br />
1742 </dd>
1745 <dd>
1746 Determines for how large tables phpMyAdmin should get exact row count by
1750 <br /><br />
1751 </dd>
1755 <dd>
1756 Utilizes a WYSIWYG editing control to easily place elements of a PDF
1757 page. By clicking on the button 'toggle scratchboard' on the page
1758 where you edit x/y coordinates of those elements you can activate a
1759 scratchboard where all your elements are placed. By clicking on an
1760 element, you can move them around in the pre-defined area and the x/y
1761 coordinates will get updated dynamically. Likewise, when entering a
1762 new position directly into the input field, the new position in the
1763 scratchboard changes after your cursors leaves the input field.
1764 <br />
1765 You have to click on the 'OK'-button below the tables to save the new
1766 positions. If you want to place a new element, first add it to the
1767 table of elements and then you can drag the new element around.
1768 <br />
1769 By changing the paper size and the orientation you can change the size
1770 of the scratchboard as well. You can do so by just changing the
1771 dropdown field below, and the scratchboard will resize automatically,
1772 without interfering with the current placement of the elements.
1773 <br />
1774 If ever an element gets out of range you can either enlarge the paper
1775 size or click on the 'reset' button to place all elements below each
1776 other.
1777 <br />
1779 get this control to work. The basic Drag&Drop script functionality
1780 was kindly borrowed from www.youngpup.net and is underlying so
1781 specific license.
1782 <br /><br />
1783 </dd>
1786 <dd>
1787 The main use of the new SQL Parser is to pretty-print SQL queries. By
1788 default we use HTML to format the query, but you can disable this by
1790 <br /><br />
1791 </dd>
1795 <dd>
1796 For the pretty-printing of SQL queries, under some cases the part of a
1797 query inside a bracket is indented. By changing
1800 specifies the units of the indent amount that you specified. This is
1801 used via stylesheets.
1802 <br /><br />
1803 </dd>
1806 <dd>
1807 This array is used to define the colours for each type of element of
1808 the pretty-printed SQL queries. The tuple format is<br />
1810 If you specify an empty string for the color of a class, it is ignored
1811 in creating the stylesheet.
1812 You should not alter the class names, only the colour strings.<br />
1814 <ul>
1838 <li><b>quote_single</b> Single quotes <tt>'</tt></li>
1839 <li><b>quote_backtick</b> Backtick quotes <tt>`</tt></li>
1840 </ul><br />
1841 </dd>
1843 <dt><b>$cfg['SQLValidator']['use']</b> boolean</dt>
1844 <dd>
1845 phpMyAdmin now supports use of the <a href="http://developer.mimer.com/validator/index.htm">Mimer SQL Validator</a> service,
1846 as originally published on
1848 <br />
1849 For help in setting up your system to use the service, see the
1851 <br /><br />
1852 </dd>
1854 <dt><b>$cfg['SQLValidator']['username']</b> string<br />
1855 <b>$cfg['SQLValidator']['password']</b> string</dt>
1856 <dd>
1857 The SOAP service allows you to login with <tt>anonymous</tt>
1858 and any password, so we use those by default.. Instead, if
1859 you have an account with them, you can put your login details
1860 here, and it will be used in place of the anonymous login.
1861 <br /><br />
1862 </dd>
1864 <dt><b>$cfg['DBG']['enable']</b> boolean</dt>
1865 <dd>
1866 <b>DEVELOPERS ONLY!</b><br />
1867 Enable the DBG extension for debugging phpMyAdmin. Required for profiling
1868 the code.
1869 <br />
1870 For help in setting up your system to this, see the
1872 </dd>
1874 <dt><b>$cfg['DBG']['profile']['enable']</b> boolean</dt>
1875 <dd>
1876 <b>DEVELOPERS ONLY!</b><br />
1877 Enable profiling support for phpMyAdmin. This will append a chunk of data
1878 to the end of every page displayed in the main window with profiling
1879 statistics for that page.<br />
1880 You may need need to increase the maximum execution time for this to
1881 complete successfully.
1882 </dd>
1884 <dt><b>$cfg['DBG']['profile']['threshold']</b> float (units in milliseconds)</dt>
1885 <dd>
1886 <b>DEVELOPERS ONLY!</b><br />
1887 When profiling data is displayed, this variable controls the threshold of
1888 display for any profiling data, based on the average time each time has
1889 taken. If it is over the threshold it is displayed, otherwise it is not
1890 displayed. This takes a value in milliseconds. In most cases you don't need
1891 to edit this.
1892 </dd>
1894 <dt><b>$cfg['ColumnTypes'] </b>array</dt>
1895 <dd>
1896 All possible types of a MySQL column. In most cases you don't need to
1897 edit this.
1898 <br /><br />
1899 </dd>
1901 <dt><b>$cfg['AttributeTypes'] </b>array</dt>
1902 <dd>
1903 Possible attributes for fields. In most cases you don't need to edit
1904 this.
1905 <br /><br />
1906 </dd>
1908 <dt><b>$cfg['Functions'] </b>array</dt>
1909 <dd>
1910 A list of functions MySQL supports. In most cases you don't need to
1911 edit this.
1912 <br /><br />
1913 </dd>
1915 </dl>
1917 <!-- TRANSFORMATIONS -->
1919 <h2>Transformations</h2>
1921 <p>
1925 </p>
1928 <h3>[1. Introduction]</h3>
1930 <p>To enable transformations, you have to setup the column_info table and the proper
1932 <br />
1934 <p>You can apply different transformations to the contents of each field. The
1935 transformation will take the content of each field and transform it with
1936 certain rules defined in the selected transformation.</p><br />
1938 <p>Say you have a field 'filename' which contains a filename. Normally you would see
1939 in phpMyAdmin only this filename. Using transformations you can transform that filename
1940 into a HTML link, so you can click inside of the phpMyAdmin structure on the field's
1941 link and will see the file displayed in a new browser window. Using transformation
1942 options you can also specify strings to append/prepend to a string or the format you
1943 want the output stored in.</p><br />
1945 <p>For a general overview of all available transformations and their options, you can
1946 consult your <i><www.your-host.com>/<your-install-dir>/libraries/transformations/overview.php3</i>
1947 installation.</p>
1949 <p><br />For a tutorial on how to effectively use transformations, see our <a href="http://www.phpmyadmin.net/#links">Link section</a> on the official phpMyAdmin-homepage.</p>
1952 <h3>[2. Usage]</h3>
1954 <p>Go to your tbl_properties.inc.php3 page (i.e. reached through clicking on the
1955 'properties' link for a table). There click on "Change" (or change
1956 icon) and there you will see three new fields at the end of the line. They are
1957 called 'MIME-type', 'Browser transformation' and 'Transformation options'.</p>
1958 <br />
1960 <ul>
1961 <li>The field 'MIME-type' is a dropdown field. You have the options to leave that field
1962 empty or to use 'auto' [this feature is not yet available]. Please note that
1963 transformations are inactive as long as no mime-type is selected.</li>
1965 <li>The field 'Browser transformation' is a drop-down field. You can choose from a
1966 hopefully growing amount of pre-defined transformations. See below for information on
1967 how to build your own transformation.<br />
1969 There are global transformations and mimetype-bound transformations. Global transformations
1970 can be used for any mimetype. They will take the mimetype, if necessary, into regard.
1971 Mimetype-bound transformations usually only operate on a certain mimetype. There are
1972 transformations which operate on the main mimetype (like 'image'), which will most likely
1973 take the subtype into regard, and those who only operate on a
1974 specific subtype (like 'image/jpeg').<br />
1976 You can use transformations on mimetypes for which the function was not defined for. There
1977 is no security check for you selected the right transformation, so take care of what the
1978 output will be like.</li>
1980 <li>The field 'Transformation options' is a free-type textfield. You have to enter
1981 transform-function specific options here. Usually the transforms can operate with default
1982 options, but it is generally a good idea to look up the overview to see which options are
1983 necessary.<br />
1985 Much like the ENUM/SET-Fields, you have to split up several options using the format
1986 'a','b','c',...(NOTE THE MISSING BLANKS). This is because internally the options will be
1987 parsed as an array, leaving the first value the first element in the array, and so
1988 forth.<br />
1990 If you want to specify a MIME character set you can define it in the transformation_options.
1991 You have to put that outside of the pre-defined options of the specific mime-transform,
1993 for which you can specify 2 options and you want to append a character set, enter "'first
1994 parameter','second parameter','charset=us-ascii'". You can, however use the defaults for
1996 </ul>
1999 <h3>[3. File structure]</h3>
2001 <p>All mimetypes and their transformations are defined through single files in
2002 the directory 'libraries/transformations/'.</p><br />
2004 <p>They are stored in files to ease up customization and easy adding of new
2005 transformations.</p><br />
2007 <p>Because the user cannot enter own mimetypes, it is kept sure that transformations
2008 always work. It makes no sense to apply a transformation to a mimetype, the
2009 transform-function doesn't know to handle.</p><br />
2011 <p>One can, however, use empty mime-types and global transformations which should work
2012 for many mimetypes. You can also use transforms on a different mimetype they where built
2013 for, but pay attention to option usage as well as what the transformation does to your
2014 field.</p><br />
2016 <p>There is a basic file called 'global.inc.php3'. This function can be included by
2017 any other transform function and provides some basic functions.</p><br />
2019 <p>There are 5 possible file names:</p>
2021 <ol>
2022 <li>A mimetype+subtype transform:<br /><br />
2024 [mimetype]_[subtype]__[transform].inc.php3<br /><br />
2026 Please not that mimetype and subtype are separated via '_', which shall not be
2027 contained in their names. The transform function/filename may contain only
2028 characters which cause no problems in the file system as well as the PHP function
2029 naming convention.<br /><br />
2031 The transform function will the be called 'PMA_transform_[mimetype]_[subtype]__[transform]()'.<br /><br />
2033 <b>Example:</b><br /><br />
2035 text_html__formatted.inc.php3<br />
2036 PMA_transform_text_html__formatted()</li>
2038 <li>A mimetype (w/o subtype) transform:<br /><br />
2040 [mimetype]__[transform].inc.php3<br /><br />
2042 Please note that there are no single '_' characters.
2043 The transform function/filename may contain only characters which cause no problems
2044 in the file system as well as the PHP function naming convention.<br /><br />
2046 The transform function will the be called 'PMA_transform_[mimetype]__[transform]()'.<br /><br />
2048 <b>Example:</b><br /><br />
2050 text__formatted.inc.php3<br />
2051 PMA_transform_text__formatted()</li>
2053 <li>A mimetype+subtype without specific transform function<br /><br />
2055 [mimetype]_[subtype].inc.php3<br /><br />
2057 Please note that there are no '__' characters in the filename. Do not use special
2058 characters in the filename causing problems with the file system.<br /><br />
2060 No transformation function is defined in the file itself.<br /><br />
2062 <b>Example:</b><br /><br />
2064 text_plain.inc.php3<br />
2065 (No function)</li>
2067 <li>A mimetype (w/o subtype) without specific transform function<br /><br />
2069 [mimetype].inc.php3<br /><br />
2071 Please note that there are no '_' characters in the filename. Do not use special
2072 characters in the filename causing problems with the file system.<br /><br />
2074 No transformation function is defined in the file itself.<br /><br />
2076 <b>Example:</b><br /><br />
2078 text.inc.php3<br />
2079 (No function)</li>
2081 <li>A global transform function with no specific mimetype<br /><br />
2083 global__[transform].inc.php3<br /><br />
2085 The transform function will the be called 'PMA_transform_global__[transform]()'.<br /><br />
2087 <b>Example:</b><br /><br />
2089 global__formatted<br />
2090 PMA_transform_global__formatted()</li>
2091 </ol>
2093 <br />
2094 <p>So generally use '_' to split up mimetype and subtype, and '__' to provide a
2095 transform function.</p><br />
2097 <p>All filenames containing no '__' in themselves are not shown as valid transform
2098 functions in the dropdown.</p><br />
2100 <p>Please see the libraries/transformations/TEMPLATE file for adding your own transform
2101 function. See the libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
2102 without a transform function. Also note the introduction of a function description in
2103 the language files. For each function a $strTransformation_[filename without .inc.php3]
2104 has to exist.</p><br />
2106 <p>You can use the template generator to generate new functions and entries in the
2107 language file.</p><br />
2109 <p>To create a new transform function please see libraries/transformations/template_generator.sh.
2110 To create a new, empty mimetype please see libraries/transformations/template_generator_mimetype.sh.</p><br />
2112 <!-- FAQ -->
2114 <h2>FAQ - Frequently Asked Questions</h2>
2116 <p>
2125 </p>
2127 <p><br />
2128 Please have a look at our <a href="http://www.phpmyadmin.net/#links">Link section</a> on the official phpMyAdmin homepage for in-depth coverage of phpMyAdmin's features and/or interface.
2129 </p>
2132 <h3>[1. Server]</h3>
2134 <h4>
2135 [1.1] I'm running PHP 4+ and my server is crashing each time a specific
2136 action is required or phpMyAdmin sends a blank page or a page full of
2137 cryptic characters to my browser, what can I do?
2138 </h4>
2139 <p>
2140 There are some known PHP bugs with output buffering and compression.<br />
2141 Try to set the <tt>$cfg['OBGzip']</tt> directive to <tt>FALSE</tt> in your
2142 <i>config.inc.php or .php3</i> file and the
2143 <tt>zlib.output_compression</tt> directive to <tt>Off</tt> in your php
2144 configuration file.<br />
2145 Furthermore, we know about such problems connected to the release
2146 candidates of PHP 4.2.0 (tested with PHP 4.2.0 RC1 to RC4) together with
2147 MS Internet Explorer. Please upgrade to the release version PHP 4.2.0.
2148 </p>
2150 <h4>
2151 [1.2] My Apache server crashes when using phpMyAdmin.
2152 </h4>
2153 <p>
2154 You should first try the latest versions of Apache (and possibly MySQL).
2155 <br />
2156 See also the other FAQ entry about PHP bugs with output buffering.
2157 <br />
2158 If your server keeps crashing, please ask for help in the various
2159 Apache support groups.
2160 </p>
2162 <h4>
2164 PHP 4.2.0 or 4.2.1 loaded as an Apache 2+ module but can't enter the
2165 script: I'm always displayed the login screen.
2166 </h4>
2167 <p>
2168 This is a known PHP bug (see this
2170 official PHP bug database. It means there is and won't be any phpMyAdmin
2171 fix against it because there is no way to code a fix.
2172 </p>
2174 <h4>
2175 [1.4] Using phpMyAdmin on IIS, I'm displayed the error message:
2176 "The specified CGI application misbehaved by not returning a
2177 complete set of HTTP headers...".
2178 </h4>
2179 <p>
2180 You just forgot to read the <i>install.txt</i> file from the php
2181 distribution. Have a look at the last message in this
2183 official PHP bug database.
2184 </p>
2186 <h4>
2187 [1.5] Using phpMyAdmin on IIS, I'm facing crashes and/or many error
2188 messages with the HTTP or advanced authentication mode.
2189 </h4>
2190 <p>
2191 This is a known problem with the PHP ISAPI filter: it's not so stable. For
2192 some more information and complete testings see the messages posted by
2193 André B. aka "djdeluxe76" in
2194 <a href="http://www.phpwizard.net/phorum/read.php?f=1&i=6624&t=6300">this thread</a>
2195 from the phpWizard forum.<br />
2196 Please use instead the cookie authentication mode.
2197 </p>
2199 <h4>
2200 [1.6] I can't use phpMyAdmin on PWS: nothing is displayed!</h4>
2201 <p>
2202 This seems to be a PWS bug. Filippo Simoncini found a workaround (at this
2203 time there is no better fix): remove or comment the <tt>DOCTYPE</tt>
2204 declarations (2 lines) from the scripts <i>header.inc.php3</i>,
2205 <i>header_printview.inc.php3</i>, <i>index.php3</i>, <i>left.php3</i> and
2206 <i>libraries/common.lib.php3</i>.
2207 </p>
2209 <h4>
2210 [1.7] How can I GZip or Bzip a dump or a CSV export. It does not seem to
2211 work.
2212 </h4>
2213 <p>
2214 These features are based on the <tt>gzencode()</tt> and
2215 <tt>bzcompress()</tt> PHP functions to be more independent of the platform
2216 (Unix/Windows, Safe Mode or not, and so on).
2217 So, you must have PHP4 >= 4.0.4 and Zlib/Bzip2 support
2218 (<tt>--with-zlib</tt> and <tt>--with-bz2</tt>).<br />
2219 We faced PHP crashes when trying to download a dump with MS Internet
2220 Explorer when phpMyAdmin is run with a release candidate of PHP 4.2.0. In
2221 this case you should switch to the release version of PHP 4.2.0.
2222 </p>
2224 <h4>
2225 [1.8] I cannot insert a text file in a table, and I get an error about
2226 safe mode being in effect.
2227 </h4>
2228 <p>
2229 Your uploaded file is saved by PHP in the "upload dir", as
2230 defined in <i>php.ini</i> by the variable <tt>upload_tmp_dir</tt> (usually
2231 the system default is <i>/tmp</i>).
2232 <br />
2233 We recommend the following setup for Apache servers running in safe mode,
2234 to enable uploads of files while being reasonably secure:
2235 </p>
2236 <ul>
2237 <li>create a separate directory for uploads:
2238 <tt>mkdir /tmp/php</tt></li>
2239 <li>give ownership to the Apache server's user.group:
2240 <tt>chown apache.apache /tmp/php</tt></li>
2241 <li>give proper permission: <tt>chmod 600 /tmp/php</tt></li>
2242 <li>put <tt>upload_tmp_dir = /tmp/php</tt> in php.ini</li>
2243 <li>restart Apache</li>
2244 </ul>
2246 <h4>
2247 [1.9] I'm having troubles when uploading files. In general file uploads
2248 don't work on my system and uploaded files have a <tt>Content-Type:</tt>
2249 header in the first line.
2250 </h4>
2251 <p>
2252 It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat 7.0
2253 and you updated your PHP RPM to php-4.0.4pl1-3.i386.rpm, didn't you?
2254 <br />
2255 So the problem is that this package has a serious bug that was corrected
2256 ages ago in PHP (2001-01-28: see
2258 for more details). The problem is that the bugged package is still
2259 available though it was corrected (see
2261 for more details).
2262 <br />
2263 So please download
2264 <a href="http://www.redhat.com/swr/i386/php-4.0.4pl1-9.i386.html">the fixed package (4.0.4pl1-9)</a>
2265 and the problem should go away.
2266 <br />
2267 And that fixes the \r\n problem with file uploads!
2268 </p>
2270 <h4>
2271 [1.10] I'm having troubles when uploading files with phpMyAdmin running
2272 on a secure server. My browser is Internet Explorer and I'm using the
2273 Apache server.
2274 </h4>
2275 <p>
2276 As suggested by "Rob M" in the phpWizard forum, add this line to
2277 your <i>httpd.conf</i>:<br />
2278 <tt>SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown</tt><br />
2279 It seems to clear up many problems between Internet Explorer and SSL.
2280 </p>
2282 <h4>
2283 [1.11] I get an 'open_basedir restriction' while uploading a file from
2284 the query box.
2285 </h4>
2286 <p>
2287 Since version 2.2.4, phpMyAdmin supports servers with open_basedir
2288 restrictions. Assuming that the restriction allows you to open files in the
2289 current directory ('.'), all you have to do is create a 'tmp' directory
2290 under the phpMyAdmin install directory, with permissions 777 and the same
2291 owner as the owner of your phpMyAdmin directory. The uploaded files will
2292 be moved there, and after execution of your SQL commands, removed.
2293 </p>
2295 <h4>
2296 [1.12] I have lost my MySQL root password, what can I do?
2297 </h4>
2298 <p>
2299 The MySQL manual explains how to
2301 reset the permissions</a>.
2302 </p>
2304 <h4>
2305 [1.13] I get an error 'No SQL query' when trying to execute a bookmark.
2306 </h4>
2307 <p>
2308 If PHP does not have read/write access to its <tt>upload_tmp_dir</tt>, it
2309 cannot access the uploaded query.
2310 </p>
2312 <h4>
2313 [1.14] I get an error 'No SQL query' when trying to submit a query from
2314 the convenient text area.
2315 </h4>
2316 <p>
2317 Check the <tt>post_max_size</tt> directive from your PHP configuration file
2318 and try to increase it.
2319 </p>
2321 <h4>
2322 [1.15] I have problems with <i>mysql.user</i> field names.
2323 </h4>
2324 <p>
2325 In older MySQL versions, the <tt>User</tt> and <tt>Password</tt> fields
2326 were named <tt>user</tt> and <tt>password</tt>. Please modify your field
2327 names to align with current standards.
2328 </p>
2329 <h4>
2330 [1.16] I cannot upload big dump files (memory, http or timeout problems).
2331 </h4>
2332 <p>
2333 The first things to check (or ask your host provider to check) are the
2334 values of <tt>upload_max_filesize</tt>, <tt>memory_limit</tt> and
2335 <tt>post_max_size</tt> in the <i>php.ini</i> configuration file.
2336 <br />
2337 All of these three settings limit the maximum size of data that can be
2338 submitted and handled by PHP. One user also said that post_max_size
2339 and memory_limit need to be larger than upload_max_filesize.
2340 <br />
2341 If you get a timeout problem, look at the <tt>$cfg['UploadDir']</tt>
2342 feature.
2343 </p>
2346 <h4>
2347 [1.17] Which MySQL versions does phpMyAdmin support?
2348 </h4>
2349 <p>
2350 All MySQL versions from 3.21 till 4.0 are fully supported. Please note
2351 that the older your MySQL version is, the more limitations you will have to
2352 face.
2353 <br />
2354 phpMyAdmin provides experimental support for MySQL 4.1. That means that
2355 although you can assign character sets to a table or field, phpMyAdmin will
2356 not recode the data when inserting or extracting it. Instead, it will still
2357 use the character set you specified for the MySQL connection.<br />
2358 When compiling php, we strongly recommend that you manually link the MySQL
2359 extension to a MySQL client library of at least the same version since the
2360 one that is bundled with php 4.x is rather old and might cause problems.
2361 <br />
2362 Also, we do not yet support the imporoved MySQL extension (mysqli) that
2363 comes with php 5. For the moment, the old MySQL extension should also
2364 work fine here, if compiled correctly.
2365 <br />
2366 MySQL 5.0 and 5.1 are not yet supported.
2367 </p>
2369 <h4>
2370 [1.18] I'm running MySQL <= 4.0.1 having
2371 <tt>lower_case_table_names</tt> set to 1. If I create a new table with a
2372 capital letter in its name it is changed to lowercase as it should. But
2373 if I try to DROP this table MySQL is unable to find the corresponding
2374 file.
2375 </h4>
2376 <p>
2377 This is a bug of MySQL <= 4.0.1. Please upgrade to at least
2378 MySQL 4.0.2 or turn off your <tt>lower_case_table_names</tt>
2379 directive.
2380 </p>
2382 <h4>
2383 [1.19] I can't run the "display relations" feature because the
2384 script seems not to know the font face I'm using!
2385 </h4>
2386 <p>
2387 The "FPDF" library we're using for this feature requires some
2388 special files to use font faces.<br />
2389 Please refers to the
2391 these files.
2392 </p>
2395 <h4>
2396 [1.20] I receive the error "cannot load MySQL extension, please
2397 check PHP Configuration".
2398 </h4>
2399 <p>
2400 To connect to a MySQL server, PHP needs a set of MySQL functions called
2401 "MySQL extension".
2402 This extension may be part of the PHP distribution (compiled-in), otherwise
2403 it needs to be loaded dynamically. Its name is probably <i>mysql.so</i> or
2404 <i>php_mysql.dll</i>. phpMyAdmin tried to load the extension but failed.
2405 <br /><br />
2406 Usually, the problem is solved by installing a software package called
2407 "PHP-MySQL" or something similar.
2408 </p>
2410 <h4>
2411 [1.21] I am running the CGI version of PHP under Unix, and I cannot
2412 login using cookie auth.
2413 </h4>
2414 <p>
2415 In <i>php.ini</i>, set <tt>mysql.max_links</tt> higher than 1.
2416 </p>
2418 <h4>
2419 [1.22] I don't see the "Location of text file" field, so
2420 I cannot upload.
2421 </h4>
2422 <p>
2423 This is most likely because in <i>php.ini</i>, your <tt>file_uploads</tt>
2424 parameter is not set to "on".
2425 </p>
2427 <h4>
2428 [1.23] I'm running MySQL on a Win32 machine. Each time I create a new
2429 table the table and field names are changed to lowercase!
2430 </h4>
2431 <p>
2432 This happens because the MySQL directive <tt>lower_case_table_names</tt>
2433 defaults to 1 (<tt>ON</tt>) in the Win32 version of MySQL. You can change
2434 this behavior by simply changing the directive to 0 (<tt>OFF</tt>):<br />
2435 Just edit your <tt>my.ini</tt> file that should be located in your Windows
2436 directory and add the following line to the group [mysqld]:<br />
2437 <tt>set-variable = lower_case_table_names=0</tt><br />
2438 Next, save the file and restart the MySQL service. You can always check the
2439 value of this directive using the query<br />
2440 <tt>SHOW VARIABLES LIKE 'lower_case_table_names';</tt>
2441 </p>
2443 <h4>
2444 [1.24] Some characters are being truncated in my queries, or I get
2445 characters randomly added. I am running PHP 4.2.3.
2446 </h4>
2447 <p>
2448 This is a
2450 </p>
2452 <h4>
2453 [1.25] I am running Apache with mod_gzip-1.3.26.1a on Windows XP,
2454 and I get problems, such as undefined variables when I run a SQL query.
2455 </h4>
2456 <p>
2457 A tip from Jose Fandos: put a comment on the following two lines
2458 in httpd.conf, like this:<br />
2459 <tt># mod_gzip_item_include file \.php$</tt><br />
2461 as this version of mod_gzip on Apache (Windows) has problems handling
2462 PHP scripts. Of course you have to restart Apache.
2463 </p>
2465 <h4>
2466 [1.26] I just installed phpMyAdmin in my document root of IIS but
2467 I get the error "No input file specified" when trying to
2468 run phpMyAdmin.
2469 </h4>
2470 <p>
2471 This is a permission problem. Right-click on the phpmyadmin folder
2472 and choose properties. Under the tab Security, click on "Add"
2473 and select the user "IUSER_machine" from the list. Now set his
2474 permissions and it should work.
2475 </p>
2477 <h4>
2478 [1.27] I get empty page when I want to view huge page (eg.
2479 db_details_structure.php3 with plenty of tables).
2480 </h4>
2481 <p>
2483 GZIP output buffering enabled. If you turn off it (by <code>$cfg['OBGzip']
2484 = FALSE</code> in config.inc.php3), it should work. This bug will be fixed
2485 in PHP 5.0.0.
2486 </p>
2488 <h4>
2489 [1.28] My MySQL server sometimes refuses queries and returns the message
2490 'Errorcode: 13'. What does this mean?
2491 </h4>
2492 <p>
2493 This can happen due to a MySQL bug when having database / table names with
2494 upper case characters although <tt>lower_case_table_names</tt> is set to 1.
2495 To fix this, turn off this directive, convert all database and table names
2496 to lower case and turn it on again. Alternatively, there's a bug-fix
2497 available starting with MySQL 3.23.56 / 4.0.11-gamma.
2498 </p>
2501 <h4>
2502 [1.29] When I create a table or modify a field, I get an error
2503 and the fields are duplicated.
2504 </h4>
2505 <p>
2506 It is possible to configure Apache in such a way that PHP has problems
2507 interpreting .php files.
2508 <br /><br />
2509 The problems occur when two different (and conflicting) set of directives
2510 are used:
2511 <br /><br />
2512 <tt>
2513 SetOutputFilter PHP<br />
2514 SetInputFilter PHP<br />
2515 </tt>
2516 &
2517 <br />
2518 <tt>
2519 AddType application/x-httpd-php .php
2520 </tt>
2521 <br /><br />
2522 In the case we saw, one set of directives was in
2523 <tt>/etc/httpd/conf/httpd.conf</tt>, while
2524 the other set was in <tt>/etc/httpd/conf/addon-modules/php.conf</tt>.<br />
2525 The recommended way is with <tt>AddType</tt>, so just comment out
2526 the first set of lines and restart Apache:
2527 <br /><br />
2528 <tt><b>
2529 #SetOutputFilter PHP<br />
2530 #SetInputFilter PHP<br /></b>
2531 </tt>
2532 </p>
2533 <h4>
2534 [1.30] I get the error "left.php: Missing hash".
2535 </h4>
2536 <p>
2537 This problem is known to happen when the server is running Turck MMCache
2538 but upgrading MMCache to version 2.3.21 solves the problem.
2539 </p>
2541 <h3>[2. Configuration]</h3>
2543 <h4>
2544 [2.1] The error message "Warning: Cannot add header information -
2545 headers already sent by ..." is displayed, what's the problem?
2546 </h4>
2547 <p>
2548 Edit your <i>config.inc.php or .php3</i> file and ensure there is nothing
2549 (I.E. no blank lines, no spaces, no characters...) neither before the
2550 <tt><?php</tt> tag at the beginning, neither after the <tt>?></tt>
2551 tag at the end.
2552 </p>
2554 <h4>
2555 [2.2] phpMyAdmin can't connect to MySQL. What's wrong?
2556 </h4>
2557 <p>
2558 Either there is an error with your PHP setup or your username/password is
2559 wrong. Try to make a small script which uses mysql_connect and see if it
2560 works. If it doesn't, it may be you haven't even compiled MySQL support
2561 into PHP.
2562 </p>
2564 <h4>
2565 [2.3] The error message "Warning: MySQL Connection Failed: Can't
2566 connect to local MySQL server through socket '/tmp/mysql.sock'
2567 (111)..." is displayed. What can I do?
2568 </h4>
2569 <p><br />
2570 For RedHat users, Harald Legner suggests this on the mailing list:
2571 <br /><br />
2572 On my RedHat-Box the socket of MySQL is <i>/var/lib/mysql/mysql.sock</i>.
2573 In your php.ini you will find a line
2574 <br />
2575 <tt>mysql.default_socket = /tmp/mysql.sock</tt>
2576 <br />
2577 change it to
2578 <br />
2579 <tt>mysql.default_socket = /var/lib/mysql/mysql.sock</tt>
2580 <br />
2581 Then restart apache and it will work.
2582 <br /><br />
2583 Here is a fix suggested by Brad Ummer in the phpwizard forum:
2584 </p>
2585 <ul>
2586 <li>
2587 First, you need to determine what socket is being used by MySQL.
2588 <br />
2589 To do this, telnet to your server and go to the MySQL bin directory. In
2590 this directory there should be a file named <i>mysqladmin</i>. Type
2591 <tt>./mysqladmin variables</tt>, and this should give you a bunch of
2592 info about your MySQL server, including the socket
2593 (<i>/tmp/mysql.sock</i>, for example).
2594 </li>
2595 <li>
2596 Then, you need to tell PHP to use this socket.<br />Assuming you are
2597 using PHP 3.0.10 or better, you can specify the socket to use when you
2598 open the connection. To do this in phpMyAdmin, you need to complete the
2599 socket information in the config.inc.php3.<br />
2600 For example:
2601 <tt>$cfg['Servers'][$i]['socket'] = '/tmp/mysql.sock';</tt><br /><br />
2602 Please also make sure that the permissions of this file allow to be readable
2603 by your webserver (i.e. '0755').
2604 </li>
2605 </ul>
2606 <p>
2607 Have also a look at the
2609 corresponding section of the MySQL documentation</a>.
2610 </p>
2612 <h4>
2613 [2.4] Nothing is displayed by my browser when I try to run phpMyAdmin,
2614 what can I do?
2615 </h4>
2616 <p>
2617 Try to set the <tt>$cfg['OBGZip']</tt> directive to <tt>FALSE</tt> in the
2618 phpMyAdmin configuration file. It helps sometime.<br />
2619 Also have a look at your PHP version number: if it contains
2620 "4.0b..." it means you're running a beta version of PHP. That's
2621 not a so good idea, please upgrade to a plain revision.
2622 </p>
2624 <h4>
2625 [2.5] Each time I want to insert or change a record or drop a database
2626 or a table, an error 404 (page not found) is displayed or, with HTTP or
2627 cookie authentication, I'm asked to login again. What's wrong?
2628 </h4>
2629 <p>
2630 Check the value you set for the <tt>$cfg['PmaAbsoluteUri']</tt> directive
2631 in the phpMyAdmin configuration file.
2632 </p>
2634 <h4>
2635 [2.6] I get an "Access denied for user: 'root@localhost' (Using
2636 password: YES)"-error when trying to access a MySQL-Server on a
2637 host which is port-forwarded for my localhost
2638 </h4>
2639 <p>
2640 When you are using a port on your localhost, which you redirect via
2641 port-forwarding to another host, MySQL is not resolving the localhost
2642 as expected.<br />
2643 Erik Wasser explains: The solution is: if your host is "localhost"
2644 MySQL (the commandline tool 'mysql' as well) always tries to use the socket
2645 connection for speeding up things. And that doesn't work in this configuration
2646 with port forwarding.<br />
2648 TCP connection.
2649 </p>
2653 <h3>[3. Known limitations]</h3>
2655 <h4>
2656 [3.1] When using HTTP authentication, an user who logged out can not
2657 relogin in with the same nick.
2658 </h4>
2659 <p>
2660 This is related to the authentication mechanism (protocol) used by
2661 phpMyAdmin. To bypass this problem: just close all the opened
2662 browser windows and then go back to phpMyAdmin. You should be able to
2663 log in again.
2664 </p>
2666 <h4>
2667 [3.2] When dumping a large table in compressed mode, I get a memory
2668 limit error or a time limit error.
2669 </h4>
2670 <p>
2671 Compressed dumps are built in memory and because of this are limited to
2672 php's memory limit. For GZip/BZip2 exports this can be overcome since
2673 2.5.4 using <tt>$cfg['CompressOnFly']</tt> (enabled by default). Zip
2674 exports can not be handled this way, so if you need Zip files for larger
2675 dump, you have to use another way.
2676 </p>
2678 <h4>
2679 [3.3] With InnoDB tables, I lose foreign key relationships when I rename
2680 or alter a table.
2681 </h4>
2682 <p>
2683 This seems to be a InnoDB bug (fixed in MySQL 3.23.50?).
2684 </p>
2686 <h4>
2687 [3.4] I am unable to import dumps I created with the mysqldump tool
2688 bundled with the MySQL server distribution.
2689 </h4>
2690 <p>
2691 The problem is that mysqldump creates invalid comments like this:
2692 </p>
2693 <pre>
2694 -- MySQL dump 8.22
2695 --
2696 -- Host: localhost Database: database
2697 ---------------------------------------------------------
2698 -- Server version 3.23.54
2699 </pre>
2700 <p>
2701 The invalid part of the code is the horizontal line made of dashes that
2702 appears once in every dump created with mysqldump. If you want to run your
2703 dump you have to turn it into valid MySQL. This means, you have to add a
2704 whitespace after the first to dashes of the line or add a # before it:
2705 <br />
2706 <code>
2707 -- -------------------------------------------------------<br />
2708 </code>
2709 or<br />
2710 <code>
2711 #---------------------------------------------------------
2712 </code>
2713 </p>
2715 <h4>
2716 [3.5] When using nested folders ($cfg['LeftFrameTableSeparator']) there
2717 are some multiple hierarchies displayed in a wrong manner?!
2718 </h4>
2719 <p>
2720 Please note that you should not use the seperating string multiple times
2721 without any characters between them, or at the beginning/end of your table
2722 name. If you have to, think about using another TableSeparator or disabling
2723 that feature
2724 </p>
2726 <h4>
2727 [3.6] What is currently not supported in phpMyAdmin about InnoDB?
2728 </h4>
2729 <p>
2730 In Relation view, being able to choose a table in another database,
2731 or having more than one index field in the foreign key.<br /><br/>
2732 In Query-by-example (Query), automatic generation of the query
2733 LEFT JOIN from the foreign table.
2734 </p>
2737 <h3>[4. ISPs, multi-user installations ]</h3>
2739 <h4>
2740 [4.1] I'm an ISP. Can I setup one central copy of phpMyAdmin or do I
2741 need to install it for each customer.
2742 </h4>
2743 <p>
2744 Since version 2.0.3, you can setup a central copy of phpMyAdmin for all
2745 your users. The development of this feature was kindly sponsored by
2746 NetCologne GmbH.
2747 This requires a properly setup MySQL user management and phpMyAdmin
2748 HTTP or cookie authentication. See the install section on
2749 "Using HTTP authentication".
2750 </p>
2752 <h4>
2753 [4.2] What's the preferred way of making phpMyAdmin secure against evil
2754 access.
2755 </h4>
2756 <p>
2757 This depends on your system.<br />
2758 If you're running a server which cannot be accessed by other people, it's
2759 sufficient to use the directory protection bundled with your webserver
2760 (with Apache you can use <i>.htaccess</i> files, for example).<br />
2761 If other people have telnet access to your server, you should use
2762 phpMyAdmin's HTTP authentication feature.
2763 <br /><br />
2764 Suggestions:
2765 </p>
2766 <ul>
2767 <li>
2768 Your <i>config.inc.php3</i> file should be <tt>chmod 660</tt>.
2769 </li>
2770 <li>
2771 All your phpMyAdmin files should be chown phpmy.apache, where phpmy
2772 is a user whose password is only known to you, and apache is the
2773 group under which Apache runs.
2774 </li>
2775 <li>
2776 You should use PHP safe mode, to protect from other users that try
2777 to include your <i>config.inc.php3</i> in their scripts.
2778 </li>
2779 </ul>
2781 <h4>
2782 [4.3] I get errors about not being able to include a file in
2783 <i>/lang</i> or in <i>/libraries</i>.
2784 </h4>
2785 <p>
2786 Check <i>php.ini</i>, or ask your sysadmin to check it. The
2787 <tt>include_path</tt> must contain "." somewhere in it, and
2788 <tt>open_basedir</tt>, if used, must contain "." and
2789 "./lang" to allow normal operation of phpMyAdmin.
2790 </p>
2791 <h4>
2792 [4.4] phpMyAdmin always gives "Access denied" when using HTTP
2793 authentication.
2794 </h4>
2795 <p>
2796 This could happen for several reasons:
2797 </p>
2798 <ul>
2799 <li>
2800 <tt>$cfg['Servers'][$i]['controluser']</tt> and/or
2801 <tt>$cfg['Servers'][$i]['controlpass']</tt> are wrong.
2802 </li>
2803 <li>
2804 The username/password you specify in the login-dialog are invalid.
2805 </li>
2806 <li>
2807 You have already setup a security mechanism for the
2808 phpMyAdmin-directory, eg. a .htaccess file. This would interfere with
2809 phpMyAdmin's authentication, so remove it.
2810 </li>
2811 </ul>
2813 <h4>
2814 [4.5] Is it possible to let users create their own databases?
2815 </h4>
2816 <p>
2817 Starting with 2.2.5, in the user management page, you can enter a wildcard
2818 database name for a user (for example "joe%"),
2819 and put the privileges you want. For example,
2820 adding <tt>SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER</tt>
2821 would let a user create/manage his/her database(s).
2822 </p>
2824 <h4>
2825 [4.6] How can I use the Host-based authentication additions?
2826 </h4>
2827 <p>
2828 If you have existing rules from an old .htaccess file, you can take them
2829 and add a username between the <tt>'deny'</tt>/<tt>'allow'</tt> and
2830 <tt>'from'</tt> strings. Using the username wildcard of <tt>'%'</tt> would
2831 be a major benefit here if your installation is suited to using it. Then
2832 you can just add those updated lines into the
2833 <tt>$cfg['Servers'][$i]['AllowDeny']['rules']</tt> array.
2834 <br /><br />
2835 If you want a pre-made sample, you can try this fragment. It stops the
2836 'root' user from logging in from any networks other than the private
2837 network IP blocks.
2838 <br />
2839 <tt>
2840 //block root from logging in except from the private networks<br />
2841 $cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';<br />
2842 $cfg['Servers'][$i]['AllowDeny']['rules'] = array(<br />
2843 'deny root from all',<br />
2844 'allow root from localhost',<br />
2845 'allow root from 10.0.0.0/8',<br />
2846 'allow root from 192.168.0.0/16',<br />
2847 'allow root from 172.16.0.0/12',<br />
2848 );
2849 </tt>
2850 </p>
2851 <h4>
2852 [4.7] Authentication window is displayed more than once, why?
2853 </h4>
2854 <p>
2855 This happens if you are using a URL to start phpMyAdmin which is
2856 different than the one set in your <tt>$cfg['PmaAbsoluteUri']</tt>.
2857 For example, a missing "www", or entering with an IP address
2858 while a domain name is defined in the config file.
2859 </p>
2862 <h3>[5. Browsers or client OS]</h3>
2864 <h4>
2865 [5.1] I get an out of memory error, and my controls are non-functional,
2866 when trying to create a table with more than 14 fields.
2867 </h4>
2868 <p>
2869 We could reproduce this problem only under Win98/98SE. Testing under
2870 WinNT4 or Win2K, we could easily create more than 60 fields.
2871 <br />
2872 A workaround is to create a smaller number of fields, then come back to
2873 your table properties and add the other fields.
2874 </p>
2876 <h4>
2877 [5.2] With Xitami 2.5b4, phpMyAdmin won't process form fields.
2878 </h4>
2879 <p>
2880 This is not a phpMyAdmin problem but a Xitami known bug: you'll face it
2881 with each script/website that use forms.<br />
2882 Upgrade or downgrade your Xitami server.
2883 </p>
2885 <h4>
2886 [5.3] I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).
2887 </h4>
2888 <p>
2889 With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except that
2890 the proposed file name for the dump is always 'tbl_dump.php'. Bzip2 dumps
2891 don't seem to work.<br />
2893 With Konqueror 2.2.1: plain dumps work; zip dumps are placed into
2894 the user's temporary directory, so they must be moved before closing
2895 Konqueror, or else they disappear. GZip dumps give an error message.<br />
2897 Testing needs to be done for Konqueror 2.2.2.<br />
2898 </p>
2900 <h4>
2901 [5.4] I can't use the cookie authentication mode because Internet
2902 Explorer never stores the cookies.
2903 </h4>
2904 <p>
2905 MS Internet Explorer seems to be really buggy about cookies, at least till
2906 version 6. And thanks to Andrew Zivolup we've traced also a PHP 4.1.1 bug
2907 in this area!
2908 <br />
2909 Then, if you're running PHP 4.1.1, try to upgrade or downgrade... it may
2910 work!
2911 </p>
2913 <h4>
2914 [5.5] In Internet Explorer 5.0, I get JavaScript errors when browsing my
2915 rows.
2916 </h4>
2917 <p>
2918 Upgrade to at least Internet Explorer 5.5 SP2.<br />
2919 </p>
2921 <h4>
2923 when trying to modify a row in a table with many fields, or with a text field
2924 </h4>
2925 <p>
2926 Your table neither have a primary key nor an unique one, so we must use a
2927 long URL to identify this row. There is a limit on the length of the URL in
2928 those browsers, and this not happen in Netscape, for example. The
2929 workaround is to create a primary or unique key, or use another browser.
2930 <br />
2931 </p>
2933 <h4>
2934 [5.7] I refresh (reload) my browser, and come back to the welcome
2935 page.
2936 </h4>
2937 <p>
2938 Some browsers support right-clicking into the frame you want to refresh,
2939 just do this in the right frame.<br />
2940 </p>
2942 <h4>
2943 [5.8] With Mozilla 0.9.7 I have problems sending a query modified in the
2944 query box.
2945 </h4>
2946 <p>
2947 Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
2948 Mozilla versions.<br />
2949 </p>
2951 <h4>
2952 [5.9] With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
2953 whitespace in the SQL-Query edit area: the page scrolls down.
2954 </h4>
2955 <p>
2956 This is a Mozilla bug (see bug #26882 at
2958 </p>
2960 <h4>
2961 [5.10] With Netscape 4.75 I get empty rows between each row of data in a
2962 CSV exported file.
2963 </h4>
2964 <p>
2965 This is a known Netscape 4.75 bug: it adds some line feeds when exporting
2966 data in octet-stream mode. Since we can't detect the specific Netscape
2967 version, we cannot workaround this bug.
2968 </p>
2970 <h4>
2971 [5.11] Extended-ASCII characters like German umlauts are displayed
2972 wrong.
2973 </h4>
2974 <p>
2975 Please ensure that you have set your browser's character set to the one of the
2976 language file you have selected on phpMyAdmin's start page.
2977 Alternatively, you can try the auto detection mode that is supported by the
2978 recent versions of the most browsers.
2979 </p>
2981 <h4>
2982 [5.12] Apple OS X: Safari browser changes special characters to
2983 "?".
2984 </h4>
2985 <p>
2986 This issue has been reported by a OS X user, who adds that Chimera,
2987 Netscape and Mozilla do not have this problem.
2988 </p>
2990 <h4>
2991 [5.13] With Internet Explorer 5.5 or 6, and HTTP authentication type,
2992 I cannot manage two servers: I login to the first one, then the other one,
2993 but if I switch back to the first, I have to login on each operation.
2994 </h4>
2995 <p>
2996 This is a bug in Internet Explorer, other browsers do not behave this way.
2997 </p>
2999 <h4>
3000 [5.14] Using Opera6, I can manage to get to the authentification, but nothing
3001 happens after that, only a blank screen.
3002 </h4>
3003 <p>
3004 Having $cfg['QueryFrameJS'] set to TRUE, this leads to a bug in Opera6, because it
3005 is not able to interpret frameset definitiions written by JavaScript. Please upgrade
3006 to Opera7 at least.
3007 </p>
3010 <h3>[6. Using phpMyAdmin]</h3>
3012 <h4>
3013 [6.1] I can't insert new rows into a table / I can't create a table
3014 - MySQL brings up a SQL-error.
3015 </h4>
3016 <p>
3017 Examine the SQL error with care. Often the problem is caused by
3018 specifying a wrong field-type.<br />
3019 Common errors include:
3020 </p>
3021 <ul>
3022 <li>Using <tt>VARCHAR</tt> without a size argument</li>
3023 <li>Using <tt>TEXT</tt> or <tt>BLOB</tt> with a size argument</li>
3024 </ul>
3025 <p>
3026 Also, look at the syntax chapter in the MySQL manual to confirm that your
3027 syntax is correct.
3028 </p>
3030 <h4>
3031 [6.2] When I create a table, I click the Index checkbox for 2 fields and
3032 phpMyAdmin generates only one index with those 2 fields.
3033 </h4>
3034 <p>
3035 In phpMyAdmin 2.2.0 and 2.2.1, this is the way to create a multi-fields
3036 index. If you want two indexes, create the first one when creating the
3037 table, save, then display the table properties and click the Index link to
3038 create the other index.
3039 </p>
3041 <h4>
3042 [6.3] How can I insert a null value into my table?
3043 </h4>
3044 <p>
3045 Since version 2.2.3, you have a checkbox for each field that can be null.
3046 Before 2.2.3, you had to enter "null", without the quotes, as the
3047 field's value.
3048 </p>
3050 <h4>
3051 [6.4] How can I backup my database or table?
3052 </h4>
3053 <p>
3054 Click on a database or table name in the left frame, the properties will be
3055 displayed. Then on the menu, click "Export", you can dump
3056 the structure, the data, or both. This will generate standard SQL
3057 statements that can be used to recreate your database/table.
3058 <br /><br />
3059 You will need to choose "Save as file", so that phpMyAdmin can
3060 transmit the resulting dump to your station. Depending on your PHP
3061 configuration, you will see options to compress the dump. See also the
3062 <tt>$cfg['ExecTimeLimit']</tt> configuration variable.
3063 <br /><br />
3064 For additional help on this subject, look for the word "dump" in
3065 this document.
3066 </p>
3068 <h4>
3069 [6.5] How can I restore (upload) my database or table using a dump?
3070 How can I run a ".sql" file.
3071 </h4>
3072 <p>
3073 Click on a database name in the left frame, the properties will be
3074 local displayed. Then in the "Run SQL query" section, type in
3075 your dump filename, or use the Browse button. Then click Go.
3076 <br /><br />
3077 For additional help on this subject, look for the word "upload"
3078 in this document.
3079 </p>
3081 <h4>
3082 [6.6] How can I use the relation table in Query-by-example?
3083 </h4>
3084 <p>
3085 Here is an example with the tables persons, towns and countries, all
3086 located in the database mydb. If you don't have a <tt>PMA_relation</tt>
3087 table, create it as explained in the configuration section. Then create the
3088 example tables:
3089 <br /><br />
3090 <tt>
3091 CREATE TABLE REL_countries (<br />
3092 country_code char(1) NOT NULL default '',<br />
3093 description varchar(10) NOT NULL default '',<br />
3094 PRIMARY KEY (country_code)<br />
3095 ) TYPE=MyISAM;<br />
3096 <br />
3097 INSERT INTO REL_countries VALUES ('C', 'Canada');<br />
3098 <br />
3099 CREATE TABLE REL_persons (<br />
3100 id tinyint(4) NOT NULL auto_increment,<br />
3101 person_name varchar(32) NOT NULL default '',<br />
3102 town_code varchar(5) default '0',<br />
3103 country_code char(1) NOT NULL default '',<br />
3104 PRIMARY KEY (id)<br />
3105 ) TYPE=MyISAM;<br />
3106 <br />
3107 INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');<br />
3108 INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');<br />
3109 <br />
3110 CREATE TABLE REL_towns (<br />
3111 town_code varchar(5) NOT NULL default '0',<br />
3112 description varchar(30) NOT NULL default '',<br />
3113 PRIMARY KEY (town_code)<br />
3114 ) TYPE=MyISAM;<br />
3115 <br />
3116 INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');<br />
3117 INSERT INTO REL_towns VALUES ('M', 'Montréal');<br />
3118 <br />
3119 </tt>
3120 To setup appropriate links and display information:
3121 </p>
3122 <ul>
3123 <li>on table "REL_persons" click Structure, then Relation view</li>
3124 <li>in Links, for "town_code" choose "REL_towns->code"</li>
3125 <li>in Links, for "country_code" choose "REL_countries->country_code"</li>
3126 <li>on table "REL_towns" click Structure, then Relation view</li>
3127 <li>in "Choose field to display", choose "description"</li>
3128 <li>repeat the two previous steps for table "REL_countries"</li>
3129 </ul>
3131 <p>
3132 Then test like this:
3133 </p>
3134 <ul>
3135 <li>Click on your db name in the left frame</li>
3136 <li>Choose "Query"</li>
3137 <li>Use tables: persons, towns, countries</li>
3138 <li>Click "Update query"</li>
3139 <li>In the fields row, choose persons.person_name and click the
3140 "Show" tickbox </li>
3141 <li>Do the same for towns.description and countries.descriptions in the
3142 other 2 columns</li>
3143 <li>Click "Update query" and you will see in the query box that
3144 the correct joins have been generated</li>
3145 <li>Click "Submit query"</li>
3146 </ul>
3147 <br />
3150 <h4>
3151 [6.7] How can I use the "display field" feature?
3152 </h4>
3153 <p>
3154 Starting from the previous example, create the PMA_table_info as explained
3155 in the configuration section, then browse your persons table,
3156 and move the mouse over a town code or country code.
3157 <br /><br />
3158 See also FAQ 6.21 for an additionnal feature that "display field"
3159 enables: drop-down list of possible values.
3160 </p>
3163 <h4>
3164 [6.8] How can I produce a PDF schema of my database?
3165 </h4>
3166 <p>
3167 First you have to fill the "relation", "table_coords"
3168 and "pdf_pages" configuration variables.
3169 <br /><br />
3170 Then, think about your schema layout: which tables will go on which pages.
3171 </p>
3172 <ul>
3173 <li>Click on your db name in the left frame</li>
3174 <li>Choose "Structure" in the navigation on top</li>
3175 <li>Choose "Edit PDF Pages" which should be somewhere at the
3176 bottom of the page</li>
3177 <li>Enter the name for a first pdf page and submit (you can also use
3178 the "Automatic layout", which will place on your page
3179 all the tables that are linked)</li>
3180 <li>Choose this page to edit</li>
3181 <li>Now add a table you want to show on this page and its coordinates and
3182 submit<br />
3183 First you will have to guess those coordinates of course, so just expect
3184 to have an area of about 297 * 210 and put the tables coordinates
3185 somewhere in there, you will be able to have a look at what happened
3186 and change them later.<br />
3187 For example, x=100 and y=200 means that the table will be at 200 mm
3188 down and 100 mm right from the upper left corner.<br />
3189 Actually if you have a width of more than 300 or a height of more than
3190 200 then it will automatically be scaled but 200*100 is a good start to
3191 have an idea of what coordinates to use.</li>
3192 <li>There is also a visual editor (scratchboard) available, see the
3194 <li>After every table you submitted you will have the possibility to submit
3195 more tables</li>
3196 <li>When you have entered enough tables Click on your db name in the left
3197 frame again</li>
3198 <li>Now, again at the bottom of the page you should be able to choose
3199 "Display PDF schema"<br />
3200 For testing it might be useful to show the grid as well, so you can see
3201 the coordinates used.<br />
3202 Maybe also choose color and submit.</li>
3203 <li>Save the file he will offer you to something like <i>Schema.pdf</i>
3204 (Internet Explorer has some bug there which might make it offer it
3205 without an extension. Under Windows it is important to have the
3206 extension ".pdf", under other OSes you should be fine just
3207 saving the file under the name it offers).</li>
3208 </ul>
3210 <h4>
3211 [6.9] phpMyAdmin is changing the type of one of my columns!
3212 </h4>
3213 <p>
3214 No, it's MySQL that is doing
3215 <a href="http://www.mysql.com/doc/S/i/Silent_column_changes.html">silent column type changing</a>.
3216 </p>
3219 <h4>
3220 [6.10] When creating a privilege, what happens with underscores in
3221 the database name?
3222 </h4>
3223 <p>
3224 If you do not put a backslash before the underscore, this is a wildcard
3225 grant, and the underscore means "any character". So, if the
3226 database name is "john_db", the user would get rights to john1db,
3227 john2db...<br /><br />
3228 If you put a backslash before the underscore, it means that the database
3229 name will have a real underscore.
3230 </p>
3232 <h4>
3233 [6.11] What is the curious symbol ø in the statistics pages?
3234 </h4>
3235 <p>
3236 It means "average".
3237 </p>
3240 <h4>
3241 [6.12] I want to understand some Export options.
3242 </h4>
3243 <p>
3244 "Complete inserts" adds the column names on every INSERT command,
3245 for better documentation (but resulting file is bigger).<br />
3246 "Extended inserts" provides a shorter dump file by using only
3247 once the INSERT verb and the table name.<br />
3248 "Enclose table and field names with backquotes" ensures that
3249 field and table names formed with special characters are protected.<br />
3250 "Add AUTO_INCREMENT value" ensures, that AUTO_INCREMENT value
3251 (if any) will be included in backup.<br />
3252 "Add into comments" includes column comments, relations and MIME
3253 types set in the PMA-DB in the dump as SQL comments (<i>/* xxx */</i>).<br />
3254 </p>
3256 <h4>
3257 [6.13] I would like to create a database with a dot in its name.
3258 </h4>
3259 <p>
3260 This is a bad idea, because in MySQL the syntax "database.table"
3261 is the normal way to reference a database and table name. Worse, MySQL
3262 will usually let you create a database with a dot, but then you cannot
3263 work with it, nor delete it.<br />
3264 </p>
3267 <h4>
3268 [6.14] How do I set up the SQL Validator?
3269 </h4>
3270 <p>
3271 To use it, you need a very recent version of PHP, 4.3.0 recommended, with
3272 XML, PCRE and PEAR support. On your system command line, run
3273 <tt>"pear install Net_Socket Net_URL HTTP_Request Mail_Mime Net_DIME
3274 SOAP"</tt> to get the necessary PEAR modules for usage.
3275 <br />
3276 If you use it, you should be aware that any SQL statement you
3277 submit will be stored anonymously (database/table/column names,
3278 strings, numbers replaced with generic values). The Mimer SQL
3279 Validator itself, is © 2001 Upright Database Technology.
3280 We utilize it as free SOAP service.
3281 </p>
3283 <h4>
3284 [6.15] I want to add a BLOB field and put an index on it, but MySQL
3285 says "BLOB column '...' used in key specification without a key
3286 length".
3287 </h4>
3288 <p>
3289 The right way to do this, is to create the field without any indexes,
3290 then display the table structure and use the "Create an index"
3291 dialog. On this page, you will be able to choose your BLOB field, and
3292 set a size to the index, which is the condition to create an index on
3293 a BLOB field.
3294 <br />
3295 </p>
3297 <h4>
3298 [6.16] How can I simply move in page with plenty editing fields?
3299 </h4>
3300 <p>
3301 You can use Ctrl+arrows for moving on most pages with plenty editing
3302 fields (table structure changes, row editing, etc.) (must be anabled in
3303 configuration - see. $cfg['CtrlArrowsMoving']). You can also have a look
3304 at the directive $cfg['DefaultPropDisplay'] ('vertical') and see if this
3305 eases up editing for you.
3306 <br />
3307 </p>
3309 <h4>
3310 [6.17] Transformations: I can't enter my own mimetype! WTF is this feature
3311 then useful for?
3312 </h4>
3313 <p>
3314 Slow down :). Defining mimetypes is of no use, if you can't put transformations on them.
3315 Otherwise you could just put a comment on the field. Because entering your own mimetype will
3316 cause serious syntax checking issues and validation, this introduces a high-risk false-user-input
3317 situation. Instead you have to initialize mimetypes using functions or empty mimetype definitions.
3318 <br />
3319 Plus, you have a whole overview of available mimetypes. Who knows all those mimetypes by heart so
3320 he/she can enter it at will?
3321 <br />
3322 </p>
3325 <h4>
3326 [6.18] Bookmarks: Where can I store bookmarks? Why can't I see any bookmarks below the query box?
3327 What is this variable for?
3328 </h4>
3329 <p>
3330 Any query you have executed can be stored as a bookmark on the page where the results are displayed.
3331 You will find a button labeled 'Bookmark this query' just at the end of the page.<br />
3332 As soon as you have stored a bookmark, it is related to the database you run the query on. You can
3333 now access a bookmark dropdown on each page, the query box appears on for that database.<br />
3334 <br />
3335 Since phpMyAdmin 2.5.0 you are also able to store variables for the bookmarks. Just use the string
3336 <b>/*[VARIABLE]*/</b> anywhere in your query. Everything which is put into the <i>value</i> input
3337 box on the query box page will replace the string "/*[VARIABLE]*/" in your stored query.
3338 Just be aware of that you HAVE to create a valid query, otherwise your query won't be even able to be
3339 stored in the database.<br />
3340 Also remember, that everything else inside the <b>/*[VARIABLE]*/</b> string for your query will remain
3341 the way it is, but will be stripped of the /**/ chars. So you can use:<br /><br />
3342 <code>/*, [VARIABLE] AS myname */</code><br /><br />
3343 which will be expanded to<br /><br />
3344 <code>, VARIABLE as myname</code><br /><br />
3345 in your query, where VARIABLE is the string you entered in the input box. If an empty string is
3346 provided, no replacements are made.<br />
3347 <br />
3348 A more complex example. Say you have stored this query:<br /><br />
3349 <code>SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE '%[VARIABLE]%' */</code><br /><br />
3350 Say, you now enter "phpMyAdmin" as the variable for the stored query, the full query will
3351 be:<br /><br />
3352 <code>SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE '%phpMyAdmin%'</code>
3353 <br />
3354 <br />
3355 You can use multiple occurences of <b>/*[VARIABLE]*/</b> in a single query.<br />
3356 <b>NOTE THE ABSENCE OF SPACES</b> inside the "/**/" construct. Any spaces inserted there
3357 will be later also inserted as spaces in your query and may lead to unexpected results especially when
3358 using the variable expansion inside of a "LIKE ''" expression.<br />
3359 Your initial query which is going to be stored as a bookmark has to yield at least one result row so
3360 you can store the bookmark. You may have that to work around using well positioned "/**/"
3361 comments.<br />
3362 <b>Variable expansion with PHP-Versions prior to 4.0.3 may not work as expected due to a necessary extra-space after any [VARIABLE] usage</b>
3363 </p>
3365 <h4>
3366 [6.19] How can I create simple LaTeX document to include exported table?
3367 </h4>
3368 <p>
3369 You can simply include table in your LaTeX documents, minimal sample
3370 document should look like following one (assuming you have table
3371 exported in file <code>table.tex</code>):
3372 <br />
3373 <br />
3374 <pre>
3375 <font color="#a52a2a"><b>\documentclass</b></font><font color="#6a5acd">{</font><font color="#a020f0">article</font><font color="#6a5acd">}</font>
3376 <font color="#a52a2a"><b>\usepackage</b></font><font color="#6a5acd">{</font><font color="#6a5acd">longtable</font><font color="#6a5acd">}</font>
3378 <font color="#a52a2a"><b>\begin</b></font><font color="#6a5acd">{</font><font color="#a020f0">document</font><font color="#6a5acd">}</font>
3380 <font color="#a52a2a"><b>\include</b></font><font color="#6a5acd">{</font><font color="#6a5acd">table</font><font color="#6a5acd">}</font>
3382 <font color="#a52a2a"><b>\end</b></font><font color="#6a5acd">{</font><font color="#a020f0">document</font><font color="#6a5acd">}</font>
3383 </pre>
3384 </p>
3386 <h4>
3387 [6.20] In MySQL 4, I see a lot of databases which are not mine, and cannot
3388 access them.
3389 </h4>
3390 <p>
3391 Upgrading to MySQL 4 usually gives users those global privileges: CREATE
3392 TEMPORARY TABLES, SHOW DATABASES, LOCK TABLES. Those privileges also
3393 enables users to see all the database names, until you upgrade the grant
3394 tables as described in the MySQL manual, section 2.5.6.
3396 So if your users do not need those privileges, you can remove them and their
3397 databases list will shorten.
3398 </p>
3399 <h4>
3400 [6.21] In edit/insert mode, how can I see a list of possible values for
3401 a field, based on some foreign table?
3402 </h4>
3403 <p>
3404 You have to setup appropriate links between the tables, and also
3405 setup the "display field" in the foreign table. See FAQ
3406 6.6 for an example. Then, if there are 200 values or less in the
3407 foreign table, a drop-down list of values will be available.
3408 </p>
3410 <h3>[7. phpMyAdmin project]</h3>
3412 <h4>
3413 [7.1] I have found a bug. How do I inform developers?
3414 </h4>
3415 <p>
3416 Our Bug Tracker is located at
3417 <a href="http://sourceforge.net/projects/phpmyadmin/">http://sourceforge.net/projects/phpmyadmin/</a>
3418 under the Bugs section.
3419 <br /><br />
3420 But please first discuss your bug with other users:
3421 <br />
3423 http://sourceforge.net/projects/phpmyadmin/</a> (and choose Forums)
3424 </p>
3426 <h4>
3427 [7.2] I want to translate the messages to a new language or upgrade an
3428 existing language, where do I start?
3429 </h4>
3430 <p>
3431 Always use the current CVS version of your language file.
3432 For a new language, start from <i>english-iso-8859-1.inc.php3</i>. If you
3433 don't know how to get the CVS version, please ask one of the developers.
3434 <br />
3435 Please note that we try not to use HTML entities like &eacute; in
3436 the translations, since we define the right character set in the file.
3437 With HTML entities, the text on JavaScript messages would not
3438 display correctly.
3439 However there are some entities that need to be there, for quotes
3440 ,non-breakable spaces, ampersands, less than, greater than.
3441 <br />
3442 You can then put your translations, as a zip file to avoid losing special
3443 characters, on the sourceforge.net translation tracker.
3444 <br />
3445 It would be a good idea to subscribe to the phpmyadmin-translators mailing
3446 list, because this is where we ask for translations of new messages.
3447 <br />
3448 </p>
3450 <h4>
3451 [7.3] I would like to help out with the development of phpMyAdmin. How
3452 should I proceed?
3453 </h4>
3454 <p>
3455 The following method is preferred for new developers:
3456 </p>
3457 <ol>
3458 <li>
3459 fetch the current CVS tree over anonymous CVS:<br />
3460 <tt>cvs -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin login</tt><br />
3461 [Password: simply press the Enter key]<br />
3462 <tt>cvs -z3 -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin checkout phpMyAdmin</tt><br />
3463 [This will create a new sub-directory named phpMyAdmin]
3464 </li>
3465 <li>
3466 add your stuff
3467 </li>
3468 <li>
3469 put the modified files (tar'ed and gzip'ed) inside the patch tracker of
3470 the
3471 <a href="http://sourceforge.net/projects/phpmyadmin/" target="_blank">phpMyAdmin SourceForge account</a>.
3472 </li>
3473 </ol>
3474 <p>
3475 Write access to the CVS tree is granted only to experienced developers who
3476 have already contributed something useful to phpMyAdmin.<br />
3477 Also, have a look at the
3479 </p>
3481 <h3>[8. Security ]</h3>
3483 <h4>
3484 [8.1] Security alert, dated 2003-06-18.
3485 </h4>
3486 <p>
3487 Last update of this FAQ: 2003-07-22.
3488 <br /><br />
3489 The phpMyAdmin development team received notice of this security alert:
3490 <a href="http://www.securityfocus.com/archive/1/325641" target="_blank">http://www.securityfocus.com/archive/1/325641.</a>
3491 <br /><br />
3493 The team regrets that the author did not communicate with us before
3494 sending this alert. However, here is our current reply to the points mentionned:
3495 <br /><br />
3496 <ul>
3497 <li>"Directory transversal attack"
3498 <br /><br />
3500 This problem had been fixed in version 2.5.0, even if the author reports
3501 the 2.5.2 development version as vulnerable, which we could not reproduce.
3502 <br /><br />
3503 </li>
3504 <li>"Remote local file retrieving"
3505 <br /><br />
3506 This is a misleading title, as the author tells in his text:
3507 "Note that you can't request files ( only dirs )".
3508 <br /><br />
3509 </li>
3511 <li>"Remote internal directory listing"
3512 <br /><br />
3513 It was possible to retrieve the list of phpMyAdmin's directory (which we
3514 doubt can cause any damage), but we fixed this in the
3515 2.5.2 version.
3516 <br /><br />
3517 </li>
3519 <li>"XSS and Path disclosures"
3520 <br /><br />
3521 Most of the XSS problems have been fixed in version 2.5.0. The rest
3522 have been fixed in the 2.5.2 version.
3523 <br /><br />
3524 We believe that the Path disclosures problems have also been fixed
3525 in version 2.5.2.
3526 <br /><br />
3527 </li>
3528 <li>"Information encoding weakness"
3529 <br /><br />
3530 We believe that an exploit for this weakness would be difficult
3531 to achieve. However version 2.5.2 now encrypts the password
3532 with the well-known blowfish algorithm.
3533 <br /><br />
3534 </li>
3535 </ul>
3537 </p>
3539 <!-- DEVELOPERS -->
3541 <h2>Developers Information</h2>
3543 <p>
3544 phpMyAdmin is Open Source, so you're invited to contribute to it. Many
3545 great features have been written by other people and you too can help to
3546 make phpMyAdmin a useful tool.
3547 </p>
3549 <p>
3550 If you're planning to contribute source, please read the following
3551 information:
3552 </p>
3553 <ul>
3554 <li>
3555 All files include <i>header.inc.php3</i> (layout),
3556 <i>libraries/common.lib.php3</i> (common functions) and
3557 <i>config.inc.php3</i>.
3558 <br />
3559 All configuration data belongs in <i>config.inc.php3</i>. Please keep
3560 it free from other code.
3561 <br />
3562 Commonly used functions should be added to
3563 <i>libraries/common.lib.php3</i> and more specific ones may be added
3564 within a library stored into the <i>libraries</i> sub-directory.
3565 </li>
3566 <li>
3567 Obviously, you're free to use whatever coding style you want. But
3568 please try to keep your code as simple as possible: beginners are
3569 using phpMyAdmin as an example application.<br />
3570 As far as possible, we want the scripts to be XHTML1.0 and CSS2
3571 compliant on one hand, they fit the
3573 on the other hand. Please pay attention to this.
3574 </li>
3575 <li>
3576 Please try to keep up the file-naming conventions. Table-related stuff
3577 goes to <i>tbl_*.php3</i>, db-related code to <i>db_*.php3</i>,
3578 server-related tools to <i>server_*.php3</i> and so on.
3579 </li>
3580 <li>
3581 Please don't use verbose strings in your code, instead add the string
3582 (at least) to <i>english-iso-8859-1.inc.php3</i> and print() it out.
3583 </li>
3584 <li>
3585 If you want to be really helpful, write an entry for the ChangeLog.
3586 </li>
3589 Debugger DBG</a>) is now supported by phpMyAdmin for developers to
3590 better debug and profile their code.<br />
3591 Please see the <tt>$cfg['DBG']*</tt> configuration options for more
3592 information.<br />
3593 This is in memoriam of the Space Shuttle Columbia (STS-107) which was
3594 lost during its re-entry into Earth's atmosphere and in memory of the
3595 brave men and women who gave their lives for the people of Earth.
3596 </li>
3598 </ul>
3600 <!-- CREDITS -->
3602 <h2>Credits</h2>
3604 <pre>
3606 phpMyAdmin - Credits
3607 ====================
3609 CREDITS, in chronological order
3610 -------------------------------
3612 - Tobias Ratschiller <tobias.ratschiller_at_maguma.com>
3613 * creator of the phpmyadmin project
3614 * maintainer from 1998 to summer 2000
3616 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca>
3617 * multi-language version
3618 * various fixes and improvements
3619 * project co-administrator
3621 - Olivier Müller <om_at_omnis.ch>
3622 * started SourceForge phpMyAdmin project in March 2001
3623 * sync'ed different existing CVS trees with new features and bugfixes
3624 * multi-language improvements, dynamic language selection
3625 * current project maintainer
3626 * many bugfixes and improvements
3628 - Loïc Chapeaux <lolo_at_phpheaven.net>
3629 * rewrote and optimized javascript, DHTML and DOM stuff
3630 * rewrote the scripts so they fit the PEAR coding standards and
3631 generate XHTML1.0 and CSS2 compliant codes
3632 * improved the language detection system
3633 * many bugfixes and improvements
3635 - Robin Johnson <robbat2_at_users.sourceforge.net>
3636 * database maintence controls
3637 * table type code
3638 * Host authentication IP Allow/Deny
3639 * DB-based configuration (Not completed)
3640 * SQL parser
3641 * SQL validator
3642 * many bugfixes and improvements
3644 - Armel Fauveau <armel.fauveau_at_globalis-ms.com>
3645 * bookmarks feature
3646 * multiple dump feature
3647 * gzip dump feature
3648 * zip dump feature
3650 - Geert Lund <glund_at_silversoft.dk>
3651 * various fixes
3652 * moderator of the phpMyAdmin users forum at phpwizard.net
3654 - Korakot Chaovavanich <korakot_at_iname.com>
3655 * "insert as new row" feature
3657 - Pete Kelly <webmaster_at_trafficg.com>
3658 * rewrote and fix dump code
3659 * bugfixes
3661 - Steve Alberty <alberty_at_neptunlabs.de>
3662 * rewrote dump code for PHP4
3663 * mySQL table statistics
3664 * bugfixes
3666 - Benjamin Gandon <gandon_at_isia.cma.fr>
3667 * main author of the version 2.1.0.1
3668 * bugfixes
3670 - Alexander M. Turek <derrabus_at_gmx.de>
3671 * XML exports
3672 * MySQL 4 related features
3673 * various features and fixes
3674 * German language file updates
3676 - Mike Beck <mike.beck_at_ibmiller.de>
3677 * automatic joins in QBE
3678 * links column in printview
3679 * Relation view
3681 - Michal Cihar <nijel_at_users.sourceforge.net>
3682 * enhanced index creation/display feature
3683 * feature to use a different charset for HTML than for MySQL
3684 * Czech language file updates
3686 - Christophe Gesché from the "MySQL Form Generator for PHPMyAdmin"
3687 (http://sourceforge.net/projects/phpmysqlformgen/)
3688 * suggested the patch for multiple table printviews
3690 - Garvin Hicking <me_at_supergarv.de>
3691 * built the patch for vertical display of table rows
3692 * built the Javascript based Query window + SQL history
3693 * Improvement of column/db comments
3694 * (MIME)-Transformations for columns
3695 * Use custom alias names for Databases in left frame
3696 * hierarchical/nested table display
3697 * PDF-scratchboard for WYSIWYG-distribution of PDF relations
3698 * new icon sets
3699 * vertical display of column properties page
3700 * some bugfixes, features, support, german language additions
3702 - Yukihiro Kawada <kawada_at_den.fujifilm.co.jp>
3703 * japanese kanji encoding conversion feature
3705 - Piotr Roszatycki <d3xter_at_users.sourceforge.net> and Dan Wilson
3706 * the Cookie authentication mode
3708 - Axel Sander <n8falke_at_users.sourceforge.net>
3709 * table relation-links feature
3711 - Maxime Delorme <delorme.maxime_at_free.fr>
3712 * PDF schema output, thanks also to Olivier Plathey for the
3713 "FPDF" library (see http://www.fpdf.org/).
3715 - Olof Edlund <olof.edlund_at_upright.se>
3716 * SQL validator server
3718 - Ivan R. Lanin <ivanlanin_at_users.sourceforge.net>
3719 * phpMyAdmin logo
3721 - Mike Cochrane <mike_at_graftonhall.co.nz>
3722 * blowfish library from the Horde project
3724 And also to the following people who have contributed minor changes,
3725 enhancements, bugfixes or support for a new language since version 2.1.0:
3727 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
3728 Péter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
3729 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kläger,
3730 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
3731 Bernard M. Piller, Laurent Haas, "Sakamoto", Yuval Sarna,
3732 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
3733 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
3734 Luís V., Martijn W. van der Lee,
3735 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
3736 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, "Manuzhai".
3739 Original Credits of Version 2.1.0
3740 ---------------------------------
3742 This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
3743 to create a web-based interface to MySQL using PHP3. Although I have not
3744 used any of his source-code, there are some concepts I've borrowed from
3745 him. phpMyAdmin was created because Peter told me he wasn't going to
3746 further develop his (great) tool.
3747 Thanks go to
3748 - Amalesh Kempf <ak-lsml_at_living-source.com> who contributed the
3749 code for the check when dropping a table or database. He also suggested
3750 that you should be able to specify the primary key on tbl_create.php3. To
3751 version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
3752 well as a bug-report. Plus many smaller improvements.
3753 - Jan Legenhausen <jan_at_nrw.net>: He made many of the changes that
3754 were introduced in 1.3.0 (including quite significant ones like the
3755 authentication). For 1.4.1 he enhanced the table-dump feature. Plus
3756 bug-fixes and help.
3757 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca> made phpMyAdmin
3758 language-independent by outsourcing the strings to a separate file. He
3759 also contributed the French translation.
3760 - Alexandr Bravo <abravo_at_hq.admiral.ru> who contributed
3761 tbl_select.php3, a feature to display only some fields from a table.
3762 - Chris Jackson <chrisj_at_ctel.net> added support for MySQL
3763 functions in tbl_change.php3. He also added the
3764 "Query by Example" feature in 2.0.
3765 - Dave Walton <walton_at_nordicdms.com> added support for multiple
3766 servers and is a regular contributor for bug-fixes.
3767 - Gabriel Ash <ga244_at_is8.nyu.edu> contributed the random access
3768 features for 2.0.6.
3769 The following people have contributed minor changes, enhancements, bugfixes
3770 or support for a new language:
3771 Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
3772 Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
3773 Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
3774 G. Wieggers.
3776 And thanks to everyone else who sent me email with suggestions, bug-reports
3777 and or just some feedback.
3778 </pre>
3785 <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" border="0" height="31" width="88" /></a>
3786
3788 <img src="http://www.w3.org/Icons/valid-css" alt="Valid CSS!" border="0" width="88" height="31" /></a>
3789 </p>
3791 </body>
3792 </html>