Child pages
  • UAPI Functions - Postgresql::rename_database
Skip to end of metadata
Go to start of metadata

Description

This function renames a PostgreSQL® database.

Important:

In cPanel & WHM version 76 and later, when you disable the Postgres role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Postgresql/rename_database?oldname=database&newname=database2


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.
 
// Renames database "database" into "database2"
$rename_database = $cpanel->uapi(
    'Postgresql', 'rename_database',
    array(
        'oldname'  => 'database',
        'newname'  => 'database2',
         )
);


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.
 
#  Renames database "database" into "database2"
my $rename_database = $cpliveapi->uapi(
    'Postgresql', 'rename_database',
    {
        'oldname'    => 'database',
        'newname'    => 'database2',
    }
);


Note:

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

 

 cPanel Template Toolkit
<!--   Renames database "database" into "database2" -->
[% data = execute( 'Postgresql', 'rename_database', { oldname => 'database', newname => 'database2'} ); %]


Note:

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

 

 Command Line
uapi --user=username Postgresql rename_database oldname=database newname=database2


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": null
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
oldname
string

Required

The database's current name.

A valid string.

Note:

If database prefixing is enabled, this parameter must include the database prefix for the account.

database
newnamestring

Required

The database's new name.

A valid string.

Note:

If database prefixing is enabled, this parameter must include the database prefix for the account.

database2

Returns

This function only returns metadata.