FAB CLI 命令¶

注意

以下 CLI 命令来自 Airflow 2.9.0+ 中的 FAB provider。以前，它们是 Airflow 核心的一部分，因此如果您使用的 Airflow 版本低于 2.9.0，请参阅 Airflow 核心文档以获取可用 CLI 命令和参数列表。

Usage: airflow [-h] GROUP_OR_COMMAND ...

位置参数¶

GROUP_OR_COMMAND: 可能选项: users, roles, sync-perm, fab-db

子命令¶

users¶

管理用户

airflow users [-h] COMMAND ...

位置参数¶

COMMAND: 可能选项: add-role, create, delete, export, import, list, remove-role, reset-password

子命令¶

add-role¶

为用户添加角色

airflow users add-role [-h] [-e EMAIL] -r ROLE [-u USERNAME] [-v]

命名参数¶

-e, --email

用户的电子邮件

-r, --role

用户的角色。现有角色包括 Admin, User, Op, Viewer, 和 Public

-u, --username

用户的用户名

-v, --verbose

使日志输出更详细

默认值: False

create¶

创建一个用户

airflow users create [-h] -e EMAIL -f FIRSTNAME -l LASTNAME [-p PASSWORD] -r
                     ROLE [--use-random-password] -u USERNAME [-v]

命名参数¶

-e, --email

用户的电子邮件

-f, --firstname

用户的名

-l, --lastname

用户的姓

-p, --password

用户密码，创建用户时如果未使用 –use-random-password 则必填

-r, --role

用户的角色。现有角色包括 Admin, User, Op, Viewer, 和 Public

--use-random-password

不提示输入密码。改用随机字符串。创建用户时如果未使用 –password 则必填

默认值: False

-u, --username

用户的用户名

-v, --verbose

使日志输出更详细

默认值: False

示例: 要创建具有“Admin”角色且用户名为“admin”的用户，请运行

$ airflow users create
–username admin –firstname FIRST_NAME –lastname LAST_NAME –role Admin –email admin@example.org

delete¶

删除用户

airflow users delete [-h] [-e EMAIL] [-u USERNAME] [-v]

命名参数¶

-e, --email

用户的电子邮件

-u, --username

用户的用户名

-v, --verbose

使日志输出更详细

默认值: False

export¶

导出所有用户

airflow users export [-h] [-v] FILEPATH

位置参数¶

FILEPATH: 将所有用户导出到 JSON 文件

命名参数¶

-v, --verbose

使日志输出更详细

默认值: False

import¶

导入用户

airflow users import [-h] [-v] FILEPATH

位置参数¶

FILEPATH

从 JSON 文件导入用户。示例格式

[
    {
        "email": "foo@bar.org",
        "firstname": "Jon",
        "lastname": "Doe",
        "roles": ["Public"],
        "username": "jondoe"
    }
]

命名参数¶

-v, --verbose

使日志输出更详细

默认值: False

list¶

列出用户

airflow users list [-h] [-o table, json, yaml, plain] [-v]

命名参数¶

-o, --output

可能选项: table, json, yaml, plain

输出格式。允许的值: json, yaml, plain, table (默认值: table)

默认值: “table”

-v, --verbose

使日志输出更详细

默认值: False

remove-role¶

从用户移除角色

airflow users remove-role [-h] [-e EMAIL] -r ROLE [-u USERNAME] [-v]

命名参数¶

-e, --email

用户的电子邮件

-r, --role

用户的角色。现有角色包括 Admin, User, Op, Viewer, 和 Public

-u, --username

用户的用户名

-v, --verbose

使日志输出更详细

默认值: False

reset-password¶

重置用户密码

airflow users reset-password [-h] [-e EMAIL] [-p PASSWORD]
                             [--use-random-password] [-u USERNAME] [-v]

命名参数¶

-e, --email

用户的电子邮件

-p, --password

用户密码，创建用户时如果未使用 –use-random-password 则必填

--use-random-password

不提示输入密码。改用随机字符串。创建用户时如果未使用 –password 则必填

默认值: False

-u, --username

用户的用户名

-v, --verbose

使日志输出更详细

默认值: False

示例: 要重置用户名为“admin”的用户，请运行

$ airflow users reset-password
–username admin

roles¶

管理角色

airflow roles [-h] COMMAND ...

位置参数¶

COMMAND: 可能选项: add-perms, create, del-perms, delete, export, import, list

子命令¶

add-perms¶

添加角色权限

airflow roles add-perms [-h] -a [ACTION ...] -r [RESOURCE ...] [-v] [role ...]

位置参数¶

role: 角色名称

命名参数¶

-a, --action

权限的操作

-r, --resource

权限名称

-v, --verbose

使日志输出更详细

默认值: False

create¶

创建角色

airflow roles create [-h] [-v] [role ...]

位置参数¶

role: 角色名称

