Flask-SQLAlchemy的使用

已于 2023-03-26 11:10:02 修改
阅读量1.1k 收藏 8
点赞数
文章标签： flask python 后端
于 2023-03-21 19:22:40 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_41783242/article/details/129695345
版权

SQLAlchemy 是目前python中最强大的 ORM框架, 功能全面, 使用简单。
Flask-SQLAlchemy 是 Flask 扩展之一，它封装了 SQLAlchemy 库，使得在 Flask 中与数据库交互变得更加方便。使用 Flask-SQLAlchemy 可以完成以下任务：

  1. 配置数据库连接信息：可以在 Flask 应用程序中设置数据库连接字符串（比如 MySQL 或 PostgreSQL），从而方便地与数据库建立连接。
  2. 定义模型类：通过定义类来表示数据库中的表格和表格之间的关系。模型类继承自 SQLAlchemy 提供的基类 Model。
  3. 声明关系：可以使用特殊的属性（比如 relationship、backref）来声明模型类之间的关系，比如一对多、多对一、多对多等。
  4. 数据库迁移：Flask-SQLAlchemy 可以支持数据库的迁移（migration）功能，它使用 Flask-Migrate 扩展实现，可以对数据库进行版本管理。
    使用 Flask-SQLAlchemy，我们可以快速地将 Flask 应用程序连接到数据库，并通过定义模型类来进行 CRUD 操作。具体的使用方法可以参考 Flask-SQLAlchemy 的官方文档。

ORM优点：

  1. 有语法提示, 省去自己拼写SQL，保证SQL语法的正确性
  2. orm提供方言功能(dialect, 可以转换为多种数据库的语法), 减少学习成本
  3. 防止sql注入攻击
  4. 搭配数据迁移, 更新数据库方便
  5. 面向对象, 可读性强, 开发效率高

ORM缺点：

  1. 需要语法转换, 效率比原生sql低
  2. 复杂的查询往往语法比较复杂 (可以使用原生sql替换)

一、相关配置

安装

pip install flask-sqlalchemy
# flask-sqlalchemy 在安装/使用过程中, 如果出现 ModuleNotFoundError: No module named 'MySQLdb’错误, 则表示缺少mysql依赖包, 则执行下面命令
pip install mysqlclient # 如果还是失败，再尝试pip install pymysql

MySQL数据库相关配置

在app/config.py中

"""
项目应用配置
"""
from pathlib import Path
BASE_DIR = Path(__file__).resolve().parent.parent # 项目路径
DEBUG = True # 设置调试模式
SECRET_KEY = 'key' # 设置交互用的密钥，以防跨域攻击（ CSRF ）
SQLALCHEMY_DATABASE_URI = 'mysql://user:pass@127.0.0.1:3306/db_ccblog' # 数据库路径，用于设置数据库连接地址
SQLALCHEMY_COMMIT_ON_TEARDOWN = True # 设置每次连接结束后自动提交数据库中的变动。
SQLALCHEMY_TRACK_MODIFICATIONS = True # 设置追踪数据库变化（触发钩子函数），会额外消耗内存
  1. 在项目目录（CCBlog/app）的__init__.py中引入SQLAlchemy
from flask_sqlalchemy import SQLAlchemy
# 实例化SQLAlchemy对象
db = SQLAlchemy()
  1. 在工厂函数create_app中与app绑定关系
def create_app(test_config=None):
    # ...省略代码
    # 递归创建目录，确保项目文件存在
    try:
        os.makedirs(app.instance_path)
    except OSError:
        pass

    # 绑定数据库
    db.init_app(app)

    return app
  1. 创建模型数据
    以auth的用户模型为例
    在app/models.py中创建模型如下
from app import db
from datetime import datetime

class BaseModel(db.Model):
    """ 基类模型
    """
    __abstract__ = True
    # 不过utc时间比北京时间要慢8个小时
    datetime_create = db.Column(db.DateTime, nullable=False, default=datetime.utcnow ) # 创建时间

