.. _`Ensure columns in Tables with Table`:

.. _`org.sysess.sympathy.data.table.ensuretablecolumns`:

Ensure columns in Tables with Table
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. image:: ensure_column.svg
   :width: 48


Ensure the existence of columns in Tables by using an additional
Table with the name of the columns that must exist. Select to get
the result of the check as the form of an exception or as an added
dummy signal. The type of the dummy signal is by default float with
all elements set to NaN. Finally mask, can also be used. In that case,
a type column also needs to be selected. Otherwise it is ignored.
When mask is used, and ensured columns are missing, these will be created
as fully masked arrays of the select types.

:Ref. nodes: :ref:`Rename columns in Tables`

*Input ports*:
    :selection: table

        Selection
    :tables: [table]

        Input Tables

*Output ports*:
    :tables: [table]

        Output Table

*Configuration*:
    **Column with column names** (columns)
        Name of column with names of the columns that must exist
    **Column with column types** (types)
        Name of column with types of the columns that must exist, only for use with "Masked Signal" reporting
    **Action of missing columns:** (reporting)
        Select action if columns are missing

.. automodule:: node_ensure_columns

.. class:: EnsureColumnsOperation


Example flows
#############

* :download:`EnsureColumnsInTable.syx </_examples/Sympathy/Data Processing/Structure/EnsureColumnsInTable.syx>`