PgAssistant 使用教程

1. 项目目录结构及介绍

PgAssistant 的目录结构如下所示：

pgassistant/
├── apps/
│   └── __init__.py
├── docker-compose/
│   └── docker-compose.yml
├── media/
├── .env
├── .gitignore
├── CHANGELOG.md
├── Dockerfile
├── LICENSE
├── LLM.md
├── README.md
├── SECURITY.md
├── build.sh
├── env.sample
├── gunicorn-cfg.py
├── myqueries.json
├── pgtune.sh
├── pyproject.toml
├── queries.json
├── render.yaml
├── requirements.txt
└── run.py

• apps/: 存放应用程序的相关模块。
• docker-compose/: 包含 Docker 的配置文件。
• media/: 存储媒体文件。
• .env: 环境变量配置文件。
• .gitignore: Git 忽略文件列表。
• CHANGELOG.md: 记录项目更新和改动的日志。
• Dockerfile: Docker 镜像构建文件。
• LICENSE: 项目许可证文件。
• LLM.md: 有关集成大型语言模型的信息。
• README.md: 项目说明文件。
• SECURITY.md: 安全相关的信息。
• build.sh: 构建脚本。
• env.sample: 环境变量配置示例文件。
• gunicorn-cfg.py: Gunicorn 服务器配置文件。
• myqueries.json: 存储用户自定义的 SQL 查询。
• pgtune.sh: PostgreSQL 性能调优脚本。
• pyproject.toml: 项目配置文件。
• queries.json: 存储查询信息的 JSON 文件。
• render.yaml: 渲染配置文件。
• requirements.txt: 项目依赖的 Python 包列表。
• run.py: 项目启动文件。

2. 项目的启动文件介绍

项目的启动文件是 run.py。该文件负责启动 Flask 应用程序。以下是启动文件的简要介绍：

from app import create_app

app = create_app()

if __name__ == "__main__":
    app.run()

该文件从 app 模块导入 create_app 函数，创建一个 Flask 应用实例，并在脚本被直接运行时启动该应用。

3. 项目的配置文件介绍

项目的配置文件是 .env 文件，该文件包含了应用程序运行时所需的环境变量。以下是配置文件的一个示例：

FLASK_APP=run.py
FLASK_ENV=development
DATABASE_URL=postgresql://username:password@localhost/pgassistant

在这个文件中，你可以配置 Flask 应用程序的名称、环境（开发/生产等），以及数据库的连接字符串。确保在 .env 文件中不要包含任何敏感信息，如数据库密码。如果需要共享配置，可以使用 env.sample 文件作为模板，并在实际部署时创建一个实际的 .env 文件。