class User(BaseModel):
    """用户模型
    """
    __tablename__ = "user" # 表名
    # 属性
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(128), unique=True, nullable=False)
    password = db.Column(db.String(320), nullable=False)
    is_admin = db.Column(db.Boolean, nullable=True, default=False) # 管理员标识

    def __repr__(self):
        return '<User %r>' % self.name
  1. 注册数据模型
    在项目目录（CCBlog/app）的__init__.py中引入模型
from app.auth import models

扩展内容，不建议采用此方式
5. 连接并同步字段
做完以上步骤，就已经可以连接到数据库了
但是字段此时还并没有同步到数据库，同步字段到数据库

# 方法是在app所在的目录下进入Flask的shell环境，运行以下两个命令即可：
from app import db
db.create_all() # 创建所有表
db.drop_all() # 删除所有表

# 在powershell终端， 运行如下命令，即可进入shell环境
# FLASK_ENV 变量用于指定 Flask 应用程序的运行环境，例如开发环境、测试环境或生产环境。当设置为 "development" 时，Flask 将启用调试模式和自动重新加载，这使得开发应用程序更加容易。
> $env:FLASK_APP = "app"
> $env:FLASK_ENV = "development" # 
> flask shell

二、ORM模型的创建与调整

1、示例

from app import db
class User(db.Model): # 必须继承db.Model
    """用户模型
    """
    __tablename__ = "user" # 表名
    # 字段, 由创造db.Column()
    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
    name = db.Column(db.String(128), unique=True, nullable=False)
    password = db.Column(db.String(320), nullable=False)
    is_admin = db.Column(db.Boolean, nullable=True, default=False)
    datetime_create = db.Column(db.DateTime, nullable=False, default=datetime.utcnow )

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

2、常用字段类型以及字段选项

  • 字段类型
类型名生成的mysql类型生成的python类型说明
Integerintint整型
Floatfloatfloat浮点型
Booleantinyintbool整型，占1字节
Texttextstr文本类型，最大64KB
Long Textlongtextstr文本类型，最大4GB
Stringvarcharstr变长字符串，必须限定长度
Datedatedatetime.date日期
Date Timedatetimedatetime日期和时间
Timetimedatetime.time时间
  • 字段选项
选项名说明
primary_key若为true，则字段为主键，默认自增
unique若为true，则字段设置唯一约束
nullable若为true，则字段允许为空
default设置字段默认值
index若为true，创建索引
autoincrement若为true，设置字段自增

3、外键

# 用db.ForeignKey设置外键关系
id_user = db.Column(db.Integer, db.ForeignKey('user.id', ondelete='CASCADE', onupdate='CASCADE'), nullable=False)

4、多对多关系帮助器表

# 收藏表，帮助器表
star = db.Table('star',
    db.Column('id_user', db.Integer, db.ForeignKey('user.id', ondelete='CASCADE', onupdate='CASCADE'), primary_key=True),
    db.Column('id_blog', db.Integer, db.ForeignKey('blog.id', ondelete='CASCADE', onupdate='CASCADE'), primary_key=True)
)
# 对帮助器表的增删查改要利用的关系引用，在ORM模型的使用中会说明

三、ORM模型的使用

# 原生sql语句操作
sql = 'select * from user'
result = db.session.execute(sql)

1、类创建的表（增删查改操作）

  1. 增添记录
# 1.创建模型对象
user = User(id, username, password)
# 2.将模型对象添加到会话中 
db.session.add(user)
# 一次性添加多条记录：db.session.add_all([user1, user2, user3])
# 3.提交会话 (会提交事务)
db.session.commit()
# 扩展说明
# db.session.flush() # 主动执行flush操作, 立即执行SQL操作(数据库同步)
# User.query.count()  # 查询操作会自动执行flush操作
# db.session.commit()  # 提交会话会自动执行flush操作
  1. 删除记录
