blob: 3fe140a4afab05d983fd3a2aaaecb7b5bb08dda1 [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","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","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"]]},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"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:exception","5":"py:function"},terms:{"0":[0,1,2,3,4,5,6,8,10,11],"01":7,"02":7,"03":7,"08575ddd8a":7,"1":[0,1,2,3,4,5,6,8,10,11],"10":[0,7,11],"11":[7,10],"12":10,"14":7,"16adc035b1":7,"2":[0,1,2,3,4,5,6,7,8,10,11],"20":[0,11],"2021":10,"2022":7,"20998":7,"21798":7,"22112":7,"22126":7,"22136":7,"22226":7,"22244":7,"22382":9,"24":[0,3],"27":7,"3":0,"30":0,"300":11,"4":[0,1,2,3,4,5,6,7,8,9,10,11],"406f":10,"4388808e0e":7,"48617":11,"49":10,"4d3a":10,"512":10,"54":10,"5c6e":10,"60":[0,3],"6674":10,"7":[0,3],"728368_run_result":3,"8":11,"8ec4":10,"boolean":0,"case":11,"class":9,"default":[0,3,11],"do":10,"enum":0,"export":8,"function":[3,5,11],"import":10,"int":[0,3,5],"long":[3,11],"return":[0,3],"static":0,"true":3,"while":[5,11],By:[0,3,10,11],For:[0,3,5,7,8,9,10,11],If:[0,3,8,10],In:11,It:[9,10],Or:11,That:3,The:[0,3,5,8,9,10,11],There:10,These:11,To:[0,8,10,11],_:3,__call__:0,about:10,abov:10,access:0,accident:7,account:[0,3,5,8,11],account_id:[0,3,5,8,11],ad:9,add:[7,8],addit:[0,3,11],additional_run_config:[0,3,11],after:8,against:[0,7],airflow:[8,10,11],airflow_conn_dbt_cloud_default:8,airflowexcept:0,aka:10,alert:9,all:[0,8,9,11],allow:3,alreadi:10,also:[8,10,11],altern:11,an:[0,1,2,3,4,5,6,7,8,9,10,11],analyst:9,ani:[0,3,10],apach:10,apache_airflow_providers_dbt_cloud:10,api:[0,3,9,11],api_token:8,approach:11,ar:[0,3,8,9,10,11],arg:0,artifact:[0,3],asc:[9,10],asynchron:[3,11],auth:0,authbas:0,author:0,automat:11,avail:[0,8,10,11],ba4b:10,base:[0,3,5],baseoper:[3,11],baseoperatorlink:[3,7],basesensoroper:[5,11],bash:10,behavior:0,behind:3,belong:10,below:[10,11],bin:10,binari:10,bool:[0,3],both:11,bst:10,build:[0,10],c1ab8e2d7b:7,can:[8,9,10,11],cancel:0,cancel_job_run:0,catalog:[0,3,11],caus:0,cd:9,cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:10,cde1:10,certif:10,certifi:10,chang:7,changelog:7,chapter:10,check:[0,3,5,10,11],check_interv:[0,3,11],check_is_valid:0,checksum:[9,10],choos:10,ci:9,cl:0,classifi:7,classmethod:0,clean:3,cleanup:3,cloud:10,code:10,com:10,come:[9,11],command:[0,3],commit:7,complet:[0,11],compon:8,configur:[0,3,11],conn_name_attr:0,conn_typ:0,connect:[0,3,5,9,11],contain:10,context:[3,5],control:11,correct:10,correspond:8,could:3,creat:[3,8,10],curl:10,current:[0,11],custom:[0,11],d08284ed25:7,d7de:10,d:10,dag:[9,11],dai:3,data:9,databas:8,datetim:[3,7],dbt:10,dbt_cloud:[0,8],dbt_cloud_conn_id:[0,3,5],dbt_cloud_default:[0,8],dbtcloudgetjobrunartifactoper:[3,11],dbtcloudhook:[0,3,5,7,8],dbtcloudjobrunexcept:0,dbtcloudjobrunoper:7,dbtcloudjobrunsensor:[3,5,11],dbtcloudjobrunstatu:0,dbtcloudrunjoboper:[3,11],dbtcloudrunjoboperatorlink:3,decor:0,default_arg:11,default_conn_nam:[0,3,5],defin:5,demonstr:11,dep:10,deploy:9,deprec:3,deriv:[3,5],describ:[8,10],descript:[0,3],desir:[0,3],dest:10,destin:[0,3],detail:[7,9,10],dev0:[0,1,2,3,4,5,6,7,8,9,10,11],develop:9,dict:[0,3],dictionari:[0,3,11],diff:10,differ:10,directli:3,directori:[0,3,10,11],disabl:3,distribut:10,document:[7,8,9,11],down:10,download:[0,3,10],drop:10,dttm:3,e08a:10,e782b37a3f:7,e:3,each:11,ecf4:10,echo:10,either:8,enabl:3,encod:8,engin:9,environ:[0,8,9],equip:9,error:0,es:0,essenti:10,etc:11,everi:11,exampl:[0,8,9,10,11],example_dag:11,example_dbt_cloud:11,except:0,execut:[0,3,11],exist:9,expect:0,expected_statu:0,expected_status:0,experiment:[0,1,2,3,4,5,6,7,8,9,10,11],explicit:[7,11],explicitli:[8,11],expos:11,extern:3,extra:9,f8c01317ef:7,fail:0,fallback:[0,11],fallback_to_default_account:0,fals:11,featur:[0,1,2,3,4,5,6,7,8,9,10,11],field:[0,7,8],file:[0,3,10],fingerprint:10,first:[0,3],flag:3,folder:10,follow:[8,10],form:[0,8],foundat:10,from:[0,3,8,9,11],func:0,g:3,gener:[0,3,11],generate_docs_overrid:11,get:[3,10],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:11,get_template_context:3,get_ui_field_behaviour:0,get_valu:7,ghost:3,git_branch:11,gmail:10,good:[10,11],gpg:10,guid:[3,5,10],gz:10,ha:[0,3,11],header:0,help:9,helper:0,high:7,hook:[2,8],hook_nam:0,host:9,how:[3,5,8,10,11],http:[0,9,10],httphook:0,i:10,id:[0,3,9,10,11],identifi:5,includ:[0,3,7,11],include_rel:0,index:[0,3],indic:[0,10],inform:[3,5,7,8,11],initi:[9,11],input:0,instal:8,install_requir:9,instanc:3,instanti:11,instead:[0,3,8],instruct:10,integr:9,interact:[0,8],interfac:7,is_termin:0,issuer:10,jinja:3,job:[0,3,5,9],job_definition_id:0,job_id:[0,3,11],job_run_info:0,job_run_sensor:11,jobruninfo:0,json:[0,3,11],ka:10,kaxil:10,kaxilnaik:10,kei:10,kill:3,know:10,known:0,kwarg:[0,3,5],l:10,la:10,last:[0,3],latest:7,leav:3,left:10,length:11,level:7,link:[3,10],list:[0,3,7,9,11],list_account:0,list_job:0,list_job_run:0,list_job_run_artifact:0,list_project:0,local:[10,11],login:8,look:[3,5],ls:10,made:[8,10],main:[3,10],manag:10,manifest:[0,3,11],map_index:7,march:7,match:[0,10],metadata:0,method:[3,8],might:9,mirror:10,mistakenli:9,misus:7,mktemp:10,model:[0,3,7,11],monitor:[3,9],more:[3,5,7,8,11],most:10,multiprocess:3,must:8,naik:10,name:3,need:[3,8,9],next:11,non:3,none:[0,3,5,10],note:[3,8,11],o:10,offici:10,old:3,omit:[0,3],on_kil:3,onc:10,one:10,onli:[0,3],oper:[2,8,9],operator_extra_link:3,option:[0,3,5,8,11],order:[0,9],order_bi:0,org:10,origin:10,other:[0,11],output:11,output_file_nam:3,overrid:[0,3,5,7,8,11],owner:10,package_nam:10,package_vers:10,page:10,pair:11,paramet:[0,3,5,11],pass:[0,7,8,11],password:8,path:[0,3,11],perform:[3,11],period:11,pertain:0,pgp:10,pgpk:10,pgpv:10,pip:10,pipelin:0,pleas:10,poke:5,poll:5,previou:[10,11],primari:10,process:3,production:9,project:0,project_id:0,properti:11,protect:7,provid:[8,10,11],provider_download_dir:10,pull:0,py3:10,py:11,pypi:9,python:[9,10],queri:[0,3],queu:0,raw:11,reach:[0,3,11],reason:[0,3],recommend:10,refer:[3,8,11],referenc:11,relat:[0,3,8],releas:[7,9],relev:10,remov:10,render:3,repositori:[0,9],request:[0,3],requir:8,respect:11,respons:0,result:0,retriev:[0,8,11],revers:0,root:[0,3,11],rsa:10,run:[0,3,5,10],run_id:[0,3,5,11],run_result:[0,3,11],runtim:[3,11],s:[0,3,10],same:[3,11],sat:10,schedul:9,schema:[0,3],schema_overrid:[0,3,11],script:10,sdist:[9,10],second:[0,3,11],see:7,select:10,self:[0,3,5,10],sensor:[2,11],sep:10,sequenc:0,serv:9,server:10,servic:[8,9],session:0,set:[0,11],sha512:[9,10],sha:10,shasum:10,should:[0,3,5,8,10,11],show:11,sign:10,signatur:[3,9,10],site:9,softwar:10,sourc:[0,3,5,9,11],specif:[0,11],specifi:[0,8,9,11],sql:11,standard:8,start:0,statu:[0,3,5],status:0,step:[0,3,10],steps_overrid:[0,3,11],still:[3,8],store:8,str:[0,3,5],subject:7,subprocess:3,succeed:11,success:[0,11],sum:10,suppli:0,support:[3,9],synchron:11,syntax:8,system:3,take:[3,5,7],taken:0,tar:10,target:[0,3,11],task:[3,11],task_id:11,taskinst:3,templat:[3,7],template_field:[3,5],temporari:10,termin:[0,3,11],terminal_status:0,test:0,test_connect:0,them:9,thi:[0,1,2,3,4,5,6,7,8,9,10,11],those:[0,3,9,10],thread:3,threads_overrid:11,through:0,ti:[0,11],ti_kei:[3,7],time:[0,3,11],timeout:[0,3,11],token:[0,8],tokenauth:0,top:[9,10],trigger:[0,3],trigger_job_run1:11,trigger_job_run2:11,trigger_job_run:0,trigger_reason:3,trust:10,turnkei:9,two:11,type:[0,8],typeddict:0,typic:11,typing_compat:0,ui:[0,8],union:0,unknown:10,until:11,up:3,uri:8,url:8,us:[0,3,5,8,9,10,11],user:[3,8,10],util:11,v2:0,valid:[0,10],valu:[0,8,11],variabl:8,verifi:9,version:[7,9,10],via:[8,9,10,11],wa:3,wai:11,wait:[0,3,11],wait_for_job_run_statu:0,wait_for_termin:[3,11],want:10,warn:10,well:10,wheel:9,when:[0,3,8,9],whether:11,which:0,whl:10,why:10,within:[3,11],worri:10,xcom:7,you:[8,9,10],your:8},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>","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":[7,9],"1":[7,9],"2":9,"class":[0,3,5],"default":8,"function":0,airflow:[0,1,2,3,4,5,6,7,9],apach:[7,9],api:8,artifact:11,authent:8,bug:9,changelog:9,cloud:[0,1,2,3,4,5,6,7,8,9,11],commit:9,configur:8,connect:8,content:[0,3,5,9],cross:9,dbt:[0,1,2,3,4,5,6,7,8,9,11],depend:9,download:[9,11],fix:9,from:10,guid:9,hook:[0,1],id:8,instal:[9,10],integr:10,job:11,modul:[0,3,5],offici:9,oper:[3,4,11],packag:[7,9,10],pip:9,poll:11,provid:[0,1,2,3,4,5,6,7,9],pypi:10,refer:9,releas:10,requir:9,resourc:9,run:11,sensor:[5,6],sourc:10,statu:11,submodul:[1,4,6],subpackag:2,trigger:11,verifi:10}})