Search.setIndex({docnames:["_api/airflow/providers/salesforce/hooks/index","_api/airflow/providers/salesforce/hooks/salesforce/index","_api/airflow/providers/salesforce/hooks/tableau/index","_api/airflow/providers/salesforce/index","_api/airflow/providers/salesforce/operators/index","_api/airflow/providers/salesforce/operators/tableau_refresh_workbook/index","_api/airflow/providers/salesforce/sensors/index","_api/airflow/providers/salesforce/sensors/tableau_job_status/index","commits","connections/salesforce","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["_api/airflow/providers/salesforce/hooks/index.rst","_api/airflow/providers/salesforce/hooks/salesforce/index.rst","_api/airflow/providers/salesforce/hooks/tableau/index.rst","_api/airflow/providers/salesforce/index.rst","_api/airflow/providers/salesforce/operators/index.rst","_api/airflow/providers/salesforce/operators/tableau_refresh_workbook/index.rst","_api/airflow/providers/salesforce/sensors/index.rst","_api/airflow/providers/salesforce/sensors/tableau_job_status/index.rst","commits.rst","connections/salesforce.rst","index.rst"],objects:{"airflow.providers":{salesforce:[3,0,0,"-"]},"airflow.providers.salesforce":{hooks:[0,0,0,"-"],operators:[4,0,0,"-"],sensors:[6,0,0,"-"]},"airflow.providers.salesforce.hooks":{salesforce:[1,0,0,"-"],tableau:[2,0,0,"-"]},"airflow.providers.salesforce.hooks.salesforce":{SalesforceHook:[1,1,1,""],log:[1,3,1,""]},"airflow.providers.salesforce.hooks.salesforce.SalesforceHook":{_to_timestamp:[1,2,1,""],describe_object:[1,2,1,""],get_available_fields:[1,2,1,""],get_conn:[1,2,1,""],get_object_from_salesforce:[1,2,1,""],make_query:[1,2,1,""],object_to_df:[1,2,1,""],write_object_to_file:[1,2,1,""]},"airflow.providers.salesforce.hooks.tableau":{TableauHook:[2,1,1,""],TableauJobFinishCode:[2,1,1,""]},"airflow.providers.salesforce.hooks.tableau.TableauHook":{__enter__:[2,2,1,""],__exit__:[2,2,1,""],_auth_via_password:[2,2,1,""],_auth_via_token:[2,2,1,""],conn_name_attr:[2,4,1,""],conn_type:[2,4,1,""],default_conn_name:[2,4,1,""],get_all:[2,2,1,""],get_conn:[2,2,1,""],hook_name:[2,4,1,""]},"airflow.providers.salesforce.hooks.tableau.TableauJobFinishCode":{CANCELED:[2,4,1,""],ERROR:[2,4,1,""],PENDING:[2,4,1,""],SUCCESS:[2,4,1,""]},"airflow.providers.salesforce.operators":{tableau_refresh_workbook:[5,0,0,"-"]},"airflow.providers.salesforce.operators.tableau_refresh_workbook":{TableauRefreshWorkbookOperator:[5,1,1,""]},"airflow.providers.salesforce.operators.tableau_refresh_workbook.TableauRefreshWorkbookOperator":{_get_workbook_by_name:[5,2,1,""],_refresh_workbook:[5,2,1,""],execute:[5,2,1,""]},"airflow.providers.salesforce.sensors":{tableau_job_status:[7,0,0,"-"]},"airflow.providers.salesforce.sensors.tableau_job_status":{TableauJobFailedException:[7,5,1,""],TableauJobStatusSensor:[7,1,1,""]},"airflow.providers.salesforce.sensors.tableau_job_status.TableauJobStatusSensor":{poke:[7,2,1,""],template_fields:[7,4,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","data","Python data"],"4":["py","attribute","Python attribute"],"5":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:data","4":"py:attribute","5":"py:exception"},terms:{"00642a46d":8,"008035450":8,"0a0e1af80":8,"0b0e4f7a4":8,"0b2":8,"0beta1":8,"10097":8,"10163":8,"10205":8,"10483":8,"10528":8,"10543":8,"11032":8,"11135":8,"11238":8,"11242":8,"11249":8,"11447":8,"11448":8,"11487":8,"11688":8,"11826":8,"11855":8,"12082":8,"12206":8,"12212":8,"12304":8,"12366":8,"12390":8,"12444":8,"12449":8,"12466":8,"12558":8,"12917":8,"12955":8,"12af6a080":8,"12c5e5d8a":8,"13148":8,"13380":8,"13717":8,"13732":8,"13767":8,"16e712971":8,"1d36b0303":8,"2020":[8,10],"2021":8,"2037303ee":8,"23rc1":8,"24c8e4c2d":8,"295d66f91":8,"2a1":8,"2fyour_host":9,"31efc931":8,"32971a1a2":8,"3320e432a":8,"349b0811c":8,"3696c34c2":8,"375d1ca22":8,"3fd5ef355":8,"45669bea4":8,"4e8f9cc8d":8,"5220e4c38":8,"59eb5de78":8,"5a439e84":8,"6140356b8":8,"61a8bb658":8,"6481":8,"6515":8,"6644":8,"6708":8,"6714":8,"6790":8,"6817":8,"6879":8,"6889a333c":8,"6cf76d7ac":8,"7265":8,"7330":8,"7338":8,"7410":8,"7500":8,"7517":8,"7703":8,"7824":8,"7825e8f59":8,"7857":8,"7d24b088c":8,"8170":8,"8565":8,"85a18e13d":8,"8644":8,"872b1566a":8,"87969a350":8,"8807":8,"8886":8,"8891":8,"8898":8,"8984":8,"8994":8,"8c42cf1b0":8,"9026":8,"92585ca4c":8,"9320":8,"9370":8,"9404":8,"9408":8,"954619283":8,"9550":8,"97a429f9d":8,"9985":8,"9b39f2478":8,"case":10,"class":[1,2,5,7,8,10],"default":[1,2,5,8],"enum":2,"export":[1,9],"final":8,"function":1,"import":8,"new":[1,8,10],"return":[1,2,5,7,8],"super":8,"switch":8,"true":[1,5,7],"try":1,Added:8,For:[1,2,8,9],The:[1,2,5,7,9],Use:8,Using:9,__enter__:2,__exit__:2,_auth_via_password:2,_auth_via_token:2,_get_workbook_by_nam:5,_refresh_workbook:5,_to_timestamp:1,a9ac2b040:8,a9ad0a929:8,about:8,ac2f72c98:8,accept:1,account:9,add:[1,8,10],addit:1,address:9,ae7cb4a1:8,aeea71274:8,aip:8,airflow:9,airflow_conn_:9,airflow_conn_salesforce_default:9,airflowexcept:7,all:[1,2,8,10],allow:[1,2],alreadi:1,also:1,amount:1,ani:2,anoth:1,api:[2,5,7,8,10],applic:1,arg:8,argument:[1,8],arrai:1,associ:9,auth:2,authent:[2,5,7],author:2,auto:8,autom:8,automat:2,avail:1,b2a28d159:8,b40dffa08:8,backend:9,backport:8,base:[1,2,5,7],basehook:[1,2],baseoper:5,basesensoroper:7,basic:8,batch:8,becom:1,been:10,being:1,belong:[2,5,7],benefici:1,black:8,block:5,bool:[1,5,7],broken:8,bug:8,build:8,bump:8,c34ef853c:8,c42a375e7:8,c7e5bce57:8,ca4238eb4:8,call:8,can:[1,9,10],cancel:2,candid:8,cdec30125:8,cf141506a:8,chang:8,changelog:8,check:8,choic:10,classmethod:1,cleanup:[1,8],client:[2,5,7],cls:1,code:2,coerce_to_timestamp:1,column:1,com:[1,2,9],come:8,comma:1,command:[8,10],comment:8,commit:[8,10],commun:2,complet:7,conn_id:[1,9],conn_name_attr:2,conn_typ:2,connect:[1,2,5,7,8,10],constructor:8,contain:[1,2,5,7],context:[2,5,7],contextmanag:2,contextmgr:2,convert:1,correct:8,coverag:8,creat:[1,9],credenti:[2,5,7],cross:8,csv:1,current:[2,9],d0e7db402:8,d200:8,d202:8,d305876be:8,dag:[8,10],data:1,databas:1,datafram:[1,8],datetim:1,default_arg:8,default_conn_nam:2,defin:1,delet:1,delimit:1,depend:[8,10],deprec:10,describe_object:1,descript:1,detail:[8,10],dev:8,dict:[1,5,7,8],dictionari:9,differ:1,discoveri:8,doc:[2,5,7,8],document:[8,10],doe:[9,10],doesn:1,domain:[1,9],don:2,downgrad:10,dump:1,dure:[5,7],dynam:8,each:1,easier:1,ee7ca128a:8,either:10,element:1,email:9,enabl:8,environ:[1,9],error:[2,8,10],especi:1,etc:9,exampl:[2,10],example_dag:8,exc_tb:2,exc_typ:2,exc_val:2,except:7,execut:[5,7],exist:10,extra:[1,10],extract:5,f3521fb0e:8,f3e87c503:8,f6bd817a3:8,face:8,fail:[7,8],fals:[1,7],fdd9b6f65:8,featur:8,fetch:1,ff342fc23:8,field:[1,8],file:[1,8,10],filenam:1,filter:9,finish:[2,5,7],fix:8,flag:1,flynt:8,fmt:1,follow:9,forc:[1,9],form:8,format:1,formmatt:8,fresh:8,from:[1,8],gcp:9,gener:8,get:[1,2,8],get_al:2,get_available_field:1,get_conn:[1,2],get_object_from_salesforc:1,github:[1,2,5,7],given:2,grammar:8,greatli:1,guid:10,handl:1,has:[1,5,7,10],hash:8,hashicorp:9,help:2,high:8,hood:1,hook:[3,8],hook_nam:2,host:9,htm:2,http:[1,2,5,7,9],implement:8,improv:8,includ:[1,8],include_delet:1,increas:8,index:1,indic:[2,7],info:8,inform:8,initi:10,instal:8,instanc:[1,2],instead:1,integr:8,introduc:8,item:2,iter:1,job:[2,5,7],job_id:7,json:[1,9],jwt:9,keep:8,kwarg:[5,7],latest:8,lazi:8,lead:10,leav:1,left:1,legaci:10,level:8,lightn:9,like:1,line:1,link:8,list:[1,8,10],load:8,log:[1,8],logger:8,login:9,logo:8,look:1,magic:8,maintain:1,make:1,make_queri:1,manag:[2,9],mark:1,markdown:8,match:8,mean:5,metadata:1,method:[8,9],might:10,millisecond:1,miss:8,mode:[1,9],model:[1,5],modul:8,month:8,move:[1,8],name:[1,2,5,8],ndjson:1,need:[1,10],none:[1,2,5,7,8],note:8,novemb:10,number:8,obj:1,object:[1,2],object_to_df:1,octob:8,one:9,onli:[1,8],oper:[1,3,8],option:[1,2,5,7,9,10],order:10,origin:1,other:[1,9],out:[1,2,8],output:1,packag:1,page:[2,8],pager:2,pagin:2,pain:1,panda:1,paramet:[1,2,5,7,8,9],pass:9,password:9,path:8,pend:2,per:8,pip:8,point:8,poke:7,prepar:8,project:8,provid:9,pull:1,push:5,pydocstyl:8,pypi:[8,10],python:[2,5,7,8,10],pyupgrad:8,queri:1,query_job:2,query_param:1,query_result:1,rc3:8,readm:[8,10],realli:1,reason:9,record:1,record_time_ad:1,redund:8,ref:[5,7,8],refer:[8,10],refernc:8,refresh:5,regener:8,relas:8,releas:[8,10],reli:1,rema:8,remain:8,remov:8,renam:8,repositori:10,repres:1,requir:[1,9],resolv:10,resourc:[2,10],resource_nam:2,rest:2,rest_api:2,rest_api_ref:2,result:[1,2],retriev:1,row:1,run:1,salesforcehook:[1,8],same:1,sandbox:[1,9],save:1,schema:1,script:8,secret:9,secur:[1,9],security_token:[1,9],see:8,select:1,self:[1,2,5,7],sensor:[3,8],separ:[1,8],seri:1,server:[2,5,7],servic:8,set:[8,9],setup:8,sfdc:1,should:[1,9],sign:[1,2],signatur:8,signific:1,simpl:[1,8,10],simple_salesforc:1,site:[2,5,7],site_id:[2,5,7],some:1,sourc:[1,2,5,7],specifi:[1,9],sql:1,standard:9,start_dat:8,statu:[2,7],stop:8,store:1,str:[1,2,5,7],string:[1,8],structur:1,subject:8,succeed:7,success:2,successfulli:7,suggest:9,support:[8,9],syntax:9,tableau:[0,3,5,7,8],tableau_conn_id:[2,5,7],tableau_default:[2,5,7],tableau_hook:5,tableau_job_statu:[3,6],tableau_refresh_workbook:[3,4],tableauhook:[2,5],tableaujobfailedexcept:7,tableaujobfinishcod:2,tableaujobstatussensor:7,tableaurefreshworkbookoper:5,tableauservercli:[2,10],task:[5,7],template_field:7,test:[1,9],thei:1,them:1,thi:[1,8,9,10],through:2,timestamp:1,toc:8,token:[1,9],tool:8,top:10,transfer:8,type:[1,2,5,7,8,9,10],typo:8,underneath:1,uniform:1,uniqu:8,unix:1,until:[5,7],untouch:8,updat:[8,10],upgrad:[8,10],uri:9,use:[1,8,9,10],used:[2,9],user:[1,8],uses:1,using:8,utc:1,utf:8,valu:1,variabl:9,vault:9,version:[8,10],via:10,wai:1,wait:5,want:1,warn:8,watch:7,were:1,when:[1,9],where:[1,2,5,7,9],which:1,word:8,work:[1,9,10],workbook:[2,5,7],workbook_id:5,workbook_nam:5,write:1,write_object_to_fil:1,written:1,wrong:8,wrongli:8,xcom:5,yet:10,you:[1,2,9,10],your:[1,9,10],your_host:9,your_password:9,your_security_token:1,your_token:9,your_usernam:9},titles:["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.salesforce.hooks</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.salesforce.hooks.salesforce</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.salesforce.hooks.tableau</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.salesforce</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.salesforce.operators</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.salesforce.operators.tableau_refresh_workbook</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.salesforce.sensors</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.salesforce.sensors.tableau_job_status</span></code>","Package apache-airflow-providers-salesforce","Salesforce Connection","<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-salesforce</span></code>"],titleterms:{airflow:[0,1,2,3,4,5,6,7,8,10],apach:[8,10],changelog:10,configur:9,connect:9,content:[1,2,5,7,10],exampl:9,extra:9,field:9,hook:[0,1,2],instal:10,modul:[1,2,5,7],oper:[4,5],packag:[8,10],pip:10,provid:[0,1,2,3,4,5,6,7,8,10],requir:10,salesforc:[0,1,2,3,4,5,6,7,8,9,10],sensor:[6,7],submodul:[0,4,6],subpackag:3,tableau:2,tableau_job_statu:7,tableau_refresh_workbook:5}})