Skip to main content

A Fivetran async provider for Apache Airflow

Project description

Fivetran Async Provider for Apache Airflow

This package provides an async operator, sensor and hook that integrates Fivetran into Apache Airflow. FivetranSensorAsync allows you to monitor a Fivetran sync job for completion before running downstream processes. FivetranOperatorAsync submits a Fivetran sync job and polls for its status on the triggerer. Since an async sensor or operator frees up worker slot while polling is happening on the triggerer, they consume less resources when compared to traditional "sync" sensors and operators.

Fivetran automates your data pipeline, and Airflow automates your data processing.

Installation

Prerequisites: An environment running apache-airflow.

pip install airflow-provider-fivetran-async

Configuration

In the Airflow user interface, configure a Connection for Fivetran. Most of the Connection config fields will be left blank. Configure the following fields:

  • Conn Id: fivetran
  • Conn Type: Fivetran
  • Login: Fivetran API Key
  • Password: Fivetran API Secret

Find the Fivetran API Key and Secret in the Fivetran Account Settings, under the API Config section. See our documentation for more information on Fivetran API Authentication.

The sensor assumes the Conn Id is set to fivetran, however if you are managing multiple Fivetran accounts, you can set this to anything you like. See the DAG in examples to see how to specify a custom Conn Id.

Modules

Fivetran Operator Async

FivetranOperatorAsync submits a Fivetran sync job and monitors it on trigger for completion. It requires that you specify the connector_id of the sync job to start. You can find connector_id in the Settings page of the connector you configured in the Fivetran dashboard.

Import into your DAG via:

from fivetran_provider_async.operators import FivetranOperatorAsync

Fivetran Sensor Async

FivetranSensorAsync monitors a Fivetran sync job for completion. Monitoring with FivetranSensorAsync allows you to trigger downstream processes only when the Fivetran sync jobs have completed, ensuring data consistency.

You can use multiple instances of FivetranSensorAsync to monitor multiple Fivetran connectors.

If used in this way,

FivetranSensorAsync requires that you specify the connector_id of the sync job to start. You can find connector_id in the Settings page of the connector you configured in the Fivetran dashboard.

Import into your DAG via:

from fivetran_provider_async.sensors import FivetranSensorAsync

Examples

See the examples directory for an example DAG.

Issues

Please submit issues and pull requests in our official repo: https://github.com/astronomer/airflow-provider-fivetran-async

We are happy to hear from you. Please email any feedback to the authors at humans@astronomer.io.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airflow-provider-fivetran-async-1.0.0a5.tar.gz (16.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file airflow-provider-fivetran-async-1.0.0a5.tar.gz.

File metadata

File hashes

Hashes for airflow-provider-fivetran-async-1.0.0a5.tar.gz
Algorithm Hash digest
SHA256 7970f38bf0ae53dca2b419418cd3104e7240c28f4e0ef98fc5513fccf5c0af8d
MD5 97a7a0944c1c9d4a984034fa69738330
BLAKE2b-256 4885e21b1344256338ec341884e82f96835a0db33df97dacda4fc71e58f6a03c

See more details on using hashes here.

File details

Details for the file airflow_provider_fivetran_async-1.0.0a5-py3-none-any.whl.

File metadata

File hashes

Hashes for airflow_provider_fivetran_async-1.0.0a5-py3-none-any.whl
Algorithm Hash digest
SHA256 c4403b0be2d4559ca439e0394faab88cbd1d89078056223c435712a9717b7b5a
MD5 e90dae64fddf685093ea0d4176bf47af
BLAKE2b-256 2f45f279bdb393468f2cdee1cbc6e3246ef15fb4ac1f6909f86ead44dd731097

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page