airflow.contrib.hooks.sftp_hook

Module Contents

class airflow.contrib.hooks.sftp_hook.SFTPHook(ftp_conn_id='sftp_default', *args, **kwargs)[source]

Bases: airflow.contrib.hooks.ssh_hook.SSHHook

This hook is inherited from SSH hook. Please refer to SSH hook for the input arguments.

Interact with SFTP. Aims to be interchangeable with FTPHook.

Pitfalls:

  • In contrast with FTPHook describe_directory only returns size, type and modify. It doesn’t return unix.owner, unix.mode, perm, unix.group and unique.

  • retrieve_file and store_file only take a local full path and not a

    buffer.

  • If no mode is passed to create_directory it will be created with 777 permissions.

Errors that may occur throughout but should be handled downstream.

get_conn(self)[source]

Returns an SFTP connection object

close_conn(self)[source]

Closes the connection. An error will occur if the connection wasnt ever opened.

describe_directory(self, path)[source]

Returns a dictionary of {filename: {attributes}} for all files on the remote system (where the MLSD command is supported).

Parameters

path (str) – full path to the remote directory

list_directory(self, path)[source]

Returns a list of files on the remote system.

Parameters

path (str) – full path to the remote directory to list

create_directory(self, path, mode=777)[source]

Creates a directory on the remote system.

Parameters

  • path (str) – full path to the remote directory to create

  • mode – int representation of octal mode for directory

delete_directory(self, path)[source]

Deletes a directory on the remote system.

Parameters

path (str) – full path to the remote directory to delete

retrieve_file(self, remote_full_path, local_full_path)[source]

Transfers the remote file to a local location. If local_full_path is a string path, the file will be put at that location

Parameters

  • remote_full_path (str) – full path to the remote file

  • local_full_path (str) – full path to the local file

store_file(self, remote_full_path, local_full_path)[source]

Transfers a local file to the remote location. If local_full_path_or_buffer is a string path, the file will be read from that location

Parameters

  • remote_full_path (str) – full path to the remote file

  • local_full_path (str) – full path to the local file

delete_file(self, path)[source]

Removes a file on the FTP Server

Parameters

path (str) – full path to the remote file

get_mod_time(self, path)[source]
path_exists(self, path)[source]

Returns True if a remote entity exists

Parameters

path (str) – full path to the remote file or directory

Was this entry helpful?