Child pages
  • UAPI Function - Mysql::list_databases
Skip to end of metadata
Go to start of metadata

Description

This function lists an account's MySQL® databases.

Important:

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/list_databases


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.
 
// List the databases on the account.
$list_databases = $cpanel->uapi(
    'Mysql', 'list_databases'
);


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.
 
# List the databases on the account.
my $list_databases = $cpliveapi->uapi(
    'Mysql', 'list_databases'
);


Note:

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

 Command Line
uapi --user=username Mysql list_databases


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)
{  
   "errors":null,
   "metadata":{  
      "transformed":1
   },
   "warnings":null,
   "status":1,
   "messages":null,
   "data":[  
      {  
         "users":[  

         ],
         "disk_usage":673 , 
         "database":"user_db"
      },
      {  
         "disk_usage"0,
         "database":"user_db2",
         "users":[  
            "db2_user"
         ]
      },
     }
   ]
}


Note:

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

Parameters

This function does not accept parameters.

Returns

Return TypeDescriptionPossible valuesExample
data array of hashesAn array of hashes that contains database information.Each hash contains the database and disk_usage returns and the users array.

database

string

The database name.

The function returns this value in the data array of hashes.

A valid database name.user_db

disk_usage

integer

The disk space that the database uses, in bytes.

The function returns this value in the data array of hashes.

An integer value.673

users

array

An array of database usernames.

Note:

If no users exist on a database, the function returns an empty array

The function returns this value in the data  array of hashes.

A valid database username.db_user