.. _odahelper:

Script Helper Module
====================

The Script Helper module provides simple functions for scripting use cases to interact directly with the ODA database,
defining the simplest interface a user needs to perform the action without having to create a UnitOfWork directly.

Execution Blocks
-----------------

Generally, it is expected that the ``create_eb`` function will be called at the start of a session, and function calls
where the request/response should be stored in the ExecutionBlock should be decorated with ``@capture_request_response``.
For more context on Execution Blocks, see the `section in the Scripting documentation <https://developer.skao.int/projects/ska-oso-scripting/en/latest/execution_blocks.html>`_

To view the ExecutionBlock in the ODA, the ODA CLI can be used perform queries (see :ref:`CLI`). Alternatively, the ODA REST API could be used directly.

Module Functions
-----------------

.. automodule:: ska_db_oda.script_helper
   :members: