:py:mod:`config_from_pg.db`
===========================

.. py:module:: config_from_pg.db

.. autoapi-nested-parse::

   Database helper module.
   Modified from https://gist.github.com/rustprooflabs/3b8564a8e7b7fe611436b30a95b7cd17,
   adapted to psycopg 3 from psycopg2.



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


Functions
~~~~~~~~~

.. autoapisummary::

   config_from_pg.db.prepare
   config_from_pg.db.ensure_schema_exists
   config_from_pg.db.ensure_view_exists
   config_from_pg.db.select_one
   config_from_pg.db.select_multi
   config_from_pg.db.get_db_string
   config_from_pg.db.get_db_conn
   config_from_pg.db._execute_query



Attributes
~~~~~~~~~~

.. autoapisummary::

   config_from_pg.db.DB_STRING


.. py:function:: prepare()

   Ensures latest `pgconfig.settings` view exists in DB to generate config.



.. py:function:: ensure_schema_exists()

   Ensures the `pgconfig` schema exists.


.. py:function:: ensure_view_exists()

   Ensures the view `pgconfig.settings` exists.


.. py:function:: select_one(sql_raw: str, params: dict) -> dict

   Runs SELECT query that will return zero or 1 rows.

   :param sql_raw:
   :type sql_raw: str
   :param params: Params is required, can be `None` if query returns a single row
                  such as `SELECT version();`
   :type params: dict

   :returns: **data**
   :rtype: dict


.. py:function:: select_multi(sql_raw, params=None) -> list

   Runs SELECT query that will return multiple.  `params` is optional.

   :param sql_raw:
   :type sql_raw: str
   :param params: Params is optional, defaults to `None`.
   :type params: dict

   :returns: **data** -- List of dictionaries.
   :rtype: list


.. py:function:: get_db_string() -> str

   Prompts user for details to create connection string

   :returns: **database_string**
   :rtype: str


.. py:data:: DB_STRING

   

.. py:function:: get_db_conn()

   Uses DB_STRING to establish psycopg connection.


.. py:function:: _execute_query(sql_raw, params, qry_type)

   Handles executing all types of queries based on the `qry_type` passed in.
   Returns False if there are errors during connection or execution.
       if results == False:
           print('Database error')
       else:
           print(results)
   You cannot use `if not results:` b/c 0 results is a false negative.