`airflow.providers.google.cloud.transfers.adls_to_gcs`¶

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

Module Contents¶

class airflow.providers.google.cloud.transfers.adls_to_gcs.ADLSToGCSOperator(*, src_adls: str, dest_gcs: str, azure_data_lake_conn_id: str, gcp_conn_id: str = 'google_cloud_default', google_cloud_storage_conn_id: Optional[str] = None, delegate_to: Optional[str] = None, replace: bool = False, gzip: bool = False, google_impersonation_chain: Optional[Union[str, Sequence[str]]] = 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_cloud_storage_conn_id (str) – (Deprecated) The connection ID used to connect to Google Cloud. This parameter has been deprecated. You should pass the gcp_conn_id parameter instead.
delegate_to (str) – Google account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled.
google_impersonation_chain (Union[str, Sequence[str]]) – 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(self, context)[source]¶

airflow.providers.google.cloud.transfers.adls_to_gcs¶

Module Contents¶

`airflow.providers.google.cloud.transfers.adls_to_gcs`¶