Page tree
Skip to end of metadata
Go to start of metadata

 

Description

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

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Postgresql/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.
 
// Retrieve the PostgreSQL user and database name length restrictions.
$get_restrictions = $cpanel->uapi(
    'Postgresql', '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.
 
#  Retrieve the PostgreSQL user and database name length restrictions.
my $get_restrictions = $cpliveapi->uapi(
    'Postgresql', 'get_restrictions',
);

Note:

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

 

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

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Postgresql 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. 
  • We introduced this functionality in cPanel & WHM version 56.

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


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