Add airflow db-manager CLI for managing external databases
#50657
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds a new top-level CLI command, `airflow db-manager`, which provides an interface for managing metadata databases handled by external DB managers. Previously, external DB managers were required to define and expose their own CLI commands. With this change, Airflow now provides support for common DB actions (reset, migrate, downgrade) across external database backends by delegating to their registered managers. Changes: - Introduces db-manager CLI group with reset, migrate, and downgrade commands. - Each command accepts a --name flag to select the DB manager. - Adds test coverage for the CLI commands. This enables external providers to plug in seamlessly without duplicating db command logic.
3c45865 to
cd1de06
Compare
| DB_MANAGERS_COMMANDS = ( | ||
| ActionCommand( | ||
| name="reset", | ||
| help="Burn down and rebuild the metadata database", |
There was a problem hiding this comment.
The help docs for these should be rewritten a bit since these are just the things the db manager controls, not the whole db.
| @@ -599,6 +599,13 @@ def string_lower_type(val): | |||
| default=False, | |||
| ) | |||
|
|
|||
| ARG_DB_MANAGER_NAME = Arg( | |||
| ("--name",), | |||
There was a problem hiding this comment.
Suggested change
| ("--name",), | |
| ("name",), |
Having it be positional might be a bit nicer?
| db_managers = conf.get("database", "external_db_managers") | ||
| db_manager = None | ||
| for manager in db_managers.split(","): | ||
| if name in manager: |
There was a problem hiding this comment.
Not sure this is right - we want a complete match right, not just a partial match? If we have a a and a abc we could match a to abc. Since we don't have the concept of a "name", maybe we should take the whole classpath?
Comment on lines
+27
to
+37
| def _get_db_manager(name): | ||
| """Import the db manager class.""" | ||
| db_managers = conf.get("database", "external_db_managers") | ||
| db_manager = None | ||
| for manager in db_managers.split(","): | ||
| if name in manager: | ||
| db_manager = manager | ||
| break | ||
| if db_manager is None: | ||
| raise SystemExit(f"DB manager {name} not found in configuration.") | ||
| return import_string(db_manager.strip()) |
There was a problem hiding this comment.
Suggested change
| def _get_db_manager(name): | |
| """Import the db manager class.""" | |
| db_managers = conf.get("database", "external_db_managers") | |
| db_manager = None | |
| for manager in db_managers.split(","): | |
| if name in manager: | |
| db_manager = manager | |
| break | |
| if db_manager is None: | |
| raise SystemExit(f"DB manager {name} not found in configuration.") | |
| return import_string(db_manager.strip()) | |
| def _get_db_manager(manager_classpath: str): | |
| """Import the db manager class.""" | |
| db_managers = conf.getlistlist("database", "external_db_managers") | |
| if manager_classpath not in manager: | |
| raise SystemExit(f"DB manager {manager_classpath} not found in configuration.") | |
| return import_string(manager_classpath.strip()) |
Something like this is probably better.
There was a problem hiding this comment.
It might not be nice to have a command like:
airflow db-manager "airflow.providers.fab.auth_manager.models.db.FABDBManager" reset -y
or what do you think?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a new top-level CLI command,
airflow db-manager, which provides an interface for managing metadata databases handled by external DB managers.Previously, external DB managers were required to define and expose their own CLI commands. With this change, Airflow now provides support for common DB actions (reset, migrate, downgrade) across external database backends by delegating to their registered managers.
Changes:
Introduces db-manager CLI group with reset, migrate, and downgrade commands.
Each command accepts a --name flag to select the DB manager.
Adds test coverage for the CLI commands.
This enables external providers to plug in seamlessly without duplicating db command logic.
Closes: #50496