j.jev4pg使用文档
安装
开始使用

安装

初次使用建议选择 v0.6.0 应用版,通过 Docker Compose 启动查询工作区。Rust 原生扩展目前是开发预览,需要单独安装。

使用 Docker Compose#

准备好 Git、Python 3.11 或更高版本,以及带有 Compose v2 的 Docker。获取发布版代码:

bash
git clone --branch v0.6.0 https://github.com/Sheltercosmo/jev4pg.git
cd jev4pg
python deploy/configure.py
docker compose build
docker compose up -d --wait

配置程序会创建 .secrets/,并提示输入 TypeSafe API 密钥。重新运行时会保留已有配置。使用其他模型服务时,可以先留空,再按模型服务与配置设置。

启动后打开中文查询工作区。在本机查看登录工作区所需的令牌:

bash
python deploy/configure.py --show-token

工作区令牌用于验证数据库访问权限,与模型服务的 API 密钥用途不同。不要把它们填在同一个位置。

检查服务#

bash
docker compose ps

/health 检查进程是否运行,/ready 检查数据库连接、迁移版本和运行权限。这两个接口不会调用模型,也不能证明模型服务可用。

默认情况下,HTTP 和 PostgreSQL 端口只绑定到本机。需要修改端口时,在 .env 中设置 SDD_HTTP_PORT 或 SDD_POSTGRES_PORT。数据、评估证据和排队任务保存在 sdd_pg 数据卷中。

使用现有 PostgreSQL#

应用支持 PostgreSQL 17。安装 Python 包并配置数据库连接后,运行 jevsd-pg migrate 创建所需结构。HTTP 服务与 SQL worker 是两个独立进程;异步 SQL 接口还需要安装扩展文件,并使用 --sql-interface 执行迁移。

完整的权限配置、进程启动和升级步骤见英文安装参考。若只想查询已有表,请继续阅读接入现有数据。

选择原生扩展#

原生扩展可以直接在 PostgreSQL 内执行语义扫描。它不会随默认 Compose 配置安装,也不会因切换到 main 分支自动启用。请按原生扩展安装指南部署,并使用独立数据库评估开发预览。

本页介绍用法与注意事项。完整参数及详细约定请参阅对应英文文档。