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"],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"],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":{_is_path_match:[1,2,1,""],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,""]},"airflow.providers.sftp.operators":{sftp:[4,0,0,"-"]},"airflow.providers.sftp.operators.sftp":{SFTPOperation:[4,1,1,""],SFTPOperator:[4,1,1,""],_make_intermediate_dirs:[4,4,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"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:function"},terms:{"00642a46d":7,"008035450":7,"0161b5ea2":7,"0a0e1af80":7,"0b0e4f7a4":7,"0b2":7,"0beta1":7,"10097":7,"10117":7,"10163":7,"10205":7,"10343ec29":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,"12af6a080":7,"12c5e5d8a":7,"13065":[7,9],"13148":7,"13380":7,"13717":7,"13732":7,"13767":7,"14013":7,"14059":7,"14082":[7,9],"14487":7,"14886":7,"15134":[7,9],"15348":[7,9],"15408":7,"15e044c7":7,"16e712971":7,"1fb3c28e1":7,"2019":7,"2020":7,"2021":7,"23rc1":7,"24c8e4c2d":7,"295d66f91":7,"2a1":7,"2nd":7,"32971a1a2":7,"349b0811c":7,"3696c34c2":7,"375d1ca22":7,"3fd5ef355":7,"41bf172c1":7,"42eef3821":7,"44a6648fd":7,"4541":7,"4e3799fec":7,"4e8f9cc8d":7,"5220e4c38":7,"52339a55c":7,"5807":7,"589d6dec9":7,"59eb5de78":7,"5a439e84":7,"6464":7,"64bit":8,"6646":7,"6656":7,"6714":7,"6877":7,"6889a333c":7,"68e4c4dcb":7,"69629a5a9":7,"6cf76d7ac":7,"7044":7,"7268":7,"7272":7,"7338":7,"7506":7,"777":1,"7825e8f59":7,"7953":7,"7a0d41224":7,"85a18e13d":7,"872b1566a":7,"8807":7,"8886":7,"8891":7,"8898":7,"88bdcfa0d":7,"8994":7,"8b1":7,"8c42cf1b0":7,"9026":7,"92585ca4c":7,"9320":7,"9370":7,"9404":7,"9408":7,"9549274d1":7,"9550":7,"97a429f9d":7,"9a04013b0":7,"9af452ae":7,"9b39f2478":7,"class":[1,4,6,7,9],"default":[4,7],"export":8,"final":7,"int":1,"new":[7,8],"public":8,"return":[1,4],"static":1,"switch":7,"true":[1,4,8],"while":4,Added:7,For:[7,9],RCs:[7,9],The:[1,4,6,8],There:8,Use:[7,8],_is_path_match:1,_make_intermediate_dir:4,a9ac2b040:7,aaahd:8,about:7,absolut:4,ac2f72c98:7,add:[7,8,9],added:1,ae791e191:7,ae7cb4a1:7,aeea71274:7,after:[7,9],against:[6,8],agentkei:8,aim:1,aip:7,airflow:8,airflow_conn_sftp_default:8,all:[1,4,7,8,9],allow:8,allow_host_key_chang:8,along:8,ani:4,api:9,arg:[1,7],argument:[1,7],attack:8,attribut:1,author:8,auto:7,autom:7,automat:8,b2a28d159:7,b40dffa08:7,bac0ab27c:7,backport:7,base64:8,base:[1,4,6],baseoper:4,basesensoroper:6,basi:4,batch:7,black:7,bool:[1,4],broken:7,buffer:1,build:7,built:1,c34ef853c:7,c7e5bce57:7,ca4238eb4:7,can:[4,7,8,9],candid:7,cdec30125:7,ceea293c1:7,chang:7,changelog:7,channel:4,check:[1,7],cipher:7,cleanup:7,client:4,close:[1,7],close_conn:1,come:7,command:[1,7],comment:7,commit:[7,9],compon:8,confirm:4,conn_name_attr:1,conn_typ:1,connect:[1,4,6,7,9],constructor:7,contain:[1,4,6],context:[4,6],contrast:1,contrib:7,copi:4,correct:[7,9],coverag:7,creat:[1,4],create_directori:1,create_intermediate_dir:4,credenti:8,cross:7,d0e7db402:7,d200:7,d305876be:7,d45739f7c:7,dag:4,default_conn_nam:1,defin:4,delet:1,delete_directori:1,delete_fil:1,delimit:1,depend:7,describe_directori:1,detail:[7,9],dev:7,dict:[6,7],dictionari:[1,8],dir:1,directori:[1,4,6],doc:[7,9],document:[7,9],doe:4,doesn:1,don:4,downstream:1,dynam:7,ee7ca128a: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],etc:8,exampl:[4,8,9],execut:4,exist:[1,4,9],express:7,extra:[7,8,9],f3521fb0e:7,f6bd817a3:7,fals:[4,8],fdd9b6f65:7,featur:7,field:[7,8],file:[1,4,6,7,8,9],filenam:1,filesystem:[7,9],filter:1,find:8,fix:7,flynt:7,follow:[4,8],forc:8,form:7,format:7,formmatt:7,frequent:8,fresh:7,from:[1,4,7,9],ftp:[1,7,9],ftp_conn_id:1,ftphook:1,full:1,gener:7,get:[4,7],get_conn:1,get_mod_tim:1,get_tree_map:1,get_ui_field_behaviour:1,give:1,given:1,grammar:7,group:1,handl:1,hash:7,high:7,hook:[2,4,7,8,9],hook_nam:1,hors:8,host:[4,7,8],host_kei:8,hostnam:8,ignor:4,implement:7,improv:7,includ:7,increas:7,inform:7,inherit:1,initi:9,input:1,instal:7,integr:[7,8],interact:1,interchang:1,intermedi:4,introduc:7,item:1,json:8,kei:[7,8],known:8,known_host:8,kwarg:[1,4,6],last:[7,9],latest:7,level:7,link:7,list:[1,7,9],list_directori:1,local:[1,4],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,magic:7,mai:1,maintain:8,make:8,manag:8,manual:8,markdown:7,match:[7,8],maximum:8,method:8,might:9,miss:[4,7],mkdir:7,mlsd:1,mode:1,model:4,modif:1,modifi:[1,7,9],modul:7,month:7,more:7,move:7,multipl:[7,8],name:7,need:[4,8,9],next:7,no_host_key_check:8,none:[1,4,7],note:[7,8],nullabl:4,number:7,object:1,occur:1,octal:1,octob:7,one:8,onli:[1,8],open:4,oper:[2,7,8],option:[1,7,8,9],order:9,out:7,owner:1,page:7,paramet:[1,4,6,7,8],paramiko:[4,8,9],pass:[1,4,8],password:8,path:[1,4,6,7,8],path_exist:1,pathlib:7,per:7,perm:1,permiss:1,pip:7,pitfal:1,pleas:1,point:7,poke:6,poorli:8,port:8,possibl:1,predefin:4,prefix:1,prepar:7,present:[6,8],privat:8,private_kei:[7,8,9],private_key_pass:8,process:7,project:7,protect:8,protocol:[7,9],provid:8,put:[1,4],put_fil:4,pydocstyl:7,pypi:[7,9],pysftp:9,python:[7,9],pyupgrad:7,rc3:7,read:1,readm:[7,9],recurs:1,redund:7,ref:7,refer:[1,9],refernc:7,regener:7,relas:7,relat:8,releas:[7,9],rema:7,remain:7,remot:[1,4,6,8],remote_directori:4,remote_filepath:4,remote_full_path:1,remote_host:4,remov:[1,7],renam:7,replac:[4,7],repositori:9,represent:1,resourc:9,restrict:8,result:1,retrieve_fil:1,retryer:[7,9],rsa:8,run:6,script:7,see:7,self:[1,4,6],sensor:[2,7,8,9],separ:7,serv:4,server:1,set:[1,7,8],setup:7,sftp_client:4,sftp_conn_id:[1,6],sftp_default:[1,6,8],sftphook:[1,7,9],sftpoper:4,sftpsensor:6,should:[1,4,8],show:[7,9],signatur:7,simplifi:7,size:1,sourc:[1,4,6],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],sshtunnel:9,start:1,store_fil:1,str:[1,4,6,8],string:[1,7,8],subject:7,suffix:1,support:[1,7],syntax:8,system:1,take:1,task:4,task_id:4,templat:4,template_field:[4,6],test_sftp:4,thei:4,them:9,thi:[1,4,6,7,8,9],those:9,throughout:1,time:[1,8],tmp1:4,tmp2:4,tmp:4,toc:7,tool:[7,9],top:9,transfer:[1,4,7,9],transport:4,tree:1,trojan:8,troublesom:8,tupl:1,two:8,txt:4,type:[1,7,8,9],typo:7,undeprec:[7,9],uniqu:1,unix:1,unknown:1,updat:[7,9],upgrad:7,uri:8,url:8,usag:7,use:[4,7,8,9],used:[4,8],user:8,usernam:8,uses:4,using:[7,8],utf:7,valu:8,variabl:8,versa:4,version:[7,9],via:[7,9],vice:4,wai:8,wait:6,warn:7,wave:7,when:[4,8,9],where:1,which:[1,4],without:7,word:7,would:[4,8],wrong:7,wrongli:7,ydwwq:8,you:[8,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>"],titleterms:{"default":8,IDs:8,airflow:[0,1,2,3,4,5,6,7,9],apach:[7,9],authent:8,bug:9,changelog:9,configur:8,connect:8,content:[1,4,6,9],cross:9,depend:9,featur:9,fix:9,hook:[0,1],instal:9,modul:[1,4,6],oper:[3,4],packag:[7,9],pip:9,provid:[0,1,2,3,4,5,6,7,9],requir:9,sensor:[5,6],sftp:[0,1,2,3,4,5,6,7,8,9],submodul:[0,3,5],subpackag:2}})