sumo_db 项目安装与使用教程

sumo_db 项目安装与使用教程

sumo_dbErlang Persistency Framework项目地址:https://gitcode.com/gh_mirrors/su/sumo_db

1. 项目的目录结构及介绍

sumo_db/
├── src/
│   ├── sumo_db.erl
│   ├── sumo_db_pgsql.erl
│   └── ...
├── test/
│   ├── sumo_test_people_pgsql.erl
│   └── ...
├── config/
│   ├── test.config
│   └── ...
├── README.md
├── LICENSE
├── rebar.config
├── rebar.lock
└── docker-compose.yml

目录结构介绍

• src/: 包含项目的源代码文件，如 sumo_db.erl 和 sumo_db_pgsql.erl 等。
• test/: 包含项目的测试文件，如 sumo_test_people_pgsql.erl 等。
• config/: 包含项目的配置文件，如 test.config 等。
• README.md: 项目的介绍文件，包含项目的概述、安装和使用说明。
• LICENSE: 项目的许可证文件，说明项目的开源许可证类型。
• rebar.config: 项目的构建配置文件，用于配置项目的依赖和构建选项。
• rebar.lock: 项目的依赖锁定文件，记录了项目依赖的具体版本。
• docker-compose.yml: 用于启动 PostgreSQL 数据库的 Docker 配置文件。

2. 项目的启动文件介绍

启动文件

• src/sumo_db.erl: 这是 sumo_db 项目的主模块文件，包含了项目的核心逻辑和功能。
• src/sumo_db_pgsql.erl: 这是 sumo_db 项目的 PostgreSQL 适配器模块文件，负责与 PostgreSQL 数据库的交互。

启动步骤

1. 添加依赖: 在 rebar.config 文件中添加 sumo_db 和 sumo_db_pgsql 作为项目的依赖。
2. 配置文件: 在 config/ 目录下创建或修改配置文件，如 test.config。
3. 启动应用: 使用 rebar3 shell 启动 Erlang 控制台，并加载配置文件。

$ REBAR_PROFILE=test rebar3 shell --config=config/test.config

4. 启动应用: 在 Erlang 控制台中启动 sumo_db_pgsql 应用。

> application:ensure_all_started(sumo_db_pgsql).

3. 项目的配置文件介绍

配置文件

• config/test.config: 这是项目的配置文件，包含了项目的各种配置选项，如数据库连接信息、日志配置等。

配置文件示例

[
  {sumo_db, [
    {backend, sumo_backend_pgsql},
    {db_config, [
      {host, "localhost"},
      {port, 5432},
      {database, "sumo_test"},
      {username, "postgres"},
      {password, "postgres"}
    ]}
  ]}
].

配置文件说明

• backend: 指定使用的后端数据库类型，这里是 sumo_backend_pgsql，表示使用 PostgreSQL 数据库。
• db_config: 包含数据库连接的详细配置，如主机地址、端口、数据库名称、用户名和密码等。

通过以上步骤，您可以成功安装并启动 sumo_db 项目，并根据需要进行配置和使用。

sumo_dbErlang Persistency Framework项目地址:https://gitcode.com/gh_mirrors/su/sumo_db