UAPI Functions - Postgresql::rename_database - Knowledgebase

Description

This function renames a PostgreSQL® database.

Examples

cPanel or Webmail Session URL

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

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

 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',
    }
);

cPanel Template Toolkit

[% data = execute( 'Postgresql', 'rename_database', { oldname => 'database', newname => 'database2'} ); %]

Command Line

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

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
      
  },
  "data": null
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
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
newname	string	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

Parameter

Type

Description

Possible values

Example

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

newname

string

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.

Knowledgebase

Categories

Categories