prefect.server.models.flow_run_states

Functions for interacting with flow run state ORM objects. Intended for internal use by the Prefect REST API.

Functions

read_flow_run_state

read_flow_run_state(db: PrefectDBInterface, session: AsyncSession, flow_run_state_id: UUID) -> Union[orm_models.FlowRunState, None]
Reads a flow run state by id. Args:
  • session: A database session
  • flow_run_state_id: a flow run state id
Returns:
  • orm_models.FlowRunState: the flow state

read_flow_run_states

read_flow_run_states(db: PrefectDBInterface, session: AsyncSession, flow_run_id: UUID) -> Sequence[orm_models.FlowRunState]
Reads flow runs states for a flow run. Args:
  • session: A database session
  • flow_run_id: the flow run id
Returns:
  • List[orm_models.FlowRunState]: the flow run states

delete_flow_run_state

delete_flow_run_state(db: PrefectDBInterface, session: AsyncSession, flow_run_state_id: UUID) -> bool
Delete a flow run state by id. Args:
  • session: A database session
  • flow_run_state_id: a flow run state id
Returns:
  • whether or not the flow run state was deleted