prefect_dbt.cloud.jobs
¶
Module containing tasks and flows for interacting with dbt Cloud jobs
DbtCloudJob
¶
Bases: JobBlock
Block that holds the information and methods to interact with a dbt Cloud job.
Attributes:
Name | Type | Description |
---|---|---|
dbt_cloud_credentials |
DbtCloudCredentials
|
The credentials to use to authenticate with dbt Cloud. |
job_id |
int
|
The id of the dbt Cloud job. |
timeout_seconds |
int
|
The number of seconds to wait for the job to complete. |
interval_seconds |
int
|
The number of seconds to wait between polling for job completion. |
trigger_job_run_options |
TriggerJobRunOptions
|
The options to use when triggering a job run. |
Examples:
Load a configured dbt Cloud job block.
from prefect_dbt.cloud import DbtCloudJob
dbt_cloud_job = DbtCloudJob.load("BLOCK_NAME")
Triggers a dbt Cloud job, waits for completion, and fetches the results.
from prefect import flow
from prefect_dbt.cloud import DbtCloudCredentials, DbtCloudJob
@flow
def dbt_cloud_job_flow():
dbt_cloud_credentials = DbtCloudCredentials.load("dbt-token")
dbt_cloud_job = DbtCloudJob.load(
dbt_cloud_credentials=dbt_cloud_credentials,
job_id=154217
)
dbt_cloud_job_run = dbt_cloud_job.trigger()
dbt_cloud_job_run.wait_for_completion()
dbt_cloud_job_run.fetch_result()
return dbt_cloud_job_run
dbt_cloud_job_flow()
Source code in prefect_dbt/cloud/jobs.py
971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 |
|
get_job
async
¶
Retrieve information about a dbt Cloud job.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
order_by |
Optional[str]
|
The field to order the results by. |
None
|
Returns:
Type | Description |
---|---|
Dict[str, Any]
|
The job data. |
Source code in prefect_dbt/cloud/jobs.py
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 |
|
trigger
async
¶
Triggers a dbt Cloud job.
Returns:
Type | Description |
---|---|
DbtCloudJobRun
|
A representation of the dbt Cloud job run. |
Source code in prefect_dbt/cloud/jobs.py
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 |
|
DbtCloudJobRun
¶
Bases: JobRun
Class that holds the information and methods to interact with the resulting run of a dbt Cloud job.
Source code in prefect_dbt/cloud/jobs.py
642 643 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 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 |
|
fetch_result
async
¶
Gets the results from the job run. Since the results may not be ready, use wait_for_completion before calling this method.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
step |
Optional[int]
|
The index of the step in the run to query for artifacts. The first step in the run has the index 1. If the step parameter is omitted, then this method will return the artifacts compiled for the last step in the run. |
None
|
Source code in prefect_dbt/cloud/jobs.py
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 |
|
get_run
async
¶
Makes a request to the dbt Cloud API to get the run data.
Returns:
Type | Description |
---|---|
Dict[str, Any]
|
The run data. |
Source code in prefect_dbt/cloud/jobs.py
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 |
|
get_run_artifacts
async
¶
Get an artifact generated for a completed run.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
Literal['manifest.json', 'catalog.json', 'run_results.json']
|
The relative path to the run artifact. |
required |
step |
Optional[int]
|
The index of the step in the run to query for artifacts. The first step in the run has the index 1. If the step parameter is omitted, then this method will return the artifacts compiled for the last step in the run. |
None
|
Returns:
Type | Description |
---|---|
Union[Dict[str, Any], str]
|
The contents of the requested manifest. Returns a |
Source code in prefect_dbt/cloud/jobs.py
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 |
|
get_status_code
async
¶
Makes a request to the dbt Cloud API to get the run status.
Returns:
Type | Description |
---|---|
int
|
The run status code. |
Source code in prefect_dbt/cloud/jobs.py
719 720 721 722 723 724 725 726 727 728 729 |
|
retry_failed_steps
async
¶
Retries steps that did not complete successfully in a run.
Returns:
Type | Description |
---|---|
DbtCloudJobRun
|
A representation of the dbt Cloud job run. |
Source code in prefect_dbt/cloud/jobs.py
945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 |
|
wait_for_completion
async
¶
Waits for the job run to reach a terminal state.
Source code in prefect_dbt/cloud/jobs.py
731 732 733 734 735 736 737 738 739 740 741 742 |
|
get_dbt_cloud_job_info
async
¶
A task to retrieve information about a dbt Cloud job.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
dbt_cloud_credentials |
DbtCloudCredentials
|
Credentials for authenticating with dbt Cloud. |
required |
job_id |
int
|
The ID of the job to get. |
required |
Returns:
Type | Description |
---|---|
Dict
|
The job data returned by the dbt Cloud administrative API. |
Example
Get status of a dbt Cloud job:
from prefect import flow
from prefect_dbt.cloud import DbtCloudCredentials
from prefect_dbt.cloud.jobs import get_job
@flow
def get_job_flow():
credentials = DbtCloudCredentials(api_key="my_api_key", account_id=123456789)
return get_job(
dbt_cloud_credentials=credentials,
job_id=42
)
get_job_flow()
Source code in prefect_dbt/cloud/jobs.py
48 49 50 51 52 53 54 55 56 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 |
|
get_run_id
¶
Task that extracts the run ID from a trigger job run API response,
This task is mainly used to maintain dependency tracking between the
trigger_dbt_cloud_job_run
task and downstream tasks/flows that use the run ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj |
Dict
|
The JSON body from the trigger job run response. |
required |
Example
from prefect import flow
from prefect_dbt.cloud import DbtCloudCredentials
from prefect_dbt.cloud.jobs import trigger_dbt_cloud_job_run, get_run_id
@flow
def trigger_run_and_get_id():
dbt_cloud_credentials=DbtCloudCredentials(
api_key="my_api_key",
account_id=123456789
)
triggered_run_data = trigger_dbt_cloud_job_run(
dbt_cloud_credentials=dbt_cloud_credentials,
job_id=job_id,
options=trigger_job_run_options,
)
run_id = get_run_id.submit(triggered_run_data)
return run_id
trigger_run_and_get_id()
Source code in prefect_dbt/cloud/jobs.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 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
|
retry_dbt_cloud_job_run_subset_and_wait_for_completion
async
¶
Flow that retrys a subset of dbt Cloud job run, filtered by select statuses, and waits for the triggered retry to complete.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
dbt_cloud_credentials |
DbtCloudCredentials
|
Credentials for authenticating with dbt Cloud. |
required |
trigger_job_run_options |
Optional[TriggerJobRunOptions]
|
An optional TriggerJobRunOptions instance to specify overrides for the triggered job run. |
None
|
max_wait_seconds |
int
|
Maximum number of seconds to wait for job to complete |
900
|
poll_frequency_seconds |
int
|
Number of seconds to wait in between checks for run completion. |
10
|
run_id |
int
|
The ID of the job run to retry. |
required |
Raises:
Type | Description |
---|---|
ValueError
|
If |
Returns:
Type | Description |
---|---|
Dict
|
The run data returned by the dbt Cloud administrative API. |
Examples:
Retry a subset of models in a dbt Cloud job run and wait for completion:
from prefect import flow
from prefect_dbt.cloud import DbtCloudCredentials
from prefect_dbt.cloud.jobs import retry_dbt_cloud_job_run_subset_and_wait_for_completion
@flow
def retry_dbt_cloud_job_run_subset_and_wait_for_completion_flow():
credentials = DbtCloudCredentials.load("MY_BLOCK_NAME")
retry_dbt_cloud_job_run_subset_and_wait_for_completion(
dbt_cloud_credentials=credentials,
run_id=88640123,
)
retry_dbt_cloud_job_run_subset_and_wait_for_completion_flow()
Source code in prefect_dbt/cloud/jobs.py
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 |
|
run_dbt_cloud_job
async
¶
Flow that triggers and waits for a dbt Cloud job run, retrying a subset of failed nodes if necessary.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
dbt_cloud_job |
DbtCloudJob
|
Block that holds the information and methods to interact with a dbt Cloud job. |
required |
targeted_retries |
int
|
The number of times to retry failed steps. |
3
|
Examples:
from prefect import flow
from prefect_dbt.cloud import DbtCloudCredentials, DbtCloudJob
from prefect_dbt.cloud.jobs import run_dbt_cloud_job
@flow
def run_dbt_cloud_job_flow():
dbt_cloud_credentials = DbtCloudCredentials.load("dbt-token")
dbt_cloud_job = DbtCloudJob(
dbt_cloud_credentials=dbt_cloud_credentials, job_id=154217
)
return run_dbt_cloud_job(dbt_cloud_job=dbt_cloud_job)
run_dbt_cloud_job_flow()
Source code in prefect_dbt/cloud/jobs.py
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 |
|
trigger_dbt_cloud_job_run
async
¶
A task to trigger a dbt Cloud job run.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
dbt_cloud_credentials |
DbtCloudCredentials
|
Credentials for authenticating with dbt Cloud. |
required |
job_id |
int
|
The ID of the job to trigger. |
required |
options |
Optional[TriggerJobRunOptions]
|
An optional TriggerJobRunOptions instance to specify overrides for the triggered job run. |
None
|
Returns:
Type | Description |
---|---|
Dict
|
The run data returned from the dbt Cloud administrative API. |
Examples:
Trigger a dbt Cloud job run:
from prefect import flow
from prefect_dbt.cloud import DbtCloudCredentials
from prefect_dbt.cloud.jobs import trigger_dbt_cloud_job_run
@flow
def trigger_dbt_cloud_job_run_flow():
credentials = DbtCloudCredentials(api_key="my_api_key", account_id=123456789)
trigger_dbt_cloud_job_run(dbt_cloud_credentials=credentials, job_id=1)
trigger_dbt_cloud_job_run_flow()
Trigger a dbt Cloud job run with overrides:
from prefect import flow
from prefect_dbt.cloud import DbtCloudCredentials
from prefect_dbt.cloud.jobs import trigger_dbt_cloud_job_run
from prefect_dbt.cloud.models import TriggerJobRunOptions
@flow
def trigger_dbt_cloud_job_run_flow():
credentials = DbtCloudCredentials(api_key="my_api_key", account_id=123456789)
trigger_dbt_cloud_job_run(
dbt_cloud_credentials=credentials,
job_id=1,
options=TriggerJobRunOptions(
git_branch="staging",
schema_override="dbt_cloud_pr_123",
dbt_version_override="0.18.0",
target_name_override="staging",
timeout_seconds_override=3000,
generate_docs_override=True,
threads_override=8,
steps_override=[
"dbt seed",
"dbt run --fail-fast",
"dbt test --fail-fast",
],
),
)
trigger_dbt_cloud_job_run()
Source code in prefect_dbt/cloud/jobs.py
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 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 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
|
trigger_dbt_cloud_job_run_and_wait_for_completion
async
¶
Flow that triggers a job run and waits for the triggered run to complete.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
dbt_cloud_credentials |
DbtCloudCredentials
|
Credentials for authenticating with dbt Cloud. |
required |
job_id |
int
|
The ID of the job to trigger. |
required |
trigger_job_run_options |
Optional[TriggerJobRunOptions]
|
An optional TriggerJobRunOptions instance to specify overrides for the triggered job run. |
None
|
max_wait_seconds |
int
|
Maximum number of seconds to wait for job to complete |
900
|
poll_frequency_seconds |
int
|
Number of seconds to wait in between checks for run completion. |
10
|
retry_filtered_models_attempts |
int
|
Number of times to retry models selected by |
3
|
Raises:
Type | Description |
---|---|
DbtCloudJobRunCancelled
|
The triggered dbt Cloud job run was cancelled. |
DbtCloudJobRunFailed
|
The triggered dbt Cloud job run failed. |
RuntimeError
|
The triggered dbt Cloud job run ended in an unexpected state. |
Returns:
Type | Description |
---|---|
Dict
|
The run data returned by the dbt Cloud administrative API. |
Examples:
Trigger a dbt Cloud job and wait for completion as a stand alone flow:
import asyncio
from prefect_dbt.cloud import DbtCloudCredentials
from prefect_dbt.cloud.jobs import trigger_dbt_cloud_job_run_and_wait_for_completion
asyncio.run(
trigger_dbt_cloud_job_run_and_wait_for_completion(
dbt_cloud_credentials=DbtCloudCredentials(
api_key="my_api_key",
account_id=123456789
),
job_id=1
)
)
Trigger a dbt Cloud job and wait for completion as a sub-flow:
from prefect import flow
from prefect_dbt.cloud import DbtCloudCredentials
from prefect_dbt.cloud.jobs import trigger_dbt_cloud_job_run_and_wait_for_completion
@flow
def my_flow():
...
run_result = trigger_dbt_cloud_job_run_and_wait_for_completion(
dbt_cloud_credentials=DbtCloudCredentials(
api_key="my_api_key",
account_id=123456789
),
job_id=1
)
...
my_flow()
Trigger a dbt Cloud job with overrides:
import asyncio
from prefect_dbt.cloud import DbtCloudCredentials
from prefect_dbt.cloud.jobs import trigger_dbt_cloud_job_run_and_wait_for_completion
from prefect_dbt.cloud.models import TriggerJobRunOptions
asyncio.run(
trigger_dbt_cloud_job_run_and_wait_for_completion(
dbt_cloud_credentials=DbtCloudCredentials(
api_key="my_api_key",
account_id=123456789
),
job_id=1,
trigger_job_run_options=TriggerJobRunOptions(
git_branch="staging",
schema_override="dbt_cloud_pr_123",
dbt_version_override="0.18.0",
target_name_override="staging",
timeout_seconds_override=3000,
generate_docs_override=True,
threads_override=8,
steps_override=[
"dbt seed",
"dbt run --fail-fast",
"dbt test --fail fast",
],
),
)
)
Source code in prefect_dbt/cloud/jobs.py
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 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 345 346 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 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 |
|