UAPI Functions - Mysql::get_restrictions - Knowledgebase

Description

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

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Mysql/get_restrictions

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'

);

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',

);

 cPanel Template Toolkit

<!-- Get a hash of all the data, then display the prefix value. -->
[% data = execute( 'Mysql', 'get_restrictions' ); %]
[% FOREACH q = data.prefix %]
     <p>
         [% q %]
     </p>
[% END %]
  
<!-- Get only a hash of the data. -->
[% execute('Mysql', 'get_restrictions' ).data.prefix %]

Command Line

uapi --user=username Mysql get_restrictions

Notes:

You must URI-encode values.
username represents your account-level username.

 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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
max_database_name_length	integer	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_length	integer	The 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
prefix	string	The 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_

Knowledgebase

Categories

Categories