thedockerimages/tidb

TiDB Docker镜像文档

镜像概述和主要用途

该镜像为单元测试场景提供轻量级TiDB数据库实例。TiDB是一款分布式SQL数据库，本镜像旨在简化开发过程中对TiDB依赖的单元测试环境搭建，支持快速部署和配置，适用于本地开发及CI/CD流程中的测试环节。

核心功能和特性

• 提供可直接用于单元测试的TiDB数据库实例
• 支持通过环境变量配置数据库连接参数（用户、密码、数据库名、主机、端口）
• 轻量级部署，无需复杂的分布式环境配置
• 兼容标准MySQL客户端工具，便于进行连接和操作验证

使用场景和适用范围

适用于开发人员在单元测试中需要依赖TiDB数据库的场景，尤其适合：

• 本地开发环境中的单元测试
• CI/CD流水线中的自动化测试环节
• 需要快速验证TiDB数据库交互逻辑的场景

使用方法和配置说明

构建镜像

通过以下命令构建并推送镜像：

bash
# 构建镜像
docker build -t thedockerimages/tidb .

# 推送镜像（需提前登录Docker仓库）
docker push thedockerimages/tidb

运行容器

使用以下命令启动TiDB容器实例：

bash
docker run -d --name tidb_inst -p 4000:4000 thedockerimages/tidb

参数说明：

• -d：后台运行容器
• --name tidb_inst：指定容器名称为tidb_inst
• -p 4000:4000：将容器的4000端口映射到主机的4000端口（TiDB默认客户端端口）

健康检查

使用mysqladmin工具验证TiDB实例是否正常运行：

bash
mysqladmin ping --host 127.0.0.1 --port 4000 -u root

若返回mysqld is alive，表示TiDB实例运行正常。

环境变量配置

通过环境变量文件（.env）配置数据库连接信息，示例如下：

env
# 数据库用户名
CDS_REQUIRES_MYSQL_CREDENTIALS_USER=root
# 数据库密码（默认为空）
CDS_REQUIRES_MYSQL_CREDENTIALS_PASSWORD=
# 数据库名称
CDS_REQUIRES_MYSQL_CREDENTIALS_DATABASE=test
# 数据库主机地址
CDS_REQUIRES_MYSQL_CREDENTIALS_HOST=127.0.0.1
# 数据库端口
CDS_REQUIRES_MYSQL_CREDENTIALS_PORT=4000

启动容器时可通过--env-file参数加载环境变量文件：

bash
docker run -d --name tidb_inst -p 4000:4000 --env-file .env thedockerimages/tidb