From bfdc39d49bbfc907ae0d2780d7fc1d1a0438ca2a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20=C4=8Ciha=C5=99?= Date: Fri, 9 Nov 2012 13:37:59 +0100 Subject: [PATCH] Add missing default values for config options --- config.rst | 429 ++++++++++++++++++++++++++++++----------------------- 1 file changed, 247 insertions(+), 182 deletions(-) diff --git a/config.rst b/config.rst index c76c723df9..28e86489d2 100644 --- a/config.rst +++ b/config.rst @@ -958,7 +958,7 @@ table headers). .. config:option:: $cfg['MaxCharactersInDisplayedSQL'] :type: integer - :default: + :default: 1000 The maximum number of characters when a :abbr:`SQL (structured query language)` query is displayed. The default limit of 1000 should be @@ -971,7 +971,7 @@ history. .. config:option:: $cfg['OBGzip'] :type: string/boolean - :default: + :default: 'auto' Defines whether to use GZip output buffering for increased speed in :abbr:`HTTP (HyperText Transfer Protocol)` transfers. Set to @@ -984,7 +984,7 @@ buffering. .. config:option:: $cfg['PersistentConnections'] :type: boolean - :default: + :default: false Whether `persistent connections `_ should be used or not. Works with @@ -1000,14 +1000,14 @@ following extensions: .. config:option:: $cfg['ForceSSL'] :type: boolean - :default: + :default: false Whether to force using https while accessing phpMyAdmin. .. config:option:: $cfg['ExecTimeLimit'] :type: integer [number of seconds] - :default: + :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 @@ -1017,7 +1017,7 @@ no effect when PHP is running in safe mode. .. config:option:: $cfg['SessionSavePath'] :type: string - :default: + :default: '' Path for storing session data (`session\_save\_path PHP parameter `_). @@ -1025,7 +1025,7 @@ Path for storing session data (`session\_save\_path PHP parameter .. config:option:: $cfg['MemoryLimit'] :type: string [number of bytes] - :default: + :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 @@ -1038,7 +1038,7 @@ as in :file:`php.ini`, eg. '16M'. Ensure you don't omit the suffix (16 means .. config:option:: $cfg['SkipLockedTables'] :type: boolean - :default: + :default: false Mark used tables and make it possible to show databases with locked tables (since MySQL 3.23.30). @@ -1046,7 +1046,7 @@ tables (since MySQL 3.23.30). .. config:option:: $cfg['ShowSQL'] :type: boolean - :default: + :default: true Defines whether :abbr:`SQL (structured query language)` queries generated by phpMyAdmin should be displayed or not. @@ -1054,7 +1054,7 @@ generated by phpMyAdmin should be displayed or not. .. config:option:: $cfg['RetainQueryBox'] :type: boolean - :default: + :default: false Defines whether the :abbr:`SQL (structured query language)` query box should be kept displayed after its submission. @@ -1062,7 +1062,7 @@ should be kept displayed after its submission. .. config:option:: $cfg['CodemirrorEnable'] :type: boolean - :default: + :default: true Defines whether to use a Javascript code editor for SQL query boxes. CodeMirror provides syntax highlighting and line numbers. However, @@ -1072,7 +1072,7 @@ distributions (such as Ubuntu) is not supported by all browsers. .. config:option:: $cfg['AllowUserDropDatabase'] :type: boolean - :default: + :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" @@ -1088,7 +1088,7 @@ rather than strict privilege limitation. .. config:option:: $cfg['Confirm'] :type: boolean - :default: + :default: true Whether a warning ("Are your really sure...") should be displayed when you're about to lose data. @@ -1096,7 +1096,7 @@ you're about to lose data. .. config:option:: $cfg['LoginCookieRecall'] :type: boolean - :default: + :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 @@ -1105,7 +1105,7 @@ configured :config:option:`$cfg['blowfish_secret']`. .. config:option:: $cfg['LoginCookieValidity'] :type: integer [number of seconds] - :default: + :default: 1440 Define how long is login cookie valid. Please note that php configuration option `session.gc\_maxlifetime @@ -1118,7 +1118,7 @@ $cfg['LoginCookieValidity']. .. config:option:: $cfg['LoginCookieStore'] :type: integer [number of seconds] - :default: + :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 @@ -1127,7 +1127,7 @@ for not trusted environments. .. config:option:: $cfg['LoginCookieDeleteAll'] :type: boolean - :default: + :default: true If enabled (default), logout deletes cookies for all servers, otherwise only for current one. Setting this to false makes it easy to @@ -1136,14 +1136,14 @@ forget to log out from other server, when you are using more of them. .. config:option:: $cfg['UseDbSearch'] :type: boolean - :default: + :default: true Define whether the "search string inside database" is enabled or not. .. config:option:: $cfg['IgnoreMultiSubmitErrors'] :type: boolean - :default: + :default: false Define whether phpMyAdmin will continue executing a multi-query statement if one of the queries fails. Default is to abort execution. @@ -1152,7 +1152,7 @@ statement if one of the queries fails. Default is to abort execution. .. config:option:: $cfg['AllowArbitraryServer'] :type: boolean - :default: + :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 @@ -1160,24 +1160,30 @@ 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 +-------------- + .. config:option:: $cfg['Error_Handler']['display'] :type: boolean - :default: + :default: false Whether to display errors from PHP or not. .. config:option:: $cfg['Error_Handler']['gather'] :type: boolean - :default: + :default: false Whether to gather errors from PHP or not. + +Navigation panel setup +---------------------- .. config:option:: $cfg['NavigationTreeEnableGrouping'] :type: boolean - :default: + :default: true Defines whether to group the databases based on a common prefix in their name :config:option:`$cfg['NavigationTreeDbSeparator']`. @@ -1185,7 +1191,7 @@ in their name :config:option:`$cfg['NavigationTreeDbSeparator']`. .. config:option:: $cfg['NavigationTreeDbSeparator'] :type: string or array - :default: + :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 @@ -1194,7 +1200,7 @@ an array and all of them will be used as a separator. .. config:option:: $cfg['NavigationTreeTableSeparator'] :type: string or array - :default: + :default: '__' Defines a string to be used to nest table spaces. Defaults to '\_\_'. This means if you have tables like 'first\_\_second\_\_third' this @@ -1206,7 +1212,7 @@ multiple times after another without any other characters in between. .. config:option:: $cfg['NavigationTreeTableLevel'] :type: integer - :default: + :default: 1 Defines how many sublevels should be displayed when splitting up tables by the above separator. @@ -1214,7 +1220,7 @@ tables by the above separator. .. config:option:: $cfg['NumRecentTables'] :type: integer - :default: + :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. @@ -1222,7 +1228,7 @@ panel. Set this to 0 (zero) to disable the listing of recent tables. .. config:option:: $cfg['ShowTooltip'] :type: boolean - :default: + :default: true Defines whether to display item comments as tooltips in navigation panel or not. @@ -1230,7 +1236,7 @@ panel or not. .. config:option:: $cfg['NavigationDisplayLogo'] :type: boolean - :default: + :default: true Defines whether or not to display the phpMyAdmin logo at the top of the navigation panel. Defaults to ``TRUE``. @@ -1238,7 +1244,7 @@ the navigation panel. Defaults to ``TRUE``. .. config:option:: $cfg['NavigationLogoLink'] :type: string - :default: + :default: 'index.php' Enter :abbr:`URL (Uniform Resource Locator)` where logo in the navigation panel will point to. For use especially with self made @@ -1247,7 +1253,7 @@ theme which changes this. The default value for this is ``main.php``. .. config:option:: $cfg['NavigationLogoLinkWindow'] :type: string - :default: + :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 @@ -1256,17 +1262,17 @@ new one (``new``). Note: use ``new`` if you are linking to .. config:option:: $cfg['NavigationTreeDisplayItemFilterMinimum'] :type: integer - :default: + :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) -.. config:option:: $cfg['NavigationTreeDisplayDatabaseFilterMinimum'] +.. config:option:: $cfg['NavigationTreeDisplayDbFilterMinimum'] :type: integer - :default: + :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 @@ -1276,7 +1282,7 @@ box above the list of databases in the navigation tree. Defaults to .. config:option:: $cfg['NavigationDisplayServers'] :type: boolean - :default: + :default: false Defines whether or not to display a server choice at the top of the navigation panel. Defaults to FALSE. @@ -1284,7 +1290,7 @@ navigation panel. Defaults to FALSE. .. config:option:: $cfg['DisplayServersList'] :type: boolean - :default: + :default: false Defines whether to display this server choice as links instead of in a drop-down. Defaults to FALSE (drop-down). @@ -1292,25 +1298,20 @@ drop-down. Defaults to FALSE (drop-down). .. config:option:: $cfg['NavigationTreeDefaultTabTable'] :type: string - :default: + :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". -.. config:option:: $cfg['HideStructureActions'] - - :type: boolean - :default: - -Defines whether the table structure actions are hidden under a "More" -drop-down. +Main panel +---------- .. config:option:: $cfg['ShowStats'] :type: boolean - :default: + :default: true Defines whether or not to display space usage and statistics about databases and tables. Note that statistics requires at least MySQL @@ -1320,7 +1321,7 @@ for Berkeley DB tables. .. config:option:: $cfg['ShowServerInfo'] :type: boolean - :default: + :default: true Defines whether to display detailed server information on main page. You can additionally hide more information by using @@ -1329,17 +1330,17 @@ You can additionally hide more information by using .. config:option:: $cfg['ShowPhpInfo'] :type: boolean - :default: + :default: false .. config:option:: $cfg['ShowChgPassword'] :type: boolean - :default: + :default: true .. config:option:: $cfg['ShowCreateDb'] :type: boolean - :default: + :default: true Defines whether to display the "PHP information" and "Change password " links and form for creating database or not at the starting main @@ -1356,10 +1357,13 @@ Also note that enabling the "Change password " link has no effect with in the configuration file, end users can't be allowed to change their passwords. +Database structure +------------------ + .. config:option:: $cfg['ShowDbStructureCreation'] :type: boolean - :default: + :default: false Defines whether the database structure page (tables list) has a "Creation" column that displays when each table was created. @@ -1367,7 +1371,7 @@ Defines whether the database structure page (tables list) has a .. config:option:: $cfg['ShowDbStructureLastUpdate'] :type: boolean - :default: + :default: false Defines whether the database structure page (tables list) has a "Last update" column that displays when each table was last updated. @@ -1375,15 +1379,26 @@ update" column that displays when each table was last updated. .. config:option:: $cfg['ShowDbStructureLastCheck'] :type: boolean - :default: + :default: false 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. + +Browse mode +----------- + .. config:option:: $cfg['NavigationBarIconic'] :type: string - :default: + :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 @@ -1392,7 +1407,7 @@ displays text and 'both' displays both icons and text. .. config:option:: $cfg['ShowAll'] :type: boolean - :default: + :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 @@ -1402,7 +1417,7 @@ performance issues while getting too many rows. .. config:option:: $cfg['MaxRows'] :type: integer - :default: + :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 @@ -1410,8 +1425,8 @@ clause is used. If the result set contains more rows, "Previous" and .. config:option:: $cfg['Order'] - :type: string [||] - :default: + :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. @@ -1421,7 +1436,7 @@ TIMESTAMP, ascending order else- by default. .. config:option:: $cfg['DisplayBinaryAsHex'] :type: boolean - :default: + :default: true Defines whether the "Show binary contents as HEX" browse option is ticked by default. @@ -1429,7 +1444,7 @@ ticked by default. .. config:option:: $cfg['GridEditing'] :type: string - :default: + :default: 'double-click' Defines which action (``double-click`` or ``click``) triggers grid editing. Can be deactived with the ``disabled`` value. @@ -1437,15 +1452,18 @@ editing. Can be deactived with the ``disabled`` value. .. config:option:: $cfg['SaveCellsAtOnce'] :type: boolean - :default: + :default: false Defines whether or not to save all edited cells at once for grid editing. +Editing mode +------------ + .. config:option:: $cfg['ProtectBinary'] :type: boolean or string - :default: + :default: 'blob' Defines whether ``BLOB`` or ``BINARY`` columns are protected from editing when browsing a table's content. Valid values are: @@ -1461,7 +1479,7 @@ editing when browsing a table's content. Valid values are: .. config:option:: $cfg['ShowFunctionFields'] :type: boolean - :default: + :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 @@ -1470,7 +1488,7 @@ this setting from the interface. .. config:option:: $cfg['ShowFieldTypesInDataEditView'] :type: boolean - :default: + :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. @@ -1478,7 +1496,7 @@ edit/insert mode. The user can toggle this setting from the interface. .. config:option:: $cfg['CharEditing'] :type: string - :default: + :default: 'input' Defines which type of editing controls should be used for CHAR and VARCHAR columns. Possible values are: @@ -1493,7 +1511,7 @@ Default is old behavior so input. .. config:option:: $cfg['MinSizeForInputField'] :type: integer - :default: + :default: 4 Defines the minimum size for input fields generated for CHAR and VARCHAR columns. @@ -1501,7 +1519,7 @@ VARCHAR columns. .. config:option:: $cfg['MaxSizeForInputField'] :type: integer - :default: + :default: 60 Defines the maximum size for input fields generated for CHAR and VARCHAR columns. @@ -1509,14 +1527,14 @@ VARCHAR columns. .. config:option:: $cfg['InsertRows'] :type: integer - :default: + :default: 2 Defines the maximum number of concurrent entries for the Insert page. .. config:option:: $cfg['ForeignKeyMaxLimit'] :type: integer - :default: + :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 @@ -1525,27 +1543,30 @@ the :config:option:`$cfg['ForeignKeyDropdownOrder']` setting. .. config:option:: $cfg['ForeignKeyDropdownOrder'] :type: array - :default: + :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'*. +array should be one or both of the following strings: ``content-id``, +``id-content``. + +Export features +--------------- .. config:option:: $cfg['ZipDump'] :type: boolean - :default: + :default: true .. config:option:: $cfg['GZipDump'] :type: boolean - :default: + :default: true .. config:option:: $cfg['BZipDump'] :type: boolean - :default: + :default: true Defines whether to allow the use of zip/GZip/BZip2 compression when creating a dump file @@ -1553,7 +1574,7 @@ creating a dump file .. config:option:: $cfg['CompressOnFly'] :type: boolean - :default: + :default: true Defines whether to allow on the fly compression for GZip/BZip2 compressed exports. This doesn't affect smaller dumps and allows users @@ -1561,10 +1582,13 @@ 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. +Tabs display settings +--------------------- + .. config:option:: $cfg['PropertiesIconic'] :type: string - :default: + :default: 'both' If set to ``TRUE``, will display icons instead of text for db and table properties links (like 'Browse', 'Select', 'Insert', ...). Can @@ -1574,7 +1598,7 @@ be set to ``'both'`` if you want icons AND text. When set to .. config:option:: $cfg['PropertiesNumColumns'] :type: integer - :default: + :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 @@ -1584,7 +1608,7 @@ display space. .. config:option:: $cfg['DefaultTabServer'] :type: string - :default: + :default: 'index.php' Defines the tab displayed by default on server view. Possible values: "main.php" (recommended for multi-user setups), @@ -1595,7 +1619,7 @@ Defines the tab displayed by default on server view. Possible values: .. config:option:: $cfg['DefaultTabDatabase'] :type: string - :default: + :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". @@ -1603,16 +1627,19 @@ values: "db\_structure.php", "db\_sql.php" or "db\_search.php". .. config:option:: $cfg['DefaultTabTable'] :type: string - :default: + :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". +Documentation +------------- + .. config:option:: $cfg['MySQLManualBase'] :type: string - :default: + :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 @@ -1623,7 +1650,7 @@ information about MySQL manuals and their types. .. config:option:: $cfg['MySQLManualType'] :type: string - :default: + :default: 'viewable' Type of MySQL documentation: @@ -1633,12 +1660,13 @@ Type of MySQL documentation: * big - "HTML, all on one page" * none - do not show documentation links - +Languages +--------- .. config:option:: $cfg['DefaultLang'] :type: string - :default: + :default: 'en' Defines the default language to use, if not browser-defined or user- defined. The corresponding language file needs to be in @@ -1647,7 +1675,7 @@ locale/*code*/LC\_MESSAGES/phpmyadmin.mo. .. config:option:: $cfg['DefaultConnectionCollation'] :type: string - :default: + :default: 'utf8_general_ci' Defines the default connection collation to use, if not user-defined. See the `MySQL documentation = 2 is available. If yes it can be used for MIME transformations. Possible values are: @@ -1750,7 +1781,7 @@ Default is auto. .. config:option:: $cfg['CheckConfigurationPermissions'] :type: boolean - :default: + :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 @@ -1761,7 +1792,7 @@ sysadmin would set this parameter to ``FALSE``. Default is ``TRUE``. .. config:option:: $cfg['LinkLengthLimit'] :type: integer - :default: + :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 @@ -1772,13 +1803,16 @@ Resource Locator)`s. Default is ``1000``. .. config:option:: $cfg['DisableMultiTableMaintenance'] :type: boolean - :default: + :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``. +Theme settings +-------------- + .. config:option:: $cfg['NaviWidth'] :type: integer @@ -1813,13 +1847,6 @@ The background styles used for both the frames. See The style used for the pointer in the navi frame. See ``themes/themename/layout.inc.php``. -.. config:option:: $cfg['NavigationTreePointerEnable'] - - :type: boolean - :default: - -A value of ``TRUE`` activates the navi pointer. - .. config:option:: $cfg['Border'] :type: integer @@ -1901,39 +1928,49 @@ serif``. 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 +-------------------- + +.. config:option:: $cfg['NavigationTreePointerEnable'] + + :type: boolean + :default: true + +A value of ``TRUE`` activates the navi pointer. + .. config:option:: $cfg['BrowsePointerEnable'] :type: boolean - :default: + :default: true Whether to activate the browse pointer or not. .. config:option:: $cfg['BrowseMarkerEnable'] :type: boolean - :default: + :default: true Whether to activate the browse marker or not. .. config:option:: $cfg['TextareaCols'] :type: integer - :default: + :default: 40 .. config:option:: $cfg['TextareaRows'] :type: integer - :default: + :default: 15 .. config:option:: $cfg['CharTextareaCols'] :type: integer - :default: + :default: 40 .. config:option:: $cfg['CharTextareaRows'] :type: integer - :default: + :default: 2 Number of columns and rows for the textareas. This value will be emphasized (\*2) for :abbr:`SQL (structured query language)` query @@ -1944,14 +1981,14 @@ and VARCHAR editing (if configured via :config:option:`$cfg['CharEditing']`). .. config:option:: $cfg['LongtextDoubleTextarea'] :type: boolean - :default: + :default: true Defines whether textarea for LONGTEXT columns should have double size. .. config:option:: $cfg['TextareaAutoSelect'] :type: boolean - :default: + :default: false Defines if the whole textarea of the query box will be selected on click. @@ -1959,7 +1996,7 @@ click. .. config:option:: $cfg['LimitChars'] :type: integer - :default: + :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. @@ -1967,7 +2004,7 @@ view. Can be turned off by a toggle button on the browse page. .. config:option:: $cfg['RowActionLinks'] :type: string - :default: + :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 @@ -1977,7 +2014,7 @@ are parsed as "top" and "bottom" with vertical display mode. .. config:option:: $cfg['DefaultDisplay'] :type: string - :default: + :default: 'horizonta' There are 3 display modes: horizontal, horizontalflipped and vertical. Define which one is displayed by default. The first mode displays each @@ -1989,14 +2026,14 @@ each row on a vertical lineup. .. config:option:: $cfg['RememberSorting'] :type: boolean - :default: + :default: true If enabled, remember the sorting of each table when browsing them. .. config:option:: $cfg['HeaderFlipType'] :type: string - :default: + :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 @@ -2009,12 +2046,12 @@ otherwise. .. config:option:: $cfg['ShowBrowseComments'] :type: boolean - :default: + :default: true .. config:option:: $cfg['ShowPropertyComments'] :type: boolean - :default: + :default: true By setting the corresponding variable to ``TRUE`` you can enable the display of column comments in Browse or Property display. In browse @@ -2023,10 +2060,13 @@ 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 +---------------------- + .. config:option:: $cfg['SQLQuery']['Edit'] :type: boolean - :default: + :default: true Whether to display an edit link to change a query in any SQL Query box. @@ -2034,7 +2074,7 @@ box. .. config:option:: $cfg['SQLQuery']['Explain'] :type: boolean - :default: + :default: true Whether to display a link to explain a SELECT query in any SQL Query box. @@ -2042,7 +2082,7 @@ box. .. config:option:: $cfg['SQLQuery']['ShowAsPHP'] :type: boolean - :default: + :default: true Whether to display a link to wrap a query in PHP code in any SQL Query box. @@ -2050,7 +2090,7 @@ box. .. config:option:: $cfg['SQLQuery']['Validate'] :type: boolean - :default: + :default: false Whether to display a link to validate a query in any SQL Query box. @@ -2059,14 +2099,17 @@ Whether to display a link to validate a query in any SQL Query box. .. config:option:: $cfg['SQLQuery']['Refresh'] :type: boolean - :default: + :default: true Whether to display a link to refresh a query in any SQL Query box. +Web server upload/save/import directories +----------------------------------------- + .. config:option:: $cfg['UploadDir'] :type: string - :default: + :default: '' The name of the directory where :abbr:`SQL (structured query language)` files have been uploaded by other means than phpMyAdmin @@ -2084,7 +2127,7 @@ of the phpMyAdmin scripts. See also :ref:`faq1_16` for alternatives. .. config:option:: $cfg['SaveDir'] :type: string - :default: + :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. @@ -2096,7 +2139,7 @@ the phpMyAdmin scripts. .. config:option:: $cfg['TempDir'] :type: string - :default: + :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 @@ -2133,10 +2176,13 @@ 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. +Export and import settings +-------------------------- + .. config:option:: $cfg['Export'] :type: array - :default: + :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 @@ -2145,7 +2191,7 @@ identify what they mean. .. config:option:: $cfg['Export']['method'] :type: string - :default: + :default: 'quick' Defines how the export form is displayed when it loads. Valid values are: @@ -2160,16 +2206,19 @@ are: .. config:option:: $cfg['Import'] :type: array - :default: + :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. +Various display setting +----------------------- + .. config:option:: $cfg['ShowDisplayDirection'] :type: boolean - :default: + :default: false Defines whether or not type display direction option is shown when browsing a table. @@ -2177,39 +2226,39 @@ browsing a table. .. config:option:: $cfg['RepeatCells'] :type: integer - :default: + :default: 100 Repeat the headers every X cells, or 0 to deactivate. .. config:option:: $cfg['EditInWindow'] :type: boolean - :default: + :default: true .. config:option:: $cfg['QueryWindowWidth'] :type: integer - :default: + :default: 550 .. config:option:: $cfg['QueryWindowHeight'] :type: integer - :default: + :default: 310 .. config:option:: $cfg['QueryHistoryDB'] :type: boolean - :default: + :default: false .. config:option:: $cfg['QueryWindowDefTab'] :type: string - :default: + :default: 'sql' .. config:option:: $cfg['QueryHistoryMax'] :type: integer - :default: + :default: 25 All those variables affect the query window feature. A :abbr:`SQL (structured query language)` link or icon is always displayed in the @@ -2255,14 +2304,14 @@ either 'sql', 'files', 'history' or 'full'. .. config:option:: $cfg['BrowseMIME'] :type: boolean - :default: + :default: true Enable :ref:`transformations`. .. config:option:: $cfg['MaxExactCount'] :type: integer - :default: + :default: 0 For InnoDB tables, determines for how large tables phpMyAdmin should get the exact row count using ``SELECT COUNT``. If the approximate row @@ -2273,7 +2322,7 @@ used. .. config:option:: $cfg['MaxExactCountViews'] :type: integer - :default: + :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 @@ -2283,7 +2332,7 @@ counting. .. config:option:: $cfg['NaturalOrder'] :type: boolean - :default: + :default: true Sorts database and table names according to natural order (for example, t1, t2, t10). Currently implemented in the navigation panel @@ -2292,7 +2341,7 @@ and in Database view, for the table list. .. config:option:: $cfg['InitialSlidersState'] :type: string - :default: + :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 @@ -2301,7 +2350,7 @@ all visual sliders, use ``'disabled'``. .. config:option:: $cfg['UserprefsDisallow'] :type: array - :default: + :default: array() Contains names of configuration options (keys in ``$cfg`` array) that users can't set through user preferences. For possible values, refer @@ -2310,37 +2359,43 @@ to :file:`libraries/config/user_preferences.forms.php`. .. config:option:: $cfg['UserprefsDeveloperTab'] :type: boolean - :default: + :default: false Activates in the user preferences a tab containing options for developers of phpMyAdmin. +Window title settings +--------------------- + .. config:option:: $cfg['TitleTable'] :type: string - :default: + :default: '@HTTP_HOST@ / @VSERVER@ / @DATABASE@ / @TABLE@ | @PHPMYADMIN@' .. config:option:: $cfg['TitleDatabase'] :type: string - :default: + :default: '@HTTP_HOST@ / @VSERVER@ / @DATABASE@ | @PHPMYADMIN@' .. config:option:: $cfg['TitleServer'] :type: string - :default: + :default: '@HTTP_HOST@ / @VSERVER@ | @PHPMYADMIN@' .. config:option:: $cfg['TitleDefault'] :type: string - :default: + :default: '@HTTP_HOST@ | @PHPMYADMIN@' Allows you to specify window's title bar. You can use :ref:`faq6_27`. +Theme manager settings +---------------------- + .. config:option:: $cfg['ThemePath'] :type: string - :default: + :default: './themes' If theme manager is active, use this as the path of the subdirectory containing all the themes. @@ -2348,41 +2403,46 @@ containing all the themes. .. config:option:: $cfg['ThemeManager'] :type: boolean - :default: + :default: true Enables user-selectable themes. See :ref:`faqthemes`. .. config:option:: $cfg['ThemeDefault'] :type: string - :default: + :default: 'pmahomme' -The default theme (a subdirectory under ``cfg['ThemePath']``). +The default theme (a subdirectory under :config:option:`$cfg['ThemePath']`). .. config:option:: $cfg['ThemePerServer'] :type: boolean - :default: + :default: false Whether to allow different theme for each server. +Default queries + .. config:option:: $cfg['DefaultQueryTable'] :type: string - :default: + :default: 'SELECT * FROM @TABLE@ WHERE 1' .. config:option:: $cfg['DefaultQueryDatabase'] :type: string - :default: + :default: '' 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 +------------------- + .. config:option:: $cfg['SQP']['fmtType'] :type: string [|] - :default: + :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 @@ -2393,12 +2453,12 @@ setting this variable to ``'none'``. .. config:option:: $cfg['SQP']['fmtInd'] :type: float - :default: + :default: '1' .. config:option:: $cfg['SQP']['fmtIndUnit'] :type: string [|||] - :default: + :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 @@ -2447,19 +2507,20 @@ the colour strings. **Class name key:** * **quote\_single** Single quotes ``'`` * **quote\_backtick** Backtick quotes ````` - +SQL validator settings +---------------------- .. config:option:: $cfg['SQLValidator'] - :type: boolean - :default: + :type: array + :default: array(...) .. config:option:: $cfg['SQLValidator']['use'] :type: boolean - :default: + :default: false phpMyAdmin now supports use of the `Mimer :abbr:`SQL (structured query language)` Validator @@ -2472,44 +2533,48 @@ For help in setting up your system to use the service, see the .. config:option:: $cfg['SQLValidator']['username'] :type: string - :default: + :default: '' .. config:option:: $cfg['SQLValidator']['password'] :type: string - :default: + :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. - -Debugging settings ------------------- - -.. config:option:: $cfg['DBG'] - - :type: array - :default: see bellow - -**DEVELOPERS ONLY!** - -.. config:option:: $cfg['DBG']['sql'] - - :type: boolean - :default: - -**DEVELOPERS ONLY!** Enable logging queries and execution times to be -displayed in the bottom of main page (right frame). +MySQL settings +-------------- .. config:option:: $cfg['DefaultFunctions'] :type: array - :default: + :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. + +Debugging settings +------------------ + +.. warning:: + + These settings might have huge effect on performace or security. + +.. config:option:: $cfg['DBG'] + + :type: array + :default: array(...) + +.. config:option:: $cfg['DBG']['sql'] + + :type: boolean + :default: false + +Enable logging queries and execution times to be +displayed in the bottom of main page (right frame).