使用Flask-SQLAlchemy插件进行数据库操作

依照惯例,本文开头先提供Flask-SQLAlchemy的官方文档地址

Flask框架之所以强大有一个重要因素是良好的生态系统支持用户对原框架进行扩展,Flask-SQLAlchemy就是一个扩展插件,其作用是帮助用户操作数据库(增、删、改、查、创表、提交事务等等),或者说这是一个ORM插件(O-ObjectR-RelationalM-Mapping,简言之就是用对象去表达数据结构的插件)。显然,使用Flask-SQLAlchemy最大的好处就是操作不同的数据库时不必关注数据库特异性,一套代码重复利用。

使用Flask-SQLAlchemy

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
db = SQLAlchemy(app)

引入flask_sqlalchemy插件,调用SQLAlchemyflask app绑定

调用SQLAlchemy是因为这是flask_sqlalchemy提供的一个__init__函数,源码:

#: Default query class used by :attr:`Model.query` and other queries.
   #: Customize this by passing ``query_class`` to :func:`SQLAlchemy`.
   #: Defaults to :class:`BaseQuery`.
   Query = None

  def __init__(self, app=None, use_native_unicode=True, session_options=None,
                metadata=None, query_class=BaseQuery, model_class=Model):

       self.use_native_unicode = use_native_unicode
       self.Query = query_class
       self.session = self.create_scoped_session(session_options)
       self.Model = self.make_declarative_base(model_class, metadata)
       self._engine_lock = Lock()
       self.app = app
       _include_sqlalchemy(self, query_class)

       if app is not None:
           self.init_app(app)

PS:通过看源码应该能发现调用SQLAlchemyapp是可以不用传入的,可以初始化时再调用init_app传入app,这特别适用于工厂函数创建app的情况

使用Flask-SQLAlchemy创建表

class User(db.Model):
    __tablename__ = 'users'
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(80), unique=True, nullable=False)
    email = db.Column(db.String(120), unique=True, nullable=False)

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

核心是创建一个类继承Model属性(Model属性是啥,可以按照上面的源码去查看)
这里讲一下代码含义:

  • __tablename__ = 'users'是给表命名(这句也可以省略,但是一般表名还是推荐自己取)
  •   id = db.Column(db.Integer, primary_key=True)
      username = db.Column(db.String(80), unique=True, nullable=False)
      email = db.Column(db.String(120), unique=True, nullable=False)
    
    这部分是添加表的字段,以及相应字段的属性
  •   def __repr__(self):
          return '<User %r>' % self.username
    
    这两行是python对象的__repr__方法,重写是为了方便程序员查看对象,不属于flask-sqlalchemy提供的特殊内容

当然,这是最简单的数据表,实际操作中肯定会涉及到数据表的互相关联。这一部分实际是数据库的基础知识而不是Flask-SQLAlchemy的独特内容。简单提一下Flask-SQLAlchemy是有APIForeignKeyrelationship帮助我们创表时关联数据表的。具体内容可以查看上面的官方文档。

使用Flask-SQLAlchemy进行增、删、改、查

做数据库基本操作必然涉及到数据库事务,这里先说如何使用SQLAlchemy提交事务

db.session.add(xxx)
db.session.delete(xxx)
db.session.commit()

session API中带有adddelete等方法,直接调用即可,最后再commit。当然,如同写SQL语句一样,针对不同的操作还有更多API,例如session.add_all()session.rollback()等等,这里不详述了。

前面说了相关的API,现在总结一下增、删、改、查具体操作。

from yourapp import User
me = User('admin', 'admin@example.com')
db.session.add(me)
db.session.commit()

以添加一条记录为例,所有的执行都是遵循三个步骤

  • 创建一个python对象(这个对象是相应数据表类的一个实例,也就是相应数据表的一条记录)
  • 调用session中的API
  • 提交事务
db.session.delete(me)
db.session.commit()

删除一条记录也是类似的

admin = Role.query.filter_by(name='Admin').first()

查询表中某条记录可以直接调用对象的query方法,相当于SELECT语句

admin = Role.query.filter_by(name='Admin').first()
if admin is not None:
    admin.name = 'admin'
    db.session.add(admin)
    db.session.commit()

修改记录可以综合查找和添加两步:

  • 查出记录
  • 修改
  • 提交

至此,使用Flask-SQLALchemy进行数据库基本操作已经都介绍完了,复杂的用法请查看开头的官方文档。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,458评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,454评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,171评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,062评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,440评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,661评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,906评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,609评论 0 200
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,379评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,600评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,085评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,409评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,072评论 3 237
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,088评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,860评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,704评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,608评论 2 270