blob: 1e757f51aaec44a63e8dcad6ee812588e867b5d0 [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","_api/tests/system/providers/salesforce/example_salesforce_apex_rest/index","_api/tests/system/providers/salesforce/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","_api/tests/system/providers/salesforce/example_salesforce_apex_rest/index.rst","_api/tests/system/providers/salesforce/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"]],"tests.system.providers":[[10,0,0,"-","salesforce"]],"tests.system.providers.salesforce":[[9,0,0,"-","example_salesforce_apex_rest"]],"tests.system.providers.salesforce.example_salesforce_apex_rest":[[9,4,1,"","DAG_ID"],[9,4,1,"","ENV_ID"],[9,4,1,"","payload"],[9,4,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","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,9,10,12,14,15,16],"00":16,"00642a46d0":11,"0080354502":11,"01":11,"02":11,"027b707d21":11,"03":11,"04":[11,16],"05":11,"06":11,"07":11,"08":11,"09":11,"0a0e1af800":11,"0a68588479":11,"0b0e4f7a4c":11,"0b2":11,"0beta1":11,"10":[11,13],"10097":11,"10163":11,"10205":11,"10483":11,"10528":11,"10543":11,"11":[11,14],"11032":11,"11135":11,"11238":11,"11242":11,"11249":11,"11447":11,"11448":11,"11487":11,"11688":11,"11826":11,"11855":11,"12":[11,14],"12082":11,"12206":11,"12212":11,"12304":11,"12345":16,"12366":11,"12390":11,"12444":11,"12449":11,"12466":11,"12558":11,"12917":11,"12955":11,"12af6a0800":11,"12c5e5d8a":11,"13":11,"13148":11,"13380":11,"13717":11,"13732":11,"13767":11,"14":11,"14013":11,"14030":11,"14487":11,"14886":11,"15":11,"15667":13,"15z":16,"16":11,"16294":11,"16405":11,"16464":11,"16501":11,"16682":11,"16adc035b1":11,"16e7129719":11,"17":[11,13],"17015":11,"17116":11,"17162":[11,13],"17272":11,"17399":[11,13],"17682":11,"17890":11,"18":11,"18819":[11,13],"19":11,"19321":11,"19530":[11,13],"19882":11,"1d36b0303b":11,"1fba5402bb":11,"2":[0,1,2,3,4,5,6,7,8,9,10,12,14,15,16],"20":11,"2014":16,"2020":11,"2021":[11,14],"2022":11,"20226":11,"20325":11,"2037303eef":11,"20523":11,"20565":11,"20614":11,"20951":11,"21":11,"21074":[11,13],"21257":11,"21439":11,"21t13":16,"22":11,"22056":11,"22226":11,"22382":13,"22383":11,"22463":11,"23":11,"23353":[11,13],"23631":11,"23rc1":11,"24":11,"24127":11,"24229":11,"24231":11,"24292":11,"24c8e4c2d6":11,"25":11,"26":11,"27":11,"28":11,"29":11,"295d66f914":11,"2a1":11,"2f":12,"2fb5e1d0ec":11,"2fyour_host":12,"30":11,"31":11,"31efc931e3":11,"32971a1a2d":11,"3320e432a1":11,"349b0811c3":11,"3696c34c28":11,"375d1ca229":11,"3a":12,"3fd5ef3555":11,"4":[0,1,2,3,4,5,6,7,8,9,10,12,14,15,16],"406f":14,"45669bea4f":11,"45e72ca830":11,"49":14,"4d3a":14,"4dc622d8ca":11,"4e8f9cc8d0":11,"512":14,"5220e4c384":11,"54":14,"589d6dec92":11,"59eb5de78c":11,"5a439e84eb":11,"5c0e98cc77":11,"5c6e":14,"6":11,"602abe8394":11,"6140356b80":11,"61a8bb6581":11,"6481":11,"6515":11,"6644":11,"6674":14,"6708":11,"6714":11,"6790":11,"6817":11,"6879":11,"6889a333cf":11,"68e4c4dcb0":11,"6c3a67d4fc":11,"6cf76d7ac0":11,"717a7588bc":11,"7265":11,"7330":11,"7338":11,"7410":11,"7500":11,"7517":11,"75c60923e0":11,"763919d415":11,"76ed2a49c6":11,"7703":11,"7824":11,"7825e8f590":11,"7857":11,"7d24b088cd":11,"8":11,"8170":11,"853576d901":11,"8565":11,"85a18e13d9":11,"8644":11,"866a601b76":11,"872b1566a1":11,"87969a350d":11,"87f408b1e7":11,"8807":11,"8886":11,"8891":11,"8898":11,"88bdcfa0df":11,"8984":11,"8994":11,"8c42cf1b00":11,"8ec4":14,"9026":11,"9132baf192":11,"92585ca4cb":11,"92bc8047cf":11,"9320":11,"9370":11,"9404":11,"9408":11,"9546192836":11,"9550":11,"97496ba2b4":11,"97a429f9d0":11,"9985":11,"9b39f24780":11,"9c94b72d44":11,"class":[11,13],"default":[1,5,11,12],"do":[1,11,13,14],"export":[1,12],"final":11,"function":1,"import":[11,13,14],"new":[1,11],"return":[1,5,11],"static":1,"super":11,"switch":11,"true":1,"try":1,A:[1,5,12],By:[1,14],For:[1,5,11,12,13,14],If:[1,12,13,14],It:14,The:[1,5,12,13,14],There:14,To:14,a0821235fb:11,a24066bc4c:11,a9ac2b040b:11,a9ad0a9298:11,about:[11,14,16],abov:14,ac2f72c98d:11,accept:1,access:[1,12],account:12,action:[5,16],activ:16,ad:[11,13],add:[1,11,13],addit:1,addition:13,address:12,ae7cb4a1e2:11,aeabe994b3:11,aeea71274d:11,after:11,aip:11,airflow:14,airflow_conn_:12,airflow_conn_salesforce_default:12,aka:14,all:[1,11,13],allow:1,alreadi:14,also:[1,12,14,16],amount:1,an:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],ani:14,anoth:1,apach:14,apache_airflow_providers_salesforc:14,apex:[5,16],apex_oper:16,apex_task:16,apexrest:16,api:[5,11,12,13],appli:13,apply_default:13,ar:[1,12,13,14],arg:11,argument:[1,11],arrai:1,asc:[13,14],associ:12,attempt:12,august:11,authent:[1,12],auto:[11,13],autoapi:11,autom:11,automat:13,avail:[1,13,14],b2a28d1590:11,b40dffa085:11,b916b75079:11,ba4b:14,backend:12,backport:11,base:[1,5],basehook:1,baseoper:5,bash:14,basic:11,batch:11,bbc627a3da:11,be75dcd39c:11,becom:1,behaviour:1,being:1,belong:14,below:[13,14],benefici:1,bin:14,binari:14,black:11,blob:13,bodi:16,bool:1,both:12,broken:11,bst:14,bug:11,bugfix:11,buggfix:11,build:[11,14],bump:11,c34ef853c8:11,c42a375e79:11,c7e5bce57f:11,ca4238eb4d:11,cach:1,cached_properti:11,call:[11,12,16],can:[1,13,14,16],candid:11,cb73053211:11,cbf8001d76:11,cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:14,cde1:14,cdec301254:11,certif:14,certifi:14,cf141506a2:11,chang:11,changelog:11,chapter:14,check:[11,14],checksum:[13,14],choos:14,ci:11,classifi:[11,13],cleanup:[1,11],client:12,code:[14,16],coerce_to_timestamp:1,com:[1,12,13,14,16],come:11,comma:1,command:11,comment:11,commit:11,common:12,compat:11,complet:13,conn:1,conn_id:[1,12],conn_name_attr:1,conn_typ:1,connect:[1,5,11,13],constructor:11,consum:[1,12],contain:[1,14],content:16,context:[5,11],contributor:11,convert:1,correct:[11,14],coverag:11,creat:[1,12,14],cross:11,csv:1,curl:14,custom:[1,11,13,16],d0e7db4024:11,d200:11,d202:11,d305876bee:11,d7dbfb7e26:11,d7de:14,d94fa37830:11,d9567eb106:11,d:14,dag:[11,13],dag_id:9,data:[1,11],databas:1,datafram:[1,11],datetim:1,db:[12,13],decemb:11,declar:11,decor:13,default_arg:11,default_conn_nam:1,delai:11,delet:1,delimit:1,dep:14,depend:11,deprec:13,describ:14,describe_object:1,descript:[1,11],design:11,dest:14,detail:[11,13,14],dev0:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],dev:11,develop:16,dict:[1,5,11],diff:14,differ:[1,14],direct:[1,11,12,13],directori:14,discoveri:11,distribut:14,doc:11,document:[11,13],doesn:1,domain:[1,12],done:13,doubl:11,down:14,download:14,drop:14,due:13,dump:[1,16],dure:5,dynam:11,e08a:14,e9a72a4e95:11,e:12,each:1,easier:1,ecf4:14,echo:14,ee7ca128a1:11,either:1,element:1,email:12,enabl:[1,11],encod:16,endpoint:[5,16],enter:1,env_id:9,environ:[1,12],error:11,especi:1,essenti:14,etc:12,everywher:11,exampl:[11,12,13,14],example_dag:11,example_gcs_to_trino:9,example_salesforce_apex_rest:[10,16],execut:[5,16],exist:13,experiment:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],explain:13,explanatori:11,expos:1,extra:[1,11,12,13],f3521fb0e3:11,f3e87c5030:11,f5b96315fe:11,f6bd817a3a:11,f77417eb0d:11,f:11,face:11,fail:11,fals:1,fdd9b6f65b:11,fdf518573f:11,featur:[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16],feb:11,fetch:1,ff342fc230:11,field:[1,11],file:[1,11,12,13,14],filenam:1,filter:[1,11,12,13],fingerprint:14,first:13,fix:11,flag:1,flynt:11,fmt:1,folder:14,follow:[12,14],forc:[1,12,16],form:[1,11],format:1,formmatt:11,foundat:14,framework:13,fresh:11,from:[1,11,13],full:12,gcp:12,gener:[11,12],get:[1,5,11,13,14],get_available_field:1,get_conn:1,get_connection_form_widget:1,get_object_from_salesforc:1,get_ui_field_behaviour:1,github:[1,13],given:1,gmail:14,good:14,gpg:14,grammar:11,greatli:1,guid:[5,14,16],gz:14,ha:1,handl:1,hash:11,hashicorp:12,have:13,high:11,hood:1,hook:[3,11],hook_nam:1,how:[5,14],http:[1,5,12,13,14,16],i:[12,14],id:[1,5,12,14],implement:11,improv:11,includ:[1,11],include_delet:1,increas:11,indic:14,individu:11,info:11,inform:[5,11],initi:13,instal:11,install_requir:13,instanc:[1,12,16],instead:1,instruct:14,integr:[11,13],introduc:11,ip:[1,11,12,13],issuer:14,iter:1,januari:11,json:[1,16],juli:11,june:11,jwt:[1,11,12,13],k8:11,ka:14,kaxil:14,kaxilnaik:14,keep:11,kei:[1,12,14],know:14,kwarg:5,l:14,la:14,latest:11,lazi:11,lazili:11,least:13,leav:1,left:[1,14],level:11,librari:16,lightn:12,like:1,line:[1,11],link:[11,14],list:[1,11,13],load:11,local:[12,14],log:[1,11],logger:11,login:[11,12,13],logo:11,look:[1,5],ls:14,made:14,magic:11,mai:11,main:[13,14],make:[1,5],make_queri:1,manag:[11,12,14],manual:13,map:12,march:11,mark:1,markdown:11,match:[11,14],md:13,meta:11,metadata:1,method:[5,11,16],might:13,migrat:[11,13],millisecond:1,min:11,minimum:13,mirror:14,miss:11,mistakenli:13,mktemp:14,model:[1,5],modul:11,month:11,more:[5,11,16],most:14,move:[1,11,13],my:12,mypi:11,na1:12,naik:14,name:[1,11,12],ndjson:1,necessari:12,need:[1,12,13],next:11,none:[1,11,14],note:11,novemb:11,now:11,number:11,o:14,oauth:[1,12],obj:1,object:1,object_to_df:1,octob:11,offici:14,onc:14,one:[12,14],onli:[1,11,13],oper:[1,3,11,13],optimis:13,option:[1,11,12,13],order:13,org:14,organ:[1,11,12,13],origin:14,other:1,otherwis:[1,13],our:11,out:[1,11],output:1,owner:14,packag:1,package_nam:14,package_vers:14,page:[11,14,16],pain:1,panda:[1,13],param:5,paramet:[1,5,11,12],pass:12,password:[1,12],path:[1,11,12],payload:[5,9,16],per:11,pgp:14,pgpk:14,pgpv:14,pip:[11,13,14],pleas:14,point:11,polici:13,post:[5,16],prepar:11,previou:14,primari:14,privat:[1,12],project:11,provid:[12,14,16],provider_download_dir:14,proxi:12,pull:1,push:5,put:5,py3:14,py:16,pydocstyl:11,pylint:11,pypi:[11,13],python:[11,13,14],pyupgrad:11,queri:1,query_param:1,query_result:1,rc2:11,rc3:11,read:16,readm:[11,13],realli:1,reason:12,recommend:14,record:1,record_time_ad:1,redund:11,ref:11,refer:11,refernc:11,regener:11,relas:11,relat:11,releas:[11,13],relev:14,reli:1,rema:11,remain:11,remov:[11,13,14],renam:11,repositori:13,repres:1,request:[1,5],requir:[1,11],respons:5,rest:[5,16],result:[1,5],retriev:1,row:1,rsa:14,rtype:5,run:[1,13,14],s:[1,11,12,14,16],salesforc:[14,16],salesforce_apex_rest:[3,4],salesforce_conn_id:[1,5],salesforce_default:[1,5],salesforceapexrestoper:[5,11,13,15],salesforcehook:[1,11,12,13],salesforcetos3oper:[11,13],same:1,sandbox:1,sat:14,save:1,schema:1,scheme:12,script:[11,14],sdist:[13,14],secret:12,secur:[1,12],security_token:12,see:[11,13],select:[1,14],self:[1,5,14],send:5,sensor:[3,11],sep:14,separ:[1,11,13],server:[12,14],servic:[11,16],session:[1,11,12,13],session_id:[1,12],set:11,setup:11,sever:[1,12],sfdc:1,sha512:[13,14],sha:14,shasum:14,should:[1,12,14],sign:[12,14],signatur:[11,13,14],signific:1,simpl:[1,11,13],simple_salesforc:1,site:13,softwar:14,some:1,sourc:[1,5,9,13,16],specif:11,specifi:[1,12,13],sphinx:11,sql:1,standard:12,start_dat:11,step:14,stop:11,store:1,str:[1,5],string:[1,11],subject:11,suggest:12,sum:14,support:[11,13],synchron:11,syntax:12,system:16,t:1,tableau:[0,3,11,13],tableau_job_statu:[3,7],tableau_refresh_workbook:[3,4],tableauservercli:13,take:5,tar:14,task:5,task_id:16,temporari:14,test:[1,12,16],test_run:9,thei:1,them:[1,13],thi:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],thing:13,those:[13,14],ti:12,time:16,timestamp:1,toc:11,token:[1,12],tool:11,toolchain:11,top:[13,14],transfer:11,trove:13,trust:14,type:[1,11,12,13],typehint:11,typo:11,underneath:1,uniform:1,uniqu:11,unix:1,unknown:14,untouch:11,up:11,updat:[11,13,16],upgrad:[11,13],uri:12,url:[1,12],us:[1,5,11,12,13,14],user:[11,12,14,16],usernam:[1,12],utc:1,utf:11,valid:14,valu:[1,12],variabl:12,vault:12,verifi:13,version:[11,12,13,14],via:[1,12,13,14],wa:1,wai:1,want:[1,13,14],warn:[11,13,14],wave:11,we:[1,12],well:14,were:1,wheel:13,when:[1,12,13],where:[1,12],which:1,whl:14,why:14,widget:1,word:11,work:[1,13],worri:14,would:16,write:1,write_object_to_fil:1,written:1,wrong:11,wrongli:11,xcom:5,you:[1,12,13,14,16],your:[1,12,13],your_password:12,your_token:12,your_usernam:12},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>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.salesforce.example_salesforce_apex_rest</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.salesforce</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":[11,13],"1":[11,13],"2":[11,13],"3":[11,13],"4":[11,13],"break":13,"class":[1,5],airflow:[0,1,2,3,4,5,6,7,8,11,13],apach:[11,13],attribut:1,bug:13,chang:13,changelog:13,commit:13,configur:12,connect:12,content:[1,5,9,13],cross:13,depend:13,download:13,example_salesforce_apex_rest:9,featur:13,fix:13,from:14,guid:13,hook:[0,1,2],instal:[13,14],integr:14,misc:13,modul:[1,5,9],offici:13,oper:[4,5,6,15,16],packag:[11,13,14],provid:[0,1,2,3,4,5,6,7,8,9,10,11,13],pypi:14,refer:13,releas:14,requir:13,resourc:13,salesforc:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,15],salesforce_apex_rest:5,salesforceapexrestoper:16,sensor:[7,8],sourc:14,submodul:[0,4,7,10],subpackag:3,system:[9,10],tableau:2,tableau_job_statu:8,tableau_refresh_workbook:6,test:[9,10],us:16,verifi:14}})