FastETL custom package Apache Airflow provider.
Project description
FastETL framework, modern, versatile, does almost everything.
Este texto também está disponível em português: 🇧🇷LEIAME.md.
FastETL is a plugins package for Airflow for building data pipelines for a number of common scenarios.
Main features:
- Full or incremental replication of tables in SQL Server, Postgres and MySQL databases
- Load data from GSheets and from spreadsheets on Samba/Windows networks
- Extracting CSV from SQL
- Clean data using custom data patching tasks (e.g. for messy geographical coordinates, mapping canonical values for columns, etc.)
- Using a Open Street Routing Machine service to calculate route distances
- Using CKAN or dados.gov.br's API to update dataset metadata
- Using Frictionless Tabular Data Packages to write OpenDocument Text format data dictionaries
This framework is maintained by a network of developers from many teams at the Ministry of Management and Innovation in Public Services and is the cumulative result of using Apache Airflow, a free and open source tool, starting in 2019.
For government: FastETL is widely used for replication of data queried via Quartzo (DaaS) from Serpro.
Installation in Airflow
FastETL implements the standards for Airflow plugins. To install it,
simply add the apache-airflow-providers-fastetl
package to your
Python dependencies in your Airflow environment.
Or install it with
pip install apache-airflow-providers-fastetl
To see an example of an Apache Airflow container that uses FastETL, check out the airflow2-docker repository.
To ensure appropriate results, please make sure to install the
msodbcsql17
and unixodbc-dev
libraries on your Apache Airflow workers.
Tests
The test suite uses Docker containers to simulate a complete use environment, including Airflow and the databases. For that reason, to execute the tests, you first need to install Docker and docker-compose.
For instructions on how to do this, see the official Docker documentation.
To build the containers:
make setup
To run the tests, use:
make setup && make tests
To shutdown the environment, use:
make down
Usage examples
The main FastETL feature is the DbToDbOperator
operator. It copies data
between postgres
and mssql
databases. MySQL is also supported as a
source.
Here goes an example:
from datetime import datetime
from airflow import DAG
from fastetl.operators.db_to_db_operator import DbToDbOperator
default_args = {
"start_date": datetime(2023, 4, 1),
}
dag = DAG(
"copy_db_to_db_example",
default_args=default_args,
schedule_interval=None,
)
t0 = DbToDbOperator(
task_id="copy_data",
source={
"conn_id": airflow_source_conn_id,
"schema": source_schema,
"table": table_name,
},
destination={
"conn_id": airflow_dest_conn_id,
"schema": dest_schema,
"table": table_name,
},
destination_truncate=True,
copy_table_comments=True,
chunksize=10000,
dag=dag,
)
More detail about the parameters and the workings of DbToDbOperator
can bee seen on the following files:
How to contribute
To be written on the CONTRIBUTING.md
document (issue
#4).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file apache_airflow_providers_fastetl-0.0.37.tar.gz
.
File metadata
- Download URL: apache_airflow_providers_fastetl-0.0.37.tar.gz
- Upload date:
- Size: 76.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee2cc84567412efd85cec00db51cfa7fecb030f4ea213ebd44ef2a454b3e4417 |
|
MD5 | b79882dcc3368860c4d3c8481d6923df |
|
BLAKE2b-256 | b9b30c6c2bf0202ea3078d570d54a027b2438794b86a2611f78c0049b2a66bcf |
File details
Details for the file apache_airflow_providers_fastetl-0.0.37-py3-none-any.whl
.
File metadata
- Download URL: apache_airflow_providers_fastetl-0.0.37-py3-none-any.whl
- Upload date:
- Size: 82.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b44337fab589fb3b179d7235d3bfd53065b5ab4e4c0f41f7de260b639c9d320d |
|
MD5 | c1fc32b263dadb6c027ef9b4ac7ab5ec |
|
BLAKE2b-256 | 9e04fd7394ab2ae58bf4ffce6c4a4815d25dace79c80bc2a46aa655788686447 |