Child pages
  • UAPI Functions - Mysql::check_database

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

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

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledMySQLRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


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

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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',
    )
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


Code Block
languagexml
linenumberstrue
<!-- Check the example_test database. -->
[% execute('Mysql', 'check_database', { name => 'example_test' } ) %]

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
languagetext
uapi --user=username Mysql check_database name=example_test

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "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"
      }
   ]
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


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'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 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
titleNote:

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


status