.. _step-MySqlDelete:


MySqlDelete
===========

Execute a MySQL DELETE statement.

.. versionadded:: 1.0.0

* **Friendly name:** ``MySQL Delete``
* **Step class:** ``base_steps_syncpack.steps.MySqlDelete.MySqlDelete``
* **Step version:** ``1.0.0``
* **Required parameters:** ``database``, ``host``, ``port``, ``username``, ``password``

Parameters
----------

.. list-table::
   :header-rows: 1
   :widths: 22 16 8 16 38

   * - Name
     - Type
     - Required
     - Default
     - Description
   * - ``table``
     - string
     - no
     - --
     - The database table name. Example: ``Users``
   * - ``database``
     - string
     - yes
     - --
     - The database name. Example: ``database1``
   * - ``host``
     - string
     - yes
     - --
     - The host of the database. Example: ``host1``
   * - ``port``
     - number
     - yes
     - ``7706``
     - The port of the database. Example: ``8008``
   * - ``username``
     - string
     - yes
     - --
     - The database username. Example: ``db_user_name``
   * - ``password``
     - string
     - yes
     - --
     - The database password. Example: ``db_user_password``
   * - ``delete_query``
     - string (long)
     - no
     - --
     - A full DELETE statement. Overrides the 'data' parameter. Example: ``DELETE FROM table_name WHERE id=1;``
   * - ``where``
     - string (long)
     - no
     - --
     - where condition Example: ``id like '%test';``

Every step also accepts the platform parameters common to all steps --
see :ref:`platform-parameters`.

Dependencies
------------

* **Inherits from:** ``MySqlDelete`` -> ``BaseStep`` -> ``Serializable``
* **SyncPack modules:** ``base_steps_syncpack.util.mysql_utils``
* **External packages:** ``ipaascommon``, ``ipaascore``

.. include:: /_step_notes/MySqlDelete.rst