sqlalchemy连接mysql数据库

news2024/11/6 7:05:55

create_engine() 是 SQLAlchemy 中用于创建数据库连接的函数，它接受多个参数来配置连接池、日志输出等方面。你提到的 create_engine(DATABASE_URI, echo=True, pool_size=5, max_overflow=2, pool_timeout=30) 中的各个参数的含义如下：

1. `DATABASE_URI`

意义: 这是连接数据库的 URI 字符串，通常包括数据库的类型（如 postgresql:// 或 mysql://），用户名、密码、主机、端口、数据库名称等信息。
示例: 'postgresql://user:password@localhost/mydatabase'

2. `echo=True`

意义: 控制 SQLAlchemy 是否输出 SQL 执行的日志。
- True：会打印所有执行的 SQL 语句（包括参数化查询的 SQL），以及数据库返回的结果。
- False：关闭 SQL 日志输出（默认）。
用途: 开发调试时，启用 echo=True 可以帮助你查看生成的 SQL 查询，检查是否与预期一致。

示例:
```
engine = create_engine(DATABASE_URI, echo=True)
```

3. `pool_size=5`

意义: 设置连接池的大小，即连接池中保持的数据库连接数的数量。
- 连接池是 SQLAlchemy 为了高效地管理数据库连接而实现的一种机制，避免每次都要重新建立连接。
- pool_size=5 表示池中最多可以同时存在 5 个连接。
用途: 适用于高并发的应用，允许多个数据库连接并发执行查询。调整 pool_size 可以控制连接池的大小，以应对不同的负载需求。

示例:
```
engine = create_engine(DATABASE_URI, pool_size=5)
```

4. `max_overflow=2`

意义: 设置连接池可以额外创建的连接数，超过 pool_size 的连接数。也就是，当连接池中的连接都被占用时，最多可以创建 max_overflow 个额外的连接。
- max_overflow=2 表示池子最多可以超出 pool_size 2 个额外连接（在高峰时创建更多临时连接以处理并发请求）。
- 如果请求的连接数超过池大小 + max_overflow，会导致连接请求被阻塞，直到有连接释放。
用途: 当负载非常高时，可以设置较大的 max_overflow 来增加连接池的最大容量，以避免连接请求被阻塞。

示例:
```
engine = create_engine(DATABASE_URI, max_overflow=2)
```

5. `pool_timeout=30`

意义: 设置获取连接池连接的超时时间（秒）。
- pool_timeout=30 表示如果连接池中没有空闲连接，SQLAlchemy 会等待 30 秒，如果在这段时间内没有获得连接，则会抛出超时错误。
- 该参数有助于避免在高负载情况下等待连接池超时。
用途: 如果你预计在高并发情况下，数据库连接池可能会暂时被占满，设置合适的 pool_timeout 可以避免请求长时间阻塞。

示例:
```
engine = create_engine(DATABASE_URI, pool_timeout=30)
```

综合示例

假设我们需要创建一个 PostgreSQL 数据库的引擎，连接池大小为 5，最多可以超出 2 个连接，连接获取超时时间为 30 秒，并启用 SQL 调试日志输出。代码如下：

from sqlalchemy import create_engine

DATABASE_URI = 'postgresql://user:password@localhost/mydatabase'

engine = create_engine(
    DATABASE_URI,
    echo=True,               # 启用 SQL 日志输出
    pool_size=5,             # 连接池大小 5
    max_overflow=2,          # 超过池大小的最大额外连接数 2
    pool_timeout=30          # 获取连接时的最大等待时间 30 秒
)