# 方法1
User.query.filter_by(User.username='name').delete()
# 方法2
# db.session.delete(user)
# 两个方法均需提交会话
db.session.commit()
  1. 修改记录
# 方法1
User.query.filter_by(User.username='name').update({'password':'newdata'})
# 方法2
# user.password = 'newdata'
# 两个方法均需提交会话
db.session.commit()
  1. 查询记录
User.query.all() # 查询所有用户数据，返回列表, 元素为模型对象
User.query.count() # 获取查询所得的记录数
User.query.first() # 获取查询所得的第一条记录
# 查询id为userid的用户[3种方式]
# 方式1: 根据id查询  返回模型对象/None
User.query.get(userid)  
# 方式2: 等值过滤器 关键字实参设置字段值  返回BaseQuery对象
# BaseQuery对象可以续接其他过滤器/执行器  如 all/count/first等
User.query.filter_by(id=userid).all()  
# 方式3: 复杂过滤器  参数为比较运算/函数引用等  返回BaseQuery对象
User.query.filter(User.id == userid).first()  
# 查询名字结尾字符为g的所有用户[开始 / 包含]
User.query.filter(User.name.endswith("g")).all()
User.query.filter(User.name.startswith("w")).all()
User.query.filter(User.name.contains("n")).all()
User.query.filter(User.name.like("w%n%g")).all()  # 模糊查询

from sqlalchemy import and_, or_, not_, in_
# 查询名字和邮箱都以li开头的所有用户[2种方式]
User.query.filter(User.name.startswith('li'), User.email.startswith('li')).all()
User.query.filter(and_(User.name.startswith('li'), User.email.startswith('li'))).all()

# 查询age是25 或者 `email`以`itheima.com`结尾的所有用户
User.query.filter(or_(User.age==25, User.email.endswith("itheima.com"))).all()

# 查询名字不等于wang的所有用户[2种方式]
User.query.filter(not_(User.name == 'wang')).all()
User.query.filter(User.name != 'wang').all()

# 查询id为[1, 3, 5, 7, 9]的用户
User.query.filter(User.id.in_([1, 3, 5, 7, 9])).all()

# 所有用户先按年龄从小到大, 再按id从大到小排序, 取前5个
User.query.order_by(User.age, User.id.desc()).limit(5).all()

# 查询年龄从小到大第2-5位的数据   2 3 4 5
User.query.order_by(User.age).offset(1).limit(4).all()

# 分页查询, 每页10个, 查询第2页的数据  paginate(页码, 每页条数)
pn = User.query.paginate(page=2, per_page=10, error_out=False)
# pn.pages 总页数  pn.page 当前页码 pn.items 当前页的数据  pn.total 总条数

# 比较查询
User.query.filter(User.id.__lt__(5)) # 小于5
User.query.filter(User.id.__le__(5)) # 小于等于5
User.query.filter(User.id.__gt__(5)) # 大于5
User.query.filter(User.id.__ge__(5)) # 大于等于5

# ......

2、帮助器表创建的表（增删查改操作）

# 收藏表，帮助器表
star = db.Table('star',
    db.Column('id_user', db.Integer, db.ForeignKey('user.id', ondelete='CASCADE', onupdate='CASCADE'), primary_key=True),
    db.Column('id_blog', db.Integer, db.ForeignKey('blog.id', ondelete='CASCADE', onupdate='CASCADE'), primary_key=True)
)
class User(db.Model): 
    """用户模型
    """
    __tablename__ = "user" # 表名
    # 字段
    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
    name = db.Column(db.String(128), unique=True, nullable=False)
    password = db.Column(db.String(320), nullable=False)
    is_admin = db.Column(db.Boolean, nullable=True, default=False)
    datetime_create = db.Column(db.DateTime, nullable=False, default=datetime.utcnow )
    # 关系引用：正向引用与反向引用
    # 一对多关系
    blogs = db.relationship('Blog', backref=db.backref('blog_user'), lazy=True)
    # 多对多关系引用
    stars = db.relationship('Blog', secondary=star, backref=db.backref('star_user'), lazy='select')

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

