You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

Child pages
  • UAPI Functions - Mysql::get_restrictions
Skip to end of metadata
Go to start of metadata

Description

This function lists a MySQL® database's name, username length restrictions, and database prefix.

Important:

In cPanel & WHM version 76 and later, when you disable the MySQL/MariaDB role and remote MySQL is not already configured, the system disables this function.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Mysql/get_restrictions


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 current MySQL database restrictions.
$get_db_restrictions = $cpanel->uapi(
    'Mysql', 'get_restrictions'
);


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 current MySQL database restrictions.
my $get_db_restrictions = $cpliveapi->uapi(
    'Mysql', 'get_restrictions',
);


Note:

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

 Command Line
uapi --user=username Mysql get_restrictions 


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)
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":{  
      "max_database_name_length":64,
      "max_username_length":16,
      "prefix":"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

ReturnTypeDescriptionPossible valuesExample
max_database_name_lengthinteger

The maximum length of a MySQL database name.

A positive integer that represents the number of characters that a MySQL database name can contain.

64
max_username_lengthintegerThe maximum length of a MySQL database user's name.A positive integer that represents the number of characters that a MySQL database user's name can contain.16
prefixstringThe account's database prefix, if database prefixing is enabled.
  • If database prefixing is enabled, a string of up to the first eight characters of the cPanel account username, and an underscore (_).
  • If database prefixing is disabled, this return's value displays as undefined.
user_