blob: 54eec68a3b101ce5edd90a5e8b1036720b519fe4 [file] [log] [blame]
Search.setIndex({docnames:["_api/airflow/providers/tableau/hooks/index","_api/airflow/providers/tableau/hooks/tableau/index","_api/airflow/providers/tableau/index","_api/airflow/providers/tableau/operators/index","_api/airflow/providers/tableau/operators/tableau/index","_api/airflow/providers/tableau/operators/tableau_refresh_workbook/index","_api/airflow/providers/tableau/sensors/index","_api/airflow/providers/tableau/sensors/tableau/index","_api/airflow/providers/tableau/sensors/tableau_job_status/index","commits","connections/tableau","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/tableau/hooks/index.rst","_api/airflow/providers/tableau/hooks/tableau/index.rst","_api/airflow/providers/tableau/index.rst","_api/airflow/providers/tableau/operators/index.rst","_api/airflow/providers/tableau/operators/tableau/index.rst","_api/airflow/providers/tableau/operators/tableau_refresh_workbook/index.rst","_api/airflow/providers/tableau/sensors/index.rst","_api/airflow/providers/tableau/sensors/tableau/index.rst","_api/airflow/providers/tableau/sensors/tableau_job_status/index.rst","commits.rst","connections/tableau.rst","index.rst","installing-providers-from-sources.rst","operators.rst"],objects:{"airflow.providers":[[2,0,0,"-","tableau"]],"airflow.providers.tableau":[[0,0,0,"-","hooks"],[3,0,0,"-","operators"],[6,0,0,"-","sensors"]],"airflow.providers.tableau.hooks":[[1,0,0,"-","tableau"]],"airflow.providers.tableau.hooks.tableau":[[1,1,1,"","TableauHook"],[1,4,1,"","TableauJobFailedException"],[1,1,1,"","TableauJobFinishCode"],[1,5,1,"","parse_boolean"]],"airflow.providers.tableau.hooks.tableau.TableauHook":[[1,2,1,"","__enter__"],[1,2,1,"","__exit__"],[1,3,1,"","conn_name_attr"],[1,3,1,"","conn_type"],[1,3,1,"","default_conn_name"],[1,2,1,"","get_all"],[1,2,1,"","get_conn"],[1,2,1,"","get_job_status"],[1,3,1,"","hook_name"],[1,2,1,"","wait_for_state"]],"airflow.providers.tableau.hooks.tableau.TableauJobFinishCode":[[1,3,1,"","CANCELED"],[1,3,1,"","ERROR"],[1,3,1,"","PENDING"],[1,3,1,"","SUCCESS"]],"airflow.providers.tableau.operators":[[4,0,0,"-","tableau"],[5,0,0,"-","tableau_refresh_workbook"]],"airflow.providers.tableau.operators.tableau":[[4,6,1,"","RESOURCES_METHODS"],[4,1,1,"","TableauOperator"]],"airflow.providers.tableau.operators.tableau.TableauOperator":[[4,2,1,"","execute"]],"airflow.providers.tableau.operators.tableau_refresh_workbook":[[5,1,1,"","TableauRefreshWorkbookOperator"]],"airflow.providers.tableau.operators.tableau_refresh_workbook.TableauRefreshWorkbookOperator":[[5,2,1,"","execute"]],"airflow.providers.tableau.sensors":[[7,0,0,"-","tableau"],[8,0,0,"-","tableau_job_status"]],"airflow.providers.tableau.sensors.tableau":[[7,1,1,"","TableauJobStatusSensor"]],"airflow.providers.tableau.sensors.tableau.TableauJobStatusSensor":[[7,2,1,"","poke"],[7,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"],"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,"03":9,"04":9,"05":9,"06":9,"07":9,"08":9,"09":9,"0a6858847":9,"0dbd0f420":9,"1":[0,1,2,3,4,5,6,7,8,10,12,13],"10":[9,11],"11":12,"12":[9,12],"13":9,"14":9,"14030":9,"14487":9,"14886":9,"15":9,"15499":9,"15518":9,"15576":9,"15667":[9,11],"16":9,"16294":9,"16365":[9,11],"16405":9,"16464":9,"16501":9,"16872":9,"16915":9,"16916":[9,11],"16adc035b":9,"17015":9,"17020":9,"17034":9,"17116":9,"17125":[9,11],"17682":9,"17890":9,"18":9,"18597":9,"18613":9,"19":9,"19064":[9,11],"19321":9,"1fba5402b":9,"2":[0,1,2,3,4,5,6,7,8,10,12,13],"20":[4,5,9,13],"2021":[9,12],"2022":9,"20240":9,"20433":[9,11],"20523":9,"20565":9,"20571":9,"20614":9,"20654":9,"20951":9,"21":9,"21003":[9,11],"21257":9,"21439":9,"22":9,"22056":9,"22226":9,"22382":11,"22383":9,"23":9,"23353":[9,11],"25":9,"26":9,"27":9,"28":9,"29":9,"29b6be848":9,"2f":10,"2fmy":10,"30":9,"31":9,"37681bca0":9,"3a":10,"4":[0,1,2,3,4,5,6,7,8,10,12,13],"406f":12,"40a2476a5":9,"45e72ca83":9,"49":12,"4d3a":12,"506efb6fa":9,"512":12,"53246ebef":9,"54":12,"5569b868a":9,"589d6dec9":9,"5c6e":12,"5df99d6c6":9,"602abe839":9,"6174198a3":9,"636ae0a33":9,"6674":12,"68e4c4dcb":9,"6c3a67d4f":9,"76ed2a49c":9,"8":[0,1,2,3,4,5,6,7,8,10,12,13],"807ad32c":9,"840ea3efb":9,"87f408b1e":9,"8ec4":12,"9132baf19":9,"97496ba2b":9,"9c94b72d4":9,"boolean":[1,10],"case":10,"class":[9,11],"default":[1,4,5,9,13],"do":12,"enum":1,"export":10,"float":[1,4,5,13],"function":9,"import":[9,11,12],"new":9,"return":[1,4,5,7],"static":9,"true":[1,4,5,7,10,13],"try":1,By:[4,12,13],For:[1,4,9,10,12],If:[10,11,12],It:[1,12],The:[1,4,5,7,10,12,13],There:[10,12],To:[10,12],__enter__:1,__exit__:1,a0821235f:9,about:[9,12],abov:12,access:[9,10,11],action:[4,13],activ:[9,11],ad:11,add:[9,10,11],after:9,airflow:[10,12,13],airflow_conn_tableau_default:10,airflowexcept:1,aka:12,all:[1,10,11],allow:[1,9,11],alreadi:12,also:[1,12],amazon:9,an:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],ani:12,apach:12,apache_airflow_providers_tableau:12,api:[1,4,5,7,10,11],appli:[9,11],apply_default:[9,11],ar:[10,11,12],arg:9,asc:12,attribut:10,august:9,auth:[1,10],authent:[1,4,5,7,9,11,13],author:[1,10],auto:[9,11],autoapi:9,automat:[1,10,11],avail:12,azur:10,b916b7507:9,ba4b:12,backport:9,base:[1,4,5,7],basehook:1,baseoper:[4,5],basesensoroper:7,bash:12,bbc627a3d:9,be75dcd39:9,belong:[1,4,5,7,12,13],below:12,between:[1,4,5,13],bf2b48174:9,bin:12,binari:12,block:[4,5,13],blocking_refresh:[4,13],bool:[1,4,5,7,9,11,13],both:10,bst:12,bug:10,bugfix:9,buggfix:9,build:12,bundl:10,ca:10,can:[1,10,11,12],cancel:1,cbf8001d7:9,cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:12,cde1:12,cert:10,certif:[10,12],certifi:12,chang:[9,10],changelog:9,chapter:12,charact:9,check:[1,4,5,12,13],check_interv:[1,4,5,13],checksum:12,choos:12,classifi:[9,11],cleanup:9,client:[1,4,5,7,10,13],close:1,cncf:9,code:[1,12],com:[1,12],command:13,commit:9,commun:1,compat:9,complet:[1,4,5,11,13],compon:10,conn_name_attr:1,conn_typ:1,connect:[1,4,5,7,9,11],consid:10,contain:[1,4,5,7,12],contenturl:10,context:[1,4,5,7,9],contextmgr:1,control:10,convers:[9,11],correct:12,correspond:10,creat:12,credenti:[1,4,5,7,10,13],curl:12,current:1,d02ded65:9,d56e7b56b:9,d7dbfb7e2:9,d7de:12,d94fa3783:9,d9567eb10:9,d:12,dag:[9,11],data:9,datasourc:13,db:11,decemb:9,decor:[9,11],default_arg:9,default_conn_nam:1,defin:[1,5],delai:9,delet:13,dep:12,deprec:[5,8,9,10,11],describ:[1,12],descript:9,dest:12,detail:[9,11,12],dev0:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],df0746e13:9,dictionari:10,diff:12,differ:[1,12],directori:12,disabl:[9,11],distribut:12,distutil:[9,11],doc:[1,4,5,7,9],document:9,doe:1,don:1,down:12,download:[4,12],drop:12,due:11,dure:[4,5,7],e08a:12,e4888a061:9,e:10,each:[1,4,5,13],ecf4:12,echo:12,ef037e702:9,ef3c75df1:9,either:10,empti:10,en:1,enabl:10,encod:10,ensur:[9,11],environ:10,equal:1,error:[1,9],escap:9,essenti:12,everywher:9,exampl:[1,9,10,11,12,13],example_dag:13,example_tableau:13,exc_tb:1,exc_typ:1,exc_val:1,except:1,execut:[4,5,7,13],exist:11,experiment:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],extra:10,extract:[4,5,13],f5b96315f:9,f77417eb0:9,fail:1,fals:[1,7],featur:[0,1,2,3,4,5,6,7,8,9,10,12,13],feb:9,field:[4,13],file:[4,10,12],find:[4,13],fingerprint:12,finish:[1,4,5,7,13],first:11,fix:9,folder:12,follow:[10,12,13],foundat:12,framework:11,friendli:9,from:[1,9,11],gener:9,get:[1,12],get_al:1,get_conn:1,get_job_statu:1,github:[1,4,5,7],given:1,gmail:12,good:12,gpg:12,group:13,guid:[4,12],gz:12,ha:[4,5,7,13],harm:10,have:[9,11],help:1,high:9,hook:[2,9,10,11],hook_nam:1,host:10,how:[4,12],htm:1,http:[1,4,5,7,10,12],i:[10,12],id:[1,4,5,7,12,13],includ:9,indic:[1,12],individu:9,inform:[4,9],initi:[10,11],install_requir:11,instanc:[1,4,5,13],instruct:12,integr:10,intend:10,interact:9,invalid:10,io:[1,4,5,7],issuer:12,item:1,januari:9,job:[1,4,5,7,9,10,13],job_id:[1,7],json:10,juli:9,june:9,k8:9,ka:12,kaxil:12,kaxilnaik:12,kei:[10,12],know:12,kwarg:[4,5,7],l:12,la:12,latest:9,lazili:9,lead:10,least:11,left:12,level:9,like:1,line:9,link:12,list:[9,11],local:12,logic:10,login:10,look:[1,4],ls:12,made:12,main:12,manag:[1,9,10,12],manual:11,march:9,marketingteam:10,match:[4,12,13],match_with:[4,13],mean:[4,13],meta:9,method:[4,10],migrat:11,mirror:12,misc:9,miscellan:9,mistakenli:11,mktemp:12,model:[4,5],modul:8,more:[4,9,10,11],most:12,multipl:10,must:10,mypi:9,myserv:10,myworkbook:13,naik:12,name:[1,4,5,10,13],need:10,next:9,none:[1,4,5,7,12,13],note:10,now:9,numer:10,o:12,object:1,octob:9,offici:12,onc:12,one:[10,12],onli:10,onlin:10,open:[1,10],oper:[1,2,9,10,11],optimis:11,option:[1,4,5,7,10],org:12,organ:[9,11],origin:12,otherwis:[1,11],out:1,owner:12,package_nam:12,package_vers:12,page:[1,12],pager:1,pagin:1,pair:10,parallel:10,param:4,paramet:[1,4,5,7,9,10,11,13],pars:1,parse_boolean:1,password:10,path:10,pattern:9,pem:10,pend:1,person:[9,10,11],personal_access_token:10,pgp:12,pgpk:12,pgpv:12,pip:[9,12],pleas:[5,8,12],poke:7,portion:10,prepar:9,previou:12,primari:12,project:[10,13],provid:[10,12,13],provider_download_dir:12,push:[4,5],py3:12,py:13,pypi:[9,11],python:[1,4,5,7,9,11,12,13],query_job:1,quot:10,rc2:9,receiv:[4,13],recommend:12,ref:[1,4,5,7],refactor:9,refer:[4,13],refresh:[4,5,13],refresh_tableau_workbook_block:13,relat:10,releas:[9,11],relev:12,remov:[9,11,12,13],repositori:11,resourc:[1,4],resource_nam:1,resources_method:4,rest:[1,10],rest_api:1,rest_api_ref:1,result:1,rsa:12,rtype:4,run:[10,11,12,13],s:[1,4,9,10,12,13],salesforc:9,same:10,sat:12,schedul:13,script:12,sdist:12,second:[1,4,5,13],see:[1,9],seealso:1,select:12,self:[1,4,5,7,12],sensor:2,sep:12,separ:9,septemb:9,sequenc:[7,9],server:[1,4,5,7,10,12,13],sever:10,sha512:12,sha:12,shasum:12,should:[1,4,5,10,12,13],sign:[1,12],signatur:12,singl:10,site:[1,4,5,7,10,13],site_id:[1,4,5,7,10,13],so:10,softwar:12,sourc:[1,4,5,7,11,13],space:10,specifi:10,sphinx:9,squelch:[9,11],ssl:[9,10,11],start_dat:9,state:[1,4,5,13],statu:[1,7],step:12,str:[1,4,5,7,13],string:[1,10],subject:9,succeed:7,success:1,successfulli:7,sum:12,support:[9,11],synchron:9,syntax:10,t:1,tableau:[12,13],tableau_conn_id:[1,4,5,7,13],tableau_default:[1,4,5,7,10,13],tableau_job_statu:[2,6],tableau_refresh_workbook:[2,3],tableauhook:[1,9,11],tableaujobfailedexcept:1,tableaujobfinishcod:1,tableaujobstatussensor:7,tableauoper:[4,9],tableaurefreshworkbookoper:5,tableauservercli:[1,11],take:4,tar:12,target:1,target_st:1,target_statu:1,task:[4,5,7,10,13],task_id:13,task_refresh_workbook_block:13,template_field:[7,9],temporari:12,thei:10,therefor:10,thi:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],those:12,through:1,time:[1,4,5,10,13],tl:10,token:[9,10,11],token_nam:10,top:[11,12],trove:11,trust:12,tupl:10,two:10,type:[1,5,7,9,10,11],typehint:9,unknown:12,until:[1,4,5,7,10,13],updat:9,upgrad:11,uri:[4,10],url:10,us:[1,4,5,8,9,10,12],usag:[9,11,13],user:[12,13],usernam:10,util:[5,7],val:1,valid:12,valu:[1,10],variabl:10,verifi:[9,10,11],version:[9,11,12],via:[11,12],wa:10,wai:10,wait:[1,4,5,9,13],wait_for_st:[1,9,11],want:[11,12],warn:[9,11,12],watch:7,wave:9,we:10,well:12,when:[1,9,10],where:[1,4,5,7,13],whether:10,which:10,whl:12,why:12,workbook:[1,4,5,7,13],workbook_nam:5,worri:12,wrongli:9,xcom:[4,5],you:[1,10,11,12],your:11},titles:["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.tableau.hooks</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.tableau.hooks.tableau</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.tableau</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.tableau.operators</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.tableau.operators.tableau</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.tableau.operators.tableau_refresh_workbook</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.tableau.sensors</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.tableau.sensors.tableau</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.tableau.sensors.tableau_job_status</span></code>","Package apache-airflow-providers-tableau","Tableau Connection","<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-tableau</span></code>","Installing from sources","TableauOperator"],titleterms:{"0":[9,11],"1":[9,11],"2":[9,11],"3":[9,11],"4":[9,11],"5":[9,11],"6":[9,11],"7":[9,11],"8":[9,11],"break":11,"class":[1,4,5,7],"default":10,"function":1,airflow:[0,1,2,3,4,5,6,7,8,9,11],apach:[9,11],attribut:4,authent:10,avail:13,bug:11,chang:11,changelog:11,commit:11,configur:10,connect:10,content:[1,4,5,7,11],featur:11,fix:11,from:12,hook:[0,1],id:10,instal:[11,12],integr:12,method:13,misc:11,modul:[1,4,5,7],oper:[3,4,5,13],packag:[9,11,12],pip:11,provid:[0,1,2,3,4,5,6,7,8,9,11],pypi:12,refer:11,releas:12,requir:11,resourc:[11,13],sensor:[6,7,8],sourc:12,submodul:[0,3,6],subpackag:2,tableau:[0,1,2,3,4,5,6,7,8,9,10,11],tableau_job_statu:8,tableau_refresh_workbook:5,tableauoper:13,us:13,verifi:12}})