| :py:mod:`airflow.providers.samba.hooks.samba` |
| ============================================= |
| |
| .. py:module:: airflow.providers.samba.hooks.samba |
| |
| |
| Module Contents |
| --------------- |
| |
| Classes |
| ~~~~~~~ |
| |
| .. autoapisummary:: |
| |
| airflow.providers.samba.hooks.samba.SambaHook |
| |
| |
| |
| |
| .. py:class:: SambaHook(samba_conn_id = default_conn_name, share = None) |
| |
| Bases: :py:obj:`airflow.hooks.base.BaseHook` |
| |
| Allows for interaction with a Samba server. |
| |
| The hook should be used as a context manager in order to correctly |
| set up a session and disconnect open connections upon exit. |
| |
| :param samba_conn_id: The connection id reference. |
| :param share: |
| An optional share name. If this is unset then the "schema" field of |
| the connection is used in its place. |
| |
| .. py:attribute:: conn_name_attr |
| :annotation: = samba_conn_id |
| |
| |
| |
| .. py:attribute:: default_conn_name |
| :annotation: = samba_default |
| |
| |
| |
| .. py:attribute:: conn_type |
| :annotation: = samba |
| |
| |
| |
| .. py:attribute:: hook_name |
| :annotation: = Samba |
| |
| |
| |
| .. py:method:: __enter__(self) |
| |
| |
| .. py:method:: __exit__(self, exc_type, exc_value, traceback) |
| |
| |
| .. py:method:: link(self, src, dst, follow_symlinks=True) |
| |
| |
| .. py:method:: listdir(self, path) |
| |
| |
| .. py:method:: lstat(self, path) |
| |
| |
| .. py:method:: makedirs(self, path, exist_ok=False) |
| |
| |
| .. py:method:: mkdir(self, path) |
| |
| |
| .. py:method:: open_file(self, path, mode='r', buffering=-1, encoding=None, errors=None, newline=None, share_access=None, desired_access=None, file_attributes=None, file_type='file') |
| |
| |
| .. py:method:: readlink(self, path) |
| |
| |
| .. py:method:: remove(self, path) |
| |
| |
| .. py:method:: removedirs(self, path) |
| |
| |
| .. py:method:: rename(self, src, dst) |
| |
| |
| .. py:method:: replace(self, src, dst) |
| |
| |
| .. py:method:: rmdir(self, path) |
| |
| |
| .. py:method:: scandir(self, path, search_pattern='*') |
| |
| |
| .. py:method:: stat(self, path, follow_symlinks=True) |
| |
| |
| .. py:method:: stat_volume(self, path) |
| |
| |
| .. py:method:: symlink(self, src, dst, target_is_directory=False) |
| |
| |
| .. py:method:: truncate(self, path, length) |
| |
| |
| .. py:method:: unlink(self, path) |
| |
| |
| .. py:method:: utime(self, path, times=None, ns=None, follow_symlinks=True) |
| |
| |
| .. py:method:: walk(self, path, topdown=True, onerror=None, follow_symlinks=False) |
| |
| |
| .. py:method:: getxattr(self, path, attribute, follow_symlinks=True) |
| |
| |
| .. py:method:: listxattr(self, path, follow_symlinks=True) |
| |
| |
| .. py:method:: removexattr(self, path, attribute, follow_symlinks=True) |
| |
| |
| .. py:method:: setxattr(self, path, attribute, value, flags=0, follow_symlinks=True) |
| |
| |
| .. py:method:: push_from_local(self, destination_filepath, local_filepath) |
| |
| Push local file to samba server |
| |
| |
| |