airflow.providers.google.cloud.transfers.adls_to_gcs

This module contains Azure Data Lake Storage to Google Cloud Storage operator.

Module Contents

Classes

ADLSToGCSOperator

Synchronizes an Azure Data Lake Storage path with a GCS bucket.
class airflow.providers.google.cloud.transfers.adls_to_gcs.ADLSToGCSOperator(*, src_adls, dest_gcs, azure_data_lake_conn_id, gcp_conn_id='google_cloud_default', replace=False, gzip=False, google_impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.microsoft.azure.operators.adls.ADLSListOperator

Synchronizes an Azure Data Lake Storage path with a GCS bucket.

Parameters

  • src_adls (str) – The Azure Data Lake path to find the objects (templated)

  • dest_gcs (str) – The Google Cloud Storage bucket and prefix to store the objects. (templated)

  • replace (bool) – If true, replaces same-named files in GCS

  • gzip (bool) – Option to compress file for upload

  • azure_data_lake_conn_id (str) – The connection ID to use when connecting to Azure Data Lake Storage.

  • gcp_conn_id (str) – (Optional) The connection ID used to connect to Google Cloud.

  • google_impersonation_chain (str | Sequence[str] | None) – Optional Google service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

Examples:

The following Operator would copy a single file named hello/world.avro from ADLS to the GCS bucket mybucket. Its full resulting gcs path will be gs://mybucket/hello/world.avro

copy_single_file = AdlsToGoogleCloudStorageOperator(
    task_id="copy_single_file",
    src_adls="hello/world.avro",
    dest_gcs="gs://mybucket",
    replace=False,
    azure_data_lake_conn_id="azure_data_lake_default",
    gcp_conn_id="google_cloud_default",
)

The following Operator would copy all parquet files from ADLS to the GCS bucket mybucket.

   copy_all_files = AdlsToGoogleCloudStorageOperator(
       task_id='copy_all_files',
       src_adls='*.parquet',
       dest_gcs='gs://mybucket',
       replace=False,
       azure_data_lake_conn_id='azure_data_lake_default',
       gcp_conn_id='google_cloud_default'
   )

The following Operator would copy all parquet files from ADLS
path ``/hello/world``to the GCS bucket ``mybucket``. ::

   copy_world_files = AdlsToGoogleCloudStorageOperator(
       task_id='copy_world_files',
       src_adls='hello/world/*.parquet',
       dest_gcs='gs://mybucket',
       replace=False,
       azure_data_lake_conn_id='azure_data_lake_default',
       gcp_conn_id='google_cloud_default'
   )
template_fields: Sequence[str] = ('src_adls', 'dest_gcs', 'google_impersonation_chain')[source]
ui_color = '#f0eee4'[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

Was this entry helpful?