SQLAlchemy：简单使用SQLAlchemy

使用

导入SQLAlchemy，并初始化DBSession：

# 导入:
from sqlalchemy import Column, String, create_engine
from sqlalchemy.orm import sessionmaker
from sqlalchemy.ext.declarative 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)

注：create_engine可以使用echo参数，echo=True，可以输出日志，如下所示“

2019-02-05 16:20:31,866 INFO sqlalchemy.engine.base.Engine SHOW VARIABLES LIKE 'sql_mode'
2019-02-05 16:20:31,866 INFO sqlalchemy.engine.base.Engine {}
2019-02-05 16:20:31,872 INFO sqlalchemy.engine.base.Engine SHOW VARIABLES LIKE 'lower_case_table_names'
2019-02-05 16:20:31,872 INFO sqlalchemy.engine.base.Engine {}
2019-02-05 16:20:31,879 INFO sqlalchemy.engine.base.Engine SELECT DATABASE()
2019-02-05 16:20:31,879 INFO sqlalchemy.engine.base.Engine {}
2019-02-05 16:20:31,882 INFO sqlalchemy.engine.base.Engine SELECT CAST('test plain returns' AS CHAR(60)) AS anon_1
2019-02-05 16:20:31,882 INFO sqlalchemy.engine.base.Engine {}
2019-02-05 16:20:31,883 INFO sqlalchemy.engine.base.Engine SELECT CAST('test unicode returns' AS CHAR(60)) AS anon_1
2019-02-05 16:20:31,883 INFO sqlalchemy.engine.base.Engine {}
2019-02-05 16:20:31,885 INFO sqlalchemy.engine.base.Engine BEGIN (implicit)
2019-02-05 16:20:31,887 INFO sqlalchemy.engine.base.Engine SELECT `USER`.id AS `USER_id`, `USER`.name AS `USER_name` 
FROM `USER` 
WHERE `USER`.name = %(name_1)s AND `USER`.id = %(id_1)s
2019-02-05 16:20:31,887 INFO sqlalchemy.engine.base.Engine {'name_1': 'Bob', 'id_1': '5'}

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

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

注：类必须继承Base基类，而且必须定义tablename，对应数据库中表的名称，且类中每个字段的名称必须对应数据库中的字段名称（windows中可以大小写，linux未测试），类中的字段可以少，例如数据库中有time字段，如果不是必要字段，可以在类中不定义time字段。

定义了tablename，可以输出类构建的表的信息：

>>> User.__table__
Out[2]: Table('USER', MetaData(bind=None), Column('id', String(length=20), table=<USER>, primary_key=True, nullable=False), Column('name', String(length=20), table=<USER>), schema=None)

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()

注：这里的sesson就是pymysql中的cursor游标，DBSession才是pymysql中的session。
可见，关键是获取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

如果要查找多个条件，可以写成以下几种形式：

a = session.query(User).filter(User.name == 'Bob').filter(User.id == '5').all()
a = session.query(User).filter(User.name == 'Bob', User.id == '5').all()
a = session.query(User).filter(User.name == 'Bob' and User.id == '5').all()

更通用的方法是用and_

a = session.query(User).filter(and_(User.name == 'Bob', User.id == '5')).all()

使用like，如下所示：

a = session.query(User).filter(and_(User.name.like("%%"), User.id.like('%2%'))).all()

使用filter_by

a = session.query(User).filter_by(id='5').all()

filter_by特点是不需要使用类属性表示，可以使用参数，例如id,name等。

可见，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'))

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

run参数

最后，Flask类的run()方法在本地开发服务器上运行应用程序

app.run(host, port, debug, options)

Python上面方法中的所有参数都是可选的，作用如下表描述说明

编号	参数	描述
1	host	监听的主机名。默认为127.0.0.1(localhost)。 设置为’0.0.0.0’使服务器在外部可用
2	port	监听端口号，默认为:5000
3	debug	默认为:false。 如果设置为:true，则提供调试信息
4	options	被转发到底层的Werkzeug服务器。

小结

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

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

报错

报错找不到mysql的包，需要安装mysql-connector

pip install mysql-connector