pipeline.src.db_config
======================

.. py:module:: pipeline.src.db_config


Attributes
----------

.. autoapisummary::

   pipeline.src.db_config.db_env


Functions
---------

.. autoapisummary::

   pipeline.src.db_config.make_connection_string
   pipeline.src.db_config.create_engine
   pipeline.src.db_config.create_datawarehouse_client


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

.. py:data:: db_env

.. py:function:: make_connection_string(db: str) -> str

   Returns the connection string for the designated database.

   :param db: Database name. Possible values :
              'ocan', 'fmc', 'monitorfish_remote', 'monistorfish_local',
              'monitorenv_remote', 'cacem_local'
   :type db: str

   :returns: connection string for selected database.
   :rtype: str

   :raises ValueError: with credentials for the selected database are not found in
   :raises environment variables.:


.. py:function:: create_engine(db: str, **kwargs) -> sqlalchemy.engine.Engine

   Returns sqlalchemy engine for designated database.

   :param db: Database name. Possible values :
              'ocan', 'fmc', 'monitorfish_remote', 'monistorfish_local',
              'monitorenv_remote', 'cacem_local'
   :type db: str

   :returns: sqlalchemy engine for selected database.
   :rtype: sa.engine.Engine


.. py:function:: create_datawarehouse_client() -> clickhouse_connect.driver.httpclient.HttpClient

   Returns clickhouse client for data_warehouse database.

   :returns: clickhouse client for data_warehouse.
   :rtype: HttpClient