class Blog(db.Model):
    """博客模型
    """
    __tablename__ = "blog"
    # 字段
    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
    title = db.Column(db.String(128), nullable=False)
    intro = db.Column(db.String(200), nullable=True)
    # 外键
    id_user = db.Column(db.Integer, db.ForeignKey('user.id', ondelete='CASCADE', onupdate='CASCADE'), nullable=False)
    # 关系引用：正向引用与反向引用
    # 一对一关系引用
    author = db.relationship("User", backref=db.backref('user_blog'), viewonly=True)

    def __repr__(self):
        return f'<Blog {self.title}>'

# 扩展
# 当同一个表有多个外键时，建立关系引用需设置foreign_keys
# messages = db.relationship('Message', backref=db.backref('message_user'), lazy='select', foreign_keys='[Message.id_receive]')
# 当多个外键指向同一表下同一字段时，建立关系引用需设置primaryjoin、secondaryjoin
# follows = db.relationship('User', secondary=follow, backref=db.backref('follow_user'), lazy='select', primaryjoin = (follow.c.id_user == id),secondaryjoin = (follow.c.id_other_user == id))
# 当建立关系引用，报出指向不清时，可考虑设置viewonly
# blogs = db.relationship('Blog', secondary=blogtag, backref=db.backref('blog_tag'), lazy='select',viewonly=True)
  1. 增添记录
# 方法1（仅在定义了关系引用时可用）
# user = User()
# blog = Blog()
user.blogs.append(blog)
db.session.add(user)
db.session.commit()
# 方法2（利用SQL语句）
# 1.定义SQL语句
sql = """
INSERT INTO star (id_user, id_blog)
VALUES (:id_user1, :id_blog1), (:id_user1, :id_blog2)
"""
# 2.执行SQL语句，传递参数
db.session.execute(sql, {
    'id_user1': 1,
    'id_blog1': 1,
    'id_blog2': 2
})
# 提交更改到数据库
db.session.commit()
  1. 删除记录
user.stars.remove(blog)
db.session.commit()
  1. 查询记录
# 查询指定用户收藏的所有博客
user_stars = user.stars
for blog in user_stars:
    print(blog.title)

# 查询指定博客被哪些用户收藏
blog_stars = blog.star_user
for user in blog_stars:
    print(user.name)

# 在查询条件中使用 in 时，需要使用 Blog.tags.any()
# 获取携带了该标签的项目
    pagination = Blog.query.filter(
        Blog.is_release==True,
        Blog.tags.any(Tag.id == tag.id)
    ).paginate(page=page, per_page=4, error_out=False)

四、参考资料

flask-sqlalchemy官方文档
flask插件系列之SQLAlchemy基础使用
Flask-SQLAlchemy详解
Flask-SQLAlchemy
ChatGPT

