Apache Airflow Samba Provider

4.12.5 · active · verified Tue Apr 14

The `apache-airflow-providers-samba` library provides Apache Airflow operators and hooks for interacting with Samba (SMB/CIFS) file shares. It enables users to perform file operations like reading, writing, moving, and deleting files on Samba servers directly within Airflow DAGs. The current version is 4.12.5, and it follows a regular release cadence as part of the Apache Airflow provider ecosystem, with versioning independent of Airflow core but with specific minimum Airflow version requirements.

Warnings

breaking Provider versions have specific minimum Apache Airflow core version requirements. For example, `apache-airflow-providers-samba` version 4.12.x requires Airflow 2.11+ due to internal API changes like the removal of the `apply_default` decorator.
Fix: Ensure your Airflow core installation meets or exceeds the minimum version specified in the provider's changelog or documentation for the installed provider version. For 4.12.x, upgrade Airflow to 2.11+.
gotcha When interacting with Windows Samba shares, using forward slashes (/) in paths may lead to `STATUS_INVALID_PARAMETER` errors. The underlying `smbclient` library often expects backslashes (\) or proper handling of path types.
Fix: Use the `share_type='windows'` parameter in your Samba connection's 'Extra' field (`{"share_type": "windows"}`) or explicitly use Windows path separators (`\`) in your paths if the `share_type` is not set or defaults to 'posix'.
deprecated The old import path `airflow.hooks.samba_hook` has been deprecated.
Fix: Update your imports to use `from airflow.providers.samba.hooks.samba import SambaHook`.
gotcha Some users have reported issues with Kerberos authentication (`SpnegoError`) when using `SambaHook`, even when direct `smbclient` commands work outside Airflow.
Fix: Ensure `pysmbclient` is up-to-date. Verify that Kerberos configuration (keytabs, krb5.conf) is correctly set up for the user running Airflow workers. Consider explicit `auth` parameter in 'Extra' field of the connection if supported by `pysmbclient`'s underlying mechanisms.

Install

pip install apache-airflow-providers-samba Install with pip

Imports

SambaHook
```
from airflow.providers.samba.hooks.samba import SambaHook
```
The old `airflow.hooks.samba_hook` module is deprecated; use the provider-specific path.

SambaOperator

from airflow.providers.samba.operators.samba import SambaOperator

Quickstart

This quickstart demonstrates how to use the `SambaOperator` to move a file on a Samba share. It requires an Airflow connection named `samba_default` to be configured with the Samba server details. The `operation` parameter can be 'move', 'read', 'write', or 'delete'.

from __future__ import annotations

import pendulum

from airflow.models.dag import DAG
from airflow.providers.samba.operators.samba import SambaOperator

with DAG(
    dag_id="samba_file_operations_example",
    start_date=pendulum.datetime(2023, 1, 1, tz="UTC"),
    catchup=False,
    schedule=None,
    tags=["samba", "file_transfer"],
) as dag:
    # This task assumes an Airflow Connection named 'samba_default' is configured.
    # Configure a connection in the Airflow UI:
    # Conn Id: samba_default
    # Conn Type: Samba
    # Host: <Samba Server IP/Hostname>
    # Login: <Samba Username>
    # Password: <Samba Password>
    # Schema: <Optional default share name, e.g., 'share'>
    # Extra: {"share_type": "posix"} or {"share_type": "windows"}

    move_file_task = SambaOperator(
        task_id="move_samba_file",
        samba_conn_id="samba_default",
        source_path="/source/path/file.txt",
        destination_path="/destination/path/file.txt",
        operation="move",  # Other supported operations: 'read', 'write', 'delete'
    )

view raw JSON →