Child pages
  • cPanel API 1 Functions - Mysql::updateprivs

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function updates a database user's privileges.

Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$update_privs = $cpanel->api1('Mysql','updateprivs', array('example_user1','example_database') ); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $update_privs = $cpliveapi->api1('Mysql','updateprivs', ['example_user1','example_database'] ); # Call the function.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Mysql::updateprivs($FORM('dbuser','db')">



Expand
titleCommand Line


Code Block
languagebash
cpapi1 --user=username Mysql updateprivs dbuser=example_user1 db=example_database

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (plaintext)


Code Block
linenumberstrue
{
   "func" : "updateprivs",
   "event" : {
      "result" : 1
   },
   "data" : {
      "result" : ""
   },
   "module" : "Mysql",
   "type" : "event",
   "apiversion" : "1",
   "source" : "module"
}




Parameters

ParameterTypeDescriptionPossible valuesExample
dbuserstring

Required

The database user's name.

A valid username.
example_user1
dbstring

Required

The database's name.

A valid database name.example_database

Returns

This function returns a list of updated user privileges on the database.