Controller: /siteworx/mysql/perms
=================================

:Required Permissions: MYSQL
:Required Options: MySQL Databases, MySQL Users

Action: ``add``
---------------

:Added in Version: 4.7.0-339
:Description: Add mysql permissions.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``name``
     - string
     - Yes
     - mydb
     - 
     - 
   * - ``user``
     - string
     - Yes
     - testuser
     - 
     - 
   * - ``perms``
     - 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"]
     - 
   * - ``host``
     - string
     - No*
     - 
     - %
     - 

\* indicates that it's actually required, but probably already has a valid default value.

Action: ``edit``
----------------

:Added in Version: 4.7.0-339
:Description: Edit mysql permissions.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``perms``
     - 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
     - ["CREATE","DROP","REFERENCES","ALTER","DELETE","INDEX","INSERT","SELECT","UPDATE","CREATE VIEW","SHOW VIEW","ALTER ROUTINE","CREATE ROUTINE","EXECUTE","CREATE TEMPORARY TABLES","LOCK TABLES","EVENT","TRIGGER","DELETE HISTORY"]
     - 

\* 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: ``listAvailablePerms``
------------------------------

:Added in Version: 4.7.0-339
:Description: List available MySQL permissions.

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       0 => 'SELECT',
       1 => 'INSERT',
       2 => 'UPDATE',
     ),
     'reply_code' => 205,
   )


Action: ``queryDatabaseUserPerms``
----------------------------------

:Added in Version: 4.8.0-393
:Description: Given a database, find all the db users and their permissions on that db.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``name``
     - string
     - Yes
     - mydb
     - 
     - 

Action: ``queryEdit``
---------------------

:Added in Version: 5.1.0-838
:Description: Displays the information available to the action "edit".

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       'name_copy' => 'mydb',
       'user_copy' => 'testuser',
       'perms' => 
       array (
         0 => 'CREATE',
         1 => 'DROP',
         2 => 'REFERENCES',
         3 => 'ALTER',
         4 => 'DELETE',
         5 => 'INDEX',
         6 => 'INSERT',
         7 => 'SELECT',
         8 => 'UPDATE',
         9 => 'CREATE VIEW',
         10 => 'SHOW VIEW',
         11 => 'ALTER ROUTINE',
         12 => 'CREATE ROUTINE',
         13 => 'EXECUTE',
         14 => 'CREATE TEMPORARY TABLES',
         15 => 'LOCK TABLES',
         16 => 'EVENT',
         17 => 'TRIGGER',
         18 => 'DELETE HISTORY',
       ),
       'host_copy' => '%',
       'name' => 'mydb',
       'user' => 'testuser',
       'host' => '%',
     ),
     '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
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``controller``
     - string
     - Yes
     - Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, DomainsAdvanced, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Softaculous, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout
     - 
     - 

Action: ``win``
---------------

:Added in Version: n/a
:Description: Magic function - test for testing success mechanism.