blob: 603f02a0c3368606836e98951081337b9d7aabdb [file] [log] [blame]
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","installing-providers-from-sources"],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","installing-providers-from-sources.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,4,1,""]},"airflow.providers.salesforce.hooks.salesforce.SalesforceHook":{conn_name_attr:[1,2,1,""],conn_type:[1,2,1,""],default_conn_name:[1,2,1,""],describe_object:[1,3,1,""],get_available_fields:[1,3,1,""],get_conn:[1,3,1,""],get_connection_form_widgets:[1,3,1,""],get_object_from_salesforce:[1,3,1,""],get_ui_field_behaviour:[1,3,1,""],hook_name:[1,2,1,""],make_query:[1,3,1,""],object_to_df:[1,3,1,""],write_object_to_file:[1,3,1,""]},"airflow.providers.salesforce.operators":{tableau_refresh_workbook:[5,0,0,"-"]},"airflow.providers.salesforce.sensors":{tableau_job_status:[7,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"],"4":["py","data","Python data"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method","4":"py:data"},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,"14013":8,"14030":8,"14487":8,"14886":8,"15667":10,"16294":8,"16405":8,"16464":8,"16501":8,"16682":8,"16e712971":8,"17015":8,"17116":8,"17162":[8,10],"17272":8,"17399":[8,10],"17682":8,"1d36b0303":8,"1fba5402b":8,"2020":8,"2021":[8,11],"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,"406f":11,"45669bea4":8,"45e72ca83":8,"4d3a":11,"4dc622d8c":8,"4e8f9cc8d":8,"512":11,"5220e4c38":8,"589d6dec9":8,"59eb5de78":8,"5a439e84":8,"5c0e98cc7":8,"5c6e":11,"6140356b8":8,"61a8bb658":8,"6481":8,"6515":8,"6644":8,"6674":11,"6708":8,"6714":8,"6790":8,"6817":8,"6879":8,"6889a333c":8,"68e4c4dcb":8,"6cf76d7ac":8,"7265":8,"7330":8,"7338":8,"7410":8,"7500":8,"7517":8,"763919d41":8,"76ed2a49c":8,"7703":8,"7824":8,"7825e8f59":8,"7857":8,"7d24b088c":8,"8170":8,"8565":8,"85a18e13d":8,"8644":8,"866a601b7":8,"872b1566a":8,"87969a350":8,"87f408b1e":8,"8807":8,"8886":8,"8891":8,"8898":8,"88bdcfa0d":8,"8984":8,"8994":8,"8c42cf1b0":8,"8ec4":11,"9026":8,"92585ca4c":8,"9320":8,"9370":8,"9404":8,"9408":8,"954619283":8,"9550":8,"97a429f9d":8,"9985":8,"9b39f2478":8,"9c94b72d4":8,"class":[1,8,10],"default":[1,8,9],"export":[1,9],"final":8,"function":1,"import":[8,10,11],"new":[1,8],"return":[1,8],"static":1,"super":8,"switch":8,"true":1,"try":1,Added:8,Adding:[8,10],For:[1,8,9,10,11],The:[1,9,10,11],There:11,Use:[8,9],Using:9,a9ac2b040:8,a9ad0a929:8,about:[8,11],abov:11,ac2f72c98:8,accept:1,access:[1,9],account:9,add:[1,8],addit:1,addition:10,address:9,ae7cb4a1:8,aeea71274:8,after:8,aip:8,airflow:11,airflow_conn_:9,airflow_conn_salesforce_default:9,aka:11,all:[1,8,10],allow:1,alreadi:[1,11],also:[1,9,11],amount:1,ani:11,anoth:1,apach:11,apache_airflow_providers_salesforc:11,api:[8,9,10],appli:10,apply_default:10,arg:8,argument:[1,8],arrai:1,asc:[10,11],associ:9,attempt:9,authent:[1,9],auto:[8,10],autom:8,automat:10,avail:[1,11],b2a28d159:8,b40dffa08:8,b916b7507:8,ba4b:11,backend:9,backport:8,base:1,basehook:1,bash:11,basic:8,batch:8,bbc627a3d:8,be75dcd39:8,becom:1,behaviour:1,being:1,belong:11,below:11,benefici:1,bin:11,binari:11,black:8,bool:1,both:9,broken:8,bst:11,bug:8,buggfix:8,build:[8,11],bump:8,c34ef853c:8,c42a375e7:8,c7e5bce57:8,ca4238eb4:8,call:[8,9],can:[1,10,11],candid:8,cbf8001d7:8,cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:11,cde1:11,cdec30125:8,certif:11,certifi:11,cf141506a:8,chang:8,changelog:8,chapter:11,check:[8,11],checksum:[10,11],choos:11,cleanup:[1,8],client:9,code:11,coerce_to_timestamp:1,com:[1,9,11],come:8,comma:1,command:8,comment:8,commit:[8,10],common:9,complet:10,conn_id:[1,9],conn_name_attr:1,conn_typ:1,connect:[1,8,10],constructor:8,consum:[1,9],contain:[1,11],convert:1,correct:[8,11],coverag:8,creat:[1,9,11],cross:8,csv:1,curl:11,custom:[1,8,10],d0e7db402:8,d200:8,d202:8,d305876be:8,d7de:11,dag:[8,10],data:[1,8],databas:1,datafram:[1,8],datetim:1,decor:10,default_arg:8,default_conn_nam:1,delet:1,delimit:1,dep:11,depend:8,deprec:10,describ:11,describe_object:1,descript:[1,8],dest:11,detail:[8,10,11],dev:8,dict:[1,8],diff:11,differ:[1,11],direct:[1,8,9,10],directori:11,discoveri:8,distribut:11,doc:8,document:[8,10],doesn:1,domain:[1,9],done:10,down:11,download:11,drop:11,due:10,dump:1,dynam:8,e08a:11,each:1,easier:1,ecf4:11,echo:11,ee7ca128a:8,either:1,element:1,email:9,enabl:[1,8],enter:1,environ:[1,9],error:8,especi:1,essenti:11,etc:9,exampl:[9,10,11],example_dag:8,exist:10,expos:1,extra:[1,9,10],f3521fb0e:8,f3e87c503:8,f6bd817a3:8,face:8,fail:8,fals:1,fdd9b6f65:8,featur:[1,8],fetch:1,ff342fc23:8,field:[1,8],file:[1,8,9,10,11],filenam:1,filter:[1,8,9,10],fingerprint:11,first:10,fix:8,flag:1,flynt:8,fmt:1,folder:11,follow:[9,11],forc:[1,9],form:[1,8],format:1,formmatt:8,foundat:11,fresh:8,from:[1,8,10],full:9,gcp:9,gener:[8,9],get:[1,8,10,11],get_available_field:1,get_conn:1,get_connection_form_widget:1,get_object_from_salesforc:1,get_ui_field_behaviour:1,github:1,given:1,gmail:11,good:11,gpg:11,grammar:8,greatli:1,guid:[10,11],handl:1,has:1,hash:8,hashicorp:9,have:10,high:8,hood:1,hook:[3,8],hook_nam:1,how:11,http:[1,9,11],implement:8,improv:8,includ:[1,8],include_delet:1,increas:8,indic:11,individu:8,info:8,inform:8,initi:10,instal:8,instanc:[1,9],instead:1,instruct:11,integr:[8,10],introduc:8,issuer:11,iter:1,json:1,juli:8,june:8,jwt:[1,8,9,10],kaxil:11,kaxilnaik:11,keep:8,kei:[1,9,11],know:11,latest:8,lazi:8,lazili:8,least:10,leav:1,left:[1,11],level:8,lightn:9,like:1,line:1,link:[8,11],list:[1,8,10],load:8,local:[9,11],log:[1,8],logger:8,login:[8,9,10],logo:8,look:1,made:11,magic:8,main:11,make:1,make_queri:1,manag:[8,9,11],manual:10,map:9,mark:1,markdown:8,match:[8,11],meta:8,metadata:1,method:8,might:10,migrat:10,millisecond:1,mirror:11,miss:8,mktemp:11,model:1,modul:8,month:8,more:8,most:11,move:[1,8,10],na1:9,naik:11,name:[1,8,9],ndjson:1,necessari:9,need:[1,9,10],next:8,none:[1,8,11],note:8,number:8,oauth:[1,9],obj:1,object:1,object_to_df:1,octob:8,offici:11,onc:11,one:[9,11],onli:[1,8],oper:[1,3,8],optimis:10,option:[1,9],order:10,org:11,organ:[1,9],origin:11,other:1,otherwis:[1,10],our:8,out:[1,8],output:1,owner:11,packag:1,package_nam:11,package_vers:11,page:[8,11],pain:1,panda:1,paramet:[1,8,9],pass:9,password:[1,9],path:[1,8,9],per:8,pgp:11,pgpk:11,pgpv:11,pip:[8,11],pleas:11,point:8,prepar:8,previou:11,primari:11,privat:[1,9],project:8,provid:[9,11],provider_download_dir:11,proxi:9,pull:1,py3:11,pydocstyl:8,pylint:8,pypi:[8,10],python:[8,10,11],pyupgrad:8,queri:1,query_param:1,query_result:1,rc2:8,rc3:8,readm:[8,10],realli:1,reason:9,recommend:11,record:1,record_time_ad:1,redund:8,ref:8,refer:[8,10],regener:8,relas:8,releas:[8,10],relev:11,reli:1,remain:8,remov:[8,10,11],renam:8,repositori:10,repres:1,request:1,requir:1,resourc:10,result:1,retriev:1,row:1,rsa:11,run:[1,10,11],salesforc:11,salesforce_conn_id:1,salesforce_default:1,salesforcehook:[1,8,9,10],salesforcetos3oper:[8,10],same:1,sandbox:1,sat:11,save:1,schema:1,scheme:9,script:[8,11],sdist:[10,11],secret:9,secur:[1,9],security_token:9,see:8,select:[1,11],self:[1,11],sensor:[3,8],sep:11,separ:[1,8,10],server:[9,11],servic:8,session:[1,8,9,10],session_id:[1,9],set:8,setup:8,sever:[1,9],sfdc:1,sha512:[10,11],sha:11,shasum:11,should:[1,9,11],sign:[1,9,11],signatur:[8,10,11],signific:1,simpl:[1,8,10],simple_salesforc:1,site:10,softwar:11,some:1,sourc:[1,10],specifi:[1,9,10],sql:1,standard:9,start_dat:8,step:11,stop:8,store:1,str:1,string:[1,8],subject:8,suggest:9,sum:11,support:[8,10],synchron:8,syntax:9,tableau:[0,3,8,10],tableau_job_statu:[3,6],tableau_refresh_workbook:[3,4],tableauservercli:10,tar:11,temporari:11,test:[1,9],thei:1,them:[1,10],thi:[1,8,9,10,11],thing:10,those:[10,11],tied:9,timestamp:1,toc:8,token:[1,9],tool:8,toolchain:8,top:[10,11],transfer:8,trust:11,type:[1,8,9,10],typo:8,underneath:1,uniform:1,uniqu:8,unix:1,unknown:11,untouch:8,updat:[8,10],upgrad:[8,10],uri:9,url:[1,9],use:[1,8,9,10,11],used:[9,11],user:[8,9,11],usernam:[1,9],uses:1,using:[8,9,11],utc:1,utf:8,valid:11,valu:[1,9],variabl:9,vault:9,verifi:10,version:[8,9,10,11],via:[1,9,10,11],wai:1,want:[1,10,11],warn:[8,10,11],wave:8,well:11,were:1,wheel:10,when:[1,9,10],where:[1,9],which:1,whl:11,why:11,widget:1,word:8,work:[1,10],worri:11,write:1,write_object_to_fil:1,written:1,wrong:8,wrongli:8,you:[1,9,10,11],your:[1,9,10],your_password:9,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>","Installing from sources"],titleterms:{"break":10,airflow:[0,1,2,3,4,5,6,7,8,10],apach:[8,10],chang:10,changelog:10,configur:9,connect:9,content:[1,10],cross:10,depend:10,download:10,featur:10,from:11,hook:[0,1,2],instal:[10,11],integr:11,misc:10,modul:1,offici:10,oper:[4,5],packag:[8,10,11],pip:10,provid:[0,1,2,3,4,5,6,7,8,10],pypi:11,releas:11,requir:10,salesforc:[0,1,2,3,4,5,6,7,8,9,10],sensor:[6,7],sourc:11,submodul:[0,4,6],subpackag:3,tableau:2,tableau_job_statu:7,tableau_refresh_workbook:5,verifi:11}})