# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import annotations
from collections.abc import Iterable, Sequence
from typing import IO, TYPE_CHECKING, Any, AnyStr
from airflow.providers.common.compat.sdk import BaseOperator
from airflow.providers.microsoft.azure.hooks.data_lake import AzureDataLakeHook, AzureDataLakeStorageV2Hook
if TYPE_CHECKING:
from airflow.utils.context import Context
[docs]
DEFAULT_AZURE_DATA_LAKE_CONN_ID = "azure_data_lake_default"
[docs]
class ADLSCreateObjectOperator(BaseOperator):
"""
Creates a new object from passed data to Azure Data Lake on specified file.
.. seealso::
For more information on how to use this operator, take a look at the guide:
:ref:`howto/operator:ADLSCreateObjectOperator`
:param file_system_name: Name of the file system or instance of FileSystemProperties.
:param file_name: Name of the file which needs to be created in the file system.
:param data: The data that will be uploaded.
:param length: Size of the data in bytes (optional).
:param replace: Whether to forcibly overwrite existing files/directories.
If False and remote path is a directory, will quit regardless if any files
would be overwritten or not. If True, only matching filenames are actually
overwritten.
:param azure_data_lake_conn_id: Reference to the :ref:`Azure Data Lake connection<howto/connection:adl>`.
"""
[docs]
template_fields: Sequence[str] = ("file_system_name", "file_name", "data")
def __init__(
self,
*,
file_system_name: str,
file_name: str,
data: bytes | str | Iterable[AnyStr] | IO[AnyStr],
length: int | None = None,
replace: bool = False,
azure_data_lake_conn_id: str = DEFAULT_AZURE_DATA_LAKE_CONN_ID,
**kwargs,
) -> None:
super().__init__(**kwargs)
[docs]
self.file_system_name = file_system_name
[docs]
self.file_name = file_name
[docs]
self.data = data # type: ignore[var-annotated]
[docs]
self.azure_data_lake_conn_id = azure_data_lake_conn_id
[docs]
def execute(self, context: Context) -> dict[str, Any]:
self.log.debug("Uploading %s to %s", self.data, self.file_name)
hook = AzureDataLakeStorageV2Hook(adls_conn_id=self.azure_data_lake_conn_id)
return hook.create_file(file_system_name=self.file_system_name, file_name=self.file_name).upload_data(
data=self.data, length=self.length, overwrite=self.replace
)
[docs]
class ADLSDeleteOperator(BaseOperator):
"""
Delete files in the specified path.
.. seealso::
For more information on how to use this operator, take a look at the guide:
:ref:`howto/operator:ADLSDeleteOperator`
:param path: A directory or file to remove
:param recursive: Whether to loop into directories in the location and remove the files
:param ignore_not_found: Whether to raise error if file to delete is not found
:param azure_data_lake_conn_id: Reference to the :ref:`Azure Data Lake connection<howto/connection:adl>`.
"""
[docs]
template_fields: Sequence[str] = ("path",)
def __init__(
self,
*,
path: str,
recursive: bool = False,
ignore_not_found: bool = True,
azure_data_lake_conn_id: str = DEFAULT_AZURE_DATA_LAKE_CONN_ID,
**kwargs,
) -> None:
super().__init__(**kwargs)
[docs]
self.recursive = recursive
[docs]
self.ignore_not_found = ignore_not_found
[docs]
self.azure_data_lake_conn_id = azure_data_lake_conn_id
[docs]
def execute(self, context: Context) -> Any:
hook = AzureDataLakeHook(azure_data_lake_conn_id=self.azure_data_lake_conn_id)
return hook.remove(path=self.path, recursive=self.recursive, ignore_not_found=self.ignore_not_found)
[docs]
class ADLSListOperator(BaseOperator):
"""
List all files from the specified path.
This operator returns a python list with the names of files which can be used by
`xcom` in the downstream tasks.
.. seealso::
For more information on how to use this operator, take a look at the guide:
:ref:`howto/operator:ADLSListOperator`
:param path: The Azure Data Lake path to find the objects. Supports glob strings (templated)
:param azure_data_lake_conn_id: Reference to the :ref:`Azure Data Lake connection<howto/connection:adl>`.
"""
[docs]
template_fields: Sequence[str] = ("path",)
def __init__(
self, *, path: str, azure_data_lake_conn_id: str = DEFAULT_AZURE_DATA_LAKE_CONN_ID, **kwargs
) -> None:
super().__init__(**kwargs)
[docs]
self.azure_data_lake_conn_id = azure_data_lake_conn_id
[docs]
def execute(self, context: Context) -> list:
hook = AzureDataLakeHook(azure_data_lake_conn_id=self.azure_data_lake_conn_id)
self.log.info("Getting list of ADLS files in path: %s", self.path)
return hook.list(path=self.path)