Skip to content

prefect.server.models.flow_run_states

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

delete_flow_run_state(session, flow_run_state_id) async

Delete a flow run state by id.

Parameters:

Name Type Description Default
session AsyncSession

A database session

 required
flow_run_state_id UUID

a flow run state id

 required

Returns:

Name Type Description
bool bool

whether or not the flow run state was deleted
Source code in src/prefect/server/models/flow_run_states.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
async def delete_flow_run_state(
    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:
        bool: whether or not the flow run state was deleted
    """

    result = await session.execute(
        delete(orm_models.FlowRunState).where(
            orm_models.FlowRunState.id == flow_run_state_id
        )
    )
    return result.rowcount > 0

read_flow_run_state(session, flow_run_state_id) async

Reads a flow run state by id.

Parameters:

Name Type Description Default
session AsyncSession

A database session

 required
flow_run_state_id UUID

a flow run state id

 required

Returns:

Type Description
Union[FlowRunState, None]

orm_models.FlowRunState: the flow state
Source code in src/prefect/server/models/flow_run_states.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
async def read_flow_run_state(
    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
    """

    return await session.get(orm_models.FlowRunState, flow_run_state_id)

read_flow_run_states(session, flow_run_id) async

Reads flow runs states for a flow run.

Parameters:

Name Type Description Default
session AsyncSession

A database session

 required
flow_run_id UUID

the flow run id

 required

Returns:

Type Description
Sequence[FlowRunState]

List[orm_models.FlowRunState]: the flow run states
Source code in src/prefect/server/models/flow_run_states.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
async def read_flow_run_states(
    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
    """

    query = (
        select(orm_models.FlowRunState)
        .filter_by(flow_run_id=flow_run_id)
        .order_by(orm_models.FlowRunState.timestamp)
    )
    result = await session.execute(query)
    return result.scalars().unique().all()