FastAPI数据库系列(一) MySQL数据库操作 一、简介

本文涉及的产品
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
RDS MySQL Serverless 高可用系列,价值2615元额度,1个月
云数据库 RDS MySQL,高可用系列 2核4GB
简介: FastAPI中你可以使用任何关系型数据库,可以通过SQLAlchemy将其轻松的适应于任何的数据库,比如:PostgreSQLMySQLSQLiteOracleMicrosoft SQL Server...

一、简介
FastAPI中你可以使用任何关系型数据库,可以通过SQLAlchemy将其轻松的适应于任何的数据库,比如:

PostgreSQL
MySQL
SQLite
Oracle
Microsoft SQL Server
...
  SQLAlchemy是一个ORM(object-relational mapping)的框架。在ORM中,你创建一个类就会通过SQLAlchemy将其自动转成一张表,在类中的每一个属性就会将其转成表中的字段。

这里有一些实例,假如有一个大的项目,里面包含一个子包叫做sql_app:

复制代码
.
└── sql_app

├── __init__.py
├── crud.py
├── database.py
├── main.py
├── models.py
└── schemas.py

复制代码
__init__.py 是一个空文件,但是说明sql_app是一个package
database.py 数据库配置相关
models.py 数据库模型表
schemas.py 模型验证
crud.py 数据库操作相关
main.py 主文件
二、简单实例
该实例以MySQL为例,SQLAlchemy需要借助于pymysql连接数据库,所以需要进行安装这两个工具包:

pip install sqlalchemy
pip install pymysql
1、database.py
复制代码
from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

SQLALCHEMY_DATABASE_URL = "mysql+pymysql://root:123456@127.0.0.1:3306/test"

echo=True表示引擎将用repr()函数记录所有语句及其参数列表到日志

engine = create_engine(

SQLALCHEMY_DATABASE_URL, encoding='utf8', echo=True

)

SQLAlchemy中,CRUD是通过会话进行管理的,所以需要先创建会话,

每一个SessionLocal实例就是一个数据库session

flush指发送到数据库语句到数据库,但数据库不一定执行写入磁盘

commit是指提交事务,将变更保存到数据库文件中

SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)

创建基本映射类

Base = declarative_base()
复制代码
在数据库相关的配置文件中,首先创建一个SQLAlchemy的"engine",然后创建SessionLocal实例进行会话,最后创建模型类的基类。

2、models.py
复制代码
from sqlalchemy import Boolean, Column, Integer, String
from database import Base

class User(Base):

__tablename__ = "users"
id = Column(Integer, primary_key=True, index=True)
email = Column(String(32), unique=True, index=True)
hashed_password = Column(String(32))
is_active = Column(Boolean, default=True)

复制代码
通过数据库配置文件中的基类来创建模型类。

3、schemas.py
复制代码
from pydantic import BaseModel

class UserBase(BaseModel):

email: str

class UserCreate(UserBase):

"""
请求模型验证:
email:
password:
"""
password: str

class User(UserBase):

"""
响应模型:
id:
email:
is_active
并且设置orm_mode与之兼容
"""
id: int
is_active: bool

class Config:
    orm_mode = True

复制代码
  定义请求参数模型验证与响应模型验证的Pydantic模型,其中响应模型中设置orm_mode=True参数,表示与ORM模型兼容,因为后续中返回的数据库查询是orm模型,通过设置这个参数可以将orm模型通过pydantic模型进行验证。

4、crud.py
复制代码
from sqlalchemy.orm import Session
import models, schemas

通过id查询用户

def get_user(db: Session, user_id: int):

return db.query(models.User).filter(models.User.id == user_id).first()

新建用户

def db_create_user(db: Session, user: schemas.UserCreate):

fake_hashed_password = user.password + "notreallyhashed"
db_user = models.User(email=user.email, hashed_password=fake_hashed_password)
db.add(db_user)
db.commit()  # 提交保存到数据库中
db.refresh(db_user)  # 刷新
return db_user

复制代码
通过传入数据库连接以及参数等进行数据库操作,包括创建用户、查询用户等,返回的是orm模型对象。

