Config

From PmaWiki

Jump to: navigation, search

This should have the default values, but it may be very helpful to also look at the ./libraries/config.default.php file included in phpMyAdmin.

Contents

PmaAbsoluteUri

Defines the URL under which phpMyAdmin is accessible from the users browser.

Complete the variable below with the full URL in the style of <schema>://<server>[:<port>][/<path>] - like http://example.com:8080/phpMyAdmin/ 

$cfg['PmaAbsoluteUri'] = '';

Usually the path is case sensitive, sometimes even on windows systems, e.g., when an Alias is used for the pma folder (like in the xampp kit).

In most cases phpMyAdmin will detect the URL correctly, so there is no need to fill this.


When a web server is running on one port and is redirected (through a proxy or some such) to another port or if you use an SSL-Proxy phpMyAdmin can not gather all needed Information to create the correct value for this needed setting itself.

But even if you set the correct URL yourself, you're fooled. phpMyAdmin will accidentally overwrite your correct value with an wrong guessed value. You need to fall back to version 2.7.0-pl2 (2005-12-27 15:08) it was messed up somewhere between version 2.8.0.3 and 2.8.2.4.

f. e. user enters following URL: https://ssl.example.org/pma.example.org/ now the proxy at ssl.example.org will ask http://pma.example.org/ and return the result to the user

phpMyAdmin will wrongly detect http://pma.example.org/ as PmaAbsoluteUri resulting in wrong links in generated HTML code aso.

so you have to set 

$cfg['PmaAbsoluteUri'] = 'https://ssl.example.org/pma.example.org/';

PmaNoRelation_DisableWarning

Disable the default warning that is displayed on the DB Details Structure page if any of the required Tables for the relation features could not be found 

$cfg['PmaNoRelation_DisableWarning'] = false;

blowfish_secret

The cookie authentication mode uses blowfish algorithm to encrypt the password. If at least one server configuration uses cookie authentication mode, enter here a passphrase that will be used by blowfish. The maximum length seems to be 46 characters if mcrypt is loaded. 

$cfg['blowfish_secret'] = '';

You do not need to remember the passphrase, as it is only used internally and you are never prompted for it. If you change it, all that happens is that people currently using your phpMyAdmin installation are logged out and prompted for their password again.

Server(s) configuration

The $cfg['Servers'] array starts with $cfg['Servers'][1]. Do not use $cfg['Servers'][0]. If you want more than one server, just copy following section (including $i incrementation) serveral times. There is no need to define full server array, just define values you need to change.

host

Possible values are:

  • 'hostname', e.g., localhost or mydb.test.org
  • 'IP address', e.g., 127.0.0.1 or 192.168.10.1
  • '.' - dot, i.e., use named pipes on windows systems
  • '' - empty, disables this server 
$cfg['Servers'][$i]['host'] = 'localhost';

port

MySQL port - leave blank for default port, which normally is 3306. 

$cfg['Servers'][$i]['port'] = '';

socket

Path to the socket - leave blank for default socket 

$cfg['Servers'][$i]['socket'] = '';

connect_type

How to connect to MySQL server (tcp or socket). 

$cfg['Servers'][$i]['connect_type'] = 'tcp';

extension

The PHP MySQL extension to use (mysql or mysqli). 

$cfg['Servers'][$i]['extension'] = 'mysql';

compress

Use compressed protocol for the MySQL connection (requires PHP >= 4.3.0) 

$cfg['Servers'][$i]['compress'] = FALSE;

ssl

This feature is available since phpMyAdmin 2.10.0.

Use SSL for the MySQL connection (requires PHP >= 4.3.0) 

$cfg['Servers'][$i]['ssl'] = FALSE;

In phpMyAdmin 2.10.0.0 unfortunately the default setting was TRUE. Set it to FALSE if you get the MySQL error "#1043 - Bad handshake" or "#2026 - SSL connection error".

controluser

MySQL control user settings (this user must have read-only access to the "mysql/user" and "mysql/db" tables). The controluser is also used for all relational features (pmadb). 

$cfg['Servers'][$i]['controluser'] = '';

controlpass

The password needed for the controluser to login (see $cfg['Servers'][$i]['controluser']). 

$cfg['Servers'][$i]['controlpass'] = '';

auth_type

Authentication method used to authenticate users (config, http, signon, or cookie), see authentication methods. 

$cfg['Servers'][$i]['auth_type'] = 'config';

user

MySQL user which should be used to connect to the database, only needed when using config as $cfg['Servers'][$i]['auth_type']. 

$cfg['Servers'][$i]['user'] = 'root';

password

MySQL password which should be used to connect to the database, only needed when using config as $cfg['Servers'][$i]['auth_type']. 

$cfg['Servers'][$i]['password'] = '';

nopassword

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. 

$cfg['Servers'][$i]['nopassword'] = FALSE;

only_db

If set to a db-name, only this db is displayed in left frame. It may also be an array of db-names, where sorting order is relevant. For example: $cfg['Servers'][$i]['only_db'] = array('db1', 'db2');. This does not replace using proper privilege rules on the MySQL server - it only hides the database in the navigation frame. 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).

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. 

$cfg['Servers'][$i]['only_db'] = '';

hide_db

Regular expression for database name(s) to be hidden from listings. This does not replace using proper privilege rules on the MySQL server - it only hides the database in the navigation frame.

For example, to hide all databases beginning with the letter a use: $cfg['Servers'][$i]['hide_db'] = '^a';. To hide multiple databases by name use $cfg['Servers'][$i]['hide_db'] = '(information_schema|phpmyadmin|mysql)'.

