FAB CLI 命令¶
注意
下面的 CLI 命令来源于 Airflow 2.9.0+ 的 FAB 提供程序。在此之前，它们是 Airflow 核心的一部分，因此如果您使用的是低于 2.9.0 的 Airflow，请参阅 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": "[email protected]", "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
通过对角色名称进行排序和缩进 4 个空格来格式化输出 JSON 文件
默认值: 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，可以提供 *from* Alembic 修订版
- --from-version
（可选）如果生成 sql，可以提供 *from* 版本
- -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，可以提供 *from* Alembic 修订版
- --from-version
（可选）如果生成 sql，可以提供 *from* 版本
- -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