使用 SQLAlchemy
许多人喜欢使用 SQLAlchemy 来访问数据库。建议在你的 Flask 应用中使用 包来代替模块,并把模型放入一个独立的模块中(参见 大型应用作为一个包 )。虽 然这不是必须的,但是很有用。
有四种 SQLAlchemy 的常用方法,下面一一道来:
Flask-SQLAlchemy 扩展
因为 SQLAlchemy 是一个常用的数据库抽象层,并且需要一定的配置才能使用,因此 我们为你做了一个处理 SQLAlchemy 的扩展。如果你需要快速的开始使用 SQLAlchemy ,那么推荐你使用这个扩展。
你可以从 PyPI 下载 Flask-SQLAlchemy 。
声明
SQLAlchemy 中的声明扩展是使用 SQLAlchemy 的最新方法,它允许你像 Django 一 样,在一个地方定义表和模型然后到处使用。除了以下内容,我建议你阅读 声明 的官方文档。
以下是示例 database.py 模块:
from sqlalchemy import create_enginefrom sqlalchemy.orm import scoped_session, sessionmakerfrom sqlalchemy.ext.declarative import declarative_baseengine = create_engine('sqlite:////tmp/test.db')db_session = scoped_session(sessionmaker(autocommit=False,autoflush=False,bind=engine))Base = declarative_base()Base.query = db_session.query_property()def init_db():# 在这里导入定义模型所需要的所有模块,这样它们就会正确的注册在# 元数据上。否则你就必须在调用 init_db() 之前导入它们。import yourapplication.modelsBase.metadata.create_all(bind=engine)
要定义模型的话,只要继承上面创建的 Base 类就可以了。你可能会奇怪这里为什 么不用理会线程(就像我们在 SQLite3 的例子中一样使用 g 对象)。 原因是 SQLAlchemy 已经用 scoped_session 为我们做 好了此类工作。
如果要在应用中以声明方式使用 SQLAlchemy ,那么只要把下列代码加入应用模块就 可以了。 Flask 会自动在请求结束时或者应用关闭时删除数据库会话:
from yourapplication.database import db_session@app.teardown_appcontextdef shutdown_session(exception=None):db_session.remove()
以下是一个示例模型(放入 models.py 中):
from sqlalchemy import Column, Integer, Stringfrom yourapplication.database import Baseclass User(Base):__tablename__ = 'users'id = Column(Integer, primary_key=True)name = Column(String(50), unique=True)email = Column(String(120), unique=True)def __init__(self, name=None, email=None):self.name = nameself.email = emaildef __repr__(self):return f'<User {self.name!r}>'
可以使用 init_db 函数来创建数据库:
>>> from yourapplication.database import init_db>>> init_db()
在数据库中插入条目示例:
>>> from yourapplication.database import db_session>>> from yourapplication.models import User>>> u = User('admin', 'admin@localhost')>>> db_session.add(u)>>> db_session.commit()
查询很简单:
>>> User.query.all()[<User 'admin'>]>>> User.query.filter(User.name == 'admin').first()<User 'admin'>
人工对象关系映射
人工对象关系映射相较于上面的声明方式有优点也有缺点。主要区别是人工对象关系 映射分别定义表和类并映射它们。这种方式更灵活,但是要多些代码。通常,这种方 式与声明方式一样运行,因此请确保把你的应用在包中分为多个模块。
示例 database.py 模块:
from sqlalchemy import create_engine, MetaDatafrom sqlalchemy.orm import scoped_session, sessionmakerengine = create_engine('sqlite:////tmp/test.db')metadata = MetaData()db_session = scoped_session(sessionmaker(autocommit=False,autoflush=False,bind=engine))def init_db():metadata.create_all(bind=engine)
就像声明方法一样,你需要在每个请求结束后或者应用情境关闭后关闭会话。把以下 代码放入你的应用模块:
from yourapplication.database import db_session@app.teardown_appcontextdef shutdown_session(exception=None):db_session.remove()
以下是一个示例表和模型(放入 models.py 中):
from sqlalchemy import Table, Column, Integer, Stringfrom sqlalchemy.orm import mapperfrom yourapplication.database import metadata, db_sessionclass User(object):query = db_session.query_property()def __init__(self, name=None, email=None):self.name = nameself.email = emaildef __repr__(self):return f'<User {self.name!r}>'users = Table('users', metadata,Column('id', Integer, primary_key=True),Column('name', String(50), unique=True),Column('email', String(120), unique=True))mapper(User, users)
查询和插入与声明方式的一样。
SQL 抽象层
如果你只需要使用数据库系统(和 SQL )抽象层,那么基本上只要使用引擎:
from sqlalchemy import create_engine, MetaData, Tableengine = create_engine('sqlite:////tmp/test.db')metadata = MetaData(bind=engine)
然后你要么像前文中一样在代码中声明表,要么自动载入它们:
from sqlalchemy import Tableusers = Table('users', metadata, autoload=True)
可以使用 insert 方法插入数据。为了使用事务,我们必须先得到一个连接:
>>> con = engine.connect()>>> con.execute(users.insert(), name='admin', email='admin@localhost')
SQLAlchemy 会自动提交。
可以直接使用引擎或连接来查询数据库:
>>> users.select(users.c.id == 1).execute().first()(1, 'admin', u'admin@localhost')
查询结果也是类字典元组:
>>> r = users.select(users.c.id == 1).execute().first()>>> r['name']'admin'
你也可以把 SQL 语句作为字符串传递给 execute() 方法:
>>> engine.execute('select * from users where id = :1', [1]).first()(1, 'admin', u'admin@localhost')
关于 SQLAlchemy 的更多信息请移步其 官方网站 。