blob: 5e171a1bf23f212f3495b8fc6fdcbf152fe3410e [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/salesforce_apex_rest/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","operators/index","operators/salesforce_apex_rest"],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/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/salesforce_apex_rest/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","operators/index.rst","operators/salesforce_apex_rest.rst"],objects:{"airflow.providers":[[3,0,0,"-","salesforce"]],"airflow.providers.salesforce":[[0,0,0,"-","hooks"],[4,0,0,"-","operators"],[7,0,0,"-","sensors"]],"airflow.providers.salesforce.hooks":[[1,0,0,"-","salesforce"],[2,0,0,"-","tableau"]],"airflow.providers.salesforce.hooks.salesforce":[[1,1,1,"","SalesforceHook"],[1,4,1,"","log"]],"airflow.providers.salesforce.hooks.salesforce.SalesforceHook":[[1,2,1,"","conn"],[1,3,1,"","conn_name_attr"],[1,3,1,"","conn_type"],[1,3,1,"","default_conn_name"],[1,2,1,"","describe_object"],[1,2,1,"","get_available_fields"],[1,2,1,"","get_conn"],[1,2,1,"","get_connection_form_widgets"],[1,2,1,"","get_object_from_salesforce"],[1,2,1,"","get_ui_field_behaviour"],[1,3,1,"","hook_name"],[1,2,1,"","make_query"],[1,2,1,"","object_to_df"],[1,2,1,"","write_object_to_file"]],"airflow.providers.salesforce.operators":[[5,0,0,"-","salesforce_apex_rest"],[6,0,0,"-","tableau_refresh_workbook"]],"airflow.providers.salesforce.operators.salesforce_apex_rest":[[5,1,1,"","SalesforceApexRestOperator"]],"airflow.providers.salesforce.operators.salesforce_apex_rest.SalesforceApexRestOperator":[[5,2,1,"","execute"]],"airflow.providers.salesforce.sensors":[[8,0,0,"-","tableau_job_status"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","data","Python data"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:data"},terms:{"0":[0,1,2,3,4,5,6,7,8,10,12,13,14],"00":14,"00642a46d":9,"008035450":9,"01":9,"02":9,"03":9,"04":[9,14],"05":9,"06":9,"07":9,"08":9,"09":9,"0a0e1af80":9,"0a6858847":9,"0b0e4f7a4":9,"0b2":9,"0beta1":9,"10":[9,11],"10097":9,"10163":9,"10205":9,"10483":9,"10528":9,"10543":9,"11":[9,12],"11032":9,"11135":9,"11238":9,"11242":9,"11249":9,"11447":9,"11448":9,"11487":9,"11688":9,"11826":9,"11855":9,"12":[9,12],"12082":9,"12206":9,"12212":9,"12304":9,"12345":14,"12366":9,"12390":9,"12444":9,"12449":9,"12466":9,"12558":9,"12917":9,"12955":9,"12af6a080":9,"12c5e5d8a":9,"13":9,"13148":9,"13380":9,"13717":9,"13732":9,"13767":9,"14":9,"14013":9,"14030":9,"14487":9,"14886":9,"15":9,"15667":11,"15z":14,"16":9,"16294":9,"16405":9,"16464":9,"16501":9,"16682":9,"16adc035b":9,"16e712971":9,"17":[9,11],"17015":9,"17116":9,"17162":[9,11],"17272":9,"17399":[9,11],"17682":9,"17890":9,"18":9,"18819":[9,11],"19":9,"19321":9,"19530":[9,11],"19882":9,"1d36b0303":9,"1fba5402b":9,"2":[0,1,2,3,4,5,6,7,8,10,12,13,14],"20":9,"2014":14,"2020":9,"2021":[9,12],"2022":9,"20226":9,"20325":9,"2037303ee":9,"20523":9,"20565":9,"20614":9,"20951":9,"21":9,"21074":[9,11],"21257":9,"21439":9,"21t13":14,"22":9,"22056":9,"22226":9,"22382":11,"22383":9,"23":9,"23353":[9,11],"23rc1":9,"24":9,"24c8e4c2d":9,"25":9,"26":9,"27":9,"28":9,"29":9,"295d66f91":9,"2a1":9,"2f":10,"2fb5e1d0":9,"2fyour_host":10,"3":[0,1,2,3,4,5,6,7,8,10,12,13,14],"30":9,"31":9,"31efc931":9,"32971a1a2":9,"3320e432a":9,"349b0811c":9,"3696c34c2":9,"375d1ca22":9,"3a":10,"3fd5ef355":9,"4":[0,1,2,3,4,5,6,7,8,10,12,13,14],"406f":12,"45669bea4":9,"45e72ca83":9,"49":12,"4d3a":12,"4dc622d8c":9,"4e8f9cc8d":9,"512":12,"5220e4c38":9,"54":12,"589d6dec9":9,"59eb5de78":9,"5a439e84":9,"5c0e98cc7":9,"5c6e":12,"6":9,"602abe839":9,"6140356b8":9,"61a8bb658":9,"6481":9,"6515":9,"6644":9,"6674":12,"6708":9,"6714":9,"6790":9,"6817":9,"6879":9,"6889a333c":9,"68e4c4dcb":9,"6c3a67d4f":9,"6cf76d7ac":9,"7265":9,"7330":9,"7338":9,"7410":9,"7500":9,"7517":9,"763919d41":9,"76ed2a49c":9,"7703":9,"7824":9,"7825e8f59":9,"7857":9,"7d24b088c":9,"8":9,"8170":9,"853576d90":9,"8565":9,"85a18e13d":9,"8644":9,"866a601b7":9,"872b1566a":9,"87969a350":9,"87f408b1e":9,"8807":9,"8886":9,"8891":9,"8898":9,"88bdcfa0d":9,"8984":9,"8994":9,"8c42cf1b0":9,"8ec4":12,"9026":9,"9132baf19":9,"92585ca4c":9,"92bc8047c":9,"9320":9,"9370":9,"9404":9,"9408":9,"954619283":9,"9550":9,"97496ba2b":9,"97a429f9d":9,"9985":9,"9b39f2478":9,"9c94b72d4":9,"class":[9,11],"default":[1,5,9,10],"do":[1,9,11,12],"export":[1,10],"final":9,"function":1,"import":[9,11,12],"new":[1,9],"return":[1,5,9],"static":1,"super":9,"switch":9,"true":1,"try":1,A:[1,5,10],By:[1,12],For:[1,5,9,10,11,12],If:[1,10,11,12],It:12,The:[1,5,10,11,12],There:12,To:12,a0821235f:9,a24066bc4:9,a9ac2b040:9,a9ad0a929:9,about:[9,12,14],abov:12,ac2f72c98:9,accept:1,access:[1,10],account:10,action:[5,14],activ:14,ad:[9,11],add:[1,9,11],addit:1,addition:11,address:10,ae7cb4a1:9,aeea71274:9,after:9,aip:9,airflow:[12,14],airflow_conn_:10,airflow_conn_salesforce_default:10,aka:12,all:[1,9,11],allow:1,alreadi:12,also:[1,10,12,14],amount:1,an:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],ani:12,anoth:1,apach:12,apache_airflow_providers_salesforc:12,apex:[5,14],apex_oper:14,apex_task:14,apexrest:14,api:[5,9,10,11],appli:11,apply_default:11,ar:[1,10,11,12],arg:9,argument:[1,9],arrai:1,asc:[11,12],associ:10,attempt:10,august:9,authent:[1,10],auto:[9,11],autoapi:9,autom:9,automat:11,avail:[1,12],b2a28d159:9,b40dffa08:9,b916b7507:9,ba4b:12,backend:10,backport:9,base:[1,5],basehook:1,baseoper:5,bash:12,basic:9,batch:9,bbc627a3d:9,be75dcd39:9,becom:1,behaviour:1,being:1,belong:12,below:12,benefici:1,bin:12,binari:12,black:9,bodi:14,bool:1,both:10,broken:9,bst:12,bug:9,bugfix:9,buggfix:9,build:[9,12],bump:9,c34ef853c:9,c42a375e7:9,c7e5bce57:9,ca4238eb4:9,cach:1,cached_properti:9,call:[9,10,14],can:[1,11,12,14],candid:9,cb7305321:9,cbf8001d7:9,cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:12,cde1:12,cdec30125:9,certif:12,certifi:12,cf141506a:9,chang:9,changelog:9,chapter:12,check:[9,12],checksum:[11,12],choos:12,ci:9,classifi:[9,11],cleanup:[1,9],client:10,code:[12,14],coerce_to_timestamp:1,com:[1,10,12,14],come:9,comma:1,command:9,comment:9,commit:9,common:10,compat:9,complet:11,conn:1,conn_id:[1,10],conn_name_attr:1,conn_typ:1,connect:[1,5,9,11],constructor:9,consum:[1,10],contain:[1,12],content:14,context:[5,9],convert:1,correct:[9,12],coverag:9,creat:[1,10,12],cross:9,csv:1,curl:12,custom:[1,9,11,14],d0e7db402:9,d200:9,d202:9,d305876be:9,d7dbfb7e2:9,d7de:12,d94fa3783:9,d9567eb10:9,d:12,dag:[9,11],data:[1,9],databas:1,datafram:[1,9],datetim:1,db:[10,11],decemb:9,declar:9,decor:11,default_arg:9,default_conn_nam:1,delai:9,delet:1,delimit:1,dep:12,depend:9,deprec:11,describ:12,describe_object:1,descript:[1,9],dest:12,detail:[9,11,12],dev0:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],dev:9,develop:14,dict:[1,5,9],diff:12,differ:[1,12],direct:[1,9,10,11],directori:12,discoveri:9,distribut:12,doc:9,document:[9,11],doesn:1,domain:[1,10],done:11,down:12,download:12,drop:12,due:11,dump:[1,14],dure:5,dynam:9,e08a:12,e9a72a4e9:9,e:10,each:1,easier:1,ecf4:12,echo:12,ee7ca128a:9,either:1,element:1,email:10,enabl:[1,9],encod:14,endpoint:[5,14],enter:1,environ:[1,10],error:9,especi:1,essenti:12,etc:10,everywher:9,exampl:[10,11,12],example_dag:[9,14],example_salesforce_apex_rest:14,execut:[5,14],exist:11,experiment:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],expos:1,extra:[1,9,10,11],f3521fb0e:9,f3e87c503:9,f5b96315f:9,f6bd817a3:9,f77417eb0:9,f:9,face:9,fail:9,fals:1,fdd9b6f65:9,featur:[0,1,2,3,4,5,6,7,8,9,10,12,13,14],feb:9,fetch:1,ff342fc23:9,field:[1,9],file:[1,9,10,11,12],filenam:1,filter:[1,9,10,11],fingerprint:12,first:11,fix:9,flag:1,flynt:9,fmt:1,folder:12,follow:[10,12],forc:[1,10,14],form:[1,9],format:1,formmatt:9,foundat:12,framework:11,fresh:9,from:[1,9,11],full:10,gcp:10,gener:[9,10],get:[1,5,9,11,12],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:12,good:12,gpg:12,grammar:9,greatli:1,guid:[5,12,14],gz:12,ha:1,handl:1,hash:9,hashicorp:10,have:11,high:9,hood:1,hook:[3,9],hook_nam:1,how:[5,12],http:[1,5,10,12,14],i:[10,12],id:[1,5,10,12],implement:9,improv:9,includ:[1,9],include_delet:1,increas:9,indic:12,individu:9,info:9,inform:[5,9],initi:11,instal:9,install_requir:11,instanc:[1,10,14],instead:1,instruct:12,integr:[9,11],introduc:9,ip:[1,9,10,11],issuer:12,iter:1,januari:9,json:[1,14],juli:9,june:9,jwt:[1,9,10,11],k8:9,ka:12,kaxil:12,kaxilnaik:12,keep:9,kei:[1,10,12],know:12,kwarg:5,l:12,la:12,latest:9,lazi:9,lazili:9,least:11,leav:1,left:[1,12],level:9,librari:14,lightn:10,like:1,line:[1,9],link:[9,12],list:[1,9,11],load:9,local:[10,12],log:[1,9],logger:9,login:[9,10,11],logo:9,look:[1,5],ls:12,made:12,magic:9,main:12,make:[1,5],make_queri:1,manag:[9,10,12],manual:11,map:10,march:9,mark:1,markdown:9,match:[9,12],meta:9,metadata:1,method:[5,9,14],might:11,migrat:11,millisecond:1,mirror:12,miss:9,mistakenli:11,mktemp:12,model:[1,5],modul:9,month:9,more:[5,9,14],most:12,move:[1,9,11],my:10,mypi:9,na1:10,naik:12,name:[1,9,10],ndjson:1,necessari:10,need:[1,10,11],next:9,none:[1,9,12],note:9,novemb:9,now:9,number:9,o:12,oauth:[1,10],obj:1,object:1,object_to_df:1,octob:9,offici:12,onc:12,one:[10,12],onli:[1,9],oper:[1,3,9,11],optimis:11,option:[1,9,10,11],order:11,org:12,organ:[1,9,10,11],origin:12,other:1,otherwis:[1,11],our:9,out:[1,9],output:1,owner:12,packag:1,package_nam:12,package_vers:12,page:[9,12,14],pain:1,panda:[1,11],param:5,paramet:[1,5,9,10],pass:10,password:[1,10],path:[1,9,10],payload:[5,14],per:9,pgp:12,pgpk:12,pgpv:12,pip:[9,12],pleas:12,point:9,post:[5,14],prepar:9,previou:12,primari:12,privat:[1,10],project:9,provid:[10,12,14],provider_download_dir:12,proxi:10,pull:1,push:5,put:5,py3:12,py:14,pydocstyl:9,pylint:9,pypi:[9,11],python:[9,11,12],pyupgrad:9,queri:1,query_param:1,query_result:1,rc2:9,rc3:9,read:14,readm:[9,11],realli:1,reason:10,recommend:12,record:1,record_time_ad:1,redund:9,ref:9,refer:9,refernc:9,regener:9,relas:9,relat:9,releas:[9,11],relev:12,reli:1,rema:9,remain:9,remov:[9,11,12],renam:9,repositori:11,repres:1,request:[1,5],requir:[1,9],respons:5,rest:[5,14],result:[1,5],retriev:1,row:1,rsa:12,rtype:5,run:[1,11,12],s:[1,9,10,12,14],salesforc:[12,14],salesforce_apex_rest:[3,4],salesforce_conn_id:[1,5],salesforce_default:[1,5],salesforceapexrestoper:[5,9,11,13],salesforcehook:[1,9,10,11],salesforcetos3oper:[9,11],same:1,sandbox:1,sat:12,save:1,schema:1,scheme:10,script:[9,12],sdist:[11,12],secret:10,secur:[1,10],security_token:10,see:9,select:[1,12],self:[1,5,12],send:5,sensor:[3,9],sep:12,separ:[1,9,11],server:[10,12],servic:[9,14],session:[1,9,10,11],session_id:[1,10],set:9,setup:9,sever:[1,10],sfdc:1,sha512:[11,12],sha:12,shasum:12,should:[1,10,12],sign:[10,12],signatur:[9,11,12],signific:1,simpl:[1,9,11],simple_salesforc:1,site:11,softwar:12,some:1,sourc:[1,5,11,14],specifi:[1,10,11],sphinx:9,sql:1,standard:10,start_dat:9,step:12,stop:9,store:1,str:[1,5],string:[1,9],subject:9,suggest:10,sum:12,support:[9,11],synchron:9,syntax:10,t:1,tableau:[0,3,9,11],tableau_job_statu:[3,7],tableau_refresh_workbook:[3,4],tableauservercli:11,take:5,tar:12,task:5,task_id:14,temporari:12,test:[1,10],thei:1,them:[1,11],thi:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],thing:11,those:[11,12],ti:10,time:14,timestamp:1,toc:9,token:[1,10],tool:9,toolchain:9,top:[11,12],transfer:9,trove:11,trust:12,type:[1,9,10,11],typehint:9,typo:9,underneath:1,uniform:1,uniqu:9,unix:1,unknown:12,untouch:9,up:9,updat:[9,11,14],upgrad:[9,11],uri:10,url:[1,10],us:[1,5,9,10,11,12],user:[9,10,12,14],usernam:[1,10],utc:1,utf:9,valid:12,valu:[1,10],variabl:10,vault:10,verifi:11,version:[9,10,11,12],via:[1,10,11,12],wa:1,wai:1,want:[1,11,12],warn:[9,11,12],wave:9,we:[1,10],well:12,were:1,wheel:11,when:[1,10,11],where:[1,10],which:1,whl:12,why:12,widget:1,word:9,work:[1,11],worri:12,would:14,write:1,write_object_to_fil:1,written:1,wrong:9,wrongli:9,xcom:5,you:[1,10,11,12,14],your:[1,10,11],your_password:10,your_token:10,your_usernam:10},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.salesforce_apex_rest</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","Salesforce Operators","SalesforceApexRestOperator"],titleterms:{"0":[9,11],"1":[9,11],"2":[9,11],"3":[9,11],"4":[9,11],"break":11,"class":[1,5],airflow:[0,1,2,3,4,5,6,7,8,9,11],apach:[9,11],attribut:1,bug:11,chang:11,changelog:11,commit:11,configur:10,connect:10,content:[1,5,11],cross:11,depend:11,download:11,featur:11,fix:11,from:12,guid:11,hook:[0,1,2],instal:[11,12],integr:12,misc:11,modul:[1,5],offici:11,oper:[4,5,6,13,14],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,salesforc:[0,1,2,3,4,5,6,7,8,9,10,11,13],salesforce_apex_rest:5,salesforceapexrestoper:14,sensor:[7,8],sourc:12,submodul:[0,4,7],subpackag:3,tableau:2,tableau_job_statu:8,tableau_refresh_workbook:6,us:14,verifi:12}})