Software Development Kit
cPanel & WHM's API [+] cPanel & WHM's API [-]Modules and Plugins [+] Modules and Plugins [-]
cPanel Modules
Writing cPanel Modules PHP Accounting Module cPanel::Accounting Perl Module Writing cPanel Plugins
Writing cPanel Plugins PHP in cPanel Plugin Interfaces cPanel CGI Scripts Live PHP in cPanel Plugins Plugin Variables Installing cPanel Plugins Adding Icons and Groups Plugin Installation File Generator Plugin Security Policy (
.pdf)
WHM Plugins
Creating WHM Plugins ACL Reference Table The swapip Utility cPanel Logger Module Pluggable dnsadmin Modules EasyApache Modules
Custom Modules?
cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]
Standardized Hooks Introduction Taxonomy Getting Started Hooks Management Interface Hookable Events Advanced Usage Troubleshooting
Legacy Hooks Introduction Writing Function Hooks Script Hooks Custom Event Handlers cPanel Logger Module Universal Password Trap Hooking into EasyApache
EasyApache Hooks?
cPAddons (Site Software) [+] cPAddons (Site Software) [-]
System Administration [+] System Administration [-]
Developer Software [+] Developer Software [-]
Back to All Documentation
MysqlFE Module Documentation
The MysqlFE module allows you to access information about an account's MySQL users, databases, and permissions. The functions within this module may or may not be governed by a feature list. The required feature list may vary from function to function, to review a total list of the available features sets on a cPanel server, please see "Feature Manager" in WHM.MysqlFE::userdbprivs
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve a list of permissions that correspond to a specific user and database. |
| Parameters: | |
| db (string) | |
| The database that corresponds to the user whose permissions you wish to view. | |
| user (string) | |
| The user whose permissions you wish to view. | |
| Returns: | |
<data> <CREATEROUTINE> A boolean value that indicates whether or not a user can create a routine. '1' if the user has the permission. '0' if the user does not.</CREATEROUTINE> <DROP> A boolean value that indicates whether or not a user can drop something from the database. '1' if the user has the permission. '0' if the user does not.</DROP> <DELETE> A boolean value that indicates whether or not a user can delete a table. '1' if the user has the permission. '0' if the user does not.</DELETE> <REFERENCES> A boolean value that indicates whether or not a user can reference a database or table. '1' if the user has the permission. '0' if the user does not.</REFERENCES> <UPDATE> A boolean value that indicates whether or not a user can update a table. '1' if the user has the permission. '0' if the user does not.</UPDATE> <ALTER> A boolean value that indicates whether or not a user can alter a table with the 'ALTER TABLE' command. '1' if the user has the permission. '0' if the user does not.</ALTER> <CREATETEMPORARYTABLES> A boolean value that indicates whether or not a user can create temporary tables. '1' if the user has the permission. '0' if the user does not.</CREATETEMPORARYTABLES> <INDEX> A boolean value that indicates whether or not a user can create or remove indexes for tables. '1' if the user has the permission. '0' if the user does not.</INDEX> <CREATE> A boolean value that indicates whether or not a user can make a new database, table or index. '1' if the user has the permission. '0' if the user does not.</CREATE> <LOCKTABLES> A boolean value that indicates whether or not a user can lock tables. '1' if the user has the permission. '0' if the user does not.</LOCKTABLES> <SELECT> A boolean value that indicates whether or not a user can select tables. '1' if the user has the permission. '0' if the user does not.</SELECT> <INSERT> A boolean value that indicates whether or not a user can create tables. '1' if the user has the permission. '0' if the user does not.</INSERT> </data> |
MysqlFE::listdbs
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve a list of databases that belong to a specific account. |
| Parameters: | |
| regex (Regular Expression (optional)) | |
| This parameter allows you to filter based on a regular expression or string matching the db field. | |
| Returns: | |
<data> <userlist> <db> A string value that contains the name of the database. (e.g. cpuser_dbname)</db> <user> A string value that contains the database's username. (e.g. cpuser_dbuser)</user> </userlist> <sizemeg> An integer value that contains the size of the database in megabytes.</sizemeg> <db> A string value that contains the name of the database. (cpuser_dbname)</db> <usercount> An integer value that contains the number of users associated with the database.</usercount> <size> An integer value that contains the size of the database in bytes.</size> </data> |
MysqlFE::listdbsbackup
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve a list of existing database backups. |
| Returns: | |
<data> <db> The name of the database to which the backup belongs. (e.g. cpuser_dbname)</db> <strippeddb> A stripped down version of the database's name that does not contain the user portion of the name. (e.g. dbname)</strippeddb> </data> |
MysqlFE::listusersindb
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | List users who can access a particular database. |
| Parameters: | |
| db (string) | |
| The name of the database whose users you wish to view. Be sure to use the cPanel convention's full MySQL database name. (e.g. cpaneluser_dbname). | |
| Returns: | |
<data> <db> A string value that contains the name of the database. (e.g. cpaneluser_dbname)</db> <user> A string value that contains the name of the database user. (e.g. cpaneluser_dbusername)</user> </data> |
MysqlFE::listhosts
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve a list of remote MySQL connection hosts. |
| Returns: | |
<data> <uri_host> A URI encoded version of the remote host.</uri_host> <host> The IP address of the remote host. (e.g. 127.0.0.1)</host> </data> |
MysqlFE::listusers
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | List all of the MySQL users available to a cPanel account. |
| Returns: | |
<data> <dblist> <db> A string value that contains the name of the database. (e.g. cpuser_dbname)</db> <user> A string value that contains the user associated with the database. (e.g. cpuser_dbname)</user> </dblist> <shortuser> A string value that contains a stripped down version of the username that does not contain the cPanel user portion of the name. (e.g. dbuser)</shortuser> <user> A string value that contains the name of the username. (e.g. cpuser_dbuser)</user> </data> |
Edit | Attach | Print version | History: r2 < r1 | Backlinks | Raw View | More topic actions
Topic revision: r2 - 26 Mar 2012 - 16:14:15 - Main.JenniferDoubrava