riftbit/pgsql

pgsql

包含PostgreSQL客户端的最小环境，支持周期性查询运行，并具有每周自动更新功能：

镜像概述和主要用途

pgsql镜像是一个轻量级的Docker环境，包含PostgreSQL客户端工具（如psql、pg_dump），支持周期性查询执行功能，并每周自动更新以保持工具版本最新。适用于临时数据库连接、备份及定期查询任务。

核心功能和特性

• 集成完整PostgreSQL客户端工具集（psql、pg_dump等）
• 支持周期性SQL查询执行（通过query_runner和sql_file_runner）
• 每周自动更新镜像，确保工具最新
• 轻量级设计，镜像体积小，启动快速
• 灵活的命令覆盖机制，可直接调用各类PostgreSQL客户端工具

使用场景和适用范围

• 临时连接PostgreSQL数据库执行SQL命令
• 使用pg_dump进行数据库备份操作
• 定期执行监控查询、数据统计或数据同步任务
• CI/CD流程中需要轻量级PostgreSQL客户端环境的场景
• 开发环境中快速测试数据库连接和查询

使用方法和配置说明

psql（默认命令）

默认执行psql命令，可直接传入PostgreSQL连接字符串：

bash
$ docker run -it --rm riftbit/pgsql postgresql://user:pass@host:5432/db
...

也可显式指定psql命令：

bash
$ docker run -it --rm riftbit/pgsql psql postgresql://user:pass@host:5432/db
...

pg_dump

如需使用pg_dump工具（覆盖默认psql命令），直接指定pg_dump及参数。示例：将数据库备份到本地目录

bash
$ docker run -it --rm \
  -v /本地备份路径:/var/pgdata riftbit/pgsql pg_dump -h host -U user -f /var/pgdata/mydump.sql db
...

query_runner（周期性查询执行）

用于按指定周期执行SQL查询，需配置以下环境变量：

• PG_CONNECTION_DSN: PostgreSQL连接字符串
• PG_QUERY_PERIOD_SECONDS: 查询执行周期（秒）
• PG_QUERY: 要执行的SQL查询语句

示例：每60秒执行一次查询

bash
$ docker run -d \
    -e PG_CONNECTION_DSN='postgresql://user:pass@host:5432/db' \
    -e PG_QUERY_PERIOD_SECONDS=60 \
    -e PG_QUERY='SELECT schemaname, relname, seq_scan, seq_tup_read, seq_tup_read / seq_scan as avg_seq_tup_read FROM pg_stat_all_tables WHERE seq_scan > 0 ORDER BY 5 DESC LIMIT 5;' \
riftbit/pgsql query_runner
...

sql_file_runner（周期性文件查询执行）

用于按指定周期执行SQL文件中的查询，需配置以下环境变量：

• PG_CONNECTION_DSN: PostgreSQL连接字符串
• PG_QUERY_PERIOD_SECONDS: 查询执行周期（秒）

SQL文件要求：需挂载卷/sql.d，并在该卷中放置名为query.sql的SQL文件。

示例：每60秒执行挂载卷中query.sql的查询

bash
$ docker run -d \
    -e PG_CONNECTION_DSN='postgresql://user:pass@host:5432/db' \
    -e PG_QUERY_PERIOD_SECONDS=60 \
    -v ${PWD}:/sql.d \
riftbit/pgsql sql_file_runner
...