5、main.py
复制代码
from fastapi import FastAPI, Depends, HTTPException
import crud, schemas
from database import SessionLocal, engine, Base
from sqlalchemy.orm import Session
import uvicorn

Base.metadata.create_all(bind=engine) #数据库初始化,如果没有库或者表,会自动创建

app = FastAPI()

Dependency

def get_db():

"""
每一个请求处理完毕后会关闭当前连接,不同的请求使用不同的连接
:return:
"""
db = SessionLocal()
try:
    yield db
finally:
    db.close()

新建用户

@app.post("/users/", response_model=schemas.User)
def create_user(user: schemas.UserCreate, db: Session = Depends(get_db)):

return crud.db_create_user(db=db, user=user)

通过id查询用户

@app.get("/user/{user_id}", response_model=schemas.User)
def read_user(user_id: int, db: Session = Depends(get_db)):

db_user = crud.get_user(db, user_id=user_id)
if not db_user:
    raise HTTPException(status_code=404, detail="User not found")
return db_user

if name == '__main__':

uvicorn.run(app=app, host="127.0.0.1", port=8000)

复制代码
主文件进行数据库初始化、FastAPI实例创建以及处理各种请求。

进入到交互文档查看:

http://127.0.0.1:8000/users/
复制代码

请求

{
"email": "hhh@example113.com",
"password": "ss123456"
}

响应

{
"email": "hhh@example113.com",
"id": 7,
"is_active": true
}
复制代码
http://127.0.0.1:8000/user/7
复制代码

响应

{
"email": "hhh@example113.com",
"id": 7,
"is_active": true
}
复制代码
三、复杂实例
在之前的基础上再加一个模型类Item,User与之是一对多的关系。

1、models.py
复制代码
from sqlalchemy import Boolean, Column, Integer, String, ForeignKey
from sqlalchemy.orm import relationship
from database import Base

class User(Base):

__tablename__ = "users"
id = Column(Integer, primary_key=True, index=True)
email = Column(String(32), unique=True, index=True)
hashed_password = Column(String(32))
is_active = Column(Boolean, default=True)

items = relationship("Item", back_populates="owner")

class Item(Base):

__tablename__ = "items"
id = Column(Integer, primary_key=True, index=True)
title = Column(String(32), index=True)
description = Column(String(32), index=True)
owner_id = Column(Integer, ForeignKey("users.id"))

owner = relationship("User", back_populates="items")

复制代码
2、schemas.py
复制代码
from typing import Optional,List
from pydantic import BaseModel

class ItemBase(BaseModel):

title: str
description: Optional[str] = None

class ItemCreate(ItemBase):

pass

class Item(ItemBase):

id: int
owner_id: int

class Config:
    orm_mode = True

class UserBase(BaseModel):

email: str

class UserCreate(UserBase):

"""
请求模型验证:
email:
password:
"""
password: str

class User(UserBase):

"""
响应模型:
id:
email:
is_active
并且设置orm_mode与之兼容
"""
id: int
is_active: bool
items: List[Item] = []

class Config:
    orm_mode = True

复制代码
3、crud.py
复制代码
from sqlalchemy.orm import Session
import models, schemas

通过id查询用户

def get_user(db: Session, user_id: int):

return db.query(models.User).filter(models.User.id == user_id).first()

新建用户

def db_create_user(db: Session, user: schemas.UserCreate):

fake_hashed_password = user.password + "notreallyhashed"
db_user = models.User(email=user.email, hashed_password=fake_hashed_password)
db.add(db_user)
db.commit()  # 提交保存到数据库中
db.refresh(db_user)  # 刷新
return db_user

获取用户拥有的item

def get_item(db: Session, skip: int = 0, limit: int = 100):

return db.query(models.Item).offset(skip).limit(limit).all()

新建用户的item

def create_user_item(db: Session, item: schemas.ItemCreate, user_id: int):

db_item = models.Item(**item.dict(), owner_id=user_id)
db.add(db_item)
db.commit()
db.refresh(db_item)
return db_item

复制代码
4、main.py
复制代码
from typing import List
from fastapi import FastAPI, Depends, HTTPException
import crud, schemas
from database import SessionLocal, engine, Base
from sqlalchemy.orm import Session
import uvicorn

