blob: 12bc501d2ea5599edf8c005553cd749b6915b5ff [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","_api/tests/system/providers/tableau/example_tableau/index","_api/tests/system/providers/tableau/example_tableau_refresh_workbook/index","_api/tests/system/providers/tableau/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","_api/tests/system/providers/tableau/example_tableau/index.rst","_api/tests/system/providers/tableau/example_tableau_refresh_workbook/index.rst","_api/tests/system/providers/tableau/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"]],"tests.system.providers":[[11,0,0,"-","tableau"]],"tests.system.providers.tableau":[[9,0,0,"-","example_tableau"],[10,0,0,"-","example_tableau_refresh_workbook"]],"tests.system.providers.tableau.example_tableau":[[9,6,1,"","DAG_ID"],[9,6,1,"","ENV_ID"],[9,6,1,"","task_refresh_workbook_blocking"],[9,6,1,"","test_run"]],"tests.system.providers.tableau.example_tableau_refresh_workbook":[[10,6,1,"","DAG_ID"],[10,6,1,"","ENV_ID"],[10,6,1,"","task_refresh_workbook_blocking"],[10,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,9,10,11,13,15,16],"01":12,"02":12,"027b707d21":12,"03":12,"04":12,"05":12,"06":12,"07":12,"08":12,"09":12,"0a68588479":12,"0dbd0f420c":12,"1":1,"10":[12,14],"11":[12,15],"12":[12,15],"13":12,"14":12,"14030":12,"14487":12,"14886":12,"15":12,"15499":12,"15518":12,"15576":12,"15667":[12,14],"16":12,"16294":12,"16365":[12,14],"16405":12,"16464":12,"16501":12,"16872":12,"16915":12,"16916":[12,14],"16adc035b1":12,"17015":12,"17020":12,"17034":12,"17116":12,"17125":[12,14],"17682":12,"17890":12,"18":12,"18597":12,"18613":12,"19":12,"19064":[12,14],"19321":12,"1fba5402bb":12,"2":[0,1,2,3,4,5,6,7,8,9,10,11,13,15,16],"20":[4,5,12,16],"2021":[12,15],"2022":12,"20240":12,"20433":[12,14],"20523":12,"20565":12,"20571":12,"20614":12,"20654":12,"20951":12,"21":12,"21003":[12,14],"21257":12,"21439":12,"22":12,"22056":12,"22226":12,"22382":14,"22383":12,"23":12,"23353":[12,14],"23631":12,"23f367afc1":12,"24125":12,"24229":12,"24231":12,"24292":12,"25":12,"26":12,"27":12,"28":12,"29":12,"29b6be8482":12,"2f":13,"2fmy":13,"3":[0,1,2,3,4,5,6,7,8,9,10,11,13,15,16],"30":12,"31":12,"37681bca00":12,"3a":13,"4":[0,1,2,3,4,5,6,7,8,9,10,11,13,15,16],"406f":15,"40a2476a5d":12,"45e72ca830":12,"47":12,"49":15,"4d3a":15,"506efb6fa3":12,"512":15,"53246ebef7":12,"54":15,"5569b868a9":12,"589d6dec92":12,"5c6e":15,"5df99d6c69":12,"602abe8394":12,"6174198a3f":12,"636ae0a33d":12,"6674":15,"68e4c4dcb0":12,"6c3a67d4fc":12,"717a7588bc":12,"75c60923e0":12,"76ed2a49c6":12,"807ad32ce5":12,"840ea3efb9":12,"87f408b1e7":12,"8ec4":15,"9132baf192":12,"97496ba2b4":12,"9c94b72d44":12,"boolean":[1,13],"case":13,"class":[12,14],"default":[1,4,5,12,16],"do":15,"enum":1,"export":13,"float":[1,4,5,16],"function":12,"import":[12,14,15],"new":12,"return":[1,4,5,7],"static":12,"true":[1,4,5,7,13,16],"try":1,By:[4,15,16],For:[1,4,12,13,15],If:[13,14,15],It:[1,15],That:[9,10],The:[1,4,5,7,9,10,13,15,16],There:[13,15],To:[13,15],__enter__:1,__exit__:1,a0821235fb:12,about:[12,15],abov:15,access:[12,13,14],action:[4,16],activ:[12,14],actual:[9,10],ad:14,add:[12,13,14],aeabe994b3:12,after:12,aip:12,airflow:[13,15],airflow_conn_tableau_default:13,airflowexcept:1,aka:[9,10,15],all:[1,13,14],allow:[1,12,14],alreadi:15,also:[1,15],amazon:12,an:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],ani:15,anoth:[9,10],apach:15,apache_airflow_providers_tableau:15,api:[1,4,5,7,13,14],appli:[12,14],apply_default:[12,14],ar:[13,14,15],arg:12,asc:15,asynchron:[9,10],attribut:13,august:12,auth:[1,13],authent:[1,4,5,7,12,14,16],author:[1,13],auto:[12,14],autoapi:12,automat:[1,13,14],avail:[14,15],azur:13,b916b75079:12,ba4b:15,backport:12,base:[1,4,5,7],basehook:1,baseoper:[4,5],basesensoroper:7,bash:15,bbc627a3da:12,be75dcd39c:12,belong:[1,4,5,7,15,16],below:[14,15],between:[1,4,5,16],bf2b48174a:12,bin:15,binari:15,blob:14,block:[4,5,16],blocking_refresh:[4,16],bool:[1,4,5,7,12,14,16],both:13,bst:15,bug:13,bugfix:12,buggfix:12,build:15,bundl:13,ca:13,can:[1,13,14,15],cancel:1,cbf8001d76:12,cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:15,cde1:15,cert:13,certif:[13,15],certifi:15,chang:[12,13],changelog:12,chapter:15,charact:12,check:[1,4,5,9,10,15,16],check_interv:[1,4,5,16],checksum:15,choos:15,classifi:[12,14],cleanup:12,client:[1,4,5,7,13,16],close:1,cncf:12,code:[1,15],com:[1,14,15],command:16,commit:12,commun:1,compat:12,complet:[1,4,5,14,16],compon:13,conn_name_attr:1,conn_typ:1,connect:[1,4,5,7,12,14],consid:13,contain:[1,4,5,7,15],contenturl:13,context:[1,4,5,7,12],contextmgr:1,contributor:12,control:13,convers:[12,14],correct:15,correspond:13,creat:15,credenti:[1,4,5,7,13,16],curl:15,current:1,d02ded65ea:12,d56e7b56bb:12,d7dbfb7e26:12,d7de:15,d94fa37830:12,d9567eb106:12,d:15,dag:[9,10,12,14],dag_id:[9,10],data:12,datasourc:16,db:14,decemb:12,decor:[12,14],default_arg:12,default_conn_nam:1,defin:[1,5],delai:12,delet:16,dep:15,deprec:[5,8,12,13,14],describ:[1,15],descript:12,design:12,dest:15,detail:[12,14,15],dev0:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],df0746e133:12,dictionari:13,diff:15,differ:[1,15],directori:15,disabl:[12,14],distribut:15,distutil:[12,14],doc:[1,4,5,7,12],document:12,doe:[1,9,10],don:[1,9,10],doubl:12,down:15,download:[4,15],drop:15,due:14,dure:[4,5,7],e08a:15,e4888a061f:12,e:13,each:[1,4,5,16],ecf4:15,echo:15,ef037e7021:12,ef3c75df17:12,either:13,empti:13,en:1,enabl:13,encod:13,ensur:[12,14],env_id:[9,10],environ:13,equal:1,error:[1,12],escap:12,essenti:15,everywher:12,exampl:[1,9,10,12,13,14,15,16],example_tableau:[11,16],example_tableau_refresh_workbook:[9,11],exc_tb:1,exc_typ:1,exc_val:1,except:1,execut:[4,5,7,16],exist:14,experiment:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],explain:14,explanatori:12,extra:13,extract:[4,5,9,10,16],f5b96315fe:12,f77417eb0d:12,fail:1,fals:[1,7],featur:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,15,16],feb:12,field:[4,16],file:[4,13,15],find:[4,16],fingerprint:15,finish:[1,4,5,7,9,10,16],first:[9,10,14],fix:12,folder:15,follow:[13,15,16],foundat:15,framework:14,friendli:12,from:[1,12,14],gener:12,get:[1,15],get_al:1,get_conn:1,get_job_statu:1,github:[1,4,5,7,14],given:1,gmail:15,good:15,gpg:15,group:16,guid:[4,15],gz:15,ha:[4,5,7,16],harm:13,have:[9,10,12,14],help:1,high:12,hook:[2,12,13,14],hook_nam:1,host:13,how:[4,15],htm:1,http:[1,4,5,7,13,14,15],i:[13,15],id:[1,4,5,7,15,16],includ:12,indic:[1,15],individu:12,inform:[4,12],initi:[13,14],install_requir:14,instanc:[1,4,5,16],instruct:15,integr:13,intend:13,interact:12,invalid:13,io:[1,4,5,7],issuer:15,item:1,januari:12,job:[1,4,5,7,12,13,16],job_id:[1,7],json:13,juli:12,june:12,k8:12,ka:15,kaxil:15,kaxilnaik:15,kei:[13,15],know:[9,10,15],kwarg:[4,5,7],l:15,la:15,latest:12,lazili:12,lead:13,least:14,left:15,level:12,like:1,line:12,link:15,list:[12,14],local:15,logic:13,login:13,look:[1,4],ls:15,made:15,mai:12,main:[14,15],manag:[1,12,13,15],manual:14,march:12,marketingteam:13,match:[4,15,16],match_with:[4,16],md:14,mean:[4,16],meta:12,method:[4,13],migrat:[12,14],min:12,minimum:14,mirror:15,misc:12,miscellan:12,mistakenli:14,mktemp:15,model:[4,5],modul:8,more:[4,12,13,14],most:15,multipl:13,must:13,mypi:12,myserv:13,myworkbook:16,naik:15,name:[1,4,5,13,16],need:13,next:12,none:[1,4,5,7,15,16],note:[12,13],now:12,numer:13,o:15,object:1,octob:12,offici:15,onc:15,one:[9,10,13,15],onli:[9,10,13,14],onlin:13,open:[1,13],oper:[1,2,9,10,12,13,14],optimis:14,option:[1,4,5,7,13],org:15,organ:[12,14],origin:15,otherwis:[1,14],out:1,owner:15,package_nam:15,package_vers:15,page:[1,15],pager:1,pagin:1,pair:13,parallel:13,param:4,paramet:[1,4,5,7,12,13,14,16],pars:1,parse_boolean:1,password:13,path:13,pattern:12,pem:13,pend:1,perform:[9,10],person:[12,13,14],personal_access_token:13,pgp:15,pgpk:15,pgpv:15,pip:[12,14,15],pleas:[5,8,15],poke:7,polici:14,portion:13,prepar:12,previou:15,primari:15,project:[13,16],provid:[13,15,16],provider_download_dir:15,push:[4,5],py3:15,py:16,pypi:[12,14],python:[1,4,5,7,12,14,15,16],query_job:1,quot:13,rc2:12,readm:14,receiv:[4,16],recommend:15,ref:[1,4,5,7],refactor:12,refer:[4,16],refresh:[4,5,9,10,16],refresh_tableau_workbook_block:16,relat:13,releas:[12,14],relev:15,remov:[12,14,15,16],repositori:14,resourc:[1,4],resource_nam:1,resources_method:4,rest:[1,13],rest_api:1,rest_api_ref:1,result:1,rsa:15,rtype:4,run:[13,14,15,16],s:[1,4,9,10,12,13,15,16],salesforc:12,same:13,sat:15,schedul:16,script:15,sdist:15,second:[1,4,5,9,10,16],see:[1,12,14],seealso:1,select:15,self:[1,4,5,7,15],sensor:2,sep:15,separ:12,septemb:12,sequenc:[7,12],server:[1,4,5,7,13,15,16],sever:13,sha512:15,sha:15,shasum:15,should:[1,4,5,13,15,16],sign:[1,15],signatur:15,sinc:[9,10],singl:13,site:[1,4,5,7,13,16],site_id:[1,4,5,7,13,16],so:13,softwar:15,sourc:[1,4,5,7,9,10,14,16],space:13,specif:12,specifi:13,sphinx:12,squelch:[12,14],ssl:[12,13,14],start_dat:12,state:[1,4,5,16],statu:[1,7],step:15,str:[1,4,5,7,16],string:[1,13],subject:12,succe:[9,10],succeed:7,success:1,successfulli:7,sum:15,support:[12,14],synchron:12,syntax:13,system:16,t:[1,9,10],tableau:[15,16],tableau_conn_id:[1,4,5,7,16],tableau_default:[1,4,5,7,13,16],tableau_job_statu:[2,6],tableau_refresh_workbook:[2,3],tableauhook:[1,12,14],tableaujobfailedexcept:1,tableaujobfinishcod:1,tableaujobstatussensor:7,tableauoper:[4,12],tableaurefreshworkbookoper:5,tableauservercli:[1,14],take:4,tar:15,target:1,target_st:1,target_statu:1,task:[4,5,7,9,10,13,16],task_id:16,task_refresh_workbook_block:[9,10,16],template_field:[7,12],temporari:15,test:16,test_run:[9,10],thei:13,therefor:13,thi:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],those:15,through:1,time:[1,4,5,13,16],tl:13,token:[12,13,14],token_nam:13,top:[14,15],trove:14,trust:15,tupl:13,two:[9,10,13],type:[1,5,7,12,13,14],typehint:12,unknown:15,until:[1,4,5,7,9,10,13,16],updat:12,upgrad:14,uri:[4,13],url:13,us:[1,4,5,8,12,13,15],usag:[12,14,16],user:[15,16],usernam:13,util:[5,7],val:1,valid:15,valu:[1,13],variabl:13,verifi:[12,13,14],version:[12,14,15],via:[14,15],wa:13,wai:13,wait:[1,4,5,9,10,12,16],wait_for_st:[1,12,14],want:[14,15],warn:[12,14,15],watch:7,wave:12,we:[9,10,13],well:15,when:[1,9,10,12,13],where:[1,4,5,7,16],whether:13,which:13,whl:15,why:[9,10,15],workbook:[1,4,5,7,9,10,16],workbook_nam:5,worri:15,wrongli:12,xcom:[4,5],you:[1,13,14,15],your:14},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>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.tableau.example_tableau</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.tableau.example_tableau_refresh_workbook</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.tableau</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":[12,14],"1":[12,14],"2":[12,14],"3":[12,14],"4":[12,14],"5":[12,14],"6":[12,14],"7":[12,14],"8":[12,14],"break":14,"class":[1,4,5,7],"default":13,"function":1,airflow:[0,1,2,3,4,5,6,7,8,12,14],apach:[12,14],attribut:4,authent:13,avail:16,bug:14,chang:14,changelog:14,commit:14,configur:13,connect:13,content:[1,4,5,7,9,10,14],example_tableau:9,example_tableau_refresh_workbook:10,featur:14,fix:14,from:15,hook:[0,1],id:13,instal:[14,15],integr:15,method:16,misc:14,modul:[1,4,5,7,9,10],oper:[3,4,5,16],packag:[12,14,15],provid:[0,1,2,3,4,5,6,7,8,9,10,11,12,14],pypi:15,refer:14,releas:15,requir:14,resourc:[14,16],sensor:[6,7,8],sourc:15,submodul:[0,3,6,11],subpackag:2,system:[9,10,11],tableau:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],tableau_job_statu:8,tableau_refresh_workbook:5,tableauoper:16,test:[9,10,11],us:16,verifi:15}})