.. _step-MySqlSelect:


MySqlSelect
===========

Execute a MySQL SELECT Statement.

.. versionadded:: 1.0.0

* **Friendly name:** ``MySQL Select``
* **Step class:** ``base_steps_syncpack.steps.MySqlSelect.MySqlSelect``
* **Step version:** ``1.1.3``
* **Required parameters:** ``database``, ``host``, ``username``, ``password``, ``port``

Parameters
----------

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

   * - Name
     - Type
     - Required
     - Default
     - Description
   * - ``table``
     - string
     - no
     - --
     - The database Table Example: ``Users``
   * - ``database``
     - string
     - yes
     - --
     - The database Example: ``database1``
   * - ``host``
     - string
     - yes
     - --
     - The host of the database Example: ``host1``
   * - ``username``
     - string
     - yes
     - --
     - The db username Example: ``${db_user_name}``
   * - ``password``
     - string
     - yes
     - --
     - The db password Example: ``${db_password}``
   * - ``select_query``
     - string (long)
     - no
     - --
     - A full SELECT statement. Overrides the 'fields' statement. Example: ``SELECT COUNT(*) FROM XYZ``
   * - ``fields``
     - array of strings
     - no
     - ``*``
     - Which fields to select. Example: ``['field1', 'field2']``
   * - ``port``
     - number
     - yes
     - ``7706``
     - The port number to use when establishing a connection to the remote mysql server.

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

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

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

.. include:: /_step_notes/MySqlSelect.rst