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","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","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:{"2fyour_host":8,"class":[1,2,5,7],"default":[1,2,5],"enum":2,"export":[1,8],"function":1,"new":1,"return":[1,2,5,7],"true":[1,5,7],"try":1,For:[1,2,8],The:[1,2,5,7,8],Using:8,__enter__:2,__exit__:2,_auth_via_password:2,_auth_via_token:2,_get_workbook_by_nam:5,_refresh_workbook:5,_to_timestamp:1,accept:1,account:8,add:1,addit:1,address:8,airflow:8,airflow_conn_:8,airflow_conn_salesforce_default:8,airflowexcept:7,all:[1,2],allow:[1,2],alreadi:1,also:1,amount:1,ani:2,anoth:1,api:[2,5,7,9],applic:1,argument:1,arrai:1,associ:8,auth:2,authent:[2,5,7],author:2,automat:2,avail:1,backend:8,base:[1,2,5,7],basehook:[1,2],baseoper:5,basesensoroper:7,becom:1,being:1,belong:[2,5,7],benefici:1,block:5,bool:[1,5,7],can:[1,8],cancel:2,classmethod:1,cleanup:1,client:[2,5,7],cls:1,code:2,coerce_to_timestamp:1,column:1,com:[1,2,8],comma:1,commun:2,complet:7,conn_id:[1,8],conn_name_attr:2,conn_typ:2,connect:[1,2,5,7,9],contain:[1,2,5,7],context:[2,5,7],contextmanag:2,contextmgr:2,convert:1,creat:[1,8],credenti:[2,5,7],csv:1,current:[2,8],dag:9,data:1,databas:1,datafram:1,datetim:1,default_conn_nam:2,defin:1,delet:1,delimit:1,describe_object:1,descript:1,dict:[1,5,7],dictionari:8,differ:1,doc:[2,5,7],doe:8,doesn:1,domain:[1,8],don:2,dump:1,dure:[5,7],each:1,easier:1,element:1,email:8,environ:[1,8],error:2,especi:1,etc:8,exampl:[2,9],exc_tb:2,exc_typ:2,exc_val:2,except:7,execut:[5,7],extra:1,extract:5,fail:7,fals:[1,7],fetch:1,field:1,file:1,filenam:1,filter:8,finish:[2,5,7],flag:1,fmt:1,follow:8,forc:[1,8],format:1,from:1,gcp:8,get:[1,2],get_al:2,get_available_field:1,get_conn:[1,2],get_object_from_salesforc:1,github:[1,2,5,7],given:2,greatli:1,guid:9,handl:1,has:[1,5,7],hashicorp:8,help:2,hood:1,hook:3,hook_nam:2,host:8,htm:2,http:[1,2,5,7,8],includ:1,include_delet:1,index:1,indic:[2,7],instanc:[1,2],instead:1,item:2,iter:1,job:[2,5,7],job_id:7,json:[1,8],jwt:8,kwarg:[5,7],leav:1,left:1,lightn:8,like:1,line:1,list:1,log:1,login:8,look:1,maintain:1,make:1,make_queri:1,manag:[2,8],mark:1,mean:5,metadata:1,method:8,millisecond:1,mode:[1,8],model:[1,5],move:1,name:[1,2,5],ndjson:1,need:1,none:[1,2,5,7],obj:1,object:[1,2],object_to_df:1,one:8,onli:1,oper:[1,3],option:[1,2,5,7,8],origin:1,other:[1,8],out:[1,2],output:1,packag:1,page:2,pager:2,pagin:2,pain:1,panda:1,paramet:[1,2,5,7,8],pass:8,password:8,pend:2,poke:7,provid:8,pull:1,push:5,python:[2,5,7,9],queri:1,query_job:2,query_param:1,query_result:1,realli:1,reason:8,record:1,record_time_ad:1,ref:[5,7],refer:9,refresh:5,reli:1,repres:1,requir:[1,8],resourc:[2,9],resource_nam:2,rest:2,rest_api:2,rest_api_ref:2,result:[1,2],retriev:1,row:1,run:1,salesforcehook:1,same:1,sandbox:[1,8],save:1,schema:1,secret:8,secur:[1,8],security_token:[1,8],select:1,self:[1,2,5,7],sensor:3,separ:1,seri:1,server:[2,5,7],set:8,sfdc:1,should:[1,8],sign:[1,2],signific:1,simpl:1,simple_salesforc:1,site:[2,5,7],site_id:[2,5,7],some:1,sourc:[1,2,5,7],specifi:[1,8],sql:1,standard:8,statu:[2,7],store:1,str:[1,2,5,7],string:1,structur:1,succeed:7,success:2,successfulli:7,suggest:8,support:8,syntax:8,tableau:[0,3,5,7],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,task:[5,7],template_field:7,test:[1,8],thei:1,them:1,thi:[1,8],through:2,timestamp:1,token:[1,8],type:[1,2,5,7,8,9],underneath:1,uniform:1,unix:1,until:[5,7],uri:8,use:[1,8],used:[2,8],user:1,uses:1,utc:1,valu:1,variabl:8,vault:8,wai:1,wait:5,want:1,watch:7,were:1,when:[1,8],where:[1,2,5,7,8],which:1,work:[1,8],workbook:[2,5,7],workbook_id:5,workbook_nam:5,write:1,write_object_to_fil:1,written:1,xcom:5,you:[1,2,8],your:[1,8],your_host:8,your_password:8,your_security_token:1,your_token:8,your_usernam:8},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>","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,9],apach:9,configur:8,connect:8,content:[1,2,5,7,9],exampl:8,extra:8,field:8,hook:[0,1,2],modul:[1,2,5,7],oper:[4,5],provid:[0,1,2,3,4,5,6,7,9],salesforc:[0,1,2,3,4,5,6,7,8,9],sensor:[6,7],submodul:[0,4,6],subpackag:3,tableau:2,tableau_job_statu:7,tableau_refresh_workbook:5}})