Child pages
  • UAPI Functions - Mysql::get_restrictions

Versions Compared

Key

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

Description

Excerpt

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

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledMySQLRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


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

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List the current MySQL database restrictions.
$get_db_restrictions = $cpanel->uapi(
    'Mysql', 'get_restrictions'
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


Code Block
languagexml
linenumberstrue
<!-- 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 %]

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
languagetext
uapi --user=username Mysql get_restrictions 

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":{  
      "max_database_name_length":64,
      "max_username_length":16,
      "prefix":"user_"
   }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


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_