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
async
¶
Delete a flow run state by id.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session |
Session
|
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 /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/flow_run_states.py
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
|
read_flow_run_state
async
¶
Reads a flow run state by id.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session |
Session
|
A database session |
required |
flow_run_state_id |
UUID
|
a flow run state id |
required |
Returns:
Type | Description |
---|---|
db.FlowRunState: the flow state |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/flow_run_states.py
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
|
read_flow_run_states
async
¶
Reads flow runs states for a flow run.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session |
Session
|
A database session |
required |
flow_run_id |
UUID
|
the flow run id |
required |
Returns:
Type | Description |
---|---|
List[db.FlowRunState]: the flow run states |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/flow_run_states.py
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
|