Controller: /siteworx/mysql/db¶
- Required Permissions
MYSQL
- Required Options
MySQL Databases
Action: add
¶
- Added in Version
4.7.0-339
- Description
Add a mysql database.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
|||
|
integer |
No |
1 |
||
|
string |
No |
|||
|
string |
No |
|||
|
string |
No |
Confirm the password field by providing it again. Must match the password provided. |
||
|
struct (string) |
No |
SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EXECUTE, EVENT, TRIGGER, DELETE HISTORY |
[“SELECT”,”INSERT”,”UPDATE”,”DELETE”,”CREATE”,”DROP”,”REFERENCES”,”INDEX”,”ALTER”,”CREATE TEMPORARY TABLES”,”LOCK TABLES”,”CREATE VIEW”,”SHOW VIEW”,”CREATE ROUTINE”,”ALTER ROUTINE”,”EXECUTE”,”EVENT”,”TRIGGER”,”DELETE HISTORY”] |
|
|
string |
No |
% |
Action: addSqlFile
¶
- Added in Version
7.9.3-1969
- Description
Add a mysql database from dump.sql file.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
Provide the path to the MySQL dump file or browse for the Mysql dump file on your local computer. |
||
|
string |
Yes |
Provide the database name the dump should be imported as. |
Action: delete
¶
- Added in Version
4.7.0-339
- Description
Delete a mysql database.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
Yes |
mydb |
||
|
struct (integer) |
No* |
1 |
* indicates that it’s actually required, but probably already has a valid default value.
Action: fail
¶
- Added in Version
n/a
- Description
Magic function - test for failure mechanism.
Action: list
¶
- Added in Version
4.7.0-339
- Description
List MySQL databases.
Warning
This action has been deprecated as of version 4.8.0-393. 2010-12-03 use listDatabases
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
0 => 'mydb',
1 => 'example_mydb',
),
),
'reply_code' => 205,
)
Action: listMysqlDatabases
¶
- Added in Version
4.8.0-393
- Description
List MySQL Databases.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'name' => 'mydb',
'fqdn' => 'example_mydb',
'host' => '192.168.0.1',
'storage' => 0,
),
),
'reply_code' => 205,
)
Action: listMysqlHost
¶
- Added in Version
4.7.0-339
- Description
List the mysql host for this account (localhost, 22.33.44.55, etc).
Sample Output¶
array (
'status' => 0,
'payload' => '192.168.0.1',
'reply_code' => 205,
)
Action: reroute
¶
- Added in Version
n/a
- Description
Action to re-route from the current controller to a different one.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, EmailMailman, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Softaculous, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpamprefs, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout |
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.