edgedb/edgedb-cli

EdgeDB命令行工具镜像文档

镜像概述

该镜像为EdgeDB官方提供的命令行工具（CLI）Docker封装，包含edgedb命令行客户端，用于与EdgeDB数据库实例进行交互，支持数据库生命周期管理、数据查询、模式迁移等核心操作。适用于开发、测试及生产环境中通过容器化方式使用EdgeDB CLI。

核心功能

• 数据库管理：创建、删除、重命名数据库实例，管理数据库连接
• 迁移管理：生成、应用、回滚数据库模式迁移脚本，查看迁移历史
• 查询执行：执行EdgeQL查询语句，支持交互式查询和脚本化执行
• 连接配置：通过环境变量或配置文件定义数据库连接参数
• 用户与权限：管理数据库用户、角色及权限配置
• 数据导入/导出：支持数据库备份、数据导出及导入功能

使用场景

• 开发环境中通过容器化方式快速使用EdgeDB CLI，避免本地环境依赖冲突
• CI/CD流程中集成数据库迁移自动化（如构建阶段执行迁移脚本）
• 生产/测试环境中通过容器调度工具（如Kubernetes）执行数据库维护操作
• 多环境一致性管理（统一CLI版本，避免版本差异导致的兼容性问题）

使用方法

基本用法

通过docker run命令直接执行edgedb命令：

bash
docker run --rm edgedb/edgedb-cli <command> [options]

连接数据库

环境变量配置

通过环境变量定义数据库连接参数（推荐用于容器化环境）：

配置文件挂载

通过挂载本地配置文件（~/.edgedb/credentials）持久化连接配置：

bash
docker run --rm -v ~/.edgedb:/root/.edgedb edgedb/edgedb-cli instance list

常用命令示例

1. 执行交互式查询

bash
docker run -it --rm \
  -e EDGEDB_HOST=your-edgedb-instance \
  -e EDGEDB_USER=edgedb \
  -e EDGEDB_PASSWORD=your-password \
  edgedb/edgedb-cli query

2. 应用数据库迁移

bash
docker run --rm \
  -e EDGEDB_HOST=your-edgedb-instance \
  -e EDGEDB_PASSWORD=your-password \
  -v $(pwd)/dbschema:/app/dbschema \  # 挂载本地模式文件
  edgedb/edgedb-cli migrate --schema-dir /app/dbschema

3. 创建数据库

bash
docker run --rm \
  -e EDGEDB_HOST=your-edgedb-instance \
  -e EDGEDB_PASSWORD=your-password \
  edgedb/edgedb-cli database create new_db

4. 导出数据库备份

bash
docker run --rm \
  -e EDGEDB_HOST=your-edgedb-instance \
  -e EDGEDB_PASSWORD=your-password \
  -v $(pwd)/backups:/backups \  # 挂载备份目录
  edgedb/edgedb-cli dump --output /backups/db_backup.dump

Docker Compose配置示例

yaml
version: '3.8'
services:
  edgedb-cli:
    image: edgedb/edgedb-cli
    environment:
      EDGEDB_HOST: edgedb-server
      EDGEDB_PORT: 5656
      EDGEDB_USER: edgedb
      EDGEDB_PASSWORD: ${EDGEDB_PASSWORD}
    volumes:
      - ./dbschema:/app/dbschema  # 挂载本地模式文件
      - ~/.edgedb:/root/.edgedb   # 持久化CLI配置
    depends_on:
      - edgedb-server

  edgedb-server:
    image: edgedb/edgedb
    environment:
      EDGEDB_PASSWORD: ${EDGEDB_PASSWORD}
    ports:
      - "5656:5656"

注意事项

• 镜像标签与EdgeDB版本对应（如edgedb/edgedb-cli:4.0对应EdgeDB 4.0版本CLI），建议指定具体版本标签以确保稳定性
• 生产环境中建议通过环境变量注入敏感信息（如密码），避免硬编码
• 挂载本地目录时需确保容器内用户（默认root）对挂载目录有读写权限
• 详细命令参数可通过docker run --rm edgedb/edgedb-cli --help查看完整帮助文档