# seatools-starter-sqlalchemy

**Repository Path**: seatools-py/seatools-starter-sqlalchemy

## Basic Information

- **Project Name**: seatools-starter-sqlalchemy
- **Description**: seatools ioc sqlalchemy db 启动器(推荐)
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-11-28
- **Last Updated**: 2025-05-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Python, ioc, starter, Spring

## README

# Seatools-starter-sqlalchemy

seatools ioc 的 sqlalchemy 启动器

## 仓库地址:
1. https://github.com/seatools-py/seatools-starter-sqlalchemy
2. https://gitee.com/seatools-py/seatools-starter-sqlalchemy

## 使用指南
1. 安装, `poetry add seatools-starter-sqlalchemy`
2. 配置文件`config/application.yml`配置如下
```yaml
# seatools 配置
seatools:
  # sqlalchemy 配置
  sqlalchemy:
    echo: false
    pool_cycle: 3600
  # 数据库配置
  datasource:
    # 数据库bean名称
    demo_db:
      host: xxx
      port: 1234
      user: xxx
      password: sss
      database: xxx
      driver: sqlite # sqlalchemy schema数据库驱动, 示例: sqlite+aiosqlite (异步), mysql+pymysql, hive, clickhouse 等
      primary: false # 是否默认bean
      is_async: false # 是否异步, 若driver是异步驱动则该值需要改为true
      # 单独数据库的sqlalchemy覆盖配置
      config:
        echo: true
        # 1.0.6版本支持自定义Session, 默认同步为sqlalchemy.orm.Session, 异步为sqlalchemy.ext.asyncio.AsyncSession
        session_cls: sqlalchemy.orm.Session # 可改为其他Session, 例如: sqlmodel.orm.Session (需要安装sqlmodel)
```
3. 使用示例
```python
from seatools.ioc import run, Autowired
from seatools.sqlalchemy.decorators.ioc import new_session
from sqlalchemy.orm import Session
from seatools.sqlalchemy import SqlAlchemyClient


# 启动ioc
run(scan_package_names=['xxx'], config='./config')

"""
方式一, 通过装饰器, 推荐
"""
@new_session
def xxx(session: Session):
    ...

# 调用
xxx()


# 方式二, 不推荐
client = Autowired(cls=SqlAlchemyClient)

with client.session() as session:
    ...

```