blob: f3306b683ee4bf8e43784ca6460593948937e7a0 [file] [log] [blame]
Search.setIndex({docnames:["_api/airflow/providers/dbt/cloud/hooks/dbt/index","_api/airflow/providers/dbt/cloud/hooks/index","_api/airflow/providers/dbt/cloud/index","_api/airflow/providers/dbt/cloud/operators/dbt/index","_api/airflow/providers/dbt/cloud/operators/index","_api/airflow/providers/dbt/cloud/sensors/dbt/index","_api/airflow/providers/dbt/cloud/sensors/index","_api/tests/system/providers/dbt/cloud/example_dbt_cloud/index","_api/tests/system/providers/dbt/cloud/index","commits","connections","index","installing-providers-from-sources","operators"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["_api/airflow/providers/dbt/cloud/hooks/dbt/index.rst","_api/airflow/providers/dbt/cloud/hooks/index.rst","_api/airflow/providers/dbt/cloud/index.rst","_api/airflow/providers/dbt/cloud/operators/dbt/index.rst","_api/airflow/providers/dbt/cloud/operators/index.rst","_api/airflow/providers/dbt/cloud/sensors/dbt/index.rst","_api/airflow/providers/dbt/cloud/sensors/index.rst","_api/tests/system/providers/dbt/cloud/example_dbt_cloud/index.rst","_api/tests/system/providers/dbt/cloud/index.rst","commits.rst","connections.rst","index.rst","installing-providers-from-sources.rst","operators.rst"],objects:{"airflow.providers.dbt":[[2,0,0,"-","cloud"]],"airflow.providers.dbt.cloud":[[1,0,0,"-","hooks"],[4,0,0,"-","operators"],[6,0,0,"-","sensors"]],"airflow.providers.dbt.cloud.hooks":[[0,0,0,"-","dbt"]],"airflow.providers.dbt.cloud.hooks.dbt":[[0,1,1,"","DbtCloudHook"],[0,4,1,"","DbtCloudJobRunException"],[0,1,1,"","DbtCloudJobRunStatus"],[0,1,1,"","JobRunInfo"],[0,1,1,"","TokenAuth"],[0,5,1,"","fallback_to_default_account"]],"airflow.providers.dbt.cloud.hooks.dbt.DbtCloudHook":[[0,2,1,"","cancel_job_run"],[0,3,1,"","conn_name_attr"],[0,3,1,"","conn_type"],[0,2,1,"","connection"],[0,3,1,"","default_conn_name"],[0,2,1,"","get_account"],[0,2,1,"","get_conn"],[0,2,1,"","get_job"],[0,2,1,"","get_job_run"],[0,2,1,"","get_job_run_artifact"],[0,2,1,"","get_job_run_status"],[0,2,1,"","get_project"],[0,2,1,"","get_ui_field_behaviour"],[0,3,1,"","hook_name"],[0,2,1,"","list_accounts"],[0,2,1,"","list_job_run_artifacts"],[0,2,1,"","list_job_runs"],[0,2,1,"","list_jobs"],[0,2,1,"","list_projects"],[0,2,1,"","test_connection"],[0,2,1,"","trigger_job_run"],[0,2,1,"","wait_for_job_run_status"]],"airflow.providers.dbt.cloud.hooks.dbt.DbtCloudJobRunStatus":[[0,3,1,"","CANCELLED"],[0,3,1,"","ERROR"],[0,3,1,"","QUEUED"],[0,3,1,"","RUNNING"],[0,3,1,"","STARTING"],[0,3,1,"","SUCCESS"],[0,3,1,"","TERMINAL_STATUSES"],[0,2,1,"","check_is_valid"],[0,2,1,"","is_terminal"]],"airflow.providers.dbt.cloud.hooks.dbt.JobRunInfo":[[0,3,1,"","account_id"],[0,3,1,"","run_id"]],"airflow.providers.dbt.cloud.hooks.dbt.TokenAuth":[[0,2,1,"","__call__"]],"airflow.providers.dbt.cloud.operators":[[3,0,0,"-","dbt"]],"airflow.providers.dbt.cloud.operators.dbt":[[3,1,1,"","DbtCloudGetJobRunArtifactOperator"],[3,1,1,"","DbtCloudRunJobOperator"],[3,1,1,"","DbtCloudRunJobOperatorLink"]],"airflow.providers.dbt.cloud.operators.dbt.DbtCloudGetJobRunArtifactOperator":[[3,2,1,"","execute"],[3,3,1,"","template_fields"]],"airflow.providers.dbt.cloud.operators.dbt.DbtCloudRunJobOperator":[[3,2,1,"","execute"],[3,2,1,"","on_kill"],[3,3,1,"","operator_extra_links"],[3,3,1,"","template_fields"]],"airflow.providers.dbt.cloud.operators.dbt.DbtCloudRunJobOperatorLink":[[3,2,1,"","get_link"],[3,3,1,"","name"]],"airflow.providers.dbt.cloud.sensors":[[5,0,0,"-","dbt"]],"airflow.providers.dbt.cloud.sensors.dbt":[[5,1,1,"","DbtCloudJobRunSensor"]],"airflow.providers.dbt.cloud.sensors.dbt.DbtCloudJobRunSensor":[[5,2,1,"","poke"],[5,3,1,"","template_fields"]],"tests.system.providers.dbt":[[8,0,0,"-","cloud"]],"tests.system.providers.dbt.cloud":[[7,0,0,"-","example_dbt_cloud"]],"tests.system.providers.dbt.cloud.example_dbt_cloud":[[7,6,1,"","DAG_ID"],[7,6,1,"","ENV_ID"],[7,6,1,"","begin"],[7,6,1,"","test_run"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","exception","Python exception"],"5":["py","function","Python function"],"6":["py","data","Python data"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:exception","5":"py:function","6":"py:data"},terms:{"0":[0,1,2,3,4,5,6,7,8,10,12,13],"01":9,"02":9,"027b707d21":9,"03":9,"04":9,"05":9,"06":9,"07":9,"08575ddd8a":9,"1":[0,3],"10":[0,9,13],"11":[9,12],"12":[9,12],"13":9,"14":9,"16adc035b1":9,"2":[0,1,2,3,4,5,6,7,8,10,12,13],"20":[0,13],"2021":12,"2022":9,"20998":9,"21798":9,"22":9,"22112":9,"22126":9,"22136":9,"22226":9,"22244":9,"22382":11,"22383":9,"22472":9,"22884":[9,11],"22974":9,"23":9,"23104":9,"23179":[9,11],"23631":9,"24":[0,3],"24202":9,"24218":9,"24229":9,"24231":9,"24264":[9,11],"24292":9,"27":9,"3":0,"30":0,"300":13,"4":[0,1,2,3,4,5,6,7,8,9,10,11,12,13],"406f":12,"4388808e0e":9,"47":9,"48617":13,"49":12,"49e336ae03":9,"4d3a":12,"512":12,"54":12,"5c6e":12,"5e6997ed45":9,"60":[0,3],"6674":12,"6933022e94":9,"7":[0,3],"717a7588bc":9,"728368_run_result":3,"7498fba826":9,"75c60923e0":9,"8":13,"8b6b0848a3":9,"8ec4":12,"8f2213fcd0":9,"boolean":0,"case":13,"class":11,"default":[0,3,13],"do":12,"enum":0,"export":10,"function":[3,5,13],"import":12,"int":[0,3,5],"long":[3,13],"new":[9,11],"return":[0,3],"static":0,"true":3,"while":[5,13],By:[0,3,12,13],For:[0,3,5,9,10,11,12,13],If:[0,3,10,12],In:13,It:[11,12],Or:13,That:3,The:[0,3,5,10,11,12,13],There:12,These:13,To:[0,10,12,13],_:3,__call__:0,about:[9,12],abov:12,access:0,accident:9,account:[0,3,5,10,13],account_id:[0,3,5,10,13],ad:11,add:[9,10],addit:[0,3,13],additional_run_config:[0,3,13],aeabe994b3:9,after:10,against:[0,9],aip:9,airflow:[10,12,13],airflow_conn_dbt_cloud_default:10,airflowexcept:0,aka:12,alert:11,all:[0,10,11,13],allow:3,alreadi:12,also:[10,12,13],altern:13,an:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],analyst:11,ani:[0,3,12],apach:12,apache_airflow_providers_dbt_cloud:12,api:[0,3,11,13],api_token:10,approach:13,ar:[0,3,10,11,12,13],arg:0,artifact:[0,3],asc:[11,12],asynchron:[3,13],auth:0,authbas:0,author:0,automat:13,avail:[0,10,11,12,13],ba4b:12,base:[0,3,5],baseoper:3,baseoperatorlink:[3,9],basesensoroper:[5,13],bash:12,begin:7,behavior:0,behind:3,belong:12,below:[11,12,13],bin:12,binari:12,blob:11,bool:[0,3],both:13,brees:9,bst:12,bugfix:9,build:[0,9,12],c1ab8e2d7b:9,can:[10,11,12,13],cancel:0,cancel_job_run:0,catalog:[0,3,13],caus:0,cd:11,cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:12,cde1:12,certif:12,certifi:12,chang:9,changelog:9,chapter:12,check:[0,3,5,12,13],check_interv:[0,3,13],check_is_valid:0,checksum:[11,12],choos:12,ci:11,cl:0,classifi:9,classmethod:0,clean:3,cleanup:3,cloud:12,code:12,com:[11,12],come:[11,13],command:[0,3],commit:9,complet:[0,13],compon:10,configur:[0,3,13],conn_name_attr:0,conn_typ:0,connect:[0,3,5,11,13],contain:12,context:[3,5],contributor:9,control:13,correct:12,correspond:10,could:3,creat:[3,10,12],curl:12,current:[0,13],custom:[0,13],d08284ed25:9,d7dbfb7e26:9,d7de:12,d:12,dag:[9,11,13],dag_id:7,dai:3,data:11,databas:10,datetim:[3,9],dbt:12,dbt_cloud:[0,10],dbt_cloud_conn_id:[0,3,5],dbt_cloud_default:[0,10],dbtcloudgetjobrunartifactoper:[3,13],dbtcloudhook:[0,3,5,9,10],dbtcloudjobrunexcept:0,dbtcloudjobrunoper:9,dbtcloudjobrunsensor:[3,5,13],dbtcloudjobrunstatu:0,dbtcloudrunjoboper:[3,13],dbtcloudrunjoboperatorlink:3,decor:0,default_arg:13,default_conn_nam:[0,3,5],defin:5,demonstr:13,dep:12,deploy:11,deprec:3,deriv:[3,5],describ:[10,12],descript:[0,3,9,11],design:9,desir:[0,3],dest:12,destin:[0,3],detail:[9,11,12],dev0:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],develop:11,dict:[0,3],dictionari:[0,3,13],diff:12,differ:12,directli:3,directori:[0,3,12,13],disabl:3,distribut:12,doc:9,document:[9,10,11,13],doubl:9,down:12,download:[0,3,12],drop:12,dttm:3,dummyoper:9,e08a:12,e782b37a3f:9,e:3,each:13,ecf4:12,echo:12,either:10,emptyoper:9,enabl:[3,9,11],encod:10,engin:11,env_id:7,environ:[0,10,11],equip:11,error:[0,9,11],es:0,essenti:12,etc:13,everi:13,exampl:[0,10,11,12,13],example_dbt_cloud:[8,13],except:0,execut:[0,3,13],exist:11,expect:0,expected_statu:0,expected_status:0,experiment:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],explain:11,explanatori:9,explicit:[9,13],explicitli:[10,13],expos:13,extern:3,extra:11,f8c01317ef:9,f935c9f163:9,fail:0,fallback:[0,13],fallback_to_default_account:0,fals:13,featur:[0,1,2,3,4,5,6,7,8,9,10,12,13],field:[0,9,10],file:[0,3,12],fingerprint:12,first:[0,3],fix:9,flag:3,folder:12,follow:[10,12],form:[0,10],foundat:12,from:[0,3,10,11,13],func:0,g:3,gener:[0,3,13],generate_docs_overrid:13,get:[3,12],get_account:0,get_conn:0,get_job:0,get_job_run:0,get_job_run_artifact:0,get_job_run_statu:0,get_link:3,get_project:0,get_run_results_artifact:13,get_template_context:3,get_ui_field_behaviour:0,get_valu:9,ghost:3,git_branch:13,github:11,gmail:12,good:[12,13],gpg:12,guid:[3,5,12],gz:12,ha:[0,3,13],header:0,help:11,helper:0,high:9,hook:[2,10],hook_nam:0,host:11,how:[3,5,10,12,13],http:[0,11,12],httphook:0,i:12,id:[0,3,11,12,13],identifi:5,imag:9,includ:[0,3,9,13],include_rel:0,index:[0,3],indic:[0,12],inform:[3,5,9,10,13],initi:[11,13],input:0,instal:10,install_requir:11,instanc:[3,9,11],instanti:13,instead:[0,3,10],instruct:12,integr:11,interact:[0,9,10,11],interfac:9,is_termin:0,issuer:12,jinja:3,job:[0,3,5,11],job_definition_id:0,job_id:[0,3,13],job_run_info:0,job_run_sensor:13,jobruninfo:0,json:[0,3,13],ka:12,kaxil:12,kaxilnaik:12,kei:12,kill:3,know:12,known:0,kwarg:[0,3,5],l:12,la:12,last:[0,3],latest:9,leav:3,left:12,length:13,level:9,link:[3,12],list:[0,3,9,11,13],list_account:0,list_job:0,list_job_run:0,list_job_run_artifact:0,list_project:0,local:[12,13],login:10,look:[3,5],ls:12,made:[10,12],mai:9,main:[3,9,11,12],manag:12,manifest:[0,3,13],map_index:9,march:9,match:[0,12],md:11,metadata:0,method:[3,10],might:11,migrat:9,min:9,minimum:11,mirror:12,mistakenli:11,misus:9,mktemp:12,model:[0,3,9,13],monitor:[3,11],more:[3,5,9,10,13],most:12,multiprocess:3,must:10,mypi:[9,11],naik:12,name:3,need:[3,10,11],next:13,non:3,none:[0,3,5,12],note:[3,9,10,13],o:12,offici:12,old:3,omit:[0,3],on_kil:3,onc:12,one:12,onli:[0,3,11],oper:[2,10,11],operator_extra_link:3,option:[0,3,5,10,13],order:[0,11],order_bi:0,org:12,origin:12,other:[0,13],output:13,output_file_nam:3,overrid:[0,3,5,9,10,13],owner:12,package_nam:12,package_vers:12,page:12,pair:13,paramet:[0,3,5,13],pass:[0,9,10,13],password:10,path:[0,3,13],perform:[3,13],period:13,pertain:0,pgp:12,pgpk:12,pgpv:12,pip:[11,12],pipelin:0,pleas:12,poke:5,polici:11,poll:5,prepar:9,previou:[12,13],primari:12,process:3,production:11,project:0,project_id:0,properti:13,protect:9,provid:[10,12,13],provider_download_dir:12,pull:[0,9],py3:12,py:[9,13],pypi:11,python:[11,12],queri:[0,3],queu:0,raw:13,reach:[0,3,13],readm:11,reason:[0,3],recommend:12,refer:[3,10,13],referenc:13,relat:[0,3,10],releas:[9,11],relev:12,remov:[9,12],render:3,replac:9,repositori:[0,11],request:[0,3],requir:10,respect:13,respons:0,result:0,retriev:[0,10,13],revers:0,root:[0,3,13],rsa:12,run:[0,3,5,12],run_id:[0,3,5,13],run_result:[0,3,13],runtim:[3,13],s:[0,3,9,12],same:[3,13],sat:12,schedul:11,schema:[0,3],schema_overrid:[0,3,13],script:12,sdist:[11,12],second:[0,3,13],see:[9,11],select:12,self:[0,3,5,12],sensor:[2,13],sep:12,sequenc:0,serv:11,server:12,servic:[10,11],session:0,set:[0,13],sha512:[11,12],sha:12,shasum:12,should:[0,3,5,10,12,13],show:13,sign:12,signatur:[3,11,12],singl:[9,11],site:11,softwar:12,sourc:[0,3,5,7,11,13],specif:[0,9,13],specifi:[0,10,11,13],sql:13,standard:10,start:0,statu:[0,3,5],status:0,step:[0,3,12],steps_overrid:[0,3,13],still:[3,10],store:10,str:[0,3,5],subject:9,subprocess:3,succeed:13,success:[0,13],sum:12,suppli:0,support:[3,11],synchron:13,syntax:10,system:[3,13],take:[3,5,9],taken:0,tar:12,target:[0,3,13],task:[3,13],task_id:13,taskinst:3,templat:[3,9],template_field:[3,5],temporari:12,tenant:[9,11],termin:[0,3,13],terminal_status:0,test:[0,13],test_connect:0,test_run:7,them:11,thi:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],those:[0,3,11,12],thread:3,threads_overrid:13,through:0,ti:[0,13],ti_kei:[3,9],time:[0,3,13],timeout:[0,3,13],token:[0,10],tokenauth:0,top:[11,12],trigger:[0,3],trigger_job_run1:13,trigger_job_run2:13,trigger_job_run:0,trigger_reason:3,trust:12,turnkei:11,two:13,type:[0,10],typeddict:0,typic:13,typing_compat:0,typo:[9,11],ui:[0,10],union:0,unknown:12,until:13,up:3,updat:9,uri:10,url:10,us:[0,3,5,9,10,11,12,13],usag:9,user:[3,10,12],util:13,v2:0,valid:[0,12],valu:[0,10,13],variabl:10,verifi:[9,11],version:[9,11,12],via:[10,11,12,13],wa:3,wai:13,wait:[0,3,13],wait_for_job_run_statu:0,wait_for_termin:[3,13],want:12,warn:12,well:12,wheel:11,when:[0,3,10,11],whether:13,which:0,whl:12,why:12,within:[3,13],worri:12,xcom:9,you:[10,11,12],your:10},titles:["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.dbt.cloud.hooks.dbt</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.dbt.cloud.hooks</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.dbt.cloud</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.dbt.cloud.operators.dbt</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.dbt.cloud.operators</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.dbt.cloud.sensors.dbt</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.dbt.cloud.sensors</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.dbt.cloud.example_dbt_cloud</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.dbt.cloud</span></code>","Package apache-airflow-providers-dbt-cloud","Connecting to dbt Cloud","<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-dbt-cloud</span></code>","Installing from sources","dbt Cloud Operators"],titleterms:{"0":[9,11],"1":[9,11],"2":[9,11],"break":11,"class":[0,3,5],"default":10,"function":0,airflow:[0,1,2,3,4,5,6,9,11],apach:[9,11],api:10,artifact:13,authent:10,bug:11,chang:11,changelog:11,cloud:[0,1,2,3,4,5,6,7,8,9,10,11,13],commit:11,configur:10,connect:10,content:[0,3,5,7,11],cross:11,dbt:[0,1,2,3,4,5,6,7,8,9,10,11,13],depend:11,download:[11,13],example_dbt_cloud:7,featur:11,fix:11,from:12,guid:11,hook:[0,1],id:10,instal:[11,12],integr:12,job:13,modul:[0,3,5,7],offici:11,oper:[3,4,13],packag:[9,11,12],poll:13,provid:[0,1,2,3,4,5,6,7,8,9,11],pypi:12,refer:11,releas:12,requir:11,resourc:11,run:13,sensor:[5,6],sourc:12,statu:13,submodul:[1,4,6,8],subpackag:2,system:[7,8],test:[7,8],trigger:13,verifi:12}})