app.api.dal
===========

.. py:module:: app.api.dal

.. autoapi-nested-parse::

   Data Access Layer (DAL).



Functions
---------

.. autoapisummary::

   app.api.dal.add_patient
   app.api.dal.get_patient
   app.api.dal.get_all_patients
   app.api.dal.delete_patient
   app.api.dal.update_patient


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

.. py:function:: add_patient(payload: scanhub_libraries.models.BasePatient) -> app.api.db.Patient
   :async:


   Create a new patient entry in database.

   Parameters
   ----------
   payload
       Patient pydantic base model

   Returns
   -------
       Patient database entry


.. py:function:: get_patient(patient_id: uuid.UUID) -> app.api.db.Patient | None
   :async:


   Fetch a patient from database.

   Parameters
   ----------
   patient_id
       Id of the requested patient

   Returns
   -------
       Patient database entry


.. py:function:: get_all_patients() -> list[app.api.db.Patient]
   :async:


   Get a list of all existing patients.

   Returns
   -------
       List of database orm models


.. py:function:: delete_patient(patient_id: uuid.UUID) -> bool
   :async:


   Delete patient entry from database.

   Parameters
   ----------
   patient_id
       Id of the patient to be deleted

   Returns
   -------
       Delete success


.. py:function:: update_patient(patient_id: uuid.UUID, payload: scanhub_libraries.models.BasePatient) -> app.api.db.Patient | None
   :async:


   Update existing patient in database.

   Parameters
   ----------
   patient_id
       Id of the patient to be updated

   Returns
   -------
       Updated database entry