Airflow has a number of optional "extras" that you can use to add features to your installation when you are installing Airflow. Those extras are a good way for the users to manage their installation, but also they are useful for contributors to airflow when they want to contribute some of the features - including optional integrations of Airflow - via providers.
Warning
Traditionally in Airflow some of the extras used . and _ to separate the parts of the extra name. This was not PEP-685 normalized name and we opted to change it to to - for all our extras, Expecting that PEP-685 will be implemented in full by pip and other tools we change all our extras to use - as separator even if in some cases it will introduce warnings (the warnings are harmless). This is future proof approach. It's also fully backwards-compatible if you use _ or . in your extras, but we recommend using - as separator in the future.
Here's the list of all the extra dependencies of Apache Airflow.
These are core airflow extras that extend capabilities of core Airflow. They usually do not install provider
packages (with the exception of celery
and cncf.kubernetes
extras), they just install necessary
python dependencies for the provided package.
extra | install command | enables |
---|---|---|
aiobotocore | pip install 'apache-airflow[aiobotocore]' |
Support for asynchronous (deferrable) operators for Amazon integration |
async | pip install 'apache-airflow[async]' |
Async worker classes for Gunicorn |
cgroups | pip install 'apache-airflow[cgroups]' |
Needed To use CgroupTaskRunner |
deprecated-api | pip install 'apache-airflow[deprecated-api]' |
Deprecated, experimental API that is replaced with the new REST API |
github-enterprise | pip install 'apache-airflow[github-enterprise]' |
GitHub Enterprise auth backend |
google-auth | pip install 'apache-airflow[google-auth]' |
Google auth backend |
graphviz | pip install 'apache-airflow[graphvis]' |
Enables exporting DAGs to .dot graphical output |
graphviz | pip install 'apache-airflow[graphviz]' |
Graphviz renderer for converting DAG to graphical output |
kerberos | pip install 'apache-airflow[kerberos]' |
Kerberos integration for Kerberized services (Hadoop, Presto, Trino) |
ldap | pip install 'apache-airflow[ldap]' |
LDAP authentication for users |
leveldb | pip install 'apache-airflow[leveldb]' |
Required for use leveldb extra in google provider |
otel | pip install 'apache-airflow[otel]' |
Required for OpenTelemetry metrics |
pandas | pip install 'apache-airflow[pandas]' |
Install Pandas library compatible with Airflow |
password | pip install 'apache-airflow[password]' |
Password authentication for users |
pydantic | pip install 'apache-airflow[pydantic]' |
Pydantic serialization for internal-api |
rabbitmq | pip install 'apache-airflow[rabbitmq]' |
RabbitMQ support as a Celery backend |
sentry | pip install 'apache-airflow[sentry]' |
Sentry service for application logging and monitoring |
s3fs | pip install 'apache-airflow[s3fs]' |
Support for S3 as Airflow FS |
saml | pip install 'apache-airflow[saml]' |
Support for SAML authentication in Airflow |
statsd | pip install 'apache-airflow[statsd]' |
Needed by StatsD metrics |
uv | pip install 'apache-airflow[uv]' |
Install uv - fast, Rust-based package installer (experimental) |
virtualenv | pip install 'apache-airflow[virtualenv]' |
Running python tasks in local virtualenv |
These providers extras are simply convenience extras to install provider packages so that you can install the providers with simple command - including provider package and necessary dependencies in single command, which allows PIP to resolve any conflicting dependencies. This is extremely useful for first time installation where you want to repeatably install version of dependencies which are 'valid' for both airflow and providers installed.
For example the below command will install:
- apache-airflow
- apache-airflow-providers-amazon
- apache-airflow-providers-google
- apache-airflow-providers-apache-spark
with a consistent set of dependencies based on constraint files provided by Airflow Community at the time |version| version was released.
pip install apache-airflow[google,amazon,apache-spark]==|version| \
--constraint "https://raw.githubusercontent.com/apache/airflow/constraints-|version|/constraints-3.8.txt"
Note, that this will install providers in the versions that were released at the time of Airflow |version| release. You can later upgrade those providers manually if you want to use latest versions of the providers.
These are extras that add dependencies needed for integration with other Apache projects (note that apache.atlas
and
apache.webhdfs
do not have their own providers - they only install additional libraries that can be used in
custom bash/python providers).
extra | install command | enables |
---|---|---|
apache-atlas | pip install 'apache-airflow[apache-atlas]' |
Apache Atlas |
apache-beam | pip install 'apache-airflow[apache-beam]' |
Apache Beam operators & hooks |
apache-cassandra | pip install 'apache-airflow[apache-cassandra]' |
Cassandra related operators & hooks |
apache-drill | pip install 'apache-airflow[apache-drill]' |
Drill related operators & hooks |
apache-druid | pip install 'apache-airflow[apache-druid]' |
Druid related operators & hooks |
apache-flink | pip install 'apache-airflow[apache-flink]' |
Flink related operators & hooks |
apache-hdfs | pip install 'apache-airflow[apache-hdfs]' |
HDFS hooks and operators |
apache-hive | pip install 'apache-airflow[apache-hive]' |
All Hive related operators |
apache-impala | pip install 'apache-airflow[apache-impala]' |
All Impala related operators & hooks |
apache-kafka | pip install 'apache-airflow[apache-kafka]' |
All Kafka related operators & hooks |
apache-kylin | pip install 'apache-airflow[apache-kylin]' |
All Kylin related operators & hooks |
apache-livy | pip install 'apache-airflow[apache-livy]' |
All Livy related operators, hooks & sensors |
apache-pig | pip install 'apache-airflow[apache-pig]' |
All Pig related operators & hooks |
apache-pinot | pip install 'apache-airflow[apache-pinot]' |
All Pinot related hooks |
apache-spark | pip install 'apache-airflow[apache-spark]' |
All Spark related operators & hooks |
apache-webhdfs | pip install 'apache-airflow[apache-webhdfs]' |
HDFS hooks and operators |
These are extras that add dependencies needed for integration with external services - either cloud based or on-premises.
extra | install command | enables |
---|---|---|
airbyte | pip install 'apache-airflow[airbyte]' |
Airbyte hooks and operators |
alibaba | pip install 'apache-airflow[alibaba]' |
Alibaba Cloud |
apprise | pip install 'apache-airflow[apprise]' |
Apprise Notification |
amazon | pip install 'apache-airflow[amazon]' |
Amazon Web Services |
asana | pip install 'apache-airflow[asana]' |
Asana hooks and operators |
atlassian-jira | pip install 'apache-airflow[atlassian-jira]' |
Jira hooks and operators |
microsoft-azure | pip install 'apache-airflow[microsoft-azure]' |
Microsoft Azure |
cloudant | pip install 'apache-airflow[cloudant]' |
Cloudant hook |
cohere | pip install 'apache-airflow[cohere]' |
Cohere hook and operators |
databricks | pip install 'apache-airflow[databricks]' |
Databricks hooks and operators |
datadog | pip install 'apache-airflow[datadog]' |
Datadog hooks and sensors |
dbt-cloud | pip install 'apache-airflow[dbt-cloud]' |
dbt Cloud hooks and operators |
dingding | pip install 'apache-airflow[dingding]' |
Dingding hooks and sensors |
discord | pip install 'apache-airflow[discord]' |
Discord hooks and sensors |
pip install 'apache-airflow[facebook]' |
Facebook Social | |
github | pip install 'apache-airflow[github]' |
GitHub operators and hook |
pip install 'apache-airflow[google]' |
Google Cloud | |
hashicorp | pip install 'apache-airflow[hashicorp]' |
Hashicorp Services (Vault) |
openai | pip install 'apache-airflow[openai]' |
Open AI hooks and operators |
opsgenie | pip install 'apache-airflow[opsgenie]' |
OpsGenie hooks and operators |
pagerduty | pip install 'apache-airflow[pagerduty]' |
Pagerduty hook |
pgvector | pip install 'apache-airflow[pgvector]' |
pgvector operators and hook |
pinecone | pip install 'apache-airflow[pinecone]' |
Pinecone Operators and Hooks |
qdrant | pip install 'apache-airflow[qdrant]' |
Qdrant Operators and Hooks |
salesforce | pip install 'apache-airflow[salesforce]' |
Salesforce hook |
sendgrid | pip install 'apache-airflow[sendgrid]' |
Send email using sendgrid |
segment | pip install 'apache-airflow[segment]' |
Segment hooks and sensors |
slack | pip install 'apache-airflow[slack]' |
Slack hooks and operators |
snowflake | pip install 'apache-airflow[snowflake]' |
Snowflake hooks and operators |
tableau | pip install 'apache-airflow[tableau]' |
Tableau hooks and operators |
tabular | pip install 'apache-airflow[tabular]' |
Tabular hooks |
telegram | pip install 'apache-airflow[telegram]' |
Telegram hooks and operators |
vertica | pip install 'apache-airflow[vertica]' |
Vertica hook support as an Airflow backend |
weaviate | pip install 'apache-airflow[weaviate]' |
Weaviate hook and operators |
yandex | pip install 'apache-airflow[yandex]' |
Yandex.cloud hooks and operators |
zendesk | pip install 'apache-airflow[zendesk]' |
Zendesk hooks |
These are extras that add dependencies needed for integration with other software packages installed usually as part of the deployment of Airflow. Some of those enable Airflow to use executors to run tasks with them - other than via the built-in LocalExecutor.
extra | install command | brings | enables executors |
---|---|---|---|
arangodb | pip install 'apache-airflow[arangodb]' |
ArangoDB operators, sensors and hook | |
celery | pip install 'apache-airflow[celery]' |
Celery dependencies and sensor | CeleryExecutor, CeleryKubernetesExecutor |
cncf-kubernetes | pip install 'apache-airflow[cncf-kubernetes]' |
Kubernetes client libraries, KubernetesPodOperator & friends | KubernetesExecutor, LocalKubernetesExecutor |
docker | pip install 'apache-airflow[docker]' |
Docker hooks and operators | |
elasticsearch | pip install 'apache-airflow[elasticsearch]' |
Elasticsearch hooks and Log Handler | |
exasol | pip install 'apache-airflow[exasol]' |
Exasol hooks and operators | |
fab | pip install 'apache-airflow[fab]' |
FAB auth manager | |
github | pip install 'apache-airflow[github]' |
GitHub operators and hook | |
influxdb | pip install 'apache-airflow[influxdb]' |
Influxdb operators and hook | |
jenkins | pip install 'apache-airflow[jenkins]' |
Jenkins hooks and operators | |
mongo | pip install 'apache-airflow[mongo]' |
Mongo hooks and operators | |
microsoft-mssql | pip install 'apache-airflow[microsoft-mssql]' |
Microsoft SQL Server operators and hook. | |
mysql | pip install 'apache-airflow[mysql]' |
MySQL operators and hook | |
neo4j | pip install 'apache-airflow[neo4j]' |
Neo4j operators and hook | |
odbc | pip install 'apache-airflow[odbc]' |
ODBC data sources including MS SQL Server | |
openfaas | pip install 'apache-airflow[openfaas]' |
OpenFaaS hooks | |
oracle | pip install 'apache-airflow[oracle]' |
Oracle hooks and operators | |
postgres | pip install 'apache-airflow[postgres]' |
PostgreSQL operators and hook | |
presto | pip install 'apache-airflow[presto]' |
All Presto related operators & hooks | |
redis | pip install 'apache-airflow[redis]' |
Redis hooks and sensors | |
samba | pip install 'apache-airflow[samba]' |
Samba hooks and operators | |
singularity | pip install 'apache-airflow[singularity]' |
Singularity container operator | |
teradata | pip install 'apache-airflow[teradata]' |
Teradata hooks and operators | |
trino | pip install 'apache-airflow[trino]' |
All Trino related operators & hooks |
These are extras that provide support for integration with external systems via some - usually - standard protocols.
The entries with *
in the Preinstalled
column indicate that those extras (providers) are always
pre-installed when Airflow is installed.
extra | install command | enables | Preinstalled |
---|---|---|---|
common-io | pip install 'apache-airflow[common-io]' |
Core IO Operators | |
common-sql | pip install 'apache-airflow[common-sql]' |
Core SQL Operators | |
ftp | pip install 'apache-airflow[ftp]' |
FTP hooks and operators | |
grpc | pip install 'apache-airflow[grpc]' |
Grpc hooks and operators | |
http | pip install 'apache-airflow[http]' |
HTTP hooks, operators and sensors | |
imap | pip install 'apache-airflow[imap]' |
IMAP hooks and sensors | |
jdbc | pip install 'apache-airflow[jdbc]' |
JDBC hooks and operators | |
microsoft-psrp | pip install 'apache-airflow[microsoft-psrp]' |
PSRP hooks and operators | |
microsoft-winrm | pip install 'apache-airflow[microsoft-winrm]' |
WinRM hooks and operators | |
openlineage | pip install 'apache-airflow[openlineage]' |
Sending OpenLineage events | |
opensearch | pip install 'apache-airflow[opensearch]' |
Opensearch hooks and operators | ||
papermill | pip install 'apache-airflow[papermill]' |
Papermill hooks and operators | |
sftp | pip install 'apache-airflow[sftp]' |
SFTP hooks, operators and sensors | |
smtp | pip install 'apache-airflow[smtp]' |
SMTP hooks and operators | |
sqlite | pip install 'apache-airflow[sqlite]' |
SQLite hooks and operators | |
ssh | pip install 'apache-airflow[ssh]' |
SSH hooks and operators |
These are extras that install one or more extras as a bundle.
extra | install command | enables |
---|---|---|
all | pip install 'apache-airflow[all]' |
All Airflow user facing features (no devel and doc requirements) |
all-core | pip install 'apache-airflow[all-core]' |
All core airflow features that do not require installing providers |
all-dbs | pip install 'apache-airflow[all-dbs]' |
All database integrations |
The devel
extras only make sense in editable mode. Users of Airflow should not be using them, unless they
start contributing back and install airflow from sources. Those extras are only available in Airflow when
it is installed in editable mode from sources (pip install -e .[devel,EXTRAS]
).
The devel extras do not install dependencies for features of Airflow, but add functionality that is needed to develop Airflow, such as running tests, static checks.
extra | install command | enables |
---|---|---|
devel-debuggers | pip install -e '.[devel-debuggers]' | Adds all test libraries needed to test debuggers |
devel-devscripts | pip install -e '.[devel-devscripts]' | Adds all test libraries needed to test devel scripts |
devel-duckdb | pip install -e '.[devel-duckdb]' | Adds all test libraries needed to test duckdb |
devel-iceberg | pip install -e '.[devel-iceberg]' | Adds all test libraries needed to test iceberg |
devel-mypy | pip install -e '.[devel-mypy]' | Adds all test libraries needed to test mypy |
devel-sentry | pip install -e '.[devel-sentry]' | Adds all test libraries needed to test sentry |
devel-static-checks | pip install -e '.[devel-static-checks]' | Adds all test libraries needed to test static_checks |
devel-tests | pip install -e '.[devel-tests]' | Adds all test libraries needed to test tests |
Those are extras that bundle devel, editable and doc extras together to make it easy to install them together in a single installation. Some of the extras are more difficult to install on certain systems (such as ARM MacBooks) because they require system level dependencies to be installed.
Note that pip install -e ".[devel]"
should be run at least once, the first time you initialize the editable environment in order
to get minimal, complete test environment with usual tools and dependencies needed for unit testing.
extra | install command | enables |
---|---|---|
devel | pip install -e '.[devel]' |
Minimum development dependencies - minimal, complete test environment |
devel-hadoop | pip install -e '.[devel-hadoop]' |
Adds Hadoop stack libraries devel dependencies |
devel-all-dbs | pip install -e '.[devel-all-dbs]' |
Adds all libraries needed to test database providers |
devel-all | pip install -e '.[devel-all]' |
Everything needed for development including Hadoop, all devel extras, all doc extras. Generally: all possible dependencies except providers |
devel-ci | pip install -e '.[devel-ci]' |
All dependencies required for CI tests (same as devel-all ) |
Those are the extras that are needed to generated documentation for Airflow. This is used for development time only
extra | install command | enables |
---|---|---|
doc | pip install -e '.[doc]' |
Packages needed to build docs (included in devel ) |
doc-gen | pip install -e '.[doc-gen]' |
Packages needed to generate er diagrams (included in devel-all ) |
These are the extras that have been deprecated in 2.0 and will be removed in Airflow 3.0.0. They were all replaced by new extras, which have naming consistent with the names of provider packages.
The crypto
extra is not needed any more, because all crypto dependencies are part of airflow package,
so there is no replacement for crypto
extra.
Deprecated extra | Extra to be used instead |
---|---|
atlas | apache-atlas |
aws | amazon |
azure | microsoft-azure |
cassandra | apache-cassandra |
crypto | |
druid | apache-druid |
gcp | |
gcp_api | |
hdfs | apache-hdfs |
hive | apache-hive |
kubernetes | cncf-kubernetes |
mssql | microsoft-mssql |
pinot | apache-pinot |
s3 | amazon |
spark | apache-spark |
webhdfs | apache-webhdfs |
winrm | microsoft-winrm |