Description

This function renames a MySQL® database.


It is potentially dangerous to rename a MySQL database. We strongly recommend that you perform a backup of the database before you attempt to rename it. 

Examples 




https://hostname.example.com:2083/cpsess##########/execute/Mysql/rename_database?oldname=mydb&newname=newlyrenamed



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Rename the mydb database.
$rename_db = $cpanel->uapi(
    'Mysql', 'rename_database',
    array(
        'oldname'       => 'mydb',
        'newname'       => 'newlyrenamed',
    )
);



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Rename the mydb database.
my $rename_db = $cpliveapi->uapi(
    'Mysql', 'rename_database',
    {
        'oldname'       => 'mydb',
        'newname'       => 'newlyrenamed',
    }
);



<!-- Rename the database. -->
[% execute('Mysql', 'rename_database', { oldname => 'mydb', newname => 'newlyrenamed' } ) %]



uapi --user=username Mysql rename_database oldname=mydb newname=newlyrenamed



{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": null
}



Parameters

ParameterTypeDescriptionPossible valuesExample
oldnamestring

Required

The database's current name.

A database on the cPanel account.

mydb
newnamestring

Required

The database's new name.

A valid database name.

  • If database prefixing is enabled, you must prefix this value with the account prefix and an underscore (_). For example, for the dbuser database on the user cPanel account, pass in a value of user_dbuser.
  • The maximum length of the database name is 64 characters. However, due to the method that cPanel & WHM uses to store MySQL database names, each underscore character requires two characters of that limit. Therefore, if you enable database prefixing, the maximum length of the database name is 63 characters, which includes both the database prefix and the underscore character. Each additional underscore requires another two characters of that limit.


newlyrenamed

Returns

This function only returns metadata.