app.api.db
==========

.. py:module:: app.api.db

.. autoapi-nested-parse::

   Patient database ORM model definition.



Attributes
----------

.. autoapisummary::

   app.api.db.Base
   app.api.db.postgres_user_filepath
   app.api.db.postgres_password_filepath
   app.api.db.postgres_db_name_filepath
   app.api.db.postgres_user


Classes
-------

.. autoapisummary::

   app.api.db.Patient


Functions
---------

.. autoapisummary::

   app.api.db.init_db


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

.. py:data:: Base
   :type:  sqlalchemy.ext.declarative.DeclarativeMeta

.. py:data:: postgres_user_filepath
   :value: '/run/secrets/patient_database_postgres_user'


.. py:data:: postgres_password_filepath
   :value: '/run/secrets/patient_database_postgres_password'


.. py:data:: postgres_db_name_filepath
   :value: '/run/secrets/patient_database_postgres_db_name'


.. py:data:: postgres_user

.. py:function:: init_db() -> None

   Initialize database.


.. py:class:: Patient

   Bases: :py:obj:`Base`


   Patient ORM model.


   .. py:attribute:: __tablename__
      :value: 'patients'



   .. py:attribute:: __table_args__


   .. py:attribute:: patient_id
      :type:  sqlalchemy.orm.Mapped[uuid.UUID]


   .. py:attribute:: first_name
      :type:  sqlalchemy.orm.Mapped[str]


   .. py:attribute:: last_name
      :type:  sqlalchemy.orm.Mapped[str]


   .. py:attribute:: birth_date
      :type:  sqlalchemy.orm.Mapped[datetime.date]


   .. py:attribute:: sex
      :type:  sqlalchemy.orm.Mapped[scanhub_libraries.models.Gender]


   .. py:attribute:: height
      :type:  sqlalchemy.orm.Mapped[float]


   .. py:attribute:: weight
      :type:  sqlalchemy.orm.Mapped[float]


   .. py:attribute:: issuer
      :type:  sqlalchemy.orm.Mapped[str]


   .. py:attribute:: status
      :type:  sqlalchemy.orm.Mapped[scanhub_libraries.models.ItemStatus]


   .. py:attribute:: comment
      :type:  sqlalchemy.orm.Mapped[str]


   .. py:attribute:: datetime_created
      :type:  sqlalchemy.orm.Mapped[datetime.datetime]


   .. py:attribute:: datetime_updated
      :type:  sqlalchemy.orm.Mapped[datetime.datetime]


   .. py:method:: update(data: scanhub_libraries.models.BasePatient) -> None

      Update a patient entry.

      Parameters
      ----------
      data
          Data to be written