前言
Flask-SQLAlchemy 是 Flask 框架的一个扩展,它简化了与数据库的交互。使用 Flask-SQLAlchemy,您可以轻松地定义数据库模型和字段,从而有效地管理应用程序的数据层。本文将详细介绍如何使用 Flask-SQLAlchemy 新建模型和字段。
安装 Flask-SQLAlchemy
在开始之前,确保您已经安装了 Flask 和 Flask-SQLAlchemy。可以使用以下命令安装它们:
pip install Flask Flask-SQLAlchemy
初始化 Flask 应用和 SQLAlchemy
首先,创建一个 Flask 应用并初始化 SQLAlchemy:
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///test.db' # 使用 SQLite 数据库
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
db = SQLAlchemy(app)
创建数据库模型
在 Flask-SQLAlchemy 中,数据库模型是 Python 类,每个类映射到数据库中的一张表。以下是一个示例模型定义:
class User(db.Model):
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 f'<User {self.username}>'
在这个示例中,我们定义了一个名为 User
的模型,该模型有三个字段:id
、username
和 email
。每个字段都使用 db.Column
定义,其中:
db.Integer
表示整数类型db.String
表示字符串类型primary_key=True
表示主键unique=True
表示字段值唯一nullable=False
表示字段不允许为空
创建和修改数据库
在定义好模型后,需要将其应用到数据库中。可以通过以下命令创建数据库和表:
with app.app_context():
db.create_all()
这将创建一个名为 test.db
的 SQLite
数据库,并在其中创建 User
表。
添加更多字段
可以随时向现有模型添加更多字段。例如,向 User
模型添加一个created_at
字段以记录用户创建时间:
from datetime import datetime
class User(db.Model):
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)
created_at = db.Column(db.DateTime, default=datetime.utcnow) # 默认当前时间
def __repr__(self):
return f'<User {self.username}>'
在添加新字段后,需要使用迁移工具(如 Flask-Migrate)来应用更改,而不是直接使用 db.create_all()
,因为 db.create_all()
只会创建表,不会修改现有表的结构。
使用模型
定义模型后,可以使用它们来进行数据库操作,例如添加、查询、更新和删除记录:
# 添加新用户
new_user = User(username='john_doe', email='john@example.com')
db.session.add(new_user)
db.session.commit()
# 查询用户
user = User.query.filter_by(username='john_doe').first()
print(user)
# 更新用户
user.email = 'john.doe@example.com'
db.session.commit()
# 删除用户
db.session.delete(user)
db.session.commit()
总结
通过本文,您已经了解了如何使用 Flask-SQLAlchemy 创建模型和字段,并进行了基本的数据库操作。Flask-SQLAlchemy 提供了一个简单而强大的工具集,使您能够轻松地管理 Flask 应用程序中的数据库。