命名参数¶

-v, --verbose

使日志输出更详细

默认值: False

del-perms¶

删除角色权限

airflow roles del-perms [-h] [-a [ACTION ...]] -r [RESOURCE ...] [-v]
                        [role ...]

位置参数¶

role: 角色名称

命名参数¶

-a, --action

权限的操作

-r, --resource

权限名称

-v, --verbose

使日志输出更详细

默认值: False

delete¶

删除角色

airflow roles delete [-h] [-v] [role ...]

位置参数¶

role: 角色名称

命名参数¶

-v, --verbose

使日志输出更详细

默认值: False

export¶

从数据库导出角色（不含权限）到 JSON 文件

airflow roles export [-h] [-p] [-v] file

位置参数¶

file: 将所有角色导出到 JSON 文件

命名参数¶

-p, --pretty

格式化输出 JSON 文件，按角色名称排序并缩进 4 个空格

默认值: False

-v, --verbose

使日志输出更详细

默认值: False

import¶

从 JSON 文件导入角色（不含权限）到数据库

airflow roles import [-h] [-v] file

位置参数¶

file: 从 JSON 文件导入角色

命名参数¶

-v, --verbose

使日志输出更详细

默认值: False

list¶

列出角色

airflow roles list [-h] [-o table, json, yaml, plain] [-p] [-v]

命名参数¶

-o, --output

可能选项: table, json, yaml, plain

输出格式。允许的值: json, yaml, plain, table (默认值: table)

默认值: “table”

-p, --permission

显示角色权限

默认值: False

-v, --verbose

使日志输出更详细

默认值: False

sync-perm¶

更新现有角色和可选的 DAG 的权限

airflow sync-perm [-h] [--include-dags] [-v]

命名参数¶

--include-dags

如果传入此参数，DAG 特定权限也将同步。

默认值: False

-v, --verbose

使日志输出更详细

默认值: False

fab-db¶

管理 FAB

airflow fab-db [-h] COMMAND ...

位置参数¶

COMMAND: 可能选项: downgrade, migrate, reset

子命令¶

downgrade¶

降级 FAB 元数据数据库的模式。您必须提供 –to-revision 或 –to-version 之一。要打印但不执行命令，请使用选项 –show-sql-only。如果使用选项 –from-revision 或 –from-version，您也必须使用 –show-sql-only，因为如果实际运行迁移，我们应该只从当前的 Alembic 版本进行迁移。

airflow fab-db downgrade [-h] [--from-revision FROM_REVISION]
                         [--from-version FROM_VERSION] [-s] [-r TO_REVISION]
                         [-n TO_VERSION] [-v] [-y]

命名参数¶

--from-revision

（可选）如果生成 sql，可以提供一个起始 Alembic 版本

--from-version

（可选）如果生成 sql，可以提供一个起始版本

-s, --show-sql-only

不实际运行迁移；只打印出用于离线迁移的 sql 脚本。如果使用 –from-revision 或 –from-version 则必填。

默认值: False

-r, --to-revision

要降级到的 Alembic 版本。注意: 必须提供 –to-revision 或 –to-version 之一。

-n, --to-version

（可选）如果提供此参数，只运行迁移到此版本为止。

-v, --verbose

使日志输出更详细

默认值: False

-y, --yes

不提示确认。请谨慎使用！

默认值: False

migrate¶

迁移 FAB 元数据数据库的模式。如果数据库不存在则创建它。要打印但不执行命令，请使用选项 --show-sql-only。如果使用选项 --from-revision 或 --from-version，您也必须使用 --show-sql-only，因为如果实际运行迁移，我们应该只从当前的 Alembic 版本进行迁移。

airflow fab-db migrate [-h] [--from-revision FROM_REVISION]
                       [--from-version FROM_VERSION] [-s] [-r TO_REVISION]
                       [-n TO_VERSION] [-v]

命名参数¶

--from-revision

（可选）如果生成 sql，可以提供一个起始 Alembic 版本

--from-version

（可选）如果生成 sql，可以提供一个起始版本

-s, --show-sql-only

不实际运行迁移；只打印出用于离线迁移的 sql 脚本。如果使用 –from-revision 或 –from-version 则必填。

默认值: False

-r, --to-revision

（可选）如果提供此参数，只运行迁移到此 Alembic 版本（含）为止。

-n, --to-version

（可选）要升级到的 Airflow 版本。注意: 必须提供 –to-revision 或 –to-version 之一。

-v, --verbose

使日志输出更详细

默认值: False

reset¶

销毁并重建 FAB 元数据数据库

airflow fab-db reset [-h] [-s] [-v] [-y]

命名参数¶

-s, --skip-init

只删除表；不执行数据库初始化。

默认值: False

-v, --verbose

使日志输出更详细

默认值: False

-y, --yes

不提示确认。请谨慎使用！

默认值: False