Flask中常見的資料庫定義和資料庫遷移
from datetime import datetime
from werkzeug.security import generate_password_hash, check_password_hash
from info import constants
from . import db
class BaseModel(object):
"""模型基類，為每個模型補充建立時間與更新時間"""
create_time = db.Column(db.DateTime, default=datetime.now) # 記錄的建立時間
update_time = db.Column(db.DateTime, default=datetime.now, onupdate=datetime.now) # 記錄的更新時間
# 使用者收藏表，建立使用者與其收藏新聞多對多的關係
tb_user_collection = db.Table(
"info_user_collection",
db.Column("user_id", db.Integer, db.ForeignKey("info_user.id"), primary_key=True), # 新聞編號
db.Column("news_id", db.Integer, db.ForeignKey("info_news.id"), primary_key=True), # 分類編號
db.Column("create_time", db.DateTime, default=datetime.now) # 收藏建立時間
)
tb_user_follows = db.Table(
"info_user_fans",
db.Column('follower_id', db.Integer, db.ForeignKey('info_user.id'), primary_key=True), # 粉絲id
db.Column('followed_id', db.Integer, db.ForeignKey('info_user.id'), primary_key=True) # 被關注人的id
)
class User(BaseModel, db.Model):
"""使用者"""
__tablename__ = "info_user"
id = db.Column(db.Integer, primary_key=True) # 使用者編號
nick_name = db.Column(db.String(32), unique=True, nullable=False) # 使用者暱稱
password_hash = db.Column(db.String(128), nullable=False) # 加密的密碼
mobile = db.Column(db.String(11), unique=True, nullable=False) # 手機號
avatar_url = db.Column(db.String(256)) # 使用者頭像路徑
last_login = db.Column(db.DateTime, default=datetime.now) # 最後一次登入時間
is_admin = db.Column(db.Boolean, default=False)
signature = db.Column(db.String(512)) # 使用者簽名
gender = db.Column( # 訂單的狀態
db.Enum(
"MAN", # 男
"WOMAN" # 女
),
default="MAN")
# 當前使用者收藏的所有新聞
collection_news = db.relationship("News", secondary=tb_user_collection, lazy="dynamic") # 使用者收藏的新聞
# 使用者所有的粉絲，添加了反向引用followed，代表使用者都關注了哪些人
followers = db.relationship('User',
secondary=tb_user_follows,
primaryjoin=id == tb_user_follows.c.followed_id,
secondaryjoin=id == tb_user_follows.c.follower_id,
backref=db.backref('followed', lazy='dynamic'),
lazy='dynamic')
# 當前使用者所釋出的新聞
news_list = db.relationship('News', backref='user', lazy='dynamic')
@property
def password(self):
raise AttributeError("當前屬性不可讀")
@password.setter
def password(self, value):
self.password_hash = generate_password_hash(value)
def check_passowrd(self, password):
return check_password_hash(self.password_hash, password)
def to_dict(self):
resp_dict = {
"id": self.id,
"nick_name": self.nick_name,
"avatar_url": constants.QINIU_DOMIN_PREFIX + self.avatar_url if self.avatar_url else "",
"mobile": self.mobile,
"gender": self.gender if self.gender else "MAN",
"signature": self.signature if self.signature else "",
"followers_count": self.followers.count(),
"news_count": self.news_list.count()
}
return resp_dict
def to_admin_dict(self):
resp_dict = {
"id": self.id,
"nick_name": self.nick_name,
"mobile": self.mobile,
"register": self.create_time.strftime("%Y-%m-%d %H:%M:%S"),
"last_login": self.last_login.strftime("%Y-%m-%d %H:%M:%S"),
}
return resp_dict
class News(BaseModel, db.Model):
"""新聞"""
__tablename__ = "info_news"
id = db.Column(db.Integer, primary_key=True) # 新聞編號
title = db.Column(db.String(256), nullable=False) # 新聞標題
source = db.Column(db.String(64), nullable=False) # 新聞來源
digest = db.Column(db.String(512), nullable=False) # 新聞摘要
content = db.Column(db.Text, nullable=False) # 新聞內容
clicks = db.Column(db.Integer, default=0) # 瀏覽量
index_image_url = db.Column(db.String(256)) # 新聞列表圖片路徑
category_id = db.Column(db.Integer, db.ForeignKey("info_category.id"))
user_id = db.Column(db.Integer, db.ForeignKey("info_user.id")) # 當前新聞的作者id
status = db.Column(db.Integer, default=0) # 當前新聞狀態 如果為0代表稽核通過，1代表稽核中，-1代表稽核不通過
reason = db.Column(db.String(256)) # 未通過原因，status = -1 的時候使用
# 當前新聞的所有評論
comments = db.relationship("Comment", lazy="dynamic")
def to_review_dict(self):
resp_dict = {
"id": self.id,
"title": self.title,
"create_time": self.create_time.strftime("%Y-%m-%d %H:%M:%S"),
"status": self.status,
"reason": self.reason if self.reason else ""
}
return resp_dict
def to_basic_dict(self):
resp_dict = {
"id": self.id,
"title": self.title,
"source": self.source,
"digest": self.digest,
"create_time": self.create_time.strftime("%Y-%m-%d %H:%M:%S"),
"index_image_url": self.index_image_url,
"clicks": self.clicks,
}
return resp_dict
def to_dict(self):
resp_dict = {
"id": self.id,
"title": self.title,
"source": self.source,
"digest": self.digest,
"create_time": self.create_time.strftime("%Y-%m-%d %H:%M:%S"),
"content": self.content,
"comments_count": self.comments.count(),
"clicks": self.clicks,
"category": self.category.to_dict(),
"index_image_url": self.index_image_url,
"author": self.user.to_dict() if self.user else None
}
return resp_dict
class Comment(BaseModel, db.Model):
"""評論"""
__tablename__ = "info_comment"
id = db.Column(db.Integer, primary_key=True) # 評論編號
user_id = db.Column(db.Integer, db.ForeignKey("info_user.id"), nullable=False) # 使用者id
news_id = db.Column(db.Integer, db.ForeignKey("info_news.id"), nullable=False) # 新聞id
content = db.Column(db.Text, nullable=False) # 評論內容
parent_id = db.Column(db.Integer, db.ForeignKey("info_comment.id")) # 父評論id
parent = db.relationship("Comment", remote_side=[id]) # 自關聯
like_count = db.Column(db.Integer, default=0) # 點贊條數
def to_dict(self):
resp_dict = {
"id": self.id,
"create_time": self.create_time.strftime("%Y-%m-%d %H:%M:%S"),
"content": self.content,
"parent": self.parent.to_dict() if self.parent else None,
"user": User.query.get(self.user_id).to_dict(),
"news_id": self.news_id,
"like_count": self.like_count
}
return resp_dict
class CommentLike(BaseModel, db.Model):
"""評論點贊"""
__tablename__ = "info_comment_like"
comment_id = db.Column("comment_id", db.Integer, db.ForeignKey("info_comment.id"), primary_key=True) # 評論編號
user_id = db.Column("user_id", db.Integer, db.ForeignKey("info_user.id"), primary_key=True) # 使用者編號
class Category(BaseModel, db.Model):
"""新聞分類"""
__tablename__ = "info_category"
id = db.Column(db.Integer, primary_key=True) # 分類編號
name = db.Column(db.String(64), nullable=False) # 分類名
news_list = db.relationship('News', backref='category', lazy='dynamic')
def to_dict(self):
resp_dict = {
"id": self.id,
"name": self.name
}
return resp_dict
####################################
資料庫基本操作
在Flask-SQLAlchemy中，插入、修改、刪除操作，均由資料庫會話管理。
會話用 db.session 表示。在準備把資料寫入資料庫前，要先將資料新增到會話中然後呼叫 commit() 方法提交會話。
在 Flask-SQLAlchemy 中，查詢操作是通過 query 物件操作資料。
最基本的查詢是返回表中所有資料，可以通過過濾器進行更精確的資料庫查詢。
在檢視函式中定義模型類
from flask import Flaskfrom flask_sqlalchemy import SQLAlchemy app = Flask(__name__)#設定連線資料庫的URLapp.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://root:[email protected]:3306/test'app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = True#查詢時會顯示原始SQL語句app.config['SQLALCHEMY_ECHO'] = Truedb = 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') #repr()方法顯示一個可讀字串 def __repr__(self): return 'Role:%s'% self.nameclass User(db.Model): __tablename__ = 'users' id = db.Column(db.Integer, primary_key=True) name = db.Column(db.String(64), unique=True, 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.nameif __name__ == '__main__': app.run(debug=True)
模型之前的關聯
一對多
class Role(db.Model):
... #關鍵程式碼
us = db.relationship('User', backref='role', lazy='dynamic')
...class User(db.Model):
...
role_id = db.Column(db.Integer, db.ForeignKey('roles.id'))
其中realtionship描述了Role和User的關係。在此文中，第一個引數為對應參照的類"User"
第二個引數backref為類User申明新屬性的方法
第三個引數lazy決定了什麼時候SQLALchemy從資料庫中載入資料
設定為 dynamic 的話，role.users 返回查詢物件，並沒有做真正的查詢，可以利用查詢物件做其他邏輯，比如：先排序再返回結果
設定為 subquery 的話，role.users 返回所有資料列表
如果設定為子查詢方式(subquery)，則會在載入完Role物件後，就立即載入與其關聯的物件，這樣會讓總查詢數量減少，但如果返回的條目數量很多，就會比較慢
另外,也可以設定為動態方式(dynamic)，這樣關聯物件會在被使用的時候再進行載入，並且在返回前進行過濾，如果返回的物件數很多，或者未來會變得很多，那最好採用這種方式
常用的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() | 返回一個Paginate物件，它包含指定範圍內的結果 |
建立表：
db.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='[email protected]',password='123456',role_id=ro1.id) us2 = User(name='zhang',email='[email protected]',password='201512',role_id=ro2.id) us3 = User(name='chen',email='[email protected]',password='987654',role_id=ro2.id) us4 = User(name='zhou',email='[email protected]',password='456789',role_id=ro1.id) us5 = User(name='tang',email='[email protected]',password='158104',role_id=ro2.id) us6 = User(name='wu',email='[email protected]',password='5623514',role_id=ro2.id) us7 = User(name='qian',email='[email protected]',password='1543567',role_id=ro1.id) us8 = User(name='liu',email='[email protected]',password='867322',role_id=ro1.id) us9 = User(name='li',email='[email protected]',password='4526342',role_id=ro2.id) us10 = User(name='sun',email='[email protected]',password='235523',role_id=ro2.id) db.session.add_all([us1,us2,us3,us4,us5,us6,us7,us8,us9,us10]) db.session.commit()""" 查詢所有使用者資料 查詢有多少個使用者 查詢第1個使用者 查詢id為4的使用者[3種方式] 查詢名字結尾字元為g的所有資料[開始/包含] 查詢名字不等於wang的所有資料[2種方式] 查詢名字和郵箱都以 li 開頭的所有資料[2種方式] 查詢password是 `123456` 或者 `email` 以 `itheima.com` 結尾的所有資料 查詢id為 [1, 3, 5, 7, 9] 的使用者列表 查詢name為liu的角色資料 查詢所有使用者資料，並以郵箱排序 每頁3個，查詢第2頁的資料 """
查詢: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
################################################
資料庫遷移
在開發過程中，需要修改資料庫模型，而且還要在修改之後更新資料庫。最直接的方式就是刪除舊錶，但這樣會丟失資料。
更好的解決辦法是使用資料庫遷移框架，它可以追蹤資料庫模式的變化，然後把變動應用到資料庫中。
在Flask中可以使用Flask-Migrate擴充套件，來實現資料遷移。並且整合到Flask-Script中，所有操作通過命令就能完成。
為了匯出資料庫遷移命令，Flask-Migrate提供了一個MigrateCommand類，可以附加到flask-script的manager物件上。
首先要在虛擬環境中安裝Flask-Migrate。
pip install flask-migrate
程式碼檔案內容：
#coding=utf-8from flask import Flaskfrom flask_sqlalchemy import SQLAlchemyfrom flask_migrate import Migrate,MigrateCommandfrom flask_script import Shell,Manager app = Flask(__name__) manager = Manager(app) app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://root:[email protected]:3306/Flask_test'app.config['SQLALCHEMY_COMMIT_ON_TEARDOWN'] = Trueapp.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = Truedb = SQLAlchemy(app)#第一個引數是Flask的例項，第二個引數是Sqlalchemy資料庫例項migrate = Migrate(app,db) #manager是Flask-Script的例項，這條語句在flask-Script中新增一個db命令manager.add_command('db',MigrateCommand)#定義模型Roleclass Role(db.Model): # 定義表名 __tablename__ = 'roles' # 定義列物件 id = db.Column(db.Integer, primary_key=True) name = db.Column(db.String(64), unique=True) user = db.relationship('User', backref='role') #repr()方法顯示一個可讀字串， def __repr__(self): return 'Role:'.format(self.name)#定義使用者class User(db.Model): __talbe__ = 'users' id = db.Column(db.Integer, primary_key=True) username = db.Column(db.String(64), unique=True, index=True) #設定外來鍵 role_id = db.Column(db.Integer, db.ForeignKey('roles.id')) def __repr__(self): return 'User:'.format(self.username)if __name__ == '__main__': manager.run()
建立遷移倉庫
#這個命令會建立migrations資料夾，所有遷移檔案都放在裡面。 python database.py