**ORM** 全拼`Object-Relation Mapping`,中文意为 **对象-关系映射**。主要实现模型对象到关系数据库数据的映射 优点 : - 只需要面向对象编程, 不需要面向数据库编写代码. - 对数据库的操作都转化成对类属性和方法的操作. - 不用编写各种数据库的`sql语句`. - 实现了数据模型与数据库的解耦, 屏蔽了不同数据库操作上的差异. - 不再需要关注当前项目使用的是哪种数据库。 - 通过简单的配置就可以轻松更换数据库, 而不需要修改代码. 缺点 : - 相比较直接使用SQL语句操作数据库,有性能损失. - 根据对象的操作转换成SQL语句,根据查询的结果转化成对象, 在映射过程中有性能损失.
flask默认提供模型操作,但是并没有提供ORM,所以一般开发的时候我们会采用flask-SQLAlchemy模块来实现ORM操作。 SQLAlchemy是一个关系型数据库框架,它提供了高层的 ORM 和底层的原生数据库的操作。flask-sqlalchemy 是一个简化了 SQLAlchemy 操作的flask扩展。 SQLAlchemy: https://www.sqlalchemy.org/ 安装 flask-sqlalchemy pip install flask-sqlalchemy 如果连接的是 mysql 数据库,需要安装 mysqldb **驱动** pip install flask-mysqldb ### 数据库连接设置 - 在 Flask-SQLAlchemy 中,数据库使用URL指定,而且程序使用的数据库必须保存到Flask配置对象的 **SQLALCHEMY_DATABASE_URI** 键中 app.config[‘SQLALCHEMY_DATABASE_URI‘] = ‘mysql://root:mysql@127.0.0.1:3306/test‘ - 其他设置: # 动态追踪修改设置,如未设置只会提示警告 app.config[‘SQLALCHEMY_TRACK_MODIFICATIONS‘] = True #查询时会显示原始SQL语句 app.config[‘SQLALCHEMY_ECHO‘] = True - 配置完成需要去 MySQL 中创建项目所使用的数据库 $ mysql -uroot -p123456 $ create database flaskdemo charset=utf8;
### 常用的SQLAlchemy字段类型
python中类型 | 说明 | |
---|---|---|
Integer | int | 普通整数,一般是32位 |
SmallInteger | int | 取值范围小的整数,一般是16位 |
BigInteger | int或long | 不限制精度的整数 |
Float | float | 浮点数 |
Numeric | decimal.Decimal | 普通整数,一般是32位 |
String | str | 变长字符串 |
Text | str | 变长字符串,对较长或不限长度的字符串做了优化 |
Unicode | unicode | 变长Unicode字符串 |
UnicodeText | unicode | 变长Unicode字符串,对较长或不限长度的字符串做了优化 |
Boolean | bool | 布尔值 |
Date | datetime.date | 时间 |
Time | datetime.datetime | 日期和时间 |
LargeBinary | str |
### 常用的SQLAlchemy列选项
说明 | |
---|---|
primary_key | 如果为True,代表表的主键 |
unique | 如果为True,代表这列不允许出现重复的值 |
index | 如果为True,为这列创建索引,提高查询效率 |
nullable | 如果为True,允许有空值,如果为False,不允许有空值 |
default |
### 常用的SQLAlchemy关系选项
说明 | |
---|---|
backref | 在关系的另一模型中添加反向引用,用于设置外键名称,在1查多的 |
primary join | 明确指定两个模型之间使用的联结条件 |
uselist | 如果为False,不使用列表,而使用标量值 |
order_by | 指定关系中记录的排序方式 |
secondary | 指定多对多关系中关系表的名字 |
secondary join |
## 数据库基本操作 - 在Flask-SQLAlchemy中,插入、修改、删除操作,均由数据库会话管理。 - 会话用 db.session 表示。在准备把数据写入数据库前,要先将数据添加到会话中然后调用 commit() 方法提交会话。 - 在 Flask-SQLAlchemy 中,查询操作是通过 query 对象操作数据。 - 最基本的查询是返回表中所有数据,可以通过过滤器进行更精确的数据库查询。
### 常用的SQLAlchemy查询过滤器
说明 | |
---|---|
filter() | 把过滤器添加到原查询上,返回一个新查询 |
filter_by() | 把等值过滤器添加到原查询上,返回一个新查询 |
limit() | 使用指定的值限定原查询返回的结果 |
offset() | 偏移原查询返回的结果,返回一个新查询 |
order_by() | 根据指定条件对原查询结果进行排序,返回一个新查询 |
group_by() |
### 常用的SQLAlchemy查询结果的方法
说明 | |
---|---|
all() | 以列表形式返回查询的所有结果 |
first() | 返回查询的第一个结果,如果未查到,返回None |
first_or_404() | 返回查询的第一个结果,如果未查到,返回404 |
get() | 返回指定主键对应的行,如不存在,返回None |
get_or_404() | 返回指定主键对应的行,如不存在,返回404 |
count() | 返回查询结果的数量 |
paginate() |
### 创建表: db.create_all() # 注意,create_all()方法执行的时候,需要放在模型的后面### 删除表 db.drop_all() ### 插入一条数据 ro1 = Role(name=‘admin‘) db.session.add(ro1) db.session.commit() #再次插入一条数据 ro2 = Role(name=‘user‘) db.session.add(ro2) db.session.commit() ### 一次插入多条数据 us1 = User(name=‘wang‘,email=‘wang@163.com‘,password=‘123456‘,role_id=ro1.id) us2 = User(name=‘zhang‘,email=‘zhang@189.com‘,password=‘201512‘,role_id=ro2.id) us3 = User(name=‘chen‘,email=‘chen@126.com‘,password=‘987654‘,role_id=ro2.id) us4 = User(name=‘zhou‘,email=‘zhou@163.com‘,password=‘456789‘,role_id=ro1.id) us5 = User(name=‘tang‘,email=‘tang@163.com‘,password=‘158104‘,role_id=ro2.id) us6 = User(name=‘wu‘,email=‘wu@gmail.com‘,password=‘5623514‘,role_id=ro2.id) us7 = User(name=‘qian‘,email=‘qian@gmail.com‘,password=‘1543567‘,role_id=ro1.id) us8 = User(name=‘liu‘,email=‘liu@163.com‘,password=‘867322‘,role_id=ro1.id) us9 = User(name=‘li‘,email=‘li@163.com‘,password=‘4526342‘,role_id=ro2.id) us10 = User(name=‘sun‘,email=‘sun@163.com‘,password=‘235523‘,role_id=ro2.id) db.session.add_all([us1,us2,us3,us4,us5,us6,us7,us8,us9,us10]) db.session.commit() ##### filter_by精确查询 返回名字等于wang的所有人 User.query.filter_by(name=‘wang‘).all() ### first()返回查询到的第一个对象 User.query.first() ### all()返回查询到的所有对象 User.query.all() ### filter模糊查询,返回名字结尾字符为g的所有数据。 User.query.filter(User.name.endswith(‘g‘)).all() ### get():参数为主键,如果主键不存在没有返回内容 User.query.get() ### 逻辑非,返回名字不等于wang的所有数据 User.query.filter(User.name!=‘wang‘).all() ### not_ 相当于取反 from sqlalchemy import not_ User.query.filter(not_(User.name==‘chen‘)).all() ### 逻辑与,需要导入and,返回and()条件满足的所有数据from sqlalchemy import and_ User.query.filter(and_(User.name!=‘wang‘,User.email.endswith(‘163.com‘))).all() ### 逻辑或,需要导入or_ from sqlalchemy import or_ User.query.filter(or_(User.name!=‘wang‘,User.email.endswith(‘163.com‘))).all() ### 查询数据后删除 user = User.query.first() db.session.delete(user) db.session.commit() User.query.all() ### 更新数据 user = User.query.first() user.name = ‘dong‘ db.session.commit() User.query.first() ### 关联查询示例: > 角色和用户的关系是一对多的关系,一个角色可以有多个用户,一个用户只能属于一个角色。 - 查询角色的所有用户 #查询roles表id为1的角色 ro1 = Role.query.get(1) #查询该角色的所有用户 ro1.us.all() - 查询用户所属角色 #查询users表id为3的用户 us1 = User.query.get(3) #查询用户属于什么角色 us1.role
实例1:(创建表和添加数据):
#!/usr/bin/env python # -*- coding: utf-8 -*- #author tom from flask import Flask from settings.dev import DEVConfig from flask_sqlalchemy import SQLAlchemy app=Flask(__name__,template_folder=‘templates‘,static_folder=‘stactic‘) app.config.from_object(DEVConfig) #初始化SQLAlchemy db=SQLAlchemy(app) class Role(db.Model): #定义表名 __tablename__=‘roles‘ #定义表名 #定义对象 id=db.Column(db.Integer,primary_key=True) name=db.Column(db.String(64),unique=True) #设置外键[用于查询一对多额情况] us=db.relationship(‘User‘,backref=‘role‘,lazy=‘dynamic‘) #repr()方法类似于django的__str__,用于打印模型对象的字符串信息 def __repr__(self): return ‘Role:%s‘%self.name #创建数据模型必须继承db。Model class User(db.Model): #表选项 __tablename__=‘users‘ #设置表名 #声明字段 #db.Colum(字段类型,选项) id=db.Column(db.Integer,primary_key=True) name=db.Column(db.String(64),unique=True) born=db.Column(db.Date,index=True) email=db.Column(db.String(64),unique=True) password=db.Column(db.String(64)) #设置外键 role_id=db.Column(db.Integer,db.ForeignKey(‘roles.id‘)) def __repr__(self): return ‘User:%s‘%self.name @app.route(‘/‘) def index(): #数据库的基本操作 return ‘ok‘ @app.route(‘/add‘) def add(): #数据库的基本操作 ‘‘‘添加数据add()‘‘‘ role=Role(name=‘实习生‘) db.session.add(role) db.session.commit() role=Role(name=‘正式员工‘) db.session.add(role) db.session.commit() role=Role(name=‘优秀员工‘) db.session.add(role) db.session.commit() user = User(name="xiaoming", born="2018-10-01", email="qq.qq.com", password="123456", role_id=1) db.session.add(user) db.session.commit() us1 = User(name=‘wang‘, email=‘wang@163.com‘, password=‘123456‘, role_id=1) us2 = User(name=‘zhang‘, email=‘zhang@189.com‘, password=‘201512‘, role_id=3) us3 = User(name=‘chen‘, email=‘chen@126.com‘, password=‘987654‘, role_id=1) us4 = User(name=‘zhou‘, email=‘zhou@163.com‘, password=‘456789‘, role_id=3) us5 = User(name=‘tang‘, email=‘tang@163.com‘, password=‘158104‘, role_id=2) us6 = User(name=‘wu‘, email=‘wu@gmail.com‘, password=‘5623514‘, role_id=1) us7 = User(name=‘qian‘, email=‘qian@gmail.com‘, password=‘1543567‘, role_id=1) us8 = User(name=‘liu‘, email=‘liu@163.com‘, password=‘867322‘, role_id=2) us9 = User(name=‘li‘, email=‘li@163.com‘, password=‘4526342‘, role_id=3) us10 = User(name=‘sun‘, email=‘sun@163.com‘, password=‘235523‘, role_id=2) db.session.add_all([us1, us2, us3, us4, us5, us6, us7, us8, us9, us10]) db.session.commit() return "添加成功" if __name__ == ‘__main__‘: # db.create_all() #表创建成功后记得注释掉,要不然第二次运行还会创建数据库,就会报错 app.run()
dev.py
#!/usr/bin/env python # -*- coding: utf-8 -*- #author tom class DEVConfig(object): DEBUG=True SECRET_KEY=‘wocao‘ #session秘钥 # 数据库配置 # ‘数据库类型://账号:密码@数据库IP:端口/数据库名‘ SQLALCHEMY_DATABASE_URI = ‘mysql://root:123@127.0.0.1:3306/flaskdemo‘ # 动态追踪修改设置,如未设置只会提示警告 SQLALCHEMY_TRACK_MODIFICATIONS = True # 查询时会显示原始SQL语句 SQLALCHEMY_ECHO = True
第二个参数backref为类User申明新属性的方法
第三个参数lazy决定了什么时候SQLALchemy从数据库中加载数据
如果设置为子查询方式(subquery),则会在加载完Role对象后,就立即加载与其关联的对象,这样会让总查询数量减少,但如果返回的条目数量很多,就会比较慢
设置为 subquery 的话,role.users 返回所有数据列表
另外,也可以设置为动态方式(dynamic),这样关联对象会在被使用的时候再进行加载,并且在返回前进行过滤,如果返回的对象数很多,或者未来会变得很多,那最好采用这种方式
设置为 dynamic 的话,role.users 返回查询对象,并没有做真正的查询,可以利用查询对象做其他逻辑,比如:先排序再返回结果
实例2(查询数据):
#!/usr/bin/env python # -*- coding: utf-8 -*- #author tom import json from flask import Flask from sqlalchemy import or_, and_ from settings.dev import DEVConfig from flask_sqlalchemy import SQLAlchemy app=Flask(__name__,template_folder=‘templates‘,static_folder=‘stactic‘) app.config.from_object(DEVConfig) #初始化SQLAlchemy db=SQLAlchemy(app) class Role(db.Model): #定义表名 __tablename__=‘roles‘ #定义表名 #定义对象 id=db.Column(db.Integer,primary_key=True) name=db.Column(db.String(64),unique=True) #设置外键[用于查询一对多额情况] us=db.relationship(‘User‘,backref=‘role‘,lazy=‘dynamic‘) #repr()方法类似于django的__str__,用于打印模型对象的字符串信息 def __repr__(self): return ‘Role:%s‘%self.name #创建数据模型必须继承db。Model class User(db.Model): #表选项 __tablename__=‘users‘ #设置表名 #声明字段 #db.Colum(字段类型,选项) id=db.Column(db.Integer,primary_key=True) name=db.Column(db.String(64),unique=True) born=db.Column(db.Date,index=True) email=db.Column(db.String(64),unique=True) password=db.Column(db.String(64)) #设置外键 role_id=db.Column(db.Integer,db.ForeignKey(‘roles.id‘)) def __repr__(self): return ‘User:%s‘%self.name @app.route(‘/‘) def index(): #数据库的基本操作 return ‘ok‘ @app.route(‘/all‘) def all(): ‘‘‘all()‘‘‘ #查询所有数据 user_list=User.query.all() print(‘user_list‘,user_list) user_list_dict=[] for user in user_list: user_list_dict.append( { ‘id‘:user.id, ‘user‘:user.name } ) user_list_json=json.dumps(user_list_dict) return user_list_json @app.route(‘/filter_by‘) def filter(): #first获得查询的第一条数据 user=User.query.filter_by(name=‘xiaoming‘).first print(user) return ‘ok‘ @app.route(‘/get‘) def get(): ‘‘‘get根据主键查询相应的数据‘‘‘ user=User.query.get(10) print(‘===‘,user) return ‘ok‘ @app.route(‘/mycount‘) def mycount(): mycount=User.query.count() print(mycount) return str(mycount) @app.route(‘/like‘) def like(): ‘‘‘like模糊查询‘‘‘ #查询 name以字母’1‘开头的 #模型类名.query.filter(模型雷类名.ziduan .startswith,endwith(‘字符串‘.all())) user_list=User.query.filter(User.name.startswith(‘l‘)).all() print(user_list) return ‘查询成功‘ @app.route(‘/logic1‘) def logic1(): #取反 user_list=User.query.filter(User.name!=‘xiaoming‘).all() print(user_list) return ‘查询成功‘ @app.route(‘/logic2‘) def logic2(): #或者,多条件 user_list=User.query.filter(or_(User.name==‘xiaoming‘,User.name==‘li‘)).all() print(user_list) return ‘查询成功‘ @app.route(‘/logic3‘) def logic3(): user_list=User.query.filter(and_(User.role_id==1,User.id>5)).all() print(user_list) return ‘ok‘ if __name__ == ‘__main__‘: # db.create_all() #表创建成功后记得注释掉,要不然第二次运行还会创建数据库,就会报错 app.run()
实例3:更新删除数据:
#!/usr/bin/env python # -*- coding: utf-8 -*- #author tom import json from flask import Flask from sqlalchemy import or_, and_ from settings.dev import DEVConfig from flask_sqlalchemy import SQLAlchemy app=Flask(__name__,template_folder=‘templates‘,static_folder=‘stactic‘) app.config.from_object(DEVConfig) #初始化SQLAlchemy db=SQLAlchemy(app) class Role(db.Model): #定义表名 __tablename__=‘roles‘ #定义表名 #定义对象 id=db.Column(db.Integer,primary_key=True) name=db.Column(db.String(64),unique=True) #设置外键[用于查询一对多额情况] us=db.relationship(‘User‘,backref=‘role‘,lazy=‘dynamic‘) #repr()方法类似于django的__str__,用于打印模型对象的字符串信息 def __repr__(self): return ‘Role:%s‘%self.name #创建数据模型必须继承db。Model class User(db.Model): #表选项 __tablename__=‘users‘ #设置表名 #声明字段 #db.Colum(字段类型,选项) id=db.Column(db.Integer,primary_key=True) name=db.Column(db.String(64),unique=True) born=db.Column(db.Date,index=True) email=db.Column(db.String(64),unique=True) password=db.Column(db.String(64)) #设置外键 role_id=db.Column(db.Integer,db.ForeignKey(‘roles.id‘)) def __repr__(self): return ‘User:%s‘%self.name @app.route(‘/delete‘) def delete(): ‘‘‘删除数据‘‘‘ user=User.query.get(1) db.session.delete(user) db.session.commit() return ‘删除成功‘ @app.route(‘/update‘) def update(): ‘‘‘更新数据‘‘‘ user=User.query.get(2) user.born=‘2011-12-23‘ user.name=‘wangba‘ db.session.commit() return ‘修改成功‘ if __name__ == ‘__main__‘: # db.create_all() #表创建成功后记得注释掉,要不然第二次运行还会创建数据库,就会报错 app.run()
- 在开发过程中,需要修改数据库模型,而且还要在修改之后更新数据库。最直接的方式就是删除旧表,但这样会丢失数据。 - 更好的解决办法是使用数据库迁移框架,它可以追踪数据库模式的变化,然后把变动应用到数据库中。 - 在Flask中可以使用Flask-Migrate扩展,来实现数据迁移。并且集成到Flask-Script中,所有操作通过命令就能完成。 - 为了导出数据库迁移命令,Flask-Migrate提供了一个MigrateCommand类,可以附加到flask-script的manager对象上。 首先要在虚拟环境中安装Flask-Migrate。 pip install flask-migrate
代码:
#!/usr/bin/env python # -*- coding: utf-8 -*- #author tom from flask import Flask from settings.dev import DEVConfig from flask_sqlalchemy import SQLAlchemy from flask_migrate import Migrate,MigrateCommand from flask_script import Shell,Manager app=Flask(__name__,template_folder=‘templates‘,static_folder=‘stactic‘) app.config.from_object(DEVConfig) #把app注册到manager manager=Manager(app) #初始化SQLAlchemy db=SQLAlchemy(app) # 第一个参数是Flask的实例, # 第二个参数是Sqlalchemy数据库实例 migrate = Migrate(app,db) # manager是Flask-Script的实例,这条语句在flask-Script中添加一个db命令 # 参数1就是命令行调用数据迁移的命令前缀 manager.add_command(‘db‘,MigrateCommand) class Role(db.Model): #定义表名 __tablename__=‘roles‘ #定义表名 #定义对象 id=db.Column(db.Integer,primary_key=True) name=db.Column(db.String(64),unique=True) #设置外键[用于查询一对多额情况] us=db.relationship(‘User‘,backref=‘role‘,lazy=‘dynamic‘) #repr()方法类似于django的__str__,用于打印模型对象的字符串信息 def __repr__(self): return ‘Role:%s‘%self.name #创建数据模型必须继承db。Model class User(db.Model): #表选项 __tablename__=‘users‘ #设置表名 #声明字段 #db.Colum(字段类型,选项) id=db.Column(db.Integer,primary_key=True) name=db.Column(db.String(64),unique=True) born=db.Column(db.Date,index=True) email=db.Column(db.String(64),unique=True) password=db.Column(db.String(64)) #设置外键 role_id=db.Column(db.Integer,db.ForeignKey(‘roles.id‘)) def __repr__(self): return ‘User:%s‘%self.name @app.route(‘/‘) def index(): #数据库的基本操作 return ‘ok‘ if __name__ == ‘__main__‘: # db.create_all() #表创建成功后记得注释掉,要不然第二次运行还会创建数据库,就会报错 manager.run()
这样我们就可以进入到文件所在目录(这个文件名为manage.py),我们可以使用python manage.py runserver 运行文件
配置后使用步骤:
### 创建迁移仓库 #这个命令会创建migrations文件夹,所有迁移文件都放在里面。 python manage.py db init ### 创建迁移脚本 - 自动创建迁移脚本有两个函数 - upgrade():函数把迁移中的改动应用到数据库中。 - downgrade():函数则将改动删除。 - 自动创建的迁移脚本会根据模型定义和数据库当前状态的差异,生成upgrade()和downgrade()函数的内容。 - 对比不一定完全正确,有可能会遗漏一些细节,需要进行检查 python manage.py db migrate ### 更新数据库 python manage.py db upgrade ### 返回以前的版本 可以根据history命令找到版本号,然后传给downgrade命令: python manage.py db history 输出格式:<base> -> 版本号 (head), initial migration 回滚到指定版本 python manage.py db downgrade # 默认返回上一个版本 python manage.py db downgrade 版本号 # 返回到指定版本号对应的版本 数据迁移的步骤: 1. 初始化数据迁移的目录 python manage.py db init 2. 数据库的数据迁移版本初始化 python manage.py db migrate 3. 升级版本[创建表] python manage.py db upgrade 4. 降级版本[删除表] python manage.py db downgrade
原文:https://www.cnblogs.com/tjp40922/p/10680586.html