-
Notifications
You must be signed in to change notification settings - Fork 14.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[AIRFLOW-5718] Add SFTPToGoogleCloudStorageOperator (#6393)
- Loading branch information
Showing
7 changed files
with
774 additions
and
0 deletions.
There are no files selected for viewing
79 changes: 79 additions & 0 deletions
79
airflow/providers/google/cloud/example_dags/example_sftp_to_gcs.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# -*- coding: utf-8 -*- | ||
# | ||
# 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. | ||
""" | ||
Example Airflow DAG for Google Cloud Storage to SFTP transfer operators. | ||
""" | ||
|
||
import os | ||
|
||
import airflow | ||
from airflow import models | ||
from airflow.providers.google.cloud.operators.sftp_to_gcs import SFTPToGoogleCloudStorageOperator | ||
|
||
default_args = {"start_date": airflow.utils.dates.days_ago(1)} | ||
|
||
BUCKET_SRC = os.environ.get("GCP_GCS_BUCKET_1_SRC", "test-sftp-gcs") | ||
|
||
TMP_PATH = "/tmp" | ||
DIR = "tests_sftp_hook_dir" | ||
SUBDIR = "subdir" | ||
|
||
OBJECT_SRC_1 = "parent-1.bin" | ||
OBJECT_SRC_2 = "parent-2.bin" | ||
OBJECT_SRC_3 = "parent-3.txt" | ||
|
||
|
||
with models.DAG( | ||
"example_sftp_to_gcs", default_args=default_args, schedule_interval=None | ||
) as dag: | ||
# [START howto_operator_sftp_to_gcs_copy_single_file] | ||
copy_file_from_sftp_to_gcs = SFTPToGoogleCloudStorageOperator( | ||
task_id="file-copy-sftp-to-gcs", | ||
source_path=os.path.join(TMP_PATH, DIR, OBJECT_SRC_1), | ||
destination_bucket=BUCKET_SRC, | ||
) | ||
# [END howto_operator_sftp_to_gcs_copy_single_file] | ||
|
||
# [START howto_operator_sftp_to_gcs_move_single_file_destination] | ||
move_file_from_sftp_to_gcs_destination = SFTPToGoogleCloudStorageOperator( | ||
task_id="file-move-sftp-to-gcs-destination", | ||
source_path=os.path.join(TMP_PATH, DIR, OBJECT_SRC_2), | ||
destination_bucket=BUCKET_SRC, | ||
destination_path="destination_dir/destination_filename.bin", | ||
move_object=True, | ||
) | ||
# [END howto_operator_sftp_to_gcs_move_single_file_destination] | ||
|
||
# [START howto_operator_sftp_to_gcs_copy_directory] | ||
copy_directory_from_sftp_to_gcs = SFTPToGoogleCloudStorageOperator( | ||
task_id="dir-copy-sftp-to-gcs", | ||
source_path=os.path.join(TMP_PATH, DIR, SUBDIR, "*"), | ||
destination_bucket=BUCKET_SRC, | ||
) | ||
# [END howto_operator_sftp_to_gcs_copy_directory] | ||
|
||
# [START howto_operator_sftp_to_gcs_move_specific_files] | ||
move_specific_files_from_gcs_to_sftp = SFTPToGoogleCloudStorageOperator( | ||
task_id="dir-move-specific-files-sftp-to-gcs", | ||
source_path=os.path.join(TMP_PATH, DIR, SUBDIR, "*.bin"), | ||
destination_bucket=BUCKET_SRC, | ||
destination_path="specific_files/", | ||
move_object=True, | ||
) | ||
# [END howto_operator_sftp_to_gcs_move_specific_files] |
178 changes: 178 additions & 0 deletions
178
airflow/providers/google/cloud/operators/sftp_to_gcs.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,178 @@ | ||
# | ||
# 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. | ||
""" | ||
This module contains SFTP to Google Cloud Storage operator. | ||
""" | ||
import os | ||
from tempfile import NamedTemporaryFile | ||
from typing import Optional, Union | ||
|
||
from airflow import AirflowException | ||
from airflow.contrib.hooks.sftp_hook import SFTPHook | ||
from airflow.gcp.hooks.gcs import GoogleCloudStorageHook | ||
from airflow.models import BaseOperator | ||
from airflow.utils.decorators import apply_defaults | ||
|
||
WILDCARD = "*" | ||
|
||
|
||
class SFTPToGoogleCloudStorageOperator(BaseOperator): | ||
""" | ||
Transfer files to Google Cloud Storage from SFTP server. | ||
.. seealso:: | ||
For more information on how to use this operator, take a look at the guide: | ||
:ref:`howto/operator:SFTPToGoogleCloudStorageOperator` | ||
:param source_path: The sftp remote path. This is the specified file path | ||
for downloading the single file or multiple files from the SFTP server. | ||
You can use only one wildcard within your path. The wildcard can appear | ||
inside the path or at the end of the path. | ||
:type source_path: str | ||
:param destination_bucket: The bucket to upload to. | ||
:type destination_bucket: str | ||
:param destination_path: The destination name of the object in the | ||
destination Google Cloud Storage bucket. | ||
If destination_path is not provided file/files will be placed in the | ||
main bucket path. | ||
If a wildcard is supplied in the destination_path argument, this is the | ||
prefix that will be prepended to the final destination objects' paths. | ||
:type destination_path: str | ||
:param gcp_conn_id: (Optional) The connection ID used to connect to Google Cloud Platform. | ||
:type gcp_conn_id: str | ||
:param sftp_conn_id: The sftp connection id. The name or identifier for | ||
establishing a connection to the SFTP server. | ||
:type sftp_conn_id: str | ||
:param delegate_to: The account to impersonate, if any | ||
:type delegate_to: str | ||
:param mime_type: The mime-type string | ||
:type mime_type: str | ||
:param gzip: Allows for file to be compressed and uploaded as gzip | ||
:type gzip: bool | ||
:param move_object: When move object is True, the object is moved instead | ||
of copied to the new location. This is the equivalent of a mv command | ||
as opposed to a cp command. | ||
:type move_object: bool | ||
""" | ||
|
||
template_fields = ("source_path", "destination_path", "destination_bucket") | ||
|
||
@apply_defaults | ||
def __init__( | ||
self, | ||
source_path: str, | ||
destination_bucket: str, | ||
destination_path: Optional[str] = None, | ||
gcp_conn_id: str = "google_cloud_default", | ||
sftp_conn_id: str = "ssh_default", | ||
delegate_to: Optional[str] = None, | ||
mime_type: str = "application/octet-stream", | ||
gzip: bool = False, | ||
move_object: bool = False, | ||
*args, | ||
**kwargs | ||
) -> None: | ||
super().__init__(*args, **kwargs) | ||
|
||
self.source_path = source_path | ||
self.destination_path = self._set_destination_path(destination_path) | ||
self.destination_bucket = self._set_bucket_name(destination_bucket) | ||
self.gcp_conn_id = gcp_conn_id | ||
self.mime_type = mime_type | ||
self.delegate_to = delegate_to | ||
self.gzip = gzip | ||
self.sftp_conn_id = sftp_conn_id | ||
self.move_object = move_object | ||
|
||
def execute(self, context): | ||
gcs_hook = GoogleCloudStorageHook( | ||
gcp_conn_id=self.gcp_conn_id, delegate_to=self.delegate_to | ||
) | ||
|
||
sftp_hook = SFTPHook(self.sftp_conn_id) | ||
|
||
if WILDCARD in self.source_path: | ||
total_wildcards = self.source_path.count(WILDCARD) | ||
if total_wildcards > 1: | ||
raise AirflowException( | ||
"Only one wildcard '*' is allowed in source_path parameter. " | ||
"Found {} in {}.".format(total_wildcards, self.source_path) | ||
) | ||
|
||
prefix, delimiter = self.source_path.split(WILDCARD, 1) | ||
base_path = os.path.dirname(prefix) | ||
|
||
files, _, _ = sftp_hook.get_tree_map( | ||
base_path, prefix=prefix, delimiter=delimiter | ||
) | ||
|
||
for file in files: | ||
destination_path = file.replace(base_path, self.destination_path, 1) | ||
self._copy_single_object(gcs_hook, sftp_hook, file, destination_path) | ||
|
||
else: | ||
destination_object = ( | ||
self.destination_path | ||
if self.destination_path | ||
else self.source_path.rsplit("/", 1)[1] | ||
) | ||
self._copy_single_object( | ||
gcs_hook, sftp_hook, self.source_path, destination_object | ||
) | ||
|
||
def _copy_single_object( | ||
self, | ||
gcs_hook: GoogleCloudStorageHook, | ||
sftp_hook: SFTPHook, | ||
source_path: str, | ||
destination_object: str, | ||
) -> None: | ||
""" | ||
Helper function to copy single object. | ||
""" | ||
self.log.info( | ||
"Executing copy of %s to gs://%s/%s", | ||
source_path, | ||
self.destination_bucket, | ||
destination_object, | ||
) | ||
|
||
with NamedTemporaryFile("w") as tmp: | ||
sftp_hook.retrieve_file(source_path, tmp.name) | ||
|
||
gcs_hook.upload( | ||
bucket_name=self.destination_bucket, | ||
object_name=destination_object, | ||
filename=tmp.name, | ||
mime_type=self.mime_type, | ||
) | ||
|
||
if self.move_object: | ||
self.log.info("Executing delete of %s", source_path) | ||
sftp_hook.delete_file(source_path) | ||
|
||
@staticmethod | ||
def _set_destination_path(path: Union[str, None]) -> str: | ||
if path is not None: | ||
return path.lstrip("/") if path.startswith("/") else path | ||
return "" | ||
|
||
@staticmethod | ||
def _set_bucket_name(name: str) -> str: | ||
bucket = name if not name.startswith("gs://") else name[5:] | ||
return bucket.strip("/") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
.. 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. | ||
SFTP to Google Cloud Storage Transfer Operator | ||
============================================== | ||
|
||
Google has a service `Google Cloud Storage <https://cloud.google.com/storage/>`__. This service is | ||
used to store large data from various applications. | ||
SFTP (SSH File Transfer Protocol) is a secure file transfer protocol. | ||
It runs over the SSH protocol. It supports the full security and authentication functionality of the SSH. | ||
|
||
|
||
.. contents:: | ||
:depth: 1 | ||
:local: | ||
|
||
Prerequisite Tasks | ||
^^^^^^^^^^^^^^^^^^ | ||
|
||
.. include:: _partials/prerequisite_tasks.rst | ||
|
||
.. _howto/operator:SFTPToGoogleCloudStorageOperator: | ||
|
||
Operator | ||
^^^^^^^^ | ||
|
||
Transfer files between SFTP and Google Storage is performed with the | ||
:class:`~airflow.providers.google.cloud.operators.sftp_to_gcs.SFTPToGoogleCloudStorageOperator` operator. | ||
|
||
Use :ref:`Jinja templating <jinja-templating>` with | ||
:template-fields:`airflow.providers.google.cloud.operators.sftp_to_gcs.SFTPToGoogleCloudStorageOperator` | ||
to define values dynamically. | ||
|
||
Copying single files | ||
-------------------- | ||
|
||
The following Operator copies a single file. | ||
|
||
.. exampleinclude:: ../../../../airflow/providers/google/cloud/example_dags/example_sftp_to_gcs.py | ||
:language: python | ||
:dedent: 4 | ||
:start-after: [START howto_operator_sftp_to_gcs_copy_single_file] | ||
:end-before: [END howto_operator_sftp_to_gcs_copy_single_file] | ||
|
||
Moving a single file | ||
-------------------- | ||
|
||
To move the file use the ``move_object`` parameter. Once the file is copied to Google Storage, | ||
the original file from the SFTP is deleted. | ||
The ``destination_path`` parameter defines the full path of the file in the bucket. | ||
|
||
.. exampleinclude:: ../../../../airflow/providers/google/cloud/example_dags/example_sftp_to_gcs.py | ||
:language: python | ||
:dedent: 4 | ||
:start-after: [START howto_operator_sftp_to_gcs_move_single_file_destination] | ||
:end-before: [END howto_operator_sftp_to_gcs_move_single_file_destination] | ||
|
||
|
||
Copying directory | ||
----------------- | ||
|
||
Use the ``wildcard`` in ``source_path`` parameter to copy the directory. | ||
|
||
.. exampleinclude:: ../../../../airflow/providers/google/cloud/example_dags/example_sftp_to_gcs.py | ||
:language: python | ||
:dedent: 4 | ||
:start-after: [START howto_operator_sftp_to_gcs_copy_directory] | ||
:end-before: [END howto_operator_sftp_to_gcs_copy_directory] | ||
|
||
Moving specific files | ||
--------------------- | ||
|
||
Use the ``wildcard`` in ``source_path`` parameter to move the specific files. | ||
You can use only one wildcard within your path. | ||
The ``destination_path`` defines the path that is prefixed to all copied files, | ||
e.g. ``tests_sftp_hook_dir/subdir/parent-1.bin`` is copied to ``specific_files/parent-1.bin``, | ||
and ``tests_sftp_hook_dir/subdir/parent-2.bin`` is copied to ``specific_files/parent-2.bin`` . | ||
``tests_sftp_hook_dir/subdir/parent-3.txt`` is skipped. | ||
|
||
.. exampleinclude:: ../../../../airflow/providers/google/cloud/example_dags/example_sftp_to_gcs.py | ||
:language: python | ||
:dedent: 4 | ||
:start-after: [START howto_operator_sftp_to_gcs_move_specific_files] | ||
:end-before: [END howto_operator_sftp_to_gcs_move_specific_files] | ||
|
||
Reference | ||
^^^^^^^^^ | ||
|
||
For more information, see | ||
|
||
* `Google Cloud Storage Documentation <https://cloud.google.com/storage/>`__ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.