cPanel API 1 Functions - Postgres::adddb - Knowledgebase

Description

This function adds a PostgreSQL® database.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — Postgresql::create_database —
Error rendering macro 'excerpt-include' : No link could be created for 'UAPI Functions - Postgresql::create_database'.
cPanel API 2 — None.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

$add_postgresdb = $cpanel->api1('Postgres','adddb', array('cpusername_dbname') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

my $add_postgresdb = $cpliveapi->api1('Postgres','adddb', ['cpusername_dbname'] ); # Call the function.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Postgres::adduser($FORM('dbname'))">

Output (none)

This function does not return output.

Parameters

Parameter	Type	Description	Possible values	Example
dbname	string	Required The database name.	The cPanel account username, an underscore (_), and the database name. Warnings The maximum length of the database name is 63 bytes. If the total length of the parameter exceeds the limit for database usernames, the function will fail.	cpusername_dbname

Parameter

Type

Description

Possible values

Example

dbname

string

Required

The database name.

The cPanel account username, an underscore (_), and the database name.

Warnings

The maximum length of the database name is 63 bytes.
If the total length of the parameter exceeds the limit for database usernames, the function will fail.

cpusername_dbname

Returns

This function does not return output.

Knowledgebase

Categories

Categories