使用SQLAlchemy

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

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

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

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

  1. class User(object):
  2. def __init__(self, id, name):
  3. self.id = id
  4. self.name = name
  5. [
  6. User('1', 'Michael'),
  7. User('2', 'Bob'),
  8. User('3', 'Adam')
  9. ]

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

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

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

首先通过easy_install或者pip安装SQLAlchemy:

  1. $ easy_install sqlalchemy

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

第一步,导入SQLAlchemy,并初始化DBSession:

  1. # 导入:
  2. from sqlalchemy import Column, String, create_engine
  3. from sqlalchemy.orm import sessionmaker
  4. from sqlalchemy.ext.declarative import declarative_base
  5. # 创建对象的基类:
  6. Base = declarative_base()
  7. # 定义User对象:
  8. class User(Base):
  9. # 表的名字:
  10. __tablename__ = 'user'
  11. # 表的结构:
  12. id = Column(String(20), primary_key=True)
  13. name = Column(String(20))
  14. # 初始化数据库连接:
  15. engine = create_engine('mysql+mysqlconnector://root:password@localhost:3306/test')
  16. # 创建DBSession类型:
  17. DBSession = sessionmaker(bind=engine)

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

  1. class School(Base):
  2. __tablename__ = 'school'
  3. id = ...
  4. name = ...

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

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

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

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

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

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

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

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

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

运行结果如下:

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

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

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

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

  1. class User(Base):
  2. __tablename__ = 'user'
  3. id = Column(String(20), primary_key=True)
  4. name = Column(String(20))
  5. # 一对多:
  6. books = relationship('Book')
  7. class Book(Base):
  8. __tablename__ = 'book'
  9. id = Column(String(20), primary_key=True)
  10. name = Column(String(20))
  11. # “多”的一方的book表是通过外键关联到user表的:
  12. user_id = Column(String(20), ForeignKey('user.id'))

当我们查询一个User对象时,该对象的books属性将返回一个包含若干个Book对象的list。

小结

ORM框架的作用就是把数据库表的一行记录与一个对象互相做自动转换。

正确使用ORM的前提是了解关系数据库的原理。

原文: https://wizardforcel.gitbooks.io/liaoxuefeng/content/py2/85.html