| blob | 3ad7919e421837227d940ec643c6548594fcfb5c |
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>
79 </span>
80 </li>
81 <li>
82 a web-browser (doh!).
83 </li>
84 </ul>
87 <!-- INTRODUCTION -->
91 <p>
92 phpMyAdmin can manage a whole MySQL server (needs a super-user) as well as
93 a single database. To accomplish the latter you'll need a properly set up
94 MySQL user who can read/write only the desired database. It's up to you to
95 look up the appropriate part in the MySQL manual.<br />
96 Currently phpMyAdmin can:
97 </p>
99 <ul>
112 <li>using Query-by-example (QBE), create complex queries automatically connecting required tables</li>
115 <li>transform stored data into any format using a set of predefined functions,
116 like displaying BLOB-data as image or download-link or ...</li>
117 <li>
118 communicate in
120 </li>
121 </ul>
124 (*)
125 phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats) dumps
128 </p>
131 <!-- INSTALLATION -->
135 <p>
137 methods to the MySQL database server. It is still the system administrator's job to
138 grant permissions on the MySQL databases properly. </span>phpMyAdmin's
140 </p>
142 <p>
144 version before OS X, StuffIt unstuffs with Mac formats.<br />
145 So you'll have to resave as in BBEdit to Unix style ALL phpMyAdmin scripts
146 before uploading them to your server, as PHP seems not to like Mac-style
148 </p>
150 <p>
153 if you are using a kit with files having this extension.
154 </p>
157 <ol>
158 <li> Choose and download a distribution kit with the files having the
160 web/PHP server interprets those extensions.</li>
161 <li> Untar or unzip the distribution (be sure to unzip the subdirectories):
163 document root. If you don't have direct access to your document root,
164 put the files in a directory on your local machine, and, after step 3,
165 transfer the directory on your web server using, for example, ftp.</li>
166 <li> Open the file config.inc.php3 in your favorite editor and change
167 the values for host, user, password and authentication mode to fit
170 Have a look at
172 explanation of all values.</li>
173 <li> It is recommended that you protect the directory in which you
174 installed phpMyAdmin (unless it's on a closed intranet, or you wish to
175 use HTTP or cookie authentication), for example with HTTP-AUTH (in a
178 information.</li>
179 <li> Open the file
181 in your browser. phpMyAdmin should now display a welcome screen
182 and your databases, or a login dialog if using HTTP or cookie
183 authentication mode.</li>
184 <li> For a whole set of new features (bookmarks, comments, SQL-history, PDF-generation, field contents transformation, etc.)
185 you need to create a set of tables in your database. Please look at your scripts/
187 (If you are using a Windows server, pay special attention to FAQ 1.23).
188 You can already use your phpMyAdmin to create the tables for you. Please be
189 aware that you may have to have special (administrator) privileges to create
191 you should specify the table names in your config.inc.php3 file. The directives
194 </ol>
197 <ul>
198 <li>Please do not copy your older config.inc.php3 over the new one: it may
199 offer new configuration variables, and the new version may depend on
200 these for normal behavior. It is suggested instead to insert your site
201 values in the new one.</li>
202 </ul>
205 <ul>
207 environment</b> where you want to give users access to their own
208 database and don't want them to play around with others.
209 <br />
210 Nevertheless be aware that MS Internet Explorer seems to be really
212 bit buggy in this area!<br />
214 HTTP or cookie mode so that your user/password pair are not in clear
215 in the configuration file.<br /><br /></li>
217 <li>HTTP and cookie authentication modes are more secure: the MySQL
218 password does not need to be set in the phpMyAdmin configuration file
221 <br />
222 However, keep in mind that the password travels in plain text, unless
223 you are using the HTTPS protocol.
224 <br />
225 In cookie mode, the password is stored, encrypted with the blowfish
226 algorithm, in a temporary cookie.
227 <br /><br /></li>
229 <li>
230 For 'HTTP' and 'cookie' modes, phpMyAdmin needs a controluser that has
235 You must specify the details for the controluser in the
241 only an example: use something else in your file!</b><br />
243 if it's not the same as the MySQL server's one.
244 <pre>
246 GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY 'pmapass';
247 GRANT SELECT (
248 Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
249 Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
250 File_priv, Grant_priv, References_priv, Index_priv, Alter_priv,
251 Show_db_priv, Super_priv, Create_tmp_table_priv, Lock_tables_priv,
252 Execute_priv, Repl_slave_priv, Repl_client_priv
253 ) ON mysql.user TO 'pma'@'localhost';
254 GRANT SELECT ON mysql.db TO 'pma'@'localhost';
255 GRANT SELECT ON mysql.host TO 'pma'@'localhost';
256 GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv)
257 ON mysql.tables_priv TO 'pma'@'localhost';
258 </pre>
259 If you are using an old MySQL version (below 4.0.2), please use this
260 query instead of the second one:
261 <pre>
263 GRANT SELECT (
264 Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
265 Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
266 File_priv, Grant_priv, References_priv, Index_priv, Alter_priv
267 ) ON mysql.user TO 'pma'@'localhost';
268 </pre>
269 ... and if you want to use the many new relation and bookmark
270 features:
271 <pre>
274 </pre>
275 (this of course requires you to have a special DB for phpMyAdmin, the
276 contents will be explained later)<br />
277 Of course, the above queries only work if your MySQL version supports
278 the GRANT command. This is the case since 3.22.11.
279 </li>
280 <li>
282 privileges on a set of particular databases. Normally you shouldn't
283 give global privileges to an ordinary user, unless you understand
284 the impact of those privileges (for example, you are creating
285 a superuser).<br />
288 <tt>GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost IDENTIFIED BY 'real_password';</tt>
289 <br />
290 What the user may now do is controlled entirely by the MySQL user
291 management system.<br />
292 With HTTP or cookie authentication mode, you don't need to fill the user/password
294 </li>
295 </ul>
298 <ul>
301 allows you to login as any valid MySQL user.</li>
302 <li>Is only supported with PHP running as an Apache module, not with
303 CGI.</li>
304 </ul>
307 <ul>
308 <li>You can use this method as a replacement for the HTTP
309 authentication (for example, if you're running IIS).
310 </li>
312 <li>With this mode, the use can truly logout of phpMyAdmin and login back
313 with the same username.</li>
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,
412 enter 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.<br />
487 <br /><br />
488 Note that if you try login to phpMyAdmin with this
492 <br /><br />
493 In versions before 2.2.5, those were called
495 <br /><br />
496 </dd>
499 <dd>
500 Whether config or cookie or http authentication should be used for this
501 server.
503 <ul>
504 <li>
505 'config' authentication
507 way: username and password are stored in
509 </li>
510 <li>
511 'cookie' authentication mode
513 2.2.3 allows you to log in as any valid MySQL user with the
514 help of... cookies. Log name and password are stored in
515 cookies during the session and password is deleted when it
516 ends.
517 </li>
518 <li>
519 'http' authentication (was called 'advanced' in older versions)
521 allows you to log in as any valid MySQL user via HTTP-Auth.
522 </li>
523 </ul><br />
526 for more information.
527 <br /><br />
528 </dd>
530 <dt>
533 </dt>
534 <dd>
535 The user/password-pair which phpMyAdmin will use to connect to this
536 MySQL-server. This user/password pair is not needed when HTTP or cookie
537 authentication is used, and should be empty.<br /><br />
538 </dd>
541 <dd>
542 If set to a(an array of) database name(s), only this(these) database(s)
543 will be shown to the user. Since phpMyAdmin 2.2.1, this/these
544 database(s) name(s) may contain MySQL wildcards characters
548 This setting is an efficient way to lower the server charge since the
549 latter does not need to send MySQL requests to build the available
551 privileges rules of the MySQL database server</span>. If set, it just
552 means only these databases will be displayed but
554 <br /><br />
555 An example of using more that one database:
557 </dd>
560 <dd>
561 Only useful when using phpMyAdmin with multiple server entries. If set,
562 this string will be displayed instead of the hostname in the pull-down
563 menu on the main page. This can be useful if you want to show only
564 certain databases on your system, for example.
565 <br /><br />
566 </dd>
568 <dt>
571 </dt>
572 <dd>
573 Starting with version 2.3.0 phpMyAdmin offers a lot of features
574 to work with master / foreign - tables. To use those as well as
575 the bookmark feature you need special tables with a
576 predefined structure, which we explain below.
577 <br /><br />
578 See the Quick Install section in this document for a quick way
579 of creating those tables. Also, if you are using a Windows server,
580 read FAQ 1.23.
581 <br /><br />
582 If you are the only user of this phpMyAdmin installation, you can
583 use your current database to store those special tables; in this
584 case, just put your current database name in
586 <br /><br />
587 If you are setting up a multi-user phpMyAdmin installation,
588 you will need to create a new database and setup special privileges,
589 so, as superuser:
590 <br /><br />
591 <ul>
592 <li>
593 create a new database for phpMyAdmin:<br />
597 privileges on this database. Here is a query to set up
600 controluser):<br />
601 <tt>
602 GRANT SELECT,INSERT,UPDATE,DELETE ON phpmyadmin.* to 'pma'@'localhost';
603 </tt><br />
605 </li>
606 <li>
608 </li>
609 </ul><br />
610 </dd>
612 <dt>
615 </dt>
616 <dd>
617 Since release 2.2.0 phpMyAdmin allows to bookmark queries. This can be
618 useful for queries you often run.<br /><br />
620 To allow the usage of this functionality you have to:
621 <ul>
623 <li>within this database create a table following this scheme:
624 <br />
625 <tt>
634 </tt>
635 </li>
636 <li>enter the table name in
638 </ul><br />
639 </dd>
641 <dt>
644 </dt>
645 <dd>
646 Since release 2.2.4 you can describe, in a special 'relation' table,
647 which field is a key in another table (a foreign key). phpMyAdmin
648 currently uses this to
649 <ul>
650 <li>
651 make clickable, when you browse the master table, the data values
652 that point to the foreign table;
653 </li>
654 <li>
656 when browsing the master table, if you move the mouse to a column
657 containing a foreign key (use also the 'table_info' table);<br />
658 (see FAQ 6.7)
659 </li>
660 <li>
661 in edit/insert mode, display a drop-down list of possible
663 shown)<br />
664 (see FAQ 6.21)
665 <li>
666 display links on the table properties page, to check referential
667 integrity (display missing foreign keys) for each described key;
668 </li>
669 <li>
670 in query-by-example, create automatic joins (see FAQ 6.6)
671 </li>
672 <li>
673 enable you to get a PDF schema of your database (also uses the
674 table_coords table).
675 </li>
676 </ul>
677 <br />
679 The keys can be numeric or character.
680 <br /><br />
682 To allow the usage of this functionality the superuser has to:
683 <ul>
685 <li>
686 within this database create a table following this scheme:
687 <br />
688 <tt>
694 `foreign_table` varchar(64) NOT NULL default '',<br />
695 `foreign_field` varchar(64) NOT NULL default '',<br />
696 PRIMARY KEY (`master_db`, `master_table`, `master_field`),<br />
699 </tt>
700 </li>
701 <li>
702 put the relation table name in
704 </li>
705 <li>
706 now as normal user open phpMyAdmin and for each one of your
707 tables where you want to use this feature, click
709 </li>
710 </ul><br />
713 future development of the cross-db relations.<br /><br />
714 </dd>
716 <dt>
719 </dt>
720 <dd>
721 Since release 2.3.0 you can describe, in a special 'table_info'
722 table, which field is to be displayed as a tool-tip when moving the
723 cursor over the corresponding key.
724 <br />
725 This configuration variable will hold the name of this special
726 table.
727 To allow the usage of this functionality the superuser has to:
728 <ul>
730 <li>within this database create a table following this scheme:
731 <br />
732 <tt>
736 `display_field` varchar(64) NOT NULL default '',<br />
739 </tt>
740 </li>
741 <li>
742 put the table name in
744 </li>
745 <li>
746 then for each table where you want to use this feature,
748 to choose the field.
749 </li>
750 </ul><br />
752 <br /><br />
753 </dd>
755 <dt>
759 </dt>
760 <dd>
761 Since release 2.3.0 you can have phpMyAdmin create PDF pages showing
762 the relations between your tables. To do this it needs two tables
765 table will be placed on a PDF schema output).
766 <br /><br />
769 output.
770 <br /><br />
771 To allow the usage of this functionality the superuser has to:
772 <ul>
774 <li>
775 within this database create a table following this scheme:
776 <br />
777 <tt>
784 PRIMARY KEY (`db_name`, `table_name`, `pdf_page_number`)<br />
785 ) TYPE=MyISAM COMMENT='Table coordinates for phpMyAdmin PDF output';<br />
786 </tt>
787 </li>
788 <li>
789 also within this database create:<br />
790 <tt>
793 `page_nr` int(10) unsigned NOT NULL auto_increment,<br />
798 </tt>
799 </li>
800 <li>
801 put the first table name in
803 and the second table name in
805 </li>
806 </ul><br />
808 <br /><br />
809 </dd>
811 <dt>
814 </dt>
815 <dd>
816 <!-- This part requires a content update! -->
817 Since release 2.3.0 you can store comments to describe each column
819 <br /><br />
820 Starting with release 2.5.0, comments are consequently used on the table property
821 pages and table browse view, showing up as tool-tips above the column name (properties page)
822 or embedded within the header of table in browse view. They can also be shown
823 in a table dump. Please see the relevant configuration directives later on.
824 <br /><br />
825 Also new in release 2.5.0 is a mime-transformation system which is also based on
827 for further information. To use the mime-transformation system, your column_info
828 table has to have the three new fields 'mimetype', 'transformation', 'transformation_options'.
829 <br /><br />
830 To allow the usage of this functionality the superuser has to:
831 <ul>
833 <li>
834 within this database create a table following this scheme:
835 <br />
836 <tt>
844 transformation varchar(255) NOT NULL default '',<br />
845 transformation_options varchar(255) NOT NULL default '',<br />
847 UNIQUE KEY db_name (db_name, table_name, column_name)<br />
849 </tt>
850 </li>
851 <li>
852 put the table name in
854 </li>
855 <li>
857 <tt>
861 ADD `transformation_options` VARCHAR( 255 ) NOT NULL ;<br />
862 </tt>
863 and remember that the Variable in config.inc.php has been renamed
864 from <br />$cfg['Servers'][$i]['column_comments'] to $cfg['Servers'][$i]['column_info']
865 </li>
866 </ul><br />
867 </dd>
869 <dt>
872 </dt>
873 <dd>
874 Since release 2.5.0 you can store your SQL history, which means all queries you
875 entered manually into the phpMyAdmin interface. If you don't want to use a table-
876 based history, you can use the JavaScript-based history. Using that, all your
877 history items are deleted when closing the window.<br /><br />
880 you want to have on hold. On every login, this list gets cut to the maximum amount.
881 <br /><br />
883 The query history is only available if you use the JavaScript-based query window,
885 <br /><br />
887 To allow the usage of this functionality the superuser has to:
888 <ul>
890 <li>
891 within this database create a table following this scheme:
892 <br />
893 <tt>
902 INDEX ( `username` , `db` , `table` , `timevalue` )<br />
904 </tt>
905 </li>
906 <li>
907 put the table name in
909 </li>
910 </ul><br />
911 </dd>
913 <dt>
916 </dt>
917 <dd>
918 Because release 2.5.0 introduced the new MIME-transformation support, the
919 column_info table got enhanced with three new fields. If the above variable is
920 set to TRUE (default) phpMyAdmin will check if you have the latest table structure
921 available. If not, it will emit a warning to the superuser.<br /><br />
923 You can disable this checking behavior by setting the variable to false, which
924 should offer a performance increase.<br /><br />
926 Recommended to set to FALSE, when you are sure, your table structure is up to date.
927 <br /><br />
928 </dd>
930 <dt>
932 </dt>
933 <dd>
934 If your rule order is empty, then IP authentication is disabled.
935 <br /><br />
937 applies all deny rules followed by allow rules.
938 Access is allowed by default. Any client which does not match a Deny
939 command or does match an Allow command will be allowed access to the
940 server.
941 <br /><br />
943 applies all allow rules followed by deny rules. Access is denied by
944 default. Any client which does not match an Allow directive or does
945 match a Deny directive will be denied access to the server.
946 <br /><br />
947 If your rule order is set to 'explicit', the authentication is
948 performed in a similar fashion to rule order 'deny,allow', with the
952 and was available in Apache by specifying allow and deny rules without
953 setting any order.
954 <br /><br />
955 </dd>
957 <dt>
959 </dt>
960 <dd>
961 The general format for the rules is as such:<br />
962 <tt>
963
965 </tt>
966 <br /><br />
971 well:<br />
972 <tt>
975 </tt>
976 <br /><br />
978 Having an empty rule list is equivalent to either using
982 <br /><br />
984 For the IP matching system, the following work:<br />
988 But the following does not work:<br />
990 <br /><br />
991 </dd>
994 <dd>
995 If you have more than one server configured, you can set
997 that server when phpMyAdmin is started, or set it to 0 to be given a
998 list of servers without logging in.<br />
1000 MUST be set to that server.
1001 <br /><br />
1002 </dd>
1005 <dd>
1006 Defines whether to use GZip output buffering for increased
1007 speed in HTTP transfers.<br />
1008 Set to true/false for enabling/disabling. When set to 'auto' (string),
1009 phpMyAdmin tries to enable output buffering and will automatically disable
1010 it, if your browser has some problems with buffering. IE6 with a certain patch
1011 is known to cause data corruption having enabled buffering.
1012 <br /><br />
1013 </dd>
1016 <dd>
1017 Whether persistent connections should be used or not (mysql_connect or
1018 mysql_pconnect).
1019 <br /><br />
1020 </dd>
1023 <dd>
1024 Set the number of seconds a script is allowed to run. If seconds is set
1025 to zero, no time limit is imposed.<br />
1026 This setting is used while importing/exporting dump files but has no
1027 effect when PHP is running in safe mode.
1028 <br /><br />
1029 </dd>
1032 <dd>
1033 Mark used tables and make it possible to show databases with locked
1034 tables (since 3.23.30).
1035 <br /><br />
1036 </dd>
1039 <dd>
1040 Defines whether SQL-queries generated by phpMyAdmin should be displayed
1041 or not.
1042 <br /><br />
1043 </dd>
1046 <dd>
1047 Defines whether normal users (non-administrator) are allowed to
1048 delete their own database or not. If set as FALSE, the link "Drop
1050 mydatabase" will be rejected. Quite practical for ISP's with many
1051 customers.
1052 <br /><br />
1053 </dd>
1056 <dd>
1058 displayed when you're about to loose data.
1059 <br /><br />
1060 </dd>
1063 <dd>
1064 Define whether the previous login should be recalled or not in cookie
1065 authentication mode.
1066 <br /><br />
1067 </dd>
1070 <dd>
1071 Define whether the "search string inside database" is enabled or not.
1072 <br /><br />
1073 </dd>
1076 <dd>
1077 Define whether phpMyAdmin will continue executing a multi-query statement if one of the
1078 queries fails. Default is to abort execution.
1079 <br /><br />
1080 </dd>
1083 <dd>
1084 Define whether phpMyAdmin will output the results of each query of a multi-query statement
1085 embedded into the SQL output as inline comments. Defaults to TRUE.
1086 <br /><br />
1087 </dd>
1090 <dd>
1091 Defines whether to use select-based menu and display only the current
1092 tables in the left frame (smaller page).
1093 Only in Non-Lightmode you can use the feature to display nested folders
1094 using $cfg['LeftFrameTableSeparator']
1095 <br /><br />
1096 </dd>
1099 <dd>
1100 Defines a string to be used to nest table spaces. Defaults to '__'. This
1101 means if you have tables like 'first__second__third' this will be
1103 If set to FALSE or empty, the feature is disabled.
1104 NOTE: You shall not use this Separator in a table name at the beginning or
1105 end of a table name, or multiple times after another without any other
1106 characters in between.
1107 <br /><br />
1108 </dd>
1111 <dd>
1112 Defines how many sublevels should be displayed when splitting
1113 up tables by the above Separator.
1114 <br /><br />
1115 </dd>
1118 <dd>
1119 Defines whether to display table comment as tool-tip in left frame or
1120 not.
1121 <br /><br />
1122 </dd>
1125 <dd>
1126 If tool-tips are enabled and a DB comment is set, this will flip the comment
1127 and the real name. That means, if you have a table called 'user0001' and add
1128 the comment 'MyName' on it, you will see the name 'MyName' used consequently
1129 in the left frame and the tool-tip shows the real name of the DB.
1130 <br /><br />
1131 </dd>
1134 <dd>
1135 Same as $cfg['ShowTooltipAliasDB'], except this works for table names.
1136 <br /><br />
1137 </dd>
1140 <dd>
1141 Defines whether to display space usage and statistics about databases
1142 and tables or not.<br />
1143 Note that statistics requires at least MySQL 3.23.3 and that, at this
1144 date, MySQL doesn't return such information for Berkeley DB tables.
1145 <br /><br />
1146 </dd>
1148 <dt>
1153 </dt>
1154 <dd>
1158 starting main (right) frame. This setting does not check MySQL commands
1159 entered directly.
1160 <br /><br />
1162 Please note that to block the usage of phpinfo() in scripts, you
1163 have to put this in your php.ini:<br />
1165 <br /><br />
1169 coded password value in the configuration file, end users can't be
1170 allowed to change their passwords.
1171 <br /><br />
1172 </dd>
1175 <dd>
1176 Defines whether to suggest a database name on the
1178 <br /><br />
1179 </dd>
1182 <dd>
1184 content or not.
1185 <br /><br />
1186 </dd>
1189 <dd>
1190 Defines whether navigation bar buttons contain text or symbols only.
1191 <br /><br />
1192 </dd>
1195 <dd>
1196 Defines whether an user should be displayed a
1198 <br /><br />
1199 </dd>
1202 <dd>
1203 Number of rows displayed when browsing a result set. If the result set
1204 contains more rows, Previous/Next links will be shown.
1205 <br /><br />
1206 </dd>
1209 <dd>
1213 DATE, DATETIME & TIMESTAMP, ascending order else- by default.
1214 <br /><br />
1215 </dd>
1218 <dd>
1220 from edition when browsing a table's content or not.
1221 Valid values are:<br />
1224 <br />
1227 <br /><br />
1228 </dd>
1231 <dd>
1232 Defines whether MySQL functions fields should be displayed or not in
1233 edit/insert mode.
1234 <br /><br />
1235 </dd>
1238 <dd>
1239 Defines which type of editing controls should be used for CHAR and
1240 VARCHAR fields. Possible values are:
1241 <ul>
1242 <li>
1243 input - this allows to limit size of text to size of field in
1244 MySQL, but has problems with newlines in fields
1245 </li>
1246 <li>
1247 textarea - no problems with newlines in fields, but also no
1248 length limitations
1249 </li>
1250 </ul>
1251 Default is old behavior so input.
1252 <br /><br />
1253 </dd>
1255 <dt>
1259 </dt>
1260 <dd>
1261 Defines whether to allow the use of zip/GZip/BZip2 compression when
1262 creating a dump file or not.
1263 <br /><br />
1264 </dd>
1267 <dd>
1268 If set to True, do use less graphically intense tabs on the top of the mainframe.
1269 <br /><br />
1270 </dd>
1273 <dd>
1274 If set to True, will display icons instead of text for db and table properties links (like 'Browse', 'Select', 'Insert', ...).<br />
1275 Can be set to 'both' if you want icons AND text.<br />
1276 When set to False, will only show text.
1277 <br /><br />
1278 </dd>
1281 <dd>
1282 How many columns will be utilized to display the tables on the database property view?
1283 Default is 1 column. When setting this to a value larger than 1, the type of the database will be
1284 omitted for more display space.
1285 <br /><br />
1286 </dd>
1290 <dd>
1291 Defines the tab displayed by default on server view. Possible
1296 <br /><br />
1297 </dd>
1300 <dd>
1301 Defines the tab displayed by default on database view. Possible
1304 <br /><br />
1305 </dd>
1308 <dd>
1309 Defines the tab displayed by default on table view. Possible
1313 <br /><br />
1314 </dd>
1317 <dd>
1318 If set to an URL which points to the MySQL documentation (type depends
1320 generated.
1321 <br />
1323 Documentation page</a> for more information about MySQL manuals and
1324 their types.
1325 <br /><br />
1326 </dd>
1329 <dd>
1330 Type of MySQL documentation:
1331 <ul>
1337 </ul>
1338 <br /><br />
1339 </dd>
1342 <dd>
1343 Defines the default language to use, if not browser-defined or
1344 user-defined.<br />
1346 this setting.
1347 <br /><br />
1348 </dd>
1351 <dd>
1352 Force: always use this language (must be defined in the
1354 <br /><br />
1355 </dd>
1358 <dd>
1359 Default character set to use for recoding of MySQL queries. This must be
1361 option.<br />
1362 You can give here any character set which is in
1364 choice, user can select any of them.
1365 <br /><br />
1366 </dd>
1369 <dd>
1370 Allow character set recoding of MySQL queries. You need recode or iconv
1371 support (compiled in or module) in PHP to allow MySQL queries recoding
1372 and used language file must have it enabled (by default only these
1373 which are in Unicode, just to avoid losing some characters).
1374 <br /><br />
1375 </dd>
1378 <dd>
1379 You can select here which functions will be used for character set
1380 conversion.
1381 Possible values are:<br />
1382 <ul>
1383 <li>auto - automatically use available one (first is tested
1384 iconv, then recode)</li>
1387 </ul>
1388 Default is auto.
1389 <br /><br />
1390 </dd>
1393 <dd>
1394 Specify some parameters for iconv used in charset conversion. See
1395 <a
1397 documentation</a> for details.
1398 <br /><br />
1399 </dd>
1402 <dd>
1403 Available character sets for MySQL conversion. You can add your own (any of
1404 supported by recode/iconv) or remove these which you don't use.
1405 Character sets will be shown in same order as here listed, so if you
1406 frequently use some of these move them to the top.
1407 <br /><br />
1408 </dd>
1411 <dd>
1413 MIME transformations.<br />
1414 Possible values are:<br />
1415 <ul>
1416 <li>
1417 auto - automatically detect, this is a bit expensive
1419 according to your server real possibilities
1420 </li>
1423 </ul>
1424 Default is auto.
1425 <br /><br />
1426 </dd>
1429 <dd>
1430 Left frame width in pixel.
1431 <br /><br />
1432 </dd>
1434 <dt>
1437 </dt>
1438 <dd>
1439 The background colors (HTML) used for both the frames.
1440 <br /><br />
1441 </dd>
1443 <dt>
1445 </dt>
1446 <dd>
1447 The URI of the background image used for the right frame. It can be
1448 absolute as well as relative from your phpMyAdmin directory.
1449 </dd>
1452 <dd>
1453 The color (HTML) used for the pointer in the left frame (does not work
1454 with Netscape 4).
1455 <br /><br />
1456 </dd>
1459 <dd>
1460 The size of a table's border.
1461 <br /><br />
1462 </dd>
1465 <dd>
1466 The color (HTML) used for table headers.
1467 <br /><br />
1468 </dd>
1471 <dd>
1472 The color (HTML) #1 for table rows.
1473 <br /><br />
1474 </dd>
1477 <dd>
1478 The color (HTML) #2 for table rows.
1479 <br /><br />
1480 </dd>
1482 <dt>
1485 </dt>
1486 <dd>
1487 The colors (HTML) uses for the pointer and the marker in browse mode
1489 The former feature highlights the row over which your mouse is passing
1490 and the latter lets you visually mark/unmark rows by clicking on
1491 them.<br />
1492 You can disable both of these features by emptying the respective
1493 directive.
1494 <br /><br />
1495 </dd>
1497 <dt>
1502 </dt>
1503 <dd>
1504 Number of columns and rows for the textareas.<br />
1506 SQL textareas inside the query window.<br />
1507 The Char* values are used for CHAR and VARCHAR editing (if configured
1508 via $cfg['CharEditing']).
1509 <br /><br />
1510 </dd>
1512 <dt>
1514 </dt>
1515 <dd>
1516 Defines whether textarea for LONGTEXT fields should have double size.
1517 <br /><br />
1518 </dd>
1520 <dt>
1522 </dt>
1523 <dd>
1524 Defines if the whole textarea of the query box will be selected on
1525 click.
1526 <br /><br />
1527 </dd>
1529 <dt>
1531 </dt>
1532 <dd>
1533 Enable Ctrl+Arrows moving between fields when editing?
1534 <br /><br />
1535 </dd>
1538 <dd>
1539 Maximal number of Chars showed in any non-numeric
1540 field on browse view. Can be turned off by a toggle button on the
1541 browse page.
1542 <br /><br />
1543 </dd>
1545 <dt>
1548 </dt>
1549 <dd>
1550 Defines the place where modify and delete links would be put when
1551 tables contents are displayed (you may have them displayed both at the
1552 left and at the right).
1555 <br /><br />
1556 </dd>
1560 </dt>
1561 <dd>
1562 There are 3 display modes: horizontal, horizontalflipped and vertical. Define
1563 which one is displayed by default. The first mode displays each row on a
1564 horizontal line, the second rotates the headers by 90 degrees, so you can use
1565 descriptive headers even though fields only contain small values and still
1566 print them out. The vertical mode sorts each row on a vertical lineup.<br /><br />
1567 The HeaderFlipType can be set to 'css' or 'faked'. When using 'css' the rotation
1568 of the header for horizontalflipped is done via CSS. If set to 'faked' PGP
1569 does the transformation for you, but of course this does not look as good as CSS.
1570 <br /><br />
1571 </dd>
1574 <dd>
1575 When editing/creating new columns in a table all fields normally get lined up
1576 one field a line. (default: 'horizontal'). If you set this to 'vertical' you
1577 can have each field lined up vertically beneath each other. You can save up
1578 a lot of place on the horizontal direction and no longer have to scroll.
1579 <br /><br />
1580 </dd>
1584 </dt>
1585 <dd>
1586 By setting the corresponding variable to TRUE you can enable the display of
1587 column comments in Browse or Property display. In browse mode, the comments
1588 are show inside the header. In property mode, comments are displayed using
1589 a CSS-formatted dashed-line below the name of the field. The comment is shown
1590 as a tool-tip for that field.
1591 <br /><br />
1592 </dd>
1595 <dd>
1596 The name of the directory, ending with a slash, where SQL files have
1597 been uploaded by other means than phpMyAdmin (for example, ftp).
1598 Those files are available under a drop-down box when you click the
1599 database name, then the SQL tab.
1600 <br /><br />
1602 <br /><br />
1603 This feature is useful when your file is too big to be uploaded via
1604 HTTP, or when file uploads are disabled in PHP.
1605 <br /><br />
1606 Please note that if PHP is running in safe mode, this directory must
1607 be owned by the same user as the owner of the phpMyAdmin scripts.
1608 <br /><br />
1609 </dd>
1612 <dd>
1613 The name of the directory, ending with a slash, where dumps can
1614 be saved.
1615 <br /><br />
1616 Please note that the directory has to be writable for user running
1617 webserver.
1618 <br /><br />
1619 Please note that if PHP is running in safe mode, this directory must
1620 be owned by the same user as the owner of the phpMyAdmin scripts.
1621 <br /><br />
1622 </dd>
1625 <dd>
1626 In this array are defined default parameters for export, names of
1627 items are simmilar to texts seen on export page, so you can easily
1628 identify what they mean.
1629 <br /><br />
1630 </dd>
1633 <dd>
1634 Repeat the headers every X cells, or 0 to deactivate.
1635 <br /><br />
1636 </dd>
1646 </dt>
1647 <dd>
1648 All those variables affect the new query frame/window. When $cfg['QueryFrame']
1649 is set to true a new frame is embedded on the left with a small area. Clicking
1650 on that results in opening a direct interface to enter SQL queries.<br /><br />
1651 When $cfg['QueryFrameJS'] is set to true, clicking on that link opens a new
1652 custom sized browser window ($cfg['QueryWindowWidth'], $cfg['QueryWindowWidth'] -
1653 both integers for the size in pixels). If set to false, clicking on the link
1654 only opens the SQL input in the mainframe.<br /><br />
1655 The usage of the JavaScript query window is recommended if you have a JavaScript
1656 enabled browser. Basic functions are used to exchange quite a few variables, so
1657 most 4th generation browsers should be capable to use that feature. It currently
1659 If $cfg['QueryHistoryDB'] is set to TRUE, all your Queries are logged to a table,
1661 If set to FALSE, all your queries will be appended to the form, but only as long
1662 as your window is opened they remain saved.<br /><br />
1663 When using the JavaScript based query window, it will always get updated when you
1664 click on a new table/db to browse and will focus if you click on "Edit SQL" after
1665 using a query. You can suppress updating the query window by checking the box
1666 "Do not overwrite this query from outside the window" below the query textarea. Then
1667 you can browse tables/databases in the background without losing the contents of the
1668 textarea, so this is especially useful when composing a query with tables you first
1669 have to look in. The checkbox will get automatically checked whenever you change the
1670 contents of the textarea. Please uncheck the button whenever you definitely want the
1671 query window to get updated even though you have made alterations.<br /><br />
1672 If $cfg['QueryHistoryDB'] is set to TRUE you can specify the amount of saved
1673 history items using $cfg['QueryHistoryMax'].<br /><br />
1674 The query window also has a custom tabbed look to group the features. Using the
1675 variable $cfg['QueryWindowDefTab'] you can specify the default tab to be used
1676 when opening the query window. It can be set to either 'sql', 'files', 'history'
1677 or 'full'.<br /><br />
1678 The variable $cfg['QueryFrameDebug'] can be used by developers for easier future
1679 feature integration.
1680 <br /><br />
1681 </dd>
1684 <dd>
1686 <br /><br />
1687 </dd>
1690 <dd>
1691 Determines for how large tables phpMyAdmin should get exact row count by
1695 <br /><br />
1696 </dd>
1700 <dd>
1701 Utilizes a WYSIWYG editing control to easily place elements of a PDF page.
1702 By clicking on the button 'toggle scratchboard' on the page where you
1703 edit x/y coordinates of those elements you can activate a scratchboard where
1704 all your elements are placed. By clicking on an element, you can move them
1705 around in the pre-defined area and the x/y coordinates will get updated
1706 dynamically. Likewise, when entering a new position directly into the
1707 input field, the new position in the scratchboard changes after your
1708 cursors leaves the input field.<br />
1709 You have to click on the 'OK'-button below the tables to save the new positions.
1710 If you want to place a new element, first add it to the table of elements and
1711 then you can drag the new element around.<br />
1712 By changing the paper size and the orientation you can change the size of the
1713 scratchboard as well. You can do so by just changing the dropdown field below,
1714 and the scratchboard will resize automatically, without interfering with the
1715 current placement of the elements.<br />
1716 If ever an element gets out of range you can either enlarge the paper size
1717 or click on the 'reset' button to place all elements below each other.<br />
1719 to work. The basic Drag&Drop script functionality was kindly borrowed from www.youngpup.net and
1720 is underlying so specific license.
1721 <br /><br />
1722 </dd>
1725 <dd>
1726 The main use of the new SQL Parser is to pretty-print SQL queries. By
1727 default we use HTML to format the query, but you can disable this by
1729 <br /><br />
1730 </dd>
1734 <dd>
1735 For the pretty-printing of SQL queries, under some cases the part of a
1736 query inside a bracket is indented. By changing
1739 specifies the units of the indent amount that you specified. This is
1740 used via stylesheets.
1741 <br /><br />
1742 </dd>
1745 <dd>
1746 This array is used to define the colours for each type of element of
1747 the pretty-printed SQL queries. The tuple format is<br />
1749 If you specify an empty string for the color of a class, it is ignored
1750 in creating the stylesheet.
1751 You should not alter the class names, only the colour strings.<br />
1753 <ul>
1777 <li><b>quote_single</b> Single quotes <tt>'</tt></li>
1778 <li><b>quote_backtick</b> Backtick quotes <tt>`</tt></li>
1779 </ul><br />
1780 </dd>
1782 <dt><b>$cfg['SQLValidator']['use']</b> boolean</dt>
1783 <dd>
1784 phpMyAdmin now supports use of the <a href="http://developer.mimer.com/validator/index.htm">Mimer SQL Validator</a> service,
1785 as originally published on
1787 <br />
1788 For help in setting up your system to use the service, see the
1790 <br /><br />
1791 </dd>
1793 <dt><b>$cfg['SQLValidator']['username']</b> string<br />
1794 <b>$cfg['SQLValidator']['password']</b> string</dt>
1795 <dd>
1796 The SOAP service allows you to login with <tt>anonymous</tt>
1797 and any password, so we use those by default.. Instead, if
1798 you have an account with them, you can put your login details
1799 here, and it will be used in place of the anonymous login.
1800 <br /><br />
1801 </dd>
1803 <dt><b>$cfg['DBG']['enable']</b> boolean</dt>
1804 <dd>
1805 <b>DEVELOPERS ONLY!</b><br />
1806 Enable the DBG extension for debugging phpMyAdmin. Required for profiling
1807 the code.
1808 <br />
1809 For help in setting up your system to this, see the
1811 </dd>
1813 <dt><b>$cfg['DBG']['profile']['enable']</b> boolean</dt>
1814 <dd>
1815 <b>DEVELOPERS ONLY!</b><br />
1816 Enable profiling support for phpMyAdmin. This will append a chunk of data
1817 to the end of every page displayed in the main window with profiling
1818 statistics for that page.<br />
1819 You may need need to increase the maximum execution time for this to
1820 complete successfully.
1821 </dd>
1823 <dt><b>$cfg['DBG']['profile']['threshold']</b> float (units in milliseconds)</dt>
1824 <dd>
1825 <b>DEVELOPERS ONLY!</b><br />
1826 When profiling data is displayed, this variable controls the threshold of
1827 display for any profiling data, based on the average time each time has
1828 taken. If it is over the threshold it is displayed, otherwise it is not
1829 displayed. This takes a value in milliseconds. In most cases you don't need
1830 to edit this.
1831 </dd>
1833 <dt><b>$cfg['ColumnTypes'] </b>array</dt>
1834 <dd>
1835 All possible types of a MySQL column. In most cases you don't need to
1836 edit this.
1837 <br /><br />
1838 </dd>
1840 <dt><b>$cfg['AttributeTypes'] </b>array</dt>
1841 <dd>
1842 Possible attributes for fields. In most cases you don't need to edit
1843 this.
1844 <br /><br />
1845 </dd>
1847 <dt><b>$cfg['Functions'] </b>array</dt>
1848 <dd>
1849 A list of functions MySQL supports. In most cases you don't need to
1850 edit this.
1851 <br /><br />
1852 </dd>
1854 </dl>
1856 <!-- TRANSFORMATIONS -->
1858 <h2>Transformations</h2>
1860 <p>
1864 </p>
1867 <h3>[1. Introduction]</h3>
1869 <p>To enable transformations, you have to setup the column_info table and the proper
1871 <br />
1873 <p>You can apply different transformations to the contents of each field. The
1874 transformation will take the content of each field and transform it with
1875 certain rules defined in the selected transformation.</p><br />
1877 <p>Say you have a field 'filename' which contains a filename. Normally you would see
1878 in phpMyAdmin only this filename. Using transformations you can transform that filename
1879 into a HTML link, so you can click inside of the phpMyAdmin structure on the field's
1880 link and will see the file displayed in a new browser window. Using transformation
1881 options you can also specify strings to append/prepend to a string or the format you
1882 want the output stored in.</p><br />
1884 <p>For a general overview of all available transformations and their options, you can
1885 consult your <i><www.your-host.com>/<your-install-dir>/libraries/transformations/overview.php3</i>
1886 installation.</p>
1888 <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>
1891 <h3>[2. Usage]</h3>
1893 <p>Go to your tbl_properties.inc.php3 page (i.e. reached through clicking on the
1894 'properties' link for a table). There you will see three new fields at the end of the
1895 line. They are called 'MIME-type', 'Browser transformation' and 'Transformation options'.</p>
1896 <br />
1898 <ul>
1899 <li>The field 'MIME-type' is a dropdown field. You have the options to leave that field
1900 empty or to use 'auto' [this feature is not yet available]. Please note that
1901 transformations are inactive as long as no mime-type is selected.</li>
1903 <li>The field 'Browser transformation' is a drop-down field. You can choose from a
1904 hopefully growing amount of pre-defined transformations. See below for information on
1905 how to build your own transformation.<br />
1907 There are global transformations and mimetype-bound transformations. Global transformations
1908 can be used for any mimetype. They will take the mimetype, if necessary, into regard.
1909 Mimetype-bound transformations usually only operate on a certain mimetype. There are
1910 transformations which operate on the main mimetype (like 'image'), which will most likely
1911 take the subtype into regard, and those who only operate on a
1912 specific subtype (like 'image/jpeg').<br />
1914 You can use transformations on mimetypes for which the function was not defined for. There
1915 is no security check for you selected the right transformation, so take care of what the
1916 output will be like.</li>
1918 <li>The field 'Transformation options' is a free-type textfield. You have to enter
1919 transform-function specific options here. Usually the transforms can operate with default
1920 options, but it is generally a good idea to look up the overview to see which options are
1921 necessary.<br />
1923 Much like the ENUM/SET-Fields, you have to split up several options using the format
1924 'a','b','c',...(NOTE THE MISSING BLANKS). This is because internally the options will be
1925 parsed as an array, leaving the first value the first element in the array, and so
1926 forth.<br />
1928 If you want to specify a MIME character set you can define it in the transformation_options.
1929 You have to put that outside of the pre-defined options of the specific mime-transform,
1931 for which you can specify 2 options and you want to append a character set, enter "'first
1932 parameter','second parameter','charset=us-ascii'". You can, however use the defaults for
1934 </ul>
1937 <h3>[3. File structure]</h3>
1939 <p>All mimetypes and their transformations are defined through single files in
1940 the directory 'libraries/transformations/'.</p><br />
1942 <p>They are stored in files to ease up customization and easy adding of new
1943 transformations.</p><br />
1945 <p>Because the user cannot enter own mimetypes, it is kept sure that transformations
1946 always work. It makes no sense to apply a transformation to a mimetype, the
1947 transform-function doesn't know to handle.</p><br />
1949 <p>One can, however, use empty mime-types and global transformations which should work
1950 for many mimetypes. You can also use transforms on a different mimetype they where built
1951 for, but pay attention to option usage as well as what the transformation does to your
1952 field.</p><br />
1954 <p>There is a basic file called 'global.inc.php3'. This function can be included by
1955 any other transform function and provides some basic functions.</p><br />
1957 <p>There are 5 possible file names:</p>
1959 <ol>
1960 <li>A mimetype+subtype transform:<br /><br />
1962 [mimetype]_[subtype]__[transform].inc.php3<br /><br />
1964 Please not that mimetype and subtype are separated via '_', which shall not be
1965 contained in their names. The transform function/filename may contain only
1966 characters which cause no problems in the file system as well as the PHP function
1967 naming convention.<br /><br />
1969 The transform function will the be called 'PMA_transform_[mimetype]_[subtype]__[transform]()'.<br /><br />
1971 <b>Example:</b><br /><br />
1973 text_html__formatted.inc.php3<br />
1974 PMA_transform_text_html__formatted()</li>
1976 <li>A mimetype (w/o subtype) transform:<br /><br />
1978 [mimetype]__[transform].inc.php3<br /><br />
1980 Please note that there are no single '_' characters.
1981 The transform function/filename may contain only characters which cause no problems
1982 in the file system as well as the PHP function naming convention.<br /><br />
1984 The transform function will the be called 'PMA_transform_[mimetype]__[transform]()'.<br /><br />
1986 <b>Example:</b><br /><br />
1988 text__formatted.inc.php3<br />
1989 PMA_transform_text__formatted()</li>
1991 <li>A mimetype+subtype without specific transform function<br /><br />
1993 [mimetype]_[subtype].inc.php3<br /><br />
1995 Please note that there are no '__' characters in the filename. Do not use special
1996 characters in the filename causing problems with the file system.<br /><br />
1998 No transformation function is defined in the file itself.<br /><br />
2000 <b>Example:</b><br /><br />
2002 text_plain.inc.php3<br />
2003 (No function)</li>
2005 <li>A mimetype (w/o subtype) without specific transform function<br /><br />
2007 [mimetype].inc.php3<br /><br />
2009 Please note that there are no '_' characters in the filename. Do not use special
2010 characters in the filename causing problems with the file system.<br /><br />
2012 No transformation function is defined in the file itself.<br /><br />
2014 <b>Example:</b><br /><br />
2016 text.inc.php3<br />
2017 (No function)</li>
2019 <li>A global transform function with no specific mimetype<br /><br />
2021 global__[transform].inc.php3<br /><br />
2023 The transform function will the be called 'PMA_transform_global__[transform]()'.<br /><br />
2025 <b>Example:</b><br /><br />
2027 global__formatted<br />
2028 PMA_transform_global__formatted()</li>
2029 </ol>
2031 <br />
2032 <p>So generally use '_' to split up mimetype and subtype, and '__' to provide a
2033 transform function.</p><br />
2035 <p>All filenames containing no '__' in themselves are not shown as valid transform
2036 functions in the dropdown.</p><br />
2038 <p>Please see the libraries/transformations/TEMPLATE file for adding your own transform
2039 function. See the libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
2040 without a transform function. Also note the introduction of a function description in
2041 the language files. For each function a $strTransformation_[filename without .inc.php3]
2042 has to exist.</p><br />
2044 <p>You can use the template generator to generate new functions and entries in the
2045 language file.</p><br />
2047 <p>To create a new transform function please see libraries/transformations/template_generator.sh.
2048 To create a new, empty mimetype please see libraries/transformations/template_generator_mimetype.sh.</p><br />
2050 <!-- FAQ -->
2052 <h2>FAQ - Frequently Asked Questions</h2>
2054 <p>
2063 </p>
2065 <p><br />
2066 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.
2067 </p>
2070 <h3>[1. Server]</h3>
2072 <h4>
2073 [1.1] I'm running PHP 4+ and my server is crashing each time a specific
2074 action is required or phpMyAdmin sends a blank page or a page full of
2075 cryptic characters to my browser, what can I do?
2076 </h4>
2077 <p>
2078 There are some known PHP bugs with output buffering and compression.<br />
2079 Try to set the <tt>$cfg['OBGzip']</tt> directive to <tt>FALSE</tt> in your
2080 <i>config.inc.php or .php3</i> file and the
2081 <tt>zlib.output_compression</tt> directive to <tt>Off</tt> in your php
2082 configuration file.<br />
2083 Furthermore, we know about such problems connected to the release
2084 candidates of PHP 4.2.0 (tested with PHP 4.2.0 RC1 to RC4) together with
2085 MS Internet Explorer. Please upgrade to the release version PHP 4.2.0.
2086 </p>
2088 <h4>
2089 [1.2] My Apache server crashes when using phpMyAdmin.
2090 </h4>
2091 <p>
2092 You should first try the latest versions of Apache (and possibly MySQL).
2093 <br />
2094 See also the other FAQ entry about PHP bugs with output buffering.
2095 <br />
2096 If your server keeps crashing, please ask for help in the various
2097 Apache support groups.
2098 </p>
2100 <h4>
2102 PHP 4.2.0 or 4.2.1 loaded as an Apache 2+ module but can't enter the
2103 script: I'm always displayed the login screen.
2104 </h4>
2105 <p>
2106 This is a known PHP bug (see this
2108 official PHP bug database. It means there is and won't be any phpMyAdmin
2109 fix against it because there is no way to code a fix.
2110 </p>
2112 <h4>
2113 [1.4] Using phpMyAdmin on IIS, I'm displayed the error message:
2114 "The specified CGI application misbehaved by not returning a
2115 complete set of HTTP headers...".
2116 </h4>
2117 <p>
2118 You just forgot to read the <i>install.txt</i> file from the php
2119 distribution. Have a look at the last message in this
2121 official PHP bug database.
2122 </p>
2124 <h4>
2125 [1.5] Using phpMyAdmin on IIS, I'm facing crashes and/or many error
2126 messages with the HTTP or advanced authentication mode.
2127 </h4>
2128 <p>
2129 This is a known problem with the PHP ISAPI filter: it's not so stable. For
2130 some more information and complete testings see the messages posted by
2131 André B. aka "djdeluxe76" in
2132 <a href="http://www.phpwizard.net/phorum/read.php?f=1&i=6624&t=6300">this thread</a>
2133 from the phpWizard forum.<br />
2134 Please use instead the cookie authentication mode.
2135 </p>
2137 <h4>
2138 [1.6] I can't use phpMyAdmin on PWS: nothing is displayed!</h4>
2139 <p>
2140 This seems to be a PWS bug. Filippo Simoncini found a workaround (at this
2141 time there is no better fix): remove or comment the <tt>DOCTYPE</tt>
2142 declarations (2 lines) from the scripts <i>header.inc.php3</i>,
2143 <i>header_printview.inc.php3</i>, <i>index.php3</i>, <i>left.php3</i> and
2144 <i>libraries/common.lib.php3</i>.
2145 </p>
2147 <h4>
2148 [1.7] How can I GZip or Bzip a dump or a CSV export. It does not seem to
2149 work.
2150 </h4>
2151 <p>
2152 These features are based on the <tt>gzencode()</tt> and
2153 <tt>bzcompress()</tt> PHP functions to be more independent of the platform
2154 (Unix/Windows, Safe Mode or not, and so on).
2155 So, you must have PHP4 >= 4.0.4 and Zlib/Bzip2 support
2156 (<tt>--with-zlib</tt> and <tt>--with-bz2</tt>).<br />
2157 We faced PHP crashes when trying to download a dump with MS Internet
2158 Explorer when phpMyAdmin is run with a release candidate of PHP 4.2.0. In
2159 this case you should switch to the release version of PHP 4.2.0.
2160 </p>
2162 <h4>
2163 [1.8] I cannot insert a text file in a table, and I get an error about
2164 safe mode being in effect.
2165 </h4>
2166 <p>
2167 Your uploaded file is saved by PHP in the "upload dir", as
2168 defined in <i>php.ini</i> by the variable <tt>upload_tmp_dir</tt> (usually
2169 the system default is <i>/tmp</i>).
2170 <br />
2171 We recommend the following setup for Apache servers running in safe mode,
2172 to enable uploads of files while being reasonably secure:
2173 </p>
2174 <ul>
2175 <li>create a separate directory for uploads:
2176 <tt>mkdir /tmp/php</tt></li>
2177 <li>give ownership to the Apache server's user.group:
2178 <tt>chown apache.apache /tmp/php</tt></li>
2179 <li>give proper permission: <tt>chmod 600 /tmp/php</tt></li>
2180 <li>put <tt>upload_tmp_dir = /tmp/php</tt> in php.ini</li>
2181 <li>restart Apache</li>
2182 </ul>
2184 <h4>
2185 [1.9] I'm having troubles when uploading files. In general file uploads
2186 don't work on my system and uploaded files have a <tt>Content-Type:</tt>
2187 header in the first line.
2188 </h4>
2189 <p>
2190 It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat 7.0
2191 and you updated your PHP RPM to php-4.0.4pl1-3.i386.rpm, didn't you?
2192 <br />
2193 So the problem is that this package has a serious bug that was corrected
2194 ages ago in PHP (2001-01-28: see
2196 for more details). The problem is that the bugged package is still
2197 available though it was corrected (see
2199 for more details).
2200 <br />
2201 So please download
2202 <a href="http://www.redhat.com/swr/i386/php-4.0.4pl1-9.i386.html">the fixed package (4.0.4pl1-9)</a>
2203 and the problem should go away.
2204 <br />
2205 And that fixes the \r\n problem with file uploads!
2206 </p>
2208 <h4>
2209 [1.10] I'm having troubles when uploading files with phpMyAdmin running
2210 on a secure server. My browser is Internet Explorer and I'm using the
2211 Apache server.
2212 </h4>
2213 <p>
2214 As suggested by "Rob M" in the phpWizard forum, add this line to
2215 your <i>httpd.conf</i>:<br />
2216 <tt>SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown</tt><br />
2217 It seems to clear up many problems between Internet Explorer and SSL.
2218 </p>
2220 <h4>
2221 [1.11] I get an 'open_basedir restriction' while uploading a file from
2222 the query box.
2223 </h4>
2224 <p>
2225 Since version 2.2.4, phpMyAdmin supports servers with open_basedir
2226 restrictions. Assuming that the restriction allows you to open files in the
2227 current directory ('.'), all you have to do is create a 'tmp' directory
2228 under the phpMyAdmin install directory, with permissions 777 and the same
2229 owner as the owner of your phpMyAdmin directory. The uploaded files will
2230 be moved there, and after execution of your SQL commands, removed.
2231 </p>
2233 <h4>
2234 [1.12] I have lost my MySQL root password, what can I do?
2235 </h4>
2236 <p>
2237 The MySQL manual explains how to
2239 reset the permissions</a>.
2240 </p>
2242 <h4>
2243 [1.13] I get an error 'No SQL query' when trying to execute a bookmark.
2244 </h4>
2245 <p>
2246 If PHP does not have read/write access to its <tt>upload_tmp_dir</tt>, it
2247 cannot access the uploaded query.
2248 </p>
2250 <h4>
2251 [1.14] I get an error 'No SQL query' when trying to submit a query from
2252 the convenient text area.
2253 </h4>
2254 <p>
2255 Check the <tt>post_max_size</tt> directive from your PHP configuration file
2256 and try to increase it.
2257 </p>
2259 <h4>
2260 [1.15] I have problems with <i>mysql.user</i> field names.
2261 </h4>
2262 <p>
2263 In older MySQL versions, the <tt>User</tt> and <tt>Password</tt> fields
2264 were named <tt>user</tt> and <tt>password</tt>. Please modify your field
2265 names to align with current standards.
2266 </p>
2267 <h4>
2268 [1.16] I cannot upload big dump files (memory, http or timeout problems).
2269 </h4>
2270 <p>
2271 The first things to check (or ask your host provider to check) are the
2272 values of <tt>upload_max_filesize</tt>, <tt>memory_limit</tt> and
2273 <tt>post_max_size</tt> in the <i>php.ini</i> configuration file.
2274 <br />
2275 All of these three settings limit the maximum size of data that can be
2276 submitted and handled by PHP. One user also said that post_max_size
2277 and memory_limit need to be larger than upload_max_filesize.
2278 <br />
2279 If you get a timeout problem, look at the <tt>$cfg['UploadDir']</tt>
2280 feature.
2281 </p>
2283 <h4>
2284 [1.17] Does phpMyAdmin support MySQL 4.1 and 5.0?
2285 </h4>
2286 <p>
2287 phpMyAdmin provides limited support for MySQL 4.1. That means that you
2288 can neither assign character sets to a table or field on create nor change
2289 the (automatically) assigned character set.<br />
2290 When compiling php, we strongly recommend that you manually link it to a
2291 MySQL 4.1 client library since the one that is currently bundled with
2292 php is rather old and might cause problems.<br />
2293 MySQL 5 is not yet supported.
2294 </p>
2296 <h4>
2297 [1.18] I'm running MySQL <= 4.0.1 having
2298 <tt>lower_case_table_names</tt> set to 1. If I create a new table with a
2299 capital letter in its name it is changed to lowercase as it should. But
2300 if I try to DROP this table MySQL is unable to find the corresponding
2301 file.
2302 </h4>
2303 <p>
2304 This is a bug of MySQL <= 4.0.1. Please upgrade to at least
2305 MySQL 4.0.2 or turn off your <tt>lower_case_table_names</tt>
2306 directive.
2307 </p>
2309 <h4>
2310 [1.19] I can't run the "display relations" feature because the
2311 script seems not to know the font face I'm using!
2312 </h4>
2313 <p>
2314 The "FPDF" library we're using for this feature requires some
2315 special files to use font faces.<br />
2316 Please refers to the
2318 these files.
2319 </p>
2322 <h4>
2323 [1.20] I receive the error "cannot load MySQL extension, please
2324 check PHP Configuration".
2325 </h4>
2326 <p>
2327 To connect to a MySQL server, PHP needs a set of MySQL functions called
2328 "MySQL extension".
2329 This extension may be part of the PHP server (compiled-in), otherwise it
2330 needs to be loaded dynamically. Its name is probably <i>mysql.so</i> or
2331 <i>mysql.dll</i>. phpMyAdmin tried to load the extension but failed.
2332 <br /><br />
2333 Usually, the problem is solved by installing a software package called
2334 "PHP-MySQL" or something similar.
2335 </p>
2337 <h4>
2338 [1.21] I am running the CGI version of PHP under Unix, and I cannot
2339 login using cookie auth.
2340 </h4>
2341 <p>
2342 In <i>php.ini</i>, set <tt>mysql.max_links</tt> higher than 1.
2343 </p>
2345 <h4>
2346 [1.22] I don't see the "Location of text file" field, so
2347 I cannot upload.
2348 </h4>
2349 <p>
2350 This is most likely because in <i>php.ini</i>, your <tt>file_uploads</tt>
2351 parameter is not set to "on".
2352 </p>
2354 <h4>
2355 [1.23] I'm running MySQL on a Win32 machine. Each time I create a new
2356 table the table and field names are changed to lowercase!
2357 </h4>
2358 <p>
2359 This happens because the MySQL directive <tt>lower_case_table_names</tt>
2360 defaults to 1 (<tt>ON</tt>) in the Win32 version of MySQL. You can change
2361 this behavior by simply changing the directive to 0 (<tt>OFF</tt>):<br />
2362 Just edit your <tt>my.ini</tt> file that should be located in your Windows
2363 directory and add the following line to the group [mysqld]:<br />
2364 <tt>set-variable = lower_case_table_names=0</tt><br />
2365 Next, save the file and restart the MySQL service. You can always check the
2366 value of this directive using the query<br />
2367 <tt>SHOW VARIABLES LIKE 'lower_case_table_names';</tt>
2368 </p>
2370 <h4>
2371 [1.24] Some characters are being truncated in my queries, or I get
2372 characters randomly added. I am running PHP 4.2.3.
2373 </h4>
2374 <p>
2375 This is a
2377 </p>
2379 <h4>
2380 [1.25] I am running Apache with mod_gzip-1.3.26.1a on Windows XP,
2381 and I get problems, such as undefined variables when I run a SQL query.
2382 </h4>
2383 <p>
2384 A tip from Jose Fandos: put a comment on the following two lines
2385 in httpd.conf, like this:<br />
2386 <tt># mod_gzip_item_include file \.php$</tt><br />
2388 as this version of mod_gzip on Apache (Windows) has problems handling
2389 PHP scripts. Of course you have to restart Apache.
2390 </p>
2392 <h4>
2393 [1.26] I just installed phpMyAdmin in my document root of IIS but
2394 I get the error "No input file specified" when trying to
2395 run phpMyAdmin.
2396 </h4>
2397 <p>
2398 This is a permission problem. Right-click on the phpmyadmin folder
2399 and choose properties. Under the tab Security, click on "Add"
2400 and select the user "IUSER_machine" from the list. Now set his
2401 permissions and it should work.
2402 </p>
2404 <h4>
2405 [1.27] I get empty page when I want to view huge page (eg.
2406 db_details_structure.php3 with plenty of databases).
2407 </h4>
2408 <p>
2410 GZIP output buffering enabled. If you turn off it (by <code>$cfg['OBGzip']
2411 = FALSE</code> in config.inc.php3), it should work. This bug will be fixed
2412 in PHP 5.0.0.
2413 </p>
2415 <h4>
2416 [1.28] My MySQL server sometimes refuses queries and returns the message
2417 'Errorcode: 13'. What does this mean?
2418 </h4>
2419 <p>
2420 This can happen due to a MySQL bug when having database / table names with
2421 upper case characters although <tt>lower_case_table_names</tt> is set to 1.
2422 To fix this, turn off this directive, convert all database and table names
2423 to lower case and turn it on again. Alternatively, there's a bug-fix
2424 available starting with MySQL 3.23.56 / 4.0.11-gamma.
2425 </p>
2428 <h4>
2429 [1.29] When I create a table or modify a field, I get an error
2430 and the fields are duplicated.
2431 </h4>
2432 <p>
2433 It is possible to configure Apache in such a way that PHP has problems
2434 interpreting .php files.
2435 <br /><br />
2436 The problems occur when two different (and conflicting) set of directives
2437 are used:
2438 <br /><br />
2439 <tt>
2440 SetOutputFilter PHP<br />
2441 SetInputFilter PHP<br />
2442 </tt>
2443 &
2444 <br />
2445 <tt>
2446 AddType application/x-httpd-php .php
2447 </tt>
2448 <br /><br />
2449 In the case we saw, one set of directives was in <tt>httpd.conf</tt>, while
2450 the other set was in <tt>php.conf</tt>.<br />
2451 The recommended way is with <tt>AddType</tt>, so just comment out
2452 the first set of lines and restart Apache:
2453 <br /><br />
2454 <tt><b>
2455 #SetOutputFilter PHP<br />
2456 #SetInputFilter PHP<br /></b>
2457 </tt>
2458 </p>
2461 <h3>[2. Configuration]</h3>
2463 <h4>
2464 [2.1] The error message "Warning: Cannot add header information -
2465 headers already sent by ..." is displayed, what's the problem?
2466 </h4>
2467 <p>
2468 Edit your <i>config.inc.php or .php3</i> file and ensure there is nothing
2469 (I.E. no blank lines, no spaces, no characters...) neither before the
2470 <tt><?php</tt> tag at the beginning, neither after the <tt>?></tt>
2471 tag at the end.
2472 </p>
2474 <h4>
2475 [2.2] phpMyAdmin can't connect to MySQL. What's wrong?
2476 </h4>
2477 <p>
2478 Either there is an error with your PHP setup or your username/password is
2479 wrong. Try to make a small script which uses mysql_connect and see if it
2480 works. If it doesn't, it may be you haven't even compiled MySQL support
2481 into PHP.
2482 </p>
2484 <h4>
2485 [2.3] The error message "Warning: MySQL Connection Failed: Can't
2486 connect to local MySQL server through socket '/tmp/mysql.sock'
2487 (111)..." is displayed. What can I do?
2488 </h4>
2489 <p><br />
2490 For RedHat users, Harald Legner suggests this on the mailing list:
2491 <br /><br />
2492 On my RedHat-Box the socket of MySQL is <i>/var/lib/mysql/mysql.sock</i>.
2493 In your php.ini you will find a line
2494 <br />
2495 <tt>mysql.default_socket = /tmp/mysql.sock</tt>
2496 <br />
2497 change it to
2498 <br />
2499 <tt>mysql.default_socket = /var/lib/mysql/mysql.sock</tt>
2500 <br />
2501 Then restart apache and it will work.
2502 <br /><br />
2503 Here is a fix suggested by Brad Ummer in the phpwizard forum:
2504 </p>
2505 <ul>
2506 <li>
2507 First, you need to determine what socket is being used by MySQL.
2508 <br />
2509 To do this, telnet to your server and go to the MySQL bin directory. In
2510 this directory there should be a file named <i>mysqladmin</i>. Type
2511 <tt>./mysqladmin variables</tt>, and this should give you a bunch of
2512 info about your MySQL server, including the socket
2513 (<i>/tmp/mysql.sock</i>, for example).
2514 </li>
2515 <li>
2516 Then, you need to tell PHP to use this socket.<br />Assuming you are
2517 using PHP 3.0.10 or better, you can specify the socket to use when you
2518 open the connection. To do this in phpMyAdmin, you need to complete the
2519 socket information in the config.inc.php3.<br />
2520 For example:
2521 <tt>$cfg['Servers'][$i]['socket'] = '/tmp/mysql.sock';</tt><br /><br />
2522 Please also make sure that the permissions of this file allow to be readable
2523 by your webserver (i.e. '0755').
2524 </li>
2525 </ul>
2526 <p>
2527 Have also a look at the
2529 corresponding section of the MySQL documentation</a>.
2530 </p>
2532 <h4>
2533 [2.4] Nothing is displayed by my browser when I try to run phpMyAdmin,
2534 what can I do?
2535 </h4>
2536 <p>
2537 Try to set the <tt>$cfg['OBGZip']</tt> directive to <tt>FALSE</tt> in the
2538 phpMyAdmin configuration file. It helps sometime.<br />
2539 Also have a look at your PHP version number: if it contains
2540 "4.0b..." it means you're running a beta version of PHP. That's
2541 not a so good idea, please upgrade to a plain revision.
2542 </p>
2544 <h4>
2545 [2.5] Each time I want to insert or change a record or drop a database
2546 or a table, an error 404 (page not found) is displayed or, with HTTP or
2547 cookie authentication, I'm asked to login again. What's wrong?
2548 </h4>
2549 <p>
2550 Check the value you set for the <tt>$cfg['PmaAbsoluteUri']</tt> directive
2551 in the phpMyAdmin configuration file.
2552 </p>
2554 <h4>
2555 [2.6] I get an "Access denied for user: 'root@localhost' (Using
2556 password: YES)"-error when trying to access a MySQL-Server on a
2557 host which is port-forwarded for my localhost
2558 </h4>
2559 <p>
2560 When you are using a port on your localhost, which you redirect via
2561 port-forwarding to another host, MySQL is not resolving the localhost
2562 as expected.<br />
2563 Erik Wasser explains: The solution is: if your host is "localhost"
2564 MySQL (the commandline tool 'mysql' as well) always tries to use the socket
2565 connection for speeding up things. And that doesn't work in this configuration
2566 with port forwarding.<br />
2568 TCP connection.
2569 </p>
2573 <h3>[3. Known limitations]</h3>
2575 <h4>
2576 [3.1] When using HTTP authentication, an user who logged out can not
2577 relogin in with the same nick.
2578 </h4>
2579 <p>
2580 This is related to the authentication mechanism (protocol) used by
2581 phpMyAdmin. To bypass this problem: just close all the opened
2582 browser windows and then go back to phpMyAdmin. You should be able to
2583 log in again.
2584 </p>
2586 <h4>
2587 [3.2] When dumping a large table in compressed mode, I get a memory
2588 limit error or a time limit error.
2589 </h4>
2590 <p>
2591 As of version 2.2.4, we build the compressed dump in memory, so large
2592 tables dumps may hang. The only alternative we can think about (using
2593 system calls to mysqldump then gzip or bzip2) would not be applicable in
2594 environments where PHP is in safe mode: access to system programs is
2595 is limited by the system administrator, and time limit is enforced.
2596 </p>
2598 <h4>
2599 [3.3] With InnoDB tables, I lose foreign key relationships when I rename
2600 or alter a table.
2601 </h4>
2602 <p>
2603 This seems to be a InnoDB bug (fixed in MySQL 3.23.50?). However, keep in
2604 mind that phpMyAdmin as of version 2.3.0 does not support InnoDB.
2605 </p>
2607 <h4>
2608 [3.4] I am unable to import dumps I created with the mysqldump tool
2609 bundled with the MySQL server distribution.
2610 </h4>
2611 <p>
2612 The problem is that mysqldump creates invalid comments like this:
2613 </p>
2614 <pre>
2615 -- MySQL dump 8.22
2616 --
2617 -- Host: localhost Database: database
2618 ---------------------------------------------------------
2619 -- Server version 3.23.54
2620 </pre>
2621 <p>
2622 The invalid part of the code is the horizontal line made of dashes that
2623 appears once in every dump created with mysqldump. If you want to run your
2624 dump you have to turn it into valid MySQL. This means, you have to add a
2625 whitespace after the first to dashes of the line or add a # before it:
2626 <br />
2627 <code>
2628 -- -------------------------------------------------------<br />
2629 </code>
2630 or<br />
2631 <code>
2632 #---------------------------------------------------------
2633 </code>
2634 </p>
2636 <h4>
2637 [3.3] When using nested folders ($cfg['LeftFrameTableSeparator']) there
2638 are some multiple hierarchies displayed in a wrong manner?!
2639 </h4>
2640 <p>
2641 Please note that you should not use the seperating string multiple times
2642 without any characters between them, or at the beginning/end of your table
2643 name. If you have to, think about using another TableSeparator or disabling
2644 that feature
2645 </p>
2648 <h3>[4. ISPs, multi-user installations ]</h3>
2650 <h4>
2651 [4.1] I'm an ISP. Can I setup one central copy of phpMyAdmin or do I
2652 need to install it for each customer.
2653 </h4>
2654 <p>
2655 Since version 2.0.3, you can setup a central copy of phpMyAdmin for all
2656 your users. The development of this feature was kindly sponsored by
2657 NetCologne GmbH.
2658 This requires a properly setup MySQL user management and phpMyAdmin
2659 HTTP or cookie authentication. See the install section on
2660 "Using HTTP authentication".
2661 </p>
2663 <h4>
2664 [4.2] What's the preferred way of making phpMyAdmin secure against evil
2665 access.
2666 </h4>
2667 <p>
2668 This depends on your system.<br />
2669 If you're running a server which cannot be accessed by other people, it's
2670 sufficient to use the directory protection bundled with your webserver
2671 (with Apache you can use <i>.htaccess</i> files, for example).<br />
2672 If other people have telnet access to your server, you should use
2673 phpMyAdmin's HTTP authentication feature.
2674 <br /><br />
2675 Suggestions:
2676 </p>
2677 <ul>
2678 <li>
2679 Your <i>config.inc.php3</i> file should be <tt>chmod 660</tt>.
2680 </li>
2681 <li>
2682 All your phpMyAdmin files should be chown phpmy.apache, where phpmy
2683 is a user whose password is only known to you, and apache is the
2684 group under which Apache runs.
2685 </li>
2686 <li>
2687 You should use PHP safe mode, to protect from other users that try
2688 to include your <i>config.inc.php3</i> in their scripts.
2689 </li>
2690 </ul>
2692 <h4>
2693 [4.3] I get errors about not being able to include a file in
2694 <i>/lang</i> or in <i>/libraries</i>.
2695 </h4>
2696 <p>
2697 Check <i>php.ini</i>, or ask your sysadmin to check it. The
2698 <tt>include_path</tt> must contain "." somewhere in it, and
2699 <tt>open_basedir</tt>, if used, must contain "." and
2700 "./lang" to allow normal operation of phpMyAdmin.
2701 </p>
2702 <h4>
2703 [4.4] phpMyAdmin always gives "Access denied" when using HTTP
2704 authentication.
2705 </h4>
2706 <p>
2707 This could happen for several reasons:
2708 </p>
2709 <ul>
2710 <li>
2711 <tt>$cfg['Servers'][$i]['controluser']</tt> and/or
2712 <tt>$cfg['Servers'][$i]['controlpass']</tt> are wrong.
2713 </li>
2714 <li>
2715 The username/password you specify in the login-dialog are invalid.
2716 </li>
2717 <li>
2718 You have already setup a security mechanism for the
2719 phpMyAdmin-directory, eg. a .htaccess file. This would interfere with
2720 phpMyAdmin's authentication, so remove it.
2721 </li>
2722 </ul>
2724 <h4>
2725 [4.5] Is it possible to let users create their own databases?
2726 </h4>
2727 <p>
2728 Starting with 2.2.5, in the user management page, you can enter a wildcard
2729 database name for a user (for example "joe%"),
2730 and put the privileges you want. For example,
2731 adding <tt>SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER</tt>
2732 would let a user create/manage his/her database(s).
2733 </p>
2735 <h4>
2736 [4.6] How can I use the Host-based authentication additions?
2737 </h4>
2738 <p>
2739 If you have existing rules from an old .htaccess file, you can take them
2740 and add a username between the <tt>'deny'</tt>/<tt>'allow'</tt> and
2741 <tt>'from'</tt> strings. Using the username wildcard of <tt>'%'</tt> would
2742 be a major benefit here if your installation is suited to using it. Then
2743 you can just add those updated lines into the
2744 <tt>$cfg['Servers'][$i]['AllowDeny']['rules']</tt> array.
2745 <br /><br />
2746 If you want a pre-made sample, you can try this fragment. It stops the
2747 'root' user from logging in from any networks other than the private
2748 network IP blocks.
2749 <br />
2750 <tt>
2751 //block root from logging in except from the private networks<br />
2752 $cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';<br />
2753 $cfg['Servers'][$i]['AllowDeny']['rules'] = array(<br />
2754 'deny root from all',<br />
2755 'allow root from localhost',<br />
2756 'allow root from 10.0.0.0/8',<br />
2757 'allow root from 192.168.0.0/16',<br />
2758 'allow root from 172.16.0.0/12',<br />
2759 );
2760 </tt>
2761 </p>
2762 <h4>
2763 [4.7] Authentication window is displayed more than once, why?
2764 </h4>
2765 <p>
2766 This happens if you are using a URL to start phpMyAdmin which is
2767 different than the one set in your <tt>$cfg['PmaAbsoluteUri']</tt>.
2768 For example, a missing "www", or entering with an IP address
2769 while a domain name is defined in the config file.
2770 </p>
2773 <h3>[5. Browsers or client OS]</h3>
2775 <h4>
2776 [5.1] I get an out of memory error, and my controls are non-functional,
2777 when trying to create a table with more than 14 fields.
2778 </h4>
2779 <p>
2780 We could reproduce this problem only under Win98/98SE. Testing under
2781 WinNT4 or Win2K, we could easily create more than 60 fields.
2782 <br />
2783 A workaround is to create a smaller number of fields, then come back to
2784 your table properties and add the other fields.
2785 </p>
2787 <h4>
2788 [5.2] With Xitami 2.5b4, phpMyAdmin won't process form fields.
2789 </h4>
2790 <p>
2791 This is not a phpMyAdmin problem but a Xitami known bug: you'll face it
2792 with each script/website that use forms.<br />
2793 Upgrade or downgrade your Xitami server.
2794 </p>
2796 <h4>
2797 [5.3] I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).
2798 </h4>
2799 <p>
2800 With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except that
2801 the proposed file name for the dump is always 'tbl_dump.php'. Bzip2 dumps
2802 don't seem to work.<br />
2804 With Konqueror 2.2.1: plain dumps work; zip dumps are placed into
2805 the user's temporary directory, so they must be moved before closing
2806 Konqueror, or else they disappear. GZip dumps give an error message.<br />
2808 Testing needs to be done for Konqueror 2.2.2.<br />
2809 </p>
2811 <h4>
2812 [5.4] I can't use the cookie authentication mode because Internet
2813 Explorer never stores the cookies.
2814 </h4>
2815 <p>
2816 MS Internet Explorer seems to be really buggy about cookies, at least till
2817 version 6. And thanks to Andrew Zivolup we've traced also a PHP 4.1.1 bug
2818 in this area!
2819 <br />
2820 Then, if you're running PHP 4.1.1, try to upgrade or downgrade... it may
2821 work!
2822 </p>
2824 <h4>
2825 [5.5] In Internet Explorer 5.0, I get JavaScript errors when browsing my
2826 rows.
2827 </h4>
2828 <p>
2829 Upgrade to at least Internet Explorer 5.5 SP2.<br />
2830 </p>
2832 <h4>
2834 when trying to modify a row in a table with many fields, or with a text field
2835 </h4>
2836 <p>
2837 Your table neither have a primary key nor an unique one, so we must use a
2838 long URL to identify this row. There is a limit on the length of the URL in
2839 those browsers, and this not happen in Netscape, for example. The
2840 workaround is to create a primary or unique key, or use another browser.
2841 <br />
2842 </p>
2844 <h4>
2845 [5.7] I refresh (reload) my browser, and come back to the welcome
2846 page.
2847 </h4>
2848 <p>
2849 Some browsers support right-clicking into the frame you want to refresh,
2850 just do this in the right frame.<br />
2851 </p>
2853 <h4>
2854 [5.8] With Mozilla 0.9.7 I have problems sending a query modified in the
2855 query box.
2856 </h4>
2857 <p>
2858 Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
2859 Mozilla versions.<br />
2860 </p>
2862 <h4>
2863 [5.9] With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
2864 whitespace in the SQL-Query edit area: the page scrolls down.
2865 </h4>
2866 <p>
2867 This is a Mozilla bug (see bug #26882 at
2869 </p>
2871 <h4>
2872 [5.10] With Netscape 4.75 I get empty rows between each row of data in a
2873 CSV exported file.
2874 </h4>
2875 <p>
2876 This is a known Netscape 4.75 bug: it adds some line feeds when exporting
2877 data in octet-stream mode. Since we can't detect the specific Netscape
2878 version, we cannot workaround this bug.
2879 </p>
2881 <h4>
2882 [5.11] Extended-ASCII characters like German umlauts are displayed
2883 wrong.
2884 </h4>
2885 <p>
2886 Please ensure that you have set your browser's character set to the one of the
2887 language file you have selected on phpMyAdmin's start page.
2888 Alternatively, you can try the auto detection mode that is supported by the
2889 recent versions of the most browsers.
2890 </p>
2892 <h4>
2893 [5.12] Apple OS X: Safari browser changes special characters to
2894 "?".
2895 </h4>
2896 <p>
2897 This issue has been reported by a OS X user, who adds that Chimera,
2898 Netscape and Mozilla do not have this problem.
2899 </p>
2901 <h4>
2902 [5.13] With Internet Explorer 5.5 or 6, and HTTP authentication type,
2903 I cannot manage two servers: I login to the first one, then the other one,
2904 but if I switch back to the first, I have to login on each operation.
2905 </h4>
2906 <p>
2907 This is a bug in Internet Explorer, other browsers do not behave this way.
2908 </p>
2910 <h4>
2911 [5.14] Using Opera6, I can manage to get to the authentification, but nothing
2912 happens after that, only a blank screen.
2913 </h4>
2914 <p>
2915 Having $cfg['QueryFrameJS'] set to TRUE, this leads to a bug in Opera6, because it
2916 is not able to interpret frameset definitiions written by JavaScript. Please upgrade
2917 to Opera7 at least.
2918 </p>
2921 <h3>[6. Using phpMyAdmin]</h3>
2923 <h4>
2924 [6.1] I can't insert new rows into a table / I can't create a table
2925 - MySQL brings up a SQL-error.
2926 </h4>
2927 <p>
2928 Examine the SQL error with care. Often the problem is caused by
2929 specifying a wrong field-type.<br />
2930 Common errors include:
2931 </p>
2932 <ul>
2933 <li>Using <tt>VARCHAR</tt> without a size argument</li>
2934 <li>Using <tt>TEXT</tt> or <tt>BLOB</tt> with a size argument</li>
2935 </ul>
2936 <p>
2937 Also, look at the syntax chapter in the MySQL manual to confirm that your
2938 syntax is correct.
2939 </p>
2941 <h4>
2942 [6.2] When I create a table, I click the Index checkbox for 2 fields and
2943 phpMyAdmin generates only one index with those 2 fields.
2944 </h4>
2945 <p>
2946 In phpMyAdmin 2.2.0 and 2.2.1, this is the way to create a multi-fields
2947 index. If you want two indexes, create the first one when creating the
2948 table, save, then display the table properties and click the Index link to
2949 create the other index.
2950 </p>
2952 <h4>
2953 [6.3] How can I insert a null value into my table?
2954 </h4>
2955 <p>
2956 Since version 2.2.3, you have a checkbox for each field that can be null.
2957 Before 2.2.3, you had to enter "null", without the quotes, as the
2958 field's value.
2959 </p>
2961 <h4>
2962 [6.4] How can I backup my database or table?
2963 </h4>
2964 <p>
2965 Click on a database or table name in the left frame, the properties will be
2966 displayed. Then on the menu, click "Export", you can dump
2967 the structure, the data, or both. This will generate standard SQL
2968 statements that can be used to recreate your database/table.
2969 <br /><br />
2970 You will need to choose "Save as file", so that phpMyAdmin can
2971 transmit the resulting dump to your station. Depending on your PHP
2972 configuration, you will see options to compress the dump. See also the
2973 <tt>$cfg['ExecTimeLimit']</tt> configuration variable.
2974 <br /><br />
2975 For additional help on this subject, look for the word "dump" in
2976 this document.
2977 </p>
2979 <h4>
2980 [6.5] How can I restore (upload) my database or table using a dump?
2981 How can I run a ".sql" file.
2982 </h4>
2983 <p>
2984 Click on a database name in the left frame, the properties will be
2985 local displayed. Then in the "Run SQL query" section, type in
2986 your dump filename, or use the Browse button. Then click Go.
2987 <br /><br />
2988 For additional help on this subject, look for the word "upload"
2989 in this document.
2990 </p>
2992 <h4>
2993 [6.6] How can I use the relation table in Query-by-example?
2994 </h4>
2995 <p>
2996 Here is an example with the tables persons, towns and countries, all
2997 located in the database mydb. If you don't have a <tt>PMA_relation</tt>
2998 table, create it as explained in the configuration section. Then create the
2999 example tables:
3000 <br /><br />
3001 <tt>
3002 CREATE TABLE REL_countries (<br />
3003 country_code char(1) NOT NULL default '',<br />
3004 description varchar(10) NOT NULL default '',<br />
3005 PRIMARY KEY (country_code)<br />
3006 ) TYPE=MyISAM;<br />
3007 <br />
3008 INSERT INTO REL_countries VALUES ('C', 'Canada');<br />
3009 <br />
3010 CREATE TABLE REL_persons (<br />
3011 id tinyint(4) NOT NULL auto_increment,<br />
3012 person_name varchar(32) NOT NULL default '',<br />
3013 town_code varchar(5) default '0',<br />
3014 country_code char(1) NOT NULL default '',<br />
3015 PRIMARY KEY (id)<br />
3016 ) TYPE=MyISAM;<br />
3017 <br />
3018 INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');<br />
3019 INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');<br />
3020 <br />
3021 CREATE TABLE REL_towns (<br />
3022 town_code varchar(5) NOT NULL default '0',<br />
3023 description varchar(30) NOT NULL default '',<br />
3024 PRIMARY KEY (town_code)<br />
3025 ) TYPE=MyISAM;<br />
3026 <br />
3027 INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');<br />
3028 INSERT INTO REL_towns VALUES ('M', 'Montréal');<br />
3029 <br />
3030 </tt>
3031 To setup appropriate links and display information:
3032 </p>
3033 <ul>
3034 <li>on table "REL_persons" click Structure, then Relation view</li>
3035 <li>in Links, for "town_code" choose "REL_towns->code"</li>
3036 <li>in Links, for "country_code" choose "REL_countries->country_code"</li>
3037 <li>on table "REL_towns" click Structure, then Relation view</li>
3038 <li>in "Choose field to display", choose "description"</li>
3039 <li>repeat the two previous steps for table "REL_countries"</li>
3040 </ul>
3042 <p>
3043 Then test like this:
3044 </p>
3045 <ul>
3046 <li>Click on your db name in the left frame</li>
3047 <li>Choose "Query"</li>
3048 <li>Use tables: persons, towns, countries</li>
3049 <li>Click "Update query"</li>
3050 <li>In the fields row, choose persons.person_name and click the
3051 "Show" tickbox </li>
3052 <li>Do the same for towns.description and countries.descriptions in the
3053 other 2 columns</li>
3054 <li>Click "Update query" and you will see in the query box that
3055 the correct joins have been generated</li>
3056 <li>Click "Submit query"</li>
3057 </ul>
3058 <br />
3061 <h4>
3062 [6.7] How can I use the "display field" feature?
3063 </h4>
3064 <p>
3065 Starting from the previous example, create the PMA_table_info as explained
3066 in the configuration section, then browse your persons table,
3067 and move the mouse over a town code or country code.
3068 <br /><br />
3069 See also FAQ 6.21 for an additionnal feature that "display field"
3070 enables: drop-down list of possible values.
3071 </p>
3074 <h4>
3075 [6.8] How can I produce a PDF schema of my database?
3076 </h4>
3077 <p>
3078 First you have to fill the "relation", "table_coords"
3079 and "pdf_pages" configuration variables.
3080 <br /><br />
3081 Then, think about your schema layout: which tables will go on which pages.
3082 </p>
3083 <ul>
3084 <li>Click on your db name in the left frame</li>
3085 <li>Choose "Structure" in the navigation on top</li>
3086 <li>Choose "Edit PDF Pages" which should be somewhere at the
3087 bottom of the page</li>
3088 <li>Enter the name for a first pdf page and submit (you can also use
3089 the "Automatic layout", which will place on your page
3090 all the tables that are linked)</li>
3091 <li>Choose this page to edit</li>
3092 <li>Now add a table you want to show on this page and its coordinates and
3093 submit<br />
3094 First you will have to guess those coordinates of course, so just expect
3095 to have an area of about 297 * 210 and put the tables coordinates
3096 somewhere in there, you will be able to have a look at what happened
3097 and change them later.<br />
3098 For example, x=100 and y=200 means that the table will be at 200 mm
3099 down and 100 mm right from the upper left corner.<br />
3100 Actually if you have a width of more than 300 or a height of more than
3101 200 then it will automatically be scaled but 200*100 is a good start to
3102 have an idea of what coordinates to use.</li>
3103 <li>There is also a visual editor (scratchboard) available, see the
3105 <li>After every table you submitted you will have the possibility to submit
3106 more tables</li>
3107 <li>When you have entered enough tables Click on your db name in the left
3108 frame again</li>
3109 <li>Now, again at the bottom of the page you should be able to choose
3110 "Display PDF schema"<br />
3111 For testing it might be useful to show the grid as well, so you can see
3112 the coordinates used.<br />
3113 Maybe also choose color and submit.</li>
3114 <li>Save the file he will offer you to something like <i>Schema.pdf</i>
3115 (Internet Explorer has some bug there which might make it offer it
3116 without an extension. Under Windows it is important to have the
3117 extension ".pdf", under other OSes you should be fine just
3118 saving the file under the name it offers).</li>
3119 </ul>
3121 <h4>
3122 [6.9] phpMyAdmin is changing the type of one of my columns!
3123 </h4>
3124 <p>
3125 No, it's MySQL that is doing
3126 <a href="http://www.mysql.com/doc/S/i/Silent_column_changes.html">silent column type changing</a>.
3127 </p>
3130 <h4>
3131 [6.10] When creating a privilege, what happens with underscores in
3132 the database name?
3133 </h4>
3134 <p>
3135 If you do not put a backslash before the underscore, this is a wildcard
3136 grant, and the underscore means "any character". So, if the
3137 database name is "john_db", the user would get rights to john1db,
3138 john2db...<br /><br />
3139 If you put a backslash before the underscore, it means that the database
3140 name will have a real underscore.
3141 </p>
3143 <h4>
3144 [6.11] What is the curious symbol ø in the statistics pages?
3145 </h4>
3146 <p>
3147 It means "average".
3148 </p>
3151 <h4>
3152 [6.12] I want to understand some Export options.
3153 </h4>
3154 <p>
3155 "Complete inserts" adds the column names on every INSERT command,
3156 for better documentation (but resulting file is bigger).<br />
3157 "Extended inserts" provides a shorter dump file by using only
3158 once the INSERT verb and the table name.<br />
3159 "Enclose table and field names with backquotes" ensures that
3160 field and table names formed with special characters are protected.<br />
3161 "Include column comments as inline SQL-comments" includes any
3162 column comments set in the PMA-DB in the dump as SQL comments (<i>/* xxx */</i>).<br /></p>
3164 <h4>
3165 [6.13] I would like to create a database with a dot in its name.
3166 </h4>
3167 <p>
3168 This is a bad idea, because in MySQL the syntax "database.table"
3169 is the normal way to reference a database and table name. Worse, MySQL
3170 will usually let you create a database with a dot, but then you cannot
3171 work with it, nor delete it.<br />
3172 </p>
3175 <h4>
3176 [6.14] How do I set up the SQL Validator?
3177 </h4>
3178 <p>
3179 To use it, you need a very recent version of PHP, 4.3.0 recommended, with
3180 XML, PCRE and PEAR support. On your system command line, run
3181 <tt>"pear install Net_Socket Net_URL HTTP_Request Mail_Mime Net_DIME
3182 SOAP"</tt> to get the necessary PEAR modules for usage.
3183 <br />
3184 If you use it, you should be aware that any SQL statement you
3185 submit will be stored anonymously (database/table/column names,
3186 strings, numbers replaced with generic values). The Mimer SQL
3187 Validator itself, is © 2001 Upright Database Technology.
3188 We utilize it as free SOAP service.
3189 </p>
3191 <h4>
3192 [6.15] I want to add a BLOB field and put an index on it, but MySQL
3193 says "BLOB column '...' used in key specification without a key
3194 length".
3195 </h4>
3196 <p>
3197 The right way to do this, is to create the field without any indexes,
3198 then display the table structure and use the "Create an index"
3199 dialog. On this page, you will be able to choose your BLOB field, and
3200 set a size to the index, which is the condition to create an index on
3201 a BLOB field.
3202 <br />
3203 </p>
3205 <h4>
3206 [6.16] How can I simply move in page with plenty editing fields?
3207 </h4>
3208 <p>
3209 You can use Ctrl+arrows for moving on most pages with plenty editing
3210 fields (table structure changes, row editing, etc.) (must be anabled in
3211 configuration - see. $cfg['CtrlArrowsMoving']). You can also have a look
3212 at the directive $cfg['DefaultPropDisplay'] ('vertical') and see if this
3213 eases up editing for you.
3214 <br />
3215 </p>
3217 <h4>
3218 [6.17] Transformations: I can't enter my own mimetype! WTF is this feature
3219 then useful for?
3220 </h4>
3221 <p>
3222 Slow down :). Defining mimetypes is of no use, if you can't put transformations on them.
3223 Otherwise you could just put a comment on the field. Because entering your own mimetype will
3224 cause serious syntax checking issues and validation, this introduces a high-risk false-user-input
3225 situation. Instead you have to initialize mimetypes using functions or empty mimetype definitions.
3226 <br />
3227 Plus, you have a whole overview of available mimetypes. Who knows all those mimetypes by heart so
3228 he/she can enter it at will?
3229 <br />
3230 </p>
3233 <h4>
3234 [6.18] Bookmarks: Where can I store bookmarks? Why can't I see any bookmarks below the query box?
3235 What is this variable for?
3236 </h4>
3237 <p>
3238 Any query you have executed can be stored as a bookmark on the page where the results are displayed.
3239 You will find a button labeled 'Bookmark this query' just at the end of the page.<br />
3240 As soon as you have stored a bookmark, it is related to the database you run the query on. You can
3241 now access a bookmark dropdown on each page, the query box appears on for that database.<br />
3242 <br />
3243 Since phpMyAdmin 2.5.0 you are also able to store variables for the bookmarks. Just use the string
3244 <b>/*[VARIABLE]*/</b> anywhere in your query. Everything which is put into the <i>value</i> input
3245 box on the query box page will replace the string "/*[VARIABLE]*/" in your stored query.
3246 Just be aware of that you HAVE to create a valid query, otherwise your query won't be even able to be
3247 stored in the database.<br />
3248 Also remember, that everything else inside the <b>/*[VARIABLE]*/</b> string for your query will remain
3249 the way it is, but will be stripped of the /**/ chars. So you can use:<br /><br />
3250 <code>/*, [VARIABLE] AS myname */</code><br /><br />
3251 which will be expanded to<br /><br />
3252 <code>, VARIABLE as myname</code><br /><br />
3253 in your query, where VARIABLE is the string you entered in the input box. If an empty string is
3254 provided, no replacements are made.<br />
3255 <br />
3256 A more complex example. Say you have stored this query:<br /><br />
3257 <code>SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE '%[VARIABLE]%' */</code><br /><br />
3258 Say, you now enter "phpMyAdmin" as the variable for the stored query, the full query will
3259 be:<br /><br />
3260 <code>SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE '%phpMyAdmin%'</code>
3261 <br />
3262 <br />
3263 You can use multiple occurences of <b>/*[VARIABLE]*/</b> in a single query.<br />
3264 <b>NOTE THE ABSENCE OF SPACES</b> inside the "/**/" construct. Any spaces inserted there
3265 will be later also inserted as spaces in your query and may lead to unexpected results especially when
3266 using the variable expansion inside of a "LIKE ''" expression.<br />
3267 Your initial query which is going to be stored as a bookmark has to yield at least one result row so
3268 you can store the bookmark. You may have that to work around using well positioned "/**/"
3269 comments.
3270 </p>
3272 <h4>
3273 [6.19] How can I create simple LaTeX document to include exported table?
3274 </h4>
3275 <p>
3276 You can simply include table in your LaTeX documents, minimal sample
3277 document should look like following one (assuming you have table
3278 exported in file <code>table.tex</code>):
3279 <br />
3280 <br />
3281 <pre>
3282 <font color="#a52a2a"><b>\documentclass</b></font><font color="#6a5acd">{</font><font color="#a020f0">article</font><font color="#6a5acd">}</font>
3283 <font color="#a52a2a"><b>\usepackage</b></font><font color="#6a5acd">{</font><font color="#6a5acd">longtable</font><font color="#6a5acd">}</font>
3285 <font color="#a52a2a"><b>\begin</b></font><font color="#6a5acd">{</font><font color="#a020f0">document</font><font color="#6a5acd">}</font>
3287 <font color="#a52a2a"><b>\include</b></font><font color="#6a5acd">{</font><font color="#6a5acd">table</font><font color="#6a5acd">}</font>
3289 <font color="#a52a2a"><b>\end</b></font><font color="#6a5acd">{</font><font color="#a020f0">document</font><font color="#6a5acd">}</font>
3290 </pre>
3291 </p>
3293 <h4>
3294 [6.20] In MySQL 4, I see a lot of databases which are not mine, and cannot
3295 access them.
3296 </h4>
3297 <p>
3298 Upgrading to MySQL 4 usually gives users a global privilege: CREATE
3299 TEMPORARY TABLES. This privilege also enables users to see all the
3301 So if your users do not need this privilege, you can remove it and their
3302 databases list will shorten.
3303 </p>
3304 <h4>
3305 [6.21] In edit/insert mode, how can I see a list of possible values for
3306 a field, based on some foreign table?
3307 </h4>
3308 <p>
3309 You have to setup appropriate links between the tables, and also
3310 setup the "display field" in the foreign table. See FAQ
3311 6.6 for an example. Then, if there are 200 values or less in the
3312 foreign table, a drop-down list of values will be available.
3313 </p>
3315 <h3>[7. phpMyAdmin project]</h3>
3317 <h4>
3318 [7.1] I have found a bug. How do I inform developers?
3319 </h4>
3320 <p>
3321 Our Bug Tracker is located at
3322 <a href="http://sourceforge.net/projects/phpmyadmin/">http://sourceforge.net/projects/phpmyadmin/</a>
3323 under the Bugs section.
3324 <br /><br />
3325 But please first discuss your bug with other users:
3326 <br />
3328 http://sourceforge.net/projects/phpmyadmin/</a> (and choose Forums)
3329 </p>
3331 <h4>
3332 [7.2] I want to translate the messages to a new language or upgrade an
3333 existing language, where do I start?
3334 </h4>
3335 <p>
3336 Always use the current CVS version of your language file.
3337 For a new language, start from <i>english-iso-8859-1.inc.php3</i>. If you
3338 don't know how to get the CVS version, please ask one of the developers.
3339 <br />
3340 Please note that we try not to use HTML entities like &eacute; in
3341 the translations, since we define the right character set in the file.
3342 With HTML entities, the text on JavaScript messages would not
3343 display correctly.
3344 However there are some entities that need to be there, for quotes
3345 ,non-breakable spaces, ampersands, less than, greater than.
3346 <br />
3347 You can then put your translations, as a zip file to avoid losing special
3348 characters, on the sourceforge.net translation tracker.
3349 <br />
3350 It would be a good idea to subscribe to the phpmyadmin-translators mailing
3351 list, because this is where we ask for translations of new messages.
3352 <br />
3353 </p>
3355 <h4>
3356 [7.3] I would like to help out with the development of phpMyAdmin. How
3357 should I proceed?
3358 </h4>
3359 <p>
3360 The following method is preferred for new developers:
3361 </p>
3362 <ol>
3363 <li>
3364 fetch the current CVS tree over anonymous CVS:<br />
3365 <tt>cvs -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin login</tt><br />
3366 [Password: simply press the Enter key]<br />
3367 <tt>cvs -z3 -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin checkout phpMyAdmin</tt><br />
3368 [This will create a new sub-directory named phpMyAdmin]
3369 </li>
3370 <li>
3371 add your stuff
3372 </li>
3373 <li>
3374 put the modified files (tar'ed and gzip'ed) inside the patch tracker of
3375 the
3376 <a href="http://sourceforge.net/projects/phpmyadmin/" target="_blank">phpMyAdmin SourceForge account</a>.
3377 </li>
3378 </ol>
3379 <p>
3380 Write access to the CVS tree is granted only to experienced developers who
3381 have already contributed something useful to phpMyAdmin.<br />
3382 Also, have a look at the
3384 </p>
3386 <h3>[8. Security ]</h3>
3388 <h4>
3389 [8.1] Security alert, dated 2003-06-18.
3390 </h4>
3391 <p>
3392 Last update of this FAQ: 2003-07-22.
3393 <br /><br />
3394 The phpMyAdmin development team received notice of this security alert:
3395 <a href="http://www.securityfocus.com/archive/1/325641" target="_blank">http://www.securityfocus.com/archive/1/325641.</a>
3396 <br /><br />
3398 The team regrets that the author did not communicate with us before
3399 sending this alert. However, here is our current reply to the points mentionned:
3400 <br /><br />
3401 <ul>
3402 <li>"Directory transversal attack"
3403 <br /><br />
3405 This problem had been fixed in version 2.5.0, even if the author reports
3406 the 2.5.2 development version as vulnerable, which we could not reproduce.
3407 <br /><br />
3408 </li>
3409 <li>"Remote local file retrieving"
3410 <br /><br />
3411 This is a misleading title, as the author tells in his text:
3412 "Note that you can't request files ( only dirs )".
3413 <br /><br />
3414 </li>
3416 <li>"Remote internal directory listing"
3417 <br /><br />
3418 It was possible to retrieve the list of phpMyAdmin's directory (which we
3419 doubt can cause any damage), but we fixed this in the
3420 2.5.2 version.
3421 <br /><br />
3422 </li>
3424 <li>"XSS and Path disclosures"
3425 <br /><br />
3426 Most of the XSS problems have been fixed in version 2.5.0. The rest
3427 have been fixed in the 2.5.2 version.
3428 <br /><br />
3429 We believe that the Path disclosures problems have also been fixed
3430 in version 2.5.2.
3431 <br /><br />
3432 </li>
3433 <li>"Information encoding weakness"
3434 <br /><br />
3435 We believe that an exploit for this weakness would be difficult
3436 to achieve. However version 2.5.2 now encrypts the password
3437 with the well-known blowfish algorithm.
3438 <br /><br />
3439 </li>
3440 </ul>
3442 </p>
3444 <!-- DEVELOPERS -->
3446 <h2>Developers Information</h2>
3448 <p>
3449 phpMyAdmin is Open Source, so you're invited to contribute to it. Many
3450 great features have been written by other people and you too can help to
3451 make phpMyAdmin a useful tool.
3452 </p>
3454 <p>
3455 If you're planning to contribute source, please read the following
3456 information:
3457 </p>
3458 <ul>
3459 <li>
3460 All files include <i>header.inc.php3</i> (layout),
3461 <i>libraries/common.lib.php3</i> (common functions) and
3462 <i>config.inc.php3</i>.
3463 <br />
3464 All configuration data belongs in <i>config.inc.php3</i>. Please keep
3465 it free from other code.
3466 <br />
3467 Commonly used functions should be added to
3468 <i>libraries/common.lib.php3</i> and more specific ones may be added
3469 within a library stored into the <i>libraries</i> sub-directory.
3470 </li>
3471 <li>
3472 Obviously, you're free to use whatever coding style you want. But
3473 please try to keep your code as simple as possible: beginners are
3474 using phpMyAdmin as an example application.<br />
3475 As far as possible, we want the scripts to be XHTML1.0 and CSS2
3476 compliant on one hand, they fit the
3478 on the other hand. Please pay attention to this.
3479 </li>
3480 <li>
3481 Please try to keep up the file-naming conventions. Table-related stuff
3482 goes to <i>tbl_*.php3</i>, db-related code to <i>db_*.php3</i>,
3483 server-related tools to <i>server_*.php3</i> and so on.
3484 </li>
3485 <li>
3486 Please don't use verbose strings in your code, instead add the string
3487 (at least) to <i>english-iso-8859-1.inc.php3</i> and print() it out.
3488 </li>
3489 <li>
3490 If you want to be really helpful, write an entry for the ChangeLog.
3491 </li>
3494 Debugger DBG</a>) is now supported by phpMyAdmin for developers to
3495 better debug and profile their code.<br />
3496 Please see the <tt>$cfg['DBG']*</tt> configuration options for more
3497 information.<br />
3498 This is in memoriam of the Space Shuttle Columbia (STS-107) which was
3499 lost during its re-entry into Earth's atmosphere and in memory of the
3500 brave men and women who gave their lives for the people of Earth.
3501 </li>
3503 </ul>
3505 <!-- CREDITS -->
3507 <h2>Credits</h2>
3509 <pre>
3511 phpMyAdmin - Credits
3512 ====================
3514 CREDITS, in chronological order
3515 -------------------------------
3517 - Tobias Ratschiller <tobias.ratschiller_at_maguma.com>
3518 * creator of the phpmyadmin project
3519 * maintainer from 1998 to summer 2000
3521 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca>
3522 * multi-language version
3523 * various fixes and improvements
3524 * project co-administrator
3526 - Olivier Müller <om_at_omnis.ch>
3527 * started SourceForge phpMyAdmin project in March 2001
3528 * sync'ed different existing CVS trees with new features and bugfixes
3529 * multi-language improvements, dynamic language selection
3530 * current project maintainer
3531 * many bugfixes and improvements
3533 - Loïc Chapeaux <lolo_at_phpheaven.net>
3534 * rewrote and optimized javascript, DHTML and DOM stuff
3535 * rewrote the scripts so they fit the PEAR coding standards and
3536 generate XHTML1.0 and CSS2 compliant codes
3537 * improved the language detection system
3538 * many bugfixes and improvements
3540 - Robin Johnson <robbat2_at_users.sourceforge.net>
3541 * database maintence controls
3542 * table type code
3543 * Host authentication IP Allow/Deny
3544 * DB-based configuration (Not completed)
3545 * SQL parser
3546 * SQL validator
3547 * many bugfixes and improvements
3549 - Armel Fauveau <armel.fauveau_at_globalis-ms.com>
3550 * bookmarks feature
3551 * multiple dump feature
3552 * gzip dump feature
3553 * zip dump feature
3555 - Geert Lund <glund_at_silversoft.dk>
3556 * various fixes
3557 * moderator of the phpMyAdmin users forum at phpwizard.net
3559 - Korakot Chaovavanich <korakot_at_iname.com>
3560 * "insert as new row" feature
3562 - Pete Kelly <webmaster_at_trafficg.com>
3563 * rewrote and fix dump code
3564 * bugfixes
3566 - Steve Alberty <alberty_at_neptunlabs.de>
3567 * rewrote dump code for PHP4
3568 * mySQL table statistics
3569 * bugfixes
3571 - Benjamin Gandon <gandon_at_isia.cma.fr>
3572 * main author of the version 2.1.0.1
3573 * bugfixes
3575 - Alexander M. Turek <derrabus_at_gmx.de>
3576 * XML exports
3577 * MySQL 4 related features
3578 * various features and fixes
3579 * German language file updates
3581 - Mike Beck <mike.beck_at_ibmiller.de>
3582 * automatic joins in QBE
3583 * links column in printview
3584 * Relation view
3586 - Michal Cihar <nijel_at_users.sourceforge.net>
3587 * enhanced index creation/display feature
3588 * feature to use a different charset for HTML than for MySQL
3589 * Czech language file updates
3591 - Christophe Gesché from the "MySQL Form Generator for PHPMyAdmin"
3592 (http://sourceforge.net/projects/phpmysqlformgen/)
3593 * suggested the patch for multiple table printviews
3595 - Garvin Hicking <me_at_supergarv.de>
3596 * built the patch for vertical display of table rows
3597 * built the Javascript based Query window + SQL history
3598 * Improvement of column/db comments
3599 * (MIME)-Transformations for columns
3600 * Use custom alias names for Databases in left frame
3601 * hierarchical/nested table display
3602 * PDF-scratchboard for WYSIWYG-distribution of PDF relations
3603 * new icon sets
3604 * vertical display of column properties page
3605 * some bugfixes, features, support, german language additions
3607 - Yukihiro Kawada <kawada_at_den.fujifilm.co.jp>
3608 * japanese kanji encoding conversion feature
3610 - Piotr Roszatycki <d3xter_at_users.sourceforge.net> and Dan Wilson
3611 * the Cookie authentication mode
3613 - Axel Sander <n8falke_at_users.sourceforge.net>
3614 * table relation-links feature
3616 - Maxime Delorme <delorme.maxime_at_free.fr>
3617 * PDF schema output, thanks also to Olivier Plathey for the
3618 "FPDF" library (see http://www.fpdf.org/).
3620 - Olof Edlund <olof.edlund_at_upright.se>
3621 * SQL validator server
3623 - Ivan R. Lanin <ivanlanin_at_users.sourceforge.net>
3624 * phpMyAdmin logo
3626 - Mike Cochrane <mike_at_graftonhall.co.nz>
3627 * blowfish library from the Horde project
3629 And also to the following people who have contributed minor changes,
3630 enhancements, bugfixes or support for a new language since version 2.1.0:
3632 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
3633 Péter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
3634 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kläger,
3635 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
3636 Bernard M. Piller, Laurent Haas, "Sakamoto", Yuval Sarna,
3637 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
3638 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
3639 Luís V., Martijn W. van der Lee,
3640 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
3641 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, "Manuzhai".
3644 Original Credits of Version 2.1.0
3645 ---------------------------------
3647 This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
3648 to create a web-based interface to MySQL using PHP3. Although I have not
3649 used any of his source-code, there are some concepts I've borrowed from
3650 him. phpMyAdmin was created because Peter told me he wasn't going to
3651 further develop his (great) tool.
3652 Thanks go to
3653 - Amalesh Kempf <ak-lsml_at_living-source.com> who contributed the
3654 code for the check when dropping a table or database. He also suggested
3655 that you should be able to specify the primary key on tbl_create.php3. To
3656 version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
3657 well as a bug-report. Plus many smaller improvements.
3658 - Jan Legenhausen <jan_at_nrw.net>: He made many of the changes that
3659 were introduced in 1.3.0 (including quite significant ones like the
3660 authentication). For 1.4.1 he enhanced the table-dump feature. Plus
3661 bug-fixes and help.
3662 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca> made phpMyAdmin
3663 language-independent by outsourcing the strings to a separate file. He
3664 also contributed the French translation.
3665 - Alexandr Bravo <abravo_at_hq.admiral.ru> who contributed
3666 tbl_select.php3, a feature to display only some fields from a table.
3667 - Chris Jackson <chrisj_at_ctel.net> added support for MySQL
3668 functions in tbl_change.php3. He also added the
3669 "Query by Example" feature in 2.0.
3670 - Dave Walton <walton_at_nordicdms.com> added support for multiple
3671 servers and is a regular contributor for bug-fixes.
3672 - Gabriel Ash <ga244_at_is8.nyu.edu> contributed the random access
3673 features for 2.0.6.
3674 The following people have contributed minor changes, enhancements, bugfixes
3675 or support for a new language:
3676 Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
3677 Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
3678 Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
3679 G. Wieggers.
3681 And thanks to everyone else who sent me email with suggestions, bug-reports
3682 and or just some feedback.
3683 </pre>
3690 <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" border="0" height="31" width="88" /></a>
3691
3693 <img src="http://www.w3.org/Icons/valid-css" alt="Valid CSS!" border="0" width="88" height="31" /></a>
3694 </p>
3696 </body>
3697 </html>