blob: 3ca9818c57c2a3dd83f39d07c3e39087ae4c9113 [file] [log] [blame]
:mod:`airflow.providers.samba.hooks.samba`
==========================================
.. py:module:: airflow.providers.samba.hooks.samba
Module Contents
---------------
.. py:class:: SambaHook(samba_conn_id: str = default_conn_name)
Bases: :class:`airflow.hooks.base.BaseHook`
Allows for interaction with an samba server.
.. attribute:: conn_name_attr
:annotation: = samba_conn_id
.. attribute:: default_conn_name
:annotation: = samba_default
.. attribute:: conn_type
:annotation: = samba
.. attribute:: hook_name
:annotation: = Samba
.. method:: get_conn(self)
Return a samba client object.
You can provide optional parameters in the extra fields of
your connection.
Below is an inexhaustive list of these parameters:
`logdir`
Base directory name for log/debug files.
`kerberos`
Try to authenticate with kerberos.
`workgroup`
Set the SMB domain of the username.
`netbios_name`
This option allows you to override the NetBIOS name that
Samba uses for itself.
For additional details, see `smbclient.SambaClient`.
.. method:: push_from_local(self, destination_filepath: str, local_filepath: str)
Push local file to samba server