From 4868ae4f78d13401828628f838f27fe47f7c5cd0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20=C4=8Ciha=C5=99?= Date: Fri, 9 Nov 2012 14:14:32 +0100 Subject: [PATCH] Split some long texts into paragraphs --- config.rst | 2168 +++++++++++++++++++++++++++------------------------- 1 file changed, 1147 insertions(+), 1021 deletions(-) diff --git a/config.rst b/config.rst index 61c6b79f18..ffc54f8e78 100644 --- a/config.rst +++ b/config.rst @@ -31,82 +31,92 @@ Basic settings :type: string :default: ``''`` -Sets here the complete :abbr:`URL (Uniform Resource Locator)` (with -full path) to your phpMyAdmin installation's directory. E.g. -``http://www.your_web.net/path_to_your_phpMyAdmin_directory/``. -Note also that the :abbr:`URL (Uniform Resource Locator)` on some web -servers are case–sensitive. Don’t forget the trailing slash at the -end. Starting with version 2.3.0, it is advisable to try leaving this -blank. In most cases phpMyAdmin automatically detects the proper -setting. Users of port forwarding will need to set PmaAbsoluteUri -(`more info `_). A good test is to browse a -table, edit a row and save it. There should be an error message if -phpMyAdmin is having trouble auto–detecting the correct value. If you -get an error that this must be set or if the autodetect code fails to -detect your path, please post a bug report on our bug tracker so we -can improve the code. + Sets here the complete :abbr:`URL (Uniform Resource Locator)` (with + full path) to your phpMyAdmin installation's directory. E.g. + ``http://www.your_web.net/path_to_your_phpMyAdmin_directory/``. + Note also that the :abbr:`URL (Uniform Resource Locator)` on some web + servers are case–sensitive. Don’t forget the trailing slash at the + end. + + Starting with version 2.3.0, it is advisable to try leaving this + blank. In most cases phpMyAdmin automatically detects the proper + setting. Users of port forwarding will need to set PmaAbsoluteUri + (`more info `_). + + A good test is to browse a + table, edit a row and save it. There should be an error message if + phpMyAdmin is having trouble auto–detecting the correct value. If you + get an error that this must be set or if the autodetect code fails to + detect your path, please post a bug report on our bug tracker so we + can improve the code. .. config:option:: $cfg['PmaNoRelation_DisableWarning'] :type: boolean :default: false -Starting with version 2.3.0 phpMyAdmin offers a lot of features to -work with master / foreign – tables (see :config:option:`$cfg['Servers'][$i]['pmadb']`). If you tried to set this -up and it does not work for you, have a look on the "Structure" page -of one database where you would like to use it. You will find a link -that will analyze why those features have been disabled. If you do not -want to use those features set this variable to ``TRUE`` to stop this -message from appearing. + Starting with version 2.3.0 phpMyAdmin offers a lot of features to + work with master / foreign – tables (see :config:option:`$cfg['Servers'][$i]['pmadb']`). + + If you tried to set this + up and it does not work for you, have a look on the "Structure" page + of one database where you would like to use it. You will find a link + that will analyze why those features have been disabled. + + If you do not + want to use those features set this variable to ``TRUE`` to stop this + message from appearing. .. config:option:: $cfg['SuhosinDisableWarning'] :type: boolean :default: false -A warning is displayed on the main page if Suhosin is detected. You -can set this parameter to ``TRUE`` to stop this message from -appearing. + A warning is displayed on the main page if Suhosin is detected. You + can set this parameter to ``TRUE`` to stop this message from + appearing. .. config:option:: $cfg['McryptDisableWarning'] :type: boolean :default: false -Disable the default warning that is displayed if mcrypt is missing for -cookie authentication. You can set this parameter to ``TRUE`` to stop -this message from appearing. + Disable the default warning that is displayed if mcrypt is missing for + cookie authentication. You can set this parameter to ``TRUE`` to stop + this message from appearing. .. config:option:: $cfg['ServerLibraryDifference_DisableWarning'] :type: boolean :default: false -A warning is displayed on the main page if there is a difference -between the MySQL library and server version. You can set this -parameter to ``TRUE`` to stop this message from appearing. + A warning is displayed on the main page if there is a difference + between the MySQL library and server version. You can set this + parameter to ``TRUE`` to stop this message from appearing. .. config:option:: $cfg['TranslationWarningThreshold'] :type: integer :default: 80 -Show warning about incomplete translations on certain threshold. + Show warning about incomplete translations on certain threshold. .. config:option:: $cfg['blowfish_secret'] :type: string :default: ``''`` -The "cookie" auth\_type uses blowfish algorithm to encrypt the -password. If you are using the "cookie" auth\_type, enter here a -random passphrase of your choice. It will be used internally by the -blowfish algorithm: you won’t be prompted for this passphrase. There -is no maximum length for this secret. Since version 3.1.0 phpMyAdmin -can generate this on the fly, but it makes a bit weaker security as -this generated secret is stored in session and furthermore it makes -impossible to recall user name from cookie. + The "cookie" auth\_type uses blowfish algorithm to encrypt the + password. If you are using the "cookie" auth\_type, enter here a + random passphrase of your choice. It will be used internally by the + blowfish algorithm: you won’t be prompted for this passphrase. There + is no maximum length for this secret. + + Since version 3.1.0 phpMyAdmin + can generate this on the fly, but it makes a bit weaker security as + this generated secret is stored in session and furthermore it makes + impossible to recall user name from cookie. Server connection settings -------------------------- @@ -116,82 +126,82 @@ Server connection settings :type: array :default: one server array with settings listed bellow -Since version 1.4.2, phpMyAdmin supports the administration of -multiple MySQL servers. Therefore, a :config:option:`$cfg['Servers']`-array has been added which -contains the login information for the different servers. The first -:config:option:`$cfg['Servers'][$i]['host']` -contains the hostname of the first server, the second :config:option:`$cfg['Servers'][$i]['host']` the hostname of -the second server, etc. In :file:`libraries/config.default.php`, there -is only one section for server definition, however you can put as many -as you need in :file:`config.inc.php`, copy that block or needed parts -(you don't have to define all settings, just those you need to -change). + Since version 1.4.2, phpMyAdmin supports the administration of + multiple MySQL servers. Therefore, a :config:option:`$cfg['Servers']`-array has been added which + contains the login information for the different servers. The first + :config:option:`$cfg['Servers'][$i]['host']` + contains the hostname of the first server, the second :config:option:`$cfg['Servers'][$i]['host']` the hostname of + the second server, etc. In :file:`libraries/config.default.php`, there + is only one section for server definition, however you can put as many + as you need in :file:`config.inc.php`, copy that block or needed parts + (you don't have to define all settings, just those you need to + change). .. config:option:: $cfg['Servers'][$i]['host'] :type: string :default: ``'localhost'`` -The hostname or :abbr:`IP (Internet Protocol)` address of your $i-th -MySQL-server. E.g. localhost. + The hostname or :abbr:`IP (Internet Protocol)` address of your $i-th + MySQL-server. E.g. localhost. .. config:option:: $cfg['Servers'][$i]['port'] :type: string :default: ``''`` -The port-number of your $i-th MySQL-server. Default is 3306 (leave -blank). If you use "localhost" as the hostname, MySQL ignores this -port number and connects with the socket, so if you want to connect to -a port different from the default port, use "127.0.0.1" or the real -hostname in :config:option:`$cfg['Servers'][$i]['host']`. + The port-number of your $i-th MySQL-server. Default is 3306 (leave + blank). If you use "localhost" as the hostname, MySQL ignores this + port number and connects with the socket, so if you want to connect to + a port different from the default port, use "127.0.0.1" or the real + hostname in :config:option:`$cfg['Servers'][$i]['host']`. .. config:option:: $cfg['Servers'][$i]['socket'] :type: string :default: ``''`` -The path to the socket to use. Leave blank for default. To determine -the correct socket, check your MySQL configuration or, using the -``mysql`` command–line client, issue the ``status`` command. Among the -resulting information displayed will be the socket used. + The path to the socket to use. Leave blank for default. To determine + the correct socket, check your MySQL configuration or, using the + ``mysql`` command–line client, issue the ``status`` command. Among the + resulting information displayed will be the socket used. .. config:option:: $cfg['Servers'][$i]['ssl'] :type: boolean :default: false -Whether to enable SSL for connection to MySQL server. + Whether to enable SSL for connection to MySQL server. .. config:option:: $cfg['Servers'][$i]['connect_type'] :type: string :default: ``'tcp'`` -What type connection to use with the MySQL server. Your options are -``'socket'`` and ``'tcp'``. It defaults to 'tcp' as that is nearly -guaranteed to be available on all MySQL servers, while sockets are not -supported on some platforms. To use the socket mode, your MySQL server -must be on the same machine as the Web server. + What type connection to use with the MySQL server. Your options are + ``'socket'`` and ``'tcp'``. It defaults to 'tcp' as that is nearly + guaranteed to be available on all MySQL servers, while sockets are not + supported on some platforms. To use the socket mode, your MySQL server + must be on the same machine as the Web server. .. config:option:: $cfg['Servers'][$i]['extension'] :type: string :default: ``'mysqli'`` -What php MySQL extension to use for the connection. Valid options are: -``*mysql*`` : The classic MySQL extension. ``*mysqli*`` : The improved -MySQL extension. This extension became available with PHP 5.0.0 and is -the recommended way to connect to a server running MySQL 4.1.x or -newer. + What php MySQL extension to use for the connection. Valid options are: + ``*mysql*`` : The classic MySQL extension. ``*mysqli*`` : The improved + MySQL extension. This extension became available with PHP 5.0.0 and is + the recommended way to connect to a server running MySQL 4.1.x or + newer. .. config:option:: $cfg['Servers'][$i]['compress'] :type: boolean :default: false -Whether to use a compressed protocol for the MySQL server connection -or not (experimental). + Whether to use a compressed protocol for the MySQL server connection + or not (experimental). .. _controlhost: .. config:option:: $cfg['Servers'][$i]['controlhost'] @@ -199,8 +209,8 @@ or not (experimental). :type: string :default: ``''`` -Permits to use an alternate host to hold the configuration storage -data. + Permits to use an alternate host to hold the configuration storage + data. .. _controluser: .. config:option:: $cfg['Servers'][$i]['controluser'] @@ -213,55 +223,57 @@ data. :type: string :default: ``''`` -This special account is used for 2 distinct purposes: to make possible all -relational features (see :config:option:`$cfg['Servers'][$i]['pmadb']`) and, -for a MySQL server running with ``--skip-show-database``, to enable a -multi-user installation (:abbr:`HTTP (HyperText Transfer Protocol)` or cookie -authentication mode). When using :abbr:`HTTP (HyperText Transfer Protocol)` or -cookie authentication modes (or 'config' authentication mode since phpMyAdmin -2.2.1), you need to supply the details of a MySQL account that has ``SELECT`` -privilege on the *mysql.user (all columns except "Password")*, *mysql.db (all -columns)* and *mysql.tables\_priv (all columns except "Grantor" and -"Timestamp")* tables. This account is used to check what databases the user -will see at login. + This special account is used for 2 distinct purposes: to make possible all + relational features (see :config:option:`$cfg['Servers'][$i]['pmadb']`) and, + for a MySQL server running with ``--skip-show-database``, to enable a + multi-user installation (:abbr:`HTTP (HyperText Transfer Protocol)` or cookie + authentication mode). -.. versionchanged:: 2.2.5 - those were called "stduser/stdpass" + When using :abbr:`HTTP (HyperText Transfer Protocol)` or + cookie authentication modes (or 'config' authentication mode since phpMyAdmin + 2.2.1), you need to supply the details of a MySQL account that has ``SELECT`` + privilege on the *mysql.user (all columns except "Password")*, *mysql.db (all + columns)* and *mysql.tables\_priv (all columns except "Grantor" and + "Timestamp")* tables. This account is used to check what databases the user + will see at login. -.. seealso:: :ref:`setup`, :ref:`authentication_modes` + .. versionchanged:: 2.2.5 + those were called "stduser/stdpass" + + .. seealso:: :ref:`setup`, :ref:`authentication_modes` .. config:option:: $cfg['Servers'][$i]['auth_type'] :type: string :default: ``'cookie'`` -Whether config or cookie or :abbr:`HTTP (HyperText Transfer Protocol)` -or signon authentication should be used for this server. + Whether config or cookie or :abbr:`HTTP (HyperText Transfer Protocol)` + or signon authentication should be used for this server. -* 'config' authentication (``$auth_type = 'config'``) is the plain old - way: username and password are stored in :file:`config.inc.php`. -* 'cookie' authentication mode (``$auth_type = 'cookie'``) as - introduced in 2.2.3 allows you to log in as any valid MySQL user with - the help of cookies. Username and password are stored in cookies - during the session and password is deleted when it ends. This can also - allow you to log in in arbitrary server if :config:option:`$cfg['AllowArbitraryServer']` enabled. -* ':abbr:`HTTP (HyperText Transfer Protocol)`' authentication (was - called 'advanced' in previous versions and can be written also as - 'http') (``$auth_type = 'http';'``) as introduced in 1.3.0 allows you to log in as any - valid MySQL user via HTTP-Auth. -* 'signon' authentication mode (``$auth_type = 'signon'``) as - introduced in 2.10.0 allows you to log in from prepared PHP session - data or using supplied PHP script. This is useful for implementing - single signon from another application. Sample way how to seed session - is in signon example: :file:`examples/signon.php`. There is also - alternative example using OpenID - :file:`examples/openid.php` and example - for scripts based solution - :file:`examples/signon-script.php`. You need - to configure :config:option:`$cfg['Servers'][$i]['SignonSession']` or - :config:option:`$cfg['Servers'][$i]['SignonScript']` and - :config:option:`$cfg['Servers'][$i]['SignonURL']` to use this authentication - method. + * 'config' authentication (``$auth_type = 'config'``) is the plain old + way: username and password are stored in :file:`config.inc.php`. + * 'cookie' authentication mode (``$auth_type = 'cookie'``) as + introduced in 2.2.3 allows you to log in as any valid MySQL user with + the help of cookies. Username and password are stored in cookies + during the session and password is deleted when it ends. This can also + allow you to log in in arbitrary server if :config:option:`$cfg['AllowArbitraryServer']` enabled. + * 'http' authentication (was + called 'advanced' in previous versions and can be written also as + 'http') (``$auth_type = 'http';'``) as introduced in 1.3.0 allows you to log in as any + valid MySQL user via HTTP-Auth. + * 'signon' authentication mode (``$auth_type = 'signon'``) as + introduced in 2.10.0 allows you to log in from prepared PHP session + data or using supplied PHP script. This is useful for implementing + single signon from another application. Sample way how to seed session + is in signon example: :file:`examples/signon.php`. There is also + alternative example using OpenID - :file:`examples/openid.php` and example + for scripts based solution - :file:`examples/signon-script.php`. You need + to configure :config:option:`$cfg['Servers'][$i]['SignonSession']` or + :config:option:`$cfg['Servers'][$i]['SignonScript']` and + :config:option:`$cfg['Servers'][$i]['SignonURL']` to use this authentication + method. -.. seealso:: :ref:`authentication_modes` + .. seealso:: :ref:`authentication_modes` .. _servers_auth_http_realm: .. config:option:: $cfg['Servers'][$i]['auth_http_realm'] @@ -269,12 +281,12 @@ or signon authentication should be used for this server. :type: string :default: ``''`` -When using auth\_type = ':abbr:`HTTP (HyperText Transfer Protocol)`', -this field allows to define a custom :abbr:`HTTP (HyperText Transfer -Protocol)` Basic Auth Realm which will be displayed to the user. If -not explicitly specified in your configuration, a string combined of -"phpMyAdmin " and either :config:option:`$cfg['Servers'][$i]['verbose']` -or :config:option:`$cfg['Servers'][$i]['host']` will be used. + When using auth\_type = ':abbr:`HTTP (HyperText Transfer Protocol)`', + this field allows to define a custom :abbr:`HTTP (HyperText Transfer + Protocol)` Basic Auth Realm which will be displayed to the user. If + not explicitly specified in your configuration, a string combined of + "phpMyAdmin " and either :config:option:`$cfg['Servers'][$i]['verbose']` + or :config:option:`$cfg['Servers'][$i]['host']` will be used. .. _servers_auth_swekey_config: .. config:option:: $cfg['Servers'][$i]['auth_swekey_config'] @@ -282,8 +294,8 @@ or :config:option:`$cfg['Servers'][$i]['host']` will be used. :type: string :default: ``''`` -The name of the file containing :ref:`swekey` ids and login names for hardware -authentication. Leave empty to deactivate this feature. + The name of the file containing :ref:`swekey` ids and login names for hardware + authentication. Leave empty to deactivate this feature. .. _servers_user: .. config:option:: $cfg['Servers'][$i]['user'] @@ -296,10 +308,11 @@ authentication. Leave empty to deactivate this feature. :type: string :default: ``''`` -When using auth\_type = 'config', this is the user/password-pair which -phpMyAdmin will use to connect to the MySQL server. This user/password -pair is not needed when :abbr:`HTTP (HyperText Transfer Protocol)` or -cookie authentication is used and should be empty. + When using :config:option:`$cfg['Servers'][$i]['auth_type']` set to + 'config', this is the user/password-pair which phpMyAdmin will use to + connect to the MySQL server. This user/password pair is not needed when + :abbr:`HTTP (HyperText Transfer Protocol)` or cookie authentication is used + and should be empty. .. _servers_nopassword: .. config:option:: $cfg['Servers'][$i]['nopassword'] @@ -307,12 +320,12 @@ cookie authentication is used and should be empty. :type: boolean :default: false -Allow attempt to log in without password when a login with password -fails. This can be used together with http authentication, when -authentication is done some other way and phpMyAdmin gets user name -from auth and uses empty password for connecting to MySQL. Password -login is still tried first, but as fallback, no password method is -tried. + Allow attempt to log in without password when a login with password + fails. This can be used together with http authentication, when + authentication is done some other way and phpMyAdmin gets user name + from auth and uses empty password for connecting to MySQL. Password + login is still tried first, but as fallback, no password method is + tried. .. _servers_only_db: .. config:option:: $cfg['Servers'][$i]['only_db'] @@ -320,77 +333,93 @@ tried. :type: string or array :default: ``''`` -If set to a (an array of) database name(s), only this (these) -database(s) will be shown to the user. Since phpMyAdmin 2.2.1, -this/these database(s) name(s) may contain MySQL wildcards characters -("\_" and "%"): if you want to use literal instances of these -characters, escape them (I.E. use ``'my\_db'`` and not ``'my_db'``). -This setting is an efficient way to lower the server load since the -latter does not need to send MySQL requests to build the available -database list. But **it does not replace the privileges rules of the -MySQL database server**. If set, it just means only these databases -will be displayed but **not that all other databases can't be used.** -An example of using more that one database: -``$cfg['Servers'][$i]['only_db'] = array('db1', 'db2');`` As of -phpMyAdmin 2.5.5 the order inside the array is used for sorting the -databases in the navigation panel, so that you can individually -arrange your databases. If you want to have certain databases at the -top, but don't care about the others, you do not need to specify all -other databases. Use: ``$cfg['Servers'][$i]['only_db'] = array('db3', -'db4', '\*');`` instead to tell phpMyAdmin that it should display db3 -and db4 on top, and the rest in alphabetic order. + If set to a (an array of) database name(s), only this (these) + database(s) will be shown to the user. Since phpMyAdmin 2.2.1, + this/these database(s) name(s) may contain MySQL wildcards characters + ("\_" and "%"): if you want to use literal instances of these + characters, escape them (I.E. use ``'my\_db'`` and not ``'my_db'``). + + This setting is an efficient way to lower the server load since the + latter does not need to send MySQL requests to build the available + database list. But **it does not replace the privileges rules of the + MySQL database server**. If set, it just means only these databases + will be displayed but **not that all other databases can't be used.** + + An example of using more that one database: + + .. code-block:: php + + $cfg['Servers'][$i]['only_db'] = array('db1', 'db2'); + + .. versionchanged:: 2.5.5 + The order inside the array is used for sorting the + databases in the navigation panel, so that you can individually + arrange your databases. + + If you want to have certain databases at the top, but don't care about the + others, you do not need to specify all other databases. Use following code + instead to tell phpMyAdmin that it should display db3 and db4 on top, and + the rest in alphabetic order: + + .. code-block:: php + + $cfg['Servers'][$i]['only_db'] = array('db3', 'db4', '\*'); + .. config:option:: $cfg['Servers'][$i]['hide_db'] :type: string :default: ``''`` -Regular expression for hiding some databases from unprivileged users. -This only hides them from listing, but a user is still able to access -them (using, for example, the SQL query area). To limit access, use -the MySQL privilege system. For example, to hide all databases -starting with the letter "a", use + Regular expression for hiding some databases from unprivileged users. + This only hides them from listing, but a user is still able to access + them (using, for example, the SQL query area). To limit access, use + the MySQL privilege system. For example, to hide all databases + starting with the letter "a", use -.. code-block:: php + .. code-block:: php - $cfg['Servers'][$i]['hide_db'] = '^a'; + $cfg['Servers'][$i]['hide_db'] = '^a'; -and to hide both "db1" and "db2" use + and to hide both "db1" and "db2" use -.. code-block:: php + .. code-block:: php - $cfg['Servers'][$i]['hide_db'] = '^(db1|db2)$'; + $cfg['Servers'][$i]['hide_db'] = '^(db1|db2)$'; -More information on regular expressions can be found in the `PCRE -pattern syntax -`_ portion -of the PHP reference manual. + More information on regular expressions can be found in the `PCRE + pattern syntax + `_ portion + of the PHP reference manual. .. config:option:: $cfg['Servers'][$i]['verbose'] :type: string :default: ``''`` -Only useful when using phpMyAdmin with multiple server entries. If -set, this string will be displayed instead of the hostname in the -pull-down menu on the main page. This can be useful if you want to -show only certain databases on your system, for example. For HTTP -auth, all non-US-ASCII characters will be stripped. + Only useful when using phpMyAdmin with multiple server entries. If + set, this string will be displayed instead of the hostname in the + pull-down menu on the main page. This can be useful if you want to + show only certain databases on your system, for example. For HTTP + auth, all non-US-ASCII characters will be stripped. .. config:option:: $cfg['Servers'][$i]['pmadb'] :type: string :default: ``''`` -The name of the database containing the phpMyAdmin configuration -storage. See the :ref:`linked-tables` section in this document to see the benefits of -this feature, and for a quick way of creating this database and the -needed tables. If you are the only user of this phpMyAdmin -installation, you can use your current database to store those special -tables; in this case, just put your current database name in -:config:option:`$cfg['Servers'][$i]['pmadb']`. For a multi-user installation, set -this parameter to the name of your central database containing the -phpMyAdmin configuration storage. + The name of the database containing the phpMyAdmin configuration + storage. + + See the :ref:`linked-tables` section in this document to see the benefits of + this feature, and for a quick way of creating this database and the needed + tables. + + If you are the only user of this phpMyAdmin installation, you can use your + current database to store those special tables; in this case, just put your + current database name in :config:option:`$cfg['Servers'][$i]['pmadb']`. For a + multi-user installation, set this parameter to the name of your central + database containing the phpMyAdmin configuration storage. .. _bookmark: .. config:option:: $cfg['Servers'][$i]['bookmarktable'] @@ -398,13 +427,12 @@ phpMyAdmin configuration storage. :type: string :default: ``''`` -Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This -can be useful for queries you often run. To allow the usage of this -functionality: - -* set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage -* enter the table name in :config:option:`$cfg['Servers'][$i]['bookmarktable']` + Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This + can be useful for queries you often run. To allow the usage of this + functionality: + * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage + * enter the table name in :config:option:`$cfg['Servers'][$i]['bookmarktable']` .. _relation: @@ -413,35 +441,38 @@ functionality: :type: string :default: ``''`` -Since release 2.2.4 you can describe, in a special 'relation' table, -which column is a key in another table (a foreign key). phpMyAdmin -currently uses this to + Since release 2.2.4 you can describe, in a special 'relation' table, + which column is a key in another table (a foreign key). phpMyAdmin + currently uses this to -* make clickable, when you browse the master table, the data values that - point to the foreign table; -* display in an optional tool-tip the "display column" when browsing the - master table, if you move the mouse to a column containing a foreign - key (use also the 'table\_info' table); (see :ref:`faqdisplay`) -* in edit/insert mode, display a drop-down list of possible foreign keys - (key value and "display column" are shown) (see :ref:`faq6_21`) -* display links on the table properties page, to check referential - integrity (display missing foreign keys) for each described key; -* in query-by-example, create automatic joins (see :ref:`faq6_6`) -* enable you to get a :abbr:`PDF (Portable Document Format)` schema of - your database (also uses the table\_coords table). + * make clickable, when you browse the master table, the data values that + point to the foreign table; + * display in an optional tool-tip the "display column" when browsing the + master table, if you move the mouse to a column containing a foreign + key (use also the 'table\_info' table); (see :ref:`faqdisplay`) + * in edit/insert mode, display a drop-down list of possible foreign keys + (key value and "display column" are shown) (see :ref:`faq6_21`) + * display links on the table properties page, to check referential + integrity (display missing foreign keys) for each described key; + * in query-by-example, create automatic joins (see :ref:`faq6_6`) + * enable you to get a :abbr:`PDF (Portable Document Format)` schema of + your database (also uses the table\_coords table). -The keys can be numeric or character. To allow the usage of this -functionality: + The keys can be numeric or character. -* set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage -* put the relation table name in :config:option:`$cfg['Servers'][$i]['relation']` -* now as normal user open phpMyAdmin and for each one of your tables - where you want to use this feature, click "Structure/Relation view/" - and choose foreign columns. + To allow the usage of this functionality: -Please note that in the current version, ``master_db`` must be the -same as ``foreign_db``. Those columns have been put in future -development of the cross-db relations. + * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage + * put the relation table name in :config:option:`$cfg['Servers'][$i]['relation']` + * now as normal user open phpMyAdmin and for each one of your tables + where you want to use this feature, click "Structure/Relation view/" + and choose foreign columns. + + .. note:: + + In the current version, ``master_db`` must be the same as ``foreign_db``. + Those columns have been put in future development of the cross-db + relations. .. _table_info: .. config:option:: $cfg['Servers'][$i]['table_info'] @@ -449,20 +480,20 @@ development of the cross-db relations. :type: string :default: ``''`` -Since release 2.3.0 you can describe, in a special 'table\_info' -table, which column is to be displayed as a tool-tip when moving the -cursor over the corresponding key. This configuration variable will -hold the name of this special table. To allow the usage of this -functionality: + Since release 2.3.0 you can describe, in a special 'table\_info' + table, which column is to be displayed as a tool-tip when moving the + cursor over the corresponding key. This configuration variable will + hold the name of this special table. To allow the usage of this + functionality: -* set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage -* put the table name in :config:option:`$cfg['Servers'][$i]['table\_info']` (e.g. - 'pma\_table\_info') -* then for each table where you want to use this feature, click - "Structure/Relation view/Choose column to display" to choose the - column. + * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage + * put the table name in :config:option:`$cfg['Servers'][$i]['table\_info']` (e.g. + 'pma\_table\_info') + * then for each table where you want to use this feature, click + "Structure/Relation view/Choose column to display" to choose the + column. -Usage tip: :ref:`faqdisplay`. + Usage tip: :ref:`faqdisplay`. .. _table_coords: .. config:option:: $cfg['Servers'][$i]['table_coords'] @@ -475,21 +506,22 @@ Usage tip: :ref:`faqdisplay`. :type: string :default: ``''`` -Since release 2.3.0 you can have phpMyAdmin create :abbr:`PDF -(Portable Document Format)` pages showing the relations between your -tables. To do this it needs two tables "pdf\_pages" (storing -information about the available :abbr:`PDF (Portable Document Format)` -pages) and "table\_coords" (storing coordinates where each table will -be placed on a :abbr:`PDF (Portable Document Format)` schema output). -You must be using the "relation" feature. To allow the usage of this -functionality: + Since release 2.3.0 you can have phpMyAdmin create :abbr:`PDF + (Portable Document Format)` pages showing the relations between your + tables. To do this it needs two tables "pdf\_pages" (storing + information about the available :abbr:`PDF (Portable Document Format)` + pages) and "table\_coords" (storing coordinates where each table will + be placed on a :abbr:`PDF (Portable Document Format)` schema output). + You must be using the "relation" feature. -* set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage -* put the correct table names in - :config:option:`$cfg['Servers'][$i]['table\_coords']` and - :config:option:`$cfg['Servers'][$i]['pdf\_pages']` + To allow the usage of this functionality: -Usage tips: :ref:`faqpdf`. + * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage + * put the correct table names in + :config:option:`$cfg['Servers'][$i]['table\_coords']` and + :config:option:`$cfg['Servers'][$i]['pdf\_pages']` + + .. seealso:: :ref:`faqpdf`. .. _col_com: .. config:option:: $cfg['Servers'][$i]['column_info'] @@ -497,34 +529,39 @@ Usage tips: :ref:`faqpdf`. :type: string :default: ``''`` -This part requires a content update! Since release 2.3.0 you can -store comments to describe each column for each table. These will then -be shown on the "printview". Starting with release 2.5.0, comments -are consequently used on the table property pages and table browse -view, showing up as tool-tips above the column name (properties page) -or embedded within the header of table in browse view. They can also -be shown in a table dump. Please see the relevant configuration -directives later on. Also new in release 2.5.0 is a MIME- -transformation system which is also based on the following table -structure. See :ref:`transformations` for further information. To use the MIME- -transformation system, your column\_info table has to have the three -new columns 'mimetype', 'transformation', 'transformation\_options'. -To allow the usage of this functionality: + This part requires a content update! Since release 2.3.0 you can + store comments to describe each column for each table. These will then + be shown on the "printview". -* set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage -* put the table name in :config:option:`$cfg['Servers'][$i]['column\_info']` (e.g. - 'pma\_column\_info') -* to update your PRE-2.5.0 Column\_comments Table use this: and - remember that the Variable in :file:`config.inc.php` has been renamed from - :config:option:`$cfg['Servers'][$i]['column\_comments']` to - :config:option:`$cfg['Servers'][$i]['column\_info']` + Starting with release 2.5.0, comments are consequently used on the table + property pages and table browse view, showing up as tool-tips above the + column name (properties page) or embedded within the header of table in + browse view. They can also be shown in a table dump. Please see the + relevant configuration directives later on. - .. code-block:: sql + Also new in release 2.5.0 is a MIME- transformation system which is also + based on the following table structure. See :ref:`transformations` for + further information. To use the MIME- transformation system, your + column\_info table has to have the three new columns 'mimetype', + 'transformation', 'transformation\_options'. - ALTER TABLE `pma_column_comments` - ADD `mimetype` VARCHAR( 255 ) NOT NULL, - ADD `transformation` VARCHAR( 255 ) NOT NULL, - ADD `transformation_options` VARCHAR( 255 ) NOT NULL; + + To allow the usage of this functionality: + + * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage + * put the table name in :config:option:`$cfg['Servers'][$i]['column\_info']` (e.g. + 'pma\_column\_info') + * to update your PRE-2.5.0 Column\_comments Table use this: and + remember that the Variable in :file:`config.inc.php` has been renamed from + :config:option:`$cfg['Servers'][$i]['column\_comments']` to + :config:option:`$cfg['Servers'][$i]['column\_info']` + + .. code-block:: sql + + ALTER TABLE `pma_column_comments` + ADD `mimetype` VARCHAR( 255 ) NOT NULL, + ADD `transformation` VARCHAR( 255 ) NOT NULL, + ADD `transformation_options` VARCHAR( 255 ) NOT NULL; .. _history: .. config:option:: $cfg['Servers'][$i]['history'] @@ -532,21 +569,24 @@ To allow the usage of this functionality: :type: string :default: ``''`` -Since release 2.5.0 you can store your :abbr:`SQL (structured query -language)` history, which means all queries you entered manually into -the phpMyAdmin interface. If you don't want to use a table-based -history, you can use the JavaScript-based history. Using that, all -your history items are deleted when closing the window. Using -:config:option:`$cfg['QueryHistoryMax']` you can specify an amount of history -items you want to have on hold. On every login, this list gets cut to the -maximum amount. The query history is only available if JavaScript is enabled in -your browser. To allow the usage of this functionality: + Since release 2.5.0 you can store your :abbr:`SQL (structured query + language)` history, which means all queries you entered manually into + the phpMyAdmin interface. If you don't want to use a table-based + history, you can use the JavaScript-based history. -* set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage -* put the table name in :config:option:`$cfg['Servers'][$i]['history']` (e.g. - 'pma\_history') + Using that, all your history items are deleted when closing the window. + Using :config:option:`$cfg['QueryHistoryMax']` you can specify an amount of + history items you want to have on hold. On every login, this list gets cut + to the maximum amount. + The query history is only available if JavaScript is enabled in + your browser. + To allow the usage of this functionality: + + * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage + * put the table name in :config:option:`$cfg['Servers'][$i]['history']` (e.g. + 'pma\_history') .. _recent: .. config:option:: $cfg['Servers'][$i]['recent'] @@ -554,21 +594,22 @@ your browser. To allow the usage of this functionality: :type: string :default: ``''`` -Since release 3.5.0 you can show recently used tables in the -navigation panel. It helps you to jump across table directly, without -the need to select the database, and then select the table. Using -:config:option:`$cfg['NumRecentTables']` you can configure the maximum number -of recent tables shown. When you select a table from the list, it will jump to -the page specified in :config:option:`$cfg['NavigationTreeDefaultTabTable']`. -Without configuring the storage, you can still access the recently used tables, -but it will disappear after you logout. To allow the usage of this -functionality persistently: - -* set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage -* put the table name in :config:option:`$cfg['Servers'][$i]['recent']` (e.g. - 'pma\_recent') + Since release 3.5.0 you can show recently used tables in the + navigation panel. It helps you to jump across table directly, without + the need to select the database, and then select the table. Using + :config:option:`$cfg['NumRecentTables']` you can configure the maximum number + of recent tables shown. When you select a table from the list, it will jump to + the page specified in :config:option:`$cfg['NavigationTreeDefaultTabTable']`. + Without configuring the storage, you can still access the recently used tables, + but it will disappear after you logout. + + To allow the usage of this functionality persistently: + + * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage + * put the table name in :config:option:`$cfg['Servers'][$i]['recent']` (e.g. + 'pma\_recent') .. _table_uiprefs: .. config:option:: $cfg['Servers'][$i]['table_uiprefs'] @@ -576,17 +617,17 @@ functionality persistently: :type: string :default: ``''`` -Since release 3.5.0 phpMyAdmin can be configured to remember several -things (sorted column :config:option:`$cfg['RememberSorting']`, column order, -and column visibility from a database table) for browsing tables. Without -configuring the storage, these features still can be used, but the values will -disappear after you logout. To allow the usage of these functionality -persistently: + Since release 3.5.0 phpMyAdmin can be configured to remember several + things (sorted column :config:option:`$cfg['RememberSorting']`, column order, + and column visibility from a database table) for browsing tables. Without + configuring the storage, these features still can be used, but the values will + disappear after you logout. -* set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage -* put the table name in :config:option:`$cfg['Servers'][$i]['table\_uiprefs']` (e.g. - 'pma\_table\_uiprefs') + To allow the usage of these functionality persistently: + * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage + * put the table name in :config:option:`$cfg['Servers'][$i]['table\_uiprefs']` (e.g. + 'pma\_table\_uiprefs') .. _tracking: @@ -595,29 +636,31 @@ persistently: :type: string :default: ``''`` -Since release 3.3.x a tracking mechanism is available. It helps you to -track every :abbr:`SQL (structured query language)` command which is -executed by phpMyAdmin. The mechanism supports logging of data -manipulation and data definition statements. After enabling it you can -create versions of tables. The creation of a version has two effects: + Since release 3.3.x a tracking mechanism is available. It helps you to + track every :abbr:`SQL (structured query language)` command which is + executed by phpMyAdmin. The mechanism supports logging of data + manipulation and data definition statements. After enabling it you can + create versions of tables. -* phpMyAdmin saves a snapshot of the table, including structure and - indexes. -* phpMyAdmin logs all commands which change the structure and/or data of - the table and links these commands with the version number. + The creation of a version has two effects: -Of course you can view the tracked changes. On the "Tracking" page a -complete report is available for every version. For the report you can -use filters, for example you can get a list of statements within a -date range. When you want to filter usernames you can enter \* for all -names or you enter a list of names separated by ','. In addition you -can export the (filtered) report to a file or to a temporary database. -To allow the usage of this functionality: + * phpMyAdmin saves a snapshot of the table, including structure and + indexes. + * phpMyAdmin logs all commands which change the structure and/or data of + the table and links these commands with the version number. -* set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage -* put the table name in :config:option:`$cfg['Servers'][$i]['tracking']` (e.g. - 'pma\_tracking') + Of course you can view the tracked changes. On the "Tracking" page a + complete report is available for every version. For the report you can + use filters, for example you can get a list of statements within a + date range. When you want to filter usernames you can enter \* for all + names or you enter a list of names separated by ','. In addition you + can export the (filtered) report to a file or to a temporary database. + To allow the usage of this functionality: + + * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage + * put the table name in :config:option:`$cfg['Servers'][$i]['tracking']` (e.g. + 'pma\_tracking') .. _tracking2: @@ -626,15 +669,16 @@ To allow the usage of this functionality: :type: boolean :default: false -Whether the tracking mechanism creates versions for tables and views -automatically. Default value is false. If this is set to true and you -create a table or view with + Whether the tracking mechanism creates versions for tables and views + automatically. -* CREATE TABLE ... -* CREATE VIEW ... + If this is set to true and you create a table or view with -and no version exists for it, the mechanism will create a version for -you automatically. + * CREATE TABLE ... + * CREATE VIEW ... + + and no version exists for it, the mechanism will create a version for + you automatically. .. _tracking3: .. config:option:: $cfg['Servers'][$i]['tracking_default_statements'] @@ -642,8 +686,8 @@ you automatically. :type: string :default: ``'CREATE TABLE,ALTER TABLE,DROP TABLE,RENAME TABLE,CREATE INDEX,DROP INDEX,INSERT,UPDATE,DELETE,TRUNCATE,REPLACE,CREATE VIEW,ALTER VIEW,DROP VIEW,CREATE DATABASE,ALTER DATABASE,DROP DATABASE'`` -Defines the list of statements the auto-creation uses for new -versions. + Defines the list of statements the auto-creation uses for new + versions. .. _tracking4: .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_view'] @@ -651,8 +695,8 @@ versions. :type: boolean :default: true -Whether a DROP VIEW IF EXISTS statement will be added as first line to -the log when creating a view. Default value is true. + Whether a DROP VIEW IF EXISTS statement will be added as first line to + the log when creating a view. .. _tracking5: .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_table'] @@ -660,8 +704,8 @@ the log when creating a view. Default value is true. :type: boolean :default: true -Whether a DROP TABLE IF EXISTS statement will be added as first line -to the log when creating a table. Default value is true. + Whether a DROP TABLE IF EXISTS statement will be added as first line + to the log when creating a table. .. _tracking6: .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_database'] @@ -669,8 +713,8 @@ to the log when creating a table. Default value is true. :type: boolean :default: true -Whether a DROP DATABASE IF EXISTS statement will be added as first -line to the log when creating a database. Default value is true. + Whether a DROP DATABASE IF EXISTS statement will be added as first + line to the log when creating a database. .. _userconfig: .. config:option:: $cfg['Servers'][$i]['userconfig'] @@ -678,15 +722,18 @@ line to the log when creating a database. Default value is true. :type: string :default: ``''`` -Since release 3.4.x phpMyAdmin allows users to set most preferences by -themselves and store them in the database. If you don't allow for -storing preferences in :config:option:`$cfg['Servers'][$i]['pmadb']`, users can -still personalize phpMyAdmin, but settings will be saved in browser's local -storage, or, it is is unavailable, until the end of session. To allow the -usage of this functionality: + Since release 3.4.x phpMyAdmin allows users to set most preferences by + themselves and store them in the database. -* set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage -* put the table name in :config:option:`$cfg['Servers'][$i]['userconfig']` + If you don't allow for storing preferences in + :config:option:`$cfg['Servers'][$i]['pmadb']`, users can still personalize + phpMyAdmin, but settings will be saved in browser's local storage, or, it + is is unavailable, until the end of session. + + To allow the usage of this functionality: + + * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage + * put the table name in :config:option:`$cfg['Servers'][$i]['userconfig']` @@ -696,13 +743,14 @@ usage of this functionality: :type: string :default: ``''`` -Since release 2.10.0 a Designer interface is available; it permits to -visually manage the relations. To allow the usage of this -functionality: + Since release 2.10.0 a Designer interface is available; it permits to + visually manage the relations. -* set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage -* put the table name in :config:option:`$cfg['Servers'][$i]['designer\_coords']` - (e.g. 'pma\_designer\_coords') + To allow the usage of this functionality: + + * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage + * put the table name in :config:option:`$cfg['Servers'][$i]['designer\_coords']` + (e.g. 'pma\_designer\_coords') @@ -711,29 +759,32 @@ functionality: :type: integer :default: 100 -Maximum number of rows saved in -:config:option:`$cfg['Servers'][$i]['table_uiprefs']` table. When tables are -dropped or renamed, table\_uiprefs may contain invalid data (referring to -tables which no longer exist). We only keep this number of newest rows in -table\_uiprefs and automatically delete older rows. + Maximum number of rows saved in + :config:option:`$cfg['Servers'][$i]['table_uiprefs']` table. + + When tables are dropped or renamed, + :config:option:`$cfg['Servers'][$i]['table_uiprefs']` may contain invalid data + (referring to tables which no longer exist). We only keep this number of newest + rows in :config:option:`$cfg['Servers'][$i]['table_uiprefs']` and automatically + delete older rows. .. config:option:: $cfg['Servers'][$i]['AllowRoot'] :type: boolean :default: true -Whether to allow root access. This is just a shortcut for the -AllowDeny rules below. + Whether to allow root access. This is just a shortcut for the + AllowDeny rules below. .. config:option:: $cfg['Servers'][$i]['AllowNoPassword'] :type: boolean :default: false -Whether to allow logins without a password. The default value of -``false`` for this parameter prevents unintended access to a MySQL -server with was left with an empty password for root or on which an -anonymous (blank) user is defined. + Whether to allow logins without a password. The default value of + ``false`` for this parameter prevents unintended access to a MySQL + server with was left with an empty password for root or on which an + anonymous (blank) user is defined. .. _servers_allowdeny_order: .. config:option:: $cfg['Servers'][$i]['AllowDeny']['order'] @@ -741,23 +792,31 @@ anonymous (blank) user is defined. :type: string :default: ``''`` -If your rule order is empty, then :abbr:`IP (Internet Protocol)` -authorization is disabled. If your rule order is set to -``'deny,allow'`` then the system applies all deny rules followed by -allow rules. Access is allowed by default. Any client which does not -match a Deny command or does match an Allow command will be allowed -access to the server. If your rule order is set to ``'allow,deny'`` -then the system applies all allow rules followed by deny rules. Access -is denied by default. Any client which does not match an Allow -directive or does match a Deny directive will be denied access to the -server. If your rule order is set to 'explicit', authorization is -performed in a similar fashion to rule order 'deny,allow', with the -added restriction that your host/username combination **must** be -listed in the *allow* rules, and not listed in the *deny* rules. This -is the **most** secure means of using Allow/Deny rules, and was -available in Apache by specifying allow and deny rules without setting -any order. Please also see :config:option:`$cfg['TrustedProxies']` for -detecting IP address behind proxies. + If your rule order is empty, then :abbr:`IP (Internet Protocol)` + authorization is disabled. + + If your rule order is set to + ``'deny,allow'`` then the system applies all deny rules followed by + allow rules. Access is allowed by default. Any client which does not + match a Deny command or does match an Allow command will be allowed + access to the server. + + If your rule order is set to ``'allow,deny'`` + then the system applies all allow rules followed by deny rules. Access + is denied by default. Any client which does not match an Allow + directive or does match a Deny directive will be denied access to the + server. + + If your rule order is set to ``'explicit'``, authorization is + performed in a similar fashion to rule order 'deny,allow', with the + added restriction that your host/username combination **must** be + listed in the *allow* rules, and not listed in the *deny* rules. This + is the **most** secure means of using Allow/Deny rules, and was + available in Apache by specifying allow and deny rules without setting + any order. + + Please also see :config:option:`$cfg['TrustedProxies']` for + detecting IP address behind proxies. .. _servers_allowdeny_rules: .. config:option:: $cfg['Servers'][$i]['AllowDeny']['rules'] @@ -765,126 +824,135 @@ detecting IP address behind proxies. :type: array of strings :default: array() -The general format for the rules is as such: + The general format for the rules is as such: -.. code-block:: none + .. code-block:: none + + <'allow' | 'deny'> [from] - - <'allow' | 'deny'> [from] + If you wish to match all users, it is possible to use a ``'%'`` as a + wildcard in the *username* field. -If you wish to match all users, it is possible to use a ``'%'`` as a -wildcard in the *username* field. There are a few shortcuts you can -use in the *ipmask* field as well (please note that those containing -SERVER\_ADDRESS might not be available on all webservers): + There are a few shortcuts you can + use in the *ipmask* field as well (please note that those containing + SERVER\_ADDRESS might not be available on all webservers): -.. code-block:: none + .. code-block:: none - - 'all' -> 0.0.0.0/0 - 'localhost' -> 127.0.0.1/8 - 'localnetA' -> SERVER_ADDRESS/8 - 'localnetB' -> SERVER_ADDRESS/16 - 'localnetC' -> SERVER_ADDRESS/24 + + 'all' -> 0.0.0.0/0 + 'localhost' -> 127.0.0.1/8 + 'localnetA' -> SERVER_ADDRESS/8 + 'localnetB' -> SERVER_ADDRESS/16 + 'localnetC' -> SERVER_ADDRESS/24 -Having an empty rule list is equivalent to either using ``'allow % -from all'`` if your rule order is set to ``'deny,allow'`` or ``'deny % -from all'`` if your rule order is set to ``'allow,deny'`` or -``'explicit'``. For the :abbr:`IP (Internet Protocol)` matching -system, the following work: ``xxx.xxx.xxx.xxx`` (an exact :abbr:`IP -(Internet Protocol)` address) ``xxx.xxx.xxx.[yyy-zzz]`` (an :abbr:`IP -(Internet Protocol)` address range) ``xxx.xxx.xxx.xxx/nn`` (CIDR, -Classless Inter-Domain Routing type :abbr:`IP (Internet Protocol)` -addresses) But the following does not work: ``xxx.xxx.xxx.xx[yyy- -zzz]`` (partial :abbr:`IP (Internet Protocol)` address range) Also -IPv6 addresses are not supported. + Having an empty rule list is equivalent to either using ``'allow % + from all'`` if your rule order is set to ``'deny,allow'`` or ``'deny % + from all'`` if your rule order is set to ``'allow,deny'`` or + ``'explicit'``. + + For the :abbr:`IP (Internet Protocol)` matching + system, the following work: + + * ``xxx.xxx.xxx.xxx`` (an exact :abbr:`IP (Internet Protocol)` address) + * ``xxx.xxx.xxx.[yyy-zzz]`` (an :abbr:`IP (Internet Protocol)` address range) + * ``xxx.xxx.xxx.xxx/nn`` (CIDR, Classless Inter-Domain Routing type :abbr:`IP (Internet Protocol)` addresses) + + But the following does not work: + + * ``xxx.xxx.xxx.xx[yyy-zzz]`` (partial :abbr:`IP (Internet Protocol)` address range) + + Also IPv6 addresses are not supported. .. config:option:: $cfg['Servers'][$i]['DisableIS'] :type: boolean :default: true -Disable using ``INFORMATION_SCHEMA`` to retrieve information (use -``SHOW`` commands instead), because of speed issues when many -databases are present. Currently used in some parts of the code, more -to come. + Disable using ``INFORMATION_SCHEMA`` to retrieve information (use + ``SHOW`` commands instead), because of speed issues when many + databases are present. Currently used in some parts of the code, more + to come. .. config:option:: $cfg['Servers'][$i]['ShowDatabasesCommand'] :type: string :default: ``'SHOW DATABASES'`` -On a server with a huge number of databases, the default ``SHOW -DATABASES`` command used to fetch the name of available databases will -probably be too slow, so it can be replaced by faster commands (see -:file:`libraries/config.default.php` for examples). + On a server with a huge number of databases, the default ``SHOW + DATABASES`` command used to fetch the name of available databases will + probably be too slow, so it can be replaced by faster commands (see + :file:`libraries/config.default.php` for examples). .. config:option:: $cfg['Servers'][$i]['CountTables'] :type: boolean :default: false -Whether to count the number of tables for each database when preparing -the list of databases for the navigation panel. + Whether to count the number of tables for each database when preparing + the list of databases for the navigation panel. .. config:option:: $cfg['Servers'][$i]['SignonScript'] :type: string :default: ``''`` -Name of PHP script to be sourced and executed to obtain login -credentials. This is alternative approach to session based single -signon. The script needs to provide function -``get_login_credentials`` which returns list of username and -password, accepting single parameter of existing username (can be -empty). See :file:`examples/signon-script.php` for an example. + Name of PHP script to be sourced and executed to obtain login + credentials. This is alternative approach to session based single + signon. The script needs to provide function + ``get_login_credentials`` which returns list of username and + password, accepting single parameter of existing username (can be + empty). See :file:`examples/signon-script.php` for an example. .. config:option:: $cfg['Servers'][$i]['SignonSession'] :type: string :default: ``''`` -Name of session which will be used for signon authentication method. -You should use something different than ``phpMyAdmin``, because this -is session which phpMyAdmin uses internally. Takes effect only if -:config:option:`$cfg['Servers'][$i]['SignonScript']` is not configured. + Name of session which will be used for signon authentication method. + You should use something different than ``phpMyAdmin``, because this + is session which phpMyAdmin uses internally. Takes effect only if + :config:option:`$cfg['Servers'][$i]['SignonScript']` is not configured. .. config:option:: $cfg['Servers'][$i]['SignonURL'] :type: string :default: ``''`` -:abbr:`URL (Uniform Resource Locator)` where user will be redirected -to log in for signon authentication method. Should be absolute -including protocol. + :abbr:`URL (Uniform Resource Locator)` where user will be redirected + to log in for signon authentication method. Should be absolute + including protocol. .. config:option:: $cfg['Servers'][$i]['LogoutURL'] :type: string :default: ``''`` -:abbr:`URL (Uniform Resource Locator)` where user will be redirected -after logout (doesn't affect config authentication method). Should be -absolute including protocol. + :abbr:`URL (Uniform Resource Locator)` where user will be redirected + after logout (doesn't affect config authentication method). Should be + absolute including protocol. .. config:option:: $cfg['Servers'][$i]['StatusCacheDatabases'] :type: array of strings :default: array() -Enables caching of ``TABLE STATUS`` outputs for specific databases on -this server (in some cases ``TABLE STATUS`` can be very slow, so you -may want to cache it). APC is used (if the PHP extension is available, -if not, this setting is ignored silently). You have to provide -:config:option:`$cfg['Servers'][$i]['StatusCacheLifetime']`. Takes -effect only if :config:option:`$cfg['Servers'][$i]['DisableIS']` is ``true``. + Enables caching of ``TABLE STATUS`` outputs for specific databases on + this server (in some cases ``TABLE STATUS`` can be very slow, so you + may want to cache it). APC is used (if the PHP extension is available, + if not, this setting is ignored silently). You have to provide + :config:option:`$cfg['Servers'][$i]['StatusCacheLifetime']`. + + Takes effect only if :config:option:`$cfg['Servers'][$i]['DisableIS']` is + ``true``. .. config:option:: $cfg['Servers'][$i]['StatusCacheLifetime'] :type: integer :default: 0 -Lifetime in seconds of the ``TABLE STATUS`` cache if -:config:option:`$cfg['Servers'][$i]['StatusCacheDatabases']` is used. + Lifetime in seconds of the ``TABLE STATUS`` cache if + :config:option:`$cfg['Servers'][$i]['StatusCacheDatabases']` is used. Generic settings ---------------- @@ -894,259 +962,265 @@ Generic settings :type: integer :default: 1 -If you have more than one server configured, you can set -:config:option:`$cfg['ServerDefault']` to any one of them to autoconnect to that -server when phpMyAdmin is started, or set it to 0 to be given a list -of servers without logging in. If you have only one server configured, -:config:option:`$cfg['ServerDefault']` MUST be set to that server. + If you have more than one server configured, you can set + :config:option:`$cfg['ServerDefault']` to any one of them to autoconnect to that + server when phpMyAdmin is started, or set it to 0 to be given a list + of servers without logging in. + + If you have only one server configured, + :config:option:`$cfg['ServerDefault']` MUST be set to that server. .. config:option:: $cfg['AjaxEnable'] :type: boolean :default: true -Defines whether to refresh only parts of certain pages using Ajax -techniques. Applies only where a non-Ajax behavior is possible; for -example, the Designer feature is Ajax-only so this directive does not -apply to it. + Defines whether to refresh only parts of certain pages using Ajax + techniques. Applies only where a non-Ajax behavior is possible; for + example, the Designer feature is Ajax-only so this directive does not + apply to it. .. config:option:: $cfg['VersionCheck'] :type: boolean :default: true -Enables check for latest versions using javascript on main phpMyAdmin -page. + Enables check for latest versions using javascript on main phpMyAdmin + page. -.. note:: + .. note:: - This setting can be adjusted by your vendor. + This setting can be adjusted by your vendor. .. config:option:: $cfg['MaxDbList'] :type: integer :default: 100 -The maximum number of database names to be displayed in the database -list. + The maximum number of database names to be displayed in the database + list. .. config:option:: $cfg['MaxNavigationItems'] :type: integer :default: 25 -The number of items that can be displayed on each page of the -navigation tree. + The number of items that can be displayed on each page of the + navigation tree. .. config:option:: $cfg['MaxTableList'] :type: integer :default: 250 -The maximum number of table names to be displayed in the main panel's -list (except on the Export page). This limit is also enforced in the -navigation panel when in Light mode. + The maximum number of table names to be displayed in the main panel's + list (except on the Export page). This limit is also enforced in the + navigation panel when in Light mode. .. config:option:: $cfg['ShowHint'] :type: boolean :default: true -Whether or not to show hints (for example, hints when hovering over -table headers). + Whether or not to show hints (for example, hints when hovering over + table headers). .. config:option:: $cfg['MaxCharactersInDisplayedSQL'] :type: integer :default: 1000 -The maximum number of characters when a :abbr:`SQL (structured query -language)` query is displayed. The default limit of 1000 should be -correct to avoid the display of tons of hexadecimal codes that -represent BLOBs, but some users have real :abbr:`SQL (structured query -language)` queries that are longer than 1000 characters. Also, if a -query's length exceeds this limit, this query is not saved in the -history. + The maximum number of characters when a :abbr:`SQL (structured query + language)` query is displayed. The default limit of 1000 should be correct + to avoid the display of tons of hexadecimal codes that represent BLOBs, but + some users have real :abbr:`SQL (structured query language)` queries that + are longer than 1000 characters. Also, if a query's length exceeds this + limit, this query is not saved in the history. .. config:option:: $cfg['OBGzip'] :type: string/boolean :default: ``'auto'`` -Defines whether to use GZip output buffering for increased speed in -:abbr:`HTTP (HyperText Transfer Protocol)` transfers. Set to -true/false for enabling/disabling. When set to 'auto' (string), -phpMyAdmin tries to enable output buffering and will automatically -disable it if your browser has some problems with buffering. IE6 with -a certain patch is known to cause data corruption when having enabled -buffering. + Defines whether to use GZip output buffering for increased speed in + :abbr:`HTTP (HyperText Transfer Protocol)` transfers. Set to + true/false for enabling/disabling. When set to 'auto' (string), + phpMyAdmin tries to enable output buffering and will automatically + disable it if your browser has some problems with buffering. IE6 with + a certain patch is known to cause data corruption when having enabled + buffering. .. config:option:: $cfg['PersistentConnections'] :type: boolean :default: false -Whether `persistent connections `_ should be used or not. Works with -following extensions: - -* mysql (`mysql\_pconnect `_), -* mysqli (requires PHP 5.3.0 or newer, `more information - `_). - + Whether `persistent connections `_ should be used or not. Works with + following extensions: + * mysql (`mysql\_pconnect `_), + * mysqli (requires PHP 5.3.0 or newer, `more information + `_). .. config:option:: $cfg['ForceSSL'] :type: boolean :default: false -Whether to force using https while accessing phpMyAdmin. + Whether to force using https while accessing phpMyAdmin. .. config:option:: $cfg['ExecTimeLimit'] :type: integer [number of seconds] :default: 300 -Set the number of seconds a script is allowed to run. If seconds is -set to zero, no time limit is imposed. This setting is used while -importing/exporting dump files and in the Synchronize feature but has -no effect when PHP is running in safe mode. + Set the number of seconds a script is allowed to run. If seconds is + set to zero, no time limit is imposed. This setting is used while + importing/exporting dump files and in the Synchronize feature but has + no effect when PHP is running in safe mode. .. config:option:: $cfg['SessionSavePath'] :type: string :default: ``''`` -Path for storing session data (`session\_save\_path PHP parameter -`_). + Path for storing session data (`session\_save\_path PHP parameter + `_). .. config:option:: $cfg['MemoryLimit'] :type: string [number of bytes] - :default: 0 + :default: ``'0'`` -Set the number of bytes a script is allowed to allocate. If set to -zero, no limit is imposed. This setting is used while -importing/exporting dump files and at some other places in phpMyAdmin -so you definitely don't want to put here a too low value. It has no -effect when PHP is running in safe mode. You can also use any string -as in :file:`php.ini`, eg. '16M'. Ensure you don't omit the suffix (16 means -16 bytes!) + Set the number of bytes a script is allowed to allocate. If set to + zero, no limit is imposed. + + This setting is used while importing/exporting dump files and at some other + places in phpMyAdmin so you definitely don't want to put here a too low + value. It has no effect when PHP is running in safe mode. + + You can also use any string as in :file:`php.ini`, eg. '16M'. Ensure you + don't omit the suffix (16 means 16 bytes!) .. config:option:: $cfg['SkipLockedTables'] :type: boolean :default: false -Mark used tables and make it possible to show databases with locked -tables (since MySQL 3.23.30). + Mark used tables and make it possible to show databases with locked + tables (since MySQL 3.23.30). .. config:option:: $cfg['ShowSQL'] :type: boolean :default: true -Defines whether :abbr:`SQL (structured query language)` queries -generated by phpMyAdmin should be displayed or not. + Defines whether :abbr:`SQL (structured query language)` queries + generated by phpMyAdmin should be displayed or not. .. config:option:: $cfg['RetainQueryBox'] :type: boolean :default: false -Defines whether the :abbr:`SQL (structured query language)` query box -should be kept displayed after its submission. + Defines whether the :abbr:`SQL (structured query language)` query box + should be kept displayed after its submission. .. config:option:: $cfg['CodemirrorEnable'] :type: boolean :default: true -Defines whether to use a Javascript code editor for SQL query boxes. -CodeMirror provides syntax highlighting and line numbers. However, -middle-clicking for pasting the clipboard contents in some Linux -distributions (such as Ubuntu) is not supported by all browsers. + Defines whether to use a Javascript code editor for SQL query boxes. + CodeMirror provides syntax highlighting and line numbers. However, + middle-clicking for pasting the clipboard contents in some Linux + distributions (such as Ubuntu) is not supported by all browsers. .. config:option:: $cfg['AllowUserDropDatabase'] :type: boolean :default: false -Defines whether normal users (non-administrator) are allowed to delete -their own database or not. If set as FALSE, the link "Drop Database" -will not be shown, and even a "DROP DATABASE mydatabase" will be -rejected. Quite practical for :abbr:`ISP (Internet service -provider)`'s with many customers. Please note that this limitation of -:abbr:`SQL (structured query language)` queries is not as strict as -when using MySQL privileges. This is due to nature of :abbr:`SQL -(structured query language)` queries which might be quite complicated. -So this choice should be viewed as help to avoid accidental dropping -rather than strict privilege limitation. + Defines whether normal users (non-administrator) are allowed to delete + their own database or not. If set as FALSE, the link "Drop Database" + will not be shown, and even a "DROP DATABASE mydatabase" will be + rejected. Quite practical for :abbr:`ISP (Internet service + provider)`'s with many customers. + + .. note:: + + This limitation of :abbr:`SQL (structured query language)` queries is not + as strict as when using MySQL privileges. This is due to nature of + :abbr:`SQL (structured query language)` queries which might be quite + complicated. So this choice should be viewed as help to avoid accidental + dropping rather than strict privilege limitation. .. config:option:: $cfg['Confirm'] :type: boolean :default: true -Whether a warning ("Are your really sure...") should be displayed when -you're about to lose data. + Whether a warning ("Are your really sure...") should be displayed when + you're about to lose data. .. config:option:: $cfg['LoginCookieRecall'] :type: boolean :default: true -Define whether the previous login should be recalled or not in cookie -authentication mode. This is automatically disabled if you do not have -configured :config:option:`$cfg['blowfish_secret']`. + Define whether the previous login should be recalled or not in cookie + authentication mode. + + This is automatically disabled if you do not have + configured :config:option:`$cfg['blowfish_secret']`. .. config:option:: $cfg['LoginCookieValidity'] :type: integer [number of seconds] :default: 1440 -Define how long is login cookie valid. Please note that php -configuration option `session.gc\_maxlifetime -`_ might limit session validity and if session is lost, -login cookie is also invalidated. So it is a good idea to set -``session.gc_maxlifetime`` not lower than the value of -$cfg['LoginCookieValidity']. + Define how long is login cookie valid. Please note that php + configuration option `session.gc\_maxlifetime + `_ might limit session validity and if session is lost, + login cookie is also invalidated. So it is a good idea to set + ``session.gc_maxlifetime`` not lower than the value of + :config:option:`$cfg['LoginCookieValidity']`. .. config:option:: $cfg['LoginCookieStore'] :type: integer [number of seconds] :default: 0 -Define how long login cookie should be stored in browser. Default 0 -means that it will be kept for existing session. This is recommended -for not trusted environments. + Define how long login cookie should be stored in browser. Default 0 + means that it will be kept for existing session. This is recommended + for not trusted environments. .. config:option:: $cfg['LoginCookieDeleteAll'] :type: boolean :default: true -If enabled (default), logout deletes cookies for all servers, -otherwise only for current one. Setting this to false makes it easy to -forget to log out from other server, when you are using more of them. + If enabled (default), logout deletes cookies for all servers, + otherwise only for current one. Setting this to false makes it easy to + forget to log out from other server, when you are using more of them. .. config:option:: $cfg['UseDbSearch'] :type: boolean :default: true -Define whether the "search string inside database" is enabled or not. + Define whether the "search string inside database" is enabled or not. .. config:option:: $cfg['IgnoreMultiSubmitErrors'] :type: boolean :default: false -Define whether phpMyAdmin will continue executing a multi-query -statement if one of the queries fails. Default is to abort execution. + Define whether phpMyAdmin will continue executing a multi-query + statement if one of the queries fails. Default is to abort execution. .. _AllowArbitraryServer: .. config:option:: $cfg['AllowArbitraryServer'] @@ -1154,11 +1228,15 @@ statement if one of the queries fails. Default is to abort execution. :type: boolean :default: false -If enabled, allows you to log in to arbitrary servers using cookie -auth and permits to specify servers of your choice in the Synchronize -dialog. **NOTE:** Please use this carefully, as this may allow users -access to MySQL servers behind the firewall where your :abbr:`HTTP -(HyperText Transfer Protocol)` server is placed. + If enabled, allows you to log in to arbitrary servers using cookie + auth and permits to specify servers of your choice in the Synchronize + dialog. + + .. note:: + + Please use this carefully, as this may allow users access to MySQL servers + behind the firewall where your :abbr:`HTTP (HyperText Transfer Protocol)` + server is placed. Error handling -------------- @@ -1168,14 +1246,14 @@ Error handling :type: boolean :default: false -Whether to display errors from PHP or not. + Whether to display errors from PHP or not. .. config:option:: $cfg['Error_Handler']['gather'] :type: boolean :default: false -Whether to gather errors from PHP or not. + Whether to gather errors from PHP or not. Navigation panel setup ---------------------- @@ -1185,125 +1263,127 @@ Navigation panel setup :type: boolean :default: true -Defines whether to group the databases based on a common prefix -in their name :config:option:`$cfg['NavigationTreeDbSeparator']`. + Defines whether to group the databases based on a common prefix + in their name :config:option:`$cfg['NavigationTreeDbSeparator']`. .. config:option:: $cfg['NavigationTreeDbSeparator'] :type: string or array :default: ``'_'`` -The string used to separate the parts of the database name when -showing them in a tree. Alternatively you can specify more strings in -an array and all of them will be used as a separator. + The string used to separate the parts of the database name when + showing them in a tree. Alternatively you can specify more strings in + an array and all of them will be used as a separator. .. config:option:: $cfg['NavigationTreeTableSeparator'] :type: string or array :default: ``'__'`` -Defines a string to be used to nest table spaces. Defaults to '\_\_'. -This means if you have tables like 'first\_\_second\_\_third' this -will be shown as a three-level hierarchy like: first > second > third. -If set to FALSE or empty, the feature is disabled. NOTE: You should -not use this separator at the beginning or end of a table name or -multiple times after another without any other characters in between. + Defines a string to be used to nest table spaces. This means if you have + tables like 'first\_\_second\_\_third' this will be shown as a three-level + hierarchy like: first > second > third. If set to FALSE or empty, the + feature is disabled. NOTE: You should not use this separator at the + beginning or end of a table name or multiple times after another without + any other characters in between. .. config:option:: $cfg['NavigationTreeTableLevel'] :type: integer :default: 1 -Defines how many sublevels should be displayed when splitting up -tables by the above separator. + Defines how many sublevels should be displayed when splitting up + tables by the above separator. .. config:option:: $cfg['NumRecentTables'] :type: integer :default: 10 -The maximum number of recently used tables shown in the navigation -panel. Set this to 0 (zero) to disable the listing of recent tables. + The maximum number of recently used tables shown in the navigation + panel. Set this to 0 (zero) to disable the listing of recent tables. .. config:option:: $cfg['ShowTooltip'] :type: boolean :default: true -Defines whether to display item comments as tooltips in navigation -panel or not. + Defines whether to display item comments as tooltips in navigation + panel or not. .. config:option:: $cfg['NavigationDisplayLogo'] :type: boolean :default: true -Defines whether or not to display the phpMyAdmin logo at the top of -the navigation panel. Defaults to ``TRUE``. + Defines whether or not to display the phpMyAdmin logo at the top of + the navigation panel. .. config:option:: $cfg['NavigationLogoLink'] :type: string :default: ``'index.php'`` -Enter :abbr:`URL (Uniform Resource Locator)` where logo in the -navigation panel will point to. For use especially with self made -theme which changes this. The default value for this is ``main.php``. + Enter :abbr:`URL (Uniform Resource Locator)` where logo in the + navigation panel will point to. For use especially with self made + theme which changes this. .. config:option:: $cfg['NavigationLogoLinkWindow'] :type: string :default: ``'main'`` -Whether to open the linked page in the main window (``main``) or in a -new one (``new``). Note: use ``new`` if you are linking to -``phpmyadmin.net``. + Whether to open the linked page in the main window (``main``) or in a + new one (``new``). Note: use ``new`` if you are linking to + ``phpmyadmin.net``. .. config:option:: $cfg['NavigationTreeDisplayItemFilterMinimum'] :type: integer :default: 30 -Defines the minimum number of items (tables, views, routines and -events) to display a JavaScript filter box above the list of items in -the navigation tree. Defaults to ``30``. To disable the filter -completely some high number can be used (e.g. 9999) + Defines the minimum number of items (tables, views, routines and + events) to display a JavaScript filter box above the list of items in + the navigation tree. + + To disable the filter completely some high number can be used (e.g. 9999) .. config:option:: $cfg['NavigationTreeDisplayDbFilterMinimum'] :type: integer :default: 30 -Defines the minimum number of databases to display a JavaScript filter -box above the list of databases in the navigation tree. Defaults to -``30``. To disable the filter completely some high number can be used -(e.g. 9999) + Defines the minimum number of databases to display a JavaScript filter + box above the list of databases in the navigation tree. + + To disable the filter completely some high number can be used + (e.g. 9999) .. config:option:: $cfg['NavigationDisplayServers'] :type: boolean :default: false -Defines whether or not to display a server choice at the top of the -navigation panel. Defaults to FALSE. + Defines whether or not to display a server choice at the top of the + navigation panel. .. config:option:: $cfg['DisplayServersList'] :type: boolean :default: false -Defines whether to display this server choice as links instead of in a -drop-down. Defaults to FALSE (drop-down). + Defines whether to display this server choice as links instead of in a + drop-down. .. config:option:: $cfg['NavigationTreeDefaultTabTable'] :type: string :default: ``'tbl_structure.php'`` -Defines the tab displayed by default when clicking the small icon next -to each table name in the navigation panel. Possible values: -"tbl\_structure.php", "tbl\_sql.php", "tbl\_select.php", -"tbl\_change.php" or "sql.php". + Defines the tab displayed by default when clicking the small icon next + to each table name in the navigation panel. Possible values: + "tbl\_structure.php", "tbl\_sql.php", "tbl\_select.php", + "tbl\_change.php" or "sql.php". Main panel ---------- @@ -1313,19 +1393,19 @@ Main panel :type: boolean :default: true -Defines whether or not to display space usage and statistics about -databases and tables. Note that statistics requires at least MySQL -3.23.3 and that, at this date, MySQL doesn't return such information -for Berkeley DB tables. + Defines whether or not to display space usage and statistics about + databases and tables. Note that statistics requires at least MySQL + 3.23.3 and that, at this date, MySQL doesn't return such information + for Berkeley DB tables. .. config:option:: $cfg['ShowServerInfo'] :type: boolean :default: true -Defines whether to display detailed server information on main page. -You can additionally hide more information by using -:config:option:`$cfg['Servers'][$i]['verbose']`. + Defines whether to display detailed server information on main page. + You can additionally hide more information by using + :config:option:`$cfg['Servers'][$i]['verbose']`. .. config:option:: $cfg['ShowPhpInfo'] @@ -1342,20 +1422,22 @@ You can additionally hide more information by using :type: boolean :default: true -Defines whether to display the "PHP information" and "Change password -" links and form for creating database or not at the starting main -(right) frame. This setting does not check MySQL commands entered -directly. Please note that to block the usage of phpinfo() in scripts, -you have to put this in your :file:`php.ini`: + Defines whether to display the "PHP information" and "Change password + " links and form for creating database or not at the starting main + (right) frame. This setting does not check MySQL commands entered + directly. + + Please note that to block the usage of phpinfo() in scripts, you have to + put this in your :file:`php.ini`: -.. code-block:: ini + .. code-block:: ini - disable_functions = phpinfo() + disable_functions = phpinfo() -Also note that enabling the "Change password " link has no effect with -"config" authentication mode: because of the hard coded password value -in the configuration file, end users can't be allowed to change their -passwords. + Also note that enabling the "Change password " link has no effect with + "config" authentication mode: because of the hard coded password value + in the configuration file, end users can't be allowed to change their + passwords. Database structure ------------------ @@ -1365,32 +1447,32 @@ Database structure :type: boolean :default: false -Defines whether the database structure page (tables list) has a -"Creation" column that displays when each table was created. + Defines whether the database structure page (tables list) has a + "Creation" column that displays when each table was created. .. config:option:: $cfg['ShowDbStructureLastUpdate'] :type: boolean :default: false -Defines whether the database structure page (tables list) has a "Last -update" column that displays when each table was last updated. + Defines whether the database structure page (tables list) has a "Last + update" column that displays when each table was last updated. .. config:option:: $cfg['ShowDbStructureLastCheck'] :type: boolean :default: false -Defines whether the database structure page (tables list) has a "Last -check" column that displays when each table was last checked. + Defines whether the database structure page (tables list) has a "Last + check" column that displays when each table was last checked. .. config:option:: $cfg['HideStructureActions'] :type: boolean :default: true -Defines whether the table structure actions are hidden under a "More" -drop-down. + Defines whether the table structure actions are hidden under a "More" + drop-down. Browse mode ----------- @@ -1400,62 +1482,62 @@ Browse mode :type: string :default: true -Defines whether navigation bar buttons and the right panel top menu -contain text or symbols only. A value of TRUE displays icons, FALSE -displays text and 'both' displays both icons and text. + Defines whether navigation bar buttons and the right panel top menu + contain text or symbols only. A value of TRUE displays icons, FALSE + displays text and 'both' displays both icons and text. .. config:option:: $cfg['ShowAll'] :type: boolean :default: false -Defines whether a user should be displayed a "Show all" button in -browse mode or not in all cases. By default it is shown only on small -tables (less than 5 × :config:option:`$cfg['MaxRows']` rows) to avoid -performance issues while getting too many rows. + Defines whether a user should be displayed a "Show all" button in + browse mode or not in all cases. By default it is shown only on small + tables (less than 5 × :config:option:`$cfg['MaxRows']` rows) to avoid + performance issues while getting too many rows. .. config:option:: $cfg['MaxRows'] :type: integer :default: 30 -Number of rows displayed when browsing a result set and no LIMIT -clause is used. If the result set contains more rows, "Previous" and -"Next" links will be shown. + Number of rows displayed when browsing a result set and no LIMIT + clause is used. If the result set contains more rows, "Previous" and + "Next" links will be shown. .. config:option:: $cfg['Order'] :type: string :default: ``'SMART'`` -Defines whether columns are displayed in ascending (``ASC``) order, in -descending (``DESC``) order or in a "smart" (``SMART``) order - I.E. -descending order for columns of type TIME, DATE, DATETIME and -TIMESTAMP, ascending order else- by default. + Defines whether columns are displayed in ascending (``ASC``) order, in + descending (``DESC``) order or in a "smart" (``SMART``) order - I.E. + descending order for columns of type TIME, DATE, DATETIME and + TIMESTAMP, ascending order else- by default. .. config:option:: $cfg['DisplayBinaryAsHex'] :type: boolean :default: true -Defines whether the "Show binary contents as HEX" browse option is -ticked by default. + Defines whether the "Show binary contents as HEX" browse option is + ticked by default. .. config:option:: $cfg['GridEditing'] :type: string :default: ``'double-click'`` -Defines which action (``double-click`` or ``click``) triggers grid -editing. Can be deactived with the ``disabled`` value. + Defines which action (``double-click`` or ``click``) triggers grid + editing. Can be deactived with the ``disabled`` value. .. config:option:: $cfg['SaveCellsAtOnce'] :type: boolean :default: false -Defines whether or not to save all edited cells at once for grid -editing. + Defines whether or not to save all edited cells at once for grid + editing. Editing mode ------------ @@ -1465,90 +1547,86 @@ Editing mode :type: boolean or string :default: ``'blob'`` -Defines whether ``BLOB`` or ``BINARY`` columns are protected from -editing when browsing a table's content. Valid values are: - -* ``FALSE`` to allow editing of all columns; -* ``'blob'`` to allow editing of all columns except ``BLOBS``; -* ``'noblob'`` to disallow editing of all columns except ``BLOBS`` (the - opposite of ``'blob'``); -* ``'all'`` to disallow editing of all ``BINARY`` or ``BLOB`` columns. - + Defines whether ``BLOB`` or ``BINARY`` columns are protected from + editing when browsing a table's content. Valid values are: + * ``FALSE`` to allow editing of all columns; + * ``'blob'`` to allow editing of all columns except ``BLOBS``; + * ``'noblob'`` to disallow editing of all columns except ``BLOBS`` (the + opposite of ``'blob'``); + * ``'all'`` to disallow editing of all ``BINARY`` or ``BLOB`` columns. .. config:option:: $cfg['ShowFunctionFields'] :type: boolean :default: true -Defines whether or not MySQL functions fields should be initially -displayed in edit/insert mode. Since version 2.10, the user can toggle -this setting from the interface. + Defines whether or not MySQL functions fields should be initially + displayed in edit/insert mode. Since version 2.10, the user can toggle + this setting from the interface. .. config:option:: $cfg['ShowFieldTypesInDataEditView'] :type: boolean :default: true -Defines whether or not type fields should be initially displayed in -edit/insert mode. The user can toggle this setting from the interface. + Defines whether or not type fields should be initially displayed in + edit/insert mode. The user can toggle this setting from the interface. .. config:option:: $cfg['CharEditing'] :type: string :default: ``'input'`` -Defines which type of editing controls should be used for CHAR and -VARCHAR columns. Possible values are: + Defines which type of editing controls should be used for CHAR and + VARCHAR columns. Possible values are: -* input - this allows to limit size of text to size of columns in MySQL, - but has problems with newlines in columns -* textarea - no problems with newlines in columns, but also no length - limitations - -Default is old behavior so input. + * input - this allows to limit size of text to size of columns in MySQL, + but has problems with newlines in columns + * textarea - no problems with newlines in columns, but also no length + limitations .. config:option:: $cfg['MinSizeForInputField'] :type: integer :default: 4 -Defines the minimum size for input fields generated for CHAR and -VARCHAR columns. + Defines the minimum size for input fields generated for CHAR and + VARCHAR columns. .. config:option:: $cfg['MaxSizeForInputField'] :type: integer :default: 60 -Defines the maximum size for input fields generated for CHAR and -VARCHAR columns. + Defines the maximum size for input fields generated for CHAR and + VARCHAR columns. .. config:option:: $cfg['InsertRows'] :type: integer :default: 2 -Defines the maximum number of concurrent entries for the Insert page. + Defines the maximum number of concurrent entries for the Insert page. .. config:option:: $cfg['ForeignKeyMaxLimit'] :type: integer :default: 100 -If there are fewer items than this in the set of foreign keys, then a -drop-down box of foreign keys is presented, in the style described by -the :config:option:`$cfg['ForeignKeyDropdownOrder']` setting. + If there are fewer items than this in the set of foreign keys, then a + drop-down box of foreign keys is presented, in the style described by + the :config:option:`$cfg['ForeignKeyDropdownOrder']` setting. .. config:option:: $cfg['ForeignKeyDropdownOrder'] :type: array :default: array('content-id', 'id-content') -For the foreign key drop-down fields, there are several methods of -display, offering both the key and value data. The contents of the -array should be one or both of the following strings: ``content-id``, -``id-content``. + For the foreign key drop-down fields, there are several methods of + display, offering both the key and value data. The contents of the + array should be one or both of the following strings: ``content-id``, + ``id-content``. Export and import settings -------------------------- @@ -1568,41 +1646,41 @@ Export and import settings :type: boolean :default: true -Defines whether to allow the use of zip/GZip/BZip2 compression when -creating a dump file + Defines whether to allow the use of zip/GZip/BZip2 compression when + creating a dump file .. config:option:: $cfg['CompressOnFly'] :type: boolean :default: true -Defines whether to allow on the fly compression for GZip/BZip2 -compressed exports. This doesn't affect smaller dumps and allows users -to create larger dumps that won't otherwise fit in memory due to php -memory limit. Produced files contain more GZip/BZip2 headers, but all -normal programs handle this correctly. + Defines whether to allow on the fly compression for GZip/BZip2 + compressed exports. This doesn't affect smaller dumps and allows users + to create larger dumps that won't otherwise fit in memory due to php + memory limit. Produced files contain more GZip/BZip2 headers, but all + normal programs handle this correctly. .. config:option:: $cfg['Export'] :type: array :default: array(...) -In this array are defined default parameters for export, names of -items are similar to texts seen on export page, so you can easily -identify what they mean. + In this array are defined default parameters for export, names of + items are similar to texts seen on export page, so you can easily + identify what they mean. .. config:option:: $cfg['Export']['method'] :type: string :default: ``'quick'`` -Defines how the export form is displayed when it loads. Valid values -are: + Defines how the export form is displayed when it loads. Valid values + are: -* ``quick`` to display the minimum number of options to configure -* ``custom`` to display every available option to configure -* ``custom-no-form`` same as ``custom`` but does not display the option - of using quick export + * ``quick`` to display the minimum number of options to configure + * ``custom`` to display every available option to configure + * ``custom-no-form`` same as ``custom`` but does not display the option + of using quick export @@ -1611,9 +1689,9 @@ are: :type: array :default: array(...) -In this array are defined default parameters for import, names of -items are similar to texts seen on import page, so you can easily -identify what they mean. + In this array are defined default parameters for import, names of + items are similar to texts seen on import page, so you can easily + identify what they mean. Tabs display settings @@ -1624,48 +1702,58 @@ Tabs display settings :type: string :default: ``'both'`` -If set to ``TRUE``, will display icons instead of text for db and -table properties links (like 'Browse', 'Select', 'Insert', ...). Can -be set to ``'both'`` if you want icons AND text. When set to -``FALSE``, will only show text. + If set to ``TRUE``, will display icons instead of text for db and + table properties links (like 'Browse', 'Select', 'Insert', ...). Can + be set to ``'both'`` if you want icons AND text. When set to + ``FALSE``, will only show text. .. config:option:: $cfg['PropertiesNumColumns'] :type: integer :default: 1 -How many columns will be utilized to display the tables on the -database property view? Default is 1 column. When setting this to a -value larger than 1, the type of the database will be omitted for more -display space. + How many columns will be utilized to display the tables on the database + property view? When setting this to a value larger than 1, the type of the + database will be omitted for more display space. .. config:option:: $cfg['DefaultTabServer'] :type: string :default: ``'index.php'`` -Defines the tab displayed by default on server view. Possible values: -"main.php" (recommended for multi-user setups), -"server\_databases.php", "server\_status.php", -"server\_variables.php", "server\_privileges.php" or -"server\_processlist.php". + Defines the tab displayed by default on server view. Possible values: + + * "main.php" (recommended for multi-user setups) + * "server\_databases.php", + * "server\_status.php" + * "server\_variables.php" + * "server\_privileges.php" + * "server\_processlist.php" .. config:option:: $cfg['DefaultTabDatabase'] :type: string :default: ``'db_structure.php'`` -Defines the tab displayed by default on database view. Possible -values: "db\_structure.php", "db\_sql.php" or "db\_search.php". + Defines the tab displayed by default on database view. Possible + values: + + * "db\_structure.php" + * "db\_sql.php" + * "db\_search.php". .. config:option:: $cfg['DefaultTabTable'] :type: string :default: ``'sql.php'`` -Defines the tab displayed by default on table view. Possible values: -"tbl\_structure.php", "tbl\_sql.php", "tbl\_select.php", -"tbl\_change.php" or "sql.php". + Defines the tab displayed by default on table view. Possible values: + + * "tbl\_structure.php" + * "tbl\_sql.php" + * "tbl\_select.php" + * "tbl\_change.php" + * "sql.php" Documentation ------------- @@ -1675,24 +1763,26 @@ Documentation :type: string :default: ``'http://dev.mysql.com/doc/refman'`` -If set to an :abbr:`URL (Uniform Resource Locator)` which points to -the MySQL documentation (type depends on -:config:option:`$cfg['MySQLManualType']`), appropriate help links are -generated. See `MySQL Documentation page `_ for more -information about MySQL manuals and their types. + If set to an :abbr:`URL (Uniform Resource Locator)` which points to + the MySQL documentation (type depends on + :config:option:`$cfg['MySQLManualType']`), appropriate help links are + generated. + + See `MySQL Documentation page `_ for more + information about MySQL manuals and their types. .. config:option:: $cfg['MySQLManualType'] :type: string :default: ``'viewable'`` -Type of MySQL documentation: + Type of MySQL documentation: -* viewable - "viewable online", current one used on MySQL website -* searchable - "Searchable, with user comments" -* chapters - "HTML, one page per chapter" -* big - "HTML, all on one page" -* none - do not show documentation links + * viewable - "viewable online", current one used on MySQL website + * searchable - "Searchable, with user comments" + * chapters - "HTML, one page per chapter" + * big - "HTML, all on one page" + * none - do not show documentation links Languages --------- @@ -1702,78 +1792,76 @@ Languages :type: string :default: ``'en'`` -Defines the default language to use, if not browser-defined or user- -defined. The corresponding language file needs to be in -locale/*code*/LC\_MESSAGES/phpmyadmin.mo. + Defines the default language to use, if not browser-defined or user- + defined. The corresponding language file needs to be in + locale/*code*/LC\_MESSAGES/phpmyadmin.mo. .. config:option:: $cfg['DefaultConnectionCollation'] :type: string :default: ``'utf8_general_ci'`` -Defines the default connection collation to use, if not user-defined. -See the `MySQL documentation `_ for list of possible values. This setting is -ignored when connected to Drizzle server. + Defines the default connection collation to use, if not user-defined. + See the `MySQL documentation `_ for list of possible values. This setting is + ignored when connected to Drizzle server. .. config:option:: $cfg['Lang'] :type: string :default: not set -Force language to use. The corresponding language file needs to be in -locale/*code*/LC\_MESSAGES/phpmyadmin.mo. + Force language to use. The corresponding language file needs to be in + locale/*code*/LC\_MESSAGES/phpmyadmin.mo. .. config:option:: $cfg['FilterLanguages'] :type: string :default: ``''`` -Limit list of available languages to those matching the given regular -expression. For example if you want only Czech and English, you should -set filter to ``'^(cs|en)'``. + Limit list of available languages to those matching the given regular + expression. For example if you want only Czech and English, you should + set filter to ``'^(cs|en)'``. .. config:option:: $cfg['RecodingEngine'] :type: string :default: ``'auto'`` -You can select here which functions will be used for character set -conversion. Possible values are: + You can select here which functions will be used for character set + conversion. Possible values are: -* auto - automatically use available one (first is tested iconv, then - recode) -* iconv - use iconv or libiconv functions -* recode - use recode\_string function -* none - disable encoding conversion + * auto - automatically use available one (first is tested iconv, then + recode) + * iconv - use iconv or libiconv functions + * recode - use recode\_string function + * none - disable encoding conversion -Default is auto. - -Enabled charset conversion activates a pull-down menu in the Export -and Import pages, to choose the character set when exporting a file. -The default value in this menu comes from -:config:option:`$cfg['Export']['charset']` and :config:option:`$cfg['Import']['charset']`. + Enabled charset conversion activates a pull-down menu in the Export + and Import pages, to choose the character set when exporting a file. + The default value in this menu comes from + :config:option:`$cfg['Export']['charset']` and :config:option:`$cfg['Import']['charset']`. .. config:option:: $cfg['IconvExtraParams'] :type: string :default: ``'//TRANSLIT'`` -Specify some parameters for iconv used in charset conversion. See -`iconv documentation `_ for details. By default -``//TRANSLIT`` is used, so that invalid characters will be -transliterated. + Specify some parameters for iconv used in charset conversion. See + `iconv documentation `_ for details. By default + ``//TRANSLIT`` is used, so that invalid characters will be + transliterated. .. config:option:: $cfg['AvailableCharsets'] :type: array :default: array(..._ -Available character sets for MySQL conversion. You can add your own -(any of supported by recode/iconv) or remove these which you don't -use. Character sets will be shown in same order as here listed, so if -you frequently use some of these move them to the top. + Available character sets for MySQL conversion. You can add your own + (any of supported by recode/iconv) or remove these which you don't + use. Character sets will be shown in same order as here listed, so if + you frequently use some of these move them to the top. Web server settings ------------------- @@ -1783,66 +1871,65 @@ Web server settings :type: array :default: array() -Lists proxies and HTTP headers which are trusted for -:config:option:`$cfg['Servers'][$i]['AllowDeny']['order']`. This list is by -default empty, you need to fill in some trusted proxy servers if you -want to use rules for IP addresses behind proxy. The following example -specifies that phpMyAdmin should trust a HTTP\_X\_FORWARDED\_FOR (``X --Forwarded-For``) header coming from the proxy 1.2.3.4: + Lists proxies and HTTP headers which are trusted for + :config:option:`$cfg['Servers'][$i]['AllowDeny']['order']`. This list is by + default empty, you need to fill in some trusted proxy servers if you + want to use rules for IP addresses behind proxy. -.. code-block:: php + The following example specifies that phpMyAdmin should trust a + HTTP\_X\_FORWARDED\_FOR (``X -Forwarded-For``) header coming from the proxy + 1.2.3.4: - - $cfg['TrustedProxies'] = array('1.2.3.4' => 'HTTP_X_FORWARDED_FOR'); + .. code-block:: php + + $cfg['TrustedProxies'] = array('1.2.3.4' => 'HTTP_X_FORWARDED_FOR'); -The :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` directive uses the -client's IP address as usual. + The :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` directive uses the + client's IP address as usual. .. config:option:: $cfg['GD2Available'] :type: string :default: ``'auto'`` -Specifies whether GD >= 2 is available. If yes it can be used for MIME -transformations. Possible values are: + Specifies whether GD >= 2 is available. If yes it can be used for MIME + transformations. Possible values are: -* auto - automatically detect -* yes - GD 2 functions can be used -* no - GD 2 function cannot be used - -Default is auto. + * auto - automatically detect + * yes - GD 2 functions can be used + * no - GD 2 function cannot be used .. config:option:: $cfg['CheckConfigurationPermissions'] :type: boolean :default: true -We normally check the permissions on the configuration file to ensure -it's not world writable. However, phpMyAdmin could be installed on a -NTFS filesystem mounted on a non-Windows server, in which case the -permissions seems wrong but in fact cannot be detected. In this case a -sysadmin would set this parameter to ``FALSE``. Default is ``TRUE``. + We normally check the permissions on the configuration file to ensure + it's not world writable. However, phpMyAdmin could be installed on a + NTFS filesystem mounted on a non-Windows server, in which case the + permissions seems wrong but in fact cannot be detected. In this case a + sysadmin would set this parameter to ``FALSE``. .. config:option:: $cfg['LinkLengthLimit'] :type: integer :default: 1000 -Limit for length of :abbr:`URL (Uniform Resource Locator)` in links. -When length would be above this limit, it is replaced by form with -button. This is required as some web servers (:abbr:`IIS (Internet -Information Services)`) have problems with long :abbr:`URL (Uniform -Resource Locator)`s. Default is ``1000``. + Limit for length of :abbr:`URL (Uniform Resource Locator)` in links. + When length would be above this limit, it is replaced by form with + button. This is required as some web servers (:abbr:`IIS (Internet + Information Services)`) have problems with long :abbr:`URL (Uniform + Resource Locator)`. .. config:option:: $cfg['DisableMultiTableMaintenance'] :type: boolean :default: false -In the database Structure page, it's possible to mark some tables then -choose an operation like optimizing for many tables. This can slow -down a server; therefore, setting this to ``true`` prevents this kind -of multiple maintenance operation. Default is ``false``. + In the database Structure page, it's possible to mark some tables then + choose an operation like optimizing for many tables. This can slow + down a server; therefore, setting this to ``true`` prevents this kind + of multiple maintenance operation. Theme settings -------------- @@ -1852,8 +1939,8 @@ Theme settings :type: integer :default: -Navigation panel width in pixels. See -``themes/themename/layout.inc.php``. + Navigation panel width in pixels. See + ``themes/themename/layout.inc.php``. .. config:option:: $cfg['NaviBackground'] @@ -1865,8 +1952,8 @@ Navigation panel width in pixels. See :type: string [CSS color for background] :default: -The background styles used for both the frames. See -``themes/themename/layout.inc.php``. + The background styles used for both the frames. See + ``themes/themename/layout.inc.php``. .. config:option:: $cfg['NaviPointerBackground'] @@ -1878,15 +1965,15 @@ The background styles used for both the frames. See :type: string [CSS color] :default: -The style used for the pointer in the navi frame. See -``themes/themename/layout.inc.php``. + The style used for the pointer in the navi frame. See + ``themes/themename/layout.inc.php``. .. config:option:: $cfg['Border'] :type: integer :default: -The size of a table's border. See ``themes/themename/layout.inc.php``. + The size of a table's border. See ``themes/themename/layout.inc.php``. .. config:option:: $cfg['ThBackground'] @@ -1898,8 +1985,8 @@ The size of a table's border. See ``themes/themename/layout.inc.php``. :type: string [CSS color] :default: -The style used for table headers. See -``themes/themename/layout.inc.php``. + The style used for table headers. See + ``themes/themename/layout.inc.php``. .. _cfg_BgcolorOne: .. config:option:: $cfg['BgOne'] @@ -1907,8 +1994,8 @@ The style used for table headers. See :type: string [CSS color] :default: -The color (HTML) #1 for table rows. See -``themes/themename/layout.inc.php``. + The color (HTML) #1 for table rows. See + ``themes/themename/layout.inc.php``. .. _cfg_BgcolorTwo: .. config:option:: $cfg['BgTwo'] @@ -1916,8 +2003,8 @@ The color (HTML) #1 for table rows. See :type: string [CSS color] :default: -The color (HTML) #2 for table rows. See -``themes/themename/layout.inc.php``. + The color (HTML) #2 for table rows. See + ``themes/themename/layout.inc.php``. .. config:option:: $cfg['BrowsePointerBackground'] @@ -1939,28 +2026,28 @@ The color (HTML) #2 for table rows. See :type: string [CSS color] :default: -The colors (HTML) uses for the pointer and the marker in browse mode. -The former feature highlights the row over which your mouse is passing -and the latter lets you visually mark/unmark rows by clicking on the -corresponding checkbox. Highlighting / marking a column is done by -hovering over / clicking the column's header (outside of the text). -See ``themes/themename/layout.inc.php``. + The colors (HTML) uses for the pointer and the marker in browse mode. + The former feature highlights the row over which your mouse is passing + and the latter lets you visually mark/unmark rows by clicking on the + corresponding checkbox. Highlighting / marking a column is done by + hovering over / clicking the column's header (outside of the text). + See ``themes/themename/layout.inc.php``. .. config:option:: $cfg['FontFamily'] :type: string :default: -You put here a valid CSS font family value, for example ``arial, sans- -serif``. See ``themes/themename/layout.inc.php``. + You put here a valid CSS font family value, for example ``arial, sans- + serif``. See ``themes/themename/layout.inc.php``. .. config:option:: $cfg['FontFamilyFixed'] :type: string :default: -You put here a valid CSS font family value, for example ``monospace``. -This one is used in textarea. See ``themes/themename/layout.inc.php``. + You put here a valid CSS font family value, for example ``monospace``. + This one is used in textarea. See ``themes/themename/layout.inc.php``. Design customization -------------------- @@ -1970,21 +2057,21 @@ Design customization :type: boolean :default: true -A value of ``TRUE`` activates the navi pointer. + A value of ``TRUE`` activates the navi pointer. .. config:option:: $cfg['BrowsePointerEnable'] :type: boolean :default: true -Whether to activate the browse pointer or not. + Whether to activate the browse pointer or not. .. config:option:: $cfg['BrowseMarkerEnable'] :type: boolean :default: true -Whether to activate the browse marker or not. + Whether to activate the browse marker or not. .. config:option:: $cfg['TextareaCols'] @@ -2006,76 +2093,78 @@ Whether to activate the browse marker or not. :type: integer :default: 2 -Number of columns and rows for the textareas. This value will be -emphasized (\*2) for :abbr:`SQL (structured query language)` query -textareas and (\*1.25) for :abbr:`SQL (structured query language)` -textareas inside the query window. The Char\* values are used for CHAR -and VARCHAR editing (if configured via :config:option:`$cfg['CharEditing']`). + Number of columns and rows for the textareas. This value will be + emphasized (\*2) for :abbr:`SQL (structured query language)` query + textareas and (\*1.25) for :abbr:`SQL (structured query language)` + textareas inside the query window. + + The Char\* values are used for CHAR + and VARCHAR editing (if configured via :config:option:`$cfg['CharEditing']`). .. config:option:: $cfg['LongtextDoubleTextarea'] :type: boolean :default: true -Defines whether textarea for LONGTEXT columns should have double size. + Defines whether textarea for LONGTEXT columns should have double size. .. config:option:: $cfg['TextareaAutoSelect'] :type: boolean :default: false -Defines if the whole textarea of the query box will be selected on -click. + Defines if the whole textarea of the query box will be selected on + click. .. config:option:: $cfg['LimitChars'] :type: integer :default: 50 -Maximum number of characters shown in any non-numeric field on browse -view. Can be turned off by a toggle button on the browse page. + Maximum number of characters shown in any non-numeric field on browse + view. Can be turned off by a toggle button on the browse page. .. config:option:: $cfg['RowActionLinks'] :type: string :default: ``'left'`` -Defines the place where table row links (Edit, Copy, Delete) would be -put when tables contents are displayed (you may have them displayed at -the left side, right side, both sides or nowhere). "left" and "right" -are parsed as "top" and "bottom" with vertical display mode. + Defines the place where table row links (Edit, Copy, Delete) would be + put when tables contents are displayed (you may have them displayed at + the left side, right side, both sides or nowhere). "left" and "right" + are parsed as "top" and "bottom" with vertical display mode. .. config:option:: $cfg['DefaultDisplay'] :type: string :default: ``'horizonta'`` -There are 3 display modes: horizontal, horizontalflipped and vertical. -Define which one is displayed by default. The first mode displays each -row on a horizontal line, the second rotates the headers by 90 -degrees, so you can use descriptive headers even though columns only -contain small values and still print them out. The vertical mode sorts -each row on a vertical lineup. + There are 3 display modes: horizontal, horizontalflipped and vertical. + Define which one is displayed by default. The first mode displays each + row on a horizontal line, the second rotates the headers by 90 + degrees, so you can use descriptive headers even though columns only + contain small values and still print them out. The vertical mode sorts + each row on a vertical lineup. .. config:option:: $cfg['RememberSorting'] :type: boolean :default: true -If enabled, remember the sorting of each table when browsing them. + If enabled, remember the sorting of each table when browsing them. .. config:option:: $cfg['HeaderFlipType'] :type: string :default: ``'auto'`` -The HeaderFlipType can be set to 'auto', 'css' or 'fake'. When using -'css' the rotation of the header for horizontalflipped is done via -CSS. The CSS transformation currently works only in Internet -Explorer.If set to 'fake' PHP does the transformation for you, but of -course this does not look as good as CSS. The 'auto' option enables -CSS transformation when browser supports it and use PHP based one -otherwise. + The HeaderFlipType can be set to 'auto', 'css' or 'fake'. When using + 'css' the rotation of the header for horizontalflipped is done via + CSS. The CSS transformation currently works only in Internet + Explorer.If set to 'fake' PHP does the transformation for you, but of + course this does not look as good as CSS. The 'auto' option enables + CSS transformation when browser supports it and use PHP based one + otherwise. .. config:option:: $cfg['ShowBrowseComments'] @@ -2087,12 +2176,12 @@ otherwise. :type: boolean :default: true -By setting the corresponding variable to ``TRUE`` you can enable the -display of column comments in Browse or Property display. In browse -mode, the comments are shown inside the header. In property mode, -comments are displayed using a CSS-formatted dashed-line below the -name of the column. The comment is shown as a tool-tip for that -column. + By setting the corresponding variable to ``TRUE`` you can enable the + display of column comments in Browse or Property display. In browse + mode, the comments are shown inside the header. In property mode, + comments are displayed using a CSS-formatted dashed-line below the + name of the column. The comment is shown as a tool-tip for that + column. SQL query box settings ---------------------- @@ -2102,40 +2191,40 @@ SQL query box settings :type: boolean :default: true -Whether to display an edit link to change a query in any SQL Query -box. + Whether to display an edit link to change a query in any SQL Query + box. .. config:option:: $cfg['SQLQuery']['Explain'] :type: boolean :default: true -Whether to display a link to explain a SELECT query in any SQL Query -box. + Whether to display a link to explain a SELECT query in any SQL Query + box. .. config:option:: $cfg['SQLQuery']['ShowAsPHP'] :type: boolean :default: true -Whether to display a link to wrap a query in PHP code in any SQL Query -box. + Whether to display a link to wrap a query in PHP code in any SQL Query + box. .. config:option:: $cfg['SQLQuery']['Validate'] :type: boolean :default: false -Whether to display a link to validate a query in any SQL Query box. + Whether to display a link to validate a query in any SQL Query box. -.. seealso:: :config:option:`$cfg['SQLValidator']` + .. seealso:: :config:option:`$cfg['SQLValidator']` .. config:option:: $cfg['SQLQuery']['Refresh'] :type: boolean :default: true -Whether to display a link to refresh a query in any SQL Query box. + Whether to display a link to refresh a query in any SQL Query box. Web server upload/save/import directories ----------------------------------------- @@ -2145,70 +2234,90 @@ Web server upload/save/import directories :type: string :default: ``''`` -The name of the directory where :abbr:`SQL (structured query -language)` files have been uploaded by other means than phpMyAdmin -(for example, ftp). Those files are available under a drop-down box -when you click the database or table name, then the Import tab. If -you want different directory for each user, %u will be replaced with -username. Please note that the file names must have the suffix ".sql" -(or ".sql.bz2" or ".sql.gz" if support for compressed formats is -enabled). This feature is useful when your file is too big to be -uploaded via :abbr:`HTTP (HyperText Transfer Protocol)`, or when file -uploads are disabled in PHP. Please note that if PHP is running in -safe mode, this directory must be owned by the same user as the owner -of the phpMyAdmin scripts. See also :ref:`faq1_16` for alternatives. + The name of the directory where :abbr:`SQL (structured query + language)` files have been uploaded by other means than phpMyAdmin + (for example, ftp). Those files are available under a drop-down box + when you click the database or table name, then the Import tab. + + If + you want different directory for each user, %u will be replaced with + username. + + Please note that the file names must have the suffix ".sql" + (or ".sql.bz2" or ".sql.gz" if support for compressed formats is + enabled). + + This feature is useful when your file is too big to be + uploaded via :abbr:`HTTP (HyperText Transfer Protocol)`, or when file + uploads are disabled in PHP. + + .. note:: + + If PHP is running in safe mode, this directory must be owned by the same + user as the owner of the phpMyAdmin scripts. See also :ref:`faq1_16` for + alternatives. .. config:option:: $cfg['SaveDir'] :type: string :default: ``''`` -The name of the directory where dumps can be saved. If you want -different directory for each user, %u will be replaced with username. -Please note that the directory must exist and has to be writable for -the user running webserver. Please note that if PHP is running in safe -mode, this directory must be owned by the same user as the owner of -the phpMyAdmin scripts. + The name of the directory where dumps can be saved. + + If you want different directory for each user, %u will be replaced with + username. + + Please note that the directory must exist and has to be writable for + the user running webserver. + + .. note:: + + If PHP is running in safe mode, this directory must be owned by the same + user as the owner of the phpMyAdmin scripts. .. config:option:: $cfg['TempDir'] :type: string :default: ``''`` -The name of the directory where temporary files can be stored. This -is needed for importing ESRI Shapefiles, see :ref:`faq6_30` and to -work around limitations of ``open_basedir`` for uploaded files, see -:ref:`faq1_11`. If the directory where phpMyAdmin is installed is -subject to an ``open_basedir`` restriction, you need to create a -temporary directory in some directory accessible by the web server. -However for security reasons, this directory should be outside the -tree published by webserver. If you cannot avoid having this directory -published by webserver, place at least an empty ``index.html`` file -there, so that directory listing is not possible. This directory -should have as strict permissions as possible as the only user -required to access this directory is the one who runs the webserver. -If you have root privileges, simply make this user owner of this -directory and make it accessible only by it: + The name of the directory where temporary files can be stored. -.. code-block:: sh + This is needed for importing ESRI Shapefiles, see :ref:`faq6_30` and to + work around limitations of ``open_basedir`` for uploaded files, see + :ref:`faq1_11`. - - chown www-data:www-data tmp - chmod 700 tmp + If the directory where phpMyAdmin is installed is + subject to an ``open_basedir`` restriction, you need to create a + temporary directory in some directory accessible by the web server. + However for security reasons, this directory should be outside the + tree published by webserver. If you cannot avoid having this directory + published by webserver, place at least an empty ``index.html`` file + there, so that directory listing is not possible. -If you cannot change owner of the directory, you can achieve a similar -setup using :abbr:`ACL (Access Control List)`: + This directory should have as strict permissions as possible as the only + user required to access this directory is the one who runs the webserver. + If you have root privileges, simply make this user owner of this directory + and make it accessible only by it: -.. code-block:: sh + .. code-block:: sh - - chmod 700 tmp - setfacl -m "g:www-data:rwx" tmp - setfacl -d -m "g:www-data:rwx" tmp + + chown www-data:www-data tmp + chmod 700 tmp -If neither of above works for you, you can still make the directory -``chmod 777``, but it might impose risk of other users on system -reading and writing data in this directory. + If you cannot change owner of the directory, you can achieve a similar + setup using :abbr:`ACL (Access Control List)`: + + .. code-block:: sh + + + chmod 700 tmp + setfacl -m "g:www-data:rwx" tmp + setfacl -d -m "g:www-data:rwx" tmp + + If neither of above works for you, you can still make the directory + ``chmod 777``, but it might impose risk of other users on system + reading and writing data in this directory. Various display setting ----------------------- @@ -2218,15 +2327,15 @@ Various display setting :type: boolean :default: false -Defines whether or not type display direction option is shown when -browsing a table. + Defines whether or not type display direction option is shown when + browsing a table. .. config:option:: $cfg['RepeatCells'] :type: integer :default: 100 -Repeat the headers every X cells, or 0 to deactivate. + Repeat the headers every X cells, or 0 to deactivate. .. config:option:: $cfg['EditInWindow'] @@ -2258,109 +2367,120 @@ Repeat the headers every X cells, or 0 to deactivate. :type: integer :default: 25 -All those variables affect the query window feature. A :abbr:`SQL -(structured query language)` link or icon is always displayed in the -navigation panel. If JavaScript is enabled in your browser, a click on -this opens a distinct query window, which is a direct interface to -enter :abbr:`SQL (structured query language)` queries. Otherwise, the -right panel changes to display a query box. The size of this query -window can be customized with :config:option:`$cfg['QueryWindowWidth']` and -:config:option:`$cfg['QueryWindowHeight']` - both integers for the size in pixels. -Note that normally, those parameters will be modified in -:file:`layout.inc.php`` for the theme you are using. If -:config:option:`$cfg['EditInWindow']` is set to true, a click on [Edit] from the -results page (in the "Showing Rows" section) opens the query window -and puts the current query inside it. If set to false, clicking on the -link puts the :abbr:`SQL (structured query language)` query in the -right panel's query box. The usage of the JavaScript query window is -recommended if you have a JavaScript enabled browser. Basic functions -are used to exchange quite a few variables, so most 4th generation -browsers should be capable to use that feature. It currently is only -tested with Internet Explorer 6 and Mozilla 1.x. If -:config:option:`$cfg['QueryHistoryDB']` is set to ``TRUE``, all your Queries are -logged to a table, which has to be created by you (see :config:option:`$cfg['Servers'][$i]['history']`). If set to -FALSE, all your queries will be appended to the form, but only as long -as your window is opened they remain saved. When using the JavaScript -based query window, it will always get updated when you click on a new -table/db to browse and will focus if you click on "Edit :abbr:`SQL -(structured query language)`" after using a query. You can suppress -updating the query window by checking the box "Do not overwrite this -query from outside the window" below the query textarea. Then you can -browse tables/databases in the background without losing the contents -of the textarea, so this is especially useful when composing a query -with tables you first have to look in. The checkbox will get -automatically checked whenever you change the contents of the -textarea. Please uncheck the button whenever you definitely want the -query window to get updated even though you have made alterations. If -:config:option:`$cfg['QueryHistoryDB']` is set to ``TRUE`` you can specify the -amount of saved history items using :config:option:`$cfg['QueryHistoryMax']`. The -query window also has a custom tabbed look to group the features. -Using the variable :config:option:`$cfg['QueryWindowDefTab']` you can specify the -default tab to be used when opening the query window. It can be set to -either 'sql', 'files', 'history' or 'full'. + All those variables affect the query window feature. A :abbr:`SQL + (structured query language)` link or icon is always displayed in the + navigation panel. If JavaScript is enabled in your browser, a click on + this opens a distinct query window, which is a direct interface to + enter :abbr:`SQL (structured query language)` queries. Otherwise, the + right panel changes to display a query box. + + The size of this query window can be customized with + :config:option:`$cfg['QueryWindowWidth']` and + :config:option:`$cfg['QueryWindowHeight']` - both integers for the size in + pixels. Note that normally, those parameters will be modified in + :file:`layout.inc.php`` for the theme you are using. + + If :config:option:`$cfg['EditInWindow']` is set to true, a click on [Edit] + from the results page (in the "Showing Rows" section) opens the query + window and puts the current query inside it. If set to false, clicking on + the link puts the :abbr:`SQL (structured query language)` query in the + right panel's query box. + + The usage of the JavaScript query window is + recommended if you have a JavaScript enabled browser. Basic functions + are used to exchange quite a few variables, so most 4th generation + browsers should be capable to use that feature. It currently is only + tested with Internet Explorer 6 and Mozilla 1.x. + + If :config:option:`$cfg['QueryHistoryDB']` is set to ``TRUE``, all your + Queries are logged to a table, which has to be created by you (see + :config:option:`$cfg['Servers'][$i]['history']`). If set to FALSE, all your + queries will be appended to the form, but only as long as your window is + opened they remain saved. + + When using the JavaScript based query window, it will always get updated + when you click on a new table/db to browse and will focus if you click on + "Edit :abbr:`SQL (structured query language)`" after using a query. You can + suppress updating the query window by checking the box "Do not overwrite + this query from outside the window" below the query textarea. Then you can + browse tables/databases in the background without losing the contents of + the textarea, so this is especially useful when composing a query with + tables you first have to look in. The checkbox will get automatically + checked whenever you change the contents of the textarea. Please uncheck + the button whenever you definitely want the query window to get updated + even though you have made alterations. + + If :config:option:`$cfg['QueryHistoryDB']` is set to ``TRUE`` you can + specify the amount of saved history items using + :config:option:`$cfg['QueryHistoryMax']`. + + The query window also has a custom tabbed look to group the features. + Using the variable :config:option:`$cfg['QueryWindowDefTab']` you can + specify the default tab to be used when opening the query window. It can be + set to either 'sql', 'files', 'history' or 'full'. .. config:option:: $cfg['BrowseMIME'] :type: boolean :default: true -Enable :ref:`transformations`. + Enable :ref:`transformations`. .. config:option:: $cfg['MaxExactCount'] :type: integer :default: 0 -For InnoDB tables, determines for how large tables phpMyAdmin should -get the exact row count using ``SELECT COUNT``. If the approximate row -count as returned by ``SHOW TABLE STATUS`` is smaller than this value, -``SELECT COUNT`` will be used, otherwise the approximate count will be -used. + For InnoDB tables, determines for how large tables phpMyAdmin should + get the exact row count using ``SELECT COUNT``. If the approximate row + count as returned by ``SHOW TABLE STATUS`` is smaller than this value, + ``SELECT COUNT`` will be used, otherwise the approximate count will be + used. .. config:option:: $cfg['MaxExactCountViews'] :type: integer :default: 0 -For VIEWs, since obtaining the exact count could have an impact on -performance, this value is the maximum to be displayed, using a -``SELECT COUNT ... LIMIT``. Setting this to 0 bypasses any row -counting. + For VIEWs, since obtaining the exact count could have an impact on + performance, this value is the maximum to be displayed, using a + ``SELECT COUNT ... LIMIT``. Setting this to 0 bypasses any row + counting. .. config:option:: $cfg['NaturalOrder'] :type: boolean :default: true -Sorts database and table names according to natural order (for -example, t1, t2, t10). Currently implemented in the navigation panel -and in Database view, for the table list. + Sorts database and table names according to natural order (for + example, t1, t2, t10). Currently implemented in the navigation panel + and in Database view, for the table list. .. config:option:: $cfg['InitialSlidersState'] :type: string :default: ``'closed'`` -If set to ``'closed'``, the visual sliders are initially in a closed -state. A value of ``'open'`` does the reverse. To completely disable -all visual sliders, use ``'disabled'``. + If set to ``'closed'``, the visual sliders are initially in a closed + state. A value of ``'open'`` does the reverse. To completely disable + all visual sliders, use ``'disabled'``. .. config:option:: $cfg['UserprefsDisallow'] :type: array :default: array() -Contains names of configuration options (keys in ``$cfg`` array) that -users can't set through user preferences. For possible values, refer -to :file:`libraries/config/user_preferences.forms.php`. + Contains names of configuration options (keys in ``$cfg`` array) that + users can't set through user preferences. For possible values, refer + to :file:`libraries/config/user_preferences.forms.php`. .. config:option:: $cfg['UserprefsDeveloperTab'] :type: boolean :default: false -Activates in the user preferences a tab containing options for -developers of phpMyAdmin. + Activates in the user preferences a tab containing options for + developers of phpMyAdmin. Window title settings --------------------- @@ -2385,7 +2505,7 @@ Window title settings :type: string :default: ``'@HTTP_HOST@ | @PHPMYADMIN@'`` -Allows you to specify window's title bar. You can use :ref:`faq6_27`. + Allows you to specify window's title bar. You can use :ref:`faq6_27`. Theme manager settings ---------------------- @@ -2395,31 +2515,32 @@ Theme manager settings :type: string :default: ``'./themes'`` -If theme manager is active, use this as the path of the subdirectory -containing all the themes. + If theme manager is active, use this as the path of the subdirectory + containing all the themes. .. config:option:: $cfg['ThemeManager'] :type: boolean :default: true -Enables user-selectable themes. See :ref:`faqthemes`. + Enables user-selectable themes. See :ref:`faqthemes`. .. config:option:: $cfg['ThemeDefault'] :type: string :default: ``'pmahomme'`` -The default theme (a subdirectory under :config:option:`$cfg['ThemePath']`). + The default theme (a subdirectory under :config:option:`$cfg['ThemePath']`). .. config:option:: $cfg['ThemePerServer'] :type: boolean :default: false -Whether to allow different theme for each server. + Whether to allow different theme for each server. Default queries +--------------- .. config:option:: $cfg['DefaultQueryTable'] @@ -2431,8 +2552,8 @@ Default queries :type: string :default: ``''`` -Default queries that will be displayed in query boxes when user didn't -specify any. You can use standard :ref:`faq6_27`. + Default queries that will be displayed in query boxes when user didn't + specify any. You can use standard :ref:`faq6_27`. SQL parser settings ------------------- @@ -2442,10 +2563,10 @@ SQL parser settings :type: string [|] :default: ``'html'`` -The main use of the new :abbr:`SQL (structured query language)` Parser -is to pretty-print :abbr:`SQL (structured query language)` queries. By -default we use HTML to format the query, but you can disable this by -setting this variable to ``'none'``. + The main use of the new :abbr:`SQL (structured query language)` Parser + is to pretty-print :abbr:`SQL (structured query language)` queries. By + default we use HTML to format the query, but you can disable this by + setting this variable to ``'none'``. .. _cfg_SQP: .. config:option:: $cfg['SQP']['fmtInd'] @@ -2458,52 +2579,58 @@ setting this variable to ``'none'``. :type: string [|||] :default: ``'em'`` -For the pretty-printing of :abbr:`SQL (structured query language)` -queries, under some cases the part of a query inside a bracket is -indented. By changing :config:option:`$cfg['SQP']['fmtInd']` you can change the -amount of this indent. Related in purpose is -:config:option:`$cfg['SQP']['fmtIndUnit']` which specifies the units of the indent -amount that you specified. This is used via stylesheets. + For the pretty-printing of :abbr:`SQL (structured query language)` queries, + under some cases the part of a query inside a bracket is indented. By + changing :config:option:`$cfg['SQP']['fmtInd']` you can change the amount + of this indent. + + Related in purpose is :config:option:`$cfg['SQP']['fmtIndUnit']` which + specifies the units of the indent amount that you specified. This is used + via stylesheets. .. config:option:: $cfg['SQP']['fmtColor'] :type: array of string tuples :default: -This array is used to define the colours for each type of element of -the pretty-printed :abbr:`SQL (structured query language)` queries. -The tuple format is *class* => [*HTML colour code* | *empty string*] -If you specify an empty string for the color of a class, it is ignored -in creating the stylesheet. You should not alter the class names, only -the colour strings. **Class name key:** + This array is used to define the colours for each type of element of + the pretty-printed :abbr:`SQL (structured query language)` queries. + The tuple format is *class* => [*HTML colour code* | *empty string*] -* **comment** Applies to all comment sub-classes -* **comment\_mysql** Comments as ``"#...\n"`` -* **comment\_ansi** Comments as ``"-- ...\n"`` -* **comment\_c** Comments as ``"/\*...\*/"`` -* **digit** Applies to all digit sub-classes -* **digit\_hex** Hexadecimal numbers -* **digit\_integer** Integer numbers -* **digit\_float** Floating point numbers -* **punct** Applies to all punctuation sub-classes -* **punct\_bracket\_open\_round** Opening brackets``"("`` -* **punct\_bracket\_close\_round** Closing brackets ``")"`` -* **punct\_listsep** List item Separator ``","`` -* **punct\_qualifier** Table/Column Qualifier ``"."`` -* **punct\_queryend** End of query marker ``";"`` -* **alpha** Applies to all alphabetic classes -* **alpha\_columnType** Identifiers matching a column type -* **alpha\_columnAttrib** Identifiers matching a database/table/column - attribute -* **alpha\_functionName** Identifiers matching a MySQL function name -* **alpha\_reservedWord** Identifiers matching any other reserved word -* **alpha\_variable** Identifiers matching a :abbr:`SQL (structured - query language)` variable ``"@foo"`` -* **alpha\_identifier** All other identifiers -* **quote** Applies to all quotation mark classes -* **quote\_double** Double quotes ``"`` -* **quote\_single** Single quotes ``'`` -* **quote\_backtick** Backtick quotes ````` + + If you specify an empty string for the color of a class, it is ignored + in creating the stylesheet. You should not alter the class names, only + the colour strings. + + **Class name key:** + + * **comment** Applies to all comment sub-classes + * **comment\_mysql** Comments as ``"#...\n"`` + * **comment\_ansi** Comments as ``"-- ...\n"`` + * **comment\_c** Comments as ``"/\*...\*/"`` + * **digit** Applies to all digit sub-classes + * **digit\_hex** Hexadecimal numbers + * **digit\_integer** Integer numbers + * **digit\_float** Floating point numbers + * **punct** Applies to all punctuation sub-classes + * **punct\_bracket\_open\_round** Opening brackets``"("`` + * **punct\_bracket\_close\_round** Closing brackets ``")"`` + * **punct\_listsep** List item Separator ``","`` + * **punct\_qualifier** Table/Column Qualifier ``"."`` + * **punct\_queryend** End of query marker ``";"`` + * **alpha** Applies to all alphabetic classes + * **alpha\_columnType** Identifiers matching a column type + * **alpha\_columnAttrib** Identifiers matching a database/table/column + attribute + * **alpha\_functionName** Identifiers matching a MySQL function name + * **alpha\_reservedWord** Identifiers matching any other reserved word + * **alpha\_variable** Identifiers matching a :abbr:`SQL (structured + query language)` variable ``"@foo"`` + * **alpha\_identifier** All other identifiers + * **quote** Applies to all quotation mark classes + * **quote\_double** Double quotes ``"`` + * **quote\_single** Single quotes ``'`` + * **quote\_backtick** Backtick quotes ````` SQL validator settings ---------------------- @@ -2520,13 +2647,12 @@ SQL validator settings :type: boolean :default: false -phpMyAdmin now supports use of the `Mimer :abbr:`SQL (structured query -language)` Validator -`_ service, as -originally published on `Slashdot -`_. -For help in setting up your system to use the service, see the -:ref:`faqsqlvalidator`. + phpMyAdmin now supports use of the `Mimer :abbr:`SQL (structured query + language)` Validator `_ + service, as originally published on `Slashdot + `_. For + help in setting up your system to use the service, see the + :ref:`faqsqlvalidator`. .. config:option:: $cfg['SQLValidator']['username'] @@ -2538,10 +2664,10 @@ For help in setting up your system to use the service, see the :type: string :default: ``''`` -The SOAP service allows you to log in with ``anonymous`` and any -password, so we use those by default. Instead, if you have an account -with them, you can put your login details here, and it will be used in -place of the anonymous login. + The SOAP service allows you to log in with ``anonymous`` and any password, + so we use those by default. Instead, if you have an account with them, you + can put your login details here, and it will be used in place of the + anonymous login. MySQL settings -------------- @@ -2551,10 +2677,10 @@ MySQL settings :type: array :default: array(...) -Functions selected by default when inserting/changing row, Functions -are defined for meta types as (FUNC\_NUMBER, FUNC\_DATE, FUNC\_CHAR, -FUNC\_SPATIAL, FUNC\_UUID) and for ``first_timestamp``, which is used -for first timestamp column in table. + Functions selected by default when inserting/changing row, Functions + are defined for meta types as (FUNC\_NUMBER, FUNC\_DATE, FUNC\_CHAR, + FUNC\_SPATIAL, FUNC\_UUID) and for ``first_timestamp``, which is used + for first timestamp column in table. Debugging settings @@ -2574,5 +2700,5 @@ Debugging settings :type: boolean :default: false -Enable logging queries and execution times to be -displayed in the bottom of main page (right frame). + Enable logging queries and execution times to be + displayed in the bottom of main page (right frame).