More information on regular expressions in PHP can be found in the PCRE pattern reference portion of the PHP manual. 

$cfg['Servers'][$i]['hide_db'] = '';

verbose

Verbose name for this host - leave blank to show the hostname 

$cfg['Servers'][$i]['verbose'] = '';

pmadb

Database used for relations, bookmarks, and PDF features (see scripts/create_tables.sql). See pmadb for complete information. Leave blank for no support DEFAULT: 'phpmyadmin' 

$cfg['Servers'][$i]['pmadb'] = '';

bookmarktable

Bookmark table - leave blank for no bookmark support DEFAULT: 'pma_bookmark' 

$cfg['Servers'][$i]['bookmarktable'] = '';

relation

table to describe the relation between links (more information in Documentation.html) - leave blank for no relation-links support DEFAULT: 'pma_relation' 

$cfg['Servers'][$i]['relation'] = '';

table_info

table to describe the display fields - leave blank for no display fields support DEFAULT: 'pma_table_info' 

$cfg['Servers'][$i]['table_info'] = '';

table_coords

table to describe the tables position for the PDF schema - leave blank for no PDF schema support DEFAULT: 'pma_table_coords' 

$cfg['Servers'][$i]['table_coords'] = '';

pdf_pages

table to describe pages of relationpdf - leave blank if you don't want to use this DEFAULT: 'pma_pdf_pages' 

$cfg['Servers'][$i]['pdf_pages'] = '';

column_info

table to store column information - leave blank for no column comments/mime types DEFAULT: 'pma_column_info' 

$cfg['Servers'][$i]['column_info'] = '';

history

table to store SQL history - leave blank for no SQL query history DEFAULT: 'pma_history' 

$cfg['Servers'][$i]['history'] = '';

designer_coords

Table in which to store information for the designer feature. DEFAULT: 'pma_designer_coords' 

$cfg['Servers'][$i]['designer_coords'] = '';

verbose_check

set to FALSE if you know that your pma_* tables are up to date. This prevents compatibility checks and thereby increases performance. 

$cfg['Servers'][$i]['verbose_check'] = TRUE;

AllowRoot

whether to allow root login 

$cfg['Servers'][$i]['AllowRoot'] = TRUE;

AllowDeny (order)

Host authentication order, leave blank to not use 

$cfg['Servers'][$i]['AllowDeny']['order'] = ''

If your rule order is empty, then IP authentication 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', the authentication 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 $cfg['TrustedProxies'] for detecting IP address behind proxies.

AllowDeny (rules)

Host authentication rules, leave blank for defaults 

$cfg['Servers'][$i]['AllowDeny']['rules'] = array();// of strings

The general format for the rules is as such: 

<'allow' | 'deny'> <username> [from] <ipmask>

example: array('deny root from all', 'allow root from localhost', 'allow root from 192.168.0.0/24');

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): 

'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 IP matching system, the following work: 

xxx.xxx.xxx.xxx (an exact IP address)
xxx.xxx.xxx.[yyy-zzz] (an IP address range)
xxx.xxx.xxx.xxx/nn (CIDR, Classless Inter-Domain Routing type IP addresses)

But the following does not work: 

xxx.xxx.xxx.xx[yyy-zzz] (partial IP address range)

DisableIS

This feature is available since phpMyAdmin 3.0.0.

Disable use of INFORMATION_SCHEMA see http://sf.net/support/tracker.php?aid=1849494 and http://bugs.mysql.com/19588 

$cfg['Servers'][$i]['DisableIS'] = true;

ShowDatabasesCommand

This feature is available since phpMyAdmin 3.0.0.

SQL command to fetch available databases

By default most user will be fine with SHOW DATABASES, for servers with a huge amount of databases it is possible to define a command which executes faster but with less information

Especially when accessing database servers from ISPs changing this command can result in a great speed improvement

examples: 

