Description

This function retrieves the PostgreSQL® user and database name length restrictions.

Examples 




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



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Retrieve the PostgreSQL user and database name length restrictions.
$get_restrictions = $cpanel->uapi(
    'Postgresql', 'get_restrictions'
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
#  Retrieve the PostgreSQL user and database name length restrictions.
my $get_restrictions = $cpliveapi->uapi(
    'Postgresql', 'get_restrictions',
);

 



<!--  Retrieve the PostgreSQL user and database name length restrictions. -->
[% data = execute( 'Postgresql', 'get_restrictions'); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %] 

 



uapi --user=username Postgresql get_restrictions



{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": {
    "max_database_name_length": 63,
    "max_username_length": 63,
    "prefix": "example_"
  }
}



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
prefixstringIf database prefixing is enabled, this return outputs the database prefix.A valid string up to eight characters and an underscore (_).
example_
max_database_name_lengthintegerThe maximum length of a database name.A positive integer.63
max_username_lengthintegerThe maximum length of a database username.A positive integer.63