AidboxDB

镜像概述和主要用途

AidboxDB镜像是基于开源PostgreSQL数据库的定制构建版本，专门用作Aidbox的数据存储。更多详细信息请参见***文档。

核心功能和特性

基于PostgreSQL构建，继承其稳定性与可靠性
支持流复制功能，可配置为主数据库或流复制副本
针对FHIR搜索查询进行优化
内置备份和维护扩展工具

使用场景和适用范围

作为Aidbox的主数据库进行初始化和运行
初始化和运行流复制副本
优化FHIR搜索查询性能
执行数据库备份和维护操作

使用方法

基本运行示例

bash
docker run \
       -v "$(pwd)"/pgdata:/data/pg \
       -e POSTGRES_USER='postgres' \
       -e POSTGRES_PASSWORD='pass' \
       -e POSTGRES_DB='aidbox' \
       -e PGDATA="/data/pg" \
       healthsamurai/aidboxdb:14.5

版本控制

AidboxDB镜像标签基于其构建所使用的PostgreSQL版本。例如，若要使用PostgreSQL 14.5版本，应拉取healthsamurai/aidboxdb:14.5镜像。

支持的PostgreSQL版本

15 (beta)
14.5
13.8

可用版本

14.2
13.6
13.2
12.12
12.6
11.17
11.11

扩展

AidboxDB包含以下额外可用扩展：

jsonknife — 用于优化FHIR搜索的Jsonb提取工具
pgagent — PostgreSQL作业调度器
pg_repack — 以最小锁开销重组PostgreSQL数据库表
jsquery — 支持GIN索引的JSON查询语言
wal2json — PostgreSQL逻辑解码的输出插件
wal-g — 云环境中的数据库归档和恢复工具

配置说明

镜像通过启动时提供环境变量和命令行参数进行配置。请注意，数据库初始化后不应更改环境变量，这些变量被视为不可变。

必填环境变量

环境变量名称	说明
`POSTGRES_USER`	数据库初始化时创建的用户名
`POSTGRES_PASSWORD`	该用户的密码
`POSTGRES_DB`	启动时创建的数据库名称
`WALG_` 变量	wal-g使用的存储凭证和桶名称，详细信息请参考***文档

可选环境变量

环境变量名称	默认值	说明
`PGDATA`	`/data`	文件系统中PostgreSQL集群目录的路径
`PG_ROLE`		设置为"replica"时，镜像进入流复制副本模式
`PG_REPLICA`		要在主数据库中创建的复制槽名称，只能包含小写字母、数字和下划线
`PG_MASTER_HOST`		流复制副本的主数据库主机
`PGAGENT_ENABLED`		当存在且`PG_ROLE`未设置为"replica"时，在`aidboxdb`启动时启动`pgagent`守护进程。pgAgent教程
`PGAGENT_DB`	`POSTGRES_DB`变量的值	`pgagent`数据存储的数据库。如果设置了该值，则容器启动时数据库必须已存在
`PGAGENT_LOG_FILE_PATH`	`"/tmp/pgagent.logs"`	`pgagent`日志消息的文件路径
`PGAGENT_LOG_LEVEL`	`0`	日志级别：`0`（错误），`1`（警告），`2`（调试）
`PGAGENT_USER`	postgres	自定义`pgagent`用户的名称
`PGAGENT_PASSWORD`	`POSTGRES_PASSWORD`变量的值	自定义`pgagent`用户的密码