'SHOW DATABASES'
"SHOW DATABASES LIKE '#user#\_%'" (#user# will be replaced by the current user)
'SELECT DISTINCT TABLE_SCHEMA FROM information_schema.SCHEMA_PRIVILEGES'
'SELECT SCHEMA_NAME FROM information_schema.SCHEMATA'
false

false will disable fetching databases from the server, only databases in $cfg['Servers'][$i]['only_db'] will be displayed 

$cfg['Servers'][$i]['ShowDatabasesCommand'] = 'SHOW DATABASES';

CountTables

This feature is available since phpMyAdmin 3.0.0.

Whether to count tables when showing database list 

$cfg['Servers'][$i]['CountTables'] = true;

SignonSession

This feature is available since phpMyAdmin 2.10.0.

Name of session which will be used for signon authentication method, see authentication types for an example.

SignonURL

This feature is available since phpMyAdmin 2.10.0.

URL where user will be redirected for login for signon authentication method. Should be absolute including protocol.

LogoutURL

This feature is available since phpMyAdmin 2.10.0.

URL where user will be redirected after logout (doesn't affect config authentication method). Should be absolute including protocol.

ServerDefault

Default server (0 = no default server)

If you have more than one server configured, you can set $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. 

$cfg['ServerDefault'] = 0;

Other core phpMyAdmin settings

MaxDbList

Define the maximum number of databases displayed in left frame or database list. 

$cfg['MaxDbList'] = 100;

MaxTableList

This feature is available since phpMyAdmin 2.11.0.

The maximum number of table names to be displayed in the right panel's list. 

$cfg['MaxTableList'] = 100;
Changed in phpMyAdmin 2.11.1 : 
$cfg['MaxTableList'] = 250;

MaxCharactersInDisplayedSQL

This feature is available since phpMyAdmin 2.11.0.

The maximum number of characters when a SQL 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 SQL queries that are longer than 1000 characters. 

$cfg['MaxCharactersInDisplayedSQL'] = 1000;

OBGzip

Defines whether to use GZip output buffering for increased speed in HTTP transfers. 

$cfg['OBGzip'] = 'auto';

Set to TRUE/FALSE for enabling/disabling. When set to 'auto', 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.

PersistentConnections

use persistent connections to MySQL database 

$cfg['PersistentConnections']   = FALSE;

ForceSSL

whether to force using https 

$cfg['ForceSSL']                = FALSE;


ExecTimeLimit

maximum execution time in seconds (0 for no limit) 

$cfg['ExecTimeLimit']           = 300;


MemoryLimit

maximum allocated bytes (0 for no limit) 

$cfg['MemoryLimit']             = 0;


SkipLockedTables

mark used tables, make possible to show locked tables (since MySQL 3.23.30) 

$cfg['SkipLockedTables']        = FALSE;


ShowSQL

show SQL queries as run 

$cfg['ShowSQL']                 = TRUE;


AllowUserDropDatabase

show a 'Drop database' link to normal users 

$cfg['AllowUserDropDatabase']   = FALSE;


Confirm

confirm 'DROP TABLE' & 'DROP DATABASE' 

$cfg['Confirm']                 = TRUE;


LoginCookieRecall

Define whether the previous login should be recalled or not in cookie authentication mode. 

$cfg['LoginCookieRecall'] = TRUE;

LoginCookieValidity

Define how long (in seconds) a login cookie is valid. 

$cfg['LoginCookieValidity'] = 1800;

Maximum value is 2^31-1 , which is around 2.1 * 10^9. This is about 58 years.

If you are on a 64-bit system it is even longer. 2^63-1. Longer than the age of the universe.

LoginCookieStore

Define how long (in seconds) a login cookie should be stored in browser. Default 0 means that it will be kept for existing session only, that is it will be deleted as soon as you close the browser window. This is recommended for non-trusted environments. 

$cfg['LoginCookieStore'] = 0;

LoginCookieDeleteAll

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. 

$cfg['LoginCookieDeleteAll'] = TRUE;

UseDbSearch

whether to enable the "database search" feature or not 

$cfg['UseDbSearch']             = TRUE;


IgnoreMultiSubmitErrors

if set to true, PMA continues computing multiple-statement queries even if one of the queries failed 

$cfg['IgnoreMultiSubmitErrors'] = FALSE;


VerboseMultiSubmit

if set to true, PMA will show the affected rows of EACH statement on multiple-statement queries. See the libraries/import.php file for hardcoded defaults on how many queries a statement may contain! 

$cfg['VerboseMultiSubmit']      = TRUE;


AllowArbitraryServer

If enabled allows you to log in to arbitrary MySQL servers using cookie authentication mode.

NOTE: Please use this carefully, as this may allow users access to MySQL servers behind the firewall where your HTTP server is placed. 

$cfg['AllowArbitraryServer'] = FALSE;

Error Handler

This feature is available since phpMyAdmin 3.0.0.

Configures the phpMyAdmin error handler, it is used to avoid information disclosure, gather errors for logging, reporting and displaying

display

Whether or not to display errors

this does not affect errors of type E_USER_* 

$cfg['Error_Handler']['display'] = false;

log

Where to log errors, set to false or leave empty to disable

  • see http://php.net/error_log
  • array(0); // log to std PHP error log
  • array(1, 'admin@example.org'); // mail errors
  • array(3, '/var/log/phpmyadmin_error.log'); // append to specific file 
$cfg['Error_Handler']['log'] = false;

gather

Gather all errors in session to be displayed on a error reporting page for viewing and/or sending to phpMyAdmin developer team 

$cfg['Error_Handler']['gather'] = false;

Left frame setup

LeftFrameLight

use a select-based menu and display only the current tables in the left frame. 

$cfg['LeftFrameLight']        = TRUE;


LeftFrameDBTree

turn the select-based light menu into a tree 

$cfg['LeftFrameDBTree']       = TRUE;


LeftFrameDBSeparator

the separator to sub-tree the select-based light menu tree 

$cfg['LeftFrameDBSeparator']  = '_';


LeftFrameTableSeparator

Which string will be used to generate table prefixes to split/nest tables into multiple categories 

$cfg['LeftFrameTableSeparator']= '__';


LeftFrameTableLevel

How many sublevels should be displayed when splitting up tables by the above Separator 

$cfg['LeftFrameTableLevel']   = '1';


ShowTooltip

display table comment as tooltip in left frame 

$cfg['ShowTooltip']           = TRUE;


ShowTooltipAliasDB

if ShowToolTip is enabled, this defines that table/db comments 

$cfg['ShowTooltipAliasDB']    = FALSE;


ShowTooltipAliasTB

are shown (in the left menu and db_details_structure) instead of table/db names. Setting ShowTooltipAliasTB to 'nested' will only use the Aliases for nested descriptors, not the table itself. 

$cfg['ShowTooltipAliasTB']    = FALSE;


LeftDisplayLogo

display logo at top of left frame 

$cfg['LeftDisplayLogo']       = TRUE;


LeftLogoLink

where should logo link point to 

$cfg['LeftLogoLink']          = 'main.php';

LeftDisplayServers

display server choice at top of left frame 

$cfg['LeftDisplayServers']    = FALSE;


DisplayServersList

Defines whether to display this server choice as links instead of in a drop-down. Defaults to FALSE (drop-down). 

$cfg['DisplayServersList']    = FALSE;

DisplayDatabasesList

This feature is available since phpMyAdmin 2.10.0.

Defines whether to display database choice in light navigation frame as links instead of in a drop-down. Defaults to 'auto' - on main page list is shown, when database is selected, only drop down is displayed. 

$cfg['DisplayDatabasesList']    = FALSE;
Changed in phpMyAdmin 2.11.0 : 
$cfg['DisplayDatabasesList']    = 'auto';

LeftDefaultTabTable

This feature is available since phpMyAdmin 3.0.0.

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" (fields list), "tbl_sql.php" (SQL form), "tbl_select.php" (search), "tbl_change.php" (insert) or "sql.php" (browse). 

$cfg['LeftDefaultTabTable'] = 'tbl_structure.php';

(the new default setting reverts the accustomed meanings of the links prior to pma 3.0)

In the main frame, at startup...

ShowStats

allow to display statistics and space usage in the pages about database details and table properties 

$cfg['ShowStats']             = TRUE;


ShowServerInfo

This feature is available since phpMyAdmin 2.10.0.

Defines whether to display detailed server information on main page. You can additionally hide more information by using $cfg['Servers'][$i]['verbose']. 

$cfg['ShowServerInfo']             = TRUE;


ShowPhpInfo

show php info link 

$cfg['ShowPhpInfo']           = FALSE;


ShowChgPassword

Allow a user to change the password for the used MySQL account.

Please note that enabling the "Change password " link has no effect with "config" authentication mode (see $cfg['Servers'][$i]['auth_type']): because of the hard coded password value in the configuration file, end users can't be allowed to change their passwords. 

$cfg['ShowChgPassword'] = FALSE;

ShowCreateDb

show create database form 

$cfg['ShowCreateDb']          = TRUE;

SuggestDBName

Defines whether to suggest a database name on the "Create Database" form (if possible) or to keep the textfield empty (if set to FALSE). 

$cfg['SuggestDBName'] = TRUE;

In browse mode...

ShowBlob

display blob field contents 

$cfg['ShowBlob']              = FALSE;


NavigationBarIconic

Defines whether navigation bar buttons and the right panel top menu (Server, Database, Table) contain text or symbols only. A value of TRUE displays icons, FALSE displays text and 'both' displays both icons and text. 

$cfg['NavigationBarIconic'] = 'both';

ShowAll

Setting this option to TRUE shows a "Show all" button when browsing any table. Pushing the button makes phpMyAdmin remove the LIMIT clause it adds by default to any SELECT query (see $cfg['MaxRows'] option), allowing all matching records to be shown on one page. 

$cfg['ShowAll'] = FALSE;

MaxRows

This is the maximum number of rows being displayed on one page when browsing a table or doing any other SELECT query. If more than this number of records are in the table or match the given SELECT query, additional navigation elements will be shown to allow browsing the whole result set. 

$cfg['MaxRows'] = 30;

Order

default for 'ORDER BY' clause when clicking on a column header for the first time (valid values are 'ASC', 'DESC' or 'SMART' - ie descending order for fields of type TIME, DATE, DATETIME & TIMESTAMP, ascending order else - , 'SMART' seems not to work as intended in recent versions) 

$cfg['Order'] = 'ASC';

In edit mode...

ProtectBinary

Defines whether BLOB or BINARY fields are protected from editing when browsing a table's content. Valid values are:

  • FALSE to allow editing of all fields;
  • 'blob' to allow editing of all fields except BLOBS;
  • 'all' to disallow editing of all BINARY or BLOB fields. 
$cfg['ProtectBinary'] = 'blob';

ShowFunctionFields

Display the function fields in edit/insert mode 

$cfg['ShowFunctionFields']    = TRUE;

CharEditing

Which editor should be used for CHAR/VARCHAR fields: input - allows limiting of input length textarea - allows newlines in fields 

$cfg['CharEditing']           = 'input';

InsertRows

How many rows can be inserted at one time 

$cfg['InsertRows']            = 2;


ForeignKeyDropdownOrder

Sort order for items in a foreign-key dropdown box. 'content' is the referenced data, 'id' is the key value. 

$cfg['ForeignKeyDropdownOrder'] = array( 'content-id', 'id-content');

ForeignKeyMaxLimit

A dropdown will be used if fewer items are present 

$cfg['ForeignKeyMaxLimit'] = 100;


For the export features...

ZipDump

Allow the use of zip/gzip/bzip 

$cfg['ZipDump']               = TRUE;


GZipDump

compression for 

$cfg['GZipDump']              = TRUE;


BZipDump

dump files 

$cfg['BZipDump']              = TRUE;


CompressOnFly

Will compress gzip/bzip2 exports on fly without need for much memory. If you encounter problems with created gzip/bzip2 files disable this feature. 

$cfg['CompressOnFly']         = TRUE;


Tabs display settings

LightTabs

use graphically less intense menu tabs 

$cfg['LightTabs']             = FALSE;


PropertiesIconic

Use icons instead of text for the table display of a database (TRUE|FALSE|'both') 

$cfg['PropertiesIconic']      = TRUE;


PropertiesNumColumns

How many columns should be used for table display of a database? (a value larger than 1 results in some information being hidden) 

$cfg['PropertiesNumColumns']  = 1;


DefaultTabServer

Possible values:

  • 'main.php' = the welcome page (recommended for multiuser setups)
  • 'server_databases.php' = list of databases
  • 'server_status.php' = runtime information
  • 'server_variables.php' = MySQL server variables
  • 'server_privileges.php' = user management
  • 'server_processlist.php' = process list 
$cfg['DefaultTabServer']      = 'main.php';

DefaultTabDatabase

Possible values:

  • 'db_details_structure.php' = tables list
  • 'db_details.php' = sql form
  • 'db_search.php' = search query
  • 'db_operations.php' = operations on database 
$cfg['DefaultTabDatabase']    = 'db_details_structure.php';

DefaultTabTable

Possible values:

  • 'tbl_properties_structure.php' = fields list
  • 'tbl_properties.php' = sql form
  • 'tbl_select.php' = select page
  • 'tbl_change.php' = insert row page
  • 'sql.php' = browse page 
$cfg['DefaultTabTable']       = 'tbl_properties_structure.php';


Export defaults

format

sql/latex/excel/csv/xml/xls/htmlexcel/htmlword/ods/odt 

$cfg['Export']['format']                    = 'sql';

compression

none/zip/gzip/bzip2 

$cfg['Export']['compression']               = 'none';

asfile 

$cfg['Export']['asfile']                    = FALSE;

charset 

 $cfg['Export']['charset'] = '';

( [1] legal values for preselection, takes only effect if $cfg['AllowAnywhereRecoding'] = true; )

onserver 

$cfg['Export']['onserver']                  = FALSE;

onserver_overwrite 

$cfg['Export']['onserver_overwrite']        = FALSE;

remember_file_template 

$cfg['Export']['remember_file_template']    = TRUE;

file_template_table 

$cfg['Export']['file_template_table']       = '__TABLE__';

file_template_database 

$cfg['Export']['file_template_database']    = '__DB__';

file_template_server 

$cfg['Export']['file_template_server']      = '__SERVER__';

ODS

ods_columns 

$cfg['Export']['ods_columns']               = FALSE;

ods_null 

$cfg['Export']['ods_null']                  = 'NULL';

ODT

odt_structure 

$cfg['Export']['odt_structure']             = TRUE;

odt_data 

$cfg['Export']['odt_data']                  = TRUE;

odt_columns 

$cfg['Export']['odt_columns']               = TRUE;

odt_relation 

$cfg['Export']['odt_relation']              = TRUE;

odt_comments 

$cfg['Export']['odt_comments']              = TRUE;

odt_mime 

$cfg['Export']['odt_mime']                  = TRUE;

odt_null 

$cfg['Export']['odt_null']                  = 'NULL';

HTML-Excel

htmlexcel_columns 

$cfg['Export']['htmlexcel_columns']         = FALSE;

htmlexcel_null 

$cfg['Export']['htmlexcel_null']            = 'NULL';

HTML-Word

htmlword_structure 

$cfg['Export']['htmlword_structure']        = TRUE;

htmlword_data 

$cfg['Export']['htmlword_data']             = TRUE;

htmlword_columns 

$cfg['Export']['htmlword_columns']          = FALSE;

htmlword_null 

$cfg['Export']['htmlword_null']             = 'NULL';

Texy

texytext_structure 

$cfg['Export']['texytext_structure']        = TRUE;

texytext_data 

$cfg['Export']['texytext_data']             = TRUE;

texytext_columns 

$cfg['Export']['texytext_columns']          = FALSE;

texytext_null 

$cfg['Export']['texytext_null']             = 'NULL';

XLS

xls_columns 

$cfg['Export']['xls_columns']               = FALSE;

xls_null 

$cfg['Export']['xls_null']                  = 'NULL';

CSV

csv_columns 

$cfg['Export']['csv_columns']               = FALSE;

csv_null 

$cfg['Export']['csv_null']                  = 'NULL';

csv_separator 

$cfg['Export']['csv_separator']             = ';';

csv_enclosed 

$cfg['Export']['csv_enclosed']              = '"';

csv_escaped 

$cfg['Export']['csv_escaped']               = '\\';

csv_terminated 

$cfg['Export']['csv_terminated']            = 'AUTO';

Excel

excel_columns 

$cfg['Export']['excel_columns']             = FALSE;

excel_null 

$cfg['Export']['excel_null']                = 'NULL';

excel_edition

win/mac 

$cfg['Export']['excel_edition']             = 'win';

Latex

latex_structure 

$cfg['Export']['latex_structure']           = TRUE;

latex_data 

$cfg['Export']['latex_data']                = TRUE;

latex_columns 

$cfg['Export']['latex_columns']             = TRUE;

latex_relation 

$cfg['Export']['latex_relation']            = TRUE;

latex_comments 

$cfg['Export']['latex_comments']            = TRUE;

latex_mime 

$cfg['Export']['latex_mime']                = TRUE;

latex_null 

$cfg['Export']['latex_null']                = '\textit{NULL}';

latex_caption 

$cfg['Export']['latex_caption']             = TRUE;

latex_structure_caption 

$cfg['Export']['latex_structure_caption']   = 'strLatexStructure';

latex_structure_continued_caption 

$cfg['Export']['latex_structure_continued_caption'] = 'strLatexStructure strLatexContinued';

latex_data_caption 

$cfg['Export']['latex_data_caption']        = 'strLatexContent';

latex_data_continued_caption 

$cfg['Export']['latex_data_continued_caption'] = 'strLatexContent strLatexContinued';

latex_data_label 

$cfg['Export']['latex_data_label']          = 'tab:__TABLE__-data';

latex_structure_label 

$cfg['Export']['latex_structure_label']     = 'tab:__TABLE__-structure';

SQL

sql_structure 

$cfg['Export']['sql_structure']             = TRUE;

sql_data 

$cfg['Export']['sql_data']                  = TRUE;

sql_compat

NONE | ANSI | DB2 | MAXDB | MYSQL323 | MYSQL40 | MSSQL | ORACLE | POSTGRESQL 

$cfg['Export']['sql_compat']                = 'NONE';

sql_disable_fk 

$cfg['Export']['sql_disable_fk']            = FALSE;

sql_use_transaction 

$cfg['Export']['sql_use_transaction']       = FALSE;

sql_drop_database 

$cfg['Export']['sql_drop_database']         = FALSE;

sql_drop_table 

$cfg['Export']['sql_drop_table']            = FALSE;

sql_if_not_exists 

$cfg['Export']['sql_if_not_exists']         = FALSE;

sql_auto_increment 

$cfg['Export']['sql_auto_increment']        = TRUE;

sql_backquotes 

$cfg['Export']['sql_backquotes']            = TRUE;

sql_dates 

$cfg['Export']['sql_dates']                 = FALSE;

sql_relation 

$cfg['Export']['sql_relation']              = FALSE;

sql_columns

this is for defining the default state of the "Complete inserts" checkbox 

$cfg['Export']['sql_columns']               = TRUE;

sql_delayed 

$cfg['Export']['sql_delayed']               = FALSE;

sql_ignore 

$cfg['Export']['sql_ignore']                = FALSE;

sql_hex_for_binary 

$cfg['Export']['sql_hex_for_binary']        = TRUE;

sql_type

insert/update/replace 

$cfg['Export']['sql_type']                  = 'insert';

sql_extended 

$cfg['Export']['sql_extended']              = TRUE;

sql_max_query_size 

$cfg['Export']['sql_max_query_size']        = 50000;

sql_comments 

$cfg['Export']['sql_comments']              = FALSE;

sql_mime 

$cfg['Export']['sql_mime']                  = FALSE;

sql_header_comment

\n is replaced by new line 

$cfg['Export']['sql_header_comment']        = '';

PDF

pdf_structure 

$cfg['Export']['pdf_structure']             = FALSE;

pdf_data 

$cfg['Export']['pdf_data']                  = TRUE;

pdf_report_title 

$cfg['Export']['pdf_report_title']          = '';

Import defaults

format 

$cfg['Import']['format'] = 'sql';

allow_interrupt 

$cfg['Import']['allow_interrupt'] = TRUE;

skip_queries 

$cfg['Import']['skip_queries'] = '0';

sql_compatibility 

$cfg['Import']['sql_compatibility'] = 'NONE';

csv_replace 

$cfg['Import']['csv_replace'] = FALSE;

csv_terminated 

$cfg['Import']['csv_terminated'] = ';';

csv_enclosed 

$cfg['Import']['csv_enclosed'] = '"';

csv_escaped 

$cfg['Import']['csv_escaped'] = '\\';

csv_new_line 

$cfg['Import']['csv_new_line'] = 'auto';

csv_columns 

$cfg['Import']['csv_columns'] = '';

ldi_replace 

$cfg['Import']['ldi_replace'] = FALSE;

ldi_terminated 

$cfg['Import']['ldi_terminated'] = ';';

ldi_enclosed 

$cfg['Import']['ldi_enclosed'] = '"';

ldi_escaped 

$cfg['Import']['ldi_escaped'] = '\\';

ldi_new_line 

$cfg['Import']['ldi_new_line'] = 'auto';

ldi_columns 

$cfg['Import']['ldi_columns'] = '';

ldi_local_option

'auto' for autodetection, TRUE or FALSE for forcing 

$cfg['Import']['ldi_local_option'] = 'auto';


MySQLManualBase

Link to the official MySQL documentation. Be sure to include no trailing slash on the path. See http://dev.mysql.com/doc/ for more information about MySQL manuals and their types. 

$cfg['MySQLManualBase'] = 'http://dev.mysql.com/doc/refman';

MySQLManualType

Type of MySQL documentation:

  • viewable - "viewable online", current one used on MySQL website
  • searchable - "Searchable, with user comments"
  • chapters - "HTML, one page per chapter"
  • chapters_old - "HTML, one page per chapter", format used prior to MySQL 5.0 release
  • big - "HTML, all on one page"
  • old - old style used in phpMyAdmin 2.3.0 and sooner
  • none - do not show documentation links 
$cfg['MySQLManualType'] = 'viewable';

PDF options

PDFDefaultPageSize 

$cfg['PDFPageSizes']        = array('A3', 'A4', 'A5', 'letter', 'legal');

PDFDefaultPageSize 

$cfg['PDFDefaultPageSize']  = 'A4';


Language and charset conversion settings

DefaultLang

Default language to use, if not browser-defined or user-defined 

$cfg['DefaultLang'] = 'en-iso-8859-1';
Changed in phpMyAdmin 3.0.0 : 
$cfg['DefaultLang'] = 'en-utf-8';

DefaultConnectionCollation

Default connection collation (used for MySQL >= 4.1) 

$cfg['DefaultConnectionCollation'] = 'utf8_unicode_ci';
Changed in phpMyAdmin 3.0.0 : 
$cfg['DefaultConnectionCollation'] = 'utf8_general_ci';

Lang

Force: always use this language - must be defined in libraries/select_lang.lib.php 

$cfg['Lang']     = 'en-iso-8859-1';
Changed in phpMyAdmin 3.0.0 : 
$cfg['Lang']     = 'en-utf-8';

FilterLanguages

Regular expression to limit listed languages, eg. '^(cs|en)' for Czech and English only 

$cfg['FilterLanguages'] = '';

DefaultCharset

Default charset to use for recoding of MySQL queries, does not take any effect when charsets recoding is switched off by $cfg['AllowAnywhereRecoding'] or in language file (see $cfg['AvailableCharsets'] to possible choices, you can add your own) 

$cfg['DefaultCharset'] = 'iso-8859-1';
Changed in phpMyAdmin 3.0.0 : 
$cfg['DefaultCharset'] = 'utf-8';

AllowAnywhereRecoding

Allow charset recoding of MySQL queries, must be also enabled in language file to make harder using other language files than unicode. Default value is FALSE to avoid problems on servers without the iconv extension and where dl() is not supported. Setting this to TRUE also activates a pull-down menu in the Export page, to choose the character set when exporting a file. 

$cfg['AllowAnywhereRecoding'] = FALSE;

RecodingEngine

You can select here which functions will be used for charset 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 
$cfg['RecodingEngine'] = 'auto';

IconvExtraParams

Specify some parameters for iconv used in charset conversion. See iconv documentation for details: http://www.gnu.org/software/libiconv/documentation/libiconv/iconv_open.3.html 

$cfg['IconvExtraParams'] = '//TRANSLIT';

AvailableCharsets

Available charsets for MySQL conversion. currently contains all which could be found in lang/* files and few more. Charsets will be shown in same order as here listed, so if you frequently use some of these move them to the top. 

$cfg['AvailableCharsets'] = array(
   'iso-8859-1',
   'iso-8859-2',
   'iso-8859-3',
   'iso-8859-4',
   'iso-8859-5',
   'iso-8859-6',
   'iso-8859-7',
   'iso-8859-8',
   'iso-8859-9',
   'iso-8859-10',
   'iso-8859-11',
   'iso-8859-12',
   'iso-8859-13',
   'iso-8859-14',
   'iso-8859-15',
   'windows-1250',
   'windows-1251',
   'windows-1252',
   'windows-1256',
   'windows-1257',
   'koi8-r',
   'big5',
   'gb2312',
   'utf-16',
   'utf-8',
   'utf-7',
   'x-user-defined',
   'euc-jp',
   'ks_c_5601-1987',
   'tis-620',
   'SHIFT_JIS'

);


Customization & design

The graphical settings are now located in themes/themename/layout.inc.php


LeftPointerEnable

enable the left panel pointer (used when LeftFrameLight is FALSE) see also LeftPointerColor in layout.inc.php 

$cfg['LeftPointerEnable']   = TRUE;


BrowsePointerEnable

enable the browse pointer see also BrowsePointerColor in layout.inc.php 

$cfg['BrowsePointerEnable'] = TRUE;


BrowseMarkerEnable

enable the browse marker see also BrowseMarkerColor in layout.inc.php 

$cfg['BrowseMarkerEnable'] = TRUE;


TextareaCols

textarea size (columns) in edit mode (this value will be emphasized (*2) for sql query textareas and (*1.25) for query window) 

$cfg['TextareaCols']        = 40;


TextareaRows

textarea size (rows) in edit mode 

$cfg['TextareaRows']        = 7;


LongtextDoubleTextarea

double size of textarea size for longtext fields 

$cfg['LongtextDoubleTextarea'] = TRUE;


TextareaAutoSelect

By default, clicking into the textarea when editing an SQL statement automatically selects the text. Any previous text in the clipboard will be overwritten. Setting this option to FALSE disables automatic selection of the text. 

$cfg['TextareaAutoSelect'] = TRUE;

CharTextareaCols

textarea size (columns) for CHAR/VARCHAR 

$cfg['CharTextareaCols']    = 40;


CharTextareaRows

textarea size (rows) for CHAR/VARCHAR 

$cfg['CharTextareaRows']    = 2;


CtrlArrowsMoving

Enable Ctrl+Arrows moving between fields when editing? 

$cfg['CtrlArrowsMoving']    = TRUE;


LimitChars

Max field data length in browse mode for all non-numeric fields 

$cfg['LimitChars']          = 50;


ModifyDeleteAtLeft

show edit/delete links on left side of browse (or at the top with vertical browse) 

$cfg['ModifyDeleteAtLeft']  = TRUE;


ModifyDeleteAtRight

show edit/delete links on right side of browse (or at the bottom with vertical browse) 

$cfg['ModifyDeleteAtRight'] = FALSE;


DefaultDisplay

default display direction (horizontal|vertical|horizontalflipped) 

$cfg['DefaultDisplay']      = 'horizontal';


DefaultPropDisplay

When editing/creating new columns in a table all fields normally get lined up one field a line. (default: 'horizontal'). If you set this to 'vertical' you can have each field lined up vertically beneath each other. You can save up a lot of place on the horizontal direction and no longer have to scroll.

This feature is available since phpMyAdmin 2.10.0.

If you set this to integer, editing of fewer columns will appear in 'vertical' mode, while editing of more fields still in 'horizontal' mode. This way you can still effectively edit large number of fields, while having full view on few of them. 

$cfg['DefaultPropDisplay']  = 'horizontal';

HeaderFlipType

table-header rotation via faking or css? (css|fake) NOTE: CSS only works in IE browsers! 

$cfg['HeaderFlipType']      = 'css';


ShowBrowseComments

shows stored relation-comments in 'browse' mode. 

$cfg['ShowBrowseComments']  = TRUE;


ShowPropertyComments

shows stored relation-comments in 'table property' mode. 

$cfg['ShowPropertyComments']= TRUE;


RepeatCells

repeat header names every X cells? (0 = deactivate) 

$cfg['RepeatCells']         = 100;


EditInWindow

Set to TRUE if Edit link should open the query to edit in the query window (assuming Javascript is enabled), and to FALSE if we should edit in the right panel 

$cfg['EditInWindow']        = TRUE;


QueryWindowWidth

Width of Query window 

$cfg['QueryWindowWidth']    = 550;


QueryWindowHeight

Height of Query window 

$cfg['QueryWindowHeight']   = 310;


QueryHistoryDB

Set to TRUE if you want DB-based query history. If FALSE, this utilizes JS-routines to display query history (lost by window close) 

$cfg['QueryHistoryDB']      = FALSE;


QueryWindowDefTab

which tab to display in the querywindow on startup (sql|files|history|full) 

$cfg['QueryWindowDefTab']   = 'sql';


QueryHistoryMax

When using DB-based query history, how many entries should be kept? 

$cfg['QueryHistoryMax']     = 25;


BrowseMIME

Use MIME-Types (stored in column comments table) for 

$cfg['BrowseMIME']          = TRUE;


MaxExactCount

When approximate count < this, PMA will get exact count for table rows. 

$cfg['MaxExactCount']       = 20000;

WYSIWYG-PDF

Utilize DHTML/JS capabilities to allow WYSIWYG editing of the PDF page editor. Requires an IE6/Mozilla based browser. 

$cfg['WYSIWYG-PDF']         = TRUE;

NaturalOrder

Sort table and database in natural order 

$cfg['NaturalOrder']        = TRUE;


Window title settings

Allows you to specify window's title bar. Following magic string can be used to get special values and order: 

@HTTP_HOST@  HTTP host that runs phpMyAdmin
@SERVER@     MySQL server name or ip
@VERBOSE@    Verbose server name as defined in server configuration
@VSERVER@    Verbose server name if set, otherwise MySQL server name or ip
@DATABASE@   Currently opened database
@TABLE@      Currently opened table
@PHPMYADMIN@ phpMyAdmin with version

TitleTable 

$cfg['TitleTable']          = '@HTTP_HOST@ / @VSERVER@ / @DATABASE@ / @TABLE@ | @PHPMYADMIN@';

TitleDatabase 

$cfg['TitleDatabase']       = '@HTTP_HOST@ / @VSERVER@ / @DATABASE@ | @PHPMYADMIN@';

TitleServer

$cfg['TitleServer']         = '@HTTP_HOST@ / @VSERVER@ | @PHPMYADMIN@';

TitleDefault 

$cfg['TitleDefault']        = '@HTTP_HOST@ | @PHPMYADMIN@';

ErrorIconic

show some icons for warning, error and information messages (true|false)? 

$cfg['ErrorIconic']          = TRUE;


MainPageIconic

show icons in list on main page and on menu tabs (true|false)? 

$cfg['MainPageIconic']       = TRUE;


ReplaceHelpImg

show help button instead of strDocu (true|false)? 

$cfg['ReplaceHelpImg']       = TRUE;


theme manager

ThemePath

using themes manager please set up here the relative path (below the phpmyadmin folder) to 'themes' else leave empty 

$cfg['ThemePath']           = './themes';

ThemeManager

if you want to use selectable themes and if ThemesPath not empty set it to true, else set it to false (default is false); 

$cfg['ThemeManager']        = TRUE;


ThemeDefault

set up default theme, if ThemePath not empty you can set up here an valid path to themes or 'original' for the original pma-theme 

$cfg['ThemeDefault']        = 'original';


ThemePerServer

allow diferent theme for each configured server 

$cfg['ThemePerServer']      = FALSE;


Default queries

%d will be replaced by the database name. %t will be replaced by the table name. %f will be replaced by a list of field names. (%t and %f only applies to DefaultQueryTable)


DefaultQueryTable

$cfg['DefaultQueryTable']    = 'SELECT * FROM %t WHERE 1';

DefaultQueryDatabase 

$cfg['DefaultQueryDatabase'] = '';


SQL Query box settings

These are the links displayed in all of the SQL Query boxes.

Edit

Whether to display an edit link to change a query in any SQL Query box. 

$cfg['SQLQuery']['Edit'] = TRUE;

Explain

Whether to display a link to EXPLAIN a SELECT query in any SQL Query box. 

$cfg['SQLQuery']['Explain'] = TRUE;

ShowAsPHP

Whether to display a link to wrap a query in PHP code in any SQL Query box. 

$cfg['SQLQuery']['ShowAsPHP'] = TRUE;

Validate

Whether to display a link to validate a query in any SQL Query box. See $cfg['SQLValidator'] as well. 

$cfg['SQLQuery']['Validate'] = FALSE;

Refresh

Whether to display a link to refresh a query in any SQL Query box. 

$cfg['SQLQuery']['Refresh'] = TRUE;

Webserver upload/save/import directories

UploadDir

Directory where SQL files can be uploaded by means other than phpMyAdmin (for example with FTP). This allows file import even if file uploads are disabled in php.ini. For example './upload'. Leave empty for no upload directory support. Use %u for username inclusion. Note: the dropdown file select field is only shown after a file was successfully uploaded. 

$cfg['UploadDir'] = '';

SaveDir

Directory where phpMyAdmin can save exported data on server. For example './save'. Leave empty for no save directory support. Use %u for username inclusion. 

$cfg['SaveDir'] = '';

docSQLDir

Directory for docSQL imports, phpMyAdmin can import docSQL files from that directory. For example './docSQL'. Leave empty for no docSQL import support. 

$cfg['docSQLDir'] = '';

TempDir

Directory where phpMyAdmin can save temporary files. This is needed for MS Excel export, see documentation how to enable that. 

$cfg['TempDir'] = '';

Misc. settings