Child pages
  • UAPI Functions - Mysql::repair_database
Skip to end of metadata
Go to start of metadata

Description

This function repairs all of the tables in a MySQL® database.

Important:

In cPanel & WHM version 76 and later, when you disable the MySQL role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Mysql/repair_database?name=example_test


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Repairs the example_test database.
$repair_db = $cpanel->uapi(
    'Mysql', 'repair_database',
    array(
        'name'       => 'example_test',
    )
);


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Repair the example_test database.
my $repair_db = $cpliveapi->uapi(
    'Mysql', 'repair_database',
    {
        'name'       => 'example_test',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Template Toolkit
<!-- Repair the example_test database. -->
[% execute('Mysql', 'repair_database', { name => 'example_test' } ) %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
--uapi --user=username Mysql repair_database name=example_test


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  
      "transformed":1
   },
   "data":[  
      {  
         "msg_text":"OK",
         "table":"table1",
         "msg_type":"status"
      },
      {  
         "msg_text":"OK",
         "table":"table2",
         "msg_type":"status"
      }
   ]
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
namestring

Required

The database's name.

A MySQL database on the cPanel account.

example_test

Returns

ReturnTypeDescriptionPossible valuesExample
 array of hashes

An array that contains a response message for each of a database's table in sequence.

An array that includes the msg_test, table, and msg_type returns.

 

msg_text

string

The message's contents.

The function returns this value in the unnamed array.

A valid string.
OK

table

string

The table's name.

The function returns this value in the unnamed array.

A table in the database.table1

msg_type

string

The type of message.

The function returns this value in the unnamed array.

  • status
  • error
  • info
  • note  
  • warning

Note:

For more information, read MySQL's REPAIR TABLE documentation.

status