1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns=
"http://www.w3.org/1999/xhtml" xml:
lang=
"en-US" lang=
"en-US">
6 vim: expandtab ts=4 sw=4 sts=4 tw=78
10 <meta http-equiv=
"Content-Type" content=
"text/html; charset=iso-8859-1" />
11 <title>phpMyAdmin
2.5.0-rc2 - Documentation
</title>
12 <link rel=
"stylesheet" type=
"text/css" href=
"docs.css" />
16 <a name=
"top"></a><br />
19 <hr noshade=
"noshade" width=
"100%" />
20 <a href=
"#top">Top
</a> -
21 <a href=
"#require">Requirements
</a> -
22 <a href=
"#intro">Introduction
</a> -
23 <a href=
"#setup">Installation
</a> -
24 <a href=
"#config">Configuration
</a>
26 <a href=
"#transformations">Transformations
</a> -
27 <a href=
"#faq">FAQ
</a> -
28 <a href=
"#developers">Developers
</a> -
29 <a href=
"#credits">Credits
</a> -
30 <a href=
"translators.html">Translators
</a>
31 <hr noshade=
"noshade" width=
"100%" />
34 <h1>phpMyAdmin
2.5.0-rc2 Documentation
</h1>
40 <a href=
"http://www.phpmyadmin.net/">
41 SourceForge phpMyAdmin project page
[ http://www.phpmyadmin.net/ ]
47 <li>Version history:
<a href=
"ChangeLog">ChangeLog
</a></li>
48 <li>General notes:
<a href=
"README">README
</a></li>
49 <li>License:
<a href=
"LICENSE">LICENSE
</a></li>
53 Documentation version:
60 <a name=
"require"></a><br />
65 PHP3 or PHP4: phpMyAdmin widely uses the 'str_replace()' PHP function
66 that was added in PHP
3.0.6, but was buggy up until
68 Then
<span class=
"important">you should not run this script with
69 PHP3
< 3.0.8</span>.
<br />
70 PHP also needs to be
<span class=
"important">compiled with MySQL
72 If you want to display inline thumbnails of JPEGs, you also need
76 MySQL (tested with
3.21.x,
3.22.x,
3.23.x and
4.0.x);
<br />
77 <span class=
"important">Note: Because of a major change in the definition
78 syntax of string field types, this version of phpMyAdmin probably won't
79 work correctly with MySQL
>=
4.1.0!
</span>
88 <a name=
"intro"></a><br />
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:
100 <li>create and drop databases
</li>
101 <li>create, copy, drop, rename and alter tables
</li>
102 <li>do table maintenance
</li>
103 <li>delete, edit and add fields
</li>
104 <li>execute any SQL-statement, even batch-queries
</li>
105 <li>manage keys on fields
</li>
106 <li>load text files into tables
</li>
107 <li>create (*) and read dumps of tables
</li>
108 <li>export (*) data to CSV, XML and Latex formats
</li>
109 <li>administer multiple servers
</li>
110 <li>manage MySQL users and privileges
</li>
111 <li>check referential integrity
</li>
112 <li>using Query-by-example (QBE), create complex queries automatically connecting required tables
</li>
113 <li>create PDF graphics of your Database layout
</li>
114 <li>search globally in a database or a subset of it
</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>
119 <a href=
"./translators.html">42 different languages
</a>
125 phpMyAdmin can compress (Zip, GZip -RFC
1952- or Bzip2 formats) dumps
126 and CSV exports if you use PHP4
>=
4.0.4 with Zlib support
127 (
<tt>--with-zlib
</tt>) and/or Bzip2 support (
<tt>--with-bz2
</tt>).
131 <!-- INSTALLATION -->
132 <a name=
"setup"></a><br />
133 <h2>Installation
</h2>
136 <span class=
"important">NOTE: phpMyAdmin does not apply any special security
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
139 "Privileges
" page can be used for this.
143 <span class=
"important">Warning for Mac users:
</span>if you are on a MacOS
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
147 end of lines character (
"<tt>\r
</tt>").
151 <span class=
"important">Documentation warning:
</span> when you see in this
152 document a
<i>.php3
</i> file extension, please transpose to
<i>.php
</i>
153 if you are using a kit with files having this extension.
156 <p><b>Quick Install:
</b></p>
158 <li> Choose and download a distribution kit with the files having the
159 extension (
<i>.php3
</i> or
<i>.php
</i>) depending on the way your
160 web/PHP server interprets those extensions.
</li>
161 <li> Untar or unzip the distribution (be sure to unzip the subdirectories):
162 <tt>tar -xzvf phpMyAdmin_x.x.x.tar.gz
</tt> in your webserver's
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
168 your environment. Here,
"host
" means the MySQL server.
169 Also insert the correct value for
<tt>$cfg['PmaAbsoluteUri']
</tt>.
171 <a href=
"#config">Configuration section
</a> for an
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
176 <i>.htaccess
</i> file). See the
177 <a href=
"#faq">FAQ section
</a> for additional
180 <i><www.your-host.com
>/
<your-install-dir
>/index.php3
</i>
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, PDP-generation)
185 you need to create a set of tables in your database. Please look at your scripts/
186 directory, where you should find a file called
<i>create_tables.sql
</i>.
187 You can already use your phpMyAdmin to create the tables for you. Please be
188 aware that you may have to have special (administrator) privileges to create
189 the database and tables. After having imported the
<i>create_tables.sql
</i> file,
190 you should specify the table names in your config.inc.php3 file. The directives
191 used for that can be found in the
<a href=
"#config">Configuration section
</a>.
</li>
195 <p><b>Upgrading from an older version:
</b></p>
197 <li>Please do not copy your older config.inc.php3 over the new one: it may
198 offer new configuration variables, and the new version may depend on
199 these for normal behavior. It is suggested instead to insert your site
200 values in the new one.
</li>
203 <p><b>Using authentication modes:
</b></p>
205 <li>HTTP and cookie authentication modes are recommended in a
<b>multi-user
206 environment
</b> where you want to give users access to their own
207 database and don't want them to play around with others.
209 Nevertheless be aware that MS Internet Explorer seems to be really
210 buggy about cookies, at least till version
6. And PHP
4.1.1 is also a
211 bit buggy in this area!
<br />
212 Even in a
<b>single-user environment
</b>, you might prefer to use
213 HTTP or cookie mode so that your user/password pair are not in clear
214 in the configuration file.
<br /><br /></li>
216 <li>HTTP and cookie authentication modes are more secure: the MySQL
217 password does not need to be set in the phpMyAdmin configuration file
218 (except for the
"controluser
" -see the
219 <a href=
"#config">Configuration section
</a>).
221 However, keep in mind that the password travels in plain text, unless
222 you are using the HTTPS protocol.
224 In cookie mode, we send the password in a temporary cookie, so most
225 browsers should not store the password in their cookie file.
229 For 'HTTP' and 'cookie' modes, phpMyAdmin needs a controluser that has
230 <b>only
</b> the
<tt>SELECT
</tt> privilege on the
<i>mysql.user (all
231 columns except
"Password
")
</i>,
<i>mysql.db (all columns)
</i>
232 & <i>mysql.tables_priv (all columns except
"Grantor
"
233 & "Timestamp
")
</i>tables.
<br />
234 You must specify the details for the controluser in the
235 <i>config.inc.php3
</i> file under the
236 <tt>$cfg['Servers'][$i]['controluser']
</tt>&
237 <tt>$cfg['Servers'][$i]['controlpass']
</tt> settings.
<br />
238 The following example assumes you want to use
<tt>pma
</tt> as the
239 controluser and
<tt>pmapass
</tt> as the controlpass, but
<b>this is
240 only an example: use something else in your file!
</b><br />
241 Of course you have to replace
<tt>localhost
</tt> by the webserver's host
242 if it's not the same as the MySQL server's one.
245 GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY 'pmapass';
247 Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
248 Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
249 File_priv, Grant_priv, References_priv, Index_priv, Alter_priv,
250 Show_db_priv, Super_priv, Create_tmp_table_priv, Lock_tables_priv,
251 Execute_priv, Repl_slave_priv, Repl_client_priv
252 ) ON mysql.user TO 'pma'@'localhost';
253 GRANT SELECT ON mysql.db TO 'pma'@'localhost';
254 GRANT SELECT ON mysql.host TO 'pma'@'localhost';
255 GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv)
256 ON mysql.tables_priv TO 'pma'@'localhost';
258 If you are using an old MySQL version (below
4.0.2), please use this
259 query instead of the second one:
263 Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
264 Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
265 File_priv, Grant_priv, References_priv, Index_priv, Alter_priv
266 ) ON mysql.user TO 'pma'@'localhost';
268 ... and if you want to use the many new relation and bookmark
272 GRANT SELECT, INSERT, UPDATE, DELETE ON
<pma_db
> TO 'pma'@'localhost';
274 (this of course requires you to have a special DB for phpMyAdmin, the
275 contents will be explained later)
<br />
276 Of course, the above queries only work if your MySQL version supports
277 the GRANT command. This is the case since
3.22.11.
280 Then each of the
<i>true
</i> users should be granted a set of
281 privileges on a set of particular databases. Normally you shouldn't
282 give global privileges to an ordinary user, unless you understand
283 the impact of those privileges (for example, you are creating
285 For example, to grant the user
<i>real_user
</i> with
286 all privileges on the database
<i>user_base
</i>:
<br />
287 <tt>GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost IDENTIFIED BY 'real_password';
</tt>
289 What the user may now do is controlled entirely by the MySQL user
290 management system.
<br />
291 With HTTP or cookie authentication mode, you don't need to fill the user/password
292 fields inside the
<tt>$cfg['Servers']
</tt> array.
<br />
296 <p><b>'http' authentication mode:
</b></p>
298 <li>Was called 'advanced' in versions before
2.2.3.
</li>
299 <li>Introduced in
1.3.0, it uses Basic HTTP authentication method and
300 allows you to login as any valid MySQL user.
</li>
301 <li>Is only supported with PHP running as an Apache module, not with
305 <p><b>'cookie' authentication mode:
</b></p>
307 <li>You can use this method as a replacement for the HTTP
308 authentication (for example, if you're running IIS).
310 <li>Obviously, the user must enable cookies in the browser.
</li>
311 <li>With this mode, the use can truly logout of phpMyAdmin and login back
312 with the same username.
</li>
315 <p><b>'config' authentication mode:
</b></p>
317 <li>This mode is the less secure one because it requires you to fill the
318 <tt>$cfg['Servers'][$i]['user']
</tt> and
319 <tt>$cfg['Servers'][$i]['password']
</tt> fields.
<br />
320 But you don't need to setup a
"controluser
" here:
321 using the
<tt>$cfg['Servers'][$i]['only_db']
</tt> might be enough.
</li>
322 <li>In the ISP FAQ section, there is an entry explaining how to protect
323 your configuration file.
<br /></li>
324 <li>For additional security in this mode, you may wish to consider the
325 Host authentication
<tt>$cfg['Servers'][$i]['AllowDeny']['order']
</tt>
326 and
<tt>$cfg['Servers'][$i]['AllowDeny']['rules']
</tt> configuration
331 <!-- CONFIGURATION -->
332 <a name=
"config"></a><br />
333 <h2>Configuration
</h2>
336 <span class=
"important">Warning for Mac users:
</span> PHP seems not to like
337 Mac end of lines character (
"<tt>\r
</tt>"). So ensure you choose
338 the option that allows to use the *nix end of line character
339 (
"<tt>\n
</tt>") in your text editor before registering a script
343 <p>All configurable data is placed in
<i>config.inc.php3
</i>.
</p>
345 <dt><b>$cfg['PmaAbsoluteUri']
</b> string
</dt>
347 Sets here the complete URL (with full path) to your phpMyAdmin version.
348 E.g.
<tt>http://www.your_web.net/path_to_your_phpMyAdmin_directory/
</tt>.
350 phpMyAdmin needs this setting, because of requirements of the HTTP
351 protocol, explained in RFC2616, section
14.30.
353 Don't forget the slash at the end of your URL. The URL must contain
354 characters that are valid for a URL, and on some servers, the path
357 Starting with version
2.3.0, you can try to leave this parameter
358 empty, because the program tries to auto-detect its proper value.
359 Additional details are in the configuration file.
361 Alternatively, this setting can be dynamically completed. For example,
362 you can try to use such a kind of code:
364 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
365 . $_SERVER['HTTP_HOST']
366 . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
367 . substr($_SERVER['PHP_SELF'],
0, strrpos($_SERVER['PHP_SELF'], '/')+
1);
371 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
372 . $_SERVER['SERVER_NAME']
373 . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
374 . substr($_SERVER['SCRIPT_NAME'],
0, strrpos($_SERVER['SCRIPT_NAME'], '/')+
1);
376 Please note that the
<tt>$_SERVER
</tt> array doesn't exist in
377 PHP
< 4.1.0. Try to replace
<tt>$_SERVER
</tt> by
378 <tt>$HTTP_SERVER_VARS
</tt> or
<tt>$GLOBALS
</tt> in this case.
381 <dt><b>$cfg['PmaAbsoluteUri_DisableWarning']
</b> boolean
</dt>
383 By default, when you leave $cfg['PmaAbsoluteUri'] empty, and the system
384 detects your absolute URI automatically, we display a warning to remind
385 you. If you have tested the automatic detection, and it works perfectly
386 for your setup, then you can set this variable to squelch the warning.
390 <dt><b>$cfg['PmaNoRelation_DisableWarning']
</b> boolean
</dt>
392 Starting with version
2.3.0 phpMyAdmin offers a lot of features to work
393 with master / foreign - tables (see
394 <a href=
"#pmadb">$cfg['Servers'][$i]['pmadb']
</a>).
396 If you tried to set this up and it does not work for you, have a look on
397 the
"Structure
" page of one database where you would like to
398 use it. You will find a link that will analyze why those features have
400 If you do not want to use those features set this variable to
401 <tt>TRUE
</tt> to stop this message from appearing.
405 <dt><b>$cfg['Servers']
</b> array
</dt>
407 Since version
1.4.2, phpMyAdmin supports the administration of multiple
409 Therefore, a $cfg['Servers']-array has been added which contains
410 the login information for the different servers. The first
411 <tt>$cfg['Servers'][$i]['host']
</tt> contains the hostname of the first
412 server, the second
<tt>$cfg['Servers'][$i]['host']
</tt> the hostname of
413 the second server, etc.
414 If you have only one server to administer, simply leave free the
415 hostname of the other $cfg['Server']-entries.
419 <dt><b>$cfg['Servers'][$i]['host']
</b> string
</dt>
421 The hostname of your $i-th MySQL-server. E.g. localhost.
425 <dt><b>$cfg['Servers'][$i]['port']
</b> string
</dt>
427 The port-number of your $i-th MySQL-server. Default is
3306 (leave
432 <dt><b>$cfg['Servers'][$i]['socket']
</b> string
</dt>
434 The path to the socket to use. Leave blank for default.
<br />
435 To use the socket feature you must run PHP
3.0.10 or more.
439 <dt><b>$cfg['Servers'][$i]['connect_type']
</b> string
</dt>
441 What type connection to use with the MySQL server. Your options are
442 <tt>'socket'
</tt> & <tt>'tcp'
</tt>. It defaults to 'tcp' as that
443 is nearly guaranteed to be available on all MySQL servers, while
444 sockets are not supported on some platforms.
446 To use the socket mode, your MySQL server must be on the same machine
451 <dt><b>$cfg['Servers'][$i]['compress']
</b> boolean
</dt>
453 Whether to use a compressed protocol for the MySQL server connection
454 or not (experimental).
<br />
455 This feature requires PHP
>=
4.3.0.
459 <b>$cfg['Servers'][$i]['controluser']
</b> string
<br />
460 <b>$cfg['Servers'][$i]['controlpass']
</b> string
463 When using HTTP or cookie authentication modes (or 'config'
464 authentication mode since phpMyAdmin
2.2.1), you need to supply the
465 details of a MySQL account that has
<tt>SELECT
</tt> privilege on the
466 <i>mysql.user (all columns except
"Password
")
</i>,
467 <i>mysql.db (all columns)
</i> & <i>mysql.tables_priv (all columns
468 except
"Grantor
" & "Timestamp
")
</i>tables.
469 This account is used to check what databases the user will see at
471 Please see the
<a href=
"#setup">install section
</a>
472 on
"Using HTTP authentication
" for more information.
474 Note that if you try login to phpMyAdmin with this
475 "controluser
", you could get some errors, depending the exact
476 privileges you gave to the
"controluser
". phpMyAdmin does not
477 support a direct login with the
"controluser
".
479 In versions before
2.2.5, those were called
480 "stduser/stdpass
".
484 <dt><b>$cfg['Servers'][$i]['auth_type']
</b> string
<tt>['http'|'cookie'|'config']
</tt></dt>
486 Whether config or cookie or http authentication should be used for this
491 'config' authentication
492 (
<tt>$auth_type
=
'config'
</tt>) is the plain old
493 way: username and password are stored in
494 <i>config.inc.php3
</i>.
497 'cookie' authentication mode
498 (
<tt>$auth_type
=
'cookie'
</tt>) as introduced in
499 2.2.3 allows you to log in as any valid MySQL user with the
500 help of... cookies. Log name and password are stored in
501 cookies during the session and password is deleted when it
505 'http' authentication (was called 'advanced' in older versions)
506 (
<tt>$auth_type
=
'http'
</tt>) as introduced in
1.3.0
507 allows you to log in as any valid MySQL user via HTTP-Auth.
511 Please see the install section on
"Using authentication modes
"
512 for more information.
517 <b>$cfg['Servers'][$i]['user']
</b> string
<br />
518 <b>$cfg['Servers'][$i]['password']
</b> string
521 The user/password-pair which phpMyAdmin will use to connect to this
522 MySQL-server. This user/password pair is not needed when HTTP or cookie
523 authentication is used, and should be empty.
<br /><br />
526 <dt><b>$cfg['Servers'][$i]['only_db']
</b> string or array
</dt>
528 If set to a(an array of) database name(s), only this(these) database(s)
529 will be shown to the user. Since phpMyAdmin
2.2.1, this/these
530 database(s) name(s) may contain MySQL wildcards characters
531 (
"_
" and
"%
"): if you want to use literal instances
532 of these characters, escape them (I.E. use
<tt>'my\_db'
</tt> and not
533 <tt>'my_db'
</tt>).
<br />
534 This setting is an efficient way to lower the server charge since the
535 latter does not need to send MySQL requests to build the available
536 database list. But
<span class=
"important">it does not replace the
537 privileges rules of the MySQL database server
</span>. If set, it just
538 means only these databases will be displayed but
539 <span class=
"important">not at all other databases can't be used.
</span>
543 <dt><b>$cfg['Servers'][$i]['verbose']
</b> string
</dt>
545 Only useful when using phpMyAdmin with multiple server entries. If set,
546 this string will be displayed instead of the hostname in the pull-down
547 menu on the main page. This can be useful if you want to show only
548 certain databases on your system, for example.
553 <a name=
"pmadb"></a><br />
554 <b>$cfg['Servers'][$i]['pmadb']
</b> string
557 Starting with version
2.3.0 phpMyAdmin offers a lot of features
558 to work with master / foreign - tables. To use those as well as
559 the bookmark feature you need special tables with a
560 predefined structure, which we explain below.
<br />
561 If you are the only user of this phpMyAdmin installation, you can
562 use your current database to store those special tables; in this
563 case, just put your current database name in
564 <tt>$cfg['Servers'][$i]['pmadb']
</tt>.
566 If you are setting up a multi-user phpMyAdmin installation,
567 you will need to create a new database and setup special privileges,
572 create a new database for phpMyAdmin:
<br />
573 <tt> CREATE DATABASE phpmyadmin;
</tt><br />
574 Note that
"controluser
" must have
575 <tt>SELECT, INSERT, UPDATE
</tt> and
<tt>DELETE
</tt>
576 privileges on this database. Here is a query to set up
577 those privileges (using
"phpmyadmin
"
578 as the database name, and
"pma
" as the
581 GRANT SELECT,INSERT,UPDATE,DELETE ON phpmyadmin.* to 'pma'@'localhost';
583 do
<b>not
</b> give any other user rights on this database.
586 enter the database name in
<tt>$cfg['Servers'][$i]['pmadb']
</tt>
592 <a name=
"bookmark"></a><br />
593 <b>$cfg['Servers'][$i]['bookmarktable']
</b> string
596 Since release
2.2.0 phpMyAdmin allows to bookmark queries. This can be
597 useful for queries you often run.
<br /><br />
599 To allow the usage of this functionality you have to:
601 <li>set up
"pmadb
" as described above
</li>
602 <li>within this database create a table following this scheme:
605 CREATE TABLE `PMA_bookmark` (
<br />
606 id int(
11) DEFAULT '
0' NOT NULL auto_increment,
<br />
607 dbase varchar(
255) NOT NULL,
<br />
608 user varchar(
255) NOT NULL,
<br />
609 label varchar(
255) NOT NULL,
<br />
610 query text NOT NULL,
<br />
611 PRIMARY KEY (id)
<br />
612 ) TYPE=MyISAM COMMENT='Bookmarks';
<br />
615 <li>enter the table name in
616 <tt>$cfg['Servers'][$i]['bookmarktable']
</tt></li>
621 <a name=
"relation"></a><br />
622 <b>$cfg['Servers'][$i]['relation']
</b> string
625 Since release
2.2.4 you can describe, in a special 'relation' table,
626 which field is a key in another table (a foreign key). phpMyAdmin
627 currently uses this to
630 make clickable, when you browse the master table, the data values
631 that point to the foreign table;
634 display in an optional tool-tip the
"display field
"
635 when browsing the master table, if you move the mouse to a column
636 containing a foreign key (use also the 'table_info' table);
639 display links on the table properties page, to check referential
640 integrity (display missing foreign keys) for each described key;
643 in query-by-example, create automatic joins (see an example in
644 the FAQ, section
"Using phpMyAdmin
");
647 enable you to get a PDF schema of your database (also uses the
653 The keys can be numeric or character.
656 To allow the usage of this functionality the superuser has to:
658 <li>set up
"pmadb
" as described above
</li>
660 within this database create a table following this scheme:
663 CREATE TABLE `PMA_relation` (
<br />
664 `master_db` varchar(
64) NOT NULL default '',
<br />
665 `master_table` varchar(
64) NOT NULL default '',
<br />
666 `master_field` varchar(
64) NOT NULL default '',
<br />
667 `foreign_db` varchar(
64) NOT NULL default '',
<br />
668 `foreign_table` varchar(
64) NOT NULL default '',
<br />
669 `foreign_field` varchar(
64) NOT NULL default '',
<br />
670 PRIMARY KEY (`master_db`, `master_table`, `master_field`),
<br />
671 KEY foreign_field (foreign_db, foreign_table)
<br />
672 ) TYPE=MyISAM COMMENT='Relation table';
<br />
676 put the relation table name in
677 <tt>$cfg['Servers'][$i]['relation']
</tt>
680 now as normal user open phpMyAdmin and for each one of your
681 tables where you want to use this feature, click
682 "Structure/Relation view/
" and choose foreign fields.
685 Please note that in the current (
2.3.0) version,
<tt>master_db
</tt>
686 must be the same as
<tt>foreign_db
</tt>. Those fields have been put in
687 future development of the cross-db relations.
<br /><br />
691 <a name=
"table_info"></a><br />
692 <b>$cfg['Servers'][$i]['table_info']
</b> string
695 Since release
2.3.0 you can describe, in a special 'table_info'
696 table, which field is to be displayed as a tool-tip when moving the
697 cursor over the corresponding key.
699 This configuration variable will hold the name of this special
701 To allow the usage of this functionality the superuser has to:
703 <li>set up
"pmadb
" as described above
</li>
704 <li>within this database create a table following this scheme:
707 CREATE TABLE `PMA_table_info` (
<br />
708 `db_name` varchar(
64) NOT NULL default '',
<br />
709 `table_name` varchar(
64) NOT NULL default '',
<br />
710 `display_field` varchar(
64) NOT NULL default '',
<br />
711 PRIMARY KEY (`db_name`, `table_name`)
<br />
712 ) TYPE=MyISAM COMMENT='Table information for phpMyAdmin';
<br />
716 put the table name in
717 <tt>$cfg['Servers'][$i]['table_info']
</tt>
720 then for each table where you want to use this feature,
721 click
"Structure/Relation view/Choose field to display
"
725 Usage tip:
<a href=
"#faqdisplay">Display field
</a>.
730 <a name=
"table_coords"></a><br />
731 <b>$cfg['Servers'][$i]['table_coords']
</b> string
<br />
732 <b>$cfg['Servers'][$i]['pdf_pages']
</b> string
735 Since release
2.3.0 you can have phpMyAdmin create PDF pages showing
736 the relations between your tables. To do this it needs two tables
737 "pdf_pages
" (storing information about the available PDF
738 pages) and
"table_coords
" (storing coordinates where each
739 table will be placed on a PDF schema output).
741 You must be using the
"relation
" feature and have a table of
742 PDF pages (see
<tt>$cfg['Servers'][$i]['pdf_pages']
</tt>) to create PDF
745 To allow the usage of this functionality the superuser has to:
747 <li>set up
"pmadb
" as described above
</li>
749 within this database create a table following this scheme:
752 CREATE TABLE `PMA_table_coords` (
<br />
753 `db_name` varchar(
64) NOT NULL default '',
<br />
754 `table_name` varchar(
64) NOT NULL default '',
<br />
755 `pdf_page_number` int NOT NULL default '
0',
<br />
756 `x` float unsigned NOT NULL default '
0',
<br />
757 `y` float unsigned NOT NULL default '
0',
<br />
758 PRIMARY KEY (`db_name`, `table_name`, `pdf_page_number`)
<br />
759 ) TYPE=MyISAM COMMENT='Table coordinates for phpMyAdmin PDF output';
<br />
763 also within this database create:
<br />
765 CREATE TABLE `PMA_pdf_pages` (
<br />
766 `db_name` varchar(
64) NOT NULL default '',
<br />
767 `page_nr` int(
10) unsigned NOT NULL auto_increment,
<br />
768 `page_descr` varchar(
50) NOT NULL default '',
<br />
769 PRIMARY KEY (page_nr),
<br />
770 KEY (db_name)
<br />
771 ) TYPE=MyISAM COMMENT='PDF Relationpages for PMA';
<br />
775 put the first table name in
776 <tt>$cfg['Servers'][$i]['table_coords']
</tt>
777 and the second table name in
778 <tt>$cfg['Servers'][$i]['pdf_pages']
</tt>
781 Usage tips:
<a href=
"#faqpdf">PDF output
</a>.
786 <a name=
"col_com"></a><br />
787 <b>$cfg['Servers'][$i]['column_info']
</b> string
790 <!-- This part requires a content update! -->
791 Since release
2.3.0 you can store comments to describe each column
792 for each table. These will then be shown on the
"printview
".
794 Starting with release
2.5.0, comments are consequently used on the table property
795 pages and table browse view, showing up as tool-tips above the column name (properties page)
796 or embedded within the header of table in browse view. They can also be shown
797 in a table dump. Please see the relevant configuration directives later on.
799 Also new in release
2.5.0 is a mime-transformation system which is also based on
800 the following table structure. See
<a href=
"#transformations">Transformations
</a>
801 for further information. To use the mime-transformation system, your column_info
802 table has to have the three new fields 'mimetype', 'transformation', 'transformation_options'.
804 To allow the usage of this functionality the superuser has to:
806 <li>set up
"pmadb
" as described above
</li>
808 within this database create a table following this scheme:
811 CREATE TABLE `PMA_column_info` (
<br />
812 id int(
5) unsigned NOT NULL auto_increment,
<br />
813 db_name varchar(
64) NOT NULL default '',
<br />
814 table_name varchar(
64) NOT NULL default '',
<br />
815 column_name varchar(
64) NOT NULL default '',
<br />
816 `comment` varchar(
255) NOT NULL default '',
<br />
817 mimetype varchar(
255) NOT NULL default '',
<br />
818 transformation varchar(
255) NOT NULL default '',
<br />
819 transformation_options varchar(
255) NOT NULL default '',
<br />
820 PRIMARY KEY (id),
<br />
821 UNIQUE KEY db_name (db_name, table_name, column_name)
<br />
822 ) TYPE=MyISAM COMMENT='Comments for Columns';
<br />
826 put the table name in
827 <tt>$cfg['Servers'][$i]['column_info']
</tt>
830 To update your PRE-
2.5.0 Column_comments Table use this:
<br />
832 ALTER TABLE `PMA_column_comments`
<br />
833 ADD `mimetype` VARCHAR(
255 ) NOT NULL ,
<br />
834 ADD `transformation` VARCHAR(
255 ) NOT NULL ,
<br />
835 ADD `transformation_options` VARCHAR(
255 ) NOT NULL ;
<br />
837 and remember that the Variable in config.inc.php has been renamed
838 from
<br />$cfg['Servers'][$i]['column_comments'] to $cfg['Servers'][$i]['column_info']
844 <a name=
"history"></a><br />
845 <b>$cfg['Servers'][$i]['history']
</b> string
848 Since release
2.5.0 you can store your SQL history, which means all queries you
849 entered manually into the phpMyAdmin interface. If you don't want to use a table-
850 based history, you can use the JavaScript-based history. Using that, all your
851 history items are deleted when closing the window.
<br /><br />
853 Using
<b>$cfg['QueryHistoryMax']
</b> you can specify an amount of history items
854 you want to have on hold. On every login, this list gets cut to the maximum amount.
857 The query history is only available if you use the JavaScript-based query window,
858 see
<b>$cfg['QueryFrame']
</b>.
861 To allow the usage of this functionality the superuser has to:
863 <li>set up
"pmadb
" as described above
</li>
865 within this database create a table following this scheme:
868 CREATE TABLE `PMA_history` (
<br />
869 `id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
<br />
870 `username` VARCHAR(
64 ) NOT NULL ,
<br />
871 `db` VARCHAR(
64 ) NOT NULL ,
<br />
872 `table` VARCHAR(
64 ) NOT NULL ,
<br />
873 `timevalue` TIMESTAMP NOT NULL ,
<br />
874 `sqlquery` TEXT NOT NULL ,
<br />
875 PRIMARY KEY ( `id` ) ,
<br />
876 INDEX ( `username` , `db` , `table` , `timevalue` )
<br />
877 ) TYPE=MyISAM COMMENT='SQL history';
<br />
881 put the table name in
882 <tt>$cfg['Servers'][$i]['history']
</tt>
888 <a name=
"history"></a><br />
889 <b>$cfg['Servers'][$i]['verbose_check']
</b> string
892 Because release
2.5.0 introduced the new MIME-transformation support, the
893 column_info table got enhanced with three new fields. If the above variable is
894 set to TRUE (default) phpMyAdmin will check if you have the latest table structure
895 available. If not, it will emit a warning to the superuser.
<br /><br />
897 You can disable this checking behavior by setting the variable to false, which
898 should offer a performance increase.
<br /><br />
900 Recommended to set to FALSE, when you are sure, your table structure is up to date.
905 <b>$cfg['Servers'][$i]['AllowDeny']['order']
</b> string
908 If your rule order is empty, then IP authentication is disabled.
910 If your rule order is set to
<tt>'deny,allow'
</tt> then the system
911 applies all deny rules followed by allow rules.
912 Access is allowed by default. Any client which does not match a Deny
913 command or does match an Allow command will be allowed access to the
916 If your rule order is set to
<tt>'allow,deny'
</tt> then the system
917 applies all allow rules followed by deny rules. Access is denied by
918 default. Any client which does not match an Allow directive or does
919 match a Deny directive will be denied access to the server.
921 If your rule order is set to 'explicit', the authentication is
922 performed in a similar fashion to rule order 'deny,allow', with the
923 added restriction that your host/username combination
<b>must
</b> be
924 listed in the
<i>allow
</i> rules, and not listed in the
<i>deny
</i>
925 rules. This is the
<b>most
</b> secure means of using Allow/Deny rules,
926 and was available in Apache by specifying allow and deny rules without
932 <b>$cfg['Servers'][$i]['AllowDeny']['rules']
</b> array of strings
935 The general format for the rules is as such:
<br />
937
938 <'allow' | 'deny'
> <username
> [from]
<ipmask
>
942 If you wish to match all users, it is possible to use a
<tt>'%'
</tt> as
943 a wildcard in the
<i>username
</i> field.
<br />
944 There are a few shortcuts you can use in the
<i>ipmask
</i> field as
947 'all' -
> 0.0.0.0/
0<br />
948 'localhost' -
> 127.0.0.1/
8
952 Having an empty rule list is equivalent to either using
953 <tt>'allow % from all'
</tt> if your rule order is set to
954 <tt>'deny,allow'
</tt> or
<tt>'deny % from all'
</tt> if your rule order
955 is set to
<tt>'allow,deny'
</tt> or
<tt>'explicit'
</tt>.
958 For the IP matching system, the following work:
<br />
959 <tt>xxx.xxx.xxx.xxx
</tt> (an exact IP address)
<br />
960 <tt>xxx.xxx.xxx.[yyy-zzz]
</tt> (an IP address range)
<br />
961 <tt>xxx.xxx.xxx.xxx/nn
</tt> (CIDR, Classless Inter-Domain Routing type IP addresses)
<br />
962 But the following does not work:
<br />
963 <tt>xxx.xxx.xxx.xx[yyy-zzz]
</tt> (partial IP address range)
967 <dt><b>$cfg['ServerDefault']
</b> integer
</dt>
969 If you have more than one server configured, you can set
970 <tt>$cfg['ServerDefault']
</tt> to any one of them to autoconnect to
971 that server when phpMyAdmin is started, or set it to
0 to be given a
972 list of servers without logging in.
<br />
973 If you have only one server configured,
<tt>$cfg['ServerDefault']
</tt>
974 MUST be set to that server.
978 <dt><b>$cfg['OBGzip']
</b>boolean
</dt>
980 Defines whether to use GZip output buffering for increased
981 speed in HTTP transfers.
985 <dt><b>$cfg['PersistentConnections']
</b>boolean
</dt>
987 Whether persistent connections should be used or not (mysql_connect or
992 <dt><b>$cfg['ExecTimeLimit']
</b>integer [number of seconds]
</dt>
994 Set the number of seconds a script is allowed to run. If seconds is set
995 to zero, no time limit is imposed.
<br />
996 This setting is used while importing/exporting dump files but has no
997 effect when PHP is running in safe mode.
1001 <dt><b>$cfg['SkipLockedTables']
</b>boolean
</dt>
1003 Mark used tables and make it possible to show databases with locked
1004 tables (since
3.23.30).
1008 <dt><b>$cfg['ShowSQL']
</b>boolean
</dt>
1010 Defines whether SQL-queries generated by phpMyAdmin should be displayed
1015 <dt><b>$cfg['AllowUserDropDatabase']
</b>boolean
</dt>
1017 Defines whether normal users (non-administrator) are allowed to
1018 delete their own database or not. If set as FALSE, the link
"Drop
1019 Database
" will not be shown, and even a
"DROP DATABASE
1020 mydatabase
" will be rejected. Quite practical for ISP's with many
1025 <dt><b>$cfg['Confirm']
</b>boolean
</dt>
1027 Whether a warning (
"Are your really sure..
") should be
1028 displayed when you're about to loose data.
1032 <dt><b>$cfg['LoginCookieRecall']
</b>boolean
</dt>
1034 Define whether the previous login should be recalled or not in cookie
1035 authentication mode.
1039 <dt><b>$cfg['UseDbSearch']
</b>boolean
</dt>
1041 Define whether the
"search string inside database" is enabled or not.
1045 <dt><b>$cfg['LeftFrameLight']
</b> boolean
</dt>
1047 Defines whether to use select-based menu and display only the current
1048 tables in the left frame (smaller page).
1052 <dt><b>$cfg['ShowTooltip']
</b>boolean
</dt>
1054 Defines whether to display table comment as tool-tip in left frame or
1059 <dt><b>$cfg['ShowTooltipAliasDB']
</b>boolean
</dt>
1061 If tool-tips are enabled and a DB comment is set, this will flip the comment
1062 and the real name. That means, if you have a table called 'user0001' and add
1063 the comment 'MyName' on it, you will see the name 'MyName' used consequently
1064 in the left frame and the tool-tip shows the real name of the DB.
1068 <dt><b>$cfg['ShowTooltipAliasTB']
</b>boolean
</dt>
1070 Same as $cfg['ShowTooltipAliasDB'], except this works for table names.
1074 <dt><b>$cfg['ShowStats']
</b>boolean
</dt>
1076 Defines whether to display space usage and statistics about databases
1077 and tables or not.
<br />
1078 Note that statistics requires at least MySQL
3.23.3 and that, at this
1079 date, MySQL doesn't return such information for Berkeley DB tables.
1084 <b>$cfg['ShowMysqlInfo']
</b>boolean
<br />
1085 <b>$cfg['ShowMysqlVars']
</b>boolean
<br />
1086 <b>$cfg['ShowPhpInfo']
</b>boolean
<br />
1087 <b>$cfg['ShowChgPassword']
</b>boolean
1090 Defines whether to display the
"MySQL runtime information
",
1091 "MySQL system variables
",
"PHP information
" and
1092 "Change password
" links or not for simple users at the
1093 starting main (right) frame. This setting does not check MySQL commands
1097 Please note that to block the usage of phpinfo() in scripts, you
1098 have to put this in your php.ini:
<br />
1099 <tt>disable_functions = phpinfo()
</tt>
1102 Also note that enabling the
"Change password
" link has no
1103 effect with
"config
" authentication mode: because of the hard
1104 coded password value in the configuration file, end users can't be
1105 allowed to change their passwords.
1109 <dt><b>$cfg['SuggestDBName']
</b> boolean
</dt>
1111 Defines whether to suggest a database name on the
1112 "Create Database
" form or to keep the textfield empty.
1116 <dt><b>$cfg['ShowBlob']
</b>boolean
</dt>
1118 Defines whether
<tt>BLOB
</tt> fields are shown when browsing a table's
1123 <dt><b>$cfg['NavigationBarIconic']
</b>boolean
</dt>
1125 Defines whether navigation bar buttons contain text or symbols only.
1129 <dt><b>$cfg['ShowAll']
</b>boolean
</dt>
1131 Defines whether an user should be displayed a
1132 "show all (records)
" button in browse mode or not.
1136 <dt><b>$cfg['MaxRows']
</b>integer
</dt>
1138 Number of rows displayed when browsing a result set. If the result set
1139 contains more rows, Previous/Next links will be shown.
1143 <dt><b>$cfg['Order']
</b>string [
<tt>DESC
</tt>|
<tt>ASC
</tt>|
<tt>SMART
</tt>]
</dt>
1145 Defines whether fields are displayed in ascending (
<tt>ASC
</tt>) order,
1146 in descending (
<tt>DESC
</tt>) order or in a
"smart
"
1147 (
<tt>SMART
</tt>) order - I.E. descending order for fields of type TIME,
1148 DATE, DATETIME
& TIMESTAMP, ascending order else- by default.
1152 <dt><b>$cfg['ProtectBinary']
</b>boolean or string
</dt>
1154 Defines whether
<tt>BLOB
</tt> or
<tt>BINARY
</tt> fields are protected
1155 from edition when browsing a table's content or not.
1156 Valid values are:
<br />
1157 -
<tt>FALSE
</tt> to allow edition of all fields;
<br />
1158 -
<tt>blob
</tt> to allow edition of all fields except
<tt>BLOBS
</tt>;
1160 -
<tt>all
</tt> to disallow edition of all
<tt>BINARY
</tt> or
1161 <tt>BLOB
</tt> fields.
1165 <dt><b>$cfg['ShowFunctionFields']
</b>boolean
</dt>
1167 Defines whether MySQL functions fields should be displayed or not in
1172 <dt><b>$cfg['CharEditing']
</b>string
</dt>
1174 Defines which type of editing controls should be used for CHAR and
1175 VARCHAR fields. Possible values are:
1178 input - this allows to limit size of text to size of field in
1179 MySQL, but has problems with newlines in fields
1182 textarea - no problems with newlines in fields, but also no
1186 Default is old behavior so input.
1191 <b>$cfg['ZipDump']
</b>boolean
<br />
1192 <b>$cfg['GZipDump']
</b>boolean
<br />
1193 <b>$cfg['BZipDump']
</b>boolean
1196 Defines whether to allow the use of zip/GZip/BZip2 compression when
1197 creating a dump file or not.
1201 <dt><b>$cfg['LightTabs']
</b>string
</dt>
1203 If set to True, do use less graphically intense tabs on the top of the mainframe.
1207 <dt><b>$cfg['DefaultTabServer']
</b>string
</dt>
1209 Defines the tab displayed by default on server view. Possible
1210 values:
"main.php3
" (recommended for multi-user setups),
1211 "server_databases.php3
",
"server_status.php3
",
1212 "server_variables.php3
",
"server_privileges.php3
" or
1213 "server_processlist.php3
".
1217 <dt><b>$cfg['DefaultTabDatabase']
</b>string
</dt>
1219 Defines the tab displayed by default on database view. Possible
1220 values:
"db_details_structure.php3
",
1221 "db_details.php3
" or
"db_search.php3
".
1225 <dt><b>$cfg['DefaultTabTable']
</b>string
</dt>
1227 Defines the tab displayed by default on table view. Possible
1228 values:
"tbl_properties_structure.php3
",
1229 "tbl_properties.php3
",
"tbl_select.php3
" or
1230 "tbl_change.php3
".
1234 <dt><b>$cfg['MySQLManualBase']
</b> string
</dt>
1236 If set to an URL which points to the MySQL documentation (type depends
1237 on
<tt>$cfg['MySQLManualType']
</tt>), appropriate help links are
1240 See
<a href=
"http://www.mysql.com/documentation/index.html">MySQL
1241 Documentation page
</a> for more information about MySQL manuals and
1246 <dt><b>$cfg['MySQLManualType']
</b> string
</dt>
1248 Type of MySQL documentation:
1250 <li>old - old style used in phpMyAdmin
2.3.0 and sooner
</li>
1251 <li>searchable -
"Searchable, with user comments
"</li>
1252 <li>chapters -
"HTML, one page per chapter
"</li>
1253 <li>big -
"HTML, all on one page
"</li>
1254 <li>none - do not show documentation links
</li>
1259 <dt><b>$cfg['DefaultLang']
</b>string
</dt>
1261 Defines the default language to use, if not browser-defined or
1263 See the
<i>select_lang.inc.php3
</i> script to know the valid values for
1268 <dt><b>$cfg['Lang']
</b>string
</dt>
1270 Force: always use this language (must be defined in the
1271 <i>select_lang.inc.php3
</i> script).
1275 <dt><b>$cfg['DefaultCharset']
</b>string
</dt>
1277 Default character set to use for recoding of MySQL queries. This must be
1278 enabled and it's described by
<tt>$cfg['AllowAnywhereRecoding']
</tt>
1280 You can give here any character set which is in
1281 <tt>$cfg['AvailableCharsets']
</tt> array and this is just default
1282 choice, user can select any of them.
1286 <dt><b>$cfg['AllowAnywhereRecoding']
</b>boolean
</dt>
1288 Allow character set recoding of MySQL queries. You need recode or iconv
1289 support (compiled in or module) in PHP to allow MySQL queries recoding
1290 and used language file must have it enabled (by default only these
1291 which are in Unicode, just to avoid losing some characters).
1295 <dt><b>$cfg['RecodingEngine']
</b>string
</dt>
1297 You can select here which functions will be used for character set
1299 Possible values are:
<br />
1301 <li>auto - automatically use available one (first is tested
1302 iconv, then recode)
</li>
1303 <li>iconv - use iconv or libiconv functions
</li>
1304 <li>recode - use recode_string function
</li>
1310 <dt><b>$cfg['AvailableCharsets']
</b>array
</dt>
1312 Available character sets for MySQL conversion. You can add your own (any of
1313 supported by recode/iconv) or remove these which you don't use.
1314 Character sets will be shown in same order as here listed, so if you
1315 frequently use some of these move them to the top.
1319 <dt><b>$cfg['LeftWidth']
</b>integer
</dt>
1321 Left frame width in pixel.
1326 <b>$cfg['LeftBgColor']
</b>string [HTML color]
<br />
1327 <b>$cfg['RightBgColor']
</b>string [HTML color]
1330 The background colors (HTML) used for both the frames.
1335 <b>$cfg['RightBgImage']
</b>string
1338 The URI of the background image used for the right frame. It can be
1339 absolute as well as relative from your phpMyAdmin directory.
1342 <dt><b>$cfg['LeftPointerColor']
</b>string [HTML color]
</dt>
1344 The color (HTML) used for the pointer in the left frame (does not work
1349 <dt><b>$cfg['Border']
</b>integer
</dt>
1351 The size of a table's border.
1355 <dt><b>$cfg['ThBgcolor']
</b>string [HTML color]
</dt>
1357 The color (HTML) used for table headers.
1361 <dt><b>$cfg['BgcolorOne']
</b>string [HTML color]
</dt>
1363 The color (HTML) #
1 for table rows.
1367 <dt><b>$cfg['BgcolorTwo']
</b>string [HTML color]
</dt>
1369 The color (HTML) #
2 for table rows.
1374 <b>$cfg['BrowsePointerColor']
</b>string [HTML color]
<br />
1375 <b>$cfg['BrowseMarkerColor']
</b>string [HTML color]
1378 The colors (HTML) uses for the pointer and the marker in browse mode
1379 (does not work with Netscape
4).
<br />
1380 The former feature highlights the row over which your mouse is passing
1381 and the latter lets you visually mark/unmark rows by clicking on
1383 You can disable both of these features by emptying the respective
1389 <b>$cfg['TextareaCols']
</b>integer
<br />
1390 <b>$cfg['TextareaRows']
</b>integer
<br />
1391 <b>$cfg['CharTextareaCols']
</b>integer
<br />
1392 <b>$cfg['CharTextareaRows']
</b>integer
1395 Number of columns and rows for the textareas.
<br />
1396 This value will be emphasized (*
2) for SQL query textareas and (*
1.25) for
1397 SQL textareas inside the query window.
<br />
1398 The Char* values are used for CHAR and VARCHAR editing (if configured
1399 via $cfg['CharEditing']).
1404 <b>$cfg['TextareaAutoSelect']
</b>boolean
<br />
1407 Defines if the whole textarea of the query box will be selected on
1412 <dt><b>$cfg['LimitChars']
</b>integer
</dt>
1414 Maximal number of Chars showed in a
<tt>TEXT
</tt> OR a
<tt>BLOB
</tt>
1415 field on browse view. Can be turned off by a toggle button on the
1421 <b>$cfg['ModifyDeleteAtLeft']
</b>boolean
<br />
1422 <b>$cfg['ModifyDeleteAtRight']
</b>boolean
1425 Defines the place where modify and delete links would be put when
1426 tables contents are displayed (you may have them displayed both at the
1427 left and at the right).
1428 "Left
" and
"right
" are parsed as
"top
"
1429 and
"bottom
" with vertical display mode.
1433 <dt><b>$cfg['DefaultDisplay']
</b>string
<br />
1434 <b>$cfg['HeaderFlipType']
</b>string
1437 There are
3 display modes: horizontal, horizontalflipped and vertical. Define
1438 which one is displayed by default. The first mode displays each row on a
1439 horizontal line, the second rotates the headers by
90 degrees, so you can use
1440 descriptive headers even though fields only contain small values and still
1441 print them out. The vertical mode sorts each row on a vertical lineup.
<br /><br />
1442 The HeaderFlipType can be set to 'css' or 'faked'. When using 'css' the rotation
1443 of the header for horizontalflipped is done via CSS. If set to 'faked' PGP
1444 does the transformation for you, but of course this does not look as good as CSS.
1448 <dt><b>$cfg['DefaultPropDisplay']
</b>string
</dt>
1450 When editing/creating new columns in a table all fields normally get lined up
1451 one field a line. (default: 'horizontal'). If you set this to 'vertical' you
1452 can have each field lined up vertically beneath each other. You can save up
1453 a lot of place on the horizontal direction and no longer have to scroll.
1457 <dt><b>$cfg['ShowBrowseComments']
</b>boolean
<br />
1458 <b>$cfg['ShowPropertyComments']
</b>boolean
<br />
1461 By setting the corresponding variable to TRUE you can enable the display of
1462 column comments in Browse or Property display. In browse mode, the comments
1463 are show inside the header. In property mode, comments are displayed using
1464 a CSS-formatted dashed-line below the name of the field. The comment is shown
1465 as a tool-tip for that field.
1469 <dt><b>$cfg['UploadDir']
</b>string
</dt>
1471 The name of the directory, ending with a slash, where SQL files have
1472 been uploaded by other means than phpMyAdmin (for example, ftp).
1473 Those files are available under a drop-down box when you click the
1474 database name, then the SQL tab.
1476 Please note that the file names must have the suffix
".sql
".
1478 This feature is useful when your file is too big to be uploaded via
1479 HTTP, or when file uploads are disabled in PHP.
1481 Please note that if PHP is running in safe mode, this directory must
1482 be owned by the same user as the owner of the phpMyAdmin scripts.
1486 <dt><b>$cfg['RepeatCells']
</b>integer
</dt>
1488 Repeat the headers every X cells, or
0 to deactivate.
1492 <dt><b>$cfg['QueryFrame']
</b>boolean
<br />
1493 <b>$cfg['QueryFrameJS']
</b>boolean
<br />
1494 <b>$cfg['QueryFrameDebug']
</b>boolean
<br />
1495 <b>$cfg['QueryWindowWidth']
</b>integer
<br />
1496 <b>$cfg['QueryWindowHeight']
</b>integer
<br />
1497 <b>$cfg['QueryHistoryDB']
</b>boolean
<br />
1498 <b>$cfg['QueryWindowDefTab']
</b>string
<br />
1499 <b>$cfg['QueryHistoryMax']
</b>integer
1502 All those variables affect the new query frame/window. When $cfg['QueryFrame']
1503 is set to true a new frame is embedded on the left with a small area. Clicking
1504 on that results in opening a direct interface to enter SQL queries.
<br /><br />
1505 When $cfg['QueryFrameJS'] is set to true, clicking on that link opens a new
1506 custom sized browser window ($cfg['QueryWindowWidth'], $cfg['QueryWindowWidth'] -
1507 both integers for the size in pixels). If set to false, clicking on the link
1508 only opens the SQL input in the mainframe.
<br /><br />
1509 The usage of the JavaScript query window is recommended if you have a JavaScript
1510 enabled browser. Basic functions are used to exchange quite a few variables, so
1511 most
4th generation browsers should be capable to use that feature. It currently
1512 is only tested with Internet Explorer
6 and Mozilla
1.x.
<br /><br />
1513 If $cfg['QueryHistoryDB'] is set to TRUE, all your Queries are logged to a table,
1514 which has to be created by you (see
<a href=
"history">$cfg['Servers'][$i]['history']
</a>).
1515 If set to FALSE, all your queries will be appended to the form, but only as long
1516 as your window is opened they remain saved.
<br /><br />
1517 When using the JavaScript based query window, it will always get updated when you
1518 click on a new table/db to browse and will focus if you click on
"Edit SQL" after
1519 using a query.
<br /><br />
1520 If $cfg['QueryHistoryDB'] is set to TRUE you can specify the amount of saved
1521 history items using $cfg['QueryHistoryMax'].
<br /><br />
1522 The query window also has a custom tabbed look to group the features. Using the
1523 variable $cfg['QueryWindowDefTab'] you can specify the default tab to be used
1524 when opening the query window. It can be set to either 'sql', 'files', 'history'
1525 or 'full'.
<br /><br />
1526 The variable $cfg['QueryFrameDebug'] can be used by developers for easier future
1527 feature integration.
1531 <dt><b>$cfg['BrowseMIME']
</b>boolean
</dt>
1533 Enable
<a href=
"#transformations">MIME-transformations
</a>.
1537 <dt><b>$cfg['MaxExactCount']
</b>integer
</dt>
1539 Determines for how large tables phpMyAdmin should get exact row count by
1540 <code>SELECT COUNT
</code>. If approximate row cound is smaller than this
1541 value,
<code>SELECT COUNT
</code> will be used, otherwise only value
1542 returned by
<code>SHOW TABLE STATUS
</code>.
1546 <dt><b>$cfg['SQP']['fmtType']
</b> string [
<tt>html
</tt>|
<tt>none
</tt>]
</dt>
1548 The main use of the new SQL Parser is to pretty-print SQL queries. By
1549 default we use HTML to format the query, but you can disable this by
1550 setting this variable to
<tt>'none'
</tt>
1554 <dt><b>$cfg['SQP']['fmtInd']
</b> float
<br />
1555 <b>$cfg['SQP']['fmtIndUnit']
</b> string [
<tt>em
</tt>|
<tt>px
</tt>|
<tt>pt
</tt>|
<tt>ex
</tt>]
</dt>
1557 For the pretty-printing of SQL queries, under some cases the part of a
1558 query inside a bracket is indented. By changing
1559 <tt>$cfg['SQP']['fmtInd']
</tt> you can change the amount of this indent.
1560 <br />Related in purpose is
<tt>$cfg['SQP']['fmtIndUnit']
</tt> which
1561 specifies the units of the indent amount that you specified. This is
1562 used via stylesheets.
1566 <dt><b>$cfg['SQP']['fmtColor']
</b> array of string tuples
</dt>
1568 This array is used to define the colours for each type of element of
1569 the pretty-printed SQL queries. The tuple format is
<br />
1570 <i>class
</i> =
> [
<i>HTML colour code
</i> |
<i>empty string
</i>]
<br />
1571 If you specify an empty string for the color of a class, it is ignored
1572 in creating the stylesheet.
1573 You should not alter the class names, only the colour strings.
<br />
1574 <b>Class name key:
</b><br />
1576 <li><b>comment
</b> Applies to all comment sub-classes
</li>
1577 <li><b>comment_mysql
</b> Comments as
<tt>"#...\n"</tt></li>
1578 <li><b>comment_ansi
</b> Comments as
<tt>"-- ...\n"</tt></li>
1579 <li><b>comment_c
</b> Comments as
<tt>"/*...*/"</tt></li>
1580 <li><b>digit
</b> Applies to all digit sub-classes
</li>
1581 <li><b>digit_hex
</b> Hexadecimal numbers
</li>
1582 <li><b>digit_integer
</b> Integer numbers
</li>
1583 <li><b>digit_float
</b> Floating point numbers
</li>
1584 <li><b>punct
</b> Applies to all punctuation sub-classes
</li>
1585 <li><b>punct_bracket_open_round
</b> Opening brackets
<tt>"("</tt></li>
1586 <li><b>punct_bracket_close_round
</b> Closing brackets
<tt>")"</tt></li>
1587 <li><b>punct_listsep
</b> List item seperator
<tt>","</tt></li>
1588 <li><b>punct_qualifier
</b> Table/Column Qualifier
<tt>"."</tt> </li>
1589 <li><b>punct_queryend
</b> End of query marker
<tt>";"</tt></li>
1590 <li><b>alpha
</b> Applies to all alphabetic classes
</li>
1591 <li><b>alpha_columnType
</b> Identifiers matching a column type
</li>
1592 <li><b>alpha_columnAttrib
</b> Identifiers matching a database/table/column attribute
</li>
1593 <li><b>alpha_functionName
</b> Identifiers matching a MySQL function name
</li>
1594 <li><b>alpha_reservedWord
</b> Identifiers matching any other reserved word
</li>
1595 <li><b>alpha_variable
</b> Identifiers matching a SQL variable
<tt>"@foo"</tt></li>
1596 <li><b>alpha_identifier
</b> All other identifiers
</li>
1597 <li><b>quote
</b> Applies to all quotation mark classes
</li>
1598 <li><b>quote_double
</b> Double quotes
<tt>"</tt></li>
1599 <li><b>quote_single</b> Single quotes <tt>'</tt></li>
1600 <li><b>quote_backtick</b> Backtick quotes <tt>`</tt></li>
1604 <dt><b>$cfg['SQLValidator']['use']</b> boolean</dt>
1606 phpMyAdmin now supports use of the <a href="http://developer.mimer.com/validator/index.htm
">Mimer SQL Validator</a> service,
1607 as originally published on
1608 <a href="http://developers.slashdot.org/article.pl?sid=
02/
02/
19/
1720246">Slashdot</a>.
1610 For help in setting up your system to use the service, see the
1611 <a href="#faqsqlvalidator
">FAQ #6.14</a>.
1615 <dt><b>$cfg['SQLValidator']['username']</b> string<br />
1616 <b>$cfg['SQLValidator']['password']</b> string</dt>
1618 The SOAP service allows you to login with <tt>anonymous</tt>
1619 and any password, so we use those by default.. Instead, if
1620 you have an account with them, you can put your login details
1621 here, and it will be used in place of the anonymous login.
1625 <dt><b>$cfg['DBG']['enable']</b> boolean</dt>
1627 <b>DEVELOPERS ONLY!</b><br />
1628 Enable the DBG extension for debugging phpMyAdmin. Required for profiling
1631 For help in setting up your system to this, see the
1632 <a href="#developersdbg
">Developers</a> section.
1635 <dt><b>$cfg['DBG']['profile']['enable']</b> boolean</dt>
1637 <b>DEVELOPERS ONLY!</b><br />
1638 Enable profiling support for phpMyAdmin. This will append a chunk of data
1639 to the end of every page displayed in the main window with profiling
1640 statistics for that page.<br />
1641 You may need need to increase the maximum execution time for this to
1642 complete successfully.
1645 <dt><b>$cfg['DBG']['profile']['threshold']</b> float (units in milliseconds)</dt>
1647 <b>DEVELOPERS ONLY!</b><br />
1648 When profiling data is displayed, this variable controls the threshold of
1649 display for any profiling data, based on the average time each time has
1650 taken. If it is over the threshold it is displayed, otherwise it is not
1651 displayed. This takes a value in milliseconds. In most cases you don't need
1655 <dt><b>$cfg['ColumnTypes'] </b>array</dt>
1657 All possible types of a MySQL column. In most cases you don't need to
1662 <dt><b>$cfg['AttributeTypes'] </b>array</dt>
1664 Possible attributes for fields. In most cases you don't need to edit
1669 <dt><b>$cfg['Functions'] </b>array</dt>
1671 A list of functions MySQL supports. In most cases you don't need to
1678 <!-- TRANSFORMATIONS -->
1679 <a name="transformations
"></a><br />
1680 <h2>Transformations</h2>
1683 <a href="#transformationsintro
">Introduction</a> -
1684 <a href="#transformationshowto
">Usage</a> -
1685 <a href="#transformationsfiles
">File structure</a> -
1688 <a name="transformationsintro
"></a><br />
1689 <h3>[1. Introduction]</h3>
1691 <p>To enable transformations, you have to setup the column_info table and the proper
1692 directives. Please see the <a href="#config
">Configuration section</a> on how to do so.</p>
1695 <p>You can apply different transformations to the contents of each field. The
1696 transformation will take the content of each field and transform it with
1697 certain rules defined in the selected transformation.</p><br />
1699 <p>Say you have a field 'filename' which contains a filename. Normally you would see
1700 in phpMyAdmin only this filename. Using transformations you can transform that filename
1701 into a HTML link, so you can click inside of the phpMyAdmin structure on the field's
1702 link and will see the file displayed in a new browser window. Using transformation
1703 options you can also specify strings to append/prepend to a string or the format you
1704 want the output stored in.</p><br />
1706 <p>For a general overview of all available transformations and their options, you can
1707 consult your <i><www.your-host.com>/<your-install-dir>/libraries/transformations/overview.php3</i>
1710 <a name="transformationshowto
"></a><br />
1713 <p>Go to your tbl_properties.inc.php3 page (i.e. reached through clicking on the
1714 'properties' link for a table). There you will see three new fields at the end of the
1715 line. They are called 'MIME-type', 'Browser transformation' and 'Transformation options'.</p>
1719 <li>The field 'MIME-type' is a dropdown field. You have the options to leave that field
1720 empty or to use 'auto' [this feature is not yet available]. Please note that
1721 transformations are inactive as long as no mime-type is selected.</li>
1723 <li>The field 'Browser transformation' is a drop-down field. You can choose from a
1724 hopefully growing amount of pre-defined transformations. See below for information on
1725 how to build your own transformation.<br />
1727 There are global transformations and mimetype-bound transformations. Global transformations
1728 can be used for any mimetype. They will take the mimetype, if necessary, into regard.
1729 Mimetype-bound transformations usually only operate on a certain mimetype. There are
1730 transformations which operate on the main mimetype (like 'image'), which will most likely
1731 take the subtype into regard, and those who only operate on a
1732 specific subtype (like 'image/jpeg').<br />
1734 You can use transformations on mimetypes for which the function was not defined for. There
1735 is no security check for you selected the right transformation, so take care of what the
1736 output will be like.</li>
1738 <li>The field 'Transformation options' is a free-type textfield. You have to enter
1739 transform-function specific options here. Usually the transforms can operate with default
1740 options, but it is generally a good idea to look up the overview to see which options are
1743 Much like the ENUM/SET-Fields, you have to split up several options using the format
1744 'a','b','c',...(NOTE THE MISSING BLANKS). This is because internally the options will be
1745 parsed as an array, leaving the first value the first element in the array, and so
1748 If you want to specify a MIME character set you can define it in the transformation_options.
1749 You have to put that outside of the pre-defined options of the specific mime-transform,
1750 as the last value of the set. Use the format "'; charset=XXX'
". If you use a transform,
1751 for which you can specify 2 options and you want to append a character set, enter "'first
1752 parameter','second parameter','charset=us-ascii'
". You can, however use the defaults for
1753 the parameters: "'','','charset=us-ascii'
".</li>
1756 <a name="transformationsfiles
"></a><br />
1757 <h3>[3. File structure]</h3>
1759 <p>All mimetypes and their transformations are defined through single files in
1760 the directory 'libraries/transformations/'.</p><br />
1762 <p>They are stored in files to ease up customization and easy adding of new
1763 transformations.</p><br />
1765 <p>Because the user cannot enter own mimetypes, it is kept sure that transformations
1766 always work. It makes no sense to apply a transformation to a mimetype, the
1767 transform-function doesn't know to handle.</p><br />
1769 <p>One can, however, use empty mime-types and global transformations which should work
1770 for many mimetypes. You can also use transforms on a different mimetype they where built
1771 for, but pay attention to option usage as well as what the transformation does to your
1774 <p>There is a basic file called 'global.inc.php3'. This function can be included by
1775 any other transform function and provides some basic functions.</p><br />
1777 <p>There are 5 possible file names:</p>
1780 <li>A mimetype+subtype transform:<br /><br />
1782 [mimetype]_[subtype]__[transform].inc.php3<br /><br />
1784 Please not that mimetype and subtype are separated via '_', which shall not be
1785 contained in their names. The transform function/filename may contain only
1786 characters which cause no problems in the file system as well as the PHP function
1787 naming convention.<br /><br />
1789 The transform function will the be called 'PMA_transform_[mimetype]_[subtype]__[transform]()'.<br /><br />
1791 <b>Example:</b><br /><br />
1793 text_html__formatted.inc.php3<br />
1794 PMA_transform_text_html__formatted()</li>
1796 <li>A mimetype (w/o subtype) transform:<br /><br />
1798 [mimetype]__[transform].inc.php3<br /><br />
1800 Please note that there are no single '_' characters.
1801 The transform function/filename may contain only characters which cause no problems
1802 in the file system as well as the PHP function naming convention.<br /><br />
1804 The transform function will the be called 'PMA_transform_[mimetype]__[transform]()'.<br /><br />
1806 <b>Example:</b><br /><br />
1808 text__formatted.inc.php3<br />
1809 PMA_transform_text__formatted()</li>
1811 <li>A mimetype+subtype without specific transform function<br /><br />
1813 [mimetype]_[subtype].inc.php3<br /><br />
1815 Please note that there are no '__' characters in the filename. Do not use special
1816 characters in the filename causing problems with the file system.<br /><br />
1818 No transformation function is defined in the file itself.<br /><br />
1820 <b>Example:</b><br /><br />
1822 text_plain.inc.php3<br />
1825 <li>A mimetype (w/o subtype) without specific transform function<br /><br />
1827 [mimetype].inc.php3<br /><br />
1829 Please note that there are no '_' characters in the filename. Do not use special
1830 characters in the filename causing problems with the file system.<br /><br />
1832 No transformation function is defined in the file itself.<br /><br />
1834 <b>Example:</b><br /><br />
1839 <li>A global transform function with no specific mimetype<br /><br />
1841 global__[transform].inc.php3<br /><br />
1843 The transform function will the be called 'PMA_transform_global__[transform]()'.<br /><br />
1845 <b>Example:</b><br /><br />
1847 global__formatted<br />
1848 PMA_transform_global__formatted()</li>
1852 <p>So generally use '_' to split up mimetype and subtype, and '__' to provide a
1853 transform function.</p><br />
1855 <p>All filenames containing no '__' in themselves are not shown as valid transform
1856 functions in the dropdown.</p><br />
1858 <p>Please see the libraries/transformations/TEMPLATE file for adding your own transform
1859 function. See the libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
1860 without a transform function. Also note the introduction of a function description in
1861 the language files. For each function a $strTransformation_[filename without .inc.php3]
1862 has to exist.</p><br />
1864 <p>You can use the template generator to generate new functions and entries in the
1865 language file.</p><br />
1867 <p>To create a new transform function please see libraries/transformations/template_generator.sh.
1868 To create a new, empty mimetype please see libraries/transformations/template_generator_mimetype.sh.</p><br />
1871 <a name="faq
"></a><br />
1872 <h2>FAQ - Frequently Asked Questions</h2>
1875 <a href="#faqserver
">Server</a> -
1876 <a href="#faqconfig
">Configuration</a> -
1877 <a href="#faqlimitations
">Limitations</a> -
1878 <a href="#faqmultiuser
">Multi-user</a> -
1879 <a href="#faqbrowsers
">Browsers</a> -
1880 <a href="#faqusing
">Usage tips</a> -
1881 <a href="#faqproject
">Project</a> -
1884 <a name="faqserver
"></a><br />
1885 <h3>[1. Server]</h3>
1888 [1.1] I'm running PHP 4+ and my server is crashing each time a specific
1889 action is required or phpMyAdmin sends a blank page or a page full of
1890 cryptic characters to my browser, what can I do?
1893 There are some known PHP bugs with output buffering and compression.<br />
1894 Try to set the <tt>$cfg['OBGzip']</tt> directive to <tt>FALSE</tt> in your
1895 <i>config.inc.php or .php3</i> file and the
1896 <tt>zlib.output_compression</tt> directive to <tt>Off</tt> in your php
1897 configuration file.<br />
1898 Furthermore, we know about such problems connected to the release
1899 candidates of PHP 4.2.0 (tested with PHP 4.2.0 RC1 to RC4) together with
1900 MS Internet Explorer. Please upgrade to the release version PHP 4.2.0.
1904 [1.2] My Apache server crashes when using phpMyAdmin.
1907 You should first try the latest versions of Apache (and possibly MySQL).
1909 See also the other FAQ entry about PHP bugs with output buffering.
1911 If your server keeps crashing, please ask for help in the various
1912 Apache support groups.
1916 [1.3] I'm running phpMyAdmin with "cookie
" authentication mode under
1917 PHP 4.2.0 or 4.2.1 loaded as an Apache 2+ module but can't enter the
1918 script: I'm always displayed the login screen.
1921 This is a known PHP bug (see this
1922 <a href="http://bugs.php.net/bug.php?id=
16626">bug report</a>) from the
1923 official PHP bug database. It means there is and won't be any phpMyAdmin
1924 fix against it because there is no way to code a fix.
1928 [1.4] Using phpMyAdmin on IIS, I'm displayed the error message:
1929 "The specified CGI application misbehaved by not returning a
1930 complete set of HTTP headers...".
1933 You just forgot to read the <i>install.txt</i> file from the php
1934 distribution. Have a look at the last message in this
1935 <a href="http://bugs.php.net/bug.php?id=
12061">bug report</a> from the
1936 official PHP bug database.
1940 [1.5] Using phpMyAdmin on IIS, I'm facing crashes and/or many error
1941 messages with the HTTP or advanced authentication mode.
1944 This is a known problem with the PHP ISAPI filter: it's not so stable. For
1945 some more information and complete testings see the messages posted by
1946 André B. aka "djdeluxe76" in
1947 <a href="http://www.phpwizard.net/phorum/read.php?f=
1&i=
6624&t=
6300">this thread</a>
1948 from the phpWizard forum.<br />
1949 Please use instead the cookie authentication mode.
1953 [1.6] I can't use phpMyAdmin on PWS: nothing is displayed!</h4>
1955 This seems to be a PWS bug. Filippo Simoncini found a workaround (at this
1956 time there is no better fix): remove or comment the <tt>DOCTYPE</tt>
1957 declarations (2 lines) from the scripts <i>header.inc.php3</i>,
1958 <i>header_printview.inc.php3</i>, <i>index.php3</i>, <i>left.php3</i> and
1959 <i>libraries/common.lib.php3</i>.
1963 [1.7] How can I GZip or Bzip a dump or a CSV export. It does not seem to
1967 These features are based on the <tt>gzencode()</tt> and
1968 <tt>bzcompress()</tt> PHP functions to be more independent of the platform
1969 (Unix/Windows, Safe Mode or not, and so on).
1970 So, you must have PHP4 >= 4.0.4 and Zlib/Bzip2 support
1971 (<tt>--with-zlib</tt> and <tt>--with-bz2</tt>).<br />
1972 We faced PHP crashes when trying to download a dump with MS Internet
1973 Explorer when phpMyAdmin is run with a release candidate of PHP 4.2.0. In
1974 this case you should switch to the release version of PHP 4.2.0.
1978 [1.8] I cannot insert a text file in a table, and I get an error about
1979 safe mode being in effect.
1982 Your uploaded file is saved by PHP in the "upload dir", as
1983 defined in <i>php.ini</i> by the variable <tt>upload_tmp_dir</tt> (usually
1984 the system default is <i>/tmp</i>).
1986 We recommend the following setup for Apache servers running in safe mode,
1987 to enable uploads of files while being reasonably secure:
1990 <li>create a separate directory for uploads:
1991 <tt>mkdir /tmp/php</tt></li>
1992 <li>give ownership to the Apache server's user.group:
1993 <tt>chown apache.apache /tmp/php</tt></li>
1994 <li>give proper permission: <tt>chmod 600 /tmp/php</tt></li>
1995 <li>put <tt>upload_tmp_dir = /tmp/php</tt> in php.ini</li>
1996 <li>restart Apache</li>
2000 [1.9] I'm having troubles when uploading files. In general file uploads
2001 don't work on my system and uploaded files have a <tt>Content-Type:</tt>
2002 header in the first line.
2005 It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat 7.0
2006 and you updated your PHP RPM to php-4.0.4pl1-3.i386.rpm, didn't you?
2008 So the problem is that this package has a serious bug that was corrected
2009 ages ago in PHP (2001-01-28: see
2010 <a href="http://www.php.net/bugs.php?id=
8966">PHP's bug tracking system</a>
2011 for more details). The problem is that the bugged package is still
2012 available though it was corrected (see
2013 <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=
24933">RedHat's BugZilla</a>
2017 <a href="http://www.redhat.com/swr/i386/php-
4.0.4pl1-
9.i386.html
">the fixed package (4.0.4pl1-9)</a>
2018 and the problem should go away.
2020 And that fixes the \r\n problem with file uploads!
2024 [1.10] I'm having troubles when uploading files with phpMyAdmin running
2025 on a secure server. My browser is Internet Explorer and I'm using the
2029 As suggested by "Rob M" in the phpWizard forum, add this line to
2030 your <i>httpd.conf</i>:<br />
2031 <tt>SetEnvIf User-Agent ".*MSIE.*
" nokeepalive ssl-unclean-shutdown</tt><br />
2032 It seems to clear up many problems between Internet Explorer and SSL.
2036 [1.11] I get an 'open_basedir restriction' while uploading a file from
2040 Since version 2.2.4, phpMyAdmin supports servers with open_basedir
2041 restrictions. Assuming that the restriction allows you to open files in the
2042 current directory ('.'), all you have to do is create a 'tmp' directory
2043 under the phpMyAdmin install directory, with permissions 777 and the same
2044 owner as the owner of your phpMyAdmin directory. The uploaded files will
2045 be moved there, and after execution of your SQL commands, removed.
2049 [1.12] I have lost my MySQL root password, what can I do?
2052 The MySQL manual explains how to
2053 <a href="http://www.mysql.com/doc/R/e/Resetting_permissions.html
">
2054 reset the permissions</a>.
2058 [1.13] I get an error 'No SQL query' when trying to execute a bookmark.
2061 If PHP does not have read/write access to its <tt>upload_tmp_dir</tt>, it
2062 cannot access the uploaded query.
2066 [1.14] I get an error 'No SQL query' when trying to submit a query from
2067 the convenient text area.
2070 Check the <tt>post_max_size</tt> directive from your PHP configuration file
2071 and try to increase it.
2075 [1.15] I have problems with <i>mysql.user</i> field names.
2078 In older MySQL versions, the <tt>User</tt> and <tt>Password</tt> fields
2079 were named <tt>user</tt> and <tt>password</tt>. Please modify your field
2080 names to align with current standards.
2083 [1.16] I cannot upload big dump files.
2086 The first things to check (or ask your host provider to check) are the
2087 values of <tt>upload_max_filesize</tt>, <tt>memory_limit</tt> and
2088 <tt>post_max_size</tt> in the <i>php.ini</i> configuration file.
2090 All of these three settings limit the maximum size of data that can be
2091 submitted and handled by PHP. One user also said that post_max_size
2092 and memory_limit need to be larger than upload_max_filesize.
2096 [1.17] Does phpMyAdmin support MySQL 4.1?
2099 Because of a major change in the definition syntax of string field types,
2100 this version of phpMyAdmin probably won't work correctly with
2101 MySQL >= 4.1.0! We will work on the support as soon as
2102 MySQL 4.1.0 is released.
2106 [1.18] I'm running MySQL <= 4.0.1 having
2107 <tt>lower_case_table_names</tt> set to 1. If I create a new table with a
2108 capital letter in its name it is changed to lowercase as it should. But
2109 if I try to DROP this table MySQL is unable to find the corresponding
2113 This is a bug of MySQL <= 4.0.1. Please upgrade to at least
2114 MySQL 4.0.2 or turn off your <tt>lower_case_table_names</tt>
2119 [1.19] I can't run the "display relations" feature because the
2120 script seems not to know the font face I'm using!
2123 The "FPDF" library we're using for this feature requires some
2124 special files to use font faces.<br />
2125 Please refers to the
2126 <a href="http://www.fpdf.org/
" target="_blank
">FPDF manual</a> to build
2130 <a name="faqmysql
"></a><br />
2132 [1.20] I receive the error "cannot load MySQL extension, please
2133 check PHP Configuration".
2136 To connect to a MySQL server, PHP needs a set of MySQL functions called
2137 "MySQL extension".
2138 This extension may be part of the PHP server (compiled-in), otherwise it
2139 needs to be loaded dynamically. Its name is probably <i>mysql.so</i> or
2140 <i>mysql.dll</i>. phpMyAdmin tried to load the extension but failed.
2142 Usually, the problem is solved by installing a software package called
2143 "PHP-MySQL" or something similar.
2147 [1.21] I am running the CGI version of PHP under Unix, and I cannot
2148 login using cookie auth.
2151 In <i>php.ini</i>, set <tt>mysql.max_links</tt> higher than 1.
2155 [1.22] I don't see the "Location of text file" field, so
2159 This is most likely because in <i>php.ini</i>, your <tt>file_uploads</tt>
2160 parameter is not set to "on".
2164 [1.23] I'm running MySQL on a Win32 machine. Each time I create a new
2165 table the table and field names are changed to lowercase!
2168 This happens because the MySQL directive <tt>lower_case_table_names</tt>
2169 defaults to 1 (<tt>ON</tt>) in the Win32 version of MySQL. You can change
2170 this behavior by simply changing the directive to 0 (<tt>OFF</tt>):<br />
2171 Just edit you <tt>my.ini</tt> file that should be located in your Windows
2172 directory and add the following line to the group [mysqld]:<br />
2173 <tt>set-variable = lower_case_table_names=0</tt><br />
2174 Next, save the file and restart the MySQL service. You can always check the
2175 value of this directive using the query<br />
2176 <tt>SHOW VARIABLES LIKE 'lower_case_table_names';</tt>
2180 [1.24] Some characters are being truncated in my queries, or I get
2181 characters randomly added. I am running PHP 4.2.3.
2185 <a href="http://bugs.php.net/bug.php?id=
19404">PHP 4.2.3 bug</a>.
2189 [1.25] I am running Apache with mod_gzip-1.3.26.1a on Windows XP,
2190 and I get problems, such as undefined variables when I run a SQL query.
2193 A tip from Jose Fandos: put a comment on the following two lines
2194 in httpd.conf, like this:<br />
2195 <tt># mod_gzip_item_include file \.php$</tt><br />
2196 <tt># mod_gzip_item_include mime "application/x-httpd-php.*
"</tt><br />
2197 as this version of mod_gzip on Apache (Windows) has problems handling
2198 PHP scripts. Of course you have to restart Apache.
2202 [1.26] I just installed phpMyAdmin in my document root of IIS but
2203 I get the error "No input file specified" when trying to
2207 This is a permission problem. Right-click on the phpmyadmin folder
2208 and choose properties. Under the tab Security, click on "Add"
2209 and select the user "IUSER_machine" from the list. Now set his
2210 permissions and it should work.
2214 [1.27] I get empty page when I want to view huge page (eg.
2215 db_details_structure.php3 with plenty of dabases).
2218 This is a <a href="http://bugs.php.net/
21079">PHP bug</a> that occur when
2219 GZIP output buffering enabled. If you turn off it (by <code>$cfg['OBGzip']
2220 = FALSE</code> in config.inc.php3), it should work. This bug will be fixed
2225 [1.28] My MySQL server sometimes refuses queries and returns the message
2226 'Errorcode: 13'. What does this mean?
2229 This can happen due to a MySQL bug when having database / table names with
2230 upper case characters although <tt>lower_case_table_names</tt> is set to 1.
2231 To fix this, turn off this directive, convert all database and table names
2232 to lower case and turn it on again. Alternatively, there's a bug-fix
2233 available starting with MySQL 3.23.56 / 4.0.11-gamma.
2236 <a name="faq-
1-
29"></a>
2238 [1.29] When I create a table or modify a field, I get an error
2239 and the fields are duplicated.
2242 It is possible to configure Apache in such a way that PHP has problems
2243 interpreting .php files.
2245 The problems occur when two different (and conflicting) set of directives
2249 SetOutputFilter PHP<br />
2250 SetInputFilter PHP<br />
2255 AddType application/x-httpd-php .php
2258 In the case we saw, one set of directives was in <tt>httpd.conf</tt>, while
2259 the other set was in <tt>php.conf</tt>.<br />
2260 The recommended way is with <tt>AddType</tt>, so just comment out
2261 the first set of lines and restart Apache:
2264 #SetOutputFilter PHP<br />
2265 #SetInputFilter PHP<br /></b>
2269 <a name="faqconfig
"></a><br />
2270 <h3>[2. Configuration]</h3>
2273 [2.1] The error message "Warning: Cannot add header information -
2274 headers already sent by ..." is displayed, what's the problem?
2277 Edit your <i>config.inc.php or .php3</i> file and ensure there is nothing
2278 (I.E. no blank lines, no spaces, no characters...) neither before the
2279 <tt><?php</tt> tag at the beginning, neither after the <tt>?></tt>
2284 [2.2] phpMyAdmin can't connect to MySQL. What's wrong?
2287 Either there is an error with your PHP setup or your username/password is
2288 wrong. Try to make a small script which uses mysql_connect and see if it
2289 works. If it doesn't, it may be you haven't even compiled MySQL support
2294 [2.3] The error message "Warning: MySQL Connection Failed: Can't
2295 connect to local MySQL server through socket '/tmp/mysql.sock'
2296 (111)..." is displayed. What can I do?
2299 For RedHat users, Harald Legner suggests this on the mailing list:
2301 On my RedHat-Box the socket of MySQL is <i>/var/lib/mysql/mysql.sock</i>.
2302 In your php.ini you will find a line
2304 <tt>mysql.default_socket = /tmp/mysql.sock</tt>
2308 <tt>mysql.default_socket = /var/lib/mysql/mysql.sock</tt>
2310 Then restart apache and it will work.
2312 Here is a fix suggested by Brad Ummer in the phpwizard forum:
2316 First, you need to determine what socket is being used by MySQL.
2318 To do this, telnet to your server and go to the MySQL bin directory. In
2319 this directory there should be a file named <i>mysqladmin</i>. Type
2320 <tt>./mysqladmin variables</tt>, and this should give you a bunch of
2321 info about your MySQL server, including the socket
2322 (<i>/tmp/mysql.sock</i>, for example).
2325 Then, you need to tell PHP to use this socket.<br />Assuming you are
2326 using PHP 3.0.10 or better, you can specify the socket to use when you
2327 open the connection. To do this in phpMyAdmin, you need to complete the
2328 socket information in the config.inc.php3.<br />
2330 <tt>$cfg['Servers'][$i]['socket'] = '/tmp/mysql.sock';</tt>
2334 Have also a look at the
2335 <a href="http://www.mysql.com/doc/C/a/Can_not_connect_to_server.html
" target="_blank
">
2336 corresponding section of the MySQL documentation</a>.
2340 [2.4] Nothing is displayed by my browser when I try to run phpMyAdmin,
2344 Try to set the <tt>$cfg['OBGZip']</tt> directive to <tt>FALSE</tt> in the
2345 phpMyAdmin configuration file. It helps sometime.<br />
2346 Also have a look at your PHP version number: if it contains
2347 "4.0b..." it means you're running a beta version of PHP. That's
2348 not a so good idea, please upgrade to a plain revision.
2352 [2.5] Each time I want to insert or change a record or drop a database
2353 or a table, an error 404 (page not found) is displayed or, with HTTP or
2354 cookie authentication, I'm asked to login again. What's wrong?
2357 Check the value you set for the <tt>$cfg['PmaAbsoluteUri']</tt> directive
2358 in the phpMyAdmin configuration file.
2362 [2.6] I get an "Access denied for user: 'root@localhost' (Using
2363 password: YES)"-error when trying to access a MySQL-Server on a
2364 host which is port-forwarded for my localhost
2367 When you are using a port on your localhost, which you redirect via
2368 port-forwarding to another host, MySQL is not resolving the localhost
2370 Erik Wasser explains: The solution is: if your host is "localhost"
2371 MySQL (the commandline tool 'mysql' as well) always tries to use the socket
2372 connection for speeding up things. And that doesn't work in this configuration
2373 with port forwarding.<br />
2374 If you enter "127.0.0.1" as hostname, everything is right and MySQL uses the
2379 <a name="faqlimitations
"></a><br />
2380 <h3>[3. Known limitations]</h3>
2381 <a name="login_bug
"></a><br />
2383 [3.1] When using HTTP authentication, an user who logged out can not
2384 relogin in with the same nick.
2387 This is related to the authentication mechanism (protocol) used by
2388 phpMyAdmin. We plan to change it as soon as we may find enough free time
2389 to do it, but you can bypass this problem: just close all the opened
2390 browser windows and then go back to phpMyAdmin. You should be able to
2395 [3.2] When dumping a large table in compressed mode, I get a memory
2396 limit error or a time limit error.
2399 As of version 2.2.4, we build the compressed dump in memory, so large
2400 tables dumps may hang. The only alternative we can think about (using
2401 system calls to mysqldump then gzip or bzip2) would not be applicable in
2402 environments where PHP is in safe mode: access to system programs is
2403 is limited by the system administrator, and time limit is enforced.
2407 [3.3] With InnoDB tables, I lose foreign key relationships when I rename
2411 This seems to be a InnoDB bug (fixed in MySQL 3.23.50?). However, keep in
2412 mind that phpMyAdmin as of version 2.3.0 does not support InnoDB.
2416 [3.4] I am unable to import dumps I created with the mysqldump tool
2417 bundled with the MySQL server distribution.
2420 The problem is that mysqldump creates invalid comments like this:
2425 -- Host: localhost Database: database
2426 ---------------------------------------------------------
2427 -- Server version 3.23.54
2430 The invalid part of the code is the horizontal line made of dashes that
2431 appears once in every dump created with mysqldump. If you want to run your
2432 dump you have to turn it into valid MySQL. This means, you have to add a
2433 whitespace after the first to dashes of the line or add a # before it:
2436 -- -------------------------------------------------------<br />
2440 #---------------------------------------------------------
2445 <a name="faqmultiuser
"></a><br />
2446 <h3>[4. ISPs, multi-user installations ]</h3>
2449 [4.1] I'm an ISP. Can I setup one central copy of phpMyAdmin or do I
2450 need to install it for each customer.
2453 Since version 2.0.3, you can setup a central copy of phpMyAdmin for all
2454 your users. The development of this feature was kindly sponsored by
2456 This requires a properly setup MySQL user management and phpMyAdmin
2457 HTTP or cookie authentication. See the install section on
2458 "Using HTTP authentication".
2462 [4.2] What's the preferred way of making phpMyAdmin secure against evil
2466 This depends on your system.<br />
2467 If you're running a server which cannot be accessed by other people, it's
2468 sufficient to use the directory protection bundled with your webserver
2469 (with Apache you can use <i>.htaccess</i> files, for example).<br />
2470 If other people have telnet access to your server, you should use
2471 phpMyAdmin's HTTP authentication feature.
2477 Your <i>config.inc.php3</i> file should be <tt>chmod 660</tt>.
2480 All your phpMyAdmin files should be chown phpmy.apache, where phpmy
2481 is a user whose password is only known to you, and apache is the
2482 group under which Apache runs.
2485 You should use PHP safe mode, to protect from other users that try
2486 to include your <i>config.inc.php3</i> in their scripts.
2491 [4.3] I get errors about not being able to include a file in
2492 <i>/lang</i> or in <i>/libraries</i>.
2495 Check <i>php.ini</i>, or ask your sysadmin to check it. The
2496 <tt>include_path</tt> must contain "." somewhere in it, and
2497 <tt>open_basedir</tt>, if used, must contain "." and
2498 "./lang" to allow normal operation of phpMyAdmin.
2501 [4.4] phpMyAdmin always gives "Access denied" when using HTTP
2505 This could happen for several reasons:
2509 <tt>$cfg['Servers'][$i]['controluser']</tt> and/or
2510 <tt>$cfg['Servers'][$i]['controlpass']</tt> are wrong.
2513 The username/password you specify in the login-dialog are invalid.
2516 You have already setup a security mechanism for the
2517 phpMyAdmin-directory, eg. a .htaccess file. This would interfere with
2518 phpMyAdmin's authentication, so remove it.
2523 [4.5] Is it possible to let users create their own databases?
2526 Starting with 2.2.5, in the user management page, you can enter a wildcard
2527 database name for a user (for example "joe%"),
2528 and put the privileges you want. For example,
2529 adding <tt>SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER</tt>
2530 would let a user create/manage his/her database(s).
2534 [4.6] How can I use the Host-based authentication additions?
2537 If you have existing rules from an old .htaccess file, you can take them
2538 and add a username between the <tt>'deny'</tt>/<tt>'allow'</tt> and
2539 <tt>'from'</tt> strings. Using the username wildcard of <tt>'%'</tt> would
2540 be a major benefit here if your installation is suited to using it. Then
2541 you can just add those updated lines into the
2542 <tt>$cfg['Servers'][$i]['AllowDeny']['rules']</tt> array.
2544 If you want a pre-made sample, you can try this fragment. It stops the
2545 'root' user from logging in from any networks other than the private
2549 //block root from logging in except from the private networks<br />
2550 $cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';<br />
2551 $cfg['Servers'][$i]['AllowDeny']['rules'] = array(<br />
2552 'deny root from all',<br />
2553 'allow root from localhost',<br />
2554 'allow root from 10.0.0.0/8',<br />
2555 'allow root from 192.168.0.0/16',<br />
2556 'allow root from 172.16.0.0/12',<br />
2557 );
2561 <a name="faqbrowsers
"></a><br />
2562 <h3>[5. Browsers or client OS]</h3>
2565 [5.1] I get an out of memory error, and my controls are non-functional,
2566 when trying to create a table with more than 14 fields.
2569 We could reproduce this problem only under Win98/98SE. Testing under
2570 WinNT4 or Win2K, we could easily create more than 60 fields.
2572 A workaround is to create a smaller number of fields, then come back to
2573 your table properties and add the other fields.
2577 [5.2] With Xitami 2.5b4, phpMyAdmin won't process form fields.
2580 This is not a phpMyAdmin problem but a Xitami known bug: you'll face it
2581 with each script/website that use forms.<br />
2582 Upgrade or downgrade your Xitami server.
2586 [5.3] I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).
2589 With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except that
2590 the proposed file name for the dump is always 'tbl_dump.php'. Bzip2 dumps
2591 don't seem to work.<br />
2593 With Konqueror 2.2.1: plain dumps work; zip dumps are placed into
2594 the user's temporary directory, so they must be moved before closing
2595 Konqueror, or else they disappear. GZip dumps give an error message.<br />
2597 Testing needs to be done for Konqueror 2.2.2.<br />
2601 [5.4] I can't use the cookie authentication mode because Internet
2602 Explorer never stores the cookies.
2605 MS Internet Explorer seems to be really buggy about cookies, at least till
2606 version 6. And thanks to Andrew Zivolup we've traced also a PHP 4.1.1 bug
2609 Then, if you're running PHP 4.1.1, try to upgrade or downgrade... it may
2614 [5.5] In Internet Explorer 5.0, I get JavaScript errors when browsing my
2618 Upgrade to at least Internet Explorer 5.5 SP2.<br />
2622 [5.6] In Internet Explorer 5.0, 5.5 or 6.0, I get an error when trying
2623 to modify a row in a table with many fields, or with a text field
2626 Your table neither have a primary key nor an unique one, so we must use a
2627 long URL to identify this row. There is a limit on the length of the URL in
2628 those browsers, and this not happen in Netscape, for example. The
2629 workaround is to create a primary or unique key, or use another browser.
2634 [5.7] I refresh (reload) my browser, and come back to the welcome
2638 Some browsers support right-clicking into the frame you want to refresh,
2639 just do this in the right frame.<br />
2643 [5.8] With Mozilla 0.9.7 I have problems sending a query modified in the
2647 Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
2648 Mozilla versions.<br />
2652 [5.9] With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
2653 whitespace in the SQL-Query edit area: the page scrolls down.
2656 This is a Mozilla bug (see bug #26882 at
2657 <a href="http://bugzilla.mozilla.org/
" target="_blank
">BugZilla</a>).<br />
2661 [5.10] With Netscape 4.75 I get empty rows between each row of data in a
2665 This is a known Netscape 4.75 bug: it adds some line feeds when exporting
2666 data in octet-stream mode. Since we can't detect the specific Netscape
2667 version, we cannot workaround this bug.
2671 [5.11] Extended-ASCII characters like German umlauts are displayed
2675 Please ensure that you have set your browser's character set to the one of the
2676 language file you have selected on phpMyAdmin's start page.
2677 Alternatively, you can try the auto detection mode that is supported by the
2678 recent versions of the most browsers.
2682 [5.12] Apple OS X: Safari browser changes special characters to
2686 This issue has been reported by a OS X user, who adds that Chimera,
2687 Netscape and Mozilla do not have this problem.
2691 [5.13] With Internet Explorer 5.5 or 6, and HTTP authentication type,
2692 I cannot manage two servers: I login to the first one, then the other one,
2693 but if I switch back to the first, I have to login on each operation.
2696 This is a bug in Internet Explorer, other browsers do not behave this way.
2699 <a name="faqusing
"></a><br />
2700 <h3>[6. Using phpMyAdmin]</h3>
2703 [6.1] I can't insert new rows into a table / I can't create a table
2704 - MySQL brings up a SQL-error.
2707 Examine the SQL error with care. Often the problem is caused by
2708 specifying a wrong field-type.<br />
2709 Common errors include:
2712 <li>Using <tt>VARCHAR</tt> without a size argument</li>
2713 <li>Using <tt>TEXT</tt> or <tt>BLOB</tt> with a size argument</li>
2716 Also, look at the syntax chapter in the MySQL manual to confirm that your
2721 [6.2] When I create a table, I click the Index checkbox for 2 fields and
2722 phpMyAdmin generates only one index with those 2 fields.
2725 In phpMyAdmin 2.2.0 and 2.2.1, this is the way to create a multi-fields
2726 index. If you want two indexes, create the first one when creating the
2727 table, save, then display the table properties and click the Index link to
2728 create the other index.
2732 [6.3] How can I insert a null value into my table?
2735 Since version 2.2.3, you have a checkbox for each field that can be null.
2736 Before 2.2.3, you had to enter "null", without the quotes, as the
2741 [6.4] How can I backup my database or table?
2744 Click on a database or table name in the left frame, the properties will be
2745 displayed. Then on the menu, click "Export", you can dump
2746 the structure, the data, or both. This will generate standard SQL
2747 statements that can be used to recreate your database/table.
2749 You will need to choose "Save as file", so that phpMyAdmin can
2750 transmit the resulting dump to your station. Depending on your PHP
2751 configuration, you will see options to compress the dump. See also the
2752 <tt>$cfg['ExecTimeLimit']</tt> configuration variable.
2754 For additional help on this subject, look for the word "dump" in
2759 [6.5] How can I restore (upload) my database or table using a dump?
2760 How can I run a ".sql" file.
2763 Click on a database name in the left frame, the properties will be
2764 local displayed. Then in the "Run SQL query" section, type in
2765 your dump filename, or use the Browse button. Then click Go.
2767 For additional help on this subject, look for the word "upload"
2772 [6.6] How can I use the relation table in Query-by-example?
2775 Here is an example with the tables persons, towns and countries, all
2776 located in the database mydb. If you don't have a <tt>PMA_relation</tt>
2777 table, create it as explained in the configuration section. Then create the
2781 CREATE TABLE REL_countries (<br />
2782 country_code char(1) NOT NULL default '',<br />
2783 description varchar(10) NOT NULL default '',<br />
2784 PRIMARY KEY (country_code)<br />
2785 ) TYPE=MyISAM;<br />
2787 INSERT INTO REL_countries VALUES ('C', 'Canada');<br />
2789 CREATE TABLE REL_persons (<br />
2790 id tinyint(4) NOT NULL auto_increment,<br />
2791 person_name varchar(32) NOT NULL default '',<br />
2792 town_code varchar(5) default '0',<br />
2793 country_code char(1) NOT NULL default '',<br />
2794 PRIMARY KEY (id)<br />
2795 ) TYPE=MyISAM;<br />
2797 INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');<br />
2798 INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');<br />
2800 CREATE TABLE REL_towns (<br />
2801 town_code varchar(5) NOT NULL default '0',<br />
2802 description varchar(30) NOT NULL default '',<br />
2803 PRIMARY KEY (town_code)<br />
2804 ) TYPE=MyISAM;<br />
2806 INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');<br />
2807 INSERT INTO REL_towns VALUES ('M', 'Montréal');<br />
2810 To setup appropriate links and display information:
2813 <li>on table "REL_persons" click Structure, then Relation view</li>
2814 <li>in Links, for "town_code" choose "REL_towns->code"</li>
2815 <li>in Links, for "country_code" choose "REL_countries->country_code"</li>
2816 <li>on table "REL_towns" click Structure, then Relation view</li>
2817 <li>in "Choose field to display", choose "description"</li>
2818 <li>repeat the two previous steps for table "REL_countries"</li>
2822 Then test like this:
2825 <li>Click on your db name in the left frame</li>
2826 <li>Choose "Query"</li>
2827 <li>Use tables: persons, towns, countries</li>
2828 <li>Click "Update query"</li>
2829 <li>In the fields row, choose persons.person_name and click the
2830 "Show" tickbox </li>
2831 <li>Do the same for towns.description and countries.descriptions in the
2832 other 2 columns</li>
2833 <li>Click "Update query" and you will see in the query box that
2834 the correct joins have been generated</li>
2835 <li>Click "Submit query"</li>
2839 <a name="faqdisplay
"></a><br />
2841 [6.7] How can I use the "display field" feature?
2844 Starting from the previous example, create the PMA_table_info as explained
2845 in the configuration section, then browse your persons table,
2846 and move the mouse over a town code or country code.
2849 <a name="faqpdf
"></a><br />
2851 [6.8] How can I produce a PDF schema of my database?
2854 First you have to fill the "relation", "table_coords"
2855 and "pdf_pages" configuration variables.
2857 Then, think about your schema layout: which tables will go on which pages.
2860 <li>Click on your db name in the left frame</li>
2861 <li>Choose "Structure" in the navigation on top</li>
2862 <li>Choose "Edit PDF Pages" which should be somewhere at the
2863 bottom of the page</li>
2864 <li>Enter the name for a first pdf page and submit</li>
2865 <li>Choose this page to edit</li>
2866 <li>Now add a table you want to show on this page and it's coordinates and
2868 First you will have to guess this coordinates of course, so just expect
2869 to have an area of about 297 * 210 and put the tables coordinates
2870 somewhere in there, you will be able to have a look at what happened
2871 and change them later.<br />
2872 For example, x=100 and y=200 means that the table will be at 200 mm
2873 down and 100 mm right from the upper left corner.<br />
2874 Actually if you have a width of more than 300 or a height of more than
2875 200 than it will automatically be scaled but 300*100 is a good start to
2876 have an idea of what coordinates to use.</li>
2877 <li>After every table you submitted you will have the possibility to submit
2879 <li>When you have entered enough tables Click on your db name in the left
2881 <li>Now, again at the bottom of the page you should be able to choose
2882 "Display PDF schema"<br />
2883 For testing it might be useful to show the grid as well, so you can see
2884 the coordinates used.<br />
2885 Maybe also choose color and submit.</li>
2886 <li>Save the file he will offer you to something like <i>Schema.pdf</i>
2887 (Internet Explorer has some bug there which might make it offer it
2888 without an extension. Under Windows it is important to have the
2889 extension ".pdf", under other OSes you should be fine just
2890 saving the file under the name it offers).</li>
2894 [6.9] phpMyAdmin is changing the type of one of my columns!
2897 No, it's MySQL that is doing
2898 <a href="http://www.mysql.com/doc/S/i/Silent_column_changes.html
">silent column type changing</a>.
2901 <a name="underscore
"></a><br />
2903 [6.10] My database has an underscore in it's name, and when I grant
2904 privileges to a user for this database, a backslash is added before the
2908 This is normal and means that the grant is done only for this database. If
2909 there was no backslash, this would be a wildcard grant, and the
2910 underscore would mean "any character". So, if the database name
2911 is "john_db", the user would get rights to john1db, john2db...
2912 instead of just john_db.<br /><br />
2913 If you really want to grant using a wildcard, there is a dialog box "
2914 Database (wildcards allowed)" for this.
2918 [6.11] What is the curious symbol ø in the statistics pages?
2921 It means "average".
2924 <a name="faqexport
"></a><br />
2926 [6.12] I want to understand some Export options.
2929 "Complete inserts" adds the column names on every INSERT command,
2930 for better documentation (but resulting file is bigger).<br />
2931 "Extended inserts" provides a shorter dump file by using only
2932 once the INSERT verb and the table name.<br />
2933 "Enclose table and field names with backquotes" ensures that
2934 field and table names formed with special characters are protected.<br />
2935 "Include column comments as inline SQL-comments" includes any
2936 column comments set in the PMA-DB in the dump as SQL comments (<i>/* xxx */</i>).<br /></p>
2939 [6.13] I would like to create a database with a dot in its name.
2942 This is a bad idea, because in MySQL the syntax "database.table"
2943 is the normal way to reference a database and table name. Worse, MySQL
2944 will usually let you create a database with a dot, but then you cannot
2945 work with it, nor delete it.<br />
2948 <a name="faqsqlvalidator
"></a><br />
2950 [6.14] How do I set up the SQL Validator?
2953 To use it, you need a very recent version of PHP, 4.3.0 recommended, with
2954 XML, PCRE and PEAR support. On your system command line, run
2955 <tt>"pear install Net_Socket Net_URL HTTP_Request Mail_Mime Net_DIME
2956 SOAP
"</tt> to get the necessary PEAR modules for usage.
2958 If you use it, you should be aware that any SQL statement you
2959 submit will be stored anonymously (database/table/column names,
2960 strings, numbers replaced with generic values). The Mimer SQL
2961 Validator itself, is © 2001 Upright Database Technology.
2962 We utilize it as free SOAP service.
2966 [6.15] I want to add a BLOB field and put an index on it, but MySQL
2967 says "BLOB column '...' used in key specification without a key
2971 The right way to do this, is to create the field without any indexes,
2972 then display the table structure and use the "Create an index"
2973 dialog. On this page, you will be able to choose your BLOB field, and
2974 set a size to the index, which is the condition to create an index on
2980 [6.16] How can I simply move in page with plenty editing fields?
2983 You can use Ctrl+arrows for moving on most pages with plenty editing
2984 fields (table structure changes, row editing, etc.). You can also have
2985 a look at the directive $cfg['DefaultPropDisplay'] ('vertical') and see
2986 if this eases up editing for you.
2991 [6.17] Transformations: I can't enter my own mimetype! WTF is this feature
2995 Slow down :). Defining mimetypes is of no use, if you can't put transformations on them.
2996 Otherwise you could just put a comment on the field. Because entering your own mimetype will
2997 cause serious syntax checking issues and validation, this introduces a high-risk false-user-input
2998 situation. Instead you have to initialize mimetypes using functions or empty mimetype definitions.
3000 Plus, you have a whole overview of available mimetypes. Who knows all those mimetypes by heart so
3001 he/she can enter it at will?
3005 <a name="faqbookmark
"></a>
3007 [6.17] Bookmarks: Where can I store bookmarks? Why can't I see any bookmarks below the query box?
3008 What is this variable for?
3011 Any query you have executed can be stored as a bookmark on the page where the results are displayed.
3012 You will find a button labeled 'Bookmark this query' just at the end of the page.<br />
3013 As soon as you have stored a bookmark, it is related to the database you run the query on. You can
3014 now access a bookmark dropdown on each page, the query box appears on for that database.<br />
3016 Since phpMyAdmin 2.5.0 you are also able to store variables for the bookmarks. Just use the string
3017 <b>/*[VARIABLE]*/</b> anywhere in your query. Everything which is put into the <i>value</i> input
3018 box on the query box page will replace the string "/*[VARIABLE]*/" in your stored query.
3019 Just be aware of that you HAVE to create a valid query, otherwise your query won't be even able to be
3020 stored in the database.<br />
3021 Also remember, that everything else inside the <b>/*[VARIABLE]*/</b> string for your query will remain
3022 the way it is, but will be stripped of the /**/ chars. So you can use:<br /><br />
3023 <code>/*, [VARIABLE] AS myname */</code><br /><br />
3024 which will be expanded to<br /><br />
3025 <code>, VARIABLE as myname</code><br /><br />
3026 in your query, where VARIABLE is the string you entered in the input box. If an empty string is
3027 provided, no replacements are made.<br />
3029 A more complex example. Say you have stored this query:<br /><br />
3030 <code>SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE '%[VARIABLE]%' */</code><br /><br />
3031 Say, you now enter "phpMyAdmin" as the variable for the stored query, the full query will
3033 <code>SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE '%phpMyAdmin%'</code>
3036 You can use multiple occurences of <b>/*[VARIABLE]*/</b> in a single query.<br />
3037 <b>NOTE THE ABSENCE OF SPACES</b> inside the "/**/" construct. Any spaces inserted there
3038 will be later also inserted as spaces in your query and may lead to unexpected results especially when
3039 using the variable expansion inside of a "LIKE ''" expression.<br />
3040 Your initial query which is going to be stored as a bookmark has to yield at least one result row so
3041 you can store the bookmark. You may have that to work around using well positioned "/**/"
3045 <a name="faqproject
"></a><br />
3046 <h3>[7. phpMyAdmin project]</h3>
3049 [7.1] I have found a bug. How do I inform developers?
3052 Our Bug Tracker is located at
3053 <a href="http://sourceforge.net/projects/phpmyadmin/
">http://sourceforge.net/projects/phpmyadmin/</a>
3054 under the Bugs section.
3056 But please first discuss your bug with other users:
3058 <a href="http://sourceforge.net/projects/phpmyadmin/
">
3059 http://sourceforge.net/projects/phpmyadmin/</a> (and choose Forums)
3063 [7.2] I want to translate the messages to a new language or upgrade an
3064 existing language, where do I start?
3067 Always use the current CVS version of your language file.
3068 For a new language, start from <i>english-iso-8859-1.inc.php3</i>. If you
3069 don't know how to get the CVS version, please ask one of the developers.
3071 Please note that we try not to use HTML entities like &eacute; in
3072 the translations, since we define the right character set in the file.
3073 With HTML entities, the text on JavaScript messages would not
3075 However there are some entities that need to be there, for quotes
3076 ,non-breakable spaces, ampersands, less than, greater than.
3078 You can then put your translations, as a zip file to avoid losing special
3079 characters, on the sourceforge.net translation tracker.
3081 It would be a good idea to subscribe to the phpmyadmin-translators mailing
3082 list, because this is where we ask for translations of new messages.
3087 [7.3] I would like to help out with the development of phpMyAdmin. How
3091 The following method is preferred for new developers:
3095 fetch the current CVS tree over anonymous CVS:<br />
3096 <tt>cvs -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin login</tt><br />
3097 [Password: simply press the Enter key]<br />
3098 <tt>cvs -z3 -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin checkout phpMyAdmin</tt><br />
3099 [This will create a new sub-directory named phpMyAdmin]
3105 put the modified files (tar'ed and gzip'ed) inside the patch tracker of
3107 <a href="http://sourceforge.net/projects/phpmyadmin/
" target="_blank
">phpMyAdmin SourceForge account</a>.
3111 Write access to the CVS tree is granted only to experienced developers who
3112 have already contributed something useful to phpMyAdmin.<br />
3113 Also, have a look at the
3114 <a href="#developers
">Developers section</a>.
3118 <a name="developers
"></a><br />
3119 <h2>Developers Information</h2>
3122 phpMyAdmin is Open Source, so you're invited to contribute to it. Many
3123 great features have been written by other people and you too can help to
3124 make phpMyAdmin a useful tool.
3128 If you're planning to contribute source, please read the following
3133 All files include <i>header.inc.php3</i> (layout),
3134 <i>libraries/common.lib.php3</i> (common functions) and
3135 <i>config.inc.php3</i>.
3137 All configuration data belongs in <i>config.inc.php3</i>. Please keep
3138 it free from other code.
3140 Commonly used functions should be added to
3141 <i>libraries/common.lib.php3</i> and more specific ones may be added
3142 within a library stored into the <i>libraries</i> sub-directory.
3145 Obviously, you're free to use whatever coding style you want. But
3146 please try to keep your code as simple as possible: beginners are
3147 using phpMyAdmin as an example application.<br />
3148 As far as possible, we want the scripts to be XHTML1.0 and CSS2
3149 compliant on one hand, they fit the
3150 <a href="http://pear.php.net/
" target="_blank
">PEAR coding standards</a>
3151 on the other hand. Please pay attention to this.
3154 Please try to keep up the file-naming conventions. Table-related stuff
3155 goes to <i>tbl_*.php3</i>, db-related code to <i>db_*.php3</i>,
3156 server-related tools to <i>server_*.php3</i> and so on.
3159 Please don't use verbose strings in your code, instead add the string
3160 (at least) to <i>english-iso-8859-1.inc.php3</i> and print() it out.
3163 If you want to be really helpful, write an entry for the ChangeLog.
3165 <li id="developersdbg
">
3166 The DBG extension (<a href="http://dd.cron.ru/dbg/
" target="_blank
">PHP
3167 Debugger DBG</a>) is now supported by phpMyAdmin for developers to
3168 better debug and profile their code.<br />
3169 Please see the <tt>$cfg['DBG']*</tt> configuration options for more
3171 This is in memoriam of the Space Shuttle Columbia (STS-107) which was
3172 lost during its re-entry into Earth's atmosphere and in memory of the
3173 brave men and women who gave their lives for the people of Earth.
3179 <a name="credits
"></a><br />
3184 phpMyAdmin - Credits
3185 ====================
3187 CREDITS, in chronological order
3188 -------------------------------
3190 - Tobias Ratschiller <tobias.ratschiller_at_maguma.com>
3191 * creator of the phpmyadmin project
3192 * maintainer from 1998 to summer 2000
3194 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca>
3195 * multi-language version
3196 * various fixes and improvements
3197 * project co-administrator
3199 - Olivier Müller <om_at_omnis.ch>
3200 * started SourceForge phpMyAdmin project in March 2001
3201 * sync'ed different existing CVS trees with new features and bugfixes
3202 * multi-language improvements, dynamic language selection
3203 * current project maintainer
3204 * many bugfixes and improvements
3206 - Loïc Chapeaux <lolo_at_phpheaven.net>
3207 * rewrote and optimized javascript, DHTML and DOM stuff
3208 * rewrote the scripts so they fit the PEAR coding standards and
3209 generate XHTML1.0 and CSS2 compliant codes
3210 * improved the language detection system
3211 * many bugfixes and improvements
3213 - Robin Johnson <robbat2_at_users.sourceforge.net>
3214 * database maintence controls
3216 * Host authentication IP Allow/Deny
3217 * DB-based configuration (Not completed)
3220 * many bugfixes and improvements
3222 - Armel Fauveau <armel.fauveau_at_globalis-ms.com>
3224 * multiple dump feature
3228 - Geert Lund <glund_at_silversoft.dk>
3230 * moderator of the phpMyAdmin users forum at phpwizard.net
3232 - Korakot Chaovavanich <korakot_at_iname.com>
3233 * "insert as new row" feature
3235 - Pete Kelly <webmaster_at_trafficg.com>
3236 * rewrote and fix dump code
3239 - Steve Alberty <alberty_at_neptunlabs.de>
3240 * rewrote dump code for PHP4
3241 * mySQL table statistics
3244 - Benjamin Gandon <gandon_at_isia.cma.fr>
3245 * main author of the version 2.1.0.1
3248 - Alexander M. Turek <rabus_at_bugfixes.info>
3250 * MySQL 4 related features
3251 * various small features and fixes
3252 * German language file updates
3254 - Mike Beck <mike.beck_at_ibmiller.de>
3255 * automatic joins in QBE
3256 * links column in printview
3259 - Michal Cihar <nijel_at_users.sourceforge.net>
3260 * enhanced index creation/display feature
3261 * feature to use a different charset for HTML than for MySQL
3262 * Czech language file updates
3264 - Christophe Gesché from the "MySQL Form Generator for PHPMyAdmin"
3265 (http://sourceforge.net/projects/phpmysqlformgen/)
3266 * suggested the patch for multiple table printviews
3268 - Garvin Hicking <hicking_at_faktor-e.de>
3269 * built the patch for vertical display of table rows
3270 * built the Javascript based Query window + SQL history
3271 * Improvement of column/db comments
3272 * (MIME)-Transformations for columns
3273 * Use custom alias names for Databases in left frame
3274 * vertical display of column properties page
3275 * some bugfixes, smaller features
3277 - Yukihiro Kawada <kawada_at_den.fujifilm.co.jp>
3278 * japanese kanji encoding conversion feature
3280 - Piotr Roszatycki <d3xter_at_users.sourceforge.net> and Dan Wilson
3281 * the Cookie authentication mode
3283 - Axel Sander <n8falke_at_users.sourceforge.net>
3284 * table relation-links feature
3286 - Maxime Delorme <delorme.maxime_at_free.fr>
3287 * PDF schema output, thanks also to Olivier Plathey for the
3288 "FPDF" library (see http://www.fpdf.org/).
3290 - Olof Edlund <olof.edlund_at_upright.se>
3291 * SQL validator server
3293 - Ivan R. Lanin <ivanlanin_at_users.sourceforfe.net>
3296 And also to the following people who have contributed minor changes,
3297 enhancements, bugfixes or support for a new language since version 2.1.0:
3299 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
3300 Péter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
3301 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kläger,
3302 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
3303 Bernard M. Piller, Laurent Haas, "Sakamoto", Yuval Sarna,
3304 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
3305 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
3306 Luís V., Martijn W. van der Lee,
3307 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
3308 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, "Manuzhai".
3311 Original Credits of Version 2.1.0
3312 ---------------------------------
3314 This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
3315 to create a web-based interface to MySQL using PHP3. Although I have not
3316 used any of his source-code, there are some concepts I've borrowed from
3317 him. phpMyAdmin was created because Peter told me he wasn't going to
3318 further develop his (great) tool.
3320 - Amalesh Kempf <ak-lsml_at_living-source.com> who contributed the
3321 code for the check when dropping a table or database. He also suggested
3322 that you should be able to specify the primary key on tbl_create.php3. To
3323 version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
3324 well as a bug-report. Plus many smaller improvements.
3325 - Jan Legenhausen <jan_at_nrw.net>: He made many of the changes that
3326 were introduced in 1.3.0 (including quite significant ones like the
3327 authentication). For 1.4.1 he enhanced the table-dump feature. Plus
3329 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca> made phpMyAdmin
3330 language-independent by outsourcing the strings to a separate file. He
3331 also contributed the French translation.
3332 - Alexandr Bravo <abravo_at_hq.admiral.ru> who contributed
3333 tbl_select.php3, a feature to display only some fields from a table.
3334 - Chris Jackson <chrisj_at_ctel.net> added support for MySQL
3335 functions in tbl_change.php3. He also added the
3336 "Query by Example" feature in 2.0.
3337 - Dave Walton <walton_at_nordicdms.com> added support for multiple
3338 servers and is a regular contributor for bug-fixes.
3339 - Gabriel Ash <ga244_at_is8.nyu.edu> contributed the random access
3341 The following people have contributed minor changes, enhancements, bugfixes
3342 or support for a new language:
3343 Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
3344 Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
3345 Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
3348 And thanks to everyone else who sent me email with suggestions, bug-reports
3349 and or just some feedback.
3354 <a name="bottom
"></a><br />
3356 <a href="http://validator.w3.org/check/referer
" target="w3c
">
3357 <img src="http://www.w3.org/Icons/valid-xhtml10
" alt="Valid XHTML
1.0!
" border="0" height="31" width="88" /></a>
3358
3359 <a href="http://jigsaw.w3.org/css-validator/
" target="w3c
">
3360 <img src="http://www.w3.org/Icons/valid-css
" alt="Valid CSS!
" border="0" width="88" height="31" /></a>