citusdata/citus

Citus

镜像概述和主要用途

Citus是一个基于PostgreSQL的分布式关系型数据库管理系统(RDBMS)。它在PostgreSQL基础上提供了分布式数据库功能，允许用户轻松扩展数据库以处理大规模数据和高并发查询。

核心功能和特性

• 基于PostgreSQL 12.2构建，完全兼容PostgreSQL生态系统
• 提供标准配置的单节点Citus实例
• 基于官方PostgreSQL镜像构建，支持所有PostgreSQL高级配置选项
• 暴露标准PostgreSQL端口5432，便于容器间通信和外部连接
• 支持数据持久化存储，默认使用卷挂载PGDATA目录

使用场景和适用范围

• 开发与测试环境：快速部署单节点Citus实例进行应用开发和测试
• 小规模生产环境：使用单节点Citus提供比标准PostgreSQL更优的性能
• 大规模分布式数据处理：通过Docker Compose部署多节点集群，处理大规模分布式数据

使用方法和配置说明

独立模式使用

通过以下命令可以快速启动一个单节点Citus实例：

bash
docker run --name citus_standalone -p 5432:5432 citusdata/citus

启动后，可以通过psql或其他PostgreSQL客户端连接到127.0.0.1:5432：

bash
psql -h 127.0.0.1 -p 5432 -U postgres

与官方PostgreSQL镜像一样，默认的PGDATA目录会被挂载为卷，因此容器重启后数据会持久化保存。单节点模式适合开发测试，但无法体验Citus的分布式查询功能。

夜间构建版本

除了latest标签和特定版本标签外，nightly目录下的Dockerfile会构建包含最新Citus夜间版本（来自Citus master分支）的镜像，可以通过以下命令使用：

bash
docker run --name citus_nightly -p 5432:5432 citusdata/citus:nightly

Docker Compose集群部署

通过提供的docker-compose.yml文件，可以轻松部署包含多个工作节点的Citus集群。

1. 首先获取docker-compose配置文件：

bash
curl -O https://raw.githubusercontent.com/citusdata/docker/master/docker-compose.yml

2. 启动集群：

bash
docker-compose -p citus up

启动过程会创建并配置以下容器：

• citus_master：主节点
• citus_worker_1：工作节点（默认1个）
• citus_config：配置服务，用于自动发现和添加新的工作节点

3. 验证集群状态：

连接到主节点后，执行以下SQL查询验证工作节点：

sql
SELECT master_get_active_worker_nodes();

默认输出：

 master_get_active_worker_nodes
--------------------------------
 (citus_worker_1,5432)
(1 row)

4. 扩展工作节点：

可以随时使用docker-compose scale命令增加工作节点数量，例如扩展到5个工作节点：

bash
docker-compose -p citus scale worker=5

扩展后再次查询工作节点：

sql
SELECT master_get_active_worker_nodes();

输出将包含5个工作节点：

 master_get_active_worker_nodes
--------------------------------
 (citus_worker_5,5432)
 (citus_worker_1,5432)
 (citus_worker_3,5432)
 (citus_worker_2,5432)
 (citus_worker_4,5432)
(5 rows)

5. 停止集群：

bash
docker-compose -p citus down

配置说明

该镜像基于官方PostgreSQL镜像构建，因此支持所有官方PostgreSQL镜像的配置选项，包括但不限于：

• POSTGRES_USER：指定数据库超级用户名称（默认：postgres）
• POSTGRES_PASSWORD：指定数据库超级用户密码
• POSTGRES_DB：指定默认数据库名称
• PGDATA：指定数据库文件存储路径

例如，指定密码启动Citus：

bash
docker run --name citus_secure -e POSTGRES_PASSWORD=mysecretpassword -p 5432:5432 citusdata/citus

许可证

本仓库中的文件遵循Apache License 2.0许可协议。有关Citus本身的许可信息，请查阅Citus官方仓库。