Validate MySQL database integrity

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

Important:

When you disable the MySQL role and remote MySQL is not already configured, the system disables this function.

Authorizations:
query Parameters
name
required
string

The database's name.

Example: name=example_test

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --user=username Mysql check_database name='example_test'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "check_database",
  • "module": "Mysql",
  • "result": {
    • "data": [
      • {
        • "msg_text": "OK",
        • "msg_type": "status",
        • "table": "table1"
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}