Manual:mysql.php


DetailsEdit

The mysql.php maintenance script executes the MySQL client binary by connecting to the wiki's database. It takes credentials from LocalSettings.php and logs in to MySQL client.

OptionsEdit

Option Description Required
--write Connect to the primary database Optional
--group Specify query group Optional
--host Connect to a specific MySQL server Optional
--list-hosts List the available database hosts Optional
--cluster Use an external cluster by name Optional
--wikidb The database wiki ID to use if not the current one Optional

UsageEdit

php maintenance/mysql.php [ --write| --group| --host| --list-hosts| --cluster| --wikidb ]

Log in to MySQL clientEdit

Terminal

List database hostsEdit

Terminal

Log in to MySQL client with clusterEdit

If you use a database cluster to run your wiki with $wgExternalServers, you can use the --cluster option to log in.

$wgExternalServers = [
	'demoCluster' => [
		[ 'host' => 'leader.example.org', 'user' => 'userM',  'password' =>'pwdM',  'dbname' => 'dbM',  'type' => "mysql", 'load' => 1 ],
		[ 'host' => 'follower1.example.org', 'user' => 'userS1', 'password' =>'pwdS1', 'dbname' => 'dbS1', 'type' => "mysql", 'load' => 1 ],
		[ 'host' => 'follower2.example.org', 'user' => 'userS2', 'password' =>'pwdS2', 'dbname' => 'dbS2', 'type' => "mysql", 'load' => 1 ]
   ]
];
Terminal

Common errorEdit

Error: invalid cluster

This error occurs when an invalid or non-existent cluster name is given to the script.

Error: this script only works with MySQL/MariaDB

This error occurs when you run the script on a wiki that uses sqlite.

See alsoEdit