| blob | c81829c010d6fa139ca581fad0e55c5f1e754851 |
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>
915 </dt>
916 <dd>
917 Because release 2.5.0 introduced the new MIME-transformation support, the
918 column_info table got enhanced with three new fields. If the above variable is
919 set to TRUE (default) phpMyAdmin will check if you have the latest table structure
920 available. If not, it will emit a warning to the superuser.<br /><br />
922 You can disable this checking behavior by setting the variable to false, which
923 should offer a performance increase.<br /><br />
925 Recommended to set to FALSE, when you are sure, your table structure is up to date.
926 <br /><br />
927 </dd>
929 <dt>
931 </dt>
932 <dd>
933 If your rule order is empty, then IP authentication is disabled.
934 <br /><br />
936 applies all deny rules followed by allow rules.
937 Access is allowed by default. Any client which does not match a Deny
938 command or does match an Allow command will be allowed access to the
939 server.
940 <br /><br />
942 applies all allow rules followed by deny rules. Access is denied by
943 default. Any client which does not match an Allow directive or does
944 match a Deny directive will be denied access to the server.
945 <br /><br />
946 If your rule order is set to 'explicit', the authentication is
947 performed in a similar fashion to rule order 'deny,allow', with the
951 and was available in Apache by specifying allow and deny rules without
952 setting any order.
953 <br /><br />
954 </dd>
956 <dt>
958 </dt>
959 <dd>
960 The general format for the rules is as such:<br />
961 <tt>
962
964 </tt>
965 <br /><br />
970 well:<br />
971 <tt>
974 </tt>
975 <br /><br />
977 Having an empty rule list is equivalent to either using
981 <br /><br />
983 For the IP matching system, the following work:<br />
987 But the following does not work:<br />
989 <br /><br />
990 </dd>
993 <dd>
994 If you have more than one server configured, you can set
996 that server when phpMyAdmin is started, or set it to 0 to be given a
997 list of servers without logging in.<br />
999 MUST be set to that server.
1000 <br /><br />
1001 </dd>
1004 <dd>
1005 Defines whether to use GZip output buffering for increased
1006 speed in HTTP transfers.<br />
1007 Set to true/false for enabling/disabling. When set to 'auto' (string),
1008 phpMyAdmin tries to enable output buffering and will automatically disable
1009 it, if your browser has some problems with buffering. IE6 with a certain patch
1010 is known to cause data corruption having enabled buffering.
1011 <br /><br />
1012 </dd>
1015 <dd>
1016 Whether persistent connections should be used or not (mysql_connect or
1017 mysql_pconnect).
1018 <br /><br />
1019 </dd>
1022 <dd>
1023 Set the number of seconds a script is allowed to run. If seconds is set
1024 to zero, no time limit is imposed.<br />
1025 This setting is used while importing/exporting dump files but has no
1026 effect when PHP is running in safe mode.
1027 <br /><br />
1028 </dd>
1031 <dd>
1032 Mark used tables and make it possible to show databases with locked
1033 tables (since 3.23.30).
1034 <br /><br />
1035 </dd>
1038 <dd>
1039 Defines whether SQL-queries generated by phpMyAdmin should be displayed
1040 or not.
1041 <br /><br />
1042 </dd>
1045 <dd>
1046 Defines whether normal users (non-administrator) are allowed to
1047 delete their own database or not. If set as FALSE, the link "Drop
1049 mydatabase" will be rejected. Quite practical for ISP's with many
1050 customers.
1051 <br /><br />
1052 </dd>
1055 <dd>
1057 displayed when you're about to loose data.
1058 <br /><br />
1059 </dd>
1062 <dd>
1063 Define whether the previous login should be recalled or not in cookie
1064 authentication mode.
1065 <br /><br />
1066 </dd>
1069 <dd>
1070 Define whether the "search string inside database" is enabled or not.
1071 <br /><br />
1072 </dd>
1075 <dd>
1076 Define whether phpMyAdmin will continue executing a multi-query statement if one of the
1077 queries fails. Default is to abort execution.
1078 <br /><br />
1079 </dd>
1082 <dd>
1083 Define whether phpMyAdmin will output the results of each query of a multi-query statement
1084 embedded into the SQL output as inline comments. Defaults to TRUE.
1085 <br /><br />
1086 </dd>
1089 <dd>
1090 Defines whether to use select-based menu and display only the current
1091 tables in the left frame (smaller page).
1092 Only in Non-Lightmode you can use the feature to display nested folders
1093 using $cfg['LeftFrameTableSeparator']
1094 <br /><br />
1095 </dd>
1098 <dd>
1099 Defines a string to be used to nest table spaces. Defaults to '__'. This
1100 means if you have tables like 'first__second__third' this will be
1102 If set to FALSE or empty, the feature is disabled.
1103 NOTE: You shall not use this Separator in a table name at the beginning or
1104 end of a table name, or multiple times after another without any other
1105 characters in between.
1106 <br /><br />
1107 </dd>
1110 <dd>
1111 Defines how many sublevels should be displayed when splitting
1112 up tables by the above Separator.
1113 <br /><br />
1114 </dd>
1117 <dd>
1118 Defines whether to display table comment as tool-tip in left frame or
1119 not.
1120 <br /><br />
1121 </dd>
1124 <dd>
1125 If tool-tips are enabled and a DB comment is set, this will flip the comment
1126 and the real name. That means, if you have a table called 'user0001' and add
1127 the comment 'MyName' on it, you will see the name 'MyName' used consequently
1128 in the left frame and the tool-tip shows the real name of the DB.
1129 <br /><br />
1130 </dd>
1133 <dd>
1134 Same as $cfg['ShowTooltipAliasDB'], except this works for table names.
1135 <br /><br />
1136 </dd>
1139 <dd>
1140 Defines whether to display space usage and statistics about databases
1141 and tables or not.<br />
1142 Note that statistics requires at least MySQL 3.23.3 and that, at this
1143 date, MySQL doesn't return such information for Berkeley DB tables.
1144 <br /><br />
1145 </dd>
1147 <dt>
1152 </dt>
1153 <dd>
1157 starting main (right) frame. This setting does not check MySQL commands
1158 entered directly.
1159 <br /><br />
1161 Please note that to block the usage of phpinfo() in scripts, you
1162 have to put this in your php.ini:<br />
1164 <br /><br />
1168 coded password value in the configuration file, end users can't be
1169 allowed to change their passwords.
1170 <br /><br />
1171 </dd>
1174 <dd>
1175 Defines whether to suggest a database name on the
1177 <br /><br />
1178 </dd>
1181 <dd>
1183 content or not.
1184 <br /><br />
1185 </dd>
1188 <dd>
1189 Defines whether navigation bar buttons contain text or symbols only.
1190 <br /><br />
1191 </dd>
1194 <dd>
1195 Defines whether an user should be displayed a
1197 <br /><br />
1198 </dd>
1201 <dd>
1202 Number of rows displayed when browsing a result set. If the result set
1203 contains more rows, Previous/Next links will be shown.
1204 <br /><br />
1205 </dd>
1208 <dd>
1212 DATE, DATETIME & TIMESTAMP, ascending order else- by default.
1213 <br /><br />
1214 </dd>
1217 <dd>
1219 from edition when browsing a table's content or not.
1220 Valid values are:<br />
1223 <br />
1226 <br /><br />
1227 </dd>
1230 <dd>
1231 Defines whether MySQL functions fields should be displayed or not in
1232 edit/insert mode.
1233 <br /><br />
1234 </dd>
1237 <dd>
1238 Defines which type of editing controls should be used for CHAR and
1239 VARCHAR fields. Possible values are:
1240 <ul>
1241 <li>
1242 input - this allows to limit size of text to size of field in
1243 MySQL, but has problems with newlines in fields
1244 </li>
1245 <li>
1246 textarea - no problems with newlines in fields, but also no
1247 length limitations
1248 </li>
1249 </ul>
1250 Default is old behavior so input.
1251 <br /><br />
1252 </dd>
1254 <dt>
1258 </dt>
1259 <dd>
1260 Defines whether to allow the use of zip/GZip/BZip2 compression when
1261 creating a dump file or not.
1262 <br /><br />
1263 </dd>
1266 <dd>
1267 If set to True, do use less graphically intense tabs on the top of the mainframe.
1268 <br /><br />
1269 </dd>
1272 <dd>
1273 If set to True, will display icons instead of text for db and table properties links (like 'Browse', 'Select', 'Insert', ...).<br />
1274 Can be set to 'both' if you want icons AND text.<br />
1275 When set to False, will only show text.
1276 <br /><br />
1277 </dd>
1280 <dd>
1281 How many columns will be utilized to display the tables on the database property view?
1282 Default is 1 column. When setting this to a value larger than 1, the type of the database will be
1283 omitted for more display space.
1284 <br /><br />
1285 </dd>
1289 <dd>
1290 Defines the tab displayed by default on server view. Possible
1295 <br /><br />
1296 </dd>
1299 <dd>
1300 Defines the tab displayed by default on database view. Possible
1303 <br /><br />
1304 </dd>
1307 <dd>
1308 Defines the tab displayed by default on table view. Possible
1312 <br /><br />
1313 </dd>
1316 <dd>
1317 If set to an URL which points to the MySQL documentation (type depends
1319 generated.
1320 <br />
1322 Documentation page</a> for more information about MySQL manuals and
1323 their types.
1324 <br /><br />
1325 </dd>
1328 <dd>
1329 Type of MySQL documentation:
1330 <ul>
1336 </ul>
1337 <br /><br />
1338 </dd>
1341 <dd>
1342 Defines the default language to use, if not browser-defined or
1343 user-defined.<br />
1345 this setting.
1346 <br /><br />
1347 </dd>
1350 <dd>
1351 Force: always use this language (must be defined in the
1353 <br /><br />
1354 </dd>
1357 <dd>
1358 Default character set to use for recoding of MySQL queries. This must be
1360 option.<br />
1361 You can give here any character set which is in
1363 choice, user can select any of them.
1364 <br /><br />
1365 </dd>
1368 <dd>
1369 Allow character set recoding of MySQL queries. You need recode or iconv
1370 support (compiled in or module) in PHP to allow MySQL queries recoding
1371 and used language file must have it enabled (by default only these
1372 which are in Unicode, just to avoid losing some characters).
1373 <br /><br />
1374 </dd>
1377 <dd>
1378 You can select here which functions will be used for character set
1379 conversion.
1380 Possible values are:<br />
1381 <ul>
1382 <li>auto - automatically use available one (first is tested
1383 iconv, then recode)</li>
1386 </ul>
1387 Default is auto.
1388 <br /><br />
1389 </dd>
1392 <dd>
1393 Specify some parameters for iconv used in charset conversion. See
1394 <a
1396 documentation</a> for details.
1397 <br /><br />
1398 </dd>
1401 <dd>
1402 Available character sets for MySQL conversion. You can add your own (any of
1403 supported by recode/iconv) or remove these which you don't use.
1404 Character sets will be shown in same order as here listed, so if you
1405 frequently use some of these move them to the top.
1406 <br /><br />
1407 </dd>
1410 <dd>
1412 MIME transformations.<br />
1413 Possible values are:<br />
1414 <ul>
1415 <li>
1416 auto - automatically detect, this is a bit expensive
1418 according to your server real possibilities
1419 </li>
1422 </ul>
1423 Default is auto.
1424 <br /><br />
1425 </dd>
1428 <dd>
1429 Left frame width in pixel.
1430 <br /><br />
1431 </dd>
1433 <dt>
1436 </dt>
1437 <dd>
1438 The background colors (HTML) used for both the frames.
1439 <br /><br />
1440 </dd>
1442 <dt>
1444 </dt>
1445 <dd>
1446 The URI of the background image used for the right frame. It can be
1447 absolute as well as relative from your phpMyAdmin directory.
1448 </dd>
1451 <dd>
1452 The color (HTML) used for the pointer in the left frame (does not work
1453 with Netscape 4).
1454 <br /><br />
1455 </dd>
1458 <dd>
1459 The size of a table's border.
1460 <br /><br />
1461 </dd>
1464 <dd>
1465 The color (HTML) used for table headers.
1466 <br /><br />
1467 </dd>
1470 <dd>
1471 The color (HTML) #1 for table rows.
1472 <br /><br />
1473 </dd>
1476 <dd>
1477 The color (HTML) #2 for table rows.
1478 <br /><br />
1479 </dd>
1481 <dt>
1484 </dt>
1485 <dd>
1486 The colors (HTML) uses for the pointer and the marker in browse mode
1488 The former feature highlights the row over which your mouse is passing
1489 and the latter lets you visually mark/unmark rows by clicking on
1490 them.<br />
1491 You can disable both of these features by emptying the respective
1492 directive.
1493 <br /><br />
1494 </dd>
1496 <dt>
1501 </dt>
1502 <dd>
1503 Number of columns and rows for the textareas.<br />
1505 SQL textareas inside the query window.<br />
1506 The Char* values are used for CHAR and VARCHAR editing (if configured
1507 via $cfg['CharEditing']).
1508 <br /><br />
1509 </dd>
1511 <dt>
1513 </dt>
1514 <dd>
1515 Defines whether textarea for LONGTEXT fields should have double size.
1516 <br /><br />
1517 </dd>
1519 <dt>
1521 </dt>
1522 <dd>
1523 Defines if the whole textarea of the query box will be selected on
1524 click.
1525 <br /><br />
1526 </dd>
1528 <dt>
1530 </dt>
1531 <dd>
1532 Enable Ctrl+Arrows moving between fields when editing?
1533 <br /><br />
1534 </dd>
1537 <dd>
1538 Maximal number of Chars showed in any non-numeric
1539 field on browse view. Can be turned off by a toggle button on the
1540 browse page.
1541 <br /><br />
1542 </dd>
1544 <dt>
1547 </dt>
1548 <dd>
1549 Defines the place where modify and delete links would be put when
1550 tables contents are displayed (you may have them displayed both at the
1551 left and at the right).
1554 <br /><br />
1555 </dd>
1559 </dt>
1560 <dd>
1561 There are 3 display modes: horizontal, horizontalflipped and vertical. Define
1562 which one is displayed by default. The first mode displays each row on a
1563 horizontal line, the second rotates the headers by 90 degrees, so you can use
1564 descriptive headers even though fields only contain small values and still
1565 print them out. The vertical mode sorts each row on a vertical lineup.<br /><br />
1566 The HeaderFlipType can be set to 'css' or 'faked'. When using 'css' the rotation
1567 of the header for horizontalflipped is done via CSS. If set to 'faked' PGP
1568 does the transformation for you, but of course this does not look as good as CSS.
1569 <br /><br />
1570 </dd>
1573 <dd>
1574 When editing/creating new columns in a table all fields normally get lined up
1575 one field a line. (default: 'horizontal'). If you set this to 'vertical' you
1576 can have each field lined up vertically beneath each other. You can save up
1577 a lot of place on the horizontal direction and no longer have to scroll.
1578 <br /><br />
1579 </dd>
1583 </dt>
1584 <dd>
1585 By setting the corresponding variable to TRUE you can enable the display of
1586 column comments in Browse or Property display. In browse mode, the comments
1587 are show inside the header. In property mode, comments are displayed using
1588 a CSS-formatted dashed-line below the name of the field. The comment is shown
1589 as a tool-tip for that field.
1590 <br /><br />
1591 </dd>
1594 <dd>
1595 The name of the directory, ending with a slash, where SQL files have
1596 been uploaded by other means than phpMyAdmin (for example, ftp).
1597 Those files are available under a drop-down box when you click the
1598 database name, then the SQL tab.
1599 <br /><br />
1601 <br /><br />
1602 This feature is useful when your file is too big to be uploaded via
1603 HTTP, or when file uploads are disabled in PHP.
1604 <br /><br />
1605 Please note that if PHP is running in safe mode, this directory must
1606 be owned by the same user as the owner of the phpMyAdmin scripts.
1607 <br /><br />
1608 </dd>
1611 <dd>
1612 The name of the directory, ending with a slash, where dumps can
1613 be saved.
1614 <br /><br />
1615 Please note that the directory has to be writable for user running
1616 webserver.
1617 <br /><br />
1618 Please note that if PHP is running in safe mode, this directory must
1619 be owned by the same user as the owner of the phpMyAdmin scripts.
1620 <br /><br />
1621 </dd>
1624 <dd>
1625 In this array are defined default parameters for export, names of
1626 items are simmilar to texts seen on export page, so you can easily
1627 identify what they mean.
1628 <br /><br />
1629 </dd>
1632 <dd>
1633 Repeat the headers every X cells, or 0 to deactivate.
1634 <br /><br />
1635 </dd>
1645 </dt>
1646 <dd>
1647 All those variables affect the new query frame/window. When $cfg['QueryFrame']
1648 is set to true a new frame is embedded on the left with a small area. Clicking
1649 on that results in opening a direct interface to enter SQL queries.<br /><br />
1650 When $cfg['QueryFrameJS'] is set to true, clicking on that link opens a new
1651 custom sized browser window ($cfg['QueryWindowWidth'], $cfg['QueryWindowWidth'] -
1652 both integers for the size in pixels). If set to false, clicking on the link
1653 only opens the SQL input in the mainframe.<br /><br />
1654 The usage of the JavaScript query window is recommended if you have a JavaScript
1655 enabled browser. Basic functions are used to exchange quite a few variables, so
1656 most 4th generation browsers should be capable to use that feature. It currently
1658 If $cfg['QueryHistoryDB'] is set to TRUE, all your Queries are logged to a table,
1660 If set to FALSE, all your queries will be appended to the form, but only as long
1661 as your window is opened they remain saved.<br /><br />
1662 When using the JavaScript based query window, it will always get updated when you
1663 click on a new table/db to browse and will focus if you click on "Edit SQL" after
1664 using a query. You can suppress updating the query window by checking the box
1665 "Do not overwrite this query from outside the window" below the query textarea. Then
1666 you can browse tables/databases in the background without losing the contents of the
1667 textarea, so this is especially useful when composing a query with tables you first
1668 have to look in. The checkbox will get automatically checked whenever you change the
1669 contents of the textarea. Please uncheck the button whenever you definitely want the
1670 query window to get updated even though you have made alterations.<br /><br />
1671 If $cfg['QueryHistoryDB'] is set to TRUE you can specify the amount of saved
1672 history items using $cfg['QueryHistoryMax'].<br /><br />
1673 The query window also has a custom tabbed look to group the features. Using the
1674 variable $cfg['QueryWindowDefTab'] you can specify the default tab to be used
1675 when opening the query window. It can be set to either 'sql', 'files', 'history'
1676 or 'full'.<br /><br />
1677 The variable $cfg['QueryFrameDebug'] can be used by developers for easier future
1678 feature integration.
1679 <br /><br />
1680 </dd>
1683 <dd>
1685 <br /><br />
1686 </dd>
1689 <dd>
1690 Determines for how large tables phpMyAdmin should get exact row count by
1694 <br /><br />
1695 </dd>
1699 <dd>
1700 Utilizes a WYSIWYG editing control to easily place elements of a PDF page.
1701 By clicking on the button 'toggle scratchboard' on the page where you
1702 edit x/y coordinates of those elements you can activate a scratchboard where
1703 all your elements are placed. By clicking on an element, you can move them
1704 around in the pre-defined area and the x/y coordinates will get updated
1705 dynamically. Likewise, when entering a new position directly into the
1706 input field, the new position in the scratchboard changes after your
1707 cursors leaves the input field.<br />
1708 You have to click on the 'OK'-button below the tables to save the new positions.
1709 If you want to place a new element, first add it to the table of elements and
1710 then you can drag the new element around.<br />
1711 By changing the paper size and the orientation you can change the size of the
1712 scratchboard as well. You can do so by just changing the dropdown field below,
1713 and the scratchboard will resize automatically, without interfering with the
1714 current placement of the elements.<br />
1715 If ever an element gets out of range you can either enlarge the paper size
1716 or click on the 'reset' button to place all elements below each other.<br />
1718 to work. The basic Drag&Drop script functionality was kindly borrowed from www.youngpup.net and
1719 is underlying so specific license.
1720 <br /><br />
1721 </dd>
1724 <dd>
1725 The main use of the new SQL Parser is to pretty-print SQL queries. By
1726 default we use HTML to format the query, but you can disable this by
1728 <br /><br />
1729 </dd>
1733 <dd>
1734 For the pretty-printing of SQL queries, under some cases the part of a
1735 query inside a bracket is indented. By changing
1738 specifies the units of the indent amount that you specified. This is
1739 used via stylesheets.
1740 <br /><br />
1741 </dd>
1744 <dd>
1745 This array is used to define the colours for each type of element of
1746 the pretty-printed SQL queries. The tuple format is<br />
1748 If you specify an empty string for the color of a class, it is ignored
1749 in creating the stylesheet.
1750 You should not alter the class names, only the colour strings.<br />
1752 <ul>
1776 <li><b>quote_single</b> Single quotes <tt>'</tt></li>
1777 <li><b>quote_backtick</b> Backtick quotes <tt>`</tt></li>
1778 </ul><br />
1779 </dd>
1781 <dt><b>$cfg['SQLValidator']['use']</b> boolean</dt>
1782 <dd>
1783 phpMyAdmin now supports use of the <a href="http://developer.mimer.com/validator/index.htm">Mimer SQL Validator</a> service,
1784 as originally published on
1786 <br />
1787 For help in setting up your system to use the service, see the
1789 <br /><br />
1790 </dd>
1792 <dt><b>$cfg['SQLValidator']['username']</b> string<br />
1793 <b>$cfg['SQLValidator']['password']</b> string</dt>
1794 <dd>
1795 The SOAP service allows you to login with <tt>anonymous</tt>
1796 and any password, so we use those by default.. Instead, if
1797 you have an account with them, you can put your login details
1798 here, and it will be used in place of the anonymous login.
1799 <br /><br />
1800 </dd>
1802 <dt><b>$cfg['DBG']['enable']</b> boolean</dt>
1803 <dd>
1804 <b>DEVELOPERS ONLY!</b><br />
1805 Enable the DBG extension for debugging phpMyAdmin. Required for profiling
1806 the code.
1807 <br />
1808 For help in setting up your system to this, see the
1810 </dd>
1812 <dt><b>$cfg['DBG']['profile']['enable']</b> boolean</dt>
1813 <dd>
1814 <b>DEVELOPERS ONLY!</b><br />
1815 Enable profiling support for phpMyAdmin. This will append a chunk of data
1816 to the end of every page displayed in the main window with profiling
1817 statistics for that page.<br />
1818 You may need need to increase the maximum execution time for this to
1819 complete successfully.
1820 </dd>
1822 <dt><b>$cfg['DBG']['profile']['threshold']</b> float (units in milliseconds)</dt>
1823 <dd>
1824 <b>DEVELOPERS ONLY!</b><br />
1825 When profiling data is displayed, this variable controls the threshold of
1826 display for any profiling data, based on the average time each time has
1827 taken. If it is over the threshold it is displayed, otherwise it is not
1828 displayed. This takes a value in milliseconds. In most cases you don't need
1829 to edit this.
1830 </dd>
1832 <dt><b>$cfg['ColumnTypes'] </b>array</dt>
1833 <dd>
1834 All possible types of a MySQL column. In most cases you don't need to
1835 edit this.
1836 <br /><br />
1837 </dd>
1839 <dt><b>$cfg['AttributeTypes'] </b>array</dt>
1840 <dd>
1841 Possible attributes for fields. In most cases you don't need to edit
1842 this.
1843 <br /><br />
1844 </dd>
1846 <dt><b>$cfg['Functions'] </b>array</dt>
1847 <dd>
1848 A list of functions MySQL supports. In most cases you don't need to
1849 edit this.
1850 <br /><br />
1851 </dd>
1853 </dl>
1855 <!-- TRANSFORMATIONS -->
1857 <h2>Transformations</h2>
1859 <p>
1863 </p>
1866 <h3>[1. Introduction]</h3>
1868 <p>To enable transformations, you have to setup the column_info table and the proper
1870 <br />
1872 <p>You can apply different transformations to the contents of each field. The
1873 transformation will take the content of each field and transform it with
1874 certain rules defined in the selected transformation.</p><br />
1876 <p>Say you have a field 'filename' which contains a filename. Normally you would see
1877 in phpMyAdmin only this filename. Using transformations you can transform that filename
1878 into a HTML link, so you can click inside of the phpMyAdmin structure on the field's
1879 link and will see the file displayed in a new browser window. Using transformation
1880 options you can also specify strings to append/prepend to a string or the format you
1881 want the output stored in.</p><br />
1883 <p>For a general overview of all available transformations and their options, you can
1884 consult your <i><www.your-host.com>/<your-install-dir>/libraries/transformations/overview.php3</i>
1885 installation.</p>
1887 <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>
1890 <h3>[2. Usage]</h3>
1892 <p>Go to your tbl_properties.inc.php3 page (i.e. reached through clicking on the
1893 'properties' link for a table). There click on "Change" (or change
1894 icon) and there you will see three new fields at the end of the line. They are
1895 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>
2459 <h4>
2460 [1.30] I get the error "left.php: Missing hash".
2461 </h4>
2462 <p>
2463 This problem is known to happen when the server is running Turck MMCache
2464 but upgrading MMCache to version 2.3.21 solves the problem.
2465 </p>
2467 <h3>[2. Configuration]</h3>
2469 <h4>
2470 [2.1] The error message "Warning: Cannot add header information -
2471 headers already sent by ..." is displayed, what's the problem?
2472 </h4>
2473 <p>
2474 Edit your <i>config.inc.php or .php3</i> file and ensure there is nothing
2475 (I.E. no blank lines, no spaces, no characters...) neither before the
2476 <tt><?php</tt> tag at the beginning, neither after the <tt>?></tt>
2477 tag at the end.
2478 </p>
2480 <h4>
2481 [2.2] phpMyAdmin can't connect to MySQL. What's wrong?
2482 </h4>
2483 <p>
2484 Either there is an error with your PHP setup or your username/password is
2485 wrong. Try to make a small script which uses mysql_connect and see if it
2486 works. If it doesn't, it may be you haven't even compiled MySQL support
2487 into PHP.
2488 </p>
2490 <h4>
2491 [2.3] The error message "Warning: MySQL Connection Failed: Can't
2492 connect to local MySQL server through socket '/tmp/mysql.sock'
2493 (111)..." is displayed. What can I do?
2494 </h4>
2495 <p><br />
2496 For RedHat users, Harald Legner suggests this on the mailing list:
2497 <br /><br />
2498 On my RedHat-Box the socket of MySQL is <i>/var/lib/mysql/mysql.sock</i>.
2499 In your php.ini you will find a line
2500 <br />
2501 <tt>mysql.default_socket = /tmp/mysql.sock</tt>
2502 <br />
2503 change it to
2504 <br />
2505 <tt>mysql.default_socket = /var/lib/mysql/mysql.sock</tt>
2506 <br />
2507 Then restart apache and it will work.
2508 <br /><br />
2509 Here is a fix suggested by Brad Ummer in the phpwizard forum:
2510 </p>
2511 <ul>
2512 <li>
2513 First, you need to determine what socket is being used by MySQL.
2514 <br />
2515 To do this, telnet to your server and go to the MySQL bin directory. In
2516 this directory there should be a file named <i>mysqladmin</i>. Type
2517 <tt>./mysqladmin variables</tt>, and this should give you a bunch of
2518 info about your MySQL server, including the socket
2519 (<i>/tmp/mysql.sock</i>, for example).
2520 </li>
2521 <li>
2522 Then, you need to tell PHP to use this socket.<br />Assuming you are
2523 using PHP 3.0.10 or better, you can specify the socket to use when you
2524 open the connection. To do this in phpMyAdmin, you need to complete the
2525 socket information in the config.inc.php3.<br />
2526 For example:
2527 <tt>$cfg['Servers'][$i]['socket'] = '/tmp/mysql.sock';</tt><br /><br />
2528 Please also make sure that the permissions of this file allow to be readable
2529 by your webserver (i.e. '0755').
2530 </li>
2531 </ul>
2532 <p>
2533 Have also a look at the
2535 corresponding section of the MySQL documentation</a>.
2536 </p>
2538 <h4>
2539 [2.4] Nothing is displayed by my browser when I try to run phpMyAdmin,
2540 what can I do?
2541 </h4>
2542 <p>
2543 Try to set the <tt>$cfg['OBGZip']</tt> directive to <tt>FALSE</tt> in the
2544 phpMyAdmin configuration file. It helps sometime.<br />
2545 Also have a look at your PHP version number: if it contains
2546 "4.0b..." it means you're running a beta version of PHP. That's
2547 not a so good idea, please upgrade to a plain revision.
2548 </p>
2550 <h4>
2551 [2.5] Each time I want to insert or change a record or drop a database
2552 or a table, an error 404 (page not found) is displayed or, with HTTP or
2553 cookie authentication, I'm asked to login again. What's wrong?
2554 </h4>
2555 <p>
2556 Check the value you set for the <tt>$cfg['PmaAbsoluteUri']</tt> directive
2557 in the phpMyAdmin configuration file.
2558 </p>
2560 <h4>
2561 [2.6] I get an "Access denied for user: 'root@localhost' (Using
2562 password: YES)"-error when trying to access a MySQL-Server on a
2563 host which is port-forwarded for my localhost
2564 </h4>
2565 <p>
2566 When you are using a port on your localhost, which you redirect via
2567 port-forwarding to another host, MySQL is not resolving the localhost
2568 as expected.<br />
2569 Erik Wasser explains: The solution is: if your host is "localhost"
2570 MySQL (the commandline tool 'mysql' as well) always tries to use the socket
2571 connection for speeding up things. And that doesn't work in this configuration
2572 with port forwarding.<br />
2574 TCP connection.
2575 </p>
2579 <h3>[3. Known limitations]</h3>
2581 <h4>
2582 [3.1] When using HTTP authentication, an user who logged out can not
2583 relogin in with the same nick.
2584 </h4>
2585 <p>
2586 This is related to the authentication mechanism (protocol) used by
2587 phpMyAdmin. To bypass this problem: just close all the opened
2588 browser windows and then go back to phpMyAdmin. You should be able to
2589 log in again.
2590 </p>
2592 <h4>
2593 [3.2] When dumping a large table in compressed mode, I get a memory
2594 limit error or a time limit error.
2595 </h4>
2596 <p>
2597 As of version 2.2.4, we build the compressed dump in memory, so large
2598 tables dumps may hang. The only alternative we can think about (using
2599 system calls to mysqldump then gzip or bzip2) would not be applicable in
2600 environments where PHP is in safe mode: access to system programs is
2601 is limited by the system administrator, and time limit is enforced.
2602 </p>
2604 <h4>
2605 [3.3] With InnoDB tables, I lose foreign key relationships when I rename
2606 or alter a table.
2607 </h4>
2608 <p>
2609 This seems to be a InnoDB bug (fixed in MySQL 3.23.50?). However, keep in
2610 mind that phpMyAdmin as of version 2.3.0 does not support InnoDB.
2611 </p>
2613 <h4>
2614 [3.4] I am unable to import dumps I created with the mysqldump tool
2615 bundled with the MySQL server distribution.
2616 </h4>
2617 <p>
2618 The problem is that mysqldump creates invalid comments like this:
2619 </p>
2620 <pre>
2621 -- MySQL dump 8.22
2622 --
2623 -- Host: localhost Database: database
2624 ---------------------------------------------------------
2625 -- Server version 3.23.54
2626 </pre>
2627 <p>
2628 The invalid part of the code is the horizontal line made of dashes that
2629 appears once in every dump created with mysqldump. If you want to run your
2630 dump you have to turn it into valid MySQL. This means, you have to add a
2631 whitespace after the first to dashes of the line or add a # before it:
2632 <br />
2633 <code>
2634 -- -------------------------------------------------------<br />
2635 </code>
2636 or<br />
2637 <code>
2638 #---------------------------------------------------------
2639 </code>
2640 </p>
2642 <h4>
2643 [3.3] When using nested folders ($cfg['LeftFrameTableSeparator']) there
2644 are some multiple hierarchies displayed in a wrong manner?!
2645 </h4>
2646 <p>
2647 Please note that you should not use the seperating string multiple times
2648 without any characters between them, or at the beginning/end of your table
2649 name. If you have to, think about using another TableSeparator or disabling
2650 that feature
2651 </p>
2654 <h3>[4. ISPs, multi-user installations ]</h3>
2656 <h4>
2657 [4.1] I'm an ISP. Can I setup one central copy of phpMyAdmin or do I
2658 need to install it for each customer.
2659 </h4>
2660 <p>
2661 Since version 2.0.3, you can setup a central copy of phpMyAdmin for all
2662 your users. The development of this feature was kindly sponsored by
2663 NetCologne GmbH.
2664 This requires a properly setup MySQL user management and phpMyAdmin
2665 HTTP or cookie authentication. See the install section on
2666 "Using HTTP authentication".
2667 </p>
2669 <h4>
2670 [4.2] What's the preferred way of making phpMyAdmin secure against evil
2671 access.
2672 </h4>
2673 <p>
2674 This depends on your system.<br />
2675 If you're running a server which cannot be accessed by other people, it's
2676 sufficient to use the directory protection bundled with your webserver
2677 (with Apache you can use <i>.htaccess</i> files, for example).<br />
2678 If other people have telnet access to your server, you should use
2679 phpMyAdmin's HTTP authentication feature.
2680 <br /><br />
2681 Suggestions:
2682 </p>
2683 <ul>
2684 <li>
2685 Your <i>config.inc.php3</i> file should be <tt>chmod 660</tt>.
2686 </li>
2687 <li>
2688 All your phpMyAdmin files should be chown phpmy.apache, where phpmy
2689 is a user whose password is only known to you, and apache is the
2690 group under which Apache runs.
2691 </li>
2692 <li>
2693 You should use PHP safe mode, to protect from other users that try
2694 to include your <i>config.inc.php3</i> in their scripts.
2695 </li>
2696 </ul>
2698 <h4>
2699 [4.3] I get errors about not being able to include a file in
2700 <i>/lang</i> or in <i>/libraries</i>.
2701 </h4>
2702 <p>
2703 Check <i>php.ini</i>, or ask your sysadmin to check it. The
2704 <tt>include_path</tt> must contain "." somewhere in it, and
2705 <tt>open_basedir</tt>, if used, must contain "." and
2706 "./lang" to allow normal operation of phpMyAdmin.
2707 </p>
2708 <h4>
2709 [4.4] phpMyAdmin always gives "Access denied" when using HTTP
2710 authentication.
2711 </h4>
2712 <p>
2713 This could happen for several reasons:
2714 </p>
2715 <ul>
2716 <li>
2717 <tt>$cfg['Servers'][$i]['controluser']</tt> and/or
2718 <tt>$cfg['Servers'][$i]['controlpass']</tt> are wrong.
2719 </li>
2720 <li>
2721 The username/password you specify in the login-dialog are invalid.
2722 </li>
2723 <li>
2724 You have already setup a security mechanism for the
2725 phpMyAdmin-directory, eg. a .htaccess file. This would interfere with
2726 phpMyAdmin's authentication, so remove it.
2727 </li>
2728 </ul>
2730 <h4>
2731 [4.5] Is it possible to let users create their own databases?
2732 </h4>
2733 <p>
2734 Starting with 2.2.5, in the user management page, you can enter a wildcard
2735 database name for a user (for example "joe%"),
2736 and put the privileges you want. For example,
2737 adding <tt>SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER</tt>
2738 would let a user create/manage his/her database(s).
2739 </p>
2741 <h4>
2742 [4.6] How can I use the Host-based authentication additions?
2743 </h4>
2744 <p>
2745 If you have existing rules from an old .htaccess file, you can take them
2746 and add a username between the <tt>'deny'</tt>/<tt>'allow'</tt> and
2747 <tt>'from'</tt> strings. Using the username wildcard of <tt>'%'</tt> would
2748 be a major benefit here if your installation is suited to using it. Then
2749 you can just add those updated lines into the
2750 <tt>$cfg['Servers'][$i]['AllowDeny']['rules']</tt> array.
2751 <br /><br />
2752 If you want a pre-made sample, you can try this fragment. It stops the
2753 'root' user from logging in from any networks other than the private
2754 network IP blocks.
2755 <br />
2756 <tt>
2757 //block root from logging in except from the private networks<br />
2758 $cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';<br />
2759 $cfg['Servers'][$i]['AllowDeny']['rules'] = array(<br />
2760 'deny root from all',<br />
2761 'allow root from localhost',<br />
2762 'allow root from 10.0.0.0/8',<br />
2763 'allow root from 192.168.0.0/16',<br />
2764 'allow root from 172.16.0.0/12',<br />
2765 );
2766 </tt>
2767 </p>
2768 <h4>
2769 [4.7] Authentication window is displayed more than once, why?
2770 </h4>
2771 <p>
2772 This happens if you are using a URL to start phpMyAdmin which is
2773 different than the one set in your <tt>$cfg['PmaAbsoluteUri']</tt>.
2774 For example, a missing "www", or entering with an IP address
2775 while a domain name is defined in the config file.
2776 </p>
2779 <h3>[5. Browsers or client OS]</h3>
2781 <h4>
2782 [5.1] I get an out of memory error, and my controls are non-functional,
2783 when trying to create a table with more than 14 fields.
2784 </h4>
2785 <p>
2786 We could reproduce this problem only under Win98/98SE. Testing under
2787 WinNT4 or Win2K, we could easily create more than 60 fields.
2788 <br />
2789 A workaround is to create a smaller number of fields, then come back to
2790 your table properties and add the other fields.
2791 </p>
2793 <h4>
2794 [5.2] With Xitami 2.5b4, phpMyAdmin won't process form fields.
2795 </h4>
2796 <p>
2797 This is not a phpMyAdmin problem but a Xitami known bug: you'll face it
2798 with each script/website that use forms.<br />
2799 Upgrade or downgrade your Xitami server.
2800 </p>
2802 <h4>
2803 [5.3] I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).
2804 </h4>
2805 <p>
2806 With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except that
2807 the proposed file name for the dump is always 'tbl_dump.php'. Bzip2 dumps
2808 don't seem to work.<br />
2810 With Konqueror 2.2.1: plain dumps work; zip dumps are placed into
2811 the user's temporary directory, so they must be moved before closing
2812 Konqueror, or else they disappear. GZip dumps give an error message.<br />
2814 Testing needs to be done for Konqueror 2.2.2.<br />
2815 </p>
2817 <h4>
2818 [5.4] I can't use the cookie authentication mode because Internet
2819 Explorer never stores the cookies.
2820 </h4>
2821 <p>
2822 MS Internet Explorer seems to be really buggy about cookies, at least till
2823 version 6. And thanks to Andrew Zivolup we've traced also a PHP 4.1.1 bug
2824 in this area!
2825 <br />
2826 Then, if you're running PHP 4.1.1, try to upgrade or downgrade... it may
2827 work!
2828 </p>
2830 <h4>
2831 [5.5] In Internet Explorer 5.0, I get JavaScript errors when browsing my
2832 rows.
2833 </h4>
2834 <p>
2835 Upgrade to at least Internet Explorer 5.5 SP2.<br />
2836 </p>
2838 <h4>
2840 when trying to modify a row in a table with many fields, or with a text field
2841 </h4>
2842 <p>
2843 Your table neither have a primary key nor an unique one, so we must use a
2844 long URL to identify this row. There is a limit on the length of the URL in
2845 those browsers, and this not happen in Netscape, for example. The
2846 workaround is to create a primary or unique key, or use another browser.
2847 <br />
2848 </p>
2850 <h4>
2851 [5.7] I refresh (reload) my browser, and come back to the welcome
2852 page.
2853 </h4>
2854 <p>
2855 Some browsers support right-clicking into the frame you want to refresh,
2856 just do this in the right frame.<br />
2857 </p>
2859 <h4>
2860 [5.8] With Mozilla 0.9.7 I have problems sending a query modified in the
2861 query box.
2862 </h4>
2863 <p>
2864 Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
2865 Mozilla versions.<br />
2866 </p>
2868 <h4>
2869 [5.9] With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
2870 whitespace in the SQL-Query edit area: the page scrolls down.
2871 </h4>
2872 <p>
2873 This is a Mozilla bug (see bug #26882 at
2875 </p>
2877 <h4>
2878 [5.10] With Netscape 4.75 I get empty rows between each row of data in a
2879 CSV exported file.
2880 </h4>
2881 <p>
2882 This is a known Netscape 4.75 bug: it adds some line feeds when exporting
2883 data in octet-stream mode. Since we can't detect the specific Netscape
2884 version, we cannot workaround this bug.
2885 </p>
2887 <h4>
2888 [5.11] Extended-ASCII characters like German umlauts are displayed
2889 wrong.
2890 </h4>
2891 <p>
2892 Please ensure that you have set your browser's character set to the one of the
2893 language file you have selected on phpMyAdmin's start page.
2894 Alternatively, you can try the auto detection mode that is supported by the
2895 recent versions of the most browsers.
2896 </p>
2898 <h4>
2899 [5.12] Apple OS X: Safari browser changes special characters to
2900 "?".
2901 </h4>
2902 <p>
2903 This issue has been reported by a OS X user, who adds that Chimera,
2904 Netscape and Mozilla do not have this problem.
2905 </p>
2907 <h4>
2908 [5.13] With Internet Explorer 5.5 or 6, and HTTP authentication type,
2909 I cannot manage two servers: I login to the first one, then the other one,
2910 but if I switch back to the first, I have to login on each operation.
2911 </h4>
2912 <p>
2913 This is a bug in Internet Explorer, other browsers do not behave this way.
2914 </p>
2916 <h4>
2917 [5.14] Using Opera6, I can manage to get to the authentification, but nothing
2918 happens after that, only a blank screen.
2919 </h4>
2920 <p>
2921 Having $cfg['QueryFrameJS'] set to TRUE, this leads to a bug in Opera6, because it
2922 is not able to interpret frameset definitiions written by JavaScript. Please upgrade
2923 to Opera7 at least.
2924 </p>
2927 <h3>[6. Using phpMyAdmin]</h3>
2929 <h4>
2930 [6.1] I can't insert new rows into a table / I can't create a table
2931 - MySQL brings up a SQL-error.
2932 </h4>
2933 <p>
2934 Examine the SQL error with care. Often the problem is caused by
2935 specifying a wrong field-type.<br />
2936 Common errors include:
2937 </p>
2938 <ul>
2939 <li>Using <tt>VARCHAR</tt> without a size argument</li>
2940 <li>Using <tt>TEXT</tt> or <tt>BLOB</tt> with a size argument</li>
2941 </ul>
2942 <p>
2943 Also, look at the syntax chapter in the MySQL manual to confirm that your
2944 syntax is correct.
2945 </p>
2947 <h4>
2948 [6.2] When I create a table, I click the Index checkbox for 2 fields and
2949 phpMyAdmin generates only one index with those 2 fields.
2950 </h4>
2951 <p>
2952 In phpMyAdmin 2.2.0 and 2.2.1, this is the way to create a multi-fields
2953 index. If you want two indexes, create the first one when creating the
2954 table, save, then display the table properties and click the Index link to
2955 create the other index.
2956 </p>
2958 <h4>
2959 [6.3] How can I insert a null value into my table?
2960 </h4>
2961 <p>
2962 Since version 2.2.3, you have a checkbox for each field that can be null.
2963 Before 2.2.3, you had to enter "null", without the quotes, as the
2964 field's value.
2965 </p>
2967 <h4>
2968 [6.4] How can I backup my database or table?
2969 </h4>
2970 <p>
2971 Click on a database or table name in the left frame, the properties will be
2972 displayed. Then on the menu, click "Export", you can dump
2973 the structure, the data, or both. This will generate standard SQL
2974 statements that can be used to recreate your database/table.
2975 <br /><br />
2976 You will need to choose "Save as file", so that phpMyAdmin can
2977 transmit the resulting dump to your station. Depending on your PHP
2978 configuration, you will see options to compress the dump. See also the
2979 <tt>$cfg['ExecTimeLimit']</tt> configuration variable.
2980 <br /><br />
2981 For additional help on this subject, look for the word "dump" in
2982 this document.
2983 </p>
2985 <h4>
2986 [6.5] How can I restore (upload) my database or table using a dump?
2987 How can I run a ".sql" file.
2988 </h4>
2989 <p>
2990 Click on a database name in the left frame, the properties will be
2991 local displayed. Then in the "Run SQL query" section, type in
2992 your dump filename, or use the Browse button. Then click Go.
2993 <br /><br />
2994 For additional help on this subject, look for the word "upload"
2995 in this document.
2996 </p>
2998 <h4>
2999 [6.6] How can I use the relation table in Query-by-example?
3000 </h4>
3001 <p>
3002 Here is an example with the tables persons, towns and countries, all
3003 located in the database mydb. If you don't have a <tt>PMA_relation</tt>
3004 table, create it as explained in the configuration section. Then create the
3005 example tables:
3006 <br /><br />
3007 <tt>
3008 CREATE TABLE REL_countries (<br />
3009 country_code char(1) NOT NULL default '',<br />
3010 description varchar(10) NOT NULL default '',<br />
3011 PRIMARY KEY (country_code)<br />
3012 ) TYPE=MyISAM;<br />
3013 <br />
3014 INSERT INTO REL_countries VALUES ('C', 'Canada');<br />
3015 <br />
3016 CREATE TABLE REL_persons (<br />
3017 id tinyint(4) NOT NULL auto_increment,<br />
3018 person_name varchar(32) NOT NULL default '',<br />
3019 town_code varchar(5) default '0',<br />
3020 country_code char(1) NOT NULL default '',<br />
3021 PRIMARY KEY (id)<br />
3022 ) TYPE=MyISAM;<br />
3023 <br />
3024 INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');<br />
3025 INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');<br />
3026 <br />
3027 CREATE TABLE REL_towns (<br />
3028 town_code varchar(5) NOT NULL default '0',<br />
3029 description varchar(30) NOT NULL default '',<br />
3030 PRIMARY KEY (town_code)<br />
3031 ) TYPE=MyISAM;<br />
3032 <br />
3033 INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');<br />
3034 INSERT INTO REL_towns VALUES ('M', 'Montréal');<br />
3035 <br />
3036 </tt>
3037 To setup appropriate links and display information:
3038 </p>
3039 <ul>
3040 <li>on table "REL_persons" click Structure, then Relation view</li>
3041 <li>in Links, for "town_code" choose "REL_towns->code"</li>
3042 <li>in Links, for "country_code" choose "REL_countries->country_code"</li>
3043 <li>on table "REL_towns" click Structure, then Relation view</li>
3044 <li>in "Choose field to display", choose "description"</li>
3045 <li>repeat the two previous steps for table "REL_countries"</li>
3046 </ul>
3048 <p>
3049 Then test like this:
3050 </p>
3051 <ul>
3052 <li>Click on your db name in the left frame</li>
3053 <li>Choose "Query"</li>
3054 <li>Use tables: persons, towns, countries</li>
3055 <li>Click "Update query"</li>
3056 <li>In the fields row, choose persons.person_name and click the
3057 "Show" tickbox </li>
3058 <li>Do the same for towns.description and countries.descriptions in the
3059 other 2 columns</li>
3060 <li>Click "Update query" and you will see in the query box that
3061 the correct joins have been generated</li>
3062 <li>Click "Submit query"</li>
3063 </ul>
3064 <br />
3067 <h4>
3068 [6.7] How can I use the "display field" feature?
3069 </h4>
3070 <p>
3071 Starting from the previous example, create the PMA_table_info as explained
3072 in the configuration section, then browse your persons table,
3073 and move the mouse over a town code or country code.
3074 <br /><br />
3075 See also FAQ 6.21 for an additionnal feature that "display field"
3076 enables: drop-down list of possible values.
3077 </p>
3080 <h4>
3081 [6.8] How can I produce a PDF schema of my database?
3082 </h4>
3083 <p>
3084 First you have to fill the "relation", "table_coords"
3085 and "pdf_pages" configuration variables.
3086 <br /><br />
3087 Then, think about your schema layout: which tables will go on which pages.
3088 </p>
3089 <ul>
3090 <li>Click on your db name in the left frame</li>
3091 <li>Choose "Structure" in the navigation on top</li>
3092 <li>Choose "Edit PDF Pages" which should be somewhere at the
3093 bottom of the page</li>
3094 <li>Enter the name for a first pdf page and submit (you can also use
3095 the "Automatic layout", which will place on your page
3096 all the tables that are linked)</li>
3097 <li>Choose this page to edit</li>
3098 <li>Now add a table you want to show on this page and its coordinates and
3099 submit<br />
3100 First you will have to guess those coordinates of course, so just expect
3101 to have an area of about 297 * 210 and put the tables coordinates
3102 somewhere in there, you will be able to have a look at what happened
3103 and change them later.<br />
3104 For example, x=100 and y=200 means that the table will be at 200 mm
3105 down and 100 mm right from the upper left corner.<br />
3106 Actually if you have a width of more than 300 or a height of more than
3107 200 then it will automatically be scaled but 200*100 is a good start to
3108 have an idea of what coordinates to use.</li>
3109 <li>There is also a visual editor (scratchboard) available, see the
3111 <li>After every table you submitted you will have the possibility to submit
3112 more tables</li>
3113 <li>When you have entered enough tables Click on your db name in the left
3114 frame again</li>
3115 <li>Now, again at the bottom of the page you should be able to choose
3116 "Display PDF schema"<br />
3117 For testing it might be useful to show the grid as well, so you can see
3118 the coordinates used.<br />
3119 Maybe also choose color and submit.</li>
3120 <li>Save the file he will offer you to something like <i>Schema.pdf</i>
3121 (Internet Explorer has some bug there which might make it offer it
3122 without an extension. Under Windows it is important to have the
3123 extension ".pdf", under other OSes you should be fine just
3124 saving the file under the name it offers).</li>
3125 </ul>
3127 <h4>
3128 [6.9] phpMyAdmin is changing the type of one of my columns!
3129 </h4>
3130 <p>
3131 No, it's MySQL that is doing
3132 <a href="http://www.mysql.com/doc/S/i/Silent_column_changes.html">silent column type changing</a>.
3133 </p>
3136 <h4>
3137 [6.10] When creating a privilege, what happens with underscores in
3138 the database name?
3139 </h4>
3140 <p>
3141 If you do not put a backslash before the underscore, this is a wildcard
3142 grant, and the underscore means "any character". So, if the
3143 database name is "john_db", the user would get rights to john1db,
3144 john2db...<br /><br />
3145 If you put a backslash before the underscore, it means that the database
3146 name will have a real underscore.
3147 </p>
3149 <h4>
3150 [6.11] What is the curious symbol ø in the statistics pages?
3151 </h4>
3152 <p>
3153 It means "average".
3154 </p>
3157 <h4>
3158 [6.12] I want to understand some Export options.
3159 </h4>
3160 <p>
3161 "Complete inserts" adds the column names on every INSERT command,
3162 for better documentation (but resulting file is bigger).<br />
3163 "Extended inserts" provides a shorter dump file by using only
3164 once the INSERT verb and the table name.<br />
3165 "Enclose table and field names with backquotes" ensures that
3166 field and table names formed with special characters are protected.<br />
3167 "Add AUTO_INCREMENT value" ensures, that AUTO_INCREMENT value
3168 (if any) will be included in backup.<br />
3169 "Add into comments" includes column comments, relations and MIME
3170 types set in the PMA-DB in the dump as SQL comments (<i>/* xxx */</i>).<br />
3171 </p>
3173 <h4>
3174 [6.13] I would like to create a database with a dot in its name.
3175 </h4>
3176 <p>
3177 This is a bad idea, because in MySQL the syntax "database.table"
3178 is the normal way to reference a database and table name. Worse, MySQL
3179 will usually let you create a database with a dot, but then you cannot
3180 work with it, nor delete it.<br />
3181 </p>
3184 <h4>
3185 [6.14] How do I set up the SQL Validator?
3186 </h4>
3187 <p>
3188 To use it, you need a very recent version of PHP, 4.3.0 recommended, with
3189 XML, PCRE and PEAR support. On your system command line, run
3190 <tt>"pear install Net_Socket Net_URL HTTP_Request Mail_Mime Net_DIME
3191 SOAP"</tt> to get the necessary PEAR modules for usage.
3192 <br />
3193 If you use it, you should be aware that any SQL statement you
3194 submit will be stored anonymously (database/table/column names,
3195 strings, numbers replaced with generic values). The Mimer SQL
3196 Validator itself, is © 2001 Upright Database Technology.
3197 We utilize it as free SOAP service.
3198 </p>
3200 <h4>
3201 [6.15] I want to add a BLOB field and put an index on it, but MySQL
3202 says "BLOB column '...' used in key specification without a key
3203 length".
3204 </h4>
3205 <p>
3206 The right way to do this, is to create the field without any indexes,
3207 then display the table structure and use the "Create an index"
3208 dialog. On this page, you will be able to choose your BLOB field, and
3209 set a size to the index, which is the condition to create an index on
3210 a BLOB field.
3211 <br />
3212 </p>
3214 <h4>
3215 [6.16] How can I simply move in page with plenty editing fields?
3216 </h4>
3217 <p>
3218 You can use Ctrl+arrows for moving on most pages with plenty editing
3219 fields (table structure changes, row editing, etc.) (must be anabled in
3220 configuration - see. $cfg['CtrlArrowsMoving']). You can also have a look
3221 at the directive $cfg['DefaultPropDisplay'] ('vertical') and see if this
3222 eases up editing for you.
3223 <br />
3224 </p>
3226 <h4>
3227 [6.17] Transformations: I can't enter my own mimetype! WTF is this feature
3228 then useful for?
3229 </h4>
3230 <p>
3231 Slow down :). Defining mimetypes is of no use, if you can't put transformations on them.
3232 Otherwise you could just put a comment on the field. Because entering your own mimetype will
3233 cause serious syntax checking issues and validation, this introduces a high-risk false-user-input
3234 situation. Instead you have to initialize mimetypes using functions or empty mimetype definitions.
3235 <br />
3236 Plus, you have a whole overview of available mimetypes. Who knows all those mimetypes by heart so
3237 he/she can enter it at will?
3238 <br />
3239 </p>
3242 <h4>
3243 [6.18] Bookmarks: Where can I store bookmarks? Why can't I see any bookmarks below the query box?
3244 What is this variable for?
3245 </h4>
3246 <p>
3247 Any query you have executed can be stored as a bookmark on the page where the results are displayed.
3248 You will find a button labeled 'Bookmark this query' just at the end of the page.<br />
3249 As soon as you have stored a bookmark, it is related to the database you run the query on. You can
3250 now access a bookmark dropdown on each page, the query box appears on for that database.<br />
3251 <br />
3252 Since phpMyAdmin 2.5.0 you are also able to store variables for the bookmarks. Just use the string
3253 <b>/*[VARIABLE]*/</b> anywhere in your query. Everything which is put into the <i>value</i> input
3254 box on the query box page will replace the string "/*[VARIABLE]*/" in your stored query.
3255 Just be aware of that you HAVE to create a valid query, otherwise your query won't be even able to be
3256 stored in the database.<br />
3257 Also remember, that everything else inside the <b>/*[VARIABLE]*/</b> string for your query will remain
3258 the way it is, but will be stripped of the /**/ chars. So you can use:<br /><br />
3259 <code>/*, [VARIABLE] AS myname */</code><br /><br />
3260 which will be expanded to<br /><br />
3261 <code>, VARIABLE as myname</code><br /><br />
3262 in your query, where VARIABLE is the string you entered in the input box. If an empty string is
3263 provided, no replacements are made.<br />
3264 <br />
3265 A more complex example. Say you have stored this query:<br /><br />
3266 <code>SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE '%[VARIABLE]%' */</code><br /><br />
3267 Say, you now enter "phpMyAdmin" as the variable for the stored query, the full query will
3268 be:<br /><br />
3269 <code>SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE '%phpMyAdmin%'</code>
3270 <br />
3271 <br />
3272 You can use multiple occurences of <b>/*[VARIABLE]*/</b> in a single query.<br />
3273 <b>NOTE THE ABSENCE OF SPACES</b> inside the "/**/" construct. Any spaces inserted there
3274 will be later also inserted as spaces in your query and may lead to unexpected results especially when
3275 using the variable expansion inside of a "LIKE ''" expression.<br />
3276 Your initial query which is going to be stored as a bookmark has to yield at least one result row so
3277 you can store the bookmark. You may have that to work around using well positioned "/**/"
3278 comments.
3279 </p>
3281 <h4>
3282 [6.19] How can I create simple LaTeX document to include exported table?
3283 </h4>
3284 <p>
3285 You can simply include table in your LaTeX documents, minimal sample
3286 document should look like following one (assuming you have table
3287 exported in file <code>table.tex</code>):
3288 <br />
3289 <br />
3290 <pre>
3291 <font color="#a52a2a"><b>\documentclass</b></font><font color="#6a5acd">{</font><font color="#a020f0">article</font><font color="#6a5acd">}</font>
3292 <font color="#a52a2a"><b>\usepackage</b></font><font color="#6a5acd">{</font><font color="#6a5acd">longtable</font><font color="#6a5acd">}</font>
3294 <font color="#a52a2a"><b>\begin</b></font><font color="#6a5acd">{</font><font color="#a020f0">document</font><font color="#6a5acd">}</font>
3296 <font color="#a52a2a"><b>\include</b></font><font color="#6a5acd">{</font><font color="#6a5acd">table</font><font color="#6a5acd">}</font>
3298 <font color="#a52a2a"><b>\end</b></font><font color="#6a5acd">{</font><font color="#a020f0">document</font><font color="#6a5acd">}</font>
3299 </pre>
3300 </p>
3302 <h4>
3303 [6.20] In MySQL 4, I see a lot of databases which are not mine, and cannot
3304 access them.
3305 </h4>
3306 <p>
3307 Upgrading to MySQL 4 usually gives users a global privilege: CREATE
3308 TEMPORARY TABLES. This privilege also enables users to see all the
3310 So if your users do not need this privilege, you can remove it and their
3311 databases list will shorten.
3312 </p>
3313 <h4>
3314 [6.21] In edit/insert mode, how can I see a list of possible values for
3315 a field, based on some foreign table?
3316 </h4>
3317 <p>
3318 You have to setup appropriate links between the tables, and also
3319 setup the "display field" in the foreign table. See FAQ
3320 6.6 for an example. Then, if there are 200 values or less in the
3321 foreign table, a drop-down list of values will be available.
3322 </p>
3324 <h3>[7. phpMyAdmin project]</h3>
3326 <h4>
3327 [7.1] I have found a bug. How do I inform developers?
3328 </h4>
3329 <p>
3330 Our Bug Tracker is located at
3331 <a href="http://sourceforge.net/projects/phpmyadmin/">http://sourceforge.net/projects/phpmyadmin/</a>
3332 under the Bugs section.
3333 <br /><br />
3334 But please first discuss your bug with other users:
3335 <br />
3337 http://sourceforge.net/projects/phpmyadmin/</a> (and choose Forums)
3338 </p>
3340 <h4>
3341 [7.2] I want to translate the messages to a new language or upgrade an
3342 existing language, where do I start?
3343 </h4>
3344 <p>
3345 Always use the current CVS version of your language file.
3346 For a new language, start from <i>english-iso-8859-1.inc.php3</i>. If you
3347 don't know how to get the CVS version, please ask one of the developers.
3348 <br />
3349 Please note that we try not to use HTML entities like &eacute; in
3350 the translations, since we define the right character set in the file.
3351 With HTML entities, the text on JavaScript messages would not
3352 display correctly.
3353 However there are some entities that need to be there, for quotes
3354 ,non-breakable spaces, ampersands, less than, greater than.
3355 <br />
3356 You can then put your translations, as a zip file to avoid losing special
3357 characters, on the sourceforge.net translation tracker.
3358 <br />
3359 It would be a good idea to subscribe to the phpmyadmin-translators mailing
3360 list, because this is where we ask for translations of new messages.
3361 <br />
3362 </p>
3364 <h4>
3365 [7.3] I would like to help out with the development of phpMyAdmin. How
3366 should I proceed?
3367 </h4>
3368 <p>
3369 The following method is preferred for new developers:
3370 </p>
3371 <ol>
3372 <li>
3373 fetch the current CVS tree over anonymous CVS:<br />
3374 <tt>cvs -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin login</tt><br />
3375 [Password: simply press the Enter key]<br />
3376 <tt>cvs -z3 -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin checkout phpMyAdmin</tt><br />
3377 [This will create a new sub-directory named phpMyAdmin]
3378 </li>
3379 <li>
3380 add your stuff
3381 </li>
3382 <li>
3383 put the modified files (tar'ed and gzip'ed) inside the patch tracker of
3384 the
3385 <a href="http://sourceforge.net/projects/phpmyadmin/" target="_blank">phpMyAdmin SourceForge account</a>.
3386 </li>
3387 </ol>
3388 <p>
3389 Write access to the CVS tree is granted only to experienced developers who
3390 have already contributed something useful to phpMyAdmin.<br />
3391 Also, have a look at the
3393 </p>
3395 <h3>[8. Security ]</h3>
3397 <h4>
3398 [8.1] Security alert, dated 2003-06-18.
3399 </h4>
3400 <p>
3401 Last update of this FAQ: 2003-07-22.
3402 <br /><br />
3403 The phpMyAdmin development team received notice of this security alert:
3404 <a href="http://www.securityfocus.com/archive/1/325641" target="_blank">http://www.securityfocus.com/archive/1/325641.</a>
3405 <br /><br />
3407 The team regrets that the author did not communicate with us before
3408 sending this alert. However, here is our current reply to the points mentionned:
3409 <br /><br />
3410 <ul>
3411 <li>"Directory transversal attack"
3412 <br /><br />
3414 This problem had been fixed in version 2.5.0, even if the author reports
3415 the 2.5.2 development version as vulnerable, which we could not reproduce.
3416 <br /><br />
3417 </li>
3418 <li>"Remote local file retrieving"
3419 <br /><br />
3420 This is a misleading title, as the author tells in his text:
3421 "Note that you can't request files ( only dirs )".
3422 <br /><br />
3423 </li>
3425 <li>"Remote internal directory listing"
3426 <br /><br />
3427 It was possible to retrieve the list of phpMyAdmin's directory (which we
3428 doubt can cause any damage), but we fixed this in the
3429 2.5.2 version.
3430 <br /><br />
3431 </li>
3433 <li>"XSS and Path disclosures"
3434 <br /><br />
3435 Most of the XSS problems have been fixed in version 2.5.0. The rest
3436 have been fixed in the 2.5.2 version.
3437 <br /><br />
3438 We believe that the Path disclosures problems have also been fixed
3439 in version 2.5.2.
3440 <br /><br />
3441 </li>
3442 <li>"Information encoding weakness"
3443 <br /><br />
3444 We believe that an exploit for this weakness would be difficult
3445 to achieve. However version 2.5.2 now encrypts the password
3446 with the well-known blowfish algorithm.
3447 <br /><br />
3448 </li>
3449 </ul>
3451 </p>
3453 <!-- DEVELOPERS -->
3455 <h2>Developers Information</h2>
3457 <p>
3458 phpMyAdmin is Open Source, so you're invited to contribute to it. Many
3459 great features have been written by other people and you too can help to
3460 make phpMyAdmin a useful tool.
3461 </p>
3463 <p>
3464 If you're planning to contribute source, please read the following
3465 information:
3466 </p>
3467 <ul>
3468 <li>
3469 All files include <i>header.inc.php3</i> (layout),
3470 <i>libraries/common.lib.php3</i> (common functions) and
3471 <i>config.inc.php3</i>.
3472 <br />
3473 All configuration data belongs in <i>config.inc.php3</i>. Please keep
3474 it free from other code.
3475 <br />
3476 Commonly used functions should be added to
3477 <i>libraries/common.lib.php3</i> and more specific ones may be added
3478 within a library stored into the <i>libraries</i> sub-directory.
3479 </li>
3480 <li>
3481 Obviously, you're free to use whatever coding style you want. But
3482 please try to keep your code as simple as possible: beginners are
3483 using phpMyAdmin as an example application.<br />
3484 As far as possible, we want the scripts to be XHTML1.0 and CSS2
3485 compliant on one hand, they fit the
3487 on the other hand. Please pay attention to this.
3488 </li>
3489 <li>
3490 Please try to keep up the file-naming conventions. Table-related stuff
3491 goes to <i>tbl_*.php3</i>, db-related code to <i>db_*.php3</i>,
3492 server-related tools to <i>server_*.php3</i> and so on.
3493 </li>
3494 <li>
3495 Please don't use verbose strings in your code, instead add the string
3496 (at least) to <i>english-iso-8859-1.inc.php3</i> and print() it out.
3497 </li>
3498 <li>
3499 If you want to be really helpful, write an entry for the ChangeLog.
3500 </li>
3503 Debugger DBG</a>) is now supported by phpMyAdmin for developers to
3504 better debug and profile their code.<br />
3505 Please see the <tt>$cfg['DBG']*</tt> configuration options for more
3506 information.<br />
3507 This is in memoriam of the Space Shuttle Columbia (STS-107) which was
3508 lost during its re-entry into Earth's atmosphere and in memory of the
3509 brave men and women who gave their lives for the people of Earth.
3510 </li>
3512 </ul>
3514 <!-- CREDITS -->
3516 <h2>Credits</h2>
3518 <pre>
3520 phpMyAdmin - Credits
3521 ====================
3523 CREDITS, in chronological order
3524 -------------------------------
3526 - Tobias Ratschiller <tobias.ratschiller_at_maguma.com>
3527 * creator of the phpmyadmin project
3528 * maintainer from 1998 to summer 2000
3530 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca>
3531 * multi-language version
3532 * various fixes and improvements
3533 * project co-administrator
3535 - Olivier Müller <om_at_omnis.ch>
3536 * started SourceForge phpMyAdmin project in March 2001
3537 * sync'ed different existing CVS trees with new features and bugfixes
3538 * multi-language improvements, dynamic language selection
3539 * current project maintainer
3540 * many bugfixes and improvements
3542 - Loïc Chapeaux <lolo_at_phpheaven.net>
3543 * rewrote and optimized javascript, DHTML and DOM stuff
3544 * rewrote the scripts so they fit the PEAR coding standards and
3545 generate XHTML1.0 and CSS2 compliant codes
3546 * improved the language detection system
3547 * many bugfixes and improvements
3549 - Robin Johnson <robbat2_at_users.sourceforge.net>
3550 * database maintence controls
3551 * table type code
3552 * Host authentication IP Allow/Deny
3553 * DB-based configuration (Not completed)
3554 * SQL parser
3555 * SQL validator
3556 * many bugfixes and improvements
3558 - Armel Fauveau <armel.fauveau_at_globalis-ms.com>
3559 * bookmarks feature
3560 * multiple dump feature
3561 * gzip dump feature
3562 * zip dump feature
3564 - Geert Lund <glund_at_silversoft.dk>
3565 * various fixes
3566 * moderator of the phpMyAdmin users forum at phpwizard.net
3568 - Korakot Chaovavanich <korakot_at_iname.com>
3569 * "insert as new row" feature
3571 - Pete Kelly <webmaster_at_trafficg.com>
3572 * rewrote and fix dump code
3573 * bugfixes
3575 - Steve Alberty <alberty_at_neptunlabs.de>
3576 * rewrote dump code for PHP4
3577 * mySQL table statistics
3578 * bugfixes
3580 - Benjamin Gandon <gandon_at_isia.cma.fr>
3581 * main author of the version 2.1.0.1
3582 * bugfixes
3584 - Alexander M. Turek <derrabus_at_gmx.de>
3585 * XML exports
3586 * MySQL 4 related features
3587 * various features and fixes
3588 * German language file updates
3590 - Mike Beck <mike.beck_at_ibmiller.de>
3591 * automatic joins in QBE
3592 * links column in printview
3593 * Relation view
3595 - Michal Cihar <nijel_at_users.sourceforge.net>
3596 * enhanced index creation/display feature
3597 * feature to use a different charset for HTML than for MySQL
3598 * Czech language file updates
3600 - Christophe Gesché from the "MySQL Form Generator for PHPMyAdmin"
3601 (http://sourceforge.net/projects/phpmysqlformgen/)
3602 * suggested the patch for multiple table printviews
3604 - Garvin Hicking <me_at_supergarv.de>
3605 * built the patch for vertical display of table rows
3606 * built the Javascript based Query window + SQL history
3607 * Improvement of column/db comments
3608 * (MIME)-Transformations for columns
3609 * Use custom alias names for Databases in left frame
3610 * hierarchical/nested table display
3611 * PDF-scratchboard for WYSIWYG-distribution of PDF relations
3612 * new icon sets
3613 * vertical display of column properties page
3614 * some bugfixes, features, support, german language additions
3616 - Yukihiro Kawada <kawada_at_den.fujifilm.co.jp>
3617 * japanese kanji encoding conversion feature
3619 - Piotr Roszatycki <d3xter_at_users.sourceforge.net> and Dan Wilson
3620 * the Cookie authentication mode
3622 - Axel Sander <n8falke_at_users.sourceforge.net>
3623 * table relation-links feature
3625 - Maxime Delorme <delorme.maxime_at_free.fr>
3626 * PDF schema output, thanks also to Olivier Plathey for the
3627 "FPDF" library (see http://www.fpdf.org/).
3629 - Olof Edlund <olof.edlund_at_upright.se>
3630 * SQL validator server
3632 - Ivan R. Lanin <ivanlanin_at_users.sourceforge.net>
3633 * phpMyAdmin logo
3635 - Mike Cochrane <mike_at_graftonhall.co.nz>
3636 * blowfish library from the Horde project
3638 And also to the following people who have contributed minor changes,
3639 enhancements, bugfixes or support for a new language since version 2.1.0:
3641 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
3642 Péter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
3643 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kläger,
3644 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
3645 Bernard M. Piller, Laurent Haas, "Sakamoto", Yuval Sarna,
3646 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
3647 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
3648 Luís V., Martijn W. van der Lee,
3649 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
3650 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, "Manuzhai".
3653 Original Credits of Version 2.1.0
3654 ---------------------------------
3656 This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
3657 to create a web-based interface to MySQL using PHP3. Although I have not
3658 used any of his source-code, there are some concepts I've borrowed from
3659 him. phpMyAdmin was created because Peter told me he wasn't going to
3660 further develop his (great) tool.
3661 Thanks go to
3662 - Amalesh Kempf <ak-lsml_at_living-source.com> who contributed the
3663 code for the check when dropping a table or database. He also suggested
3664 that you should be able to specify the primary key on tbl_create.php3. To
3665 version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
3666 well as a bug-report. Plus many smaller improvements.
3667 - Jan Legenhausen <jan_at_nrw.net>: He made many of the changes that
3668 were introduced in 1.3.0 (including quite significant ones like the
3669 authentication). For 1.4.1 he enhanced the table-dump feature. Plus
3670 bug-fixes and help.
3671 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca> made phpMyAdmin
3672 language-independent by outsourcing the strings to a separate file. He
3673 also contributed the French translation.
3674 - Alexandr Bravo <abravo_at_hq.admiral.ru> who contributed
3675 tbl_select.php3, a feature to display only some fields from a table.
3676 - Chris Jackson <chrisj_at_ctel.net> added support for MySQL
3677 functions in tbl_change.php3. He also added the
3678 "Query by Example" feature in 2.0.
3679 - Dave Walton <walton_at_nordicdms.com> added support for multiple
3680 servers and is a regular contributor for bug-fixes.
3681 - Gabriel Ash <ga244_at_is8.nyu.edu> contributed the random access
3682 features for 2.0.6.
3683 The following people have contributed minor changes, enhancements, bugfixes
3684 or support for a new language:
3685 Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
3686 Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
3687 Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
3688 G. Wieggers.
3690 And thanks to everyone else who sent me email with suggestions, bug-reports
3691 and or just some feedback.
3692 </pre>
3699 <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" border="0" height="31" width="88" /></a>
3700
3702 <img src="http://www.w3.org/Icons/valid-css" alt="Valid CSS!" border="0" width="88" height="31" /></a>
3703 </p>
3705 </body>
3706 </html>