pipeline.src.flows.missions
===========================

.. py:module:: pipeline.src.flows.missions


Functions
---------

.. autoapisummary::

   pipeline.src.flows.missions.extract_missions
   pipeline.src.flows.missions.extract_missions_control_units
   pipeline.src.flows.missions.filter_missions_control_units
   pipeline.src.flows.missions.load_missions_and_missions_control_units
   pipeline.src.flows.missions.missions_flow


Module Contents
---------------

.. py:function:: extract_missions(number_of_months: int) -> pandas.DataFrame

   Extracts missions data from Monitorenv database for the specified number of months.

   :param number_of_months: number of months of controls data to extract, going
                            backwards from the present.
   :type number_of_months: int

   :raises ValueError: if `number_of_months` is not of type `int`
   :raises ValueError: if `number_of_months` is not between 1 and 240

   :returns: DataFrame with missions data.
   :rtype: pd.DataFrame


.. py:function:: extract_missions_control_units() -> pandas.DataFrame

   Extracts all `missions_control_units` data from the Monitorenv database.

   :returns: DataFrame of `missions_control_units`.
   :rtype: pd.DataFrame


.. py:function:: filter_missions_control_units(missions: pandas.DataFrame, missions_control_units: pandas.DataFrame) -> pandas.DataFrame

   Returns the subset of the input `missions_control_units` whose `mission_id` is
   present the `missions.id` Series.

   :param missions: DataFrame of missions. Must have an `id` column.
   :type missions: pd.DataFrame
   :param missions_control_units: DataFrame of missions_control_units.
                                  Must have a `mission_id` column.
   :type missions_control_units: pd.DataFrame

   :returns: Filtered `missions_control_units`.
   :rtype: pd.DataFrame


.. py:function:: load_missions_and_missions_control_units(missions: pandas.DataFrame, missions_control_units: pandas.DataFrame, analytics_missions_table: sqlalchemy.Table, analytics_missions_control_units_table: sqlalchemy.Table)

   Truncates tables and populates them with data from input DataFrames.


.. py:function:: missions_flow(number_of_months: int, extract_missions_fn=extract_missions, extract_missions_control_units_fn=extract_missions_control_units)