一、简介
flask本身没有内置orm框架，需要依赖第三方模块，这里介绍flask-sqlalchemy,而flask-sqlalchemy是一个flask的扩展，本质上是对sqlalchemy的进一步封装，当然也需要sqlalchemy的支持，使用起来和本来的sqlalchemy的orm是一样的。本文主要介绍sqlalchemy的使用以及如何在flask中是用orm。
二、sqlalchemy
SQLAlchemy是Python编程语言下的一款ORM框架，该框架建立在数据库API之上，使用关系对象映射进行数据库操作，简言之便是：将对象转换成SQL，然后使用数据API执行SQL并获取执行结果。图示：
基本使用
安装：
pip3 install sqlalchemy
注：SQLAlchemy无法修改表结构，如果需要可以使用SQLAlchemy开发者开源的另外一个软件Alembic来完成，官网doc：http://docs.sqlalchemy.org/en/latest/core/expression_api.html
原生SQL
使用 Engine/ConnectionPooling/Dialect 进行数据库操作，Engine使用ConnectionPooling连接数据库，然后再通过Dialect执行SQL语句
#!/usr/bin/env python3#_*_ coding:utf-8 _*_#Author:wdfrom sqlalchemy import create_engine
engine=create_engine("mysql+pymysql://stu:[email protected]:3307/student", max_overflow=5)#创建连接，允许溢出5个连接result = engine.execute('select * from student')#使用excute执行原生sqlprint(result.fetchall())#获取所有结果，与pymyql类似
事务
#!/usr/bin/env python3#_*_ coding:utf-8 _*_#Author:wdfrom sqlalchemy import create_engine
engine=create_engine("mysql+pymysql://stu:[email protected]:3307/student", max_overflow=5)#创建连接，允许溢出5个连接result = engine.execute('select * from student')#使用excute执行原生sqlwith engine.begin() as conn: #事务操作
conn.execute("insert into student (name, age, res_date) values ('weikang', 33, '1992-11-11')")
print(result.fetchall())#获取所有结果，与pymyql类似
建表
定义数据表，才能进行sql表达式的操作，毕竟sql表达式的表的确定，是sqlalchemy制定的，如果数据库已经存在了数据表还需要定义么？当然，这里其实是一个映射关系，如果不指定，查询表达式就不知道是附加在那个表的操作，当然定义的时候，注意表名和字段名，代码和数据的必须保持一致。定义好之后,就能创建数据表，一旦创建了，再次运行创建的代码，数据库是不会创建的。
sqlalchemy内部组件调用顺序为：使用 Schema Type/SQL Expression Language/Engine/ConnectionPooling/Dialect 进行数据库操作。Engine使用Schema Type创建一个特定的结构对象，之后通过SQL Expression Language将该对象转换成SQL语句，然后通过 ConnectionPooling 连接数据库，再然后通过 Dialect 执行SQL，并获取结果。
TIPS：使用类的方式和使用metadata方式创建表时候区别在于metadata可以不指定主键，而是用class方式必须要求有主键。
demo1:
from sqlalchemy import create_engine,Table,Column,Integer,String,ForeignKey,MetaData
engine=create_engine("mysql+pymysql://stu:[email protected]:3307/student?charset=gbk",
encoding="utf-8",
echo=True,
max_overflow=5
)#?charset是字符集编码，echo=True打印输出信息和执行的sql语句默认Flase，max_overflow=5允许溢出连接池连接数量meta=MetaData()#生成源类#定义表结构user=Table('user',meta,
Column('id',Integer,nullable=Table,autoincrement=True,primary_key=True),
Column('name',String(20),nullable=True),
Column('age',Integer,nullable=True)
)
host=Table('host',meta,
Column('ip',String(20),nullable=True),
Column('hostname',String(20),nullable=True),
)
meta.create_all(engine)#创建表，如果存在则忽视
demo2:
使用orm基类创建
#!/usr/bin/env python3#_*_ coding:utf-8 _*_#Author:wdfrom sqlalchemy import create_engine,Table,Column,Integer,String,ForeignKey,MetaData,Datefrom sqlalchemy.ext.declarative import declarative_base
engine=create_engine("mysql+pymysql://stu:[email protected]:3307/student?charset=gbk",
encoding="utf-8",
echo=True,
max_overflow=5
)#?charset是字符集编码，echo=True打印输出信息和执行的sql语句默认Flase，max_overflow=5允许溢出连接池连接数量base=declarative_base()#生成ORM基类#定义表结构class User(base): __tablename__='book' #表明
id = Column(Integer, primary_key=True)
name=Column(String(32))
date=Column(Date)
base.metadata.create_all(engine)#创建表，如果存在则忽视
orm增删改查
增
#!/usr/bin/env python3#_*_ coding:utf-8 _*_#Author:wdfrom sqlalchemy import create_engine,Table,Column,Integer,String,ForeignKeyfrom sqlalchemy.orm import sessionmakerfrom sqlalchemy.ext.declarative import declarative_base
engine=create_engine("mysql+pymysql://stu:[email protected]:3307/student?charset=gbk",
max_overflow=5,
echo=True)#数据库连接信息为，连接类型://用户名:密码@数据库地址:端口／数据库名字？编码#max_overflow创建连接，允许溢出5个连接,echo=True，输出相应的sql信息到控制台，方便调试。base=declarative_base()#生成orm基类class user(base): #映射表
__tablename__='user'
id=Column(Integer,autoincrement=True,primary_key=True)
name=Column(String(20))
age=Column(Integer)
sessoion_class=sessionmaker(bind=engine)#创建与数据库的会话类，这里的sessoion_class是类Session=sessoion_class()#生成会话实例user1=user(name='wd',age=22)#生成user对象Session.add(user1) #添加user1，可以使用add_all,参数为列表或者tupleSession.commit() #提交#Session.rollback() #回滚Session.close() #关闭会话
删
data=Session.query(user).filter(user.age==33).delete() Session.commit() #提交Session.close() #关闭会话
改
#data=Session.query(user).filter(user.age>20).update({"name":'jarry'})#update语法data=Session.query(user).filter(user.age==22).first()#面向对象语法data.name='coco'#如果data中数据多条需要使用for循环设置Session.commit() #提交Session.close() #关闭会话查
#!/usr/bin/env python3#_*_ coding:utf-8 _*_#Author:wdfrom sqlalchemy import create_engine,Table,Column,Integer,String,ForeignKeyfrom sqlalchemy.orm import sessionmakerfrom sqlalchemy.ext.declarative import declarative_base
engine=create_engine("mysql+pymysql://stu:[email protected]:3307/student?charset=gbk",
max_overflow=5,
echo=True)#数据库连接信息为，连接类型://用户名:密码@数据库地址:端口／数据库名字？编码#max_overflow创建连接，允许溢出5个连接,echo=True，输出相应的sql信息到控制台，方便调试。base=declarative_base()#生成orm基类class user(base): #映射表
__tablename__='user'
id=Column(Integer,autoincrement=True,primary_key=True)
name=Column(String(20))
age=Column(Integer) def __repr__(self): #定义
return "(%s,%s,%s)" % (self.id,self.name,self.age)
sessoion_class=sessionmaker(bind=engine)#创建与数据库的会话类，这里的sessoion_class是类Session=sessoion_class()#生成会话实例#data=Session.query(user).get(2) #get语法获取primrykey中的关键字，在这里主键为id，获取id为2的数据#data=Session.query(user).filter(user.age>22,user.name=='mack').first()#filter语法两个等于号，filter_by语法一个等于号，可以有多个filter,如果多个数据返回列表，first代表获取第一个，为all()获取所有data=Session.query(user).filter(user.age>20,user.name.in_(['mack','wd'])).all()#in语法print(data[0]) #打印第一个结果Session.commit() #提交，如果回滚的话，数据将不存在了Session.close() #关闭会话
Common Filter Operators
Here’s a rundown of some of the most common operators used in filter():
equals:
query.filter(User.name == 'ed')not equals:
query.filter(User.name != 'ed')
LIKE:
query.filter(User.name.like('%ed%'))
IN:
NOT IN:
query.filter(~User.name.in_(['ed', 'wendy', 'jack']))
IS NULL:
IS NOT NULL:
AND:2.1. ObjectRelationalTutorial 17query.filter(User.name.in_(['ed', 'wendy', 'jack']))# works with query objects too:query.filter(User.name.in_( session.query(User.name).filter(User.name.like('%ed%'))
))
query.filter(User.name == None)# alternatively, if pep8/linters are a concernquery.filter(User.name.is_(None))
query.filter(User.name != None)# alternatively, if pep8/linters are a concernquery.filter(User.name.isnot(None))
SQLAlchemy Documentation, Release 1.1.0b1# use and_()from sqlalchemy import and_
query.filter(and_(User.name == 'ed', User.fullname == 'Ed Jones'))# or send multiple expressions to .filter()query.filter(User.name == 'ed', User.fullname == 'Ed Jones')# or chain multiple filter()/filter_by() callsquery.filter(User.name == 'ed').filter(User.fullname == 'Ed Jones')
Note: Makesureyouuseand_()andnotthePythonandoperator! • OR:
Note: Makesureyouuseor_()andnotthePythonoroperator! • MATCH:
query.filter(User.name.match('wendy'))
Note: match() uses a database-specific MATCH or CONTAINS f
常用查询语法
常用查询
其他操作
##获取所有数据data=Session.query(user).all()#获取user表所有数据for i in data: print(i)##统计#count=Session.query(user).count()#获取所有的条数count=Session.query(user).filter(user.name.like("ja%")).count()#获取某些条数print(count)##分组from sqlalchemy import func#需要导入func函数res=Session.query(func.count(user.name),user.name).group_by(user.name).all()print(res)
外间关联
TIPS：设置外检的另一种方式 ForeignKeyConstraint(['other_id'], ['othertable.other_id'])
#!/usr/bin/env python3#_*_ coding:utf-8 _*_#Author:wdfrom sqlalchemy import create_engine,Table,Column,Integer,String,ForeignKeyfrom sqlalchemy.orm import sessionmakerfrom sqlalchemy.ext.declarative import declarative_basefrom sqlalchemy.orm import relationship
engine=create_engine("mysql+pymysql://stu:[email protected]:3307/student?charset=gbk",
encoding="utf-8",
echo=True,
max_overflow=5
)#?charset是连接数据库的字符集编码（和数据库的编码一样），echo=True打印输出信息和执行的sql语句默认Flase，max_overflow=5允许溢出连接池连接数量Base=declarative_base()class user(Base): __tablename__='user'
id=Column(Integer,primary_key=True,autoincrement=True)
name=Column(String(20))
age=Column(Integer) def __repr__(self): return "<id:%s,name:%s,age:%s>"%(self.id,self.name,self.age)class host(Base): __tablename__='host'
user_id=Column(Integer,ForeignKey('user.id'))#user_id关联user表中的id
hostname=Column(String(20))
ip=Column(String(20),primary_key=True)
host_user=relationship('user',backref='user_host') #通过host_user查询host表中关联的user信息,通过user_host，在user表查询关联的host，与生成的表结构无关，只是为了方便查询
def __repr__(self): return "<user_id:%s,hostname:%s,ip:%s>"%(self.user_id,self.hostname,self.ip)
Base.metadata.create_all(engine)
Session_class=sessionmaker(bind=engine)
Session=Session_class()
host1=Session.query(host).first()print(host1.host_user)print(host1)
user1=Session.query(user).first()print(user1.user_host)
多外键关联一个表中的一个字段
应用场景：当我们购物时候，你会发现有一个收发票地址，和一个收货地址。关系如下：默认情况下，发票地址和收获地址是一致的，但是也有可能我想买东西送给别人，而发票要自己留着，那收货的地址和寄送发票的地址可以不同。即：同一个人的两个收获地址可以不同，多个收获地址关联同一个人。
#!/usr/bin/env python3#_*_ coding:utf-8 _*_#Author:wdfrom sqlalchemy import Integer, ForeignKey, String, Columnfrom sqlalchemy.ext.declarative import declarative_basefrom sqlalchemy.orm import relationship
Base = declarative_base()class Customer(Base): __tablename__ = 'customer'
id = Column(Integer, primary_key=True)
name = Column(String)
billing_address_id = Column(Integer, ForeignKey("address.id"))
shipping_address_id = Column(Integer, ForeignKey("address.id"))
billing_address = relationship("Address", foreign_keys=[billing_address_id])
shipping_address = relationship("Address", foreign_keys=[shipping_address_id]) #同时关联同一个字段，使用relationship需要指定foreign_keys，为了让sqlalchemy清楚关联的外键class Address(Base): __tablename__ = 'address'
id = Column(Integer, primary_key=True)
street = Column(String)
city = Column(String)
state = Column(String)
多对多外键关联
很多时候，我们会使用多对多外键关联，例如：书和作者，学生和课程，即：书可以有多个作者，而每个作者可以写多本书，orm提供了更简单方式操作多对多关系，在进行删除操作的时候，orm会自动删除相关联的数据。
表结构创建
#!/usr/bin/env python3#_*_ coding:utf-8 _*_#Author:wdfrom sqlalchemy import Column,Table,String,Integer,ForeignKeyfrom sqlalchemy.ext.declarative import declarative_basefrom sqlalchemy import create_enginefrom sqlalchemy.orm import relationship
engine=create_engine("mysql+pymysql://stu:[email protected]:3307/student?charset=gbk",
encoding="utf-8",
echo=True,
max_overflow=5
)
Base=declarative_base()
stu_cour=Table('stu_cour',Base.metadata,
Column('stu_id',Integer,ForeignKey('student.id')),
Column('cour_id',Integer,ForeignKey('course.id'))
)class student(Base): __tablename__='student'
id=Column(Integer,autoincrement=True,primary_key=True)
stu_name=Column(String(32))
stu_age=Column(String(32))
courses=relationship('course',secondary=stu_cour,backref='students') #course是关联的第一张表，stu_cour是关联的第二张表，当然，也可以在第三张关联表中使用两个relationship关联student表和course表
def __repr__(self): return '<%s>'%self.stu_nameclass course(Base): __tablename__='course'
id=Column(Integer,autoincrement=True,primary_key=True)
cour_name=Column(String(32)) def __repr__(self): return '<%s>'%self.cour_name
Base.metadata.create_all(engine)
创建表结构
建表
插入数据
#!/usr/bin/env python3#_*_ coding:utf-8 _*_#Author:wdfrom sqlalchemy import Column,Table,String,Integer,ForeignKeyfrom sqlalchemy.ext.declarative import declarative_basefrom sqlalchemy import create_enginefrom sqlalchemy.orm import relationshipfrom sqlalchemy.orm import sessionmaker
engine=create_engine("mysql+pymysql://stu:[email protected]:3307/student?charset=gbk",
encoding="utf-8",
echo=True,
max_overflow=5
)
Base=declarative_base()
stu_cour=Table('stu_cour',Base.metadata,
Column('stu_id',Integer,ForeignKey('student.id')),
Column('cour_id',Integer,ForeignKey('course.id'))
)class student(Base): __tablename__='student'
id=Column(Integer,autoincrement=True,primary_key=True)
stu_name=Column(String(32))
stu_age=Column(String(32))
courses=relationship('course',secondary=stu_cour,backref='students') #course是关联的第一张表，stu_cour是关联的第二张表，当然，也可以在第三张关联表中使用两个relationship关联student表和course表
def __repr__(self): return '<%s>'%self.stu_nameclass course(Base): __tablename__='course'
id=Column(Integer,autoincrement=True,primary_key=True)
cour_name=Column(String(32)) def __repr__(self): return '<%s>'%self.cour_name
stu1=student(stu_name='wd',stu_age='22')
stu2=student(stu_name='jack',stu_age=33)
stu3=student(stu_name='rose',stu_age=18)
c1=course(cour_name='linux')
c2=course(cour_name='python')
c3=course(cour_name='go')
stu1.courses=[c1,c2] #添加学生课程关联stu2.courses=[c1]
stu3.courses=[c1,c2,c3]
session_class=sessionmaker(bind=engine)
session=session_class()
session.add_all([stu1,stu2,stu3,c1,c2,c3])
session.commit()
数据插入
插入数据
查询
session_class=sessionmaker(bind=engine) session=session_class() stu_obj=session.query(student).filter(student.stu_name=='wd').first()print(stu_obj.courses)#查询wd学生所报名的课程cour_obj=session.query(course).filter(course.cour_name=='python').first()print(cour_obj.students)#查询报名python课程所对应的课程session.commit()
查询
删除
session_class=sessionmaker(bind=engine) session=session_class() cour_obj=session.query(course).filter(course.cour_name=='python').first() session.delete(cour_obj)#删除python课程session.commit()
删除
三、flask-sqlalchemy
flask中使用sqlalchemy时候，个人比较习惯安装django的项目来进行构建，以下示例以登陆验证进行说明,项目结构：
taskmanager ├── app01 │ ├── __init__.py #初始化文件│ ├── models.py #数据模型│ └── views │ └── account.py # 视图函数├── create_table.py # 建表├── run.py # 启动服务器├── settings.py #配置文件├── static #静态资源└── templates #模版 └── login.html
安装：
pip3 install flask-sqlalchemy
数据库配置
SQLALCHEMY_DATABASE_URI #用于连接的数据库 URI 。例如:sqlite:////tmp/test.dbmysql://username:password@server/dbSQLALCHEMY_BINDS #一个映射 binds 到连接 URI 的字典。更多 binds 的信息见用 Binds 操作多个数据库。SQLALCHEMY_ECHO #如果设置为Ture， SQLAlchemy 会记录所有 发给 stderr 的语句，这对调试有用。(打印sql语句)SQLALCHEMY_RECORD_QUERIES #可以用于显式地禁用或启用查询记录。查询记录 在调试或测试模式自动启用。更多信息见get_debug_queries()。SQLALCHEMY_NATIVE_UNICODE #可以用于显式禁用原生 unicode 支持。当使用 不合适的指定无编码的数据库默认值时，这对于 一些数据库适配器是必须的（比如 Ubuntu 上 某些版本的 PostgreSQL ）。SQLALCHEMY_POOL_SIZE #数据库连接池的大小。默认是引擎默认值（通常 是 5 ）SQLALCHEMY_POOL_TIMEOUT #设定连接池的连接超时时间。默认是 10 。SQLALCHEMY_POOL_RECYCLE #多少秒后自动回收连接。这对 MySQL 是必要的， 它默认移除闲置多于 8 小时的连接。注意如果 使用了 MySQL ， Flask-SQLALchemy 自动设定 这个值为 2 小时。
参考http://flask-sqlalchemy.pocoo.org/2.3/config/
新建立settings.py
#!/usr/bin/env python3# -*- coding:utf-8 -*-# Author:wdimport redisclass BaseConfig(object): #session配置 SESSION_TYPE = 'redis' # session类型为redis SESSION_KEY_PREFIX = 'session:' # 保存到session中的值的前缀 SESSION_PERMANENT = True # 如果设置为False，则关闭浏览器session就失效。 SESSION_USE_SIGNER = False # 是否对发送到浏览器上 session:cookie值进行加密 SESSION_REDIS= redis.Redis(host='10.1.210.33', port='6379') #数据库配置 SQLALCHEMY_DATABASE_URI = "mysql+pymysql://root:[email protected]:3306/devops?charset=utf8" SQLALCHEMY_POOL_SIZE = 10 #数据库连接池的大小。默认值 5 SQLALCHEMY_POOL_TIMEOUT = 30 # 指定数据库连接池的超时时间。默认是 10 SQLALCHEMY_POOL_RECYCLE = -1 SQLALCHEMY_MAX_OVERFLOW = 3 # 控制在连接池达到最大值后可以创建的连接数。当这些额外的连接回收到连接池后将会被断开和抛弃 SQLALCHEMY_TRACK_MODIFICATIONS = False # 追踪对象的修改并且发送信号class ProductionConfig(BaseConfig): """生产配置文件""" passclass DevelopmentConfig(BaseConfig): """开发配置文件""" passclass TestingConfig(BaseConfig): """ 测试配置文件 """ pass
在app目录下建立models.py
from . import dbclass UserProfile(db.Model): """ 用户 """ __tablename__ = 'userprofile' id = db.Column(db.Integer, primary_key=True) username = db.Column(db.String(64), unique=True, nullable=False) password = db.Column(db.String(64), unique=True, nullable=False) email = db.Column(db.String(128), unique=True, nullable=False) def __repr__(self): return '<user %s>' % self.username
创建视图函数初始化app，App目录新建__init__.py
from flask import Flaskfrom flask_sqlalchemy import SQLAlchemyfrom .models import *from .views import account
db = SQLAlchemy() #实例化def init_app():
app = Flask(__name__, template_folder='../templates', static_folder='../static', static_url_path='/static')
app.config.from_object('settings.DevelopmentConfig') # 将db注册到app中 db.init_app(app) # 注册蓝图 app.register_blueprint(account.account) return app
在app目录创建目录views单个py文件也可以
#!/usr/bin/env python3# -*- coding:utf-8 -*-# Author:wdfrom flask import Blueprintfrom flask import requestfrom flask import render_templatefrom .. import dbfrom .. import models
account = Blueprint('account', __name__)
@account.route('/login',methods=['GET','POST'])def login(): if request.method=="GET": return render_template("login.html") else:
user_obj=db.session.query(models.UserProfile).filter(models.UserProfile.username==request.form["username"],
models.UserProfile.password==request.form["password"]).first()
db.session.close() if user_obj: return '登陆成功'
else: return render_template("login.html",errors="用户名或密码错误！")
templates/login.html
<!DOCTYPE html><html lang="en"><head>
<meta charset="UTF-8">
<title>Title</title></head><body><div><h1>用户登陆</h1></div><div>
<form method="post">
<input type="text" name="username" placeholder="用户名">
<input type="password" name="password" placeholder="密码">
<input type="submit">
{{ errors }} </form></div></body></html>
login.html
创建启动脚本run.py
#!/usr/bin/env python3# -*- coding:utf-8 -*-# Author:wdfrom app01 import init_app app = init_app() # 创建appif __name__ == '__main__': app.run()
run.py
离线创建数据库表脚本create_table.py
#!/usr/bin/env python3# -*- coding:utf-8 -*-# Author:wdfrom app01 import init_appfrom app01 import db app = init_app() #创建appwith app.app_context(): # 执行脚本创建数据库表 db.create_all()
點擊查看更多內容
為 TA 點贊
評論
評論
共同學習，寫下你的評論
評論加載中...
作者其他優質文章
正在加載中
感謝您的支持，我會繼續努力的～
掃碼打賞，你說多少就多少
贊賞金額會直接到老師賬戶
支付方式
打開微信掃一掃，即可進行掃碼打賞哦