update
[phpmyadmin/crack.git] / Documentation.txt
blob5c47cc50d445889c0a4db3cdec23a74a907ced1e
2    ______________________________________________________________________
4    Top  -  Requirements  -  Introduction  -  Installation  -
5    Configuration
6    Transformations  -  FAQ  -  Developers  -  Credits  -  Translators
7    ______________________________________________________________________
9                       phpMyAdmin 2.5.2-dev Documentation
11      * SourceForge phpMyAdmin project page   [ http://www.phpmyadmin.net/
12        ] 
13      * Local documents:
14           + Version history: ChangeLog
15           + General notes: README
16           + License: LICENSE
17      * Documentation version: $Id: Documentation.html,v 1.459 2003/06/08
18        12:55:39 lem9 Exp $
20 Requirements
22      * PHP3, PHP4 or PHP5: phpMyAdmin widely uses the 'str_replace()' PHP
23        function that was added in PHP 3.0.6, but was buggy up until
24        PHP 3.0.8. Then you should not run this script with PHP3 < 3.0.8.
25        PHP also needs to be compiled with MySQL support;
26        If you want to display inline thumbnails of JPEGs, you also need
27        GD2 support in PHP.
28      * MySQL (tested with 3.21.x, 3.22.x, 3.23.x, 4.0.x and 4.1.x);
29        Note: The implemented MySQL 4.1.x support is experimental!
30      * a web-browser (doh!).
32 Introduction
34    phpMyAdmin can manage a whole MySQL server (needs a super-user) as
35    well as a single database. To accomplish the latter you'll need a
36    properly set up MySQL user who can read/write only the desired
37    database. It's up to you to look up the appropriate part in the MySQL
38    manual.
39    Currently phpMyAdmin can:
40      * create and drop databases
41      * create, copy, drop, rename and alter tables
42      * do table maintenance
43      * delete, edit and add fields
44      * execute any SQL-statement, even batch-queries
45      * manage keys on fields
46      * load text files into tables
47      * create (*) and read dumps of tables
48      * export (*) data to CSV, XML and Latex formats
49      * administer multiple servers
50      * manage MySQL users and privileges
51      * check referential integrity
52      * using Query-by-example (QBE), create complex queries automatically
53        connecting required tables
54      * create PDF graphics of your Database layout
55      * search globally in a database or a subset of it
56      * transform stored data into any format using a set of predefined
57        functions, like displaying BLOB-data as image or download-link or
58        ...
59      * communicate in 42 different languages
61    (*)  phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats)
62    dumps and CSV exports if you use PHP4 >= 4.0.4 with Zlib support
63    (--with-zlib) and/or Bzip2 support (--with-bz2).
65 Installation
67    NOTE: phpMyAdmin does not apply any special security methods to the
68    MySQL database server. It is still the system administrator's job to
69    grant permissions on the MySQL databases properly. phpMyAdmin's
70    "Privileges" page can be used for this.
72    Warning for Mac users:if you are on a MacOS version before OS X,
73    StuffIt unstuffs with Mac formats.
74    So you'll have to resave as in BBEdit to Unix style ALL phpMyAdmin
75    scripts before uploading them to your server, as PHP seems not to like
76    Mac-style end of lines character ("\r").
78    Documentation warning: when you see in this document a .php3 file
79    extension, please transpose to .php if you are using a kit with files
80    having this extension.
82    Quick Install:
83     1. Choose and download a distribution kit with the files having the
84        extension (.php3 or .php) depending on the way your web/PHP server
85        interprets those extensions.
86     2. Untar or unzip the distribution (be sure to unzip the
87        subdirectories): tar -xzvf phpMyAdmin_x.x.x.tar.gz in your
88        webserver's document root. If you don't have direct access to your
89        document root, put the files in a directory on your local machine,
90        and, after step 3, transfer the directory on your web server
91        using, for example, ftp.
92     3. Open the file config.inc.php3 in your favorite editor and change
93        the values for host, user, password and authentication mode to fit
94        your environment. Here, "host" means the MySQL server. Also insert
95        the correct value for $cfg['PmaAbsoluteUri']. Have a look at
96        Configuration section for an explanation of all values.
97     4. It is recommended that you protect the directory in which you
98        installed phpMyAdmin (unless it's on a closed intranet, or you
99        wish to use HTTP or cookie authentication), for example with
100        HTTP-AUTH (in a .htaccess file). See the FAQ section for
101        additional information.
102     5. Open the file <www.your-host.com>/<your-install-dir>/index.php3 in
103        your browser. phpMyAdmin should now display a welcome screen and
104        your databases, or a login dialog if using HTTP or cookie
105        authentication mode.
106     6. For a whole set of new features (bookmarks, comments, SQL-history,
107        PDP-generation) you need to create a set of tables in your
108        database. Please look at your scripts/ directory, where you should
109        find a file called create_tables.sql. You can already use your
110        phpMyAdmin to create the tables for you. Please be aware that you
111        may have to have special (administrator) privileges to create the
112        database and tables. After having imported the create_tables.sql
113        file, you should specify the table names in your config.inc.php3
114        file. The directives used for that can be found in the
115        Configuration section.
117    Upgrading from an older version:
118      * Please do not copy your older config.inc.php3 over the new one: it
119        may offer new configuration variables, and the new version may
120        depend on these for normal behavior. It is suggested instead to
121        insert your site values in the new one.
123    Using authentication modes:
124      * HTTP and cookie authentication modes are recommended in a
125        multi-user environment where you want to give users access to
126        their own database and don't want them to play around with others.
127        Nevertheless be aware that MS Internet Explorer seems to be really
128        buggy about cookies, at least till version 6. And PHP 4.1.1 is
129        also a bit buggy in this area!
130        Even in a single-user environment, you might prefer to use HTTP or
131        cookie mode so that your user/password pair are not in clear in
132        the configuration file.
133      * HTTP and cookie authentication modes are more secure: the MySQL
134        password does not need to be set in the phpMyAdmin configuration
135        file (except for the "controluser" -see the Configuration
136        section).
137        However, keep in mind that the password travels in plain text,
138        unless you are using the HTTPS protocol.
139        In cookie mode, we send the password in a temporary cookie, so
140        most browsers should not store the password in their cookie file.
141      * For 'HTTP' and 'cookie' modes, phpMyAdmin needs a controluser that
142        has only the SELECT privilege on the mysql.user (all columns
143        except "Password"), mysql.db (all columns) & mysql.tables_priv
144        (all columns except "Grantor" & "Timestamp") tables.
145        You must specify the details for the controluser in the
146        config.inc.php3 file under the $cfg['Servers'][$i]['controluser']&
147        $cfg['Servers'][$i]['controlpass'] settings.
148        The following example assumes you want to use pma as the
149        controluser and pmapass as the controlpass, but this is only an
150        example: use something else in your file!
151        Of course you have to replace localhost by the webserver's host if
152        it's not the same as the MySQL server's one.
154 GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY 'pmapass';
155 GRANT SELECT (
156     Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
157     Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
158     File_priv, Grant_priv, References_priv, Index_priv, Alter_priv,
159     Show_db_priv, Super_priv, Create_tmp_table_priv, Lock_tables_priv,
160     Execute_priv, Repl_slave_priv, Repl_client_priv
161     ) ON mysql.user TO 'pma'@'localhost';
162 GRANT SELECT ON mysql.db TO 'pma'@'localhost';
163 GRANT SELECT ON mysql.host TO 'pma'@'localhost';
164 GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv)
165     ON mysql.tables_priv TO 'pma'@'localhost';
167        If you are using an old MySQL version (below 4.0.2), please use
168        this query instead of the second one:
170 GRANT SELECT (
171     Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
172     Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
173     File_priv, Grant_priv, References_priv, Index_priv, Alter_priv
174     ) ON mysql.user TO 'pma'@'localhost';
176        ... and if you want to use the many new relation and bookmark
177        features:
179 GRANT SELECT, INSERT, UPDATE, DELETE ON <pma_db> TO 'pma'@'localhost';
181        (this of course requires you to have a special DB for phpMyAdmin,
182        the contents will be explained later)
183        Of course, the above queries only work if your MySQL version
184        supports the GRANT command. This is the case since 3.22.11.
185      * Then each of the true users should be granted a set of privileges
186        on a set of particular databases. Normally you shouldn't give
187        global privileges to an ordinary user, unless you understand the
188        impact of those privileges (for example, you are creating a
189        superuser).
190        For example, to grant the user real_user with all privileges on
191        the database user_base:
192           GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost
193        IDENTIFIED BY 'real_password';
194        What the user may now do is controlled entirely by the MySQL user
195        management system.
196        With HTTP or cookie authentication mode, you don't need to fill
197        the user/password fields inside the $cfg['Servers'] array.
199    'http' authentication mode:
200      * Was called 'advanced' in versions before 2.2.3.
201      * Introduced in 1.3.0, it uses Basic HTTP authentication method and
202        allows you to login as any valid MySQL user.
203      * Is only supported with PHP running as an Apache module, not with
204        CGI.
206    'cookie' authentication mode:
207      * You can use this method as a replacement for the HTTP
208        authentication (for example, if you're running IIS).
209      * Obviously, the user must enable cookies in the browser.
210      * With this mode, the use can truly logout of phpMyAdmin and login
211        back with the same username.
213    'config' authentication mode:
214      * This mode is the less secure one because it requires you to fill
215        the $cfg['Servers'][$i]['user'] and
216        $cfg['Servers'][$i]['password'] fields.
217        But you don't need to setup a "controluser" here: using the
218        $cfg['Servers'][$i]['only_db'] might be enough.
219      * In the ISP FAQ section, there is an entry explaining how to
220        protect your configuration file.
221      * For additional security in this mode, you may wish to consider the
222        Host authentication $cfg['Servers'][$i]['AllowDeny']['order'] and
223        $cfg['Servers'][$i]['AllowDeny']['rules'] configuration
224        directives.
226 Configuration
228    Warning for Mac users: PHP seems not to like Mac end of lines
229    character ("\r"). So ensure you choose the option that allows to use
230    the *nix end of line character ("\n") in your text editor before
231    registering a script you have modified.
233    All configurable data is placed in config.inc.php3.
235    $cfg['PmaAbsoluteUri'] string
236           Sets here the complete URL (with full path) to your phpMyAdmin
237           version. E.g.
238           http://www.your_web.net/path_to_your_phpMyAdmin_directory/.
239           phpMyAdmin needs this setting, because of requirements of the
240           HTTP protocol, explained in RFC2616, section 14.30.
241           Don't forget the slash at the end of your URL. The URL must
242           contain characters that are valid for a URL, and on some
243           servers, the path is case-sensitive.
244           Starting with version 2.3.0, you can try to leave this
245           parameter empty, because the program tries to auto-detect its
246           proper value. Additional details are in the configuration file.
247           Alternatively, this setting can be dynamically completed. For
248           example, you can try to use such a kind of code:
250 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
251                        . $_SERVER['HTTP_HOST']
252                        . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
253                        . substr($_SERVER['PHP_SELF'], 0, strrpos($_SERVER['PHP_SELF'], '/')+1);
255     or
257 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
258                        . $_SERVER['SERVER_NAME']
259                        . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
260                        . substr($_SERVER['SCRIPT_NAME'], 0, strrpos($_SERVER['SCRIPT_NAME'], '/')+1);
263           Please note that the $_SERVER array doesn't exist in
264           PHP < 4.1.0. Try to replace $_SERVER by $HTTP_SERVER_VARS or
265           $GLOBALS in this case.
267    $cfg['PmaAbsoluteUri_DisableWarning'] boolean
268           By default, when you leave $cfg['PmaAbsoluteUri'] empty, and
269           the system detects your absolute URI automatically, we display
270           a warning to remind you. If you have tested the automatic
271           detection, and it works perfectly for your setup, then you can
272           set this variable to squelch the warning.
274    $cfg['PmaNoRelation_DisableWarning'] boolean
275           Starting with version 2.3.0 phpMyAdmin offers a lot of features
276           to work with master / foreign - tables (see
277           $cfg['Servers'][$i]['pmadb']).
278           If you tried to set this up and it does not work for you, have
279           a look on the "Structure" page of one database where you would
280           like to use it. You will find a link that will analyze why
281           those features have been disabled.
282           If you do not want to use those features set this variable to
283           TRUE to stop this message from appearing.
285    $cfg['Servers'] array
286           Since version 1.4.2, phpMyAdmin supports the administration of
287           multiple MySQL servers. Therefore, a $cfg['Servers']-array has
288           been added which contains the login information for the
289           different servers. The first $cfg['Servers'][$i]['host']
290           contains the hostname of the first server, the second
291           $cfg['Servers'][$i]['host'] the hostname of the second server,
292           etc. If you have only one server to administer, simply leave
293           free the hostname of the other $cfg['Server']-entries.
295    $cfg['Servers'][$i]['host'] string
296           The hostname of your $i-th MySQL-server. E.g. localhost.
298    $cfg['Servers'][$i]['port'] string
299           The port-number of your $i-th MySQL-server. Default is 3306
300           (leave blank). If you use "localhost" as the hostname, MySQL
301           ignores this port number and connects with the socket, so if
302           you want to connect to a port different from the default port,
303           use "127.0.0.1" or the real hostname in
304           $cfg['Servers'][$i]['host'].
306    $cfg['Servers'][$i]['socket'] string
307           The path to the socket to use. Leave blank for default.
308           To use the socket feature you must run PHP 3.0.10 or more.
310    $cfg['Servers'][$i]['connect_type'] string
311           What type connection to use with the MySQL server. Your options
312           are 'socket' & 'tcp'. It defaults to 'tcp' as that is nearly
313           guaranteed to be available on all MySQL servers, while sockets
314           are not supported on some platforms.
315           To use the socket mode, your MySQL server must be on the same
316           machine as the Web server.
318    $cfg['Servers'][$i]['compress'] boolean
319           Whether to use a compressed protocol for the MySQL server
320           connection or not (experimental).
321           This feature requires PHP >= 4.3.0.
323    $cfg['Servers'][$i]['controluser'] string
324           $cfg['Servers'][$i]['controlpass'] string
325           When using HTTP or cookie authentication modes (or 'config'
326           authentication mode since phpMyAdmin 2.2.1), you need to supply
327           the details of a MySQL account that has SELECT privilege on the
328           mysql.user (all columns except "Password"), mysql.db (all
329           columns) & mysql.tables_priv (all columns except "Grantor" &
330           "Timestamp") tables. This account is used to check what
331           databases the user will see at login.
332           Please see the install section on "Using HTTP authentication"
333           for more information.
334           Note that if you try login to phpMyAdmin with this
335           "controluser", you could get some errors, depending the exact
336           privileges you gave to the "controluser". phpMyAdmin does not
337           support a direct login with the "controluser".
338           In versions before 2.2.5, those were called "stduser/stdpass".
340    $cfg['Servers'][$i]['auth_type'] string ['http'|'cookie'|'config']
341           Whether config or cookie or http authentication should be used
342           for this server.
344           + 'config' authentication ($auth_type = 'config') is the plain
345             old way: username and password are stored in config.inc.php3.
346           + 'cookie' authentication mode ($auth_type = 'cookie') as
347             introduced in 2.2.3 allows you to log in as any valid MySQL
348             user with the help of... cookies. Log name and password are
349             stored in cookies during the session and password is deleted
350             when it ends.
351           + 'http' authentication (was called 'advanced' in older
352             versions) ($auth_type = 'http') as introduced in 1.3.0 allows
353             you to log in as any valid MySQL user via HTTP-Auth.
355           Please see the install section on "Using authentication modes"
356           for more information.
358    $cfg['Servers'][$i]['user'] string
359           $cfg['Servers'][$i]['password'] string
360           The user/password-pair which phpMyAdmin will use to connect to
361           this MySQL-server. This user/password pair is not needed when
362           HTTP or cookie authentication is used, and should be empty.
364    $cfg['Servers'][$i]['only_db'] string or array
365           If set to a(an array of) database name(s), only this(these)
366           database(s) will be shown to the user. Since phpMyAdmin 2.2.1,
367           this/these database(s) name(s) may contain MySQL wildcards
368           characters ("_" and "%"): if you want to use literal instances
369           of these characters, escape them (I.E. use 'my\_db' and not
370           'my_db').
371           This setting is an efficient way to lower the server charge
372           since the latter does not need to send MySQL requests to build
373           the available database list. But it does not replace the
374           privileges rules of the MySQL database server. If set, it just
375           means only these databases will be displayed but not at all
376           other databases can't be used.
377           An example of using more that one database:
378           $cfg['Servers'][$i]['only_db'] = array('db1', 'db2');
380    $cfg['Servers'][$i]['verbose'] string
381           Only useful when using phpMyAdmin with multiple server entries.
382           If set, this string will be displayed instead of the hostname
383           in the pull-down menu on the main page. This can be useful if
384           you want to show only certain databases on your system, for
385           example.
387    $cfg['Servers'][$i]['pmadb'] string
388           Starting with version 2.3.0 phpMyAdmin offers a lot of features
389           to work with master / foreign - tables. To use those as well as
390           the bookmark feature you need special tables with a predefined
391           structure, which we explain below.
392           If you are the only user of this phpMyAdmin installation, you
393           can use your current database to store those special tables; in
394           this case, just put your current database name in
395           $cfg['Servers'][$i]['pmadb'].
396           If you are setting up a multi-user phpMyAdmin installation, you
397           will need to create a new database and setup special
398           privileges, so, as superuser:
400           + create a new database for phpMyAdmin:
401               CREATE DATABASE phpmyadmin;
402             Note that "controluser" must have SELECT, INSERT, UPDATE and
403             DELETE privileges on this database. Here is a query to set up
404             those privileges (using "phpmyadmin" as the database name,
405             and "pma" as the controluser):
406               GRANT SELECT,INSERT,UPDATE,DELETE ON phpmyadmin.* to
407             'pma'@'localhost';
408             do not give any other user rights on this database.
409           + enter the database name in $cfg['Servers'][$i]['pmadb']
411    $cfg['Servers'][$i]['bookmarktable'] string
412           Since release 2.2.0 phpMyAdmin allows to bookmark queries. This
413           can be useful for queries you often run.
414           To allow the usage of this functionality you have to:
416           + set up "pmadb" as described above
417           + within this database create a table following this scheme:
418                  CREATE TABLE `PMA_bookmark` (
419                    id int(11) DEFAULT '0' NOT NULL auto_increment,
420                    dbase varchar(255) NOT NULL,
421                    user varchar(255) NOT NULL,
422                    label varchar(255) NOT NULL,
423                    query text NOT NULL,
424                    PRIMARY KEY (id)
425                  ) TYPE=MyISAM COMMENT='Bookmarks';
426           + enter the table name in $cfg['Servers'][$i]['bookmarktable']
428    $cfg['Servers'][$i]['relation'] string
429           Since release 2.2.4 you can describe, in a special 'relation'
430           table, which field is a key in another table (a foreign key).
431           phpMyAdmin currently uses this to
433           + make clickable, when you browse the master table, the data
434             values that point to the foreign table;
435           + display in an optional tool-tip the "display field" when
436             browsing the master table, if you move the mouse to a column
437             containing a foreign key (use also the 'table_info' table);
438             (see FAQ 6.7)
439           + in edit/insert mode, display a drop-down list of possible
440             foreign keys (key value and "display field" are shown)
441             (see FAQ 6.21)
442           + display links on the table properties page, to check
443             referential integrity (display missing foreign keys) for each
444             described key;
445           + in query-by-example, create automatic joins (see FAQ 6.6)
446           + enable you to get a PDF schema of your database (also uses
447             the table_coords table).
449           The keys can be numeric or character.
450           To allow the usage of this functionality the superuser has to:
452           + set up "pmadb" as described above
453           + within this database create a table following this scheme:
454                  CREATE TABLE `PMA_relation` (
455                    `master_db` varchar(64) NOT NULL default '',
456                    `master_table` varchar(64) NOT NULL default '',
457                    `master_field` varchar(64) NOT NULL default '',
458                    `foreign_db` varchar(64) NOT NULL default '',
459                    `foreign_table` varchar(64) NOT NULL default '',
460                    `foreign_field` varchar(64) NOT NULL default '',
461                    PRIMARY KEY (`master_db`, `master_table`,
462             `master_field`),
463                    KEY foreign_field (foreign_db, foreign_table)
464                  ) TYPE=MyISAM COMMENT='Relation table';
465           + put the relation table name in
466             $cfg['Servers'][$i]['relation']
467           + now as normal user open phpMyAdmin and for each one of your
468             tables where you want to use this feature, click
469             "Structure/Relation view/" and choose foreign fields.
471           Please note that in the current (2.3.0) version, master_db must
472           be the same as foreign_db. Those fields have been put in future
473           development of the cross-db relations.
475    $cfg['Servers'][$i]['table_info'] string
476           Since release 2.3.0 you can describe, in a special 'table_info'
477           table, which field is to be displayed as a tool-tip when moving
478           the cursor over the corresponding key.
479           This configuration variable will hold the name of this special
480           table. To allow the usage of this functionality the superuser
481           has to:
483           + set up "pmadb" as described above
484           + within this database create a table following this scheme:
485                  CREATE TABLE `PMA_table_info` (
486                    `db_name` varchar(64) NOT NULL default '',
487                    `table_name` varchar(64) NOT NULL default '',
488                    `display_field` varchar(64) NOT NULL default '',
489                    PRIMARY KEY (`db_name`, `table_name`)
490                  ) TYPE=MyISAM COMMENT='Table information for
491             phpMyAdmin';
492           + put the table name in $cfg['Servers'][$i]['table_info']
493           + then for each table where you want to use this feature, click
494             "Structure/Relation view/Choose field to display" to choose
495             the field.
497           Usage tip: Display field.
499    $cfg['Servers'][$i]['table_coords'] string
500           $cfg['Servers'][$i]['pdf_pages'] string
501           Since release 2.3.0 you can have phpMyAdmin create PDF pages
502           showing the relations between your tables. To do this it needs
503           two tables "pdf_pages" (storing information about the available
504           PDF pages) and "table_coords" (storing coordinates where each
505           table will be placed on a PDF schema output).
506           You must be using the "relation" feature and have a table of
507           PDF pages (see $cfg['Servers'][$i]['pdf_pages']) to create PDF
508           output.
509           To allow the usage of this functionality the superuser has to:
511           + set up "pmadb" as described above
512           + within this database create a table following this scheme:
513                  CREATE TABLE `PMA_table_coords` (
514                    `db_name` varchar(64) NOT NULL default '',
515                    `table_name` varchar(64) NOT NULL default '',
516                    `pdf_page_number` int NOT NULL default '0',
517                    `x` float unsigned NOT NULL default '0',
518                    `y` float unsigned NOT NULL default '0',
519                    PRIMARY KEY (`db_name`, `table_name`,
520             `pdf_page_number`)
521                  ) TYPE=MyISAM COMMENT='Table coordinates for phpMyAdmin
522             PDF output';
523           + also within this database create:
524                  CREATE TABLE `PMA_pdf_pages` (
525                    `db_name` varchar(64) NOT NULL default '',
526                    `page_nr` int(10) unsigned NOT NULL auto_increment,
527                    `page_descr` varchar(50) NOT NULL default '',
528                    PRIMARY KEY (page_nr),
529                    KEY (db_name)
530                  ) TYPE=MyISAM COMMENT='PDF Relationpages for PMA';
531           + put the first table name in
532             $cfg['Servers'][$i]['table_coords'] and the second table name
533             in $cfg['Servers'][$i]['pdf_pages']
535           Usage tips: PDF output.
537    $cfg['Servers'][$i]['column_info'] string
538           Since release 2.3.0 you can store comments to describe each
539           column for each table. These will then be shown on the
540           "printview".
541           Starting with release 2.5.0, comments are consequently used on
542           the table property pages and table browse view, showing up as
543           tool-tips above the column name (properties page) or embedded
544           within the header of table in browse view. They can also be
545           shown in a table dump. Please see the relevant configuration
546           directives later on.
547           Also new in release 2.5.0 is a mime-transformation system which
548           is also based on the following table structure. See
549           Transformations for further information. To use the
550           mime-transformation system, your column_info table has to have
551           the three new fields 'mimetype', 'transformation',
552           'transformation_options'.
553           To allow the usage of this functionality the superuser has to:
555           + set up "pmadb" as described above
556           + within this database create a table following this scheme:
557                  CREATE TABLE `PMA_column_info` (
558                    id int(5) unsigned NOT NULL auto_increment,
559                    db_name varchar(64) NOT NULL default '',
560                    table_name varchar(64) NOT NULL default '',
561                    column_name varchar(64) NOT NULL default '',
562                    `comment` varchar(255) NOT NULL default '',
563                    mimetype varchar(255) NOT NULL default '',
564                    transformation varchar(255) NOT NULL default '',
565                    transformation_options varchar(255) NOT NULL default
566             '',
567                    PRIMARY KEY (id),
568                    UNIQUE KEY db_name (db_name, table_name, column_name)
569                  ) TYPE=MyISAM COMMENT='Comments for Columns';
570           + put the table name in $cfg['Servers'][$i]['column_info']
571           + To update your PRE-2.5.0 Column_comments Table use this:
572                  ALTER TABLE `PMA_column_comments`
573                    ADD `mimetype` VARCHAR( 255 ) NOT NULL ,
574                    ADD `transformation` VARCHAR( 255 ) NOT NULL ,
575                    ADD `transformation_options` VARCHAR( 255 ) NOT NULL ;
576             and remember that the Variable in config.inc.php has been
577             renamed from
578             $cfg['Servers'][$i]['column_comments'] to
579             $cfg['Servers'][$i]['column_info']
581    $cfg['Servers'][$i]['history'] string
582           Since release 2.5.0 you can store your SQL history, which means
583           all queries you entered manually into the phpMyAdmin interface.
584           If you don't want to use a table- based history, you can use
585           the JavaScript-based history. Using that, all your history
586           items are deleted when closing the window.
587           Using $cfg['QueryHistoryMax'] you can specify an amount of
588           history items you want to have on hold. On every login, this
589           list gets cut to the maximum amount.
590           The query history is only available if you use the
591           JavaScript-based query window, see $cfg['QueryFrame'].
592           To allow the usage of this functionality the superuser has to:
594           + set up "pmadb" as described above
595           + within this database create a table following this scheme:
596                  CREATE TABLE `PMA_history` (
597                    `id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
598                    `username` VARCHAR( 64 ) NOT NULL ,
599                    `db` VARCHAR( 64 ) NOT NULL ,
600                    `table` VARCHAR( 64 ) NOT NULL ,
601                    `timevalue` TIMESTAMP NOT NULL ,
602                    `sqlquery` TEXT NOT NULL ,
603                    PRIMARY KEY ( `id` ) ,
604                    INDEX ( `username` , `db` , `table` , `timevalue` )
605                    ) TYPE=MyISAM COMMENT='SQL history';
606           + put the table name in $cfg['Servers'][$i]['history']
608    $cfg['Servers'][$i]['verbose_check'] string
609           Because release 2.5.0 introduced the new MIME-transformation
610           support, the column_info table got enhanced with three new
611           fields. If the above variable is set to TRUE (default)
612           phpMyAdmin will check if you have the latest table structure
613           available. If not, it will emit a warning to the superuser.
614           You can disable this checking behavior by setting the variable
615           to false, which should offer a performance increase.
616           Recommended to set to FALSE, when you are sure, your table
617           structure is up to date.
619    $cfg['Servers'][$i]['AllowDeny']['order'] string
620           If your rule order is empty, then IP authentication is
621           disabled.
622           If your rule order is set to 'deny,allow' then the system
623           applies all deny rules followed by allow rules. Access is
624           allowed by default. Any client which does not match a Deny
625           command or does match an Allow command will be allowed access
626           to the server.
627           If your rule order is set to 'allow,deny' then the system
628           applies all allow rules followed by deny rules. Access is
629           denied by default. Any client which does not match an Allow
630           directive or does match a Deny directive will be denied access
631           to the server.
632           If your rule order is set to 'explicit', the authentication is
633           performed in a similar fashion to rule order 'deny,allow', with
634           the added restriction that your host/username combination must
635           be listed in the allow rules, and not listed in the deny rules.
636           This is the most secure means of using Allow/Deny rules, and
637           was available in Apache by specifying allow and deny rules
638           without setting any order.
640    $cfg['Servers'][$i]['AllowDeny']['rules'] array of strings
641           The general format for the rules is as such:
642                 <'allow' | 'deny'> <username> [from] <ipmask>
643           If you wish to match all users, it is possible to use a '%' as
644           a wildcard in the username field.
645           There are a few shortcuts you can use in the ipmask field as
646           well:
647                'all' -> 0.0.0.0/0
648                'localhost' -> 127.0.0.1/8
649           Having an empty rule list is equivalent to either using 'allow
650           % from all' if your rule order is set to 'deny,allow' or 'deny
651           % from all' if your rule order is set to 'allow,deny' or
652           'explicit'.
653           For the IP matching system, the following work:
654           xxx.xxx.xxx.xxx (an exact IP address)
655           xxx.xxx.xxx.[yyy-zzz] (an IP address range)
656           xxx.xxx.xxx.xxx/nn (CIDR, Classless Inter-Domain Routing type
657           IP addresses)
658           But the following does not work:
659           xxx.xxx.xxx.xx[yyy-zzz] (partial IP address range)
661    $cfg['ServerDefault'] integer
662           If you have more than one server configured, you can set
663           $cfg['ServerDefault'] to any one of them to autoconnect to that
664           server when phpMyAdmin is started, or set it to 0 to be given a
665           list of servers without logging in.
666           If you have only one server configured, $cfg['ServerDefault']
667           MUST be set to that server.
669    $cfg['OBGzip'] boolean
670           Defines whether to use GZip output buffering for increased
671           speed in HTTP transfers.
673    $cfg['PersistentConnections'] boolean
674           Whether persistent connections should be used or not
675           (mysql_connect or mysql_pconnect).
677    $cfg['ExecTimeLimit'] integer [number of seconds]
678           Set the number of seconds a script is allowed to run. If
679           seconds is set to zero, no time limit is imposed.
680           This setting is used while importing/exporting dump files but
681           has no effect when PHP is running in safe mode.
683    $cfg['SkipLockedTables'] boolean
684           Mark used tables and make it possible to show databases with
685           locked tables (since 3.23.30).
687    $cfg['ShowSQL'] boolean
688           Defines whether SQL-queries generated by phpMyAdmin should be
689           displayed or not.
691    $cfg['AllowUserDropDatabase'] boolean
692           Defines whether normal users (non-administrator) are allowed to
693           delete their own database or not. If set as FALSE, the link
694           "Drop Database" will not be shown, and even a "DROP DATABASE
695           mydatabase" will be rejected. Quite practical for ISP's with
696           many customers.
698    $cfg['Confirm'] boolean
699           Whether a warning ("Are your really sure..") should be
700           displayed when you're about to loose data.
702    $cfg['LoginCookieRecall'] boolean
703           Define whether the previous login should be recalled or not in
704           cookie authentication mode.
706    $cfg['UseDbSearch'] boolean
707           Define whether the "search string inside database" is enabled
708           or not.
710    $cfg['LeftFrameLight'] boolean
711           Defines whether to use select-based menu and display only the
712           current tables in the left frame (smaller page). Only in
713           Non-Lightmode you can use the feature to display nested folders
714           using $cfg['LeftFrameTableSeparator']
716    $cfg['LeftFrameTableSeparator'] string
717           Defines a string to be used to nest table spaces. Defaults to
718           '__'. This means if you have tables like 'first__second__third'
719           this will be shown as a three-level hierarchie like: first >
720           second > third. If set to FALSE or empty, the feature is
721           disabled. NOTE: You shall not use this Separator in a table
722           name at the beginning or end of a table name, or multiple times
723           after another without any other characters in between.
725    $cfg['LeftFrameTableLevel'] string
726           Defines how many sublevels should be displayed when splitting
727           up tables by the above Separator.
729    $cfg['ShowTooltip'] boolean
730           Defines whether to display table comment as tool-tip in left
731           frame or not.
733    $cfg['ShowTooltipAliasDB'] boolean
734           If tool-tips are enabled and a DB comment is set, this will
735           flip the comment and the real name. That means, if you have a
736           table called 'user0001' and add the comment 'MyName' on it, you
737           will see the name 'MyName' used consequently in the left frame
738           and the tool-tip shows the real name of the DB.
740    $cfg['ShowTooltipAliasTB'] boolean
741           Same as $cfg['ShowTooltipAliasDB'], except this works for table
742           names.
744    $cfg['ShowStats'] boolean
745           Defines whether to display space usage and statistics about
746           databases and tables or not.
747           Note that statistics requires at least MySQL 3.23.3 and that,
748           at this date, MySQL doesn't return such information for
749           Berkeley DB tables.
751    $cfg['ShowMysqlInfo'] boolean
752           $cfg['ShowMysqlVars'] boolean
753           $cfg['ShowPhpInfo'] boolean
754           $cfg['ShowChgPassword'] boolean
755           Defines whether to display the "MySQL runtime information",
756           "MySQL system variables", "PHP information" and "Change
757           password " links or not for simple users at the starting main
758           (right) frame. This setting does not check MySQL commands
759           entered directly.
760           Please note that to block the usage of phpinfo() in scripts,
761           you have to put this in your php.ini:
762               disable_functions = phpinfo()
763           Also note that enabling the "Change password " link has no
764           effect with "config" authentication mode: because of the hard
765           coded password value in the configuration file, end users can't
766           be allowed to change their passwords.
768    $cfg['SuggestDBName'] boolean
769           Defines whether to suggest a database name on the "Create
770           Database" form or to keep the textfield empty.
772    $cfg['ShowBlob'] boolean
773           Defines whether BLOB fields are shown when browsing a table's
774           content or not.
776    $cfg['NavigationBarIconic'] boolean
777           Defines whether navigation bar buttons contain text or symbols
778           only.
780    $cfg['ShowAll'] boolean
781           Defines whether an user should be displayed a "show all
782           (records)" button in browse mode or not.
784    $cfg['MaxRows'] integer
785           Number of rows displayed when browsing a result set. If the
786           result set contains more rows, Previous/Next links will be
787           shown.
789    $cfg['Order'] string [DESC|ASC|SMART]
790           Defines whether fields are displayed in ascending (ASC) order,
791           in descending (DESC) order or in a "smart" (SMART) order - I.E.
792           descending order for fields of type TIME, DATE, DATETIME &
793           TIMESTAMP, ascending order else- by default.
795    $cfg['ProtectBinary'] boolean or string
796           Defines whether BLOB or BINARY fields are protected from
797           edition when browsing a table's content or not. Valid values
798           are:
799           - FALSE to allow edition of all fields;
800           - blob to allow edition of all fields except BLOBS;
801           - all to disallow edition of all BINARY or BLOB fields.
803    $cfg['ShowFunctionFields'] boolean
804           Defines whether MySQL functions fields should be displayed or
805           not in edit/insert mode.
807    $cfg['CharEditing'] string
808           Defines which type of editing controls should be used for CHAR
809           and VARCHAR fields. Possible values are:
811           + input - this allows to limit size of text to size of field in
812             MySQL, but has problems with newlines in fields
813           + textarea - no problems with newlines in fields, but also no
814             length limitations
816           Default is old behavior so input.
818    $cfg['ZipDump'] boolean
819           $cfg['GZipDump'] boolean
820           $cfg['BZipDump'] boolean
821           Defines whether to allow the use of zip/GZip/BZip2 compression
822           when creating a dump file or not.
824    $cfg['LightTabs'] string
825           If set to True, do use less graphically intense tabs on the top
826           of the mainframe.
828    $cfg['DefaultTabServer'] string
829           Defines the tab displayed by default on server view. Possible
830           values: "main.php3" (recommended for multi-user setups),
831           "server_databases.php3", "server_status.php3",
832           "server_variables.php3", "server_privileges.php3" or
833           "server_processlist.php3".
835    $cfg['DefaultTabDatabase'] string
836           Defines the tab displayed by default on database view. Possible
837           values: "db_details_structure.php3", "db_details.php3" or
838           "db_search.php3".
840    $cfg['DefaultTabTable'] string
841           Defines the tab displayed by default on table view. Possible
842           values: "tbl_properties_structure.php3", "tbl_properties.php3",
843           "tbl_select.php3" or "tbl_change.php3".
845    $cfg['MySQLManualBase'] string
846           If set to an URL which points to the MySQL documentation (type
847           depends on $cfg['MySQLManualType']), appropriate help links are
848           generated.
849           See MySQL Documentation page for more information about MySQL
850           manuals and their types.
852    $cfg['MySQLManualType'] string
853           Type of MySQL documentation:
855           + old - old style used in phpMyAdmin 2.3.0 and sooner
856           + searchable - "Searchable, with user comments"
857           + chapters - "HTML, one page per chapter"
858           + big - "HTML, all on one page"
859           + none - do not show documentation links
861    $cfg['DefaultLang'] string
862           Defines the default language to use, if not browser-defined or
863           user-defined.
864           See the select_lang.inc.php3 script to know the valid values
865           for this setting.
867    $cfg['Lang'] string
868           Force: always use this language (must be defined in the
869           select_lang.inc.php3 script).
871    $cfg['DefaultCharset'] string
872           Default character set to use for recoding of MySQL queries.
873           This must be enabled and it's described by
874           $cfg['AllowAnywhereRecoding'] option.
875           You can give here any character set which is in
876           $cfg['AvailableCharsets'] array and this is just default
877           choice, user can select any of them.
879    $cfg['AllowAnywhereRecoding'] boolean
880           Allow character set recoding of MySQL queries. You need recode
881           or iconv support (compiled in or module) in PHP to allow MySQL
882           queries recoding and used language file must have it enabled
883           (by default only these which are in Unicode, just to avoid
884           losing some characters).
886    $cfg['RecodingEngine'] string
887           You can select here which functions will be used for character
888           set conversion. Possible values are:
890           + auto - automatically use available one (first is tested
891             iconv, then recode)
892           + iconv - use iconv or libiconv functions
893           + recode - use recode_string function
895           Default is auto.
897    $cfg['IconvExtraParams'] string
898           Specify some parameters for iconv used in charset conversion.
899           See iconv documentation for details.
901    $cfg['AvailableCharsets'] array
902           Available character sets for MySQL conversion. You can add your
903           own (any of supported by recode/iconv) or remove these which
904           you don't use. Character sets will be shown in same order as
905           here listed, so if you frequently use some of these move them
906           to the top.
908    $cfg['GD2Available'] string
909           Specifies whether GD >= 2 is available. If yes it can be used
910           for MIME transformations.
911           Possible values are:
913           + auto - automatically detect, this is a bit expensive
914             operation for php < 4.3.0 so it is preffered to change this
915             according to your server real possibilities
916           + yes - GD 2 functions can be used
917           + no - GD 2 function can not be used
919           Default is auto.
921    $cfg['LeftWidth'] integer
922           Left frame width in pixel.
924    $cfg['LeftBgColor'] string [HTML color]
925           $cfg['RightBgColor'] string [HTML color]
926           The background colors (HTML) used for both the frames.
928    $cfg['RightBgImage'] string
929           The URI of the background image used for the right frame. It
930           can be absolute as well as relative from your phpMyAdmin
931           directory.
933    $cfg['LeftPointerColor'] string [HTML color]
934           The color (HTML) used for the pointer in the left frame (does
935           not work with Netscape 4).
937    $cfg['Border'] integer
938           The size of a table's border.
940    $cfg['ThBgcolor'] string [HTML color]
941           The color (HTML) used for table headers.
943    $cfg['BgcolorOne'] string [HTML color]
944           The color (HTML) #1 for table rows.
946    $cfg['BgcolorTwo'] string [HTML color]
947           The color (HTML) #2 for table rows.
949    $cfg['BrowsePointerColor'] string [HTML color]
950           $cfg['BrowseMarkerColor'] string [HTML color]
951           The colors (HTML) uses for the pointer and the marker in browse
952           mode (does not work with Netscape 4).
953           The former feature highlights the row over which your mouse is
954           passing and the latter lets you visually mark/unmark rows by
955           clicking on them.
956           You can disable both of these features by emptying the
957           respective directive.
959    $cfg['TextareaCols'] integer
960           $cfg['TextareaRows'] integer
961           $cfg['CharTextareaCols'] integer
962           $cfg['CharTextareaRows'] integer
963           Number of columns and rows for the textareas.
964           This value will be emphasized (*2) for SQL query textareas and
965           (*1.25) for SQL textareas inside the query window.
966           The Char* values are used for CHAR and VARCHAR editing (if
967           configured via $cfg['CharEditing']).
969    $cfg['LongtextDoubleTextarea'] boolean
970           Defines whether textarea for LONGTEXT fields should have double
971           size.
973    $cfg['TextareaAutoSelect'] boolean
974           Defines if the whole textarea of the query box will be selected
975           on click.
977    $cfg['CtrlArrowsMoving'] boolean
978           Enable Ctrl+Arrows moving between fields when editing?
980    $cfg['LimitChars'] integer
981           Maximal number of Chars showed in any non-numeric field on
982           browse view. Can be turned off by a toggle button on the browse
983           page.
985    $cfg['ModifyDeleteAtLeft'] boolean
986           $cfg['ModifyDeleteAtRight'] boolean
987           Defines the place where modify and delete links would be put
988           when tables contents are displayed (you may have them displayed
989           both at the left and at the right). "Left" and "right" are
990           parsed as "top" and "bottom" with vertical display mode.
992    $cfg['DefaultDisplay'] string
993           $cfg['HeaderFlipType'] string
994           There are 3 display modes: horizontal, horizontalflipped and
995           vertical. Define which one is displayed by default. The first
996           mode displays each row on a horizontal line, the second rotates
997           the headers by 90 degrees, so you can use descriptive headers
998           even though fields only contain small values and still print
999           them out. The vertical mode sorts each row on a vertical
1000           lineup.
1001           The HeaderFlipType can be set to 'css' or 'faked'. When using
1002           'css' the rotation of the header for horizontalflipped is done
1003           via CSS. If set to 'faked' PGP does the transformation for you,
1004           but of course this does not look as good as CSS.
1006    $cfg['DefaultPropDisplay'] string
1007           When editing/creating new columns in a table all fields
1008           normally get lined up one field a line. (default:
1009           'horizontal'). If you set this to 'vertical' you can have each
1010           field lined up vertically beneath each other. You can save up a
1011           lot of place on the horizontal direction and no longer have to
1012           scroll.
1014    $cfg['ShowBrowseComments'] boolean
1015           $cfg['ShowPropertyComments'] boolean
1016           By setting the corresponding variable to TRUE you can enable
1017           the display of column comments in Browse or Property display.
1018           In browse mode, the comments are show inside the header. In
1019           property mode, comments are displayed using a CSS-formatted
1020           dashed-line below the name of the field. The comment is shown
1021           as a tool-tip for that field.
1023    $cfg['UploadDir'] string
1024           The name of the directory, ending with a slash, where SQL files
1025           have been uploaded by other means than phpMyAdmin (for example,
1026           ftp). Those files are available under a drop-down box when you
1027           click the database name, then the SQL tab.
1028           Please note that the file names must have the suffix ".sql".
1029           This feature is useful when your file is too big to be uploaded
1030           via HTTP, or when file uploads are disabled in PHP.
1031           Please note that if PHP is running in safe mode, this directory
1032           must be owned by the same user as the owner of the phpMyAdmin
1033           scripts.
1035    $cfg['SaveDir'] string
1036           The name of the directory, ending with a slash, where dumps can
1037           be saved.
1038           Please note that the directory has to be writable for user
1039           running webserver.
1040           Please note that if PHP is running in safe mode, this directory
1041           must be owned by the same user as the owner of the phpMyAdmin
1042           scripts.
1044    $cfg['Export'] array
1045           In this array are defined default parameters for export, names
1046           of items are simmilar to texts seen on export page, so you can
1047           easily identify what they mean.
1049    $cfg['RepeatCells'] integer
1050           Repeat the headers every X cells, or 0 to deactivate.
1052    $cfg['QueryFrame'] boolean
1053           $cfg['QueryFrameJS'] boolean
1054           $cfg['QueryFrameDebug'] boolean
1055           $cfg['QueryWindowWidth'] integer
1056           $cfg['QueryWindowHeight'] integer
1057           $cfg['QueryHistoryDB'] boolean
1058           $cfg['QueryWindowDefTab'] string
1059           $cfg['QueryHistoryMax'] integer
1060           All those variables affect the new query frame/window. When
1061           $cfg['QueryFrame'] is set to true a new frame is embedded on
1062           the left with a small area. Clicking on that results in opening
1063           a direct interface to enter SQL queries.
1064           When $cfg['QueryFrameJS'] is set to true, clicking on that link
1065           opens a new custom sized browser window
1066           ($cfg['QueryWindowWidth'], $cfg['QueryWindowWidth'] - both
1067           integers for the size in pixels). If set to false, clicking on
1068           the link only opens the SQL input in the mainframe.
1069           The usage of the JavaScript query window is recommended if you
1070           have a JavaScript enabled browser. Basic functions are used to
1071           exchange quite a few variables, so most 4th generation browsers
1072           should be capable to use that feature. It currently is only
1073           tested with Internet Explorer 6 and Mozilla 1.x.
1074           If $cfg['QueryHistoryDB'] is set to TRUE, all your Queries are
1075           logged to a table, which has to be created by you (see
1076           $cfg['Servers'][$i]['history']). If set to FALSE, all your
1077           queries will be appended to the form, but only as long as your
1078           window is opened they remain saved.
1079           When using the JavaScript based query window, it will always
1080           get updated when you click on a new table/db to browse and will
1081           focus if you click on "Edit SQL" after using a query. You can
1082           suppress updating the query window by checking the box "Do not
1083           overwrite this query from outside the window" below the query
1084           textarea. Then you can browse tables/databases in the
1085           background without losing the contents of the textarea, so this
1086           is especially useful when composing a query with tables you
1087           first have to look in. The checkbox will get automatically
1088           checked whenever you change the contents of the textarea.
1089           Please uncheck the button whenever you definitely want the
1090           query window to get updated even though you have made
1091           alterations.
1092           If $cfg['QueryHistoryDB'] is set to TRUE you can specify the
1093           amount of saved history items using $cfg['QueryHistoryMax'].
1094           The query window also has a custom tabbed look to group the
1095           features. Using the variable $cfg['QueryWindowDefTab'] you can
1096           specify the default tab to be used when opening the query
1097           window. It can be set to either 'sql', 'files', 'history' or
1098           'full'.
1099           The variable $cfg['QueryFrameDebug'] can be used by developers
1100           for easier future feature integration.
1102    $cfg['BrowseMIME'] boolean
1103           Enable MIME-transformations.
1105    $cfg['MaxExactCount'] integer
1106           Determines for how large tables phpMyAdmin should get exact row
1107           count by SELECT COUNT. If approximate row count is smaller than
1108           this value, SELECT COUNT will be used, otherwise only value
1109           returned by SHOW TABLE STATUS.
1111    $cfg['SQP']['fmtType'] string [html|none]
1112           The main use of the new SQL Parser is to pretty-print SQL
1113           queries. By default we use HTML to format the query, but you
1114           can disable this by setting this variable to 'none'
1116    $cfg['SQP']['fmtInd'] float
1117           $cfg['SQP']['fmtIndUnit'] string [em|px|pt|ex]
1118           For the pretty-printing of SQL queries, under some cases the
1119           part of a query inside a bracket is indented. By changing
1120           $cfg['SQP']['fmtInd'] you can change the amount of this indent.
1121           Related in purpose is $cfg['SQP']['fmtIndUnit'] which specifies
1122           the units of the indent amount that you specified. This is used
1123           via stylesheets.
1125    $cfg['SQP']['fmtColor'] array of string tuples
1126           This array is used to define the colours for each type of
1127           element of the pretty-printed SQL queries. The tuple format is
1128           class => [HTML colour code | empty string]
1129           If you specify an empty string for the color of a class, it is
1130           ignored in creating the stylesheet. You should not alter the
1131           class names, only the colour strings.
1132           Class name key:
1134           + comment Applies to all comment sub-classes
1135           + comment_mysql Comments as "#...\n"
1136           + comment_ansi Comments as "-- ...\n"
1137           + comment_c Comments as "/*...*/"
1138           + digit Applies to all digit sub-classes
1139           + digit_hex Hexadecimal numbers
1140           + digit_integer Integer numbers
1141           + digit_float Floating point numbers
1142           + punct Applies to all punctuation sub-classes
1143           + punct_bracket_open_round Opening brackets"("
1144           + punct_bracket_close_round Closing brackets ")"
1145           + punct_listsep List item Separator ","
1146           + punct_qualifier Table/Column Qualifier "."
1147           + punct_queryend End of query marker ";"
1148           + alpha Applies to all alphabetic classes
1149           + alpha_columnType Identifiers matching a column type
1150           + alpha_columnAttrib Identifiers matching a
1151             database/table/column attribute
1152           + alpha_functionName Identifiers matching a MySQL function name
1153           + alpha_reservedWord Identifiers matching any other reserved
1154             word
1155           + alpha_variable Identifiers matching a SQL variable "@foo"
1156           + alpha_identifier All other identifiers
1157           + quote Applies to all quotation mark classes
1158           + quote_double Double quotes "
1159           + quote_single Single quotes '
1160           + quote_backtick Backtick quotes `
1162    $cfg['SQLValidator']['use'] boolean
1163           phpMyAdmin now supports use of the Mimer SQL Validator service,
1164           as originally published on Slashdot.
1165           For help in setting up your system to use the service, see the
1166           FAQ #6.14.
1168    $cfg['SQLValidator']['username'] string
1169           $cfg['SQLValidator']['password'] string
1170           The SOAP service allows you to login with anonymous and any
1171           password, so we use those by default.. Instead, if you have an
1172           account with them, you can put your login details here, and it
1173           will be used in place of the anonymous login.
1175    $cfg['DBG']['enable'] boolean
1176           DEVELOPERS ONLY!
1177           Enable the DBG extension for debugging phpMyAdmin. Required for
1178           profiling the code.
1179           For help in setting up your system to this, see the Developers
1180           section.
1182    $cfg['DBG']['profile']['enable'] boolean
1183           DEVELOPERS ONLY!
1184           Enable profiling support for phpMyAdmin. This will append a
1185           chunk of data to the end of every page displayed in the main
1186           window with profiling statistics for that page.
1187           You may need need to increase the maximum execution time for
1188           this to complete successfully.
1190    $cfg['DBG']['profile']['threshold'] float (units in milliseconds)
1191           DEVELOPERS ONLY!
1192           When profiling data is displayed, this variable controls the
1193           threshold of display for any profiling data, based on the
1194           average time each time has taken. If it is over the threshold
1195           it is displayed, otherwise it is not displayed. This takes a
1196           value in milliseconds. In most cases you don't need to edit
1197           this.
1199    $cfg['ColumnTypes'] array
1200           All possible types of a MySQL column. In most cases you don't
1201           need to edit this.
1203    $cfg['AttributeTypes'] array
1204           Possible attributes for fields. In most cases you don't need to
1205           edit this.
1207    $cfg['Functions'] array
1208           A list of functions MySQL supports. In most cases you don't
1209           need to edit this.
1211 Transformations
1213    Introduction  -  Usage  -  File structure  -
1215   [1. Introduction]
1217    To enable transformations, you have to setup the column_info table and
1218    the proper directives. Please see the Configuration section on how to
1219    do so.
1221    You can apply different transformations to the contents of each field.
1222    The transformation will take the content of each field and transform
1223    it with certain rules defined in the selected transformation.
1225    Say you have a field 'filename' which contains a filename. Normally
1226    you would see in phpMyAdmin only this filename. Using transformations
1227    you can transform that filename into a HTML link, so you can click
1228    inside of the phpMyAdmin structure on the field's link and will see
1229    the file displayed in a new browser window. Using transformation
1230    options you can also specify strings to append/prepend to a string or
1231    the format you want the output stored in.
1233    For a general overview of all available transformations and their
1234    options, you can consult your
1235    <www.your-host.com>/<your-install-dir>/libraries/transformations/overv
1236    iew.php3 installation.
1238   [2. Usage]
1240    Go to your tbl_properties.inc.php3 page (i.e. reached through clicking
1241    on the 'properties' link for a table). There you will see three new
1242    fields at the end of the line. They are called 'MIME-type', 'Browser
1243    transformation' and 'Transformation options'.
1244      * The field 'MIME-type' is a dropdown field. You have the options to
1245        leave that field empty or to use 'auto' [this feature is not yet
1246        available]. Please note that transformations are inactive as long
1247        as no mime-type is selected.
1248      * The field 'Browser transformation' is a drop-down field. You can
1249        choose from a hopefully growing amount of pre-defined
1250        transformations. See below for information on how to build your
1251        own transformation.
1252        There are global transformations and mimetype-bound
1253        transformations. Global transformations can be used for any
1254        mimetype. They will take the mimetype, if necessary, into regard.
1255        Mimetype-bound transformations usually only operate on a certain
1256        mimetype. There are transformations which operate on the main
1257        mimetype (like 'image'), which will most likely take the subtype
1258        into regard, and those who only operate on a specific subtype
1259        (like 'image/jpeg').
1260        You can use transformations on mimetypes for which the function
1261        was not defined for. There is no security check for you selected
1262        the right transformation, so take care of what the output will be
1263        like.
1264      * The field 'Transformation options' is a free-type textfield. You
1265        have to enter transform-function specific options here. Usually
1266        the transforms can operate with default options, but it is
1267        generally a good idea to look up the overview to see which options
1268        are necessary.
1269        Much like the ENUM/SET-Fields, you have to split up several
1270        options using the format 'a','b','c',...(NOTE THE MISSING BLANKS).
1271        This is because internally the options will be parsed as an array,
1272        leaving the first value the first element in the array, and so
1273        forth.
1274        If you want to specify a MIME character set you can define it in
1275        the transformation_options. You have to put that outside of the
1276        pre-defined options of the specific mime-transform, as the last
1277        value of the set. Use the format "'; charset=XXX'". If you use a
1278        transform, for which you can specify 2 options and you want to
1279        append a character set, enter "'first parameter','second
1280        parameter','charset=us-ascii'". You can, however use the defaults
1281        for the parameters: "'','','charset=us-ascii'".
1283   [3. File structure]
1285    All mimetypes and their transformations are defined through single
1286    files in the directory 'libraries/transformations/'.
1288    They are stored in files to ease up customization and easy adding of
1289    new transformations.
1291    Because the user cannot enter own mimetypes, it is kept sure that
1292    transformations always work. It makes no sense to apply a
1293    transformation to a mimetype, the transform-function doesn't know to
1294    handle.
1296    One can, however, use empty mime-types and global transformations
1297    which should work for many mimetypes. You can also use transforms on a
1298    different mimetype they where built for, but pay attention to option
1299    usage as well as what the transformation does to your field.
1301    There is a basic file called 'global.inc.php3'. This function can be
1302    included by any other transform function and provides some basic
1303    functions.
1305    There are 5 possible file names:
1306     1. A mimetype+subtype transform:
1307        [mimetype]_[subtype]__[transform].inc.php3
1308        Please not that mimetype and subtype are separated via '_', which
1309        shall not be contained in their names. The transform
1310        function/filename may contain only characters which cause no
1311        problems in the file system as well as the PHP function naming
1312        convention.
1313        The transform function will the be called
1314        'PMA_transform_[mimetype]_[subtype]__[transform]()'.
1315        Example:
1316        text_html__formatted.inc.php3
1317        PMA_transform_text_html__formatted()
1318     2. A mimetype (w/o subtype) transform:
1319        [mimetype]__[transform].inc.php3
1320        Please note that there are no single '_' characters. The transform
1321        function/filename may contain only characters which cause no
1322        problems in the file system as well as the PHP function naming
1323        convention.
1324        The transform function will the be called
1325        'PMA_transform_[mimetype]__[transform]()'.
1326        Example:
1327        text__formatted.inc.php3
1328        PMA_transform_text__formatted()
1329     3. A mimetype+subtype without specific transform function
1330        [mimetype]_[subtype].inc.php3
1331        Please note that there are no '__' characters in the filename. Do
1332        not use special characters in the filename causing problems with
1333        the file system.
1334        No transformation function is defined in the file itself.
1335        Example:
1336        text_plain.inc.php3
1337        (No function)
1338     4. A mimetype (w/o subtype) without specific transform function
1339        [mimetype].inc.php3
1340        Please note that there are no '_' characters in the filename. Do
1341        not use special characters in the filename causing problems with
1342        the file system.
1343        No transformation function is defined in the file itself.
1344        Example:
1345        text.inc.php3
1346        (No function)
1347     5. A global transform function with no specific mimetype
1348        global__[transform].inc.php3
1349        The transform function will the be called
1350        'PMA_transform_global__[transform]()'.
1351        Example:
1352        global__formatted
1353        PMA_transform_global__formatted()
1355    So generally use '_' to split up mimetype and subtype, and '__' to
1356    provide a transform function.
1358    All filenames containing no '__' in themselves are not shown as valid
1359    transform functions in the dropdown.
1361    Please see the libraries/transformations/TEMPLATE file for adding your
1362    own transform function. See the
1363    libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
1364    without a transform function. Also note the introduction of a function
1365    description in the language files. For each function a
1366    $strTransformation_[filename without .inc.php3] has to exist.
1368    You can use the template generator to generate new functions and
1369    entries in the language file.
1371    To create a new transform function please see
1372    libraries/transformations/template_generator.sh. To create a new,
1373    empty mimetype please see
1374    libraries/transformations/template_generator_mimetype.sh.
1376 FAQ - Frequently Asked Questions
1378    Server  -  Configuration  -  Limitations  -  Multi-user  -  Browsers
1379    -  Usage tips  -  Project
1381   [1. Server]
1383     [1.1] I'm running PHP 4+ and my server is crashing each time a specific
1384     action is required or phpMyAdmin sends a blank page or a page full of
1385     cryptic characters to my browser, what can I do?
1387    There are some known PHP bugs with output buffering and compression.
1388    Try to set the $cfg['OBGzip'] directive to FALSE in your
1389    config.inc.php or .php3 file and the zlib.output_compression directive
1390    to Off in your php configuration file.
1391    Furthermore, we know about such problems connected to the release
1392    candidates of PHP 4.2.0 (tested with PHP 4.2.0 RC1 to RC4) together
1393    with MS Internet Explorer. Please upgrade to the release version PHP
1394    4.2.0.
1396     [1.2] My Apache server crashes when using phpMyAdmin.
1398    You should first try the latest versions of Apache (and possibly
1399    MySQL).
1400    See also the other FAQ entry about PHP bugs with output buffering.
1401    If your server keeps crashing, please ask for help in the various
1402    Apache support groups.
1404     [1.3] I'm running phpMyAdmin with "cookie" authentication mode under PHP
1405     4.2.0 or 4.2.1 loaded as an Apache 2+ module but can't enter the script:
1406     I'm always displayed the login screen.
1408    This is a known PHP bug (see this bug report) from the official PHP
1409    bug database. It means there is and won't be any phpMyAdmin fix
1410    against it because there is no way to code a fix.
1412     [1.4] Using phpMyAdmin on IIS, I'm displayed the error message: "The
1413     specified CGI application misbehaved by not returning a complete set of
1414     HTTP headers...".
1416    You just forgot to read the install.txt file from the php
1417    distribution. Have a look at the last message in this bug report from
1418    the official PHP bug database.
1420     [1.5] Using phpMyAdmin on IIS, I'm facing crashes and/or many error
1421     messages with the HTTP or advanced authentication mode.
1423    This is a known problem with the PHP ISAPI filter: it's not so stable.
1424    For some more information and complete testings see the messages
1425    posted by André B. aka "djdeluxe76" in this thread from the phpWizard
1426    forum.
1427    Please use instead the cookie authentication mode.
1429     [1.6] I can't use phpMyAdmin on PWS: nothing is displayed!
1431    This seems to be a PWS bug. Filippo Simoncini found a workaround (at
1432    this time there is no better fix): remove or comment the DOCTYPE
1433    declarations (2 lines) from the scripts header.inc.php3,
1434    header_printview.inc.php3, index.php3, left.php3 and
1435    libraries/common.lib.php3.
1437     [1.7] How can I GZip or Bzip a dump or a CSV export. It does not seem to
1438     work.
1440    These features are based on the gzencode() and bzcompress() PHP
1441    functions to be more independent of the platform (Unix/Windows, Safe
1442    Mode or not, and so on). So, you must have PHP4 >= 4.0.4 and
1443    Zlib/Bzip2 support (--with-zlib and --with-bz2).
1444    We faced PHP crashes when trying to download a dump with MS Internet
1445    Explorer when phpMyAdmin is run with a release candidate of PHP 4.2.0.
1446    In this case you should switch to the release version of PHP 4.2.0.
1448     [1.8] I cannot insert a text file in a table, and I get an error about safe
1449     mode being in effect.
1451    Your uploaded file is saved by PHP in the "upload dir", as defined in
1452    php.ini by the variable upload_tmp_dir (usually the system default is
1453    /tmp).
1454    We recommend the following setup for Apache servers running in safe
1455    mode, to enable uploads of files while being reasonably secure:
1456      * create a separate directory for uploads: mkdir /tmp/php
1457      * give ownership to the Apache server's user.group: chown
1458        apache.apache /tmp/php
1459      * give proper permission: chmod 600 /tmp/php
1460      * put upload_tmp_dir = /tmp/php in php.ini
1461      * restart Apache
1463     [1.9] I'm having troubles when uploading files. In general file uploads
1464     don't work on my system and uploaded files have a Content-Type: header in
1465     the first line.
1467    It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat
1468    7.0 and you updated your PHP RPM to php-4.0.4pl1-3.i386.rpm, didn't
1469    you?
1470    So the problem is that this package has a serious bug that was
1471    corrected ages ago in PHP (2001-01-28: see PHP's bug tracking system
1472    for more details). The problem is that the bugged package is still
1473    available though it was corrected (see RedHat's BugZilla for more
1474    details).
1475    So please download the fixed package (4.0.4pl1-9) and the problem
1476    should go away.
1477    And that fixes the \r\n problem with file uploads!
1479     [1.10] I'm having troubles when uploading files with phpMyAdmin running on
1480     a secure server. My browser is Internet Explorer and I'm using the Apache
1481     server.
1483    As suggested by "Rob M" in the phpWizard forum, add this line to your
1484    httpd.conf:
1485        SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown
1486    It seems to clear up many problems between Internet Explorer and SSL.
1488     [1.11] I get an 'open_basedir restriction' while uploading a file from the
1489     query box.
1491    Since version 2.2.4, phpMyAdmin supports servers with open_basedir
1492    restrictions. Assuming that the restriction allows you to open files
1493    in the current directory ('.'), all you have to do is create a 'tmp'
1494    directory under the phpMyAdmin install directory, with permissions 777
1495    and the same owner as the owner of your phpMyAdmin directory. The
1496    uploaded files will be moved there, and after execution of your SQL
1497    commands, removed.
1499     [1.12] I have lost my MySQL root password, what can I do?
1501    The MySQL manual explains how to reset the permissions.
1503     [1.13] I get an error 'No SQL query' when trying to execute a bookmark.
1505    If PHP does not have read/write access to its upload_tmp_dir, it
1506    cannot access the uploaded query.
1508     [1.14] I get an error 'No SQL query' when trying to submit a query from the
1509     convenient text area.
1511    Check the post_max_size directive from your PHP configuration file and
1512    try to increase it.
1514     [1.15] I have problems with mysql.user field names.
1516    In older MySQL versions, the User and Password fields were named user
1517    and password. Please modify your field names to align with current
1518    standards.
1520     [1.16] I cannot upload big dump files.
1522    The first things to check (or ask your host provider to check) are the
1523    values of upload_max_filesize, memory_limit and post_max_size in the
1524    php.ini configuration file.
1525    All of these three settings limit the maximum size of data that can be
1526    submitted and handled by PHP. One user also said that post_max_size
1527    and memory_limit need to be larger than upload_max_filesize.
1529     [1.17] Does phpMyAdmin support MySQL 4.1 and 5.0?
1531    phpMyAdmin provides limited support for MySQL 4.1. That means that you
1532    can neither assign character sets to a table or field on create nor
1533    change the (automatically) assigned character set.
1534    When compiling php, we strongly recommend that you manually link it to
1535    a MySQL 4.1 client library since the one that is currently bundled
1536    with php is rather old and might cause problems.
1537    MySQL 5 is not yet supported.
1539     [1.18] I'm running MySQL <= 4.0.1 having lower_case_table_names set to 1.
1540     If I create a new table with a capital letter in its name it is changed to
1541     lowercase as it should. But if I try to DROP this table MySQL is unable to
1542     find the corresponding file.
1544    This is a bug of MySQL <= 4.0.1. Please upgrade to at least
1545    MySQL 4.0.2 or turn off your lower_case_table_names directive.
1547     [1.19] I can't run the "display relations" feature because the script seems
1548     not to know the font face I'm using!
1550    The "FPDF" library we're using for this feature requires some special
1551    files to use font faces.
1552    Please refers to the FPDF manual to build these files.
1554     [1.20] I receive the error "cannot load MySQL extension, please check PHP
1555     Configuration".
1557    To connect to a MySQL server, PHP needs a set of MySQL functions
1558    called "MySQL extension". This extension may be part of the PHP server
1559    (compiled-in), otherwise it needs to be loaded dynamically. Its name
1560    is probably mysql.so or mysql.dll. phpMyAdmin tried to load the
1561    extension but failed.
1562    Usually, the problem is solved by installing a software package called
1563    "PHP-MySQL" or something similar.
1565     [1.21] I am running the CGI version of PHP under Unix, and I cannot login
1566     using cookie auth.
1568    In php.ini, set mysql.max_links higher than 1.
1570     [1.22] I don't see the "Location of text file" field, so I cannot upload.
1572    This is most likely because in php.ini, your file_uploads parameter is
1573    not set to "on".
1575     [1.23] I'm running MySQL on a Win32 machine. Each time I create a new table
1576     the table and field names are changed to lowercase!
1578    This happens because the MySQL directive lower_case_table_names
1579    defaults to 1 (ON) in the Win32 version of MySQL. You can change this
1580    behavior by simply changing the directive to 0 (OFF):
1581    Just edit your my.ini file that should be located in your Windows
1582    directory and add the following line to the group [mysqld]:
1583    set-variable = lower_case_table_names=0
1584    Next, save the file and restart the MySQL service. You can always
1585    check the value of this directive using the query
1586    SHOW VARIABLES LIKE 'lower_case_table_names';
1588     [1.24] Some characters are being truncated in my queries, or I get
1589     characters randomly added. I am running PHP 4.2.3.
1591    This is a PHP 4.2.3 bug.
1593     [1.25] I am running Apache with mod_gzip-1.3.26.1a on Windows XP, and I get
1594     problems, such as undefined variables when I run a SQL query.
1596    A tip from Jose Fandos: put a comment on the following two lines in
1597    httpd.conf, like this:
1598    # mod_gzip_item_include file \.php$
1599    # mod_gzip_item_include mime "application/x-httpd-php.*"
1600    as this version of mod_gzip on Apache (Windows) has problems handling
1601    PHP scripts. Of course you have to restart Apache.
1603     [1.26] I just installed phpMyAdmin in my document root of IIS but I get the
1604     error "No input file specified" when trying to run phpMyAdmin.
1606    This is a permission problem. Right-click on the phpmyadmin folder and
1607    choose properties. Under the tab Security, click on "Add" and select
1608    the user "IUSER_machine" from the list. Now set his permissions and it
1609    should work.
1611     [1.27] I get empty page when I want to view huge page (eg.
1612     db_details_structure.php3 with plenty of dabases).
1614    This is a PHP bug that occur when GZIP output buffering enabled. If
1615    you turn off it (by $cfg['OBGzip'] = FALSE in config.inc.php3), it
1616    should work. This bug will be fixed in PHP 5.0.0.
1618     [1.28] My MySQL server sometimes refuses queries and returns the message
1619     'Errorcode: 13'. What does this mean?
1621    This can happen due to a MySQL bug when having database / table names
1622    with upper case characters although lower_case_table_names is set to
1623    1. To fix this, turn off this directive, convert all database and
1624    table names to lower case and turn it on again. Alternatively, there's
1625    a bug-fix available starting with MySQL 3.23.56 / 4.0.11-gamma.
1627     [1.29] When I create a table or modify a field, I get an error and the
1628     fields are duplicated.
1630    It is possible to configure Apache in such a way that PHP has problems
1631    interpreting .php files.
1632    The problems occur when two different (and conflicting) set of
1633    directives are used:
1634    SetOutputFilter PHP
1635    SetInputFilter PHP
1636    &
1637    AddType application/x-httpd-php .php
1638    In the case we saw, one set of directives was in httpd.conf, while the
1639    other set was in php.conf.
1640    The recommended way is with AddType, so just comment out the first set
1641    of lines and restart Apache:
1642    #SetOutputFilter PHP
1643    #SetInputFilter PHP
1644    
1645   [2. Configuration]
1647     [2.1] The error message "Warning: Cannot add header information - headers
1648     already sent by ..." is displayed, what's the problem?
1650    Edit your config.inc.php or .php3 file and ensure there is nothing
1651    (I.E. no blank lines, no spaces, no characters...) neither before the
1652    <?php tag at the beginning, neither after the ?> tag at the end.
1654     [2.2] phpMyAdmin can't connect to MySQL. What's wrong?
1656    Either there is an error with your PHP setup or your username/password
1657    is wrong. Try to make a small script which uses mysql_connect and see
1658    if it works. If it doesn't, it may be you haven't even compiled MySQL
1659    support into PHP.
1661     [2.3] The error message "Warning: MySQL Connection Failed: Can't connect to
1662     local MySQL server through socket '/tmp/mysql.sock' (111)..." is displayed.
1663     What can I do?
1665    For RedHat users, Harald Legner suggests this on the mailing list:
1666    On my RedHat-Box the socket of MySQL is /var/lib/mysql/mysql.sock. In
1667    your php.ini you will find a line
1668        mysql.default_socket = /tmp/mysql.sock
1669    change it to
1670        mysql.default_socket = /var/lib/mysql/mysql.sock
1671    Then restart apache and it will work.
1672    Here is a fix suggested by Brad Ummer in the phpwizard forum:
1673      * First, you need to determine what socket is being used by MySQL.
1674        To do this, telnet to your server and go to the MySQL bin
1675        directory. In this directory there should be a file named
1676        mysqladmin. Type ./mysqladmin variables, and this should give you
1677        a bunch of info about your MySQL server, including the socket
1678        (/tmp/mysql.sock, for example).
1679      * Then, you need to tell PHP to use this socket.
1680        Assuming you are using PHP 3.0.10 or better, you can specify the
1681        socket to use when you open the connection. To do this in
1682        phpMyAdmin, you need to complete the socket information in the
1683        config.inc.php3.
1684        For example: $cfg['Servers'][$i]['socket'] = '/tmp/mysql.sock';
1685        Please also make sure that the permissions of this file allow to
1686        be readable by your webserver (i.e. '0755').
1688    Have also a look at the corresponding section of the MySQL
1689    documentation.
1691     [2.4] Nothing is displayed by my browser when I try to run phpMyAdmin, what
1692     can I do?
1694    Try to set the $cfg['OBGZip'] directive to FALSE in the phpMyAdmin
1695    configuration file. It helps sometime.
1696    Also have a look at your PHP version number: if it contains "4.0b..."
1697    it means you're running a beta version of PHP. That's not a so good
1698    idea, please upgrade to a plain revision.
1700     [2.5] Each time I want to insert or change a record or drop a database or a
1701     table, an error 404 (page not found) is displayed or, with HTTP or cookie
1702     authentication, I'm asked to login again. What's wrong?
1704    Check the value you set for the $cfg['PmaAbsoluteUri'] directive in
1705    the phpMyAdmin configuration file.
1707     [2.6] I get an "Access denied for user: 'root@localhost' (Using password:
1708     YES)"-error when trying to access a MySQL-Server on a host which is
1709     port-forwarded for my localhost
1711    When you are using a port on your localhost, which you redirect via
1712    port-forwarding to another host, MySQL is not resolving the localhost
1713    as expected.
1714    Erik Wasser explains: The solution is: if your host is "localhost"
1715    MySQL (the commandline tool 'mysql' as well) always tries to use the
1716    socket connection for speeding up things. And that doesn't work in
1717    this configuration with port forwarding.
1718    If you enter "127.0.0.1" as hostname, everything is right and MySQL
1719    uses the TCP connection.
1721   [3. Known limitations]
1723     [3.1] When using HTTP authentication, an user who logged out can not
1724     relogin in with the same nick.
1726    This is related to the authentication mechanism (protocol) used by
1727    phpMyAdmin. We plan to change it as soon as we may find enough free
1728    time to do it, but you can bypass this problem: just close all the
1729    opened browser windows and then go back to phpMyAdmin. You should be
1730    able to log in again.
1732     [3.2] When dumping a large table in compressed mode, I get a memory limit
1733     error or a time limit error.
1735    As of version 2.2.4, we build the compressed dump in memory, so large
1736    tables dumps may hang. The only alternative we can think about (using
1737    system calls to mysqldump then gzip or bzip2) would not be applicable
1738    in environments where PHP is in safe mode: access to system programs
1739    is is limited by the system administrator, and time limit is enforced.
1741     [3.3] With InnoDB tables, I lose foreign key relationships when I rename or
1742     alter a table.
1744    This seems to be a InnoDB bug (fixed in MySQL 3.23.50?). However, keep
1745    in mind that phpMyAdmin as of version 2.3.0 does not support InnoDB.
1747     [3.4] I am unable to import dumps I created with the mysqldump tool bundled
1748     with the MySQL server distribution.
1750    The problem is that mysqldump creates invalid comments like this:
1751 -- MySQL dump 8.22
1753 -- Host: localhost Database: database
1754 ---------------------------------------------------------
1755 -- Server version 3.23.54
1757    The invalid part of the code is the horizontal line made of dashes
1758    that appears once in every dump created with mysqldump. If you want to
1759    run your dump you have to turn it into valid MySQL. This means, you
1760    have to add a whitespace after the first to dashes of the line or add
1761    a # before it:
1762    -- -------------------------------------------------------
1763    or
1764    #---------------------------------------------------------
1766     [3.3] When using nested folders ($cfg['LeftFrameTableSeparator']) there are
1767     some multiple hierarchies displayed in a wrong manner?!
1769    Please note that you should not use the seperating string multiple
1770    times without any characters between them, or at the beginning/end of
1771    your table name. If you have to, think about using another
1772    TableSeparator or disabling that feature
1774   [4. ISPs, multi-user installations ]
1776     [4.1] I'm an ISP. Can I setup one central copy of phpMyAdmin or do I need
1777     to install it for each customer.
1779    Since version 2.0.3, you can setup a central copy of phpMyAdmin for
1780    all your users. The development of this feature was kindly sponsored
1781    by NetCologne GmbH. This requires a properly setup MySQL user
1782    management and phpMyAdmin HTTP or cookie authentication. See the
1783    install section on "Using HTTP authentication".
1785     [4.2] What's the preferred way of making phpMyAdmin secure against evil
1786     access.
1788    This depends on your system.
1789    If you're running a server which cannot be accessed by other people,
1790    it's sufficient to use the directory protection bundled with your
1791    webserver (with Apache you can use .htaccess files, for example).
1792    If other people have telnet access to your server, you should use
1793    phpMyAdmin's HTTP authentication feature.
1794    Suggestions:
1795      * Your config.inc.php3 file should be chmod 660.
1796      * All your phpMyAdmin files should be chown phpmy.apache, where
1797        phpmy is a user whose password is only known to you, and apache is
1798        the group under which Apache runs.
1799      * You should use PHP safe mode, to protect from other users that try
1800        to include your config.inc.php3 in their scripts.
1802     [4.3] I get errors about not being able to include a file in /lang or in
1803     /libraries.
1805    Check php.ini, or ask your sysadmin to check it. The include_path must
1806    contain "." somewhere in it, and open_basedir, if used, must contain
1807    "." and "./lang" to allow normal operation of phpMyAdmin.
1809     [4.4] phpMyAdmin always gives "Access denied" when using HTTP
1810     authentication.
1812    This could happen for several reasons:
1813      * $cfg['Servers'][$i]['controluser'] and/or
1814        $cfg['Servers'][$i]['controlpass'] are wrong.
1815      * The username/password you specify in the login-dialog are invalid.
1816      * You have already setup a security mechanism for the
1817        phpMyAdmin-directory, eg. a .htaccess file. This would interfere
1818        with phpMyAdmin's authentication, so remove it.
1820     [4.5] Is it possible to let users create their own databases?
1822    Starting with 2.2.5, in the user management page, you can enter a
1823    wildcard database name for a user (for example "joe%"), and put the
1824    privileges you want. For example, adding SELECT, INSERT, UPDATE,
1825    DELETE, CREATE, DROP, INDEX, ALTER would let a user create/manage
1826    his/her database(s).
1828     [4.6] How can I use the Host-based authentication additions?
1830    If you have existing rules from an old .htaccess file, you can take
1831    them and add a username between the 'deny'/'allow' and 'from' strings.
1832    Using the username wildcard of '%' would be a major benefit here if
1833    your installation is suited to using it. Then you can just add those
1834    updated lines into the $cfg['Servers'][$i]['AllowDeny']['rules']
1835    array.
1836    If you want a pre-made sample, you can try this fragment. It stops the
1837    'root' user from logging in from any networks other than the private
1838    network IP blocks.
1839        //block root from logging in except from the private networks
1840        $cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';
1841        $cfg['Servers'][$i]['AllowDeny']['rules'] = array(
1842            'deny root from all',
1843            'allow root from localhost',
1844            'allow root from 10.0.0.0/8',
1845            'allow root from 192.168.0.0/16',
1846            'allow root from 172.16.0.0/12',
1847            );
1849     [4.7] Authentication window is displayed more than once, why?
1851    This happens if you are using a URL to start phpMyAdmin which is
1852    different than the one set in your $cfg['PmaAbsoluteUri']. For
1853    example, a missing "www", or entering with an IP address while a
1854    domain name is defined in the config file.
1856   [5. Browsers or client OS]
1858     [5.1] I get an out of memory error, and my controls are non-functional,
1859     when trying to create a table with more than 14 fields.
1861    We could reproduce this problem only under Win98/98SE. Testing under
1862    WinNT4 or Win2K, we could easily create more than 60 fields.
1863    A workaround is to create a smaller number of fields, then come back
1864    to your table properties and add the other fields.
1866     [5.2] With Xitami 2.5b4, phpMyAdmin won't process form fields.
1868    This is not a phpMyAdmin problem but a Xitami known bug: you'll face
1869    it with each script/website that use forms.
1870    Upgrade or downgrade your Xitami server.
1872     [5.3] I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).
1874    With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except
1875    that the proposed file name for the dump is always 'tbl_dump.php'.
1876    Bzip2 dumps don't seem to work.
1877    With Konqueror 2.2.1: plain dumps work; zip dumps are placed into the
1878    user's temporary directory, so they must be moved before closing
1879    Konqueror, or else they disappear. GZip dumps give an error message.
1880    Testing needs to be done for Konqueror 2.2.2.
1882     [5.4] I can't use the cookie authentication mode because Internet Explorer
1883     never stores the cookies.
1885    MS Internet Explorer seems to be really buggy about cookies, at least
1886    till version 6. And thanks to Andrew Zivolup we've traced also a PHP
1887    4.1.1 bug in this area!
1888    Then, if you're running PHP 4.1.1, try to upgrade or downgrade... it
1889    may work!
1891     [5.5] In Internet Explorer 5.0, I get JavaScript errors when browsing my
1892     rows.
1894    Upgrade to at least Internet Explorer 5.5 SP2.
1896     [5.6] In Internet Explorer 5.0, 5.5 or 6.0, I get an error (like "Page not
1897     found") when trying to modify a row in a table with many fields, or with a
1898     text field
1900    Your table neither have a primary key nor an unique one, so we must
1901    use a long URL to identify this row. There is a limit on the length of
1902    the URL in those browsers, and this not happen in Netscape, for
1903    example. The workaround is to create a primary or unique key, or use
1904    another browser.
1906     [5.7] I refresh (reload) my browser, and come back to the welcome page.
1908    Some browsers support right-clicking into the frame you want to
1909    refresh, just do this in the right frame.
1911     [5.8] With Mozilla 0.9.7 I have problems sending a query modified in the
1912     query box.
1914    Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
1915    Mozilla versions.
1917     [5.9] With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
1918     whitespace in the SQL-Query edit area: the page scrolls down.
1920    This is a Mozilla bug (see bug #26882 at BugZilla).
1922     [5.10] With Netscape 4.75 I get empty rows between each row of data in a
1923     CSV exported file.
1925    This is a known Netscape 4.75 bug: it adds some line feeds when
1926    exporting data in octet-stream mode. Since we can't detect the
1927    specific Netscape version, we cannot workaround this bug.
1929     [5.11] Extended-ASCII characters like German umlauts are displayed wrong.
1931    Please ensure that you have set your browser's character set to the
1932    one of the language file you have selected on phpMyAdmin's start page.
1933    Alternatively, you can try the auto detection mode that is supported
1934    by the recent versions of the most browsers.
1936     [5.12] Apple OS X: Safari browser changes special characters to "?".
1938    This issue has been reported by a OS X user, who adds that Chimera,
1939    Netscape and Mozilla do not have this problem.
1941     [5.13] With Internet Explorer 5.5 or 6, and HTTP authentication type, I
1942     cannot manage two servers: I login to the first one, then the other one,
1943     but if I switch back to the first, I have to login on each operation.
1945    This is a bug in Internet Explorer, other browsers do not behave this
1946    way.
1948     [5.14] Using Opera6, I can manage to get to the authentification, but
1949     nothing happens after that, only a blank screen.
1951    Having $cfg['QueryFrameJS'] set to TRUE, this leads to a bug in
1952    Opera6, because it is not able to interpret frameset definitiions
1953    written by JavaScript. Please upgrade to Opera7 at least.
1955   [6. Using phpMyAdmin]
1957     [6.1] I can't insert new rows into a table / I can't create a table - MySQL
1958     brings up a SQL-error.
1960    Examine the SQL error with care. Often the problem is caused by
1961    specifying a wrong field-type.
1962    Common errors include:
1963      * Using VARCHAR without a size argument
1964      * Using TEXT or BLOB with a size argument
1966    Also, look at the syntax chapter in the MySQL manual to confirm that
1967    your syntax is correct.
1969     [6.2] When I create a table, I click the Index checkbox for 2 fields and
1970     phpMyAdmin generates only one index with those 2 fields.
1972    In phpMyAdmin 2.2.0 and 2.2.1, this is the way to create a
1973    multi-fields index. If you want two indexes, create the first one when
1974    creating the table, save, then display the table properties and click
1975    the Index link to create the other index.
1977     [6.3] How can I insert a null value into my table?
1979    Since version 2.2.3, you have a checkbox for each field that can be
1980    null. Before 2.2.3, you had to enter "null", without the quotes, as
1981    the field's value.
1983     [6.4] How can I backup my database or table?
1985    Click on a database or table name in the left frame, the properties
1986    will be displayed. Then on the menu, click "Export", you can dump the
1987    structure, the data, or both. This will generate standard SQL
1988    statements that can be used to recreate your database/table.
1989    You will need to choose "Save as file", so that phpMyAdmin can
1990    transmit the resulting dump to your station. Depending on your PHP
1991    configuration, you will see options to compress the dump. See also the
1992    $cfg['ExecTimeLimit'] configuration variable.
1993    For additional help on this subject, look for the word "dump" in this
1994    document.
1996     [6.5] How can I restore (upload) my database or table using a dump? How can
1997     I run a ".sql" file.
1999    Click on a database name in the left frame, the properties will be
2000    local displayed. Then in the "Run SQL query" section, type in your
2001    dump filename, or use the Browse button. Then click Go.
2002    For additional help on this subject, look for the word "upload" in
2003    this document.
2005     [6.6] How can I use the relation table in Query-by-example?
2007    Here is an example with the tables persons, towns and countries, all
2008    located in the database mydb. If you don't have a PMA_relation table,
2009    create it as explained in the configuration section. Then create the
2010    example tables:
2011         CREATE TABLE REL_countries (
2012           country_code char(1) NOT NULL default '',
2013           description varchar(10) NOT NULL default '',
2014           PRIMARY KEY (country_code)
2015         ) TYPE=MyISAM;
2016         INSERT INTO REL_countries VALUES ('C', 'Canada');
2017         CREATE TABLE REL_persons (
2018           id tinyint(4) NOT NULL auto_increment,
2019           person_name varchar(32) NOT NULL default '',
2020           town_code varchar(5) default '0',
2021           country_code char(1) NOT NULL default '',
2022           PRIMARY KEY (id)
2023         ) TYPE=MyISAM;
2024         INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');
2025         INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');
2026         CREATE TABLE REL_towns (
2027           town_code varchar(5) NOT NULL default '0',
2028           description varchar(30) NOT NULL default '',
2029           PRIMARY KEY (town_code)
2030         ) TYPE=MyISAM;
2031         INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');
2032         INSERT INTO REL_towns VALUES ('M', 'Montréal');
2033    To setup appropriate links and display information:
2034      * on table "REL_persons" click Structure, then Relation view
2035      * in Links, for "town_code" choose "REL_towns->code"
2036      * in Links, for "country_code" choose "REL_countries->country_code"
2037      * on table "REL_towns" click Structure, then Relation view
2038      * in "Choose field to display", choose "description"
2039      * repeat the two previous steps for table "REL_countries"
2041    Then test like this:
2042      * Click on your db name in the left frame
2043      * Choose "Query"
2044      * Use tables: persons, towns, countries
2045      * Click "Update query"
2046      * In the fields row, choose persons.person_name and click the "Show"
2047        tickbox
2048      * Do the same for towns.description and countries.descriptions in
2049        the other 2 columns
2050      * Click "Update query" and you will see in the query box that the
2051        correct joins have been generated
2052      * Click "Submit query"
2054     [6.7] How can I use the "display field" feature?
2056    Starting from the previous example, create the PMA_table_info as
2057    explained in the configuration section, then browse your persons
2058    table, and move the mouse over a town code or country code.
2059    See also FAQ 6.21 for an additionnal feature that "display field"
2060    enables: drop-down list of possible values.
2062     [6.8] How can I produce a PDF schema of my database?
2064    First you have to fill the "relation", "table_coords" and "pdf_pages"
2065    configuration variables.
2066    Then, think about your schema layout: which tables will go on which
2067    pages.
2068      * Click on your db name in the left frame
2069      * Choose "Structure" in the navigation on top
2070      * Choose "Edit PDF Pages" which should be somewhere at the bottom of
2071        the page
2072      * Enter the name for a first pdf page and submit
2073      * Choose this page to edit
2074      * Now add a table you want to show on this page and it's coordinates
2075        and submit
2076        First you will have to guess this coordinates of course, so just
2077        expect to have an area of about 297 * 210 and put the tables
2078        coordinates somewhere in there, you will be able to have a look at
2079        what happened and change them later.
2080        For example, x=100 and y=200 means that the table will be at 200
2081        mm down and 100 mm right from the upper left corner.
2082        Actually if you have a width of more than 300 or a height of more
2083        than 200 than it will automatically be scaled but 300*100 is a
2084        good start to have an idea of what coordinates to use.
2085      * After every table you submitted you will have the possibility to
2086        submit more tables
2087      * When you have entered enough tables Click on your db name in the
2088        left frame again
2089      * Now, again at the bottom of the page you should be able to choose
2090        "Display PDF schema"
2091        For testing it might be useful to show the grid as well, so you
2092        can see the coordinates used.
2093        Maybe also choose color and submit.
2094      * Save the file he will offer you to something like Schema.pdf
2095        (Internet Explorer has some bug there which might make it offer it
2096        without an extension. Under Windows it is important to have the
2097        extension ".pdf", under other OSes you should be fine just saving
2098        the file under the name it offers).
2100     [6.9] phpMyAdmin is changing the type of one of my columns!
2102    No, it's MySQL that is doing silent column type changing.
2104     [6.10] When creating a privilege, what happens with underscores in the
2105     database name?
2107    If you do not put a backslash before the underscore, this is a
2108    wildcard grant, and the underscore means "any character". So, if the
2109    database name is "john_db", the user would get rights to john1db,
2110    john2db...
2111    If you put a backslash before the underscore, it means that the
2112    database name will have a real underscore.
2114     [6.11] What is the curious symbol o/ in the statistics pages?
2116    It means "average".
2118     [6.12] I want to understand some Export options.
2120    "Complete inserts" adds the column names on every INSERT command, for
2121    better documentation (but resulting file is bigger).
2122    "Extended inserts" provides a shorter dump file by using only once the
2123    INSERT verb and the table name.
2124    "Enclose table and field names with backquotes" ensures that field and
2125    table names formed with special characters are protected.
2126    "Include column comments as inline SQL-comments" includes any column
2127    comments set in the PMA-DB in the dump as SQL comments (/* xxx */).
2129     [6.13] I would like to create a database with a dot in its name.
2131    This is a bad idea, because in MySQL the syntax "database.table" is
2132    the normal way to reference a database and table name. Worse, MySQL
2133    will usually let you create a database with a dot, but then you cannot
2134    work with it, nor delete it.
2136     [6.14] How do I set up the SQL Validator?
2138    To use it, you need a very recent version of PHP, 4.3.0 recommended,
2139    with XML, PCRE and PEAR support. On your system command line, run
2140    "pear install Net_Socket Net_URL HTTP_Request Mail_Mime Net_DIME SOAP"
2141    to get the necessary PEAR modules for usage.
2142    If you use it, you should be aware that any SQL statement you submit
2143    will be stored anonymously (database/table/column names, strings,
2144    numbers replaced with generic values). The Mimer SQL Validator itself,
2145    is (c) 2001 Upright Database Technology. We utilize it as free SOAP
2146    service.
2148     [6.15] I want to add a BLOB field and put an index on it, but MySQL says
2149     "BLOB column '...' used in key specification without a key length".
2151    The right way to do this, is to create the field without any indexes,
2152    then display the table structure and use the "Create an index" dialog.
2153    On this page, you will be able to choose your BLOB field, and set a
2154    size to the index, which is the condition to create an index on a BLOB
2155    field.
2157     [6.16] How can I simply move in page with plenty editing fields?
2159    You can use Ctrl+arrows for moving on most pages with plenty editing
2160    fields (table structure changes, row editing, etc.) (must be anabled
2161    in configuration - see. $cfg['CtrlArrowsMoving']). You can also have a
2162    look at the directive $cfg['DefaultPropDisplay'] ('vertical') and see
2163    if this eases up editing for you.
2165     [6.17] Transformations: I can't enter my own mimetype! WTF is this feature
2166     then useful for?
2168    Slow down :). Defining mimetypes is of no use, if you can't put
2169    transformations on them. Otherwise you could just put a comment on the
2170    field. Because entering your own mimetype will cause serious syntax
2171    checking issues and validation, this introduces a high-risk
2172    false-user-input situation. Instead you have to initialize mimetypes
2173    using functions or empty mimetype definitions.
2174    Plus, you have a whole overview of available mimetypes. Who knows all
2175    those mimetypes by heart so he/she can enter it at will?
2177     [6.18] Bookmarks: Where can I store bookmarks? Why can't I see any
2178     bookmarks below the query box? What is this variable for?
2180    Any query you have executed can be stored as a bookmark on the page
2181    where the results are displayed. You will find a button labeled
2182    'Bookmark this query' just at the end of the page.
2183    As soon as you have stored a bookmark, it is related to the database
2184    you run the query on. You can now access a bookmark dropdown on each
2185    page, the query box appears on for that database.
2186    Since phpMyAdmin 2.5.0 you are also able to store variables for the
2187    bookmarks. Just use the string /*[VARIABLE]*/ anywhere in your query.
2188    Everything which is put into the value input box on the query box page
2189    will replace the string "/*[VARIABLE]*/" in your stored query. Just be
2190    aware of that you HAVE to create a valid query, otherwise your query
2191    won't be even able to be stored in the database.
2192    Also remember, that everything else inside the /*[VARIABLE]*/ string
2193    for your query will remain the way it is, but will be stripped of the
2194    /**/ chars. So you can use:
2195    /*, [VARIABLE] AS myname */
2196    which will be expanded to
2197    , VARIABLE as myname
2198    in your query, where VARIABLE is the string you entered in the input
2199    box. If an empty string is provided, no replacements are made.
2200    A more complex example. Say you have stored this query:
2201    SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE
2202    '%[VARIABLE]%' */
2203    Say, you now enter "phpMyAdmin" as the variable for the stored query,
2204    the full query will be:
2205    SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE
2206    '%phpMyAdmin%'
2207    You can use multiple occurences of /*[VARIABLE]*/ in a single query.
2208    NOTE THE ABSENCE OF SPACES inside the "/**/" construct. Any spaces
2209    inserted there will be later also inserted as spaces in your query and
2210    may lead to unexpected results especially when using the variable
2211    expansion inside of a "LIKE ''" expression.
2212    Your initial query which is going to be stored as a bookmark has to
2213    yield at least one result row so you can store the bookmark. You may
2214    have that to work around using well positioned "/**/" comments.
2216     [6.19] How can I create simple LaTeX document to include exported table?
2218    You can simply include table in your LaTeX documents, minimal sample
2219    document should look like following one (assuming you have table
2220    exported in file table.tex):
2221 \documentclass{article}
2222 \usepackage{longtable}
2224 \begin{document}
2226 \include{table}
2228 \end{document}
2230     [6.20] In MySQL 4, I see a lot of databases which are not mine, and cannot
2231     access them.
2233    Upgrading to MySQL 4 usually gives users a global privilege: CREATE
2234    TEMPORARY TABLES. This privilege also enables users to see all the
2235    database names. See this bug report.
2236    So if your users do not need this privilege, you can remove it and
2237    their databases list will shorten.
2239     [6.21] In edit/insert mode, how can I see a list of possible values for a
2240     field, based on some foreign table?
2242    You have to setup appropriate links between the tables, and also setup
2243    the "display field" in the foreign table. See FAQ 6.6 for an example.
2244    Then, if there are 200 values or less in the foreign table, a
2245    drop-down list of values will be available.
2247   [7. phpMyAdmin project]
2249     [7.1] I have found a bug. How do I inform developers?
2251    Our Bug Tracker is located at
2252    http://sourceforge.net/projects/phpmyadmin/ under the Bugs section.
2253    But please first discuss your bug with other users:
2254    http://sourceforge.net/projects/phpmyadmin/ (and choose Forums)
2256     [7.2] I want to translate the messages to a new language or upgrade an
2257     existing language, where do I start?
2259    Always use the current CVS version of your language file. For a new
2260    language, start from english-iso-8859-1.inc.php3. If you don't know
2261    how to get the CVS version, please ask one of the developers.
2262    Please note that we try not to use HTML entities like &eacute; in the
2263    translations, since we define the right character set in the file.
2264    With HTML entities, the text on JavaScript messages would not display
2265    correctly. However there are some entities that need to be there, for
2266    quotes ,non-breakable spaces, ampersands, less than, greater than.
2267    You can then put your translations, as a zip file to avoid losing
2268    special characters, on the sourceforge.net translation tracker.
2269    It would be a good idea to subscribe to the phpmyadmin-translators
2270    mailing list, because this is where we ask for translations of new
2271    messages.
2273     [7.3] I would like to help out with the development of phpMyAdmin. How
2274     should I proceed?
2276    The following method is preferred for new developers:
2277     1. fetch the current CVS tree over anonymous CVS:
2278        cvs
2279        -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmy
2280        admin login
2281        [Password: simply press the Enter key]
2282        cvs -z3
2283        -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmy
2284        admin checkout phpMyAdmin
2285        [This will create a new sub-directory named phpMyAdmin]
2286     2. add your stuff
2287     3. put the modified files (tar'ed and gzip'ed) inside the patch
2288        tracker of the phpMyAdmin SourceForge account.
2290    Write access to the CVS tree is granted only to experienced developers
2291    who have already contributed something useful to phpMyAdmin.
2292    Also, have a look at the Developers section.
2294 Developers Information
2296    phpMyAdmin is Open Source, so you're invited to contribute to it. Many
2297    great features have been written by other people and you too can help
2298    to make phpMyAdmin a useful tool.
2300    If you're planning to contribute source, please read the following
2301    information:
2302      * All files include header.inc.php3 (layout),
2303        libraries/common.lib.php3 (common functions) and config.inc.php3.
2304        All configuration data belongs in config.inc.php3. Please keep it
2305        free from other code.
2306        Commonly used functions should be added to
2307        libraries/common.lib.php3 and more specific ones may be added
2308        within a library stored into the libraries sub-directory.
2309      * Obviously, you're free to use whatever coding style you want. But
2310        please try to keep your code as simple as possible: beginners are
2311        using phpMyAdmin as an example application.
2312        As far as possible, we want the scripts to be XHTML1.0 and CSS2
2313        compliant on one hand, they fit the PEAR coding standards on the
2314        other hand. Please pay attention to this.
2315      * Please try to keep up the file-naming conventions. Table-related
2316        stuff goes to tbl_*.php3, db-related code to db_*.php3,
2317        server-related tools to server_*.php3 and so on.
2318      * Please don't use verbose strings in your code, instead add the
2319        string (at least) to english-iso-8859-1.inc.php3 and print() it
2320        out.
2321      * If you want to be really helpful, write an entry for the
2322        ChangeLog.
2323      * The DBG extension (PHP Debugger DBG) is now supported by
2324        phpMyAdmin for developers to better debug and profile their code.
2325        Please see the $cfg['DBG']* configuration options for more
2326        information.
2327        This is in memoriam of the Space Shuttle Columbia (STS-107) which
2328        was lost during its re-entry into Earth's atmosphere and in memory
2329        of the brave men and women who gave their lives for the people of
2330        Earth.
2332 Credits
2335 phpMyAdmin - Credits
2336 ====================
2338 CREDITS, in chronological order
2339 -------------------------------
2341 - Tobias Ratschiller <tobias.ratschiller_at_maguma.com>
2342     * creator of the phpmyadmin project
2343     * maintainer from 1998 to summer 2000
2345 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca>
2346     * multi-language version
2347     * various fixes and improvements
2348     * project co-administrator
2350 - Olivier Müller <om_at_omnis.ch>
2351     * started SourceForge phpMyAdmin project in March 2001
2352     * sync'ed different existing CVS trees with new features and bugfixes
2353     * multi-language improvements, dynamic language selection
2354     * current project maintainer
2355     * many bugfixes and improvements
2357 - Loic Chapeaux <lolo_at_phpheaven.net>
2358     * rewrote and optimized javascript, DHTML and DOM stuff
2359     * rewrote the scripts so they fit the PEAR coding standards and
2360       generate XHTML1.0 and CSS2 compliant codes
2361     * improved the language detection system
2362     * many bugfixes and improvements
2364 - Robin Johnson <robbat2_at_users.sourceforge.net>
2365     * database maintence controls
2366     * table type code
2367     * Host authentication IP Allow/Deny
2368     * DB-based configuration (Not completed)
2369     * SQL parser
2370     * SQL validator
2371     * many bugfixes and improvements
2373 - Armel Fauveau <armel.fauveau_at_globalis-ms.com>
2374     * bookmarks feature
2375     * multiple dump feature
2376     * gzip dump feature
2377     * zip dump feature
2379 - Geert Lund <glund_at_silversoft.dk>
2380     * various fixes
2381     * moderator of the phpMyAdmin users forum at phpwizard.net
2383 - Korakot Chaovavanich <korakot_at_iname.com>
2384     * "insert as new row" feature
2386 - Pete Kelly <webmaster_at_trafficg.com>
2387     * rewrote and fix dump code
2388     * bugfixes
2390 - Steve Alberty <alberty_at_neptunlabs.de>
2391     * rewrote dump code for PHP4
2392     * mySQL table statistics
2393     * bugfixes
2395 - Benjamin Gandon <gandon_at_isia.cma.fr>
2396     * main author of the version 2.1.0.1
2397     * bugfixes
2399 - Alexander M. Turek <rabus_at_bugfixes.info>
2400     * XML exports
2401     * MySQL 4 related features
2402     * various small features and fixes
2403     * German language file updates
2405 - Mike Beck <mike.beck_at_ibmiller.de>
2406     * automatic joins in QBE
2407     * links column in printview
2408     * Relation view
2410 - Michal Cihar <nijel_at_users.sourceforge.net>
2411     * enhanced index creation/display feature
2412     * feature to use a different charset for HTML than for MySQL
2413     * Czech language file updates
2415 - Christophe Gesché from the "MySQL Form Generator for PHPMyAdmin"
2416   (http://sourceforge.net/projects/phpmysqlformgen/)
2417     * suggested the patch for multiple table printviews
2419 - Garvin Hicking <hicking_at_faktor-e.de>
2420     * built the patch for vertical display of table rows
2421     * built the Javascript based Query window + SQL history
2422     * Improvement of column/db comments
2423     * (MIME)-Transformations for columns
2424     * Use custom alias names for Databases in left frame
2425     * vertical display of column properties page
2426     * some bugfixes, smaller features
2428 - Yukihiro Kawada <kawada_at_den.fujifilm.co.jp>
2429     * japanese kanji encoding conversion feature
2431 - Piotr Roszatycki <d3xter_at_users.sourceforge.net> and Dan Wilson
2432     * the Cookie authentication mode
2434 - Axel Sander <n8falke_at_users.sourceforge.net>
2435     * table relation-links feature
2437 - Maxime Delorme <delorme.maxime_at_free.fr>
2438     * PDF schema output, thanks also to Olivier Plathey for the
2439       "FPDF" library (see http://www.fpdf.org/).
2441 - Olof Edlund <olof.edlund_at_upright.se>
2442     * SQL validator server
2444 - Ivan R. Lanin <ivanlanin_at_users.sourceforfe.net>
2445     * phpMyAdmin logo
2447 And also to the following people who have contributed minor changes,
2448 enhancements, bugfixes or support for a new language since version 2.1.0:
2450 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
2451 Péter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
2452 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kläger,
2453 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
2454 Bernard M. Piller, Laurent Haas, "Sakamoto", Yuval Sarna,
2455 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
2456 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
2457 Luís V., Martijn W. van der Lee,
2458 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
2459 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, "Manuzhai".
2462 Original Credits of Version 2.1.0
2463 ---------------------------------
2465     This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
2466     to create a web-based interface to MySQL using PHP3. Although I have not
2467     used any of his source-code, there are some concepts I've borrowed from
2468     him. phpMyAdmin was created because Peter told me he wasn't going to
2469     further develop his (great) tool.
2470     Thanks go to
2471     - Amalesh Kempf <ak-lsml_at_living-source.com> who contributed the
2472       code for the check when dropping a table or database. He also suggested
2473       that you should be able to specify the primary key on tbl_create.php3. To
2474       version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
2475       well as a bug-report. Plus many smaller improvements.
2476     - Jan Legenhausen <jan_at_nrw.net>: He made many of the changes that
2477       were introduced in 1.3.0 (including quite significant ones like the
2478       authentication). For 1.4.1 he enhanced the table-dump feature. Plus
2479       bug-fixes and help.
2480     - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca> made phpMyAdmin
2481       language-independent by outsourcing the strings to a separate file. He
2482       also contributed the French translation.
2483     - Alexandr Bravo <abravo_at_hq.admiral.ru> who contributed
2484       tbl_select.php3, a feature to display only some fields from a table.
2485     - Chris Jackson <chrisj_at_ctel.net> added support for MySQL
2486       functions in tbl_change.php3. He also added the
2487       "Query by Example" feature in 2.0.
2488     - Dave Walton <walton_at_nordicdms.com> added support for multiple
2489       servers and is a regular contributor for bug-fixes.
2490     - Gabriel Ash <ga244_at_is8.nyu.edu> contributed the random access
2491       features for 2.0.6.
2492     The following people have contributed minor changes, enhancements, bugfixes
2493     or support for a new language:
2494     Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
2495     Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
2496     Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
2497     G. Wieggers.
2499     And thanks to everyone else who sent me email with suggestions, bug-reports
2500     and or just some feedback.
2502                                         Valid XHTML 1.0!      Valid CSS!