Emysql 项目启动与配置教程

1. 项目目录结构及介绍

Emysql 是一个为 Elixir 语言编写的 MySQL 客户端库。以下是项目的目录结构及各部分功能介绍：

• ebin/：存放编译后的 Elixir Beam 文件。
• lib/：包含 Emysql 库的所有 Elixir 模块和源代码。
  • emysql.app.src：Emysql 应用的元数据文件。
  • emysql.erl：Emysql 的主要模块，实现了连接池和查询接口。
  • connection_pool.erl：负责管理 MySQL 连接池。
  • connection.erl：负责单个 MySQL 连接的建立和维护。
• test/：包含 Emysql 的单元测试代码。
• mix.exs：Emysql 的 Mix 项目配置文件。
• README.md：项目的说明文档。
• rebar.config：Rebar 项目配置文件（如果使用 Rebar 构建系统）。

2. 项目的启动文件介绍

Emysql 的启动主要是通过 Mix 任务来完成的。以下是启动项目的基本步骤：

首先，确保已经安装了 Elixir 和 Mix。然后，在项目根目录下执行以下命令：

mix deps.get
mix compile

这两条命令会获取项目依赖并编译项目源代码。

启动 Emysql 连接池，可以在你的 Elixir 应用中添加以下代码：

children = [
  # Emysql 连接池配置
  {Emysql, [
    pool: :my_pool,
    size: 10,
    max_overflow: 5,
    host: 'localhost',
    username: 'root',
    password: 'password',
    database: 'my_db',
    encoding: :utf8
  ]}
]

# 在进程管理器 中启动 Emysql 连接池
 ProcessManager.start_link(children, :rest_for_one)

这段代码会配置并启动一个名为 my_pool 的 Emysql 连接池。

3. 项目的配置文件介绍

Emysql 的配置主要是通过传递参数给连接池的启动选项来实现。以下是一些常见的配置选项：

• pool: 连接池的名称，用于在应用中引用。
• size: 连接池中连接的最大数量。
• max_overflow: 允许超过 size 的最大连接数。
• host: MySQL 服务器地址。
• username: 连接到 MySQL 的用户名。
• password: 连接到 MySQL 的密码。
• database: 要连接的 MySQL 数据库名称。
• encoding: MySQL 数据库的编码方式。

下面是一个配置示例：

config :emysql,
  pool: :my_pool,
  size: 10,
  max_overflow: 5,
  host: 'localhost',
  username: 'root',
  password: 'password',
  database: 'my_db',
  encoding: :utf8

这段配置可以在 Elixir 应用的配置文件 config/config.exs 中设置。这样，Emysql 就会使用这些配置来启动和管理连接池。