TiUP 在 TiDB 生态中承担包管理器的功能,管理着 TiDB 生态下众多的组件,如 TiDB、PD、TiKV 等,这个组件是在TIDB4.0+的版本中集成进来的。
查看语法命令如下:
tiup [flags] <command> [args...] # 执行命令
# or
tiup [flags] <component> [args...] # 运行组件
使用 help
命令可以获取特定命令的信息,每个命令的摘要都显示了其参数及其用法。必须参数显示在尖括号中,可选参数显示在方括号中。
<command>
代表命令名字,支持的命令列表请参考下方命令清单,<component>
代表组件名,支持的组件列表请参考下方组件清单。
命令清单
TiUP 包含众多的命令,这些命令又包含了许多子命令,具体命令及其子命令的说明请参考对应的链接:
- install:安装组件
- list:查看组件列表
- uninstall:卸载组件
- update:升级已安装的组件
- status:查看组件运行状态
- clean:清理组件数据目录
- mirror:镜像管理
- telemetry:遥测开关
- completion:TiUP 命令补全
- env:查看 TiUP 相关环境变量
- help:查看特定命令或组件的帮助文档
组件清单
一些常用的命令和组件:
tiup cluster display cluster-name 查看集群状态
tiup cluster destory cluster-name 销毁集群
tiup cluster start cluster-name 启动集群
tiup cluster stop cluster-name 停止集群
tiup cluster start cluster-name -R pd 启动组件所有节点
tiup cluster start cluster-name -N 10...:2379,10...:2379 启动某几个节点的角色
tiup cluster stop cluster-name -R tidb 关闭组件所有节点
tiup cluster stop cluster-name -N 10...:2379,10...:2379 关闭某个节点的角色