使用 SQLAlchemy

使用 SQLAlchemy

许多人喜欢使用 SQLAlchemy 来访问数据库。建议在你的 Flask 应用中使用包来代替模块，并把模型放入一个独立的模块中（参见大型应用）。虽然这不是必须的，但是很有用。

有四种 SQLAlchemy 的常用方法，下面一一道来：

Flask-SQLAlchemy 扩展

因为 SQLAlchemy 是一个常用的数据库抽象层，并且需要一定的配置才能使用，因此我们为你做了一个处理 SQLAlchemy 的扩展。如果你需要快速的开始使用SQLAlchemy ，那么推荐你使用这个扩展。

你可以从 PyPI 下载Flask-SQLAlchemy 。

声明

SQLAlchemy 中的声明扩展是使用 SQLAlchemy 的最新方法，它允许你像 Django 一样，在一个地方定义表和模型然后到处使用。除了以下内容，我建议你阅读声明的官方文档。

以下是示例 database.py 模块:

1. from sqlalchemy import create_engine
2. from sqlalchemy.orm import scoped_session, sessionmaker
3. from sqlalchemy.ext.declarative import declarative_base

5. engine = create_engine('sqlite:////tmp/test.db', convert_unicode=True)
6. db_session = scoped_session(sessionmaker(autocommit=False,
7. autoflush=False,
8. bind=engine))
9. Base = declarative_base()
10. Base.query = db_session.query_property()

12. def init_db():
13. # 在这里导入定义模型所需要的所有模块，这样它们就会正确的注册在
14. # 元数据上。否则你就必须在调用 init_db() 之前导入它们。
15. import yourapplication.models
16. Base.metadata.create_all(bind=engine)

要定义模型的话，只要继承上面创建的 Base 类就可以了。你可能会奇怪这里为什么不用理会线程（就像我们在 SQLite3 的例子中一样使用 g 对象）。原因是 SQLAlchemy 已经用 scoped_session 为我们做好了此类工作。

如果要在应用中以声明方式使用 SQLAlchemy ，那么只要把下列代码加入应用模块就可以了。 Flask 会自动在请求结束时或者应用关闭时删除数据库会话:

1. from yourapplication.database import db_session

3. @app.teardown_appcontext
4. def shutdown_session(exception=None):
5. db_session.remove()

以下是一个示例模型（放入 models.py 中）:

1. from sqlalchemy import Column, Integer, String
2. from yourapplication.database import Base

4. class User(Base):
5. __tablename__ = 'users'
6. id = Column(Integer, primary_key=True)
7. name = Column(String(50), unique=True)
8. email = Column(String(120), unique=True)

10. def __init__(self, name=None, email=None):
11. self.name = name
12. self.email = email

14. def __repr__(self):
15. return '<User %r>' % (self.name)

可以使用 init_db 函数来创建数据库：

1. >>> from yourapplication.database import init_db
2. >>> init_db()

在数据库中插入条目示例：

1. >>> from yourapplication.database import db_session
2. >>> from yourapplication.models import User
3. >>> u = User('admin', 'admin@localhost')
4. >>> db_session.add(u)
5. >>> db_session.commit()

查询很简单：

1. >>> User.query.all()
2. [<User u'admin'>]
3. >>> User.query.filter(User.name == 'admin').first()
4. <User u'admin'>

人工对象关系映射

人工对象关系映射相较于上面的声明方式有优点也有缺点。主要区别是人工对象关系映射分别定义表和类并映射它们。这种方式更灵活，但是要多些代码。通常，这种方式与声明方式一样运行，因此请确保把你的应用在包中分为多个模块。

示例 database.py 模块:

1. from sqlalchemy import create_engine, MetaData
2. from sqlalchemy.orm import scoped_session, sessionmaker

4. engine = create_engine('sqlite:////tmp/test.db', convert_unicode=True)
5. metadata = MetaData()
6. db_session = scoped_session(sessionmaker(autocommit=False,
7. autoflush=False,
8. bind=engine))
9. def init_db():
10. metadata.create_all(bind=engine)

就像声明方法一样，你需要在每个请求结束后或者应用情境关闭后关闭会话。把以下代码放入你的应用模块:

1. from yourapplication.database import db_session

3. @app.teardown_appcontext
4. def shutdown_session(exception=None):
5. db_session.remove()

以下是一个示例表和模型（放入 models.py 中）:

1. from sqlalchemy import Table, Column, Integer, String
2. from sqlalchemy.orm import mapper
3. from yourapplication.database import metadata, db_session

5. class User(object):
6. query = db_session.query_property()

8. def __init__(self, name=None, email=None):
9. self.name = name
10. self.email = email

12. def __repr__(self):
13. return '<User %r>' % (self.name)

15. users = Table('users', metadata,
16. Column('id', Integer, primary_key=True),
17. Column('name', String(50), unique=True),
18. Column('email', String(120), unique=True)
19. )
20. mapper(User, users)

查询和插入与声明方式的一样。

SQL 抽象层

如果你只需要使用数据库系统（和 SQL ）抽象层，那么基本上只要使用引擎:

1. from sqlalchemy import create_engine, MetaData, Table

3. engine = create_engine('sqlite:////tmp/test.db', convert_unicode=True)
4. metadata = MetaData(bind=engine)

然后你要么像前文中一样在代码中声明表，要么自动载入它们:

1. from sqlalchemy import Table

3. users = Table('users', metadata, autoload=True)

可以使用 insert 方法插入数据。为了使用事务，我们必须先得到一个连接：

1. >>> con = engine.connect()
2. >>> con.execute(users.insert(), name='admin', email='admin@localhost')

SQLAlchemy 会自动提交。

可以直接使用引擎或连接来查询数据库：

1. >>> users.select(users.c.id == 1).execute().first()
2. (1, u'admin', u'admin@localhost')

查询结果也是类字典元组：

1. >>> r = users.select(users.c.id == 1).execute().first()
2. >>> r['name']
3. u'admin'

你也可以把 SQL 语句作为字符串传递给execute() 方法：

1. >>> engine.execute('select * from users where id = :1', [1]).first()
2. (1, u'admin', u'admin@localhost')

关于 SQLAlchemy 的更多信息请移步其官方网站。