Skip to content

A tool migrate Airflow DAGs to DolphinScheduler Python SDK files.

License

Notifications You must be signed in to change notification settings

WhaleOps/air2phin

Repository files navigation

Air2phin

PyPi Version PyPi Python Versions PyPi License PyPi Status Downloads Coverage Status Code style: black Imports: isort CI Documentation Status

air2phin is a tool for migrating Airflow DAGs to DolphinScheduler Python API.

Installation

For now, it just for test and without publish to pypi but will be adding in the future. You could still install locally by yourself.

python -m pip install --upgrade air2phin

Quick Start

Here will give a quick example to show how to migrate base on standard input.

# Quick test the migrate rule for standard input
# Can also add option `--diff` to see the diff detail of this migrate
air2phin test "from airflow.operators.bash import BashOperator

test = BashOperator(
    task_id='test',
    bash_command='echo 1',
)
"

And you will see the migrated result in the standard output. air2phin can only migrate standard input, it can also migrate file, directory and even can use in your python code. For more detail, please see our usage.

Documentation

The documentation host on read the doc and is available at https://air2phin.readthedocs.io.

Support Statement

For now, we support following statement from Airflow's DAG files

DAG

Before Migration After Migration
from airflow import DAG from pydolphinscheduler.core.process_definition import ProcessDefinition
with DAG(...) as dag: pass with ProcessDefinition(...) as dag: pass

Operators

Dummy Operator

Before Migration After Migration
from airflow.operators.dummy_operator import DummyOperator from pydolphinscheduler.tasks.shell import Shell
from airflow.operators.dummy import DummyOperator from pydolphinscheduler.tasks.shell import Shell
dummy = DummyOperator(...) dummy = Shell(..., command="echo 'airflow dummy operator'")

Shell Operator

Before Migration After Migration
from airflow.operators.bash import BashOperator from pydolphinscheduler.tasks.shell import Shell
bash = BashOperator(...) bash = Shell(...)

Spark Sql Operator

Before Migration After Migration
from airflow.operators.spark_sql_operator import SparkSqlOperator from pydolphinscheduler.tasks.sql import Sql
spark = SparkSqlOperator(...) spark = Sql(...)

Python Operator

Before Migration After Migration
from airflow.operators.python_operator import PythonOperator from pydolphinscheduler.tasks.python import Python
python = PythonOperator(...) python = Python(...)