UAPI Functions - Mysql::check_database - Knowledgebase

Description

This function checks all of the tables a MySQL® database for errors.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Mysql/check_database?name=example_test

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Check the example_test database.
$check_db = $cpanel->uapi(
    'Mysql', 'check_database',
    array(
        'name'       => 'example_test',
    )
);

 LiveAPI Perl Module

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

cPanel Template Toolkit

[% execute('Mysql', 'check_database', { name => 'example_test' } ) %]

Command Line

uapi --user=username Mysql check_database name=example_test

Notes:

You must URI-encode values.
username represents your account-level username.

 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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
name	string	Required The database's name.	A MySQL database on the cPanel account.	example_test

Parameter

Type

Description

Possible values

Example

name

string

Required

The database's name.

A MySQL database on the cPanel account.

example_test

Returns

Return	Type	Description	Possible values	Example
	array of hashes	An array that contains a response message for each of a database's table's in sequence.	An array that contains 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 unnamedarray.	A table in the database.	table1
msg_type	string	The type of message. The function returns this value in the unnamedarray.	status error info note warning	status

Knowledgebase

Categories

Categories