Python玩转SQL的神器有哪些

数据库   发布日期:2025年02月07日   浏览次数:360

这篇文章主要讲解了“Python玩转SQL的神器有哪些”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“Python玩转SQL的神器有哪些”吧!

初始化工作

一般使用ORM框架,都会有一些初始化工作,比如数据库连接,定义基础映射等。

MySQL为例,创建数据库连接只需要传入DSN字符串即可。其中echo表示是否输出对应的sql语句,对调试比较有帮助。

  1. from sqlalchemy import create_engine
  2. engine = create_engine('mysql+pymysql://$user:$password@$host:$port/$db?charset=utf8mb4', echo=True)

个人设计

对于我个人而言,引进ORM框架时,我的项目会参考MVC模式做以下设计。其中model存储的是一些数据库模型,即数据库表映射的Python类;model_op存储的是每个模型对应的操作,即增删查改;调用方(如main.py)执行数据库操作时,只需要调用model_op层,并不用关心model层,从而实现解耦。

  1. ├── main.py
  2. ├── model
  3. ├── __init__.py
  4. ├── base_model.py
  5. ├── ddl.sql
  6. └── py_orm_model.py
  7. └── model_op
  8. ├── __init__.py
  9. └── py_orm_model_op.py

映射声明(Model介绍)