Base.metadata.create_all(bind=engine)

app = FastAPI()

Dependency

def get_db():

"""
每一个请求处理完毕后会关闭当前连接,不同的请求使用不同的连接
:return:
"""
db = SessionLocal()
try:
    yield db
finally:
    db.close()

新建用户

@app.post("/users/", response_model=schemas.User)
def create_user(user: schemas.UserCreate, db: Session = Depends(get_db)):

return crud.db_create_user(db=db, user=user)

通过id查询用户

@app.get("/user/{user_id}", response_model=schemas.User)
def read_user(user_id: int, db: Session = Depends(get_db)):

db_user = crud.get_user(db, user_id=user_id)
if not db_user:
    raise HTTPException(status_code=404, detail="User not found")
return db_user

读取用户拥有的item

@app.get("/items/", response_model=List[schemas.Item])
def read_items(skip: int = 0, limit: int = 0, db: Session = Depends(get_db)):

items = crud.get_item(db=db, skip=skip, limit=limit)
return items

创建用户的item

@app.post("/users/{user_id}/items", response_model=schemas.Item)
def create_item_user(user_id: int, item: schemas.ItemCreate, db: Session = Depends(get_db)):

return crud.create_user_item(db=db, item=item, user_id=user_id)

if name == '__main__':

uvicorn.run(app=app, host="127.0.0.1", port=8000)

复制代码
当启动项目后,会生成新的Item数据表,以及与User表之间建立关系:

复制代码

User表

create table users
(

id              int auto_increment
    primary key,
email           varchar(32) null,
hashed_password varchar(32) null,
is_active       tinyint(1)  null,
constraint ix_users_email
    unique (email)

);

create index ix_users_id

on users (id);

Item表

create table items
(

id          int auto_increment
    primary key,
title       varchar(32) null,
description varchar(32) null,
owner_id    int         null,
constraint items_ibfk_1
    foreign key (owner_id) references users (id)

);

create index ix_items_description

on items (description);

create index ix_items_id

on items (id);

create index ix_items_title

on items (title);

create index owner_id

on items (owner_id);

复制代码
最后进入交互文档进行测试。

