Page tree

Versions Compared

Key

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

 

Description

Excerpt

This function upgrades MySQL® or MariaDB® in the background.

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/start_background_mysql_upgrade?api.version=1&version=10.0
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/start_background_mysql_upgrade?api.version=1&version=10.0
Expand
titleCommand Line
Code Block
languagebash
whmapi1 start_background_mysql_upgrade version=10.0

Include Page
_WHMAPI1CLINote
_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "data": {
    "upgrade_id":"mysql_upgrade.20141108-172923"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "start_background_mysql_upgrade"
  }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<result>
    <data>
        <upgrade_id>mysql_upgrade.20141108-172923</upgrade_id>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>start_background_mysql_upgrade</command>
    </metadata>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

   

Parameters

ReturnTypeDescriptionPossible valuesExample
versionstring

Required

The desired MySQL or MariaDB version.

A valid version number.
10.0

Returns

ReturnTypeDescriptionPossible valuesExample
upgrade_idstring

The upgrade log's location.

A valid file path, relative to the /var/cpanel/logs/ directory.mysql_upgrade.20141108-172923