server.web.routes.v3.fsm.array
==============================

.. py:module:: server.web.routes.v3.fsm.array

.. autoapi-nested-parse::

   Routes for Arrays.



Attributes
----------

.. autoapisummary::

   server.web.routes.v3.fsm.array.logger


Functions
---------

.. autoapisummary::

   server.web.routes.v3.fsm.array.add_array
   server.web.routes.v3.fsm.array.record_array_batch_num
   server.web.routes.v3.fsm.array.transition_array_to_launched
   server.web.routes.v3.fsm.array.transition_to_killed
   server.web.routes.v3.fsm.array.log_array_distributor_id
   server.web.routes.v3.fsm.array.get_array_max_concurrently_running


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

.. py:data:: logger

.. py:function:: add_array(request: fastapi.Request, db: sqlalchemy.orm.Session = Depends(get_db)) -> Any
   :async:


   Return an array ID by workflow and task template version ID.

   If not found, bind the array.


.. py:function:: record_array_batch_num(array_id: int, request: fastapi.Request, db: sqlalchemy.orm.Session = Depends(get_db)) -> Any
   :async:


   Record a batch number to associate sets of task instances with an array submission.


.. py:function:: transition_array_to_launched(array_id: int, request: fastapi.Request, db: sqlalchemy.orm.Session = Depends(get_db)) -> Any
   :async:


   Transition TIs associated with an array_id and batch_num to launched.


.. py:function:: transition_to_killed(array_id: int, request: fastapi.Request, db: sqlalchemy.orm.Session = Depends(get_db)) -> Any
   :async:


   Transition TIs from KILL_SELF to ERROR_FATAL.

   Also mark parent Tasks with status=ERROR_FATAL if they're in a killable state.


.. py:function:: log_array_distributor_id(array_id: int, request: fastapi.Request, db: sqlalchemy.orm.Session = Depends(get_db)) -> Any
   :async:


   Add distributor_id, stderr/stdout paths to the DB for all TIs in an array.


.. py:function:: get_array_max_concurrently_running(array_id: int | None = None, workflow_id: int | None = None, task_template_version_id: int | None = None, db: sqlalchemy.orm.Session = Depends(get_db)) -> Any
   :async:


   Return the maximum concurrency of this array.