graphile/postgraphile

PostGraphile Docker镜像文档

概述

PostGraphile是一款将PostgreSQL数据库与GraphQL技术结合的工具，能够自动生成高性能GraphQL API。本Docker镜像基于PostGraphile V4版本（稳定但功能冻结），V5 beta版本已接近完成，具备更多新特性（如Grafast引擎、更低Postgres负载、真多态性等）。PostGraphile通过自动检测数据库表、列、索引、关系、视图、函数等结构，快速构建智能且可扩展的GraphQL服务，无需手动编写API层代码，大幅提升开发效率。

核心功能与特性

• 自动生成GraphQL API：从PostgreSQL数据库模式自动生成完整GraphQL schema，包括查询、突变、关系等，支持表、视图、函数等多种数据库对象。
• PostgreSQL原生授权：集成PostgreSQL的行级安全（RLS）和基于角色的访问控制（RBAC），无需在API层重复实现权限逻辑。
• 高性能与低延迟：优化的查询执行引擎，减少数据库负载，提供闪电般的API响应速度。
• 开发友好工具：内置GraphiQL开发界面，支持--watch模式，自动检测数据库模式变化并热重载，无需重启服务。
• 丰富的自定义能力：通过智能注释（smart comments）自定义schema，支持计算列、自定义查询/突变、存储过程集成。
• 标准兼容：支持游标分页、Relay（经典与现代）规范、全局对象标识符（nodeId/id），兼容JWT认证。
• 多部署方式：可作为CLI工具、HTTP/Express/Koa中间件或Docker容器运行，灵活适应不同部署场景。

使用场景

• 快速API开发：需要为PostgreSQL数据库快速构建GraphQL API的项目，避免手动编写API层代码。
• 数据库优先架构：以PostgreSQL数据库模式为核心设计API，利用数据库原生功能（如RLS、函数）实现业务逻辑。
• 开发与生产环境：开发环境中利用--watch模式实时同步数据库变化；生产环境中作为稳定、高性能的API服务运行。
• 需要扩展的API：通过插件系统扩展功能，满足复杂业务需求，如自定义解析器、权限增强等。

使用方法（Docker部署）

前提条件

• Docker环境
• 可访问的PostgreSQL数据库（9.6+，官方推荐；实际可兼容9.4+）
• 网络配置：确保Docker容器可连接PostgreSQL数据库，必要时配置端口映射和网络模式

拉取镜像

bash
docker pull graphile/postgraphile

基本运行命令

bash
docker run --init graphile/postgraphile --help

常用部署示例

1. 连接本地PostgreSQL并暴露API端口

bash
docker run --init -p 5000:5000 graphile/postgraphile \
  --connection postgres://POSTGRES_USER:POSTGRES_PASSWORD@POSTGRES_HOST:POSTGRES_PORT/POSTGRES_DATABASE \
  --schema app_public \
  --watch

参数说明：

• -p 5000:5000：将容器内5000端口映射到主机5000端口（API服务端口）
• --connection：PostgreSQL连接字符串，格式为postgres://用户:密码@主机:端口/数据库名
• --schema：指定要暴露的数据库schema（如app_public）
• --watch：启用监听模式，自动检测数据库模式变化并热重载

2. macOS用户避免端口冲突（AirPlay占用5000端口）

bash
docker run --init -p 4000:4000 graphile/postgraphile \
  --connection postgres://user:pass@host:5432/db \
  --schema public \
  --port 4000

说明：通过--port指定容器内端口为4000，主机端口映射为4000，避免与macOS AirPlay服务冲突。

3. 生产环境基本配置（禁用GraphiQL，指定JWT密钥）

bash
docker run --init -d -p 8080:8080 --name postgraphile-service graphile/postgraphile \
  --connection postgres://prod_user:prod_pass@prod-postgres:5432/prod_db \
  --schema app_public \
  --port 8080 \
  --disable-graphiql \
  --jwt-secret YOUR_JWT_SECRET \
  --default-role app_anonymous

参数说明：

• -d：后台运行容器
• --name：指定容器名称
• --disable-graphiql：生产环境禁用GraphiQL界面
• --jwt-secret：配置JWT认证密钥
• --default-role：设置默认数据库角色

核心配置参数

注意事项

• V4与V5版本：本镜像基于V4（稳定但功能冻结），V5 beta版本已发布，具备更多特性（如Grafast引擎、更低Postgres负载等），生产环境可评估迁移至V5。
• macOS端口冲突：默认端口5000可能与AirPlay服务冲突，需通过--port指定其他端口（如4000、8080）。
• 安全配置：生产环境务必禁用GraphiQL，配置JWT密钥，限制数据库用户权限（遵循最小权限原则）。
• 数据库连接：确保容器与PostgreSQL之间网络连通，可通过--network指定Docker网络，或使用主机网络模式（--net=host）。

相关资源

• PostGraphile V4官方文档
• V5 beta状态与新特性
• V4迁移至V5指南
• 社区插件列表