使用SQLAlchemy

30次阅读

共计 2426 个字符，预计需要花费 7 分钟才能阅读完成。

数据库表是一个二维表，包含多行多列。把一个表的内容用 Python 的数据结构表示出来的话，可以用一个 list 表示多行，list的每一个元素是 tuple，表示一行记录，比如，包含id 和name的 user 表：

[('1', 'Michael'),
    ('2', 'Bob'),
    ('3', 'Adam')
]

Python 的 DB-API 返回的数据结构就是像上面这样表示的。

但是用 tuple 表示一行很难看出表的结构。如果把一个 tuple 用class实例来表示，就可以更容易地看出表的结构来：

class User(object):
    def __init__(self, id, name):
        self.id = id
        self.name = name

[User('1', 'Michael'),
    User('2', 'Bob'),
    User('3', 'Adam')
]

这就是传说中的 ORM 技术：Object-Relational Mapping，把关系数据库的表结构映射到对象上。是不是很简单？

但是由谁来做这个转换呢？所以 ORM 框架应运而生。

在 Python 中，最有名的 ORM 框架是 SQLAlchemy。我们来看看 SQLAlchemy 的用法。

首先通过 pip 安装 SQLAlchemy：

$ pip install sqlalchemy

然后，利用上次我们在 MySQL 的 test 数据库中创建的 user 表，用 SQLAlchemy 来试试：

第一步，导入 SQLAlchemy，并初始化 DBSession：

# 导入:
from sqlalchemy import Column, String, create_engine
from sqlalchemy.orm import sessionmaker
from sqlalchemy.orm import declarative_base

# 创建对象的基类:
Base = declarative_base()

# 定义 User 对象:
class User(Base):
    # 表的名字:
    __tablename__ = 'user'

    # 表的结构:
    id = Column(String(20), primary_key=True)
    name = Column(String(20))

# 初始化数据库连接:
engine = create_engine('mysql+mysqlconnector://root:password@localhost:3306/test')
# 创建 DBSession 类型:
DBSession = sessionmaker(bind=engine)

以上代码完成 SQLAlchemy 的初始化和具体每个表的 class 定义。如果有多个表，就继续定义其他class，例如 School：

class School(Base):
    __tablename__ = 'school'
    id = ...
    name = ...

create_engine()用来初始化数据库连接。SQLAlchemy 用一个字符串表示连接信息：

'数据库类型 + 数据库驱动名称:// 用户名: 口令 @机器地址: 端口号 / 数据库名'

你只需要根据需要替换掉用户名、口令等信息即可。

下面，我们看看如何向数据库表中添加一行记录。

由于有了 ORM，我们向数据库表中添加一行记录，可以视为添加一个 User 对象：

# 创建 session 对象:
session = DBSession()
# 创建新 User 对象:
new_user = User(id='5', name='Bob')
# 添加到 session:
session.add(new_user)
# 提交即保存到数据库:
session.commit()
# 关闭 session:
session.close()

可见，关键是获取 session，然后把对象添加到 session，最后提交并关闭。DBSession对象可视为当前数据库连接。

如何从数据库表中查询数据呢？有了 ORM，查询出来的可以不再是 tuple，而是User 对象。SQLAlchemy 提供的查询接口如下：

# 创建 Session:
session = DBSession()
# 创建 Query 查询，filter 是 where 条件，最后调用 one()返回唯一行，如果调用 all()则返回所有行:
user = session.query(User).filter(User.id=='5').one()
# 打印类型和对象的 name 属性:
print('type:', type(user))
print('name:', user.name)
# 关闭 Session:
session.close()

运行结果如下：

type: <class '__main__.User'>
name: Bob

可见，ORM 就是把数据库表的行与相应的对象建立关联，互相转换。

由于关系数据库的多个表还可以用外键实现一对多、多对多等关联，相应地，ORM 框架也可以提供两个对象之间的一对多、多对多等功能。

例如，如果一个 User 拥有多个 Book，就可以定义一对多关系如下：

class User(Base):
    __tablename__ = 'user'

    id = Column(String(20), primary_key=True)
    name = Column(String(20))
    # 一对多:
    books = relationship('Book')

class Book(Base):
    __tablename__ = 'book'

    id = Column(String(20), primary_key=True)
    name = Column(String(20))
    #“多”的一方的 book 表是通过外键关联到 user 表的:
    user_id = Column(String(20), ForeignKey('user.id'))