prefect.server.models.deployments
¶
Functions for interacting with deployment ORM objects. Intended for internal use by the Prefect REST API.
check_work_queues_for_deployment
async
¶
Get work queues that can pick up the specified deployment.
Work queues will pick up a deployment when all of the following are met.
- The deployment has ALL tags that the work queue has (i.e. the work queue's tags must be a subset of the deployment's tags).
- The work queue's specified deployment IDs match the deployment's ID, or the work queue does NOT have specified deployment IDs.
- The work queue's specified flow runners match the deployment's flow runner or the work queue does NOT have a specified flow runner.
Notes on the query:
- Our database currently allows either "null" and empty lists as null values in filters, so we need to catch both cases with "or".
json_contains(A, B)
should be interpreted as "True if A contains B".
Returns:
Type | Description |
---|---|
List[WorkQueue]
|
List[db.WorkQueue]: WorkQueues |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/deployments.py
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 |
|
count_deployments
async
¶
Count deployments.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session |
Session
|
A database session |
required |
flow_filter |
FlowFilter
|
only count deployments whose flows match these criteria |
None
|
flow_run_filter |
FlowRunFilter
|
only count deployments whose flow runs match these criteria |
None
|
task_run_filter |
TaskRunFilter
|
only count deployments whose task runs match these criteria |
None
|
deployment_filter |
DeploymentFilter
|
only count deployment that match these filters |
None
|
work_pool_filter |
WorkPoolFilter
|
only count deployments that match these work pool filters |
None
|
work_queue_filter |
WorkQueueFilter
|
only count deployments that match these work pool queue filters |
None
|
Returns:
Name | Type | Description |
---|---|---|
int |
int
|
the number of deployments matching filters |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/deployments.py
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
create_deployment
async
¶
Upserts a deployment.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session |
Session
|
a database session |
required |
deployment |
Deployment
|
a deployment model |
required |
Returns:
Type | Description |
---|---|
db.Deployment: the newly-created or updated deployment |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/deployments.py
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
|
delete_deployment
async
¶
Delete a deployment by id.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session |
Session
|
A database session |
required |
deployment_id |
UUID
|
a deployment id |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
whether or not the deployment was deleted |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/deployments.py
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 |
|
read_deployment
async
¶
Reads a deployment by id.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session |
Session
|
A database session |
required |
deployment_id |
UUID
|
a deployment id |
required |
Returns:
Type | Description |
---|---|
db.Deployment: the deployment |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/deployments.py
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
|
read_deployment_by_name
async
¶
Reads a deployment by name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session |
Session
|
A database session |
required |
name |
str
|
a deployment name |
required |
flow_name |
str
|
the name of the flow the deployment belongs to |
required |
Returns:
Type | Description |
---|---|
db.Deployment: the deployment |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/deployments.py
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
|
read_deployments
async
¶
Read deployments.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session |
Session
|
A database session |
required |
offset |
int
|
Query offset |
None
|
limit |
int
|
Query limit |
None
|
flow_filter |
FlowFilter
|
only select deployments whose flows match these criteria |
None
|
flow_run_filter |
FlowRunFilter
|
only select deployments whose flow runs match these criteria |
None
|
task_run_filter |
TaskRunFilter
|
only select deployments whose task runs match these criteria |
None
|
deployment_filter |
DeploymentFilter
|
only select deployment that match these filters |
None
|
work_pool_filter |
WorkPoolFilter
|
only select deployments whose work pools match these criteria |
None
|
work_queue_filter |
WorkQueueFilter
|
only select deployments whose work pool queues match these criteria |
None
|
sort |
DeploymentSort
|
the sort criteria for selected deployments. Defaults to |
NAME_ASC
|
Returns:
Type | Description |
---|---|
List[db.Deployment]: deployments |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/deployments.py
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 |
|
schedule_runs
async
¶
Schedule flow runs for a deployment
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session |
Session
|
a database session |
required |
deployment_id |
UUID
|
the id of the deployment to schedule |
required |
start_time |
datetime
|
the time from which to start scheduling runs |
None
|
end_time |
datetime
|
runs will be scheduled until at most this time |
None
|
min_time |
timedelta
|
runs will be scheduled until at least this far in the future |
None
|
min_runs |
int
|
a minimum amount of runs to schedule |
None
|
max_runs |
int
|
a maximum amount of runs to schedule |
None
|
This function will generate the minimum number of runs that satisfy the min and max times, and the min and max counts. Specifically, the following order will be respected.
- Runs will be generated starting on or after the `start_time`
- No more than `max_runs` runs will be generated
- No runs will be generated after `end_time` is reached
- At least `min_runs` runs will be generated
- Runs will be generated until at least `start_time` + `min_time` is reached
Returns:
Type | Description |
---|---|
List[UUID]
|
a list of flow run ids scheduled for the deployment |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/deployments.py
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 |
|
update_deployment
async
¶
Updates a deployment.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session |
Session
|
a database session |
required |
deployment_id |
UUID
|
the ID of the deployment to modify |
required |
deployment |
DeploymentUpdate
|
changes to a deployment model |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
whether the deployment was updated |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/deployments.py
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
|