Search.setIndex({docnames:["_api/airflow/providers/sftp/hooks/index","_api/airflow/providers/sftp/hooks/sftp/index","_api/airflow/providers/sftp/index","_api/airflow/providers/sftp/operators/index","_api/airflow/providers/sftp/operators/sftp/index","_api/airflow/providers/sftp/sensors/index","_api/airflow/providers/sftp/sensors/sftp/index","commits","connections/sftp","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/sftp/hooks/index.rst","_api/airflow/providers/sftp/hooks/sftp/index.rst","_api/airflow/providers/sftp/index.rst","_api/airflow/providers/sftp/operators/index.rst","_api/airflow/providers/sftp/operators/sftp/index.rst","_api/airflow/providers/sftp/sensors/index.rst","_api/airflow/providers/sftp/sensors/sftp/index.rst","commits.rst","connections/sftp.rst","index.rst","installing-providers-from-sources.rst"],objects:{"airflow.providers":{sftp:[2,0,0,"-"]},"airflow.providers.sftp":{hooks:[0,0,0,"-"],operators:[3,0,0,"-"],sensors:[5,0,0,"-"]},"airflow.providers.sftp.hooks":{sftp:[1,0,0,"-"]},"airflow.providers.sftp.hooks.sftp":{SFTPHook:[1,1,1,""]},"airflow.providers.sftp.hooks.sftp.SFTPHook":{close_conn:[1,2,1,""],conn_name_attr:[1,3,1,""],conn_type:[1,3,1,""],create_directory:[1,2,1,""],default_conn_name:[1,3,1,""],delete_directory:[1,2,1,""],delete_file:[1,2,1,""],describe_directory:[1,2,1,""],get_conn:[1,2,1,""],get_mod_time:[1,2,1,""],get_tree_map:[1,2,1,""],get_ui_field_behaviour:[1,2,1,""],hook_name:[1,3,1,""],list_directory:[1,2,1,""],path_exists:[1,2,1,""],retrieve_file:[1,2,1,""],store_file:[1,2,1,""],test_connection:[1,2,1,""]},"airflow.providers.sftp.operators":{sftp:[4,0,0,"-"]},"airflow.providers.sftp.operators.sftp":{SFTPOperation:[4,1,1,""],SFTPOperator:[4,1,1,""]},"airflow.providers.sftp.operators.sftp.SFTPOperation":{GET:[4,3,1,""],PUT:[4,3,1,""]},"airflow.providers.sftp.operators.sftp.SFTPOperator":{execute:[4,2,1,""],template_fields:[4,3,1,""]},"airflow.providers.sftp.sensors":{sftp:[6,0,0,"-"]},"airflow.providers.sftp.sensors.sftp":{SFTPSensor:[6,1,1,""]},"airflow.providers.sftp.sensors.sftp.SFTPSensor":{poke:[6,2,1,""],template_fields:[6,3,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute"},terms:{"00642a46d0":7,"0080354502":7,"0161b5ea2b":7,"0a0e1af800":7,"0a68588479":7,"0b0e4f7a4c":7,"0b2":7,"0beta1":7,"10097":7,"10117":7,"10163":7,"10205":7,"10343ec29f":7,"10483":7,"10528":7,"10543":7,"10818":7,"11159":7,"11238":7,"11242":7,"11249":7,"11447":7,"11448":7,"11487":7,"11688":7,"11720":7,"11733":7,"11826":7,"11855":7,"12082":7,"12093":7,"12206":7,"12212":7,"12304":7,"12366":7,"12390":7,"12444":7,"12449":7,"12558":7,"12917":7,"12944":7,"12955":7,"12af6a0800":7,"12c5e5d8a":7,"13065":[7,9],"13148":7,"13380":7,"13717":7,"13732":7,"13767":7,"14013":7,"14028":[7,9],"14059":7,"14082":[7,9],"14487":7,"14886":7,"15134":[7,9],"15348":[7,9],"15408":7,"15576":7,"15667":[7,9],"15e044c7e4":7,"16294":7,"16314":[7,9],"16405":7,"16464":7,"16501":7,"16704":7,"16e7129719":7,"17015":7,"17020":7,"17116":7,"17682":7,"17890":7,"18855":7,"18988":[7,9],"19321":7,"19609":[7,9],"1fb3c28e1a":7,"1fba5402bb":7,"2019":7,"2020":7,"2021":[7,10],"23rc1":7,"24c8e4c2d6":7,"295d66f914":7,"2a1":7,"2fairflow":8,"2fhome":8,"2fid_rsa":8,"2nd":7,"32971a1a2d":7,"349b0811c3":7,"3696c34c28":7,"375d1ca229":7,"37681bca00":7,"3fd5ef3555":7,"406f":10,"41bf172c1d":7,"42eef38217":7,"44a6648fd7":7,"4541":7,"4d3a":10,"4e3799fec4":7,"4e8f9cc8d0":7,"50e334df32":7,"512":10,"5220e4c384":7,"52339a55c0":7,"5807":7,"589d6dec92":7,"59eb5de78c":7,"5a439e84eb":7,"5c6e":10,"6464":7,"6646":7,"6656":7,"6674":10,"6714":7,"6877":7,"6889a333cf":7,"68e4c4dcb0":7,"69629a5a94":7,"6cf76d7ac0":7,"7044":7,"7268":7,"7272":7,"7338":7,"7506":7,"76ed2a49c6":7,"777":1,"7825e8f590":7,"7953":7,"7a0d412245":7,"807ad32ce5":7,"81be82bfb7":7,"83eb80d4ec":7,"85a18e13d9":7,"86a2a19ad2":7,"872b1566a1":7,"87f408b1e7":7,"8807":7,"8886":7,"8891":7,"8898":7,"88bdcfa0df":7,"8994":7,"8b1":7,"8c42cf1b00":7,"8ec4":10,"9026":7,"92585ca4cb":7,"9320":7,"9351e2a2d4":7,"9370":7,"9404":7,"9408":7,"9549274d11":7,"9550":7,"97a429f9d0":7,"9a04013b0":7,"9af452aee5":7,"9b39f24780":7,"9c94b72d44":7,"class":[1,4,6,7,9],"default":[4,7],"export":8,"final":7,"import":[7,9,10],"int":1,"new":[7,8],"public":8,"return":1,"static":1,"switch":7,"true":[1,4,8],"while":4,Added:7,For:[7,9,10],RCs:[7,9],The:[1,4,6,8,9,10],There:[8,10],Use:[7,8],a9ac2b040b:7,aaahd:8,about:[7,10],abov:10,ac2f72c98d:7,add:[7,8,9],added:1,ae791e1916:7,ae7cb4a1e2:7,aeea71274d:7,after:[7,9],against:[6,8],agentkei:8,aim:1,aip:7,airflow:[8,10],airflow_conn_sftp_default:8,aka:10,all:[1,7,8,9],allow:8,allow_host_key_chang:8,along:8,alreadi:10,also:10,amazon:7,ani:[4,10],apach:10,apache_airflow_providers_sftp:10,api:9,appli:[7,9],apply_default:[7,9],arg:[1,7],argument:[1,7,9],asc:[9,10],attack:8,attribut:1,august:7,author:8,auto:[7,9],autom:7,automat:[8,9],avail:10,b2a28d1590:7,b40dffa085:7,b916b75079:7,ba4b:10,bac0ab27cf:7,backport:7,base64:8,base:[1,4,6],baseoper:4,basesensoroper:6,bash:10,basi:4,batch:7,bbc627a3da:7,be75dcd39c:7,belong:10,below:10,bin:10,binari:10,black:7,bool:4,broken:7,bst:10,buffer:1,buggfix:7,build:[7,10],built:1,c34ef853c8:7,c7e5bce57f:7,ca4238eb4d:7,can:[4,7,8,9,10],candid:7,cbf8001d76:7,ccb809550d:7,cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:10,cde1:10,cdec301254:7,ceea293c16:7,certif:10,certifi:10,chang:7,changelog:7,channel:4,chapter:10,charact:7,check:[1,7,10],checksum:[9,10],choos:10,cipher:7,cleanup:7,close:[1,7],close_conn:1,code:10,com:10,come:7,command:[1,7],comment:7,commit:[7,9],compat:7,complet:9,compon:8,confirm:4,conn:[7,9],conn_name_attr:1,conn_typ:1,connect:[1,4,6,7,9],consist:9,constructor:7,contain:[1,4,6,10],content:8,context:[4,6],contrast:1,contrib:7,copi:4,correct:[7,9,10],coverag:7,creat:[1,4,10],create_directori:1,create_intermediate_dir:4,credenti:8,cross:7,curl:10,d02ded65ea:7,d0e7db4024:7,d200:7,d305876bee:7,d45739f7ce:7,d7de:10,d9567eb106:7,dag:4,data:7,decor:[7,9],default_conn_nam:1,defin:4,delet:1,delete_directori:1,delete_fil:1,delimit:1,dep:10,depend:7,deprec:9,depreci:[7,9],describ:10,describe_directori:1,descript:7,dest:10,detail:[7,9,10],dev:7,dict:[6,7],dictionari:[1,8],diff:10,differ:10,dir:1,directori:[1,4,6,10],distribut:10,doc:[7,9],document:[7,9],doe:4,doesn:1,don:4,down:10,download:10,downstream:1,drop:10,due:9,dynam:7,e08a:10,ecf4:10,echo:10,ee7ca128a1:7,either:[4,8],enabl:[7,8],encod:8,encrypt:8,end:1,endpoint:8,enter:8,entiti:1,entri:8,environ:8,error:[1,4,7],escap:7,essenti:10,etc:8,exampl:[4,8,9,10],execut:4,exist:[1,4,9],express:7,extra:[7,8,9],f3521fb0e3:7,f6bd817a3a:7,fals:[4,8],fdd9b6f65b:7,featur:7,field:[7,8],file:[1,4,6,7,8,9,10],filenam:1,filesystem:[7,9],filter:1,find:8,fingerprint:10,first:9,fix:7,flynt:7,folder:10,follow:[4,8,10],forc:8,form:7,format:7,formmatt:7,foundat:10,frequent:8,fresh:7,from:[1,4,7,9],ftp:[1,7,9],ftp_conn_id:1,ftphook:1,full:[1,8],gener:7,get:[4,7,10],get_conn:1,get_mod_tim:1,get_tree_map:1,get_ui_field_behaviour:1,give:1,given:1,gmail:10,good:10,gpg:10,grammar:7,group:1,guid:10,handl:1,hash:7,have:9,high:7,hook:[2,4,7,8,9],hook_nam:1,hors:8,host:[4,7,8],host_kei:8,hostnam:8,how:10,http:10,ignor:4,implement:7,improv:7,includ:7,increas:7,indic:10,individu:7,inform:7,inherit:1,initi:9,input:1,instal:7,instruct:10,integr:[7,8],interact:1,interchang:1,intermedi:4,introduc:7,issuer:10,item:1,json:8,juli:7,june:7,kaxil:10,kaxilnaik:10,kei:[7,8,9,10],key_fil:8,know:10,known:8,known_host:8,kwarg:[1,4,6],last:[7,9],latest:7,lazili:7,least:9,left:10,level:7,link:[7,10],list:[1,7,9],list_directori:1,local:[1,4,10],local_filepath:4,local_full_path:1,local_full_path_or_buff:1,localhost:8,locat:1,log:[7,9],login:8,logo:7,machin:8,made:[8,10],magic:7,mai:1,main:10,maintain:8,make:8,manag:[7,8,10],manual:[8,9],markdown:7,match:[7,8,10],maximum:8,meta:7,method:[7,8,9],might:9,migrat:9,mirror:10,miss:[4,7],mkdir:7,mktemp:10,mlsd:1,mode:1,model:4,modif:1,modifi:[1,7,9],modul:7,month:7,more:7,most:10,move:7,multipl:[7,8],naik:10,name:[7,9],need:[4,8,9],next:7,no_host_key_check:8,non:[7,9],none:[1,4,7,10],note:[7,8],nullabl:4,number:7,object:1,occur:1,octal:1,octob:7,offici:10,onc:10,one:[8,10],onli:[1,8],open:4,oper:[2,7,8],optimis:9,option:[1,7,8,9],order:9,org:10,origin:10,otherwis:9,out:7,over:[7,9],owner:[1,10],package_nam:10,package_vers:10,page:[7,10],param:9,paramet:[1,4,6,7,8],paramiko:[7,8,9],pass:[1,4,8],password:8,path:[1,4,6,7,8,9],path_exist:1,pathlib:7,per:7,perm:1,permiss:1,pgp:10,pgpk:10,pgpv:10,pip:[7,10],pitfal:1,pleas:[1,10],point:7,poke:6,poorli:8,port:8,possibl:1,predefin:4,prefer:[7,9],prefix:1,prepar:7,present:[6,8],previou:10,primari:10,privat:8,private_kei:[7,8,9],private_key_pass:[7,8,9],private_key_passphras:[7,9],process:7,project:7,protect:8,protocol:[7,9],provid:[8,10],provider_download_dir:10,put:[1,4],put_fil:4,py3:10,pydocstyl:7,pypi:[7,9],pysftp:9,python:[7,9,10],pyupgrad:7,rc2:7,rc3:7,read:1,readm:[7,9],recommend:10,recurs:1,redund:7,ref:7,refer:[1,9],refernc:7,regener:7,relas:7,relat:8,releas:[7,9],relev:10,rema:7,remain:7,remot:[1,4,6,8],remote_filepath:4,remote_full_path:1,remote_host:[4,8],remov:[1,7,9,10],renam:[7,9],replac:[4,7],repositori:9,represent:1,resourc:9,restrict:8,result:1,retrieve_fil:1,retryer:[7,9],rsa:[7,8,9,10],run:[6,9,10],sat:10,script:[7,10],sdist:[9,10],see:7,select:10,self:[1,4,6,10],sensor:[2,7,8,9],sep:10,separ:7,serv:4,server:[1,10],set:[1,7,8],setup:7,sftp:10,sftp_conn_id:[1,6],sftp_default:[1,6,8],sftphook:[1,7,9],sftpoper:4,sftpsensor:6,sha512:[9,10],sha:10,shasum:10,should:[1,4,8,10],show:[7,9],sign:10,signatur:[7,9,10],simplifi:7,site:9,size:1,softwar:10,some:1,sourc:[1,4,6,9],specifi:[4,7,8,9],ssh:[1,4,7,8,9],ssh_conn_id:4,ssh_default:4,ssh_hook:4,ssh_known_host:8,sshhook:[1,4,9],sshtunnel:9,start:1,step:10,store_fil:1,str:[1,4,6,8],string:[1,7,8],subject:7,sum:10,support:[1,7,9],synchron:7,syntax:8,system:1,take:1,tar:10,task:4,task_id:4,templat:4,template_field:[4,6],temporari:10,test:1,test_connect:[1,7,9],test_sftp:4,thei:4,them:9,thi:[1,4,6,7,8,9,10],those:[9,10],throughout:1,time:[1,8],tmp1:4,tmp2:4,tmp:4,toc:7,tool:[7,9],top:[9,10],transfer:[1,4,7,9],transport:4,tree:1,trojan:8,troublesom:8,trust:10,tupl:1,two:8,txt:4,type:[1,7,8,9],typo:7,undeprec:[7,9],uniqu:1,unix:1,unknown:[1,10],updat:[7,9],upgrad:[7,9],uri:8,url:8,usag:7,use:[4,7,8,9,10],used:[4,8,10],user:[8,10],usernam:8,uses:4,using:[7,8,10],utf:7,valid:10,valu:8,variabl:8,verifi:9,versa:4,version:[7,9,10],via:[7,9,10],vice:4,wai:8,wait:6,want:[9,10],warn:[7,10],wave:7,well:10,wheel:9,when:[4,8,9],where:1,which:[1,4],whl:10,why:10,without:7,word:7,worri:10,would:[4,8],wrong:7,wrongli:7,ydwwq:8,you:[8,9,10],your:9},titles:["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.sftp.hooks</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.sftp.hooks.sftp</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.sftp</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.sftp.operators</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.sftp.operators.sftp</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.sftp.sensors</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.sftp.sensors.sftp</span></code>","Package apache-airflow-providers-sftp","SFTP Connection","<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-sftp</span></code>","Installing from sources"],titleterms:{"break":9,"default":8,IDs:8,airflow:[0,1,2,3,4,5,6,7,9],apach:[7,9],authent:8,bug:9,chang:9,changelog:9,configur:8,connect:8,content:[1,4,6,9],cross:9,depend:9,download:9,featur:9,fix:9,from:10,hook:[0,1],instal:[9,10],integr:10,misc:9,modul:[1,4,6],offici:9,oper:[3,4],packag:[7,9,10],pip:9,provid:[0,1,2,3,4,5,6,7,9],pypi:10,releas:10,requir:9,sensor:[5,6],sftp:[0,1,2,3,4,5,6,7,8,9],sourc:10,submodul:[0,3,5],subpackag:2,verifi:10}})