| :py:mod:`airflow.hooks.filesystem` |
| ================================== |
| |
| .. py:module:: airflow.hooks.filesystem |
| |
| |
| Module Contents |
| --------------- |
| |
| Classes |
| ~~~~~~~ |
| |
| .. autoapisummary:: |
| |
| airflow.hooks.filesystem.FSHook |
| |
| |
| |
| |
| .. py:class:: FSHook(conn_id='fs_default') |
| |
| Bases: :py:obj:`airflow.hooks.base.BaseHook` |
| |
| Allows for interaction with an file server. |
| |
| Connection should have a name and a path specified under extra: |
| |
| example: |
| Connection Id: fs_test |
| Connection Type: File (path) |
| Host, Schema, Login, Password, Port: empty |
| Extra: {"path": "/tmp"} |
| |
| .. py:method:: get_conn(self) |
| |
| Returns connection for the hook. |
| |
| |
| .. py:method:: get_path(self) -> str |
| |
| Get the path to the filesystem location. |
| |
| :return: the path. |
| |
| |
| |