L路人乙L
关注
  • 0
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Flask-SQLAlchemy使用
shifengboy的博客
03-06 325
Flask-SQLAlchemy 使用起来非常有趣，对于基本应用十分容易使用，并且对于大型项目易于扩展。 官方文档：https://flask-sqlalchemy.palletsprojects.com/en/2.x/ 中文文档：http://www.pythondoc.com/flask-sqlalchemy/ 安装 pip install flask-sqlalchemy 配置 配置选项 说明 SQLALCHEMY_DATABASE_URI 连接数据库。示例：mysql://user
Flask-SQLAlchemy
Bob欧巴のblog
06-01 209
1.数据库 1. Flask-SQLAlchemy管理数据库 Flask-SQLAlchemy 是一个 Flask 扩展，简化了在 Flask 程序中使用 SQLAlchemy 的操作。 数据库1.png 在这些 URL 中，hostname 表示 MySQL 服务所在的主机，可以是本地主机（localhost），也可以是远程服务器。数据库服务...
flask SqlAachemy 模糊查询
qq_48082548的博客
01-19 3369
语法: 导包: from sqlalchemy import or_ objs = 模型类.query.filter(模型类.列名.like('%{keyword}%'.format(keyword=keyword))).all() #区分大小写 objs = 模型类.query.filter(模型类.列名.ilike('%{keyword}%'.format(keyword=keyword))).all() #不区分大小写 实例 @account_blue.route("/index") def
flask sqlalchemy基本操作(查询)
tangsiqi130的博客
07-12 1665
Flask sqlalchemy基本操作(查询)
sqlalchemy常用查询
qq_30359369的博客
11-17 1226
一.创建连接 创建连接,获取会话 from sqlalchemy import create_engine from sqlalchemy.orm import sessionmaker # 测试时临时session def getTempSession(): engine = create_engine('postgresql://postgres:password@127.0.0.1:5432/tablename') # 创建DBSession类型: DBSession =
SQLAlchemy的查询过滤filter_by和filter
book_dw5189的博客
03-29 1634
filter_by适用于简单的等值匹配，而filter则更适用于复杂的条件查询
SQLAlchemy 的基本使用（模糊查询 与 数据去重）
lilygg的博客
04-21 5816
参考链接：https://www.cnblogs.com/kaerxifa/p/13476317.html 1.模糊查询 原生sql写法： SELECT * FROM 表名 WHERE 字段名 LIKE '%匹配内容%' ; 利用sqlalchemy实现模糊查询： center_filter = db.query(BudgetOrganizational).filter( BudgetOrganizational.center_name.like('%'+ center_name +'%')
基于Flask的RESTful API实战代码：集成Flask-SQLAlchemy与MySQL
03-25
项目概述：本项目是一个基于Python语言的实战项目，使用了Flask框架构建RESTful ...简单描述：本项目是使用Flask RESTful扩展和Flask-SQLAlchemy进行数据库管理的实践案例，旨在通过MySQL提供可靠的数据存储解决方案。
Flask-SQLAlchemy-2.3.2.tar.gz
12-21
通过创建一个`SQLAlchemy`实例并将其绑定到Flask应用上，我们可以定义模型类来映射数据库表，并使用ORM方法进行数据操作。例如： ```python from flask import Flask from flask_sqlalchemy import SQLAlchemy app...
Api-flask-graphene-sqlalchemy.zip
09-18
Api-flask-graphene-sqlalchemy.zip,在pythonremark中构建graphql api的项目模板：,一个api可以被认为是多个软件设备之间通信的指导手册。例如，api可用于web应用程序之间的数据库通信。通过提取实现并将数据放弃到...
flask-rest-api-example:如何通过flask-sqlalchemy和JWT身份验证使用Flask Rest API的示例
05-08
flask-rest-api-example 如何通过flask-sqlalchemy和JWT身份验证使用Flask Rest API的示例 高要求：pip install requirements.txt 在my_app / init .py中更改数据库名称 运行python run.py
Flask-SQLAlchemy-Example:使用 Flask 和 SqlAlchemy 的示例货物管理网页
05-30
在本项目中，"Flask-SQLAlchemy-Example" 是一个使用 Flask 框架和 SQLAlchemy ORM（对象关系映射）构建的货物管理系统的实例。Flask 是一个轻量级的 Python Web 开发框架，而 SQLAlchemy 则是 Python 中流行的...
Flask-Sqlalchemy的基本使用
一夜奈何梁山
02-16 3575
目录一： 基本使用：1：环境的安装：2：组件初始化：2.1： 基本的配置2.2：结合工厂方法进行配置：3：构建模型类：二：数据操作：1:增加数据：2：查询数据：三：高级机制： 一： 基本使用： 1：环境的安装： pip install flask-sqlalchemy pip install pymysql 2：组件初始化： 2.1： 基本的配置 1: 首先先安装两个依赖的包。 2：配置数据库的连接：app.config[‘SQLALCHEMY_DATABASE_URI’] = “mysql://roo
Flask之SQLAlchemy的基本使用
积跬步，至千里。
05-31 2120
SQLAlchemy是一个流行的Python ORM对象关系映射框架。Flask-SQLAlchemy是一个用于在Flask应用程序中使用SQLAlchemy进行数据库访问的扩展库。
flask对数据库操作命令的增删改查，模糊查询，聚合函数等等
lizhenqi123456的博客
06-24 1575
flask对数据库操作命令的增删改查，模糊查询，聚合函数等等
sqlalchemy文档--查询-定义表
ZHH_Love123的博客
03-08 710
一、添加对象 1、ed_user = User(name='ed', fullname='Ed Jones', password='edspassword') session.add(ed_user) session.commit() 2、回滚 session.rollback() 二、查询 1、查询 query.filter(User.name == 'ed') #equals query.filter(User.name != 'ed') #not equals query.filte
python SQLAlchemy数据库操作
有勇气的牛排博客
04-18 1669
偏移量 -> 3 表示从第4条开始。查询发表过文章的 用户信息+文章信息。查询所有用户 写的文章阅读量。Customer为表名。
Flask Python:模糊查询filter和filter_by，数据库多条件查询
最新发布
snow_love_xia的博客
04-03 1975
Flask Python:模糊查询filter和filter_by，数据库多条件查询
Flask-SQLAlchemy 使用mysql全文检索
05-26
Flask-SQLAlchemy 是一个用于在 Flask 中使用 SQLAlchemy 的工具，而 MySQL 全文检索则是 MySQL 数据库提供的一种用于进行全文搜索的技术。要在 Flask-SQLAlchemy 中使用 MySQL 全文检索，需要进行以下步骤： 1. 确保 MySQL 数据库版本大于或等于 5.6，并且已经启用了全文检索功能。 2. 在 Flask-SQLAlchemy 中定义需要进行全文检索的模型，并将其中需要进行全文检索的字段定义为 Text 类型。 例如，定义一个名为 `Article` 的模型，并将其中的 `content` 字段定义为 Text 类型： ```python from flask_sqlalchemy import SQLAlchemy db = SQLAlchemy() class Article(db.Model): id = db.Column(db.Integer, primary_key=True) title = db.Column(db.String(128)) content = db.Column(db.Text) ``` 3. 创建全文索引。可以使用 SQLAlchemy 提供的 `text` 函数创建全文索引，也可以使用 MySQL 的原生语句创建全文索引。 使用 SQLAlchemy 的 `text` 函数创建全文索引的示例代码如下： ```python from sqlalchemy import text class Article(db.Model): __tablename__ = 'article' id = db.Column(db.Integer, primary_key=True) title = db.Column(db.String(128)) content = db.Column(db.Text) __table_args__ = ( text('FULLTEXT idx_content (content)'), ) ``` 以上代码创建了一个名为 `idx_content` 的全文索引，该索引包含了 `content` 字段。 4. 使用全文检索进行搜索。可以使用 SQLAlchemy 提供的 `match` 函数进行全文检索，也可以使用 MySQL 的原生语句进行全文检索。 使用 SQLAlchemy 的 `match` 函数进行全文检索的示例代码如下： ```python from sqlalchemy import func articles = Article.query.filter(func.match(Article.content, 'search keyword')).all() ``` 以上代码将返回一个包含了符合搜索关键字的所有文章的列表。 使用 MySQL 的原生语句进行全文检索的示例代码如下： ```python articles = db.session.execute("SELECT * FROM article WHERE MATCH (content) AGAINST ('search keyword' IN NATURAL LANGUAGE MODE)").fetchall() ``` 以上代码使用 MySQL 的 `MATCH` 和 `AGAINST` 关键字进行全文检索，并返回一个包含了符合搜索关键字的所有文章的列表。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值