相关实践学习
每个IT人都想学的“Web应用上云经典架构”实战
本实验从Web应用上云这个最基本的、最普遍的需求出发,帮助IT从业者们通过“阿里云Web应用上云解决方案”,了解一个企业级Web应用上云的常见架构,了解如何构建一个高可用、可扩展的企业级应用架构。
MySQL数据库入门学习
本课程通过最流行的开源数据库MySQL带你了解数据库的世界。   相关的阿里云产品:云数据库RDS MySQL 版 阿里云关系型数据库RDS(Relational Database Service)是一种稳定可靠、可弹性伸缩的在线数据库服务,提供容灾、备份、恢复、迁移等方面的全套解决方案,彻底解决数据库运维的烦恼。 了解产品详情: https://www.aliyun.com/product/rds/mysql 
相关文章
|
3月前
|
SQL 关系型数据库 MySQL
Go语言数据库编程:使用 `database/sql` 与 MySQL/PostgreSQL
Go语言通过`database/sql`标准库提供统一数据库操作接口,支持MySQL、PostgreSQL等多种数据库。本文介绍了驱动安装、连接数据库、基本增删改查操作、预处理语句、事务处理及错误管理等内容,涵盖实际开发中常用的技巧与注意事项,适合快速掌握Go语言数据库编程基础。
208 62
|
2月前
|
SQL 存储 关系型数据库
MySQL功能模块探秘:数据库世界的奇妙之旅
]带你轻松愉快地探索MySQL 8.4.5的核心功能模块,从SQL引擎到存储引擎,从复制机制到插件系统,让你在欢声笑语中掌握数据库的精髓!
|
2月前
|
SQL Oracle 关系型数据库
比较MySQL和Oracle数据库系统,特别是在进行分页查询的方法上的不同
两者的性能差异将取决于数据量大小、索引优化、查询设计以及具体版本的数据库服务器。考虑硬件资源、数据库设计和具体需求对于实现优化的分页查询至关重要。开发者和数据库管理员需要根据自身使用的具体数据库系统版本和环境,选择最合适的分页机制,并进行必要的性能调优来满足应用需求。
86 11
|
2月前
|
SQL 关系型数据库 MySQL
【赵渝强老师】MySQL中的数据库对象
本教程详细介绍了MySQL数据库中的常见对象,包括表、索引、视图、事件、存储过程和存储函数的创建与管理。内容涵盖表的基本操作、索引的使用、视图简化查询、事件调度功能等,并通过具体示例演示相关SQL语句的使用方法。
|
3月前
|
人工智能 运维 关系型数据库
数据库运维:mysql 数据库迁移方法-mysqldump
本文介绍了MySQL数据库迁移的方法与技巧,重点探讨了数据量大小对迁移方式的影响。对于10GB以下的小型数据库,推荐使用mysqldump进行逻辑导出和source导入;10GB以上可考虑mydumper与myloader工具;100GB以上则建议物理迁移。文中还提供了统计数据库及表空间大小的SQL语句,并讲解了如何使用mysqldump导出存储过程、函数和数据结构。通过结合实际应用场景选择合适的工具与方法,可实现高效的数据迁移。
583 1
|
4月前
|
负载均衡 算法 关系型数据库
大数据大厂之MySQL数据库课程设计:揭秘MySQL集群架构负载均衡核心算法:从理论到Java代码实战,让你的数据库性能飙升!
本文聚焦 MySQL 集群架构中的负载均衡算法,阐述其重要性。详细介绍轮询、加权轮询、最少连接、加权最少连接、随机、源地址哈希等常用算法,分析各自优缺点及适用场景。并提供 Java 语言代码实现示例,助力直观理解。文章结构清晰,语言通俗易懂,对理解和应用负载均衡算法具有实用价值和参考价值。
大数据大厂之MySQL数据库课程设计:揭秘MySQL集群架构负载均衡核心算法:从理论到Java代码实战,让你的数据库性能飙升!
|
6月前
|
关系型数据库 MySQL Java
【YashanDB知识库】原生mysql驱动配置连接崖山数据库
【YashanDB知识库】原生mysql驱动配置连接崖山数据库
【YashanDB知识库】原生mysql驱动配置连接崖山数据库
|
4月前
|
存储 关系型数据库 MySQL
大数据新视界 --面向数据分析师的大数据大厂之 MySQL 基础秘籍:轻松创建数据库与表,踏入大数据殿堂
本文详细介绍了在 MySQL 中创建数据库和表的方法。包括安装 MySQL、用命令行和图形化工具创建数据库、选择数据库、创建表(含数据类型介绍与选择建议、案例分析、最佳实践与注意事项)以及查看数据库和表的内容。文章专业、严谨且具可操作性,对数据管理有实际帮助。
大数据新视界 --面向数据分析师的大数据大厂之 MySQL 基础秘籍:轻松创建数据库与表,踏入大数据殿堂
|
6月前
|
关系型数据库 MySQL 数据库连接
docker拉取MySQL后数据库连接失败解决方案
通过以上方法,可以解决Docker中拉取MySQL镜像后数据库连接失败的常见问题。关键步骤包括确保容器正确启动、配置正确的环境变量、合理设置网络和权限,以及检查主机防火墙设置等。通过逐步排查,可以快速定位并解决连接问题,确保MySQL服务的正常使用。
853 82
|
4月前
|
SQL 关系型数据库 MySQL
MySQL下载安装全攻略!小白也能轻松上手,从此数据库不再难搞!
这是一份详细的MySQL安装与配置教程,适合初学者快速上手。内容涵盖从下载到安装的每一步操作,包括选择版本、设置路径、配置端口及密码等。同时提供基础操作指南,如数据库管理、数据表增删改查、用户权限设置等。还介绍了备份恢复、图形化工具使用和性能优化技巧,帮助用户全面掌握MySQL的使用方法。附带常见问题解决方法,保姆级教学让你无忧入门!
MySQL下载安装全攻略!小白也能轻松上手,从此数据库不再难搞!

推荐镜像

更多