.. _step-MicrosoftSqlInsert:


MicrosoftSqlInsert
==================

Execute a Microsoft SQL Insert Statement.

.. versionadded:: 1.0.0

* **Friendly name:** ``MS-SQL Insert``
* **Step class:** ``base_steps_syncpack.steps.MicrosoftSqlInsert.MicrosoftSqlInsert``
* **Step version:** ``1.1.1``
* **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 name. Example: ``Users``
   * - ``database``
     - string
     - yes
     - --
     - The database name. Example: ``database1``
   * - ``host``
     - string
     - yes
     - --
     - The host of the database. Example: ``host1``
   * - ``username``
     - string
     - yes
     - --
     - The database username. Example: ``db_user_name``
   * - ``password``
     - string
     - yes
     - --
     - The database password. Example: ``db_user_password``
   * - ``insert_query``
     - string (long)
     - no
     - --
     - A full INSERT statement. Overrides the 'data' parameter. Example: ``INSERT INTO table_name (column1, column2) VALUES (value1, value2);``
   * - ``data``
     - json
     - no
     - --
     - The data to insert into the database table. Example: ``{'name': 'Fred Smith', 'address': '2900 Main Street'}``
   * - ``port``
     - number
     - yes
     - ``7706``
     - The port of the database. Example: ``8008``

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

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

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

.. include:: /_step_notes/MicrosoftSqlInsert.rst

API
---

.. autoclass:: base_steps_syncpack.steps.MicrosoftSqlInsert.MicrosoftSqlInsert
   :members:
   :show-inheritance: