johearlc/opengauss

OpenGauss 数据库 Docker 镜像文档

镜像概述

本镜像基于 OpenGauss 数据库构建，提供了预配置的数据库环境，支持快速部署并自动完成数据库初始化。通过 docker-compose 配置和初始化脚本，可实现数据库创建、用户管理及 SQL 脚本自动执行，适用于开发、测试环境的数据库快速搭建。

核心功能与特性

• 快速部署：通过 docker-compose 一键启动 OpenGauss 数据库服务
• 自动初始化：执行初始化脚本创建指定数据库、用户，并分配权限
• 数据持久化：支持数据目录挂载，确保数据持久化存储
• 配置自定义：可通过环境变量调整数据库参数（如会话超时、密码策略等）
• SQL脚本执行：自动执行指定目录下的 SQL 文件，完成数据初始化

使用场景

• 开发环境数据库快速搭建
• 测试环境数据预初始化
• 需要标准化数据库部署流程的场景
• 需快速重置或重建数据库环境的场景

使用方法与配置说明

环境准备

1. 确保已安装 Docker 和 Docker Compose
2. 准备以下目录和文件：
   • ./data：用于数据持久化的目录
   • ./initdb.sh：初始化脚本（内容见下方示例）
   • ./scripts-db/yunbaasdb/：存放初始化 SQL 文件的目录

配置参数说明

docker-compose.yaml 配置

yaml
version: "3"
services:
  opengauss:
    image: johearlc/opengauss:custom
    container_name: opengauss  # 容器名称
    restart: "no"  # 重启策略：不自动重启
    user: root  # 使用 root 用户运行
    ports:
      - 5432:5432  # 端口映射：宿主机5432 -> 容器5432
    volumes:
      - ./data:/var/lib/opengauss  # 数据持久化目录
      - ./initdb.sh:/docker-entrypoint-initdb.d/initdb.sh  # 初始化脚本挂载
      - ./scripts-db/yunbaasdb:/docker-entrypoint-initdb.d/yunbaasdb/  # SQL脚本目录挂载
    environment:
      - TZ=Asia/Shanghai  # 时区设置
      - GS_PASSWORD=JoHear@1614  # gaussdb 用户密码
      - OTHER_PG_CONF=\nsession_timeout = 0\npassword_reuse_time = 0\nfailed_login_attempts = 0  # 自定义数据库配置：会话不超时、密码错误不锁定等
    privileged: true  # 启用特权模式
    networks:
      - mynetwork  # 加入指定网络
networks:
  mynetwork:
    external: true  # 使用外部网络

环境变量说明

初始化脚本 (initdb.sh)

脚本功能：创建数据库、用户，分配权限，并按顺序执行指定目录下的 SQL 文件。

shell
#!/usr/bin/env bash
    GS_USER=""
    GS_PASSWORD=""
    GS_DB=""
    ADMIN_USER="omm"  # OpenGauss 管理员用户

    # 执行SQL文件的函数
    process_sql() {
      local query_runner=( gsql -v ON_ERROR_STOP=1 --username "$GS_USER" --password "$GS_PASSWORD" --dbname "$GS_DB")
      echo "Execute SQL: ${query_runner[@]} $@"
      "${query_runner[@]}" "$@"
    }

    # 创建数据库和用户的函数
    createDbAndUser() {
      database=$1
      username=$2
      password=$3
      echo "CREATE database $1 WITH ENCODING 'UTF8'" | gsql -v ON_ERROR_STOP=1 --username ${ADMIN_USER}
      echo "CREATE USER ${username} WITH PASSWORD '${password}' ;" | gsql --username ${ADMIN_USER} --dbname ${database}
      echo "ALTER database ${database} owner to ${username};" | gsql --username ${ADMIN_USER} --dbname ${database}
      echo "ALTER SCHEMA ${username} OWNER TO ${username};" | gsql --username ${ADMIN_USER} --dbname ${database}
      echo "ALTER ROLE ${username} set search_path = ${username};" | gsql --username ${ADMIN_USER} --dbname ${database}
      echo "grant all privileges on all tables in schema pg_catalog to ${username};" | gsql --username ${ADMIN_USER} --dbname ${database}
    }

    # 创建数据库和用户示例
    BAAS_DB=yunbaasdb
    BAAS_USER=yunbaas
    createDbAndUser ${BAAS_DB} ${BAAS_USER} Yunbaas@1614  # 创建数据库yunbaasdb和用户yunbaas，密码Yunbaas@1614
    
    # 执行SQL脚本初始化数据
    GS_USER=${BAAS_USER}
    GS_PASSWORD=Yunbaas@1614
    GS_DB=${BAAS_DB}
      process_sql -f /docker-entrypoint-initdb.d/yunbaasdb/1-db_init.sql
      process_sql -f /docker-entrypoint-initdb.d/yunbaasdb/2-menu_data.sql
      process_sql -f /docker-entrypoint-initdb.d/yunbaasdb/3-dict_data.sql
      process_sql -f /docker-entrypoint-initdb.d/yunbaasdb/4-act_data.sql
      process_sql -f /docker-entrypoint-initdb.d/yunbaasdb/5-tmpl_data.sql
      process_sql -f /docker-entrypoint-initdb.d/yunbaasdb/6-init_data.sql
      process_sql -f /docker-entrypoint-initdb.d/yunbaasdb/7-quartz_init.sql

部署步骤

1. 准备上述目录和文件
2. 执行以下命令启动服务：

   bash
   docker-compose up -d
   

3. 查看容器状态：

   bash
   docker ps | grep opengauss
   

4. 连接数据库（使用初始化的用户和密码）：

   bash
   gsql -h localhost -p 5432 -U yunbaas -d yunbaasdb -W Yunbaas@1614
   

注意事项

• ./data 目录需确保有读写权限，避免数据持久化失败
• 初始化脚本执行顺序依赖 SQL 文件名前缀（如1-、2-等），需按顺序命名
• OTHER_PG_CONF 环境变量中配置项需符合 OpenGauss 配置格式，多个配置项用 \n 分隔
• 特权模式（privileged: true）为必要配置，确保数据库服务正常启动