举个栗子,如果我们有这样一张测试表

  1. create table py_orm (
  2. `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '唯一id',
  3. `name` varchar(255) NOT NULL DEFAULT '' COMMENT '名称',
  4. `attr` JSON NOT NULL COMMENT '属性',
  5. `ct` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  6. `ut` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON update CURRENT_TIMESTAMP COMMENT '更新时间',
  7. PRIMARY KEY(`id`)
  8. )ENGINE=InnoDB COMMENT '测试表';

在ORM框架中,映射的结果就是下文这个Python类

  1. # py_orm_model.py
  2. from .base_model import Base
  3. from sqlalchemy import Column, Integer, String, TIMESTAMP, text, JSON
  4. class PyOrmModel(Base):
  5. __tablename__ = 'py_orm'
  6. id = Column(Integer, autoincrement=True, primary_key=True, comment='唯一id')
  7. name = Column(String(255), nullable=False, default='', comment='名称')
  8. attr = Column(JSON, nullable=False, comment='属性')
  9. ct = Column(TIMESTAMP, nullable=False, server_default=text('CURRENT_TIMESTAMP'), comment='创建时间')
  10. ut = Column(TIMESTAMP, nullable=False, server_default=text('CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP'), comment='更新时间')

首先,我们可以看到PyOrmModel继承了Base类,该类是sqlalchemy提供的一个基类,会对我们声明的Python类做一些检查,我将其放在base_model中。

  1. # base_model.py
  2. # 一般base_model做的都是一些初始化的工作
  3. from sqlalchemy import create_engine
  4. from sqlalchemy.ext.declarative import declarative_base
  5. Base = declarative_base()
  6. engine = create_engine("mysql+pymysql://root:123456@127.0.0.1:33306/orm_test?charset=utf8mb4", echo=False)

其次,每个Python类都必须包含__tablename__属性,不然无法找到对应的表。

第三,关于数据表的创建有两种方式,第一种当然是手动在MySQL中创建,只要你的Python类定义没有问题,就可以正常操作;第二种是通过orm框架创建,比如下面:

  1. # main.py
  2. # 注意这里的导入路径,Base创建表时会寻找继承它的子类,如果路径不对,则无法创建成功
  3. from sqlachlemy_lab import Base, engine
  4. if __name__ == '__main__':
  5. Base.metadata.create_all(engine)

创建效果:

  1. ...
  2. 2020-04-04 10:12:53,974 INFO sqlalchemy.engine.base.Engine
  3. CREATE TABLE py_orm (
  4. id INTEGER NOT NULL AUTO_INCREMENT,
  5. name VARCHAR(255) NOT NULL DEFAULT '' COMMENT '名称',
  6. attr JSON NOT NULL COMMENT '属性',
  7. ct TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
  8. ut TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  9. PRIMARY KEY (id)
  10. )

第四,关于字段属性

  • 1.primary_key和autoincrement比较好理解,就是MySQL的主键和递增属性。

  • 2.如果是int类型,不需要指定长度,而如果是varchar类型,则必须指定。

  • 3.nullable对应的就是MySQL中的NULL 和 NOT NULL

  • 4.关于default和server_default: default代表的是ORM框架层面的默认值,即插入的时候如果该字段未赋值,则会使用我们定义的默认值;server_default代表的是数据库层面的默认值,即DDL语句中的default关键字。

Session介绍

在SQLAlchemy的文档中提到,数据库的增删查改是通过session来执行的。

  1. >>> from sqlalchemy.orm import sessionmaker
  2. >>> Session = sessionmaker(bind=engine)
  3. >>> session = Session()
  4. >>> orm = PyOrmModel(id=1, name='test', attr={})
  5. >>> session.add(orm)
  6. >>> session.commit()
  7. >>> session.close()

如上,我们可以看到,对于每一次操作,我们都需要对session进行获取,提交和释放。这样未免过于冗余和麻烦,所以我们一般会进行一层封装。

1.采用上下文管理器的方式,处理session的异常回滚和关闭,这部分与所参考的文章是几乎一致的。

  1. # base_model.py
  2. from contextlib import contextmanager
  3. from sqlalchemy.orm import sessionmaker, scoped_session
  4. def _get_session():
  5. """获取session"""
  6. return scoped_session(sessionmaker(bind=engine, expire_on_commit=False))()
  7. # 在这里对session进行统一管理,包括获取,提交,回滚和关闭
  8. @contextmanager
  9. def db_session(commit=True):
  10. session = _get_session()
  11. try:
  12. yield session
  13. if commit:
  14. session.commit()
  15. except Exception as e:
  16. session.rollback()
  17. raise e
  18. finally:
  19. if session:
  20. session.close()

2.在PyOrmModel中增加两个方法,用于model和dict之间的转换

  1. class PyOrmModel(Base):
  2. ...
  3. @staticmethod
  4. def fields():
  5. return ['id', 'name', 'attr']
  6. @staticmethod
  7. def to_json(model):
  8. fields = PyOrmModel.fields()
  9. json_data = {}
  10. for field in fields:
  11. json_data[field] = model.__getattribute__(field)
  12. return json_data
  13. @staticmethod
  14. def from_json(data: dict):
  15. fields = PyOrmModel.fields()
  16. model = PyOrmModel()
  17. for field in fields:
  18. if field in data:
  19. model.__setattr__(field, data[field])
  20. return model

3.数据库操作的封装,与参考的文章不同,我是直接调用了session,从而使调用方不需要关注model层,减少耦合。

  1. # py_orm_model_op.py
  2. from sqlachlemy_lab.model import db_session
  3. from sqlachlemy_lab.model import PyOrmModel
  4. class PyOrmModelOp:
  5. def __init__(self):
  6. pass
  7. @staticmethod
  8. def save_data(data: dict):
  9. with db_session() as session:
  10. model = PyOrmModel.from_json(data)
  11. session.add(model)
  12. # 查询操作,不需要commit
  13. @staticmethod
  14. def query_data(pid: int):
  15. data_list = []
  16. with db_session(commit=False) as session:
  17. data = session.query(PyOrmModel).filter(PyOrmModel.id == pid)
  18. for d in data:
  19. data_list.append(PyOrmModel.to_json(d))
  20. return data_list

4.调用方

  1. # main.py
  2. from sqlachlemy_lab.model_op import PyOrmModelOp
  3. if __name__ == '__main__':
  4. PyOrmModelOp.save_data({'id': 1, 'name': 'test', 'attr': {}})

以上就是Python玩转SQL的神器有哪些的详细内容,更多关于Python玩转SQL的神器有哪些的资料请关注九品源码其它相关文章!