.. _step-MicrosoftSqlDescribe:


MicrosoftSqlDescribe
====================

Execute a Microsoft SQL SP_HELP Statement.

.. versionadded:: 1.0.0

* **Friendly name:** ``MS-SQL Describe``
* **Step class:** ``base_steps_syncpack.steps.MicrosoftSqlDescribe.MicrosoftSqlDescribe``
* **Step version:** ``1.1.0``
* **Required parameters:** ``table``, ``database``, ``host``, ``username``, ``password``, ``port``

Parameters
----------

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

   * - Name
     - Type
     - Required
     - Default
     - Description
   * - ``table``
     - string
     - yes
     - --
     - 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}``
   * - ``port``
     - number
     - yes
     - ``1433``
     - The port number to use when establishing a connection to the remote sql server.

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

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

* **Inherits from:** ``MicrosoftSqlDescribe`` -> ``BaseStep`` -> ``Serializable``
* **External packages:** ``ipaascommon``, ``ipaascore``

.. include:: /_step_notes/MicrosoftSqlDescribe.rst