cPanel API 1 Functions - Mysql::adddb - Knowledgebase

Description

This function creates a MySQL® 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) — Mysql::create_database — This function creates a MySQL® database.
cPanel API 2 — MysqlFE::createdb — This function creates a database.

Examples

LiveAPI PHP Class

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

$add_db = $cpanel->api1('Mysql','adddb', array('database') ); // Call the function.

LiveAPI Perl Module

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

my $add_db = $cpliveapi->api1('Mysql','adddb', ['database'] ); # 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="Mysql::adddb( $FORM('dbname'))">

Output (none)

This function does not return output.

Parameters

Parameter	Type	Description	Possible values	Example
dbname	string	Required The MySQL database name.	A valid database name. If database prefixing is enabled and this parameter does not begin with the prefix, the function will automatically add it. Warning The maximum length of the database name is 64 characters. However, due to the method that cPanel & WHM uses to store MySQL database names, each underscore character requirestwo characters of that limit. Therefore, if you enable database prefixing, the maximum length of the database name is 63 characters, which includes both the database prefix and the underscore character. Each additional underscore requires another two characters of that limit. If the total length of the username is longer than the character limit for database usernames, the function will fail.	database

Parameter

Type

Description

Possible values

Example

dbname

string

Required

The MySQL database name.

A valid database name.

If database prefixing is enabled and this parameter does not begin with the prefix, the function will automatically add it.

Warning

The maximum length of the database name is 64 characters. However, due to the method that cPanel & WHM uses to store MySQL database names, each underscore character requirestwo characters of that limit. Therefore, if you enable database prefixing, the maximum length of the database name is 63 characters, which includes both the database prefix and the underscore character. Each additional underscore requires another two characters of that limit.

If the total length of the username is longer than the character limit for database usernames, the function will fail.

database

Returns

This function does not return output.

Knowledgebase

Categories

Categories