Skip to content

Clarify FAB and Auth documentation regarding external_db_managers #69929

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vincbeck merged 3 commits into from
Jul 15, 2026
+5 −5
Merged

Clarify FAB and Auth documentation regarding external_db_managers #69929

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3974705
Fix wrong configuration section use
stephsi Jul 15, 2026
cb1ee8c
Correct imprecise wording around auto adding FABDBManager
stephsi Jul 15, 2026
dccb537
Correct imprecise wording around get_db_manager function
stephsi Jul 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions airflow-core/docs/core-concepts/auth-manager/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,8 +257,8 @@ Other optional methods
Override this method if you need to make any action (e.g. create resources, API call) that the auth manager needs.
* ``get_extra_menu_items``: Provide additional links to be added to the menu in the UI.
* ``get_db_manager``: If your auth manager requires one or several database managers (see :class:`~airflow.utils.db_manager.BaseDBManager`),
their class paths need to be returned as part of this method. By doing so, they will be automatically added to the
config ``[database] external_db_managers``.
their class paths need to be returned as part of this method. By doing so, Airflow automatically loads the
respective database managers.


Additional Caveats
Expand Down
6 changes: 3 additions & 3 deletions providers/fab/docs/upgrading.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ Why you need to upgrade
The FAB provider is a separate package from Airflow and it is released independently. Starting from version 1.3.0, FAB
can now run its own migrations if you are on Airflow 3. Newer FAB versions can contain database migrations, so you
must run ``airflow fab-db migrate`` to migrate your database with the schema changes in the FAB version you are
upgrading to. If ``FABDBManager`` is included in the ``[core] external_db_managers`` configuration, the migrations will
upgrading to. If ``FABDBManager`` is included in the ``[database] external_db_managers`` configuration, the migrations will
be run automatically as part of the ``airflow db migrate`` command.

.. note::
If FAB auth manager is configured as auth manager in your environment, ``FABDBManager`` is automatically added in the
``[core] external_db_managers`` configuration.
If the FAB auth manager is configured as ``[core] auth_manager`` in your environment, Airflow automatically loads
``FABDBManager`` and runs its migrations as part of the ``airflow db migrate`` command.

How to upgrade